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.
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/>.
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
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.
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\"
70 For more information, see Info node `elisp(Declaring Functions)'."
71 ;; Does nothing - byte-compile-declare-function does the work.
74 ;;;; Basic Lisp macros.
78 (defmacro noreturn (form)
79 "Evaluate FORM, expecting it not to return.
80 If FORM does return, signal an error."
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."
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)))
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
130 (declare (debug (sexp)))
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.
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.
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)
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
166 (let ((temp '--dolist-tail--))
167 `(let ((,temp ,(nth 1 spec))
170 (setq ,(car spec) (car ,temp))
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
190 (let ((temp '--dotimes-limit--)
194 (,(car spec) ,start))
195 (while (< ,(car spec) ,temp)
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'.)"
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."
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."
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
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)
240 (setq object (indirect-function object))
242 (eq (car-safe object) 'autoload)
243 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe 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)))
253 "Return the car of the car of X."
257 "Return the car of the cdr of X."
261 "Return the cdr of the car of X."
265 "Return the cdr of the cdr of 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."
274 (let ((m 0) (p list))
276 (setq m (1+ m) p (cdr p)))
278 (if (< n m) (nthcdr (- m n) list) list)))
279 (while (consp (cdr list))
280 (setq list (cdr 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)))
294 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
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
304 (setcdr tail (delete (car tail) (cdr tail)))
305 (setq tail (cdr tail))))
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))
333 (or inc (setq inc 1))
334 (when (zerop inc) (error "The increment can not be zero"))
335 (let (seq (n 0) (next from))
338 (setq seq (cons next seq)
340 next (+ from (* n inc))))
342 (setq seq (cons next seq)
344 next (+ from (* n inc)))))
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."
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)))
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)))
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."
408 (not (and (stringp (car list))
409 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
410 (setq list (cdr 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))))
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))))
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'."
447 ;; If SEQ isn't a list, there's no need to copy SEQ because
448 ;; `delete' will return a new object.
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."
457 (delq elt (copy-sequence list))
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))
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)
483 (define-key map "-" 'negative-argument)
484 ;; Make plain numbers do numeric args.
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
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))
505 (signal 'wrong-type-argument (list 'keymapp keymap)))
507 (if (<= (length key) 1) (aref key 0)
508 (setq keymap (lookup-key keymap
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)
524 (eq (car (cdr tail)) 'keymap)
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)
532 ;; Don't insert more than once.
534 (setcdr tail (cons (cons key definition) (cdr tail))))
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."
542 (map-keymap (lambda (a b) (push (cons a b) list))
544 (setq list (sort list
546 (setq a (car a) b (car b))
548 (if (integerp b) (< a b)
551 ;; string< also accepts symbols.
554 (funcall function (car p) (cdr p)))))
556 (defun keymap-canonicalize (map)
557 "Return an equivalent keymap, without inheritance."
561 (setq map (map-keymap-internal
564 ;; Treat char-ranges specially.
565 (push (cons key item) ranges)
566 (push (cons key item) bindings)))
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))
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)))
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))
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
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.
675 (aset prefix1 (length prefix) char)
676 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
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
697 (let ((copy (copy-sequence menu-item)))
698 (setcar (nthcdr 2 copy) newdef)
700 (nconc (nreverse skipped) newdef)))
701 ;; Look past a symbol that names a keymap.
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
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."
758 (mapcar (function (lambda (c)
760 (logxor c listify-key-sequence-1)
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)))
772 (get obj 'event-symbol-elements))
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',
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."
788 (setq type (car 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))
794 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
795 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
796 (if (not (zerop (logand type ?\M-\^@)))
798 (if (or (not (zerop (logand type ?\C-\^@)))
800 (push 'control list))
801 (if (or (not (zerop (logand type ?\S-\^@)))
802 (/= char (downcase char)))
804 (or (zerop (logand type ?\H-\^@))
806 (or (zerop (logand type ?\s-\^@))
808 (or (zerop (logand type ?\A-\^@))
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."
819 (setq event (car 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.
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
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."
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))
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."
889 (if (consp (nth 1 position))
890 (car (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."
908 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
910 (defun posn-col-row (position)
911 "Return the nominal column and row in POSITION, measured in characters.
912 The column and row values are approximations calculated from the x
913 and y coordinates in POSITION and the frame's default character width
915 For a scroll-bar event, the result column is 0, and the row
916 corresponds to the vertical position of the click in the scroll bar.
917 POSITION should be a list of the form returned by the `event-start'
918 and `event-end' functions."
919 (let* ((pair (posn-x-y position))
920 (window (posn-window position))
921 (area (posn-area position)))
925 ((eq area 'vertical-scroll-bar)
926 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
927 ((eq area 'horizontal-scroll-bar)
928 (cons (scroll-bar-scale pair (window-width window)) 0))
930 (let* ((frame (if (framep window) window (window-frame window)))
931 (x (/ (car pair) (frame-char-width frame)))
932 (y (/ (cdr pair) (+ (frame-char-height frame)
933 (or (frame-parameter frame 'line-spacing)
934 ;; FIXME: Why the `default'?
935 (default-value 'line-spacing)
939 (defun posn-actual-col-row (position)
940 "Return the actual column and row in POSITION, measured in characters.
941 These are the actual row number in the window and character number in that row.
942 Return nil if POSITION does not contain the actual position; in that case
943 `posn-col-row' can be used to get approximate values.
944 POSITION should be a list of the form returned by the `event-start'
945 and `event-end' functions."
948 (defsubst posn-timestamp (position)
949 "Return the timestamp of POSITION.
950 POSITION should be a list of the form returned by the `event-start'
951 and `event-end' functions."
954 (defsubst posn-string (position)
955 "Return the string object of POSITION.
956 Value is a cons (STRING . STRING-POS), or nil if not a string.
957 POSITION should be a list of the form returned by the `event-start'
958 and `event-end' functions."
961 (defsubst posn-image (position)
962 "Return the image object of POSITION.
963 Value is a list (image ...), or nil if not an image.
964 POSITION should be a list of the form returned by the `event-start'
965 and `event-end' functions."
968 (defsubst posn-object (position)
969 "Return the object (image or string) of POSITION.
970 Value is a list (image ...) for an image object, a cons cell
971 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
972 POSITION should be a list of the form returned by the `event-start'
973 and `event-end' functions."
974 (or (posn-image position) (posn-string position)))
976 (defsubst posn-object-x-y (position)
977 "Return the x and y coordinates relative to the object of POSITION.
978 POSITION should be a list of the form returned by the `event-start'
979 and `event-end' functions."
982 (defsubst posn-object-width-height (position)
983 "Return the pixel width and height of the object of POSITION.
984 POSITION should be a list of the form returned by the `event-start'
985 and `event-end' functions."
989 ;;;; Obsolescent names for functions.
991 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
992 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
993 (define-obsolete-function-alias 'read-input 'read-string "22.1")
994 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
995 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
996 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
998 (make-obsolete 'char-bytes "now always returns 1." "20.4")
1000 (defun insert-string (&rest args)
1001 "Mocklisp-compatibility insert function.
1002 Like the function `insert' except that any argument that is a number
1003 is converted into a string by expressing it in decimal."
1005 (insert (if (integerp el) (number-to-string el) el))))
1006 (make-obsolete 'insert-string 'insert "22.1")
1008 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1009 (make-obsolete 'makehash 'make-hash-table "22.1")
1011 ;; Some programs still use this as a function.
1013 "Return the value of the `baud-rate' variable."
1015 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
1017 ;; These are used by VM and some old programs
1018 (defalias 'focus-frame 'ignore "")
1019 (make-obsolete 'focus-frame "it does nothing." "22.1")
1020 (defalias 'unfocus-frame 'ignore "")
1021 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1022 (make-obsolete 'make-variable-frame-local
1023 "explicitly check for a frame-parameter instead." "22.2")
1025 ;;;; Obsolescence declarations for variables, and aliases.
1027 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1028 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1029 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1031 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1032 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1034 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
1035 (make-obsolete-variable
1036 'mode-line-inverse-video
1037 "use the appropriate faces instead."
1039 (make-obsolete-variable
1040 'unread-command-char
1041 "use `unread-command-events' instead. That variable is a list of events
1042 to reread, so it now uses nil to mean `no event', instead of -1."
1045 ;; Lisp manual only updated in 22.1.
1046 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1049 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1050 (make-obsolete-variable 'x-lost-selection-hooks
1051 'x-lost-selection-functions "22.1")
1052 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1053 (make-obsolete-variable 'x-sent-selection-hooks
1054 'x-sent-selection-functions "22.1")
1055 ;; This was introduced in 21.4 for pre-unicode unification and was rendered
1056 ;; obsolete by the use of Unicode internally in 23.1.
1057 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1059 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1061 ;;;; Alternate names for functions - these are not being phased out.
1063 (defalias 'send-string 'process-send-string)
1064 (defalias 'send-region 'process-send-region)
1065 (defalias 'string= 'string-equal)
1066 (defalias 'string< 'string-lessp)
1067 (defalias 'move-marker 'set-marker)
1068 (defalias 'rplaca 'setcar)
1069 (defalias 'rplacd 'setcdr)
1070 (defalias 'beep 'ding) ;preserve lingual purity
1071 (defalias 'indent-to-column 'indent-to)
1072 (defalias 'backward-delete-char 'delete-backward-char)
1073 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1074 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1075 (defalias 'int-to-string 'number-to-string)
1076 (defalias 'store-match-data 'set-match-data)
1077 ;; These are the XEmacs names:
1078 (defalias 'point-at-eol 'line-end-position)
1079 (defalias 'point-at-bol 'line-beginning-position)
1081 (defalias 'user-original-login-name 'user-login-name)
1084 ;;;; Hook manipulation functions.
1086 (defun make-local-hook (hook)
1087 "Make the hook HOOK local to the current buffer.
1088 The return value is HOOK.
1090 You never need to call this function now that `add-hook' does it for you
1091 if its LOCAL argument is non-nil.
1093 When a hook is local, its local and global values
1094 work in concert: running the hook actually runs all the hook
1095 functions listed in *either* the local value *or* the global value
1096 of the hook variable.
1098 This function works by making t a member of the buffer-local value,
1099 which acts as a flag to run the hook functions in the default value as
1100 well. This works for all normal hooks, but does not work for most
1101 non-normal hooks yet. We will be changing the callers of non-normal
1102 hooks so that they can handle localness; this has to be done one by
1105 This function does nothing if HOOK is already local in the current
1108 Do not use `make-local-variable' to make a hook variable buffer-local."
1109 (if (local-variable-p hook)
1111 (or (boundp hook) (set hook nil))
1112 (make-local-variable hook)
1113 (set hook (list t)))
1115 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1117 (defun add-hook (hook function &optional append local)
1118 "Add to the value of HOOK the function FUNCTION.
1119 FUNCTION is not added if already present.
1120 FUNCTION is added (if necessary) at the beginning of the hook list
1121 unless the optional argument APPEND is non-nil, in which case
1122 FUNCTION is added at the end.
1124 The optional fourth argument, LOCAL, if non-nil, says to modify
1125 the hook's buffer-local value rather than its default value.
1126 This makes the hook buffer-local if needed, and it makes t a member
1127 of the buffer-local value. That acts as a flag to run the hook
1128 functions in the default value as well as in the local value.
1130 HOOK should be a symbol, and FUNCTION may be any valid function. If
1131 HOOK is void, it is first set to nil. If HOOK's value is a single
1132 function, it is changed to a list of functions."
1133 (or (boundp hook) (set hook nil))
1134 (or (default-boundp hook) (set-default hook nil))
1135 (if local (unless (local-variable-if-set-p hook)
1136 (set (make-local-variable hook) (list t)))
1137 ;; Detect the case where make-local-variable was used on a hook
1138 ;; and do what we used to do.
1139 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1141 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1142 ;; If the hook value is a single function, turn it into a list.
1143 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1144 (setq hook-value (list hook-value)))
1145 ;; Do the actual addition if necessary
1146 (unless (member function hook-value)
1149 (append hook-value (list function))
1150 (cons function hook-value))))
1151 ;; Set the actual variable
1154 ;; If HOOK isn't a permanent local,
1155 ;; but FUNCTION wants to survive a change of modes,
1156 ;; mark HOOK as partially permanent.
1157 (and (symbolp function)
1158 (get function 'permanent-local-hook)
1159 (not (get hook 'permanent-local))
1160 (put hook 'permanent-local 'permanent-local-hook))
1161 (set hook hook-value))
1162 (set-default hook hook-value))))
1164 (defun remove-hook (hook function &optional local)
1165 "Remove from the value of HOOK the function FUNCTION.
1166 HOOK should be a symbol, and FUNCTION may be any valid function. If
1167 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1168 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1170 The optional third argument, LOCAL, if non-nil, says to modify
1171 the hook's buffer-local value rather than its default value."
1172 (or (boundp hook) (set hook nil))
1173 (or (default-boundp hook) (set-default hook nil))
1174 ;; Do nothing if LOCAL is t but this hook has no local binding.
1175 (unless (and local (not (local-variable-p hook)))
1176 ;; Detect the case where make-local-variable was used on a hook
1177 ;; and do what we used to do.
1178 (when (and (local-variable-p hook)
1179 (not (and (consp (symbol-value hook))
1180 (memq t (symbol-value hook)))))
1182 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1183 ;; Remove the function, for both the list and the non-list cases.
1184 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1185 (if (equal hook-value function) (setq hook-value nil))
1186 (setq hook-value (delete function (copy-sequence hook-value))))
1187 ;; If the function is on the global hook, we need to shadow it locally
1188 ;;(when (and local (member function (default-value hook))
1189 ;; (not (member (cons 'not function) hook-value)))
1190 ;; (push (cons 'not function) hook-value))
1191 ;; Set the actual variable
1193 (set-default hook hook-value)
1194 (if (equal hook-value '(t))
1195 (kill-local-variable hook)
1196 (set hook hook-value))))))
1198 (defun add-to-list (list-var element &optional append compare-fn)
1199 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1200 The test for presence of ELEMENT is done with `equal',
1201 or with COMPARE-FN if that's non-nil.
1202 If ELEMENT is added, it is added at the beginning of the list,
1203 unless the optional argument APPEND is non-nil, in which case
1204 ELEMENT is added at the end.
1206 The return value is the new value of LIST-VAR.
1208 If you want to use `add-to-list' on a variable that is not defined
1209 until a certain package is loaded, you should put the call to `add-to-list'
1210 into a hook function that will be run only after loading the package.
1211 `eval-after-load' provides one way to do this. In some cases
1212 other hooks, such as major mode hooks, can do the job."
1215 (member element (symbol-value list-var)))
1216 ((eq compare-fn 'eq)
1217 (memq element (symbol-value list-var)))
1218 ((eq compare-fn 'eql)
1219 (memql element (symbol-value list-var)))
1221 (let ((lst (symbol-value list-var)))
1223 (not (funcall compare-fn element (car lst))))
1224 (setq lst (cdr lst)))
1226 (symbol-value list-var)
1229 (append (symbol-value list-var) (list element))
1230 (cons element (symbol-value list-var))))))
1233 (defun add-to-ordered-list (list-var element &optional order)
1234 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1235 The test for presence of ELEMENT is done with `eq'.
1237 The resulting list is reordered so that the elements are in the
1238 order given by each element's numeric list order. Elements
1239 without a numeric list order are placed at the end of the list.
1241 If the third optional argument ORDER is a number (integer or
1242 float), set the element's list order to the given value. If
1243 ORDER is nil or omitted, do not change the numeric order of
1244 ELEMENT. If ORDER has any other value, remove the numeric order
1245 of ELEMENT if it has one.
1247 The list order for each element is stored in LIST-VAR's
1248 `list-order' property.
1250 The return value is the new value of LIST-VAR."
1251 (let ((ordering (get list-var 'list-order)))
1253 (put list-var 'list-order
1254 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1256 (puthash element (and (numberp order) order) ordering))
1257 (unless (memq element (symbol-value list-var))
1258 (set list-var (cons element (symbol-value list-var))))
1259 (set list-var (sort (symbol-value list-var)
1261 (let ((oa (gethash a ordering))
1262 (ob (gethash b ordering)))
1267 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1268 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1269 Return the new history list.
1270 If MAXELT is non-nil, it specifies the maximum length of the history.
1271 Otherwise, the maximum history length is the value of the `history-length'
1272 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1274 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1275 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1276 if it is empty or a duplicate."
1278 (setq maxelt (or (get history-var 'history-length)
1280 (let ((history (symbol-value history-var))
1282 (when (and (listp history)
1284 (not (stringp newelt))
1285 (> (length newelt) 0))
1287 (not (equal (car history) newelt))))
1288 (if history-delete-duplicates
1289 (delete newelt history))
1290 (setq history (cons newelt history))
1291 (when (integerp maxelt)
1294 (setq tail (nthcdr (1- maxelt) history))
1296 (setcdr tail nil)))))
1297 (set history-var history)))
1302 (defvar delay-mode-hooks nil
1303 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1304 (defvar delayed-mode-hooks nil
1305 "List of delayed mode hooks waiting to be run.")
1306 (make-variable-buffer-local 'delayed-mode-hooks)
1307 (put 'delay-mode-hooks 'permanent-local t)
1309 (defvar after-change-major-mode-hook nil
1310 "Normal hook run at the very end of major mode functions.")
1312 (defun run-mode-hooks (&rest hooks)
1313 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1314 Execution is delayed if `delay-mode-hooks' is non-nil.
1315 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1316 after running the mode hooks.
1317 Major mode functions should use this instead of `run-hooks' when running their
1319 (if delay-mode-hooks
1321 (dolist (hook hooks)
1322 (push hook delayed-mode-hooks))
1323 ;; Normal case, just run the hook as before plus any delayed hooks.
1324 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1325 (setq delayed-mode-hooks nil)
1326 (apply 'run-hooks hooks)
1327 (run-hooks 'after-change-major-mode-hook)))
1329 (defmacro delay-mode-hooks (&rest body)
1330 "Execute BODY, but delay any `run-mode-hooks'.
1331 These hooks will be executed by the first following call to
1332 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1333 Only affects hooks run in the current buffer."
1334 (declare (debug t) (indent 0))
1336 (make-local-variable 'delay-mode-hooks)
1337 (let ((delay-mode-hooks t))
1340 ;; PUBLIC: find if the current mode derives from another.
1342 (defun derived-mode-p (&rest modes)
1343 "Non-nil if the current major mode is derived from one of MODES.
1344 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1345 (let ((parent major-mode))
1346 (while (and (not (memq parent modes))
1347 (setq parent (get parent 'derived-mode-parent))))
1352 ;; If a minor mode is not defined with define-minor-mode,
1353 ;; add it here explicitly.
1354 ;; isearch-mode is deliberately excluded, since you should
1355 ;; not call it yourself.
1356 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1357 overwrite-mode view-mode
1359 "List of all minor mode functions.")
1361 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1362 "Register a new minor mode.
1364 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1366 TOGGLE is a symbol which is the name of a buffer-local variable that
1367 is toggled on or off to say whether the minor mode is active or not.
1369 NAME specifies what will appear in the mode line when the minor mode
1370 is active. NAME should be either a string starting with a space, or a
1371 symbol whose value is such a string.
1373 Optional KEYMAP is the keymap for the minor mode that will be added
1374 to `minor-mode-map-alist'.
1376 Optional AFTER specifies that TOGGLE should be added after AFTER
1377 in `minor-mode-alist'.
1379 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1380 It defaults to (and should by convention be) TOGGLE.
1382 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1383 included in the mode-line minor mode menu.
1384 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1385 (unless (memq toggle minor-mode-list)
1386 (push toggle minor-mode-list))
1388 (unless toggle-fun (setq toggle-fun toggle))
1389 (unless (eq toggle-fun toggle)
1390 (put toggle :minor-mode-function toggle-fun))
1391 ;; Add the name to the minor-mode-alist.
1393 (let ((existing (assq toggle minor-mode-alist)))
1395 (setcdr existing (list name))
1396 (let ((tail minor-mode-alist) found)
1397 (while (and tail (not found))
1398 (if (eq after (caar tail))
1400 (setq tail (cdr tail))))
1402 (let ((rest (cdr found)))
1404 (nconc found (list (list toggle name)) rest))
1405 (setq minor-mode-alist (cons (list toggle name)
1406 minor-mode-alist)))))))
1407 ;; Add the toggle to the minor-modes menu if requested.
1408 (when (get toggle :included)
1409 (define-key mode-line-mode-menu
1413 (or (get toggle :menu-tag)
1414 (if (stringp name) name (symbol-name toggle)))
1415 (let ((mode-name (if (symbolp name) (symbol-value name))))
1416 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1417 (concat " (" (match-string 0 mode-name) ")"))))
1419 :button (cons :toggle toggle))))
1421 ;; Add the map to the minor-mode-map-alist.
1423 (let ((existing (assq toggle minor-mode-map-alist)))
1425 (setcdr existing keymap)
1426 (let ((tail minor-mode-map-alist) found)
1427 (while (and tail (not found))
1428 (if (eq after (caar tail))
1430 (setq tail (cdr tail))))
1432 (let ((rest (cdr found)))
1434 (nconc found (list (cons toggle keymap)) rest))
1435 (setq minor-mode-map-alist (cons (cons toggle keymap)
1436 minor-mode-map-alist))))))))
1440 ;; (defvar symbol-file-load-history-loaded nil
1441 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1442 ;; That file records the part of `load-history' for preloaded files,
1443 ;; which is cleared out before dumping to make Emacs smaller.")
1445 ;; (defun load-symbol-file-load-history ()
1446 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1447 ;; That file records the part of `load-history' for preloaded files,
1448 ;; which is cleared out before dumping to make Emacs smaller."
1449 ;; (unless symbol-file-load-history-loaded
1450 ;; (load (expand-file-name
1451 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1452 ;; (if (eq system-type 'ms-dos)
1454 ;; (format "fns-%s.el" emacs-version))
1456 ;; ;; The file name fns-%s.el already has a .el extension.
1458 ;; (setq symbol-file-load-history-loaded t)))
1460 (defun symbol-file (symbol &optional type)
1461 "Return the name of the file that defined SYMBOL.
1462 The value is normally an absolute file name. It can also be nil,
1463 if the definition is not associated with any file. If SYMBOL
1464 specifies an autoloaded function, the value can be a relative
1465 file name without extension.
1467 If TYPE is nil, then any kind of definition is acceptable. If
1468 TYPE is `defun', `defvar', or `defface', that specifies function
1469 definition, variable definition, or face definition only."
1470 (if (and (or (null type) (eq type 'defun))
1471 (symbolp symbol) (fboundp symbol)
1472 (eq 'autoload (car-safe (symbol-function symbol))))
1473 (nth 1 (symbol-function symbol))
1474 (let ((files load-history)
1478 (if (eq type 'defvar)
1479 ;; Variables are present just as their names.
1480 (member symbol (cdr (car files)))
1481 ;; Other types are represented as (TYPE . NAME).
1482 (member (cons type symbol) (cdr (car files))))
1483 ;; We accept all types, so look for variable def
1484 ;; and then for any other kind.
1485 (or (member symbol (cdr (car files)))
1486 (rassq symbol (cdr (car files)))))
1487 (setq file (car (car files)) files nil))
1488 (setq files (cdr files)))
1491 (defun locate-library (library &optional nosuffix path interactive-call)
1492 "Show the precise file name of Emacs library LIBRARY.
1493 This command searches the directories in `load-path' like `\\[load-library]'
1494 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1495 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1496 to the specified name LIBRARY.
1498 If the optional third arg PATH is specified, that list of directories
1499 is used instead of `load-path'.
1501 When called from a program, the file name is normally returned as a
1502 string. When run interactively, the argument INTERACTIVE-CALL is t,
1503 and the file name is displayed in the echo area."
1504 (interactive (list (completing-read "Locate library: "
1506 'locate-file-completion-table
1507 load-path (get-load-suffixes)))
1510 (let ((file (locate-file library
1512 (append (unless nosuffix (get-load-suffixes))
1513 load-file-rep-suffixes))))
1514 (if interactive-call
1516 (message "Library is file %s" (abbreviate-file-name file))
1517 (message "No library %s in search path" library)))
1521 ;;;; Specifying things to do later.
1523 (defmacro eval-at-startup (&rest body)
1524 "Make arrangements to evaluate BODY when Emacs starts up.
1525 If this is run after Emacs startup, evaluate BODY immediately.
1528 This works by adding a function to `before-init-hook'.
1529 That function's doc string says which file created it."
1531 (if command-line-processed
1533 (add-hook 'before-init-hook
1534 '(lambda () ,(concat "From " (or load-file-name "no file"))
1539 (defun load-history-regexp (file)
1540 "Form a regexp to find FILE in `load-history'.
1541 FILE, a string, is described in the function `eval-after-load'."
1542 (if (file-name-absolute-p file)
1543 (setq file (file-truename file)))
1544 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1546 (if (file-name-extension file)
1548 ;; Note: regexp-opt can't be used here, since we need to call
1549 ;; this before Emacs has been fully started. 2006-05-21
1550 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1551 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1554 (defun load-history-filename-element (file-regexp)
1555 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1556 Return nil if there isn't one."
1557 (let* ((loads load-history)
1558 (load-elt (and loads (car loads))))
1561 (or (null (car load-elt))
1562 (not (string-match file-regexp (car load-elt)))))
1563 (setq loads (cdr loads)
1564 load-elt (and loads (car loads)))))
1567 (defun eval-after-load (file form)
1568 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1569 If FILE is already loaded, evaluate FORM right now.
1571 If a matching file is loaded again, FORM will be evaluated again.
1573 If FILE is a string, it may be either an absolute or a relative file
1574 name, and may have an extension \(e.g. \".el\") or may lack one, and
1575 additionally may or may not have an extension denoting a compressed
1576 format \(e.g. \".gz\").
1578 When FILE is absolute, this first converts it to a true name by chasing
1579 symbolic links. Only a file of this name \(see next paragraph regarding
1580 extensions) will trigger the evaluation of FORM. When FILE is relative,
1581 a file whose absolute true name ends in FILE will trigger evaluation.
1583 When FILE lacks an extension, a file name with any extension will trigger
1584 evaluation. Otherwise, its extension must match FILE's. A further
1585 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1588 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1589 is evaluated whenever that feature is `provide'd.
1591 Usually FILE is just a library name like \"font-lock\" or a feature name
1594 This function makes or adds to an entry on `after-load-alist'."
1595 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1596 ;; evaluating it now).
1597 (let* ((regexp-or-feature
1598 (if (stringp file) (load-history-regexp file) file))
1599 (elt (assoc regexp-or-feature after-load-alist)))
1601 (setq elt (list regexp-or-feature))
1602 (push elt after-load-alist))
1603 ;; Add FORM to the element unless it's already there.
1604 (unless (member form (cdr elt))
1605 (nconc elt (list form)))
1607 ;; Is there an already loaded file whose name (or `provide' name)
1609 (if (if (stringp file)
1610 (load-history-filename-element regexp-or-feature)
1614 (defun do-after-load-evaluation (abs-file)
1615 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1616 ABS-FILE, a string, should be the absolute true name of a file just loaded."
1617 (let ((after-load-elts after-load-alist)
1618 a-l-element file-elements file-element form)
1619 (while after-load-elts
1620 (setq a-l-element (car after-load-elts)
1621 after-load-elts (cdr after-load-elts))
1622 (when (and (stringp (car a-l-element))
1623 (string-match (car a-l-element) abs-file))
1624 (while (setq a-l-element (cdr a-l-element)) ; discard the file name
1625 (setq form (car a-l-element))
1628 (defun eval-next-after-load (file)
1629 "Read the following input sexp, and run it whenever FILE is loaded.
1630 This makes or adds to an entry on `after-load-alist'.
1631 FILE should be the name of a library, with no directory name."
1632 (eval-after-load file (read)))
1636 (defun process-lines (program &rest args)
1637 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1638 Signal an error if the program returns with a non-zero exit status."
1640 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1641 (unless (eq status 0)
1642 (error "%s exited with status %s" program status))
1643 (goto-char (point-min))
1646 (setq lines (cons (buffer-substring-no-properties
1647 (line-beginning-position)
1648 (line-end-position))
1651 (nreverse lines)))))
1653 ;; open-network-stream is a wrapper around make-network-process.
1655 (when (featurep 'make-network-process)
1656 (defun open-network-stream (name buffer host service)
1657 "Open a TCP connection for a service to a host.
1658 Returns a subprocess-object to represent the connection.
1659 Input and output work as for subprocesses; `delete-process' closes it.
1661 Args are NAME BUFFER HOST SERVICE.
1662 NAME is name for process. It is modified if necessary to make it unique.
1663 BUFFER is the buffer (or buffer name) to associate with the process.
1664 Process output goes at end of that buffer, unless you specify
1665 an output stream or filter function to handle the output.
1666 BUFFER may be also nil, meaning that this process is not associated
1668 HOST is name of the host to connect to, or its IP address.
1669 SERVICE is name of the service desired, or an integer specifying
1670 a port number to connect to."
1671 (make-network-process :name name :buffer buffer
1672 :host host :service service)))
1677 'process-kill-without-query
1678 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1680 (defun process-kill-without-query (process &optional flag)
1681 "Say no query needed if PROCESS is running when Emacs is exited.
1682 Optional second argument if non-nil says to require a query.
1683 Value is t if a query was formerly required."
1684 (let ((old (process-query-on-exit-flag process)))
1685 (set-process-query-on-exit-flag process nil)
1688 ;; process plist management
1690 (defun process-get (process propname)
1691 "Return the value of PROCESS' PROPNAME property.
1692 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1693 (plist-get (process-plist process) propname))
1695 (defun process-put (process propname value)
1696 "Change PROCESS' PROPNAME property to VALUE.
1697 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1698 (set-process-plist process
1699 (plist-put (process-plist process) propname value)))
1702 ;;;; Input and display facilities.
1704 (defvar read-quoted-char-radix 8
1705 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1706 Legitimate radix values are 8, 10 and 16.")
1708 (custom-declare-variable-early
1709 'read-quoted-char-radix 8
1710 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1711 Legitimate radix values are 8, 10 and 16."
1712 :type '(choice (const 8) (const 10) (const 16))
1713 :group 'editing-basics)
1715 (defun read-quoted-char (&optional prompt)
1716 "Like `read-char', but do not allow quitting.
1717 Also, if the first character read is an octal digit,
1718 we read any number of octal digits and return the
1719 specified character code. Any nondigit terminates the sequence.
1720 If the terminator is RET, it is discarded;
1721 any other terminator is used itself as input.
1723 The optional argument PROMPT specifies a string to use to prompt the user.
1724 The variable `read-quoted-char-radix' controls which radix to use
1726 (let ((message-log-max nil) done (first t) (code 0) char translated)
1728 (let ((inhibit-quit first)
1729 ;; Don't let C-h get the help message--only help function keys.
1732 "Type the special character you want to use,
1733 or the octal character code.
1734 RET terminates the character code and is discarded;
1735 any other non-digit terminates the character code and is then used as input."))
1736 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1737 (if inhibit-quit (setq quit-flag nil)))
1738 ;; Translate TAB key into control-I ASCII character, and so on.
1739 ;; Note: `read-char' does it using the `ascii-character' property.
1740 ;; We could try and use read-key-sequence instead, but then C-q ESC
1741 ;; or C-q C-x might not return immediately since ESC or C-x might be
1742 ;; bound to some prefix in function-key-map or key-translation-map.
1745 (char-resolve-modifiers char)
1747 (let ((translation (lookup-key local-function-key-map (vector char))))
1748 (if (arrayp translation)
1749 (setq translated (aref translation 0))))
1750 (cond ((null translated))
1751 ((not (integerp translated))
1752 (setq unread-command-events (list char)
1754 ((/= (logand translated ?\M-\^@) 0)
1755 ;; Turn a meta-character into a character with the 0200 bit set.
1756 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1758 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1759 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1760 (and prompt (setq prompt (message "%s %c" prompt translated))))
1761 ((and (<= ?a (downcase translated))
1762 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1763 (setq code (+ (* code read-quoted-char-radix)
1764 (+ 10 (- (downcase translated) ?a))))
1765 (and prompt (setq prompt (message "%s %c" prompt translated))))
1766 ((and (not first) (eq translated ?\C-m))
1769 (setq unread-command-events (list char)
1771 (t (setq code translated
1776 (defun read-passwd (prompt &optional confirm default)
1777 "Read a password, prompting with PROMPT, and return it.
1778 If optional CONFIRM is non-nil, read the password twice to make sure.
1779 Optional DEFAULT is a default password to use instead of empty input.
1781 This function echoes `.' for each character that the user types.
1782 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1783 C-g quits; if `inhibit-quit' was non-nil around this function,
1784 then it returns nil if the user types C-g, but quit-flag remains set.
1786 Once the caller uses the password, it can erase the password
1787 by doing (clear-string STRING)."
1791 (while (not success)
1792 (let ((first (read-passwd prompt nil default))
1793 (second (read-passwd "Confirm password: " nil default)))
1794 (if (equal first second)
1796 (and (arrayp second) (clear-string second))
1797 (setq success first))
1798 (and (arrayp first) (clear-string first))
1799 (and (arrayp second) (clear-string second))
1800 (message "Password not repeated accurately; please start over")
1804 ;; Copy it so that add-text-properties won't modify
1805 ;; the object that was passed in by the caller.
1806 (prompt (copy-sequence prompt))
1809 (cursor-in-echo-area t)
1810 (message-log-max nil))
1811 (add-text-properties 0 (length prompt)
1812 minibuffer-prompt-properties prompt)
1813 (while (progn (message "%s%s"
1815 (make-string (length pass) ?.))
1816 (setq c (read-char-exclusive nil t))
1817 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1818 (clear-this-command-keys)
1821 (and (arrayp pass) (clear-string pass))
1823 (if (and (/= c ?\b) (/= c ?\177))
1824 (let* ((new-char (char-to-string c))
1825 (new-pass (concat pass new-char)))
1826 (and (arrayp pass) (clear-string pass))
1827 (clear-string new-char)
1829 (setq pass new-pass))
1830 (if (> (length pass) 0)
1831 (let ((new-pass (substring pass 0 -1)))
1832 (and (arrayp pass) (clear-string pass))
1833 (setq pass new-pass))))))
1835 (or pass default "")))))
1837 ;; This should be used by `call-interactively' for `n' specs.
1838 (defun read-number (prompt &optional default)
1839 "Read a numeric value in the minibuffer, prompting with PROMPT.
1840 DEFAULT specifies a default value to return if the user just types RET.
1841 The value of DEFAULT is inserted into PROMPT."
1845 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1846 (replace-match (format " (default %s)" default) t t prompt 1)
1847 (replace-regexp-in-string "[ \t]*\\'"
1848 (format " (default %s) " default)
1852 (let ((str (read-from-minibuffer prompt nil nil nil nil
1854 (number-to-string default)))))
1857 ((zerop (length str)) default)
1858 ((stringp str) (read str))))
1861 (message "Please enter a number.")
1866 (defun sit-for (seconds &optional nodisp obsolete)
1867 "Perform redisplay, then wait for SECONDS seconds or until input is available.
1868 SECONDS may be a floating-point value.
1869 \(On operating systems that do not support waiting for fractions of a
1870 second, floating-point values are rounded down to the nearest integer.)
1872 If optional arg NODISP is t, don't redisplay, just wait for input.
1873 Redisplay does not happen if input is available before it starts.
1875 Value is t if waited the full time with no input arriving, and nil otherwise.
1877 An obsolete, but still supported form is
1878 \(sit-for SECONDS &optional MILLISECONDS NODISP)
1879 where the optional arg MILLISECONDS specifies an additional wait period,
1880 in milliseconds; this was useful when Emacs was built without
1881 floating point support.
1883 \(fn SECONDS &optional NODISP)"
1884 (if (numberp nodisp)
1885 (setq seconds (+ seconds (* 1e-3 nodisp))
1887 (if obsolete (setq nodisp obsolete)))
1895 (or nodisp (redisplay)))
1897 (or nodisp (redisplay))
1898 (let ((read (read-event nil nil seconds)))
1901 ;; If last command was a prefix arg, e.g. C-u, push this event onto
1902 ;; unread-command-events as (t . EVENT) so it will be added to
1903 ;; this-command-keys by read-key-sequence.
1904 (if (eq overriding-terminal-local-map universal-argument-map)
1905 (setq read (cons t read)))
1906 (push read unread-command-events)
1909 ;;; Atomic change groups.
1911 (defmacro atomic-change-group (&rest body)
1912 "Perform BODY as an atomic change group.
1913 This means that if BODY exits abnormally,
1914 all of its changes to the current buffer are undone.
1915 This works regardless of whether undo is enabled in the buffer.
1917 This mechanism is transparent to ordinary use of undo;
1918 if undo is enabled in the buffer and BODY succeeds, the
1919 user can undo the change normally."
1920 (declare (indent 0) (debug t))
1921 (let ((handle (make-symbol "--change-group-handle--"))
1922 (success (make-symbol "--change-group-success--")))
1923 `(let ((,handle (prepare-change-group))
1924 ;; Don't truncate any undo data in the middle of this.
1925 (undo-outer-limit nil)
1926 (undo-limit most-positive-fixnum)
1927 (undo-strong-limit most-positive-fixnum)
1931 ;; This is inside the unwind-protect because
1932 ;; it enables undo if that was disabled; we need
1933 ;; to make sure that it gets disabled again.
1934 (activate-change-group ,handle)
1937 ;; Either of these functions will disable undo
1938 ;; if it was disabled before.
1940 (accept-change-group ,handle)
1941 (cancel-change-group ,handle))))))
1943 (defun prepare-change-group (&optional buffer)
1944 "Return a handle for the current buffer's state, for a change group.
1945 If you specify BUFFER, make a handle for BUFFER's state instead.
1947 Pass the handle to `activate-change-group' afterward to initiate
1948 the actual changes of the change group.
1950 To finish the change group, call either `accept-change-group' or
1951 `cancel-change-group' passing the same handle as argument. Call
1952 `accept-change-group' to accept the changes in the group as final;
1953 call `cancel-change-group' to undo them all. You should use
1954 `unwind-protect' to make sure the group is always finished. The call
1955 to `activate-change-group' should be inside the `unwind-protect'.
1956 Once you finish the group, don't use the handle again--don't try to
1957 finish the same group twice. For a simple example of correct use, see
1958 the source code of `atomic-change-group'.
1960 The handle records only the specified buffer. To make a multibuffer
1961 change group, call this function once for each buffer you want to
1962 cover, then use `nconc' to combine the returned values, like this:
1964 (nconc (prepare-change-group buffer-1)
1965 (prepare-change-group buffer-2))
1967 You can then activate that multibuffer change group with a single
1968 call to `activate-change-group' and finish it with a single call
1969 to `accept-change-group' or `cancel-change-group'."
1972 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
1973 (list (cons (current-buffer) buffer-undo-list))))
1975 (defun activate-change-group (handle)
1976 "Activate a change group made with `prepare-change-group' (which see)."
1977 (dolist (elt handle)
1978 (with-current-buffer (car elt)
1979 (if (eq buffer-undo-list t)
1980 (setq buffer-undo-list nil)))))
1982 (defun accept-change-group (handle)
1983 "Finish a change group made with `prepare-change-group' (which see).
1984 This finishes the change group by accepting its changes as final."
1985 (dolist (elt handle)
1986 (with-current-buffer (car elt)
1988 (setq buffer-undo-list t)))))
1990 (defun cancel-change-group (handle)
1991 "Finish a change group made with `prepare-change-group' (which see).
1992 This finishes the change group by reverting all of its changes."
1993 (dolist (elt handle)
1994 (with-current-buffer (car elt)
1995 (setq elt (cdr elt))
1997 ;; Widen buffer temporarily so if the buffer was narrowed within
1998 ;; the body of `atomic-change-group' all changes can be undone.
2001 (if (consp elt) (car elt)))
2003 (if (consp elt) (cdr elt))))
2004 ;; Temporarily truncate the undo log at ELT.
2006 (setcar elt nil) (setcdr elt nil))
2007 (unless (eq last-command 'undo) (undo-start))
2008 ;; Make sure there's no confusion.
2009 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2010 (error "Undoing to some unrelated state"))
2013 (while (listp pending-undo-list) (undo-more 1)))
2014 ;; Reset the modified cons cell ELT to its original content.
2016 (setcar elt old-car)
2017 (setcdr elt old-cdr))
2018 ;; Revert the undo info to what it was when we grabbed the state.
2019 (setq buffer-undo-list elt))))))
2021 ;;;; Display-related functions.
2023 ;; For compatibility.
2024 (defalias 'redraw-modeline 'force-mode-line-update)
2026 (defun force-mode-line-update (&optional all)
2027 "Force redisplay of the current buffer's mode line and header line.
2028 With optional non-nil ALL, force redisplay of all mode lines and
2029 header lines. This function also forces recomputation of the
2030 menu bar menus and the frame title."
2031 (if all (save-excursion (set-buffer (other-buffer))))
2032 (set-buffer-modified-p (buffer-modified-p)))
2034 (defun momentary-string-display (string pos &optional exit-char message)
2035 "Momentarily display STRING in the buffer at POS.
2036 Display remains until next event is input.
2037 If POS is a marker, only its position is used; its buffer is ignored.
2038 Optional third arg EXIT-CHAR can be a character, event or event
2039 description list. EXIT-CHAR defaults to SPC. If the input is
2040 EXIT-CHAR it is swallowed; otherwise it is then available as
2041 input (as a command if nothing else).
2042 Display MESSAGE (optional fourth arg) in the echo area.
2043 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2044 (or exit-char (setq exit-char ?\s))
2045 (let ((ol (make-overlay pos pos))
2046 (message (copy-sequence string)))
2050 (overlay-put ol 'after-string message)
2052 ;; To avoid trouble with out-of-bounds position
2054 ;; If the message end is off screen, recenter now.
2055 (if (<= (window-end nil t) pos)
2056 (recenter (/ (window-height) 2))))
2057 (message (or message "Type %s to continue editing.")
2058 (single-key-description exit-char))
2060 (if (integerp exit-char)
2063 (setq char (read-char))
2064 (or (eq char exit-char)
2065 (setq unread-command-events (list char))))
2067 ;; `exit-char' is a character, hence it differs
2068 ;; from char, which is an event.
2069 (setq unread-command-events (list char))))
2070 ;; `exit-char' can be an event, or an event description list.
2071 (setq char (read-event))
2072 (or (eq char exit-char)
2073 (eq char (event-convert-list exit-char))
2074 (setq unread-command-events (list char))))))
2075 (delete-overlay ol))))
2078 ;;;; Overlay operations
2080 (defun copy-overlay (o)
2081 "Return a copy of overlay O."
2082 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
2083 ;; FIXME: there's no easy way to find the
2084 ;; insertion-type of the two markers.
2085 (overlay-buffer o)))
2086 (props (overlay-properties o)))
2088 (overlay-put o1 (pop props) (pop props)))
2091 (defun remove-overlays (&optional beg end name val)
2092 "Clear BEG and END of overlays whose property NAME has value VAL.
2093 Overlays might be moved and/or split.
2094 BEG and END default respectively to the beginning and end of buffer."
2095 ;; This speeds up the loops over overlays.
2096 (unless beg (setq beg (point-min)))
2097 (unless end (setq end (point-max)))
2098 (overlay-recenter end)
2100 (setq beg (prog1 end (setq end beg))))
2102 (dolist (o (overlays-in beg end))
2103 (when (eq (overlay-get o name) val)
2104 ;; Either push this overlay outside beg...end
2105 ;; or split it to exclude beg...end
2106 ;; or delete it entirely (if it is contained in beg...end).
2107 (if (< (overlay-start o) beg)
2108 (if (> (overlay-end o) end)
2110 (move-overlay (copy-overlay o)
2111 (overlay-start o) beg)
2112 (move-overlay o end (overlay-end o)))
2113 (move-overlay o (overlay-start o) beg))
2114 (if (> (overlay-end o) end)
2115 (move-overlay o end (overlay-end o))
2116 (delete-overlay o)))))))
2120 (defvar suspend-hook nil
2121 "Normal hook run by `suspend-emacs', before suspending.")
2123 (defvar suspend-resume-hook nil
2124 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2126 (defvar temp-buffer-show-hook nil
2127 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2128 When the hook runs, the temporary buffer is current, and the window it
2129 was displayed in is selected.")
2131 (defvar temp-buffer-setup-hook nil
2132 "Normal hook run by `with-output-to-temp-buffer' at the start.
2133 When the hook runs, the temporary buffer is current.
2134 This hook is normally set up with a function to put the buffer in Help
2137 ;; Avoid compiler warnings about this variable,
2138 ;; which has a special meaning on certain system types.
2139 (defvar buffer-file-type nil
2140 "Non-nil if the visited file is a binary file.
2141 This variable is meaningful on MS-DOG and Windows NT.
2142 On those systems, it is automatically local in every buffer.
2143 On other systems, this variable is normally always nil.")
2145 ;; The `assert' macro from the cl package signals
2146 ;; `cl-assertion-failed' at runtime so always define it.
2147 (put 'cl-assertion-failed 'error-conditions '(error))
2148 (put 'cl-assertion-failed 'error-message "Assertion failed")
2150 (defconst user-emacs-directory
2151 (if (eq system-type 'ms-dos)
2152 ;; MS-DOS cannot have initial dot.
2155 "Directory beneath which additional per-user Emacs-specific files are placed.
2156 Various programs in Emacs store information in this directory.
2157 Note that this should end with a directory separator.")
2160 ;;;; Misc. useful functions.
2162 (defun find-tag-default ()
2163 "Determine default tag to search for, based on text at point.
2164 If there is no plausible default, return nil."
2165 (let (from to bound)
2167 ;; Look at text around `point'.
2169 (skip-syntax-backward "w_") (setq from (point)))
2171 (skip-syntax-forward "w_") (setq to (point)))
2173 ;; Look between `line-beginning-position' and `point'.
2175 (and (setq bound (line-beginning-position))
2176 (skip-syntax-backward "^w_" bound)
2177 (> (setq to (point)) bound)
2178 (skip-syntax-backward "w_")
2179 (setq from (point))))
2180 ;; Look between `point' and `line-end-position'.
2182 (and (setq bound (line-end-position))
2183 (skip-syntax-forward "^w_" bound)
2184 (< (setq from (point)) bound)
2185 (skip-syntax-forward "w_")
2186 (setq to (point)))))
2187 (buffer-substring-no-properties from to))))
2189 (defun play-sound (sound)
2190 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2191 The following keywords are recognized:
2193 :file FILE - read sound data from FILE. If FILE isn't an
2194 absolute file name, it is searched in `data-directory'.
2196 :data DATA - read sound data from string DATA.
2198 Exactly one of :file or :data must be present.
2200 :volume VOL - set volume to VOL. VOL must an integer in the
2201 range 0..100 or a float in the range 0..1.0. If not specified,
2202 don't change the volume setting of the sound device.
2204 :device DEVICE - play sound on DEVICE. If not specified,
2205 a system-dependent default device name is used."
2206 (if (fboundp 'play-sound-internal)
2207 (play-sound-internal sound)
2208 (error "This Emacs binary lacks sound support")))
2210 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2212 (defun shell-quote-argument (argument)
2213 "Quote an argument for passing as argument to an inferior shell."
2214 (if (or (eq system-type 'ms-dos)
2215 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2216 ;; Quote using double quotes, but escape any existing quotes in
2217 ;; the argument with backslashes.
2221 (if (or (null (string-match "[^\"]" argument))
2222 (< (match-end 0) (length argument)))
2223 (while (string-match "[\"]" argument start)
2224 (setq end (match-beginning 0)
2225 result (concat result (substring argument start end)
2226 "\\" (substring argument end (1+ end)))
2228 (concat "\"" result (substring argument start) "\""))
2229 (if (equal argument "")
2231 ;; Quote everything except POSIX filename characters.
2232 ;; This should be safe enough even for really weird shells.
2233 (let ((result "") (start 0) end)
2234 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2235 (setq end (match-beginning 0)
2236 result (concat result (substring argument start end)
2237 "\\" (substring argument end (1+ end)))
2239 (concat result (substring argument start))))))
2241 (defun string-or-null-p (object)
2242 "Return t if OBJECT is a string or nil.
2243 Otherwise, return nil."
2244 (or (stringp object) (null object)))
2246 (defun booleanp (object)
2247 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2248 (memq object '(nil t)))
2250 (defun field-at-pos (pos)
2251 "Return the field at position POS, taking stickiness etc into account"
2252 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2253 (if (eq raw-field 'boundary)
2254 (get-char-property (1- (field-end pos)) 'field)
2258 ;;;; Support for yanking and text properties.
2260 (defvar yank-excluded-properties)
2262 (defun remove-yank-excluded-properties (start end)
2263 "Remove `yank-excluded-properties' between START and END positions.
2264 Replaces `category' properties with their defined properties."
2265 (let ((inhibit-read-only t))
2266 ;; Replace any `category' property with the properties it stands for.
2267 (unless (memq yank-excluded-properties '(t nil))
2270 (while (< (point) end)
2271 (let ((cat (get-text-property (point) 'category))
2274 (next-single-property-change (point) 'category nil end))
2276 (let (run-end2 original)
2277 (remove-list-of-text-properties (point) run-end '(category))
2278 (while (< (point) run-end)
2279 (setq run-end2 (next-property-change (point) nil run-end))
2280 (setq original (text-properties-at (point)))
2281 (set-text-properties (point) run-end2 (symbol-plist cat))
2282 (add-text-properties (point) run-end2 original)
2283 (goto-char run-end2))))
2284 (goto-char run-end)))))
2285 (if (eq yank-excluded-properties t)
2286 (set-text-properties start end nil)
2287 (remove-list-of-text-properties start end yank-excluded-properties))))
2289 (defvar yank-undo-function)
2291 (defun insert-for-yank (string)
2292 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2294 See `insert-for-yank-1' for more details."
2296 (while (setq to (next-single-property-change 0 'yank-handler string))
2297 (insert-for-yank-1 (substring string 0 to))
2298 (setq string (substring string to))))
2299 (insert-for-yank-1 string))
2301 (defun insert-for-yank-1 (string)
2302 "Insert STRING at point, stripping some text properties.
2304 Strip text properties from the inserted text according to
2305 `yank-excluded-properties'. Otherwise just like (insert STRING).
2307 If STRING has a non-nil `yank-handler' property on the first character,
2308 the normal insert behavior is modified in various ways. The value of
2309 the yank-handler property must be a list with one to four elements
2310 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2311 When FUNCTION is present and non-nil, it is called instead of `insert'
2312 to insert the string. FUNCTION takes one argument--the object to insert.
2313 If PARAM is present and non-nil, it replaces STRING as the object
2314 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2315 `yank-rectangle', PARAM may be a list of strings to insert as a
2317 If NOEXCLUDE is present and non-nil, the normal removal of the
2318 yank-excluded-properties is not performed; instead FUNCTION is
2319 responsible for removing those properties. This may be necessary
2320 if FUNCTION adjusts point before or after inserting the object.
2321 If UNDO is present and non-nil, it is a function that will be called
2322 by `yank-pop' to undo the insertion of the current object. It is
2323 called with two arguments, the start and end of the current region.
2324 FUNCTION may set `yank-undo-function' to override the UNDO value."
2325 (let* ((handler (and (stringp string)
2326 (get-text-property 0 'yank-handler string)))
2327 (param (or (nth 1 handler) string))
2329 (inhibit-read-only inhibit-read-only)
2332 (setq yank-undo-function t)
2333 (if (nth 0 handler) ;; FUNCTION
2334 (funcall (car handler) param)
2338 ;; Prevent read-only properties from interfering with the
2339 ;; following text property changes.
2340 (setq inhibit-read-only t)
2342 ;; What should we do with `font-lock-face' properties?
2343 (if font-lock-defaults
2344 ;; No, just wipe them.
2345 (remove-list-of-text-properties opoint end '(font-lock-face))
2346 ;; Convert them to `face'.
2349 (while (< (point) end)
2350 (let ((face (get-text-property (point) 'font-lock-face))
2353 (next-single-property-change (point) 'font-lock-face nil end))
2355 (remove-text-properties (point) run-end '(font-lock-face nil))
2356 (put-text-property (point) run-end 'face face))
2357 (goto-char run-end)))))
2359 (unless (nth 2 handler) ;; NOEXCLUDE
2360 (remove-yank-excluded-properties opoint (point)))
2362 ;; If last inserted char has properties, mark them as rear-nonsticky.
2363 (if (and (> end opoint)
2364 (text-properties-at (1- end)))
2365 (put-text-property (1- end) end 'rear-nonsticky t))
2367 (if (eq yank-undo-function t) ;; not set by FUNCTION
2368 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2369 (if (nth 4 handler) ;; COMMAND
2370 (setq this-command (nth 4 handler)))))
2372 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2373 "Insert before point a substring of BUFFER, without text properties.
2374 BUFFER may be a buffer or a buffer name.
2375 Arguments START and END are character positions specifying the substring.
2376 They default to the values of (point-min) and (point-max) in BUFFER."
2377 (let ((opoint (point)))
2378 (insert-buffer-substring buffer start end)
2379 (let ((inhibit-read-only t))
2380 (set-text-properties opoint (point) nil))))
2382 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2383 "Insert before point a part of BUFFER, stripping some text properties.
2384 BUFFER may be a buffer or a buffer name.
2385 Arguments START and END are character positions specifying the substring.
2386 They default to the values of (point-min) and (point-max) in BUFFER.
2387 Strip text properties from the inserted text according to
2388 `yank-excluded-properties'."
2389 ;; Since the buffer text should not normally have yank-handler properties,
2390 ;; there is no need to handle them here.
2391 (let ((opoint (point)))
2392 (insert-buffer-substring buffer start end)
2393 (remove-yank-excluded-properties opoint (point))))
2396 ;;;; Synchronous shell commands.
2398 (defun start-process-shell-command (name buffer &rest args)
2399 "Start a program in a subprocess. Return the process object for it.
2400 NAME is name for process. It is modified if necessary to make it unique.
2401 BUFFER is the buffer (or buffer name) to associate with the process.
2402 Process output goes at end of that buffer, unless you specify
2403 an output stream or filter function to handle the output.
2404 BUFFER may be also nil, meaning that this process is not associated
2406 COMMAND is the name of a shell command.
2407 Remaining arguments are the arguments for the command; they are all
2408 spliced together with blanks separating between each two of them, before
2409 passing the command to the shell.
2410 Wildcards and redirection are handled as usual in the shell.
2412 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
2413 ;; We used to use `exec' to replace the shell with the command,
2414 ;; but that failed to handle (...) and semicolon, etc.
2415 (start-process name buffer shell-file-name shell-command-switch
2416 (mapconcat 'identity args " ")))
2418 (defun start-file-process-shell-command (name buffer &rest args)
2419 "Start a program in a subprocess. Return the process object for it.
2420 Similar to `start-process-shell-command', but calls `start-file-process'."
2423 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2424 (if (file-remote-p default-directory) "-c" shell-command-switch)
2425 (mapconcat 'identity args " ")))
2427 (defun call-process-shell-command (command &optional infile buffer display
2429 "Execute the shell command COMMAND synchronously in separate process.
2430 The remaining arguments are optional.
2431 The program's input comes from file INFILE (nil means `/dev/null').
2432 Insert output in BUFFER before point; t means current buffer;
2433 nil for BUFFER means discard it; 0 means discard and don't wait.
2434 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2435 REAL-BUFFER says what to do with standard output, as above,
2436 while STDERR-FILE says what to do with standard error in the child.
2437 STDERR-FILE may be nil (discard standard error output),
2438 t (mix it with ordinary output), or a file name string.
2440 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2441 Remaining arguments are strings passed as additional arguments for COMMAND.
2442 Wildcards and redirection are handled as usual in the shell.
2444 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2445 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2446 status or a signal description string.
2447 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2448 ;; We used to use `exec' to replace the shell with the command,
2449 ;; but that failed to handle (...) and semicolon, etc.
2450 (call-process shell-file-name
2451 infile buffer display
2452 shell-command-switch
2453 (mapconcat 'identity (cons command args) " ")))
2455 (defun process-file-shell-command (command &optional infile buffer display
2457 "Process files synchronously in a separate process.
2458 Similar to `call-process-shell-command', but calls `process-file'."
2460 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2461 infile buffer display
2462 (if (file-remote-p default-directory) "-c" shell-command-switch)
2463 (mapconcat 'identity (cons command args) " ")))
2465 ;;;; Lisp macros to do various things temporarily.
2467 (defmacro with-current-buffer (buffer &rest body)
2468 "Execute the forms in BODY with BUFFER temporarily current.
2469 BUFFER can be a buffer or a buffer name.
2470 The value returned is the value of the last form in BODY.
2471 See also `with-temp-buffer'."
2472 (declare (indent 1) (debug t))
2473 `(save-current-buffer
2474 (set-buffer ,buffer)
2477 (defmacro with-selected-window (window &rest body)
2478 "Execute the forms in BODY with WINDOW as the selected window.
2479 The value returned is the value of the last form in BODY.
2481 This macro saves and restores the current buffer, since otherwise
2482 its normal operation could potentially make a different
2483 buffer current. It does not alter the buffer list ordering.
2485 This macro saves and restores the selected window, as well as
2486 the selected window in each frame. If the previously selected
2487 window of some frame is no longer live at the end of BODY, that
2488 frame's selected window is left alone. If the selected window is
2489 no longer live, then whatever window is selected at the end of
2490 BODY remains selected.
2491 See also `with-temp-buffer'."
2492 (declare (indent 1) (debug t))
2493 ;; Most of this code is a copy of save-selected-window.
2494 `(let ((save-selected-window-window (selected-window))
2495 ;; It is necessary to save all of these, because calling
2496 ;; select-window changes frame-selected-window for whatever
2497 ;; frame that window is in.
2498 (save-selected-window-alist
2499 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2501 (save-current-buffer
2503 (progn (select-window ,window 'norecord)
2505 (dolist (elt save-selected-window-alist)
2506 (and (frame-live-p (car elt))
2507 (window-live-p (cadr elt))
2508 (set-frame-selected-window (car elt) (cadr elt))))
2509 (if (window-live-p save-selected-window-window)
2510 (select-window save-selected-window-window 'norecord))))))
2512 (defmacro with-selected-frame (frame &rest body)
2513 "Execute the forms in BODY with FRAME as the selected frame.
2514 The value returned is the value of the last form in BODY.
2515 See also `with-temp-buffer'."
2516 (declare (indent 1) (debug t))
2517 (let ((old-frame (make-symbol "old-frame"))
2518 (old-buffer (make-symbol "old-buffer")))
2519 `(let ((,old-frame (selected-frame))
2520 (,old-buffer (current-buffer)))
2522 (progn (select-frame ,frame)
2524 (if (frame-live-p ,old-frame)
2525 (select-frame ,old-frame))
2526 (if (buffer-live-p ,old-buffer)
2527 (set-buffer ,old-buffer))))))
2529 (defmacro with-temp-file (file &rest body)
2530 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2531 The value returned is the value of the last form in BODY.
2532 See also `with-temp-buffer'."
2534 (let ((temp-file (make-symbol "temp-file"))
2535 (temp-buffer (make-symbol "temp-buffer")))
2536 `(let ((,temp-file ,file)
2538 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2541 (with-current-buffer ,temp-buffer
2543 (with-current-buffer ,temp-buffer
2544 (write-region nil nil ,temp-file nil 0)))
2545 (and (buffer-name ,temp-buffer)
2546 (kill-buffer ,temp-buffer))))))
2548 (defmacro with-temp-message (message &rest body)
2549 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2550 The original message is restored to the echo area after BODY has finished.
2551 The value returned is the value of the last form in BODY.
2552 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2553 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2554 Use a MESSAGE of \"\" to temporarily clear the echo area."
2556 (let ((current-message (make-symbol "current-message"))
2557 (temp-message (make-symbol "with-temp-message")))
2558 `(let ((,temp-message ,message)
2563 (setq ,current-message (current-message))
2564 (message "%s" ,temp-message))
2567 (if ,current-message
2568 (message "%s" ,current-message)
2571 (defmacro with-temp-buffer (&rest body)
2572 "Create a temporary buffer, and evaluate BODY there like `progn'.
2573 See also `with-temp-file' and `with-output-to-string'."
2574 (declare (indent 0) (debug t))
2575 (let ((temp-buffer (make-symbol "temp-buffer")))
2576 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2577 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
2578 (with-current-buffer ,temp-buffer
2581 (and (buffer-name ,temp-buffer)
2582 (kill-buffer ,temp-buffer)))))))
2584 (defmacro with-output-to-string (&rest body)
2585 "Execute BODY, return the text it sent to `standard-output', as a string."
2586 (declare (indent 0) (debug t))
2587 `(let ((standard-output
2588 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2591 (let ((standard-output standard-output))
2593 (with-current-buffer standard-output
2595 (kill-buffer standard-output))))
2597 (defmacro with-local-quit (&rest body)
2598 "Execute BODY, allowing quits to terminate BODY but not escape further.
2599 When a quit terminates BODY, `with-local-quit' returns nil but
2600 requests another quit. That quit will be processed as soon as quitting
2601 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2602 (declare (debug t) (indent 0))
2603 `(condition-case nil
2604 (let ((inhibit-quit nil))
2606 (quit (setq quit-flag t)
2607 ;; This call is to give a chance to handle quit-flag
2608 ;; in case inhibit-quit is nil.
2609 ;; Without this, it will not be handled until the next function
2610 ;; call, and that might allow it to exit thru a condition-case
2611 ;; that intends to handle the quit signal next time.
2612 (eval '(ignore nil)))))
2614 (defmacro while-no-input (&rest body)
2615 "Execute BODY only as long as there's no pending input.
2616 If input arrives, that ends the execution of BODY,
2617 and `while-no-input' returns t. Quitting makes it return nil.
2618 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2619 (declare (debug t) (indent 0))
2620 (let ((catch-sym (make-symbol "input")))
2623 (let ((throw-on-input ',catch-sym))
2624 (or (input-pending-p)
2625 (progn ,@body)))))))
2627 (defmacro condition-case-no-debug (var bodyform &rest handlers)
2628 "Like `condition-case' except that it does not catch anything when debugging.
2629 More specifically if `debug-on-error' is set, then it does not catch any signal."
2630 (declare (debug condition-case) (indent 2))
2631 (let ((bodysym (make-symbol "body")))
2632 `(let ((,bodysym (lambda () ,bodyform)))
2635 (condition-case ,var
2639 (defmacro with-demoted-errors (&rest body)
2640 "Run BODY and demote any errors to simple messages.
2641 If `debug-on-error' is non-nil, run BODY without catching its errors.
2642 This is to be used around code which is not expected to signal an error
2643 but which should be robust in the unexpected case that an error is signaled."
2644 (declare (debug t) (indent 0))
2645 (let ((err (make-symbol "err")))
2646 `(condition-case-no-debug ,err
2648 (error (message "Error: %s" ,err) nil))))
2650 (defmacro combine-after-change-calls (&rest body)
2651 "Execute BODY, but don't call the after-change functions till the end.
2652 If BODY makes changes in the buffer, they are recorded
2653 and the functions on `after-change-functions' are called several times
2654 when BODY is finished.
2655 The return value is the value of the last form in BODY.
2657 If `before-change-functions' is non-nil, then calls to the after-change
2658 functions can't be deferred, so in that case this macro has no effect.
2660 Do not alter `after-change-functions' or `before-change-functions'
2662 (declare (indent 0) (debug t))
2664 (let ((combine-after-change-calls t))
2666 (combine-after-change-execute)))
2668 (defmacro with-case-table (table &rest body)
2669 "Execute the forms in BODY with TABLE as the current case table.
2670 The value returned is the value of the last form in BODY."
2671 (declare (indent 1) (debug t))
2672 (let ((old-case-table (make-symbol "table"))
2673 (old-buffer (make-symbol "buffer")))
2674 `(let ((,old-case-table (current-case-table))
2675 (,old-buffer (current-buffer)))
2677 (progn (set-case-table ,table)
2679 (with-current-buffer ,old-buffer
2680 (set-case-table ,old-case-table))))))
2682 ;;; Matching and match data.
2684 (defvar save-match-data-internal)
2686 ;; We use save-match-data-internal as the local variable because
2687 ;; that works ok in practice (people should not use that variable elsewhere).
2688 ;; We used to use an uninterned symbol; the compiler handles that properly
2689 ;; now, but it generates slower code.
2690 (defmacro save-match-data (&rest body)
2691 "Execute the BODY forms, restoring the global value of the match data.
2692 The value returned is the value of the last form in BODY."
2693 ;; It is better not to use backquote here,
2694 ;; because that makes a bootstrapping problem
2695 ;; if you need to recompile all the Lisp files using interpreted code.
2696 (declare (indent 0) (debug t))
2698 '((save-match-data-internal (match-data)))
2699 (list 'unwind-protect
2701 ;; It is safe to free (evaporate) markers immediately here,
2702 ;; as Lisp programs should not copy from save-match-data-internal.
2703 '(set-match-data save-match-data-internal 'evaporate))))
2705 (defun match-string (num &optional string)
2706 "Return string of text matched by last search.
2707 NUM specifies which parenthesized expression in the last regexp.
2708 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2709 Zero means the entire text matched by the whole regexp or whole string.
2710 STRING should be given if the last search was by `string-match' on STRING."
2711 (if (match-beginning num)
2713 (substring string (match-beginning num) (match-end num))
2714 (buffer-substring (match-beginning num) (match-end num)))))
2716 (defun match-string-no-properties (num &optional string)
2717 "Return string of text matched by last search, without text properties.
2718 NUM specifies which parenthesized expression in the last regexp.
2719 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2720 Zero means the entire text matched by the whole regexp or whole string.
2721 STRING should be given if the last search was by `string-match' on STRING."
2722 (if (match-beginning num)
2724 (substring-no-properties string (match-beginning num)
2726 (buffer-substring-no-properties (match-beginning num)
2730 (defun match-substitute-replacement (replacement
2731 &optional fixedcase literal string subexp)
2732 "Return REPLACEMENT as it will be inserted by `replace-match'.
2733 In other words, all back-references in the form `\\&' and `\\N'
2734 are substituted with actual strings matched by the last search.
2735 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
2736 meaning as for `replace-match'."
2737 (let ((match (match-string 0 string)))
2739 (set-match-data (mapcar (lambda (x)
2741 (- x (match-beginning 0))
2744 (replace-match replacement fixedcase literal match subexp))))
2747 (defun looking-back (regexp &optional limit greedy)
2748 "Return non-nil if text before point matches regular expression REGEXP.
2749 Like `looking-at' except matches before point, and is slower.
2750 LIMIT if non-nil speeds up the search by specifying a minimum
2751 starting position, to avoid checking matches that would start
2754 If GREEDY is non-nil, extend the match backwards as far as possible,
2755 stopping when a single additional previous character cannot be part
2756 of a match for REGEXP."
2757 (let ((start (point))
2760 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2762 (if (and greedy pos)
2764 (narrow-to-region (point-min) start)
2765 (while (and (> pos (point-min))
2769 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2770 (setq pos (1- pos)))
2773 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2776 (defsubst looking-at-p (regexp)
2778 Same as `looking-at' except this function does not change the match data."
2779 (let ((inhibit-changing-match-data t))
2780 (looking-at regexp)))
2782 (defsubst string-match-p (regexp string &optional start)
2784 Same as `string-match' except this function does not change the match data."
2785 (let ((inhibit-changing-match-data t))
2786 (string-match regexp string start)))
2788 (defun subregexp-context-p (regexp pos &optional start)
2789 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2790 A subregexp context is one where a sub-regexp can appear.
2791 A non-subregexp context is for example within brackets, or within a
2792 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2793 If START is non-nil, it should be a position in REGEXP, smaller
2794 than POS, and known to be in a subregexp context."
2795 ;; Here's one possible implementation, with the great benefit that it
2796 ;; reuses the regexp-matcher's own parser, so it understands all the
2797 ;; details of the syntax. A disadvantage is that it needs to match the
2801 (string-match (substring regexp (or start 0) pos) "")
2804 (not (member (cadr err) '("Unmatched [ or [^"
2806 "Trailing backslash")))))
2807 ;; An alternative implementation:
2808 ;; (defconst re-context-re
2809 ;; (let* ((harmless-ch "[^\\[]")
2810 ;; (harmless-esc "\\\\[^{]")
2811 ;; (class-harmless-ch "[^][]")
2812 ;; (class-lb-harmless "[^]:]")
2813 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2814 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2815 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2817 ;; (concat "\\[^?]?"
2818 ;; "\\(" class-harmless-ch
2819 ;; "\\|" class-lb "\\)*"
2820 ;; "\\[?]")) ; special handling for bare [ at end of re
2821 ;; (braces "\\\\{[0-9,]+\\\\}"))
2822 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2823 ;; "\\|" class "\\|" braces "\\)*\\'"))
2824 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2825 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2830 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2831 "The default value of separators for `split-string'.
2833 A regexp matching strings of whitespace. May be locale-dependent
2834 \(as yet unimplemented). Should not match non-breaking spaces.
2836 Warning: binding this to a different value and using it as default is
2837 likely to have undesired semantics.")
2839 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2840 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2841 ;; expression leads to the equivalent implementation that if SEPARATORS
2842 ;; is defaulted, OMIT-NULLS is treated as t.
2843 (defun split-string (string &optional separators omit-nulls)
2844 "Split STRING into substrings bounded by matches for SEPARATORS.
2846 The beginning and end of STRING, and each match for SEPARATORS, are
2847 splitting points. The substrings matching SEPARATORS are removed, and
2848 the substrings between the splitting points are collected as a list,
2851 If SEPARATORS is non-nil, it should be a regular expression matching text
2852 which separates, but is not part of, the substrings. If nil it defaults to
2853 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2854 OMIT-NULLS is forced to t.
2856 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2857 that for the default value of SEPARATORS leading and trailing whitespace
2858 are effectively trimmed). If nil, all zero-length substrings are retained,
2859 which correctly parses CSV format, for example.
2861 Note that the effect of `(split-string STRING)' is the same as
2862 `(split-string STRING split-string-default-separators t)'. In the rare
2863 case that you wish to retain zero-length substrings when splitting on
2864 whitespace, use `(split-string STRING split-string-default-separators)'.
2866 Modifies the match data; use `save-match-data' if necessary."
2867 (let ((keep-nulls (not (if separators omit-nulls t)))
2868 (rexp (or separators split-string-default-separators))
2872 (while (and (string-match rexp string
2874 (= start (match-beginning 0))
2875 (< start (length string)))
2877 (< start (length string)))
2879 (if (or keep-nulls (< start (match-beginning 0)))
2881 (cons (substring string start (match-beginning 0))
2883 (setq start (match-end 0)))
2884 (if (or keep-nulls (< start (length string)))
2886 (cons (substring string start)
2890 (defun combine-and-quote-strings (strings &optional separator)
2891 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
2892 This tries to quote the strings to avoid ambiguity such that
2893 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2894 Only some SEPARATORs will work properly."
2895 (let* ((sep (or separator " "))
2896 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
2899 (if (string-match re str)
2900 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
2904 (defun split-string-and-unquote (string &optional separator)
2905 "Split the STRING into a list of strings.
2906 It understands Emacs Lisp quoting within STRING, such that
2907 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2908 The SEPARATOR regexp defaults to \"\\s-+\"."
2909 (let ((sep (or separator "\\s-+"))
2910 (i (string-match "[\"]" string)))
2912 (split-string string sep t) ; no quoting: easy
2913 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
2914 (let ((rfs (read-from-string string i)))
2916 (split-string-and-unquote (substring string (cdr rfs))
2920 ;;;; Replacement in strings.
2922 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2923 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2924 Unless optional argument INPLACE is non-nil, return a new string."
2925 (let ((i (length string))
2926 (newstr (if inplace string (copy-sequence string))))
2929 (if (eq (aref newstr i) fromchar)
2930 (aset newstr i tochar)))
2933 (defun replace-regexp-in-string (regexp rep string &optional
2934 fixedcase literal subexp start)
2935 "Replace all matches for REGEXP with REP in STRING.
2937 Return a new string containing the replacements.
2939 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2940 arguments with the same names of function `replace-match'. If START
2941 is non-nil, start replacements at that index in STRING.
2943 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2944 function. If it is a function, it is called with the actual text of each
2945 match, and its value is used as the replacement text. When REP is called,
2946 the match-data are the result of matching REGEXP against a substring
2949 To replace only the first match (if any), make REGEXP match up to \\'
2950 and replace a sub-expression, e.g.
2951 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2955 ;; To avoid excessive consing from multiple matches in long strings,
2956 ;; don't just call `replace-match' continually. Walk down the
2957 ;; string looking for matches of REGEXP and building up a (reversed)
2958 ;; list MATCHES. This comprises segments of STRING which weren't
2959 ;; matched interspersed with replacements for segments that were.
2960 ;; [For a `large' number of replacements it's more efficient to
2961 ;; operate in a temporary buffer; we can't tell from the function's
2962 ;; args whether to choose the buffer-based implementation, though it
2963 ;; might be reasonable to do so for long enough STRING.]
2964 (let ((l (length string))
2965 (start (or start 0))
2968 (while (and (< start l) (string-match regexp string start))
2969 (setq mb (match-beginning 0)
2971 ;; If we matched the empty string, make sure we advance by one char
2972 (when (= me mb) (setq me (min l (1+ mb))))
2973 ;; Generate a replacement for the matched substring.
2974 ;; Operate only on the substring to minimize string consing.
2975 ;; Set up match data for the substring for replacement;
2976 ;; presumably this is likely to be faster than munging the
2977 ;; match data directly in Lisp.
2978 (string-match regexp (setq str (substring string mb me)))
2980 (cons (replace-match (if (stringp rep)
2982 (funcall rep (match-string 0 str)))
2983 fixedcase literal str subexp)
2984 (cons (substring string start mb) ; unmatched prefix
2987 ;; Reconstruct a string from the pieces.
2988 (setq matches (cons (substring string start l) matches)) ; leftover
2989 (apply #'concat (nreverse matches)))))
2991 ;;;; invisibility specs
2993 (defun add-to-invisibility-spec (element)
2994 "Add ELEMENT to `buffer-invisibility-spec'.
2995 See documentation for `buffer-invisibility-spec' for the kind of elements
2997 (if (eq buffer-invisibility-spec t)
2998 (setq buffer-invisibility-spec (list t)))
2999 (setq buffer-invisibility-spec
3000 (cons element buffer-invisibility-spec)))
3002 (defun remove-from-invisibility-spec (element)
3003 "Remove ELEMENT from `buffer-invisibility-spec'."
3004 (if (consp buffer-invisibility-spec)
3005 (setq buffer-invisibility-spec
3006 (delete element buffer-invisibility-spec))))
3010 (defmacro with-syntax-table (table &rest body)
3011 "Evaluate BODY with syntax table of current buffer set to TABLE.
3012 The syntax table of the current buffer is saved, BODY is evaluated, and the
3013 saved table is restored, even in case of an abnormal exit.
3014 Value is what BODY returns."
3016 (let ((old-table (make-symbol "table"))
3017 (old-buffer (make-symbol "buffer")))
3018 `(let ((,old-table (syntax-table))
3019 (,old-buffer (current-buffer)))
3022 (set-syntax-table ,table)
3024 (save-current-buffer
3025 (set-buffer ,old-buffer)
3026 (set-syntax-table ,old-table))))))
3028 (defun make-syntax-table (&optional oldtable)
3029 "Return a new syntax table.
3030 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3031 from `standard-syntax-table' otherwise."
3032 (let ((table (make-char-table 'syntax-table nil)))
3033 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3036 (defun syntax-after (pos)
3037 "Return the raw syntax of the char after POS.
3038 If POS is outside the buffer's accessible portion, return nil."
3039 (unless (or (< pos (point-min)) (>= pos (point-max)))
3040 (let ((st (if parse-sexp-lookup-properties
3041 (get-char-property pos 'syntax-table))))
3043 (aref (or st (syntax-table)) (char-after pos))))))
3045 (defun syntax-class (syntax)
3046 "Return the syntax class part of the syntax descriptor SYNTAX.
3047 If SYNTAX is nil, return nil."
3048 (and syntax (logand (car syntax) 65535)))
3052 (defun text-clone-maintain (ol1 after beg end &optional len)
3053 "Propagate the changes made under the overlay OL1 to the other clones.
3054 This is used on the `modification-hooks' property of text clones."
3055 (when (and after (not undo-in-progress) (overlay-start ol1))
3056 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3057 (setq beg (max beg (+ (overlay-start ol1) margin)))
3058 (setq end (min end (- (overlay-end ol1) margin)))
3061 (when (overlay-get ol1 'text-clone-syntax)
3062 ;; Check content of the clone's text.
3063 (let ((cbeg (+ (overlay-start ol1) margin))
3064 (cend (- (overlay-end ol1) margin)))
3067 (if (not (re-search-forward
3068 (overlay-get ol1 'text-clone-syntax) cend t))
3069 ;; Mark the overlay for deletion.
3070 (overlay-put ol1 'text-clones nil)
3071 (when (< (match-end 0) cend)
3072 ;; Shrink the clone at its end.
3073 (setq end (min end (match-end 0)))
3074 (move-overlay ol1 (overlay-start ol1)
3075 (+ (match-end 0) margin)))
3076 (when (> (match-beginning 0) cbeg)
3077 ;; Shrink the clone at its beginning.
3078 (setq beg (max (match-beginning 0) beg))
3079 (move-overlay ol1 (- (match-beginning 0) margin)
3080 (overlay-end ol1)))))))
3081 ;; Now go ahead and update the clones.
3082 (let ((head (- beg (overlay-start ol1)))
3083 (tail (- (overlay-end ol1) end))
3084 (str (buffer-substring beg end))
3086 (inhibit-modification-hooks t))
3087 (dolist (ol2 (overlay-get ol1 'text-clones))
3088 (let ((oe (overlay-end ol2)))
3089 (unless (or (eq ol1 ol2) (null oe))
3090 (setq nothing-left nil)
3091 (let ((mod-beg (+ (overlay-start ol2) head)))
3092 ;;(overlay-put ol2 'modification-hooks nil)
3093 (goto-char (- (overlay-end ol2) tail))
3094 (unless (> mod-beg (point))
3095 (save-excursion (insert str))
3096 (delete-region mod-beg (point)))
3097 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3099 (if nothing-left (delete-overlay ol1))))))))
3101 (defun text-clone-create (start end &optional spreadp syntax)
3102 "Create a text clone of START...END at point.
3103 Text clones are chunks of text that are automatically kept identical:
3104 changes done to one of the clones will be immediately propagated to the other.
3106 The buffer's content at point is assumed to be already identical to
3107 the one between START and END.
3108 If SYNTAX is provided it's a regexp that describes the possible text of
3109 the clones; the clone will be shrunk or killed if necessary to ensure that
3110 its text matches the regexp.
3111 If SPREADP is non-nil it indicates that text inserted before/after the
3112 clone should be incorporated in the clone."
3113 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3114 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3115 ;; (with a one-char margin at each end) with `t nil'.
3116 ;; We opted for a larger overlay because it behaves better in the case
3117 ;; where the clone is reduced to the empty string (we want the overlay to
3118 ;; stay when the clone's content is the empty string and we want to use
3119 ;; `evaporate' to make sure those overlays get deleted when needed).
3121 (let* ((pt-end (+ (point) (- end start)))
3122 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3124 (end-margin (if (or (not spreadp)
3125 (>= pt-end (point-max))
3126 (>= start (point-max)))
3128 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3129 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3130 (dups (list ol1 ol2)))
3131 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3132 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3133 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3134 ;;(overlay-put ol1 'face 'underline)
3135 (overlay-put ol1 'evaporate t)
3136 (overlay-put ol1 'text-clones dups)
3138 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3139 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3140 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3141 ;;(overlay-put ol2 'face 'underline)
3142 (overlay-put ol2 'evaporate t)
3143 (overlay-put ol2 'text-clones dups)))
3145 ;;;; Mail user agents.
3147 ;; Here we include just enough for other packages to be able
3150 (defun define-mail-user-agent (symbol composefunc sendfunc
3151 &optional abortfunc hookvar)
3152 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3154 SYMBOL can be any Lisp symbol. Its function definition and/or
3155 value as a variable do not matter for this usage; we use only certain
3156 properties on its property list, to encode the rest of the arguments.
3158 COMPOSEFUNC is program callable function that composes an outgoing
3159 mail message buffer. This function should set up the basics of the
3160 buffer without requiring user interaction. It should populate the
3161 standard mail headers, leaving the `to:' and `subject:' headers blank
3164 COMPOSEFUNC should accept several optional arguments--the same
3165 arguments that `compose-mail' takes. See that function's documentation.
3167 SENDFUNC is the command a user would run to send the message.
3169 Optional ABORTFUNC is the command a user would run to abort the
3170 message. For mail packages that don't have a separate abort function,
3171 this can be `kill-buffer' (the equivalent of omitting this argument).
3173 Optional HOOKVAR is a hook variable that gets run before the message
3174 is actually sent. Callers that use the `mail-user-agent' may
3175 install a hook function temporarily on this hook variable.
3176 If HOOKVAR is nil, `mail-send-hook' is used.
3178 The properties used on SYMBOL are `composefunc', `sendfunc',
3179 `abortfunc', and `hookvar'."
3180 (put symbol 'composefunc composefunc)
3181 (put symbol 'sendfunc sendfunc)
3182 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3183 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3185 ;;;; Progress reporters.
3187 ;; Progress reporter has the following structure:
3189 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3196 ;; This weirdeness is for optimization reasons: we want
3197 ;; `progress-reporter-update' to be as fast as possible, so
3198 ;; `(car reporter)' is better than `(aref reporter 0)'.
3200 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3201 ;; digits of precision, it doesn't really matter here. On the other
3202 ;; hand, it greatly simplifies the code.
3204 (defsubst progress-reporter-update (reporter value)
3205 "Report progress of an operation in the echo area.
3206 However, if the change since last echo area update is too small
3207 or not enough time has passed, then do nothing (see
3208 `make-progress-reporter' for details).
3210 First parameter, REPORTER, should be the result of a call to
3211 `make-progress-reporter'. Second, VALUE, determines the actual
3212 progress of operation; it must be between MIN-VALUE and MAX-VALUE
3213 as passed to `make-progress-reporter'.
3215 This function is very inexpensive, you may not bother how often
3217 (when (>= value (car reporter))
3218 (progress-reporter-do-update reporter value)))
3220 (defun make-progress-reporter (message min-value max-value
3221 &optional current-value
3222 min-change min-time)
3223 "Return progress reporter object to be used with `progress-reporter-update'.
3225 MESSAGE is shown in the echo area. When at least 1% of operation
3226 is complete, the exact percentage will be appended to the
3227 MESSAGE. When you call `progress-reporter-done', word \"done\"
3228 is printed after the MESSAGE. You can change MESSAGE of an
3229 existing progress reporter with `progress-reporter-force-update'.
3231 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
3232 final (100% complete) states of operation. The latter should be
3233 larger; if this is not the case, then simply negate all values.
3234 Optional CURRENT-VALUE specifies the progress by the moment you
3235 call this function. You should omit it or set it to nil in most
3236 cases since it defaults to MIN-VALUE.
3238 Optional MIN-CHANGE determines the minimal change in percents to
3239 report (default is 1%.) Optional MIN-TIME specifies the minimal
3240 time before echo area updates (default is 0.2 seconds.) If
3241 `float-time' function is not present, then time is not tracked
3242 at all. If OS is not capable of measuring fractions of seconds,
3243 then this parameter is effectively rounded up."
3246 (setq min-time 0.2))
3248 (cons min-value ;; Force a call to `message' now
3249 (vector (if (and (fboundp 'float-time)
3255 (if min-change (max (min min-change 50) 1) 1)
3257 (progress-reporter-update reporter (or current-value min-value))
3260 (defun progress-reporter-force-update (reporter value &optional new-message)
3261 "Report progress of an operation in the echo area unconditionally.
3263 First two parameters are the same as for
3264 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
3265 change the displayed message."
3266 (let ((parameters (cdr reporter)))
3268 (aset parameters 3 new-message))
3269 (when (aref parameters 0)
3270 (aset parameters 0 (float-time)))
3271 (progress-reporter-do-update reporter value)))
3273 (defun progress-reporter-do-update (reporter value)
3274 (let* ((parameters (cdr reporter))
3275 (min-value (aref parameters 1))
3276 (max-value (aref parameters 2))
3277 (one-percent (/ (- max-value min-value) 100.0))
3278 (percentage (if (= max-value min-value)
3280 (truncate (/ (- value min-value) one-percent))))
3281 (update-time (aref parameters 0))
3282 (current-time (float-time))
3284 ;; See if enough time has passed since the last update.
3285 (or (not update-time)
3286 (when (>= current-time update-time)
3287 ;; Calculate time for the next update
3288 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3290 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
3291 ;; message this time because not enough time has passed, then use
3292 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
3293 ;; updates closer to MIN-TIME.
3295 (min (+ min-value (* (+ percentage
3296 (if enough-time-passed
3297 (aref parameters 4) ;; MIN-CHANGE
3301 (when (integerp value)
3302 (setcar reporter (ceiling (car reporter))))
3304 ;; Only print message if enough time has passed
3305 (when enough-time-passed
3306 (if (> percentage 0)
3307 (message "%s%d%%" (aref parameters 3) percentage)
3308 (message "%s" (aref parameters 3))))))
3310 (defun progress-reporter-done (reporter)
3311 "Print reporter's message followed by word \"done\" in echo area."
3312 (message "%sdone" (aref (cdr reporter) 3)))
3314 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3315 "Loop a certain number of times and report progress in the echo area.
3316 Evaluate BODY with VAR bound to successive integers running from
3317 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3318 the return value (nil if RESULT is omitted).
3320 At each iteration MESSAGE followed by progress percentage is
3321 printed in the echo area. After the loop is finished, MESSAGE
3322 followed by word \"done\" is printed. This macro is a
3323 convenience wrapper around `make-progress-reporter' and friends.
3325 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3326 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3327 (let ((temp (make-symbol "--dotimes-temp--"))
3328 (temp2 (make-symbol "--dotimes-temp2--"))
3332 (,(car spec) ,start)
3333 (,temp2 (make-progress-reporter ,message ,start ,end)))
3334 (while (< ,(car spec) ,temp)
3336 (progress-reporter-update ,temp2
3337 (setq ,(car spec) (1+ ,(car spec)))))
3338 (progress-reporter-done ,temp2)
3339 nil ,@(cdr (cdr spec)))))
3342 ;;;; Comparing version strings.
3344 (defvar version-separator "."
3345 "*Specify the string used to separate the version elements.
3347 Usually the separator is \".\", but it can be any other string.")
3350 (defvar version-regexp-alist
3351 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3352 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3353 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3354 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3355 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3356 "*Specify association between non-numeric version part and a priority.
3358 This association is used to handle version string like \"1.0pre2\",
3359 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3360 non-numeric part to an integer. For example:
3362 String Version Integer List Version
3363 \"1.0pre2\" (1 0 -1 2)
3364 \"1.0PRE2\" (1 0 -1 2)
3365 \"22.8beta3\" (22 8 -2 3)
3366 \"22.8 Beta3\" (22 8 -2 3)
3367 \"0.9alpha1\" (0 9 -3 1)
3368 \"0.9AlphA1\" (0 9 -3 1)
3369 \"0.9 alpha\" (0 9 -3)
3371 Each element has the following form:
3377 REGEXP regexp used to match non-numeric part of a version string.
3378 It should begin with a `^' anchor and end with a `$' to
3379 prevent false hits. Letter-case is ignored while matching
3382 PRIORITY negative integer which indicate the non-numeric priority.")
3385 (defun version-to-list (ver)
3386 "Convert version string VER into an integer list.
3388 The version syntax is given by the following EBNF:
3390 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3392 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3394 SEPARATOR ::= `version-separator' (which see)
3395 | `version-regexp-alist' (which see).
3397 The NUMBER part is optional if SEPARATOR is a match for an element
3398 in `version-regexp-alist'.
3400 As an example of valid version syntax:
3402 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3404 As an example of invalid version syntax:
3406 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3408 As an example of version convertion:
3410 String Version Integer List Version
3411 \"1.0.7.5\" (1 0 7 5)
3412 \"1.0pre2\" (1 0 -1 2)
3413 \"1.0PRE2\" (1 0 -1 2)
3414 \"22.8beta3\" (22 8 -2 3)
3415 \"22.8Beta3\" (22 8 -2 3)
3416 \"0.9alpha1\" (0 9 -3 1)
3417 \"0.9AlphA1\" (0 9 -3 1)
3418 \"0.9alpha\" (0 9 -3)
3420 See documentation for `version-separator' and `version-regexp-alist'."
3421 (or (and (stringp ver) (> (length ver) 0))
3422 (error "Invalid version string: '%s'" ver))
3423 ;; Change .x.y to 0.x.y
3424 (if (and (>= (length ver) (length version-separator))
3425 (string-equal (substring ver 0 (length version-separator))
3427 (setq ver (concat "0" ver)))
3430 (case-fold-search t) ; ignore case in matching
3432 (while (and (setq s (string-match "[0-9]+" ver i))
3434 ;; handle numeric part
3435 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3438 ;; handle non-numeric part
3439 (when (and (setq s (string-match "[^0-9]+" ver i))
3441 (setq s (substring ver i (match-end 0))
3443 ;; handle alpha, beta, pre, etc. separator
3444 (unless (string= s version-separator)
3445 (setq al version-regexp-alist)
3446 (while (and al (not (string-match (caar al) s)))
3448 (or al (error "Invalid version syntax: '%s'" ver))
3449 (setq lst (cons (cdar al) lst)))))
3451 (error "Invalid version syntax: '%s'" ver)
3455 (defun version-list-< (l1 l2)
3456 "Return t if integer list L1 is lesser than L2.
3458 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3459 etc. That is, the trailing zeroes are irrelevant. Also, integer
3460 list (1) is greater than (1 -1) which is greater than (1 -2)
3461 which is greater than (1 -3)."
3462 (while (and l1 l2 (= (car l1) (car l2)))
3466 ;; l1 not null and l2 not null
3467 ((and l1 l2) (< (car l1) (car l2)))
3468 ;; l1 null and l2 null ==> l1 length = l2 length
3469 ((and (null l1) (null l2)) nil)
3470 ;; l1 not null and l2 null ==> l1 length > l2 length
3471 (l1 (< (version-list-not-zero l1) 0))
3472 ;; l1 null and l2 not null ==> l2 length > l1 length
3473 (t (< 0 (version-list-not-zero l2)))))
3476 (defun version-list-= (l1 l2)
3477 "Return t if integer list L1 is equal to 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)))
3487 ;; l1 not null and l2 not null
3489 ;; l1 null and l2 null ==> l1 length = l2 length
3490 ((and (null l1) (null l2)))
3491 ;; l1 not null and l2 null ==> l1 length > l2 length
3492 (l1 (zerop (version-list-not-zero l1)))
3493 ;; l1 null and l2 not null ==> l2 length > l1 length
3494 (t (zerop (version-list-not-zero l2)))))
3497 (defun version-list-<= (l1 l2)
3498 "Return t if integer list L1 is lesser than or 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)))
3508 ;; l1 not null and l2 not null
3509 ((and l1 l2) (< (car l1) (car l2)))
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 (<= (version-list-not-zero l1) 0))
3514 ;; l1 null and l2 not null ==> l2 length > l1 length
3515 (t (<= 0 (version-list-not-zero l2)))))
3517 (defun version-list-not-zero (lst)
3518 "Return the first non-zero element of integer list LST.
3520 If all LST elements are zeroes or LST is nil, return zero."
3521 (while (and lst (zerop (car lst)))
3522 (setq lst (cdr lst)))
3525 ;; there is no element different of zero
3529 (defun version< (v1 v2)
3530 "Return t if version V1 is lesser than V2.
3532 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3533 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3534 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3536 (version-list-< (version-to-list v1) (version-to-list v2)))
3539 (defun version<= (v1 v2)
3540 "Return t if version V1 is lesser than or equal to V2.
3542 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3543 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3544 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3546 (version-list-<= (version-to-list v1) (version-to-list v2)))
3548 (defun version= (v1 v2)
3549 "Return t if version V1 is equal to V2.
3551 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3552 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3553 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3555 (version-list-= (version-to-list v1) (version-to-list v2)))
3559 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3560 ;;; subr.el ends here