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, 2009 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/>.
28 (defvar custom-declare-variable-list nil
29 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
30 Each element of this list holds the arguments to one call to `defcustom'.")
32 ;; Use this, rather than defcustom, in subr.el and other files loaded
34 (defun custom-declare-variable-early (&rest arguments
)
35 (setq custom-declare-variable-list
36 (cons arguments custom-declare-variable-list
)))
38 (defmacro declare-function
(fn file
&optional arglist fileonly
)
39 "Tell the byte-compiler that function FN is defined, in FILE.
40 Optional ARGLIST is the argument list used by the function. The
41 FILE argument is not used by the byte-compiler, but by the
42 `check-declare' package, which checks that FILE contains a
43 definition for FN. ARGLIST is used by both the byte-compiler and
44 `check-declare' to check for consistency.
46 FILE can be either a Lisp file (in which case the \".el\"
47 extension is optional), or a C file. C files are expanded
48 relative to the Emacs \"src/\" directory. Lisp files are
49 searched for using `locate-library', and if that fails they are
50 expanded relative to the location of the file containing the
51 declaration. A FILE with an \"ext:\" prefix is an external file.
52 `check-declare' will check such files if they are found, and skip
53 them without error if they are not.
55 FILEONLY non-nil means that `check-declare' will only check that
56 FILE exists, not that it defines FN. This is intended for
57 function-definitions that `check-declare' does not recognize, e.g.
60 To specify a value for FILEONLY without passing an argument list,
61 set ARGLIST to `t'. This is necessary because `nil' means an
62 empty argument list, rather than an unspecified one.
64 Note that for the purposes of `check-declare', this statement
65 must be the first non-whitespace on a line, and everything up to
66 the end of FILE must be all on the same line. For example:
68 \(declare-function c-end-of-defun \"progmodes/cc-cmds.el\"
71 For more information, see Info node `(elisp)Declaring Functions'."
72 ;; Does nothing - byte-compile-declare-function does the work.
76 ;;;; Basic Lisp macros.
80 (defmacro noreturn
(form)
81 "Evaluate FORM, expecting it not to return.
82 If FORM does return, signal an error."
84 (error "Form marked with `noreturn' did return")))
86 (defmacro 1value
(form)
87 "Evaluate FORM, expecting a constant return value.
88 This is the global do-nothing version. There is also `testcover-1value'
89 that complains if FORM ever does return differing values."
92 (defmacro def-edebug-spec
(symbol spec
)
93 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
94 Both SYMBOL and SPEC are unevaluated. The SPEC can be 0, t, a symbol
95 \(naming a function), or a list."
96 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
98 (defmacro lambda
(&rest cdr
)
99 "Return a lambda expression.
100 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
101 self-quoting; the result of evaluating the lambda expression is the
102 expression itself. The lambda expression may then be treated as a
103 function, i.e., stored as the function value of a symbol, passed to
104 `funcall' or `mapcar', etc.
106 ARGS should take the same form as an argument list for a `defun'.
107 DOCSTRING is an optional documentation string.
108 If present, it should describe how to call the function.
109 But documentation strings are usually not useful in nameless functions.
110 INTERACTIVE should be a call to the function `interactive', which see.
111 It may also be omitted.
112 BODY should be a list of Lisp expressions.
114 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
115 ;; Note that this definition should not use backquotes; subr.el should not
116 ;; depend on backquote.el.
117 (list 'function
(cons 'lambda cdr
)))
119 (defmacro push
(newelt listname
)
120 "Add NEWELT to the list stored in the symbol LISTNAME.
121 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
122 LISTNAME must be a symbol."
123 (declare (debug (form sexp
)))
125 (list 'cons newelt listname
)))
127 (defmacro pop
(listname)
128 "Return the first element of LISTNAME's value, and remove it from the list.
129 LISTNAME must be a symbol whose value is a list.
130 If the value is nil, `pop' returns nil but does not actually
132 (declare (debug (sexp)))
134 (list 'prog1 listname
135 (list 'setq listname
(list 'cdr listname
)))))
137 (defmacro when
(cond &rest body
)
138 "If COND yields non-nil, do BODY, else return nil.
139 When COND yields non-nil, eval BODY forms sequentially and return
140 value of last one, or nil if there are none.
143 (declare (indent 1) (debug t
))
144 (list 'if cond
(cons 'progn body
)))
146 (defmacro unless
(cond &rest body
)
147 "If COND yields nil, do BODY, else return nil.
148 When COND yields nil, eval BODY forms sequentially and return
149 value of last one, or nil if there are none.
152 (declare (indent 1) (debug t
))
153 (cons 'if
(cons cond
(cons nil body
))))
155 (defvar --dolist-tail-- nil
156 "Temporary variable used in `dolist' expansion.")
158 (defmacro dolist
(spec &rest body
)
160 Evaluate BODY with VAR bound to each car from LIST, in turn.
161 Then evaluate RESULT to get return value, default nil.
163 \(fn (VAR LIST [RESULT]) BODY...)"
164 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
165 ;; It would be cleaner to create an uninterned symbol,
166 ;; but that uses a lot more space when many functions in many files
168 (let ((temp '--dolist-tail--
))
169 `(let ((,temp
,(nth 1 spec
))
172 (setq ,(car spec
) (car ,temp
))
174 (setq ,temp
(cdr ,temp
)))
175 ,@(if (cdr (cdr spec
))
176 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
)))))))
178 (defvar --dotimes-limit-- nil
179 "Temporary variable used in `dotimes' expansion.")
181 (defmacro dotimes
(spec &rest body
)
182 "Loop a certain number of times.
183 Evaluate BODY with VAR bound to successive integers running from 0,
184 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
185 the return value (nil if RESULT is omitted).
187 \(fn (VAR COUNT [RESULT]) BODY...)"
188 (declare (indent 1) (debug dolist
))
189 ;; It would be cleaner to create an uninterned symbol,
190 ;; but that uses a lot more space when many functions in many files
192 (let ((temp '--dotimes-limit--
)
196 (,(car spec
) ,start
))
197 (while (< ,(car spec
) ,temp
)
199 (setq ,(car spec
) (1+ ,(car spec
))))
200 ,@(cdr (cdr spec
)))))
202 (defmacro declare
(&rest specs
)
203 "Do not evaluate any arguments and return nil.
204 Treated as a declaration when used at the right place in a
205 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
208 (defmacro ignore-errors
(&rest body
)
209 "Execute BODY; if an error occurs, return nil.
210 Otherwise, return result of last form in BODY."
211 `(condition-case nil
(progn ,@body
) (error nil
)))
213 ;;;; Basic Lisp functions.
215 (defun ignore (&rest ignore
)
216 "Do nothing and return nil.
217 This function accepts any number of arguments, but ignores them."
221 (defun error (&rest args
)
222 "Signal an error, making error message by passing all args to `format'.
223 In Emacs, the convention is that error messages start with a capital
224 letter but *do not* end with a period. Please follow this convention
225 for the sake of consistency."
227 (signal 'error
(list (apply 'format args
)))))
229 ;; We put this here instead of in frame.el so that it's defined even on
230 ;; systems where frame.el isn't loaded.
231 (defun frame-configuration-p (object)
232 "Return non-nil if OBJECT seems to be a frame configuration.
233 Any list whose car is `frame-configuration' is assumed to be a frame
236 (eq (car object
) 'frame-configuration
)))
238 (defun functionp (object)
239 "Non-nil if OBJECT is a function."
240 (or (and (symbolp object
) (fboundp object
)
242 (setq object
(indirect-function object
))
244 (eq (car-safe object
) 'autoload
)
245 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object
)))))))
247 ;; Filter out special forms.
248 (not (eq 'unevalled
(cdr (subr-arity object
)))))
249 (byte-code-function-p object
)
250 (eq (car-safe object
) 'lambda
)))
255 "Return the car of the car of X."
259 "Return the car of the cdr of X."
263 "Return the cdr of the car of X."
267 "Return the cdr of the cdr of X."
270 (defun last (list &optional n
)
271 "Return the last link of LIST. Its car is the last element.
272 If LIST is nil, return nil.
273 If N is non-nil, return the Nth-to-last link of LIST.
274 If N is bigger than the length of LIST, return LIST."
276 (let ((m 0) (p list
))
278 (setq m
(1+ m
) p
(cdr p
)))
280 (if (< n m
) (nthcdr (- m n
) list
) list
)))
281 (while (consp (cdr list
))
282 (setq list
(cdr list
)))
285 (defun butlast (list &optional n
)
286 "Return a copy of LIST with the last N elements removed."
287 (if (and n
(<= n
0)) list
288 (nbutlast (copy-sequence list
) n
)))
290 (defun nbutlast (list &optional n
)
291 "Modifies LIST to remove the last N elements."
292 (let ((m (length list
)))
296 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
299 (defun delete-dups (list)
300 "Destructively remove `equal' duplicates from LIST.
301 Store the result in LIST and return it. LIST must be a proper list.
302 Of several `equal' occurrences of an element in LIST, the first
306 (setcdr tail
(delete (car tail
) (cdr tail
)))
307 (setq tail
(cdr tail
))))
310 (defun number-sequence (from &optional to inc
)
311 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
312 INC is the increment used between numbers in the sequence and defaults to 1.
313 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
314 zero. TO is only included if there is an N for which TO = FROM + N * INC.
315 If TO is nil or numerically equal to FROM, return \(FROM).
316 If INC is positive and TO is less than FROM, or INC is negative
317 and TO is larger than FROM, return nil.
318 If INC is zero and TO is neither nil nor numerically equal to
319 FROM, signal an error.
321 This function is primarily designed for integer arguments.
322 Nevertheless, FROM, TO and INC can be integer or float. However,
323 floating point arithmetic is inexact. For instance, depending on
324 the machine, it may quite well happen that
325 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
326 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
327 elements. Thus, if some of the arguments are floats and one wants
328 to make sure that TO is included, one may have to explicitly write
329 TO as \(+ FROM \(* N INC)) or use a variable whose value was
330 computed with this exact expression. Alternatively, you can,
331 of course, also replace TO with a slightly larger value
332 \(or a slightly more negative value if INC is negative)."
333 (if (or (not to
) (= from to
))
335 (or inc
(setq inc
1))
336 (when (zerop inc
) (error "The increment can not be zero"))
337 (let (seq (n 0) (next from
))
340 (setq seq
(cons next seq
)
342 next
(+ from
(* n inc
))))
344 (setq seq
(cons next seq
)
346 next
(+ from
(* n inc
)))))
349 (defun copy-tree (tree &optional vecp
)
350 "Make a copy of TREE.
351 If TREE is a cons cell, this recursively copies both its car and its cdr.
352 Contrast to `copy-sequence', which copies only along the cdrs. With second
353 argument VECP, this copies vectors as well as conses."
357 (let ((newcar (car tree
)))
358 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
359 (setq newcar
(copy-tree (car tree
) vecp
)))
360 (push newcar result
))
361 (setq tree
(cdr tree
)))
362 (nconc (nreverse result
) tree
))
363 (if (and vecp
(vectorp tree
))
364 (let ((i (length (setq tree
(copy-sequence tree
)))))
365 (while (>= (setq i
(1- i
)) 0)
366 (aset tree i
(copy-tree (aref tree i
) vecp
)))
370 ;;;; Various list-search functions.
372 (defun assoc-default (key alist
&optional test default
)
373 "Find object KEY in a pseudo-alist ALIST.
374 ALIST is a list of conses or objects. Each element
375 (or the element's car, if it is a cons) is compared with KEY by
376 calling TEST, with two arguments: (i) the element or its car,
378 If that is non-nil, the element matches; then `assoc-default'
379 returns the element's cdr, if it is a cons, or DEFAULT if the
380 element is not a cons.
382 If no element matches, the value is nil.
383 If TEST is omitted or nil, `equal' is used."
384 (let (found (tail alist
) value
)
385 (while (and tail
(not found
))
386 (let ((elt (car tail
)))
387 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
388 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
389 (setq tail
(cdr tail
)))
392 (make-obsolete 'assoc-ignore-case
'assoc-string
"22.1")
393 (defun assoc-ignore-case (key alist
)
394 "Like `assoc', but ignores differences in case and text representation.
395 KEY must be a string. Upper-case and lower-case letters are treated as equal.
396 Unibyte strings are converted to multibyte for comparison."
397 (assoc-string key alist t
))
399 (make-obsolete 'assoc-ignore-representation
'assoc-string
"22.1")
400 (defun assoc-ignore-representation (key alist
)
401 "Like `assoc', but ignores differences in text representation.
402 KEY must be a string.
403 Unibyte strings are converted to multibyte for comparison."
404 (assoc-string key alist nil
))
406 (defun member-ignore-case (elt list
)
407 "Like `member', but ignores differences in case and text representation.
408 ELT must be a string. Upper-case and lower-case letters are treated as equal.
409 Unibyte strings are converted to multibyte for comparison.
410 Non-strings in LIST are ignored."
412 (not (and (stringp (car list
))
413 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
414 (setq list
(cdr list
)))
417 (defun assq-delete-all (key alist
)
418 "Delete from ALIST all elements whose car is `eq' to KEY.
419 Return the modified alist.
420 Elements of ALIST that are not conses are ignored."
421 (while (and (consp (car alist
))
422 (eq (car (car alist
)) key
))
423 (setq alist
(cdr alist
)))
424 (let ((tail alist
) tail-cdr
)
425 (while (setq tail-cdr
(cdr tail
))
426 (if (and (consp (car tail-cdr
))
427 (eq (car (car tail-cdr
)) key
))
428 (setcdr tail
(cdr tail-cdr
))
429 (setq tail tail-cdr
))))
432 (defun rassq-delete-all (value alist
)
433 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
434 Return the modified alist.
435 Elements of ALIST that are not conses are ignored."
436 (while (and (consp (car alist
))
437 (eq (cdr (car alist
)) value
))
438 (setq alist
(cdr alist
)))
439 (let ((tail alist
) tail-cdr
)
440 (while (setq tail-cdr
(cdr tail
))
441 (if (and (consp (car tail-cdr
))
442 (eq (cdr (car tail-cdr
)) value
))
443 (setcdr tail
(cdr tail-cdr
))
444 (setq tail tail-cdr
))))
447 (defun remove (elt seq
)
448 "Return a copy of SEQ with all occurrences of ELT removed.
449 SEQ must be a list, vector, or string. The comparison is done with `equal'."
451 ;; If SEQ isn't a list, there's no need to copy SEQ because
452 ;; `delete' will return a new object.
454 (delete elt
(copy-sequence seq
))))
456 (defun remq (elt list
)
457 "Return LIST with all occurrences of ELT removed.
458 The comparison is done with `eq'. Contrary to `delq', this does not use
459 side-effects, and the argument LIST is not modified."
461 (delq elt
(copy-sequence list
))
467 "Convert KEYS to the internal Emacs key representation.
468 KEYS should be a string constant in the format used for
469 saving keyboard macros (see `edmacro-mode')."
470 (read-kbd-macro keys
))
476 ;; Prevent the \{...} documentation construct
477 ;; from mentioning keys that run this command.
478 (put 'undefined
'suppress-keymap t
)
480 (defun suppress-keymap (map &optional nodigits
)
481 "Make MAP override all normally self-inserting keys to be undefined.
482 Normally, as an exception, digits and minus-sign are set to make prefix args,
483 but optional second arg NODIGITS non-nil treats them like other chars."
484 (define-key map
[remap self-insert-command
] 'undefined
)
487 (define-key map
"-" 'negative-argument
)
488 ;; Make plain numbers do numeric args.
491 (define-key map
(char-to-string loop
) 'digit-argument
)
492 (setq loop
(1+ loop
))))))
494 (defun define-key-after (keymap key definition
&optional after
)
495 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
496 This is like `define-key' except that the binding for KEY is placed
497 just after the binding for the event AFTER, instead of at the beginning
498 of the map. Note that AFTER must be an event type (like KEY), NOT a command
501 If AFTER is t or omitted, the new binding goes at the end of the keymap.
502 AFTER should be a single event type--a symbol or a character, not a sequence.
504 Bindings are always added before any inherited map.
506 The order of bindings in a keymap matters when it is used as a menu."
507 (unless after
(setq after t
))
509 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
511 (if (<= (length key
) 1) (aref key
0)
512 (setq keymap
(lookup-key keymap
514 (butlast (mapcar 'identity key
)))))
515 (aref key
(1- (length key
)))))
516 (let ((tail keymap
) done inserted
)
517 (while (and (not done
) tail
)
518 ;; Delete any earlier bindings for the same key.
519 (if (eq (car-safe (car (cdr tail
))) key
)
520 (setcdr tail
(cdr (cdr tail
))))
521 ;; If we hit an included map, go down that one.
522 (if (keymapp (car tail
)) (setq tail
(car tail
)))
523 ;; When we reach AFTER's binding, insert the new binding after.
524 ;; If we reach an inherited keymap, insert just before that.
525 ;; If we reach the end of this keymap, insert at the end.
526 (if (or (and (eq (car-safe (car tail
)) after
)
528 (eq (car (cdr tail
)) 'keymap
)
531 ;; Stop the scan only if we find a parent keymap.
532 ;; Keep going past the inserted element
533 ;; so we can delete any duplications that come later.
534 (if (eq (car (cdr tail
)) 'keymap
)
536 ;; Don't insert more than once.
538 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
540 (setq tail
(cdr tail
)))))
542 (defun map-keymap-sorted (function keymap
)
543 "Implement `map-keymap' with sorting.
544 Don't call this function; it is for internal use only."
546 (map-keymap (lambda (a b
) (push (cons a b
) list
))
548 (setq list
(sort list
550 (setq a
(car a
) b
(car b
))
552 (if (integerp b
) (< a b
)
555 ;; string< also accepts symbols.
558 (funcall function
(car p
) (cdr p
)))))
560 (defun keymap-canonicalize (map)
561 "Return an equivalent keymap, without inheritance."
564 (prompt (keymap-prompt map
)))
566 (setq map
(map-keymap-internal
569 ;; Treat char-ranges specially.
570 (push (cons key item
) ranges
)
571 (push (cons key item
) bindings
)))
573 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
574 (dolist (binding ranges
)
575 ;; Treat char-ranges specially.
576 (define-key map
(vector (car binding
)) (cdr binding
)))
577 (dolist (binding (prog1 bindings
(setq bindings
())))
578 (let* ((key (car binding
))
580 (oldbind (assq key bindings
)))
581 ;; Newer bindings override older.
582 (if oldbind
(setq bindings
(delq oldbind bindings
)))
583 (when item
;nil bindings just hide older ones.
584 (push binding bindings
))))
585 (nconc map bindings
)))
587 (put 'keyboard-translate-table
'char-table-extra-slots
0)
589 (defun keyboard-translate (from to
)
590 "Translate character FROM to TO at a low level.
591 This function creates a `keyboard-translate-table' if necessary
592 and then modifies one entry in it."
593 (or (char-table-p keyboard-translate-table
)
594 (setq keyboard-translate-table
595 (make-char-table 'keyboard-translate-table nil
)))
596 (aset keyboard-translate-table from to
))
598 ;;;; Key binding commands.
600 (defun global-set-key (key command
)
601 "Give KEY a global binding as COMMAND.
602 COMMAND is the command definition to use; usually it is
603 a symbol naming an interactively-callable function.
604 KEY is a key sequence; noninteractively, it is a string or vector
605 of characters or event types, and non-ASCII characters with codes
606 above 127 (such as ISO Latin-1) can be included if you use a vector.
608 Note that if KEY has a local binding in the current buffer,
609 that local binding will continue to shadow any global binding
610 that you make with this function."
611 (interactive "KSet key globally: \nCSet key %s to command: ")
612 (or (vectorp key
) (stringp key
)
613 (signal 'wrong-type-argument
(list 'arrayp key
)))
614 (define-key (current-global-map) key command
))
616 (defun local-set-key (key command
)
617 "Give KEY a local binding as COMMAND.
618 COMMAND is the command definition to use; usually it is
619 a symbol naming an interactively-callable function.
620 KEY is a key sequence; noninteractively, it is a string or vector
621 of characters or event types, and non-ASCII characters with codes
622 above 127 (such as ISO Latin-1) can be included if you use a vector.
624 The binding goes in the current buffer's local map,
625 which in most cases is shared with all other buffers in the same major mode."
626 (interactive "KSet key locally: \nCSet key %s locally to command: ")
627 (let ((map (current-local-map)))
629 (use-local-map (setq map
(make-sparse-keymap))))
630 (or (vectorp key
) (stringp key
)
631 (signal 'wrong-type-argument
(list 'arrayp key
)))
632 (define-key map key command
)))
634 (defun global-unset-key (key)
635 "Remove global binding of KEY.
636 KEY is a string or vector representing a sequence of keystrokes."
637 (interactive "kUnset key globally: ")
638 (global-set-key key nil
))
640 (defun local-unset-key (key)
641 "Remove local binding of KEY.
642 KEY is a string or vector representing a sequence of keystrokes."
643 (interactive "kUnset key locally: ")
644 (if (current-local-map)
645 (local-set-key key nil
))
648 ;;;; substitute-key-definition and its subroutines.
650 (defvar key-substitution-in-progress nil
651 "Used internally by `substitute-key-definition'.")
653 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
654 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
655 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
656 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
657 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
659 If you don't specify OLDMAP, you can usually get the same results
660 in a cleaner way with command remapping, like this:
661 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
662 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
663 ;; Don't document PREFIX in the doc string because we don't want to
664 ;; advertise it. It's meant for recursive calls only. Here's its
667 ;; If optional argument PREFIX is specified, it should be a key
668 ;; prefix, a string. Redefined bindings will then be bound to the
669 ;; original key, with PREFIX added at the front.
670 (or prefix
(setq prefix
""))
671 (let* ((scan (or oldmap keymap
))
672 (prefix1 (vconcat prefix
[nil]))
673 (key-substitution-in-progress
674 (cons scan key-substitution-in-progress)))
675 ;; Scan OLDMAP, finding each char or event-symbol that
676 ;; has any definition, and act on it with hack-key.
679 (aset prefix1 (length prefix) char)
680 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
683 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
684 (let (inner-def skipped menu-item)
685 ;; Find the actual command name within the binding.
686 (if (eq (car-safe defn) 'menu-item)
687 (setq menu-item defn defn (nth 2 defn))
688 ;; Skip past menu-prompt.
689 (while (stringp (car-safe defn))
690 (push (pop defn) skipped))
691 ;; Skip past cached key-equivalence data for menu items.
692 (if (consp (car-safe defn))
693 (setq defn (cdr defn))))
694 (if (or (eq defn olddef)
695 ;; Compare with equal if definition is a key sequence.
696 ;; That is useful for operating on function-key-map.
697 (and (or (stringp defn) (vectorp defn))
698 (equal defn olddef)))
699 (define-key keymap prefix
701 (let ((copy (copy-sequence menu-item)))
702 (setcar (nthcdr 2 copy) newdef)
704 (nconc (nreverse skipped) newdef)))
705 ;; Look past a symbol that names a keymap.
707 (or (indirect-function defn t) defn))
708 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
709 ;; avoid autoloading a keymap. This is mostly done to preserve the
710 ;; original non-autoloading behavior of pre-map-keymap times.
711 (if (and (keymapp inner-def)
712 ;; Avoid recursively scanning
713 ;; where KEYMAP does not have a submap.
714 (let ((elt (lookup-key keymap prefix)))
715 (or (null elt) (natnump elt) (keymapp elt)))
716 ;; Avoid recursively rescanning keymap being scanned.
717 (not (memq inner-def key-substitution-in-progress)))
718 ;; If this one isn't being scanned already, scan it now.
719 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
722 ;;;; The global keymap tree.
724 ;;; global-map, esc-map, and ctl-x-map have their values set up in
725 ;;; keymap.c; we just give them docstrings here.
727 (defvar global-map nil
728 "Default global keymap mapping Emacs keyboard input into commands.
729 The value is a keymap which is usually (but not necessarily) Emacs's
733 "Default keymap for ESC (meta) commands.
734 The normal global definition of the character ESC indirects to this keymap.")
736 (defvar ctl-x-map nil
737 "Default keymap for C-x commands.
738 The normal global definition of the character C-x indirects to this keymap.")
740 (defvar ctl-x-4-map (make-sparse-keymap)
741 "Keymap for subcommands of C-x 4.")
742 (defalias 'ctl-x-4-prefix ctl-x-4-map)
743 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
745 (defvar ctl-x-5-map (make-sparse-keymap)
746 "Keymap for frame commands.")
747 (defalias 'ctl-x-5-prefix ctl-x-5-map)
748 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
751 ;;;; Event manipulation functions.
753 ;; The call to `read' is to ensure that the value is computed at load time
754 ;; and not compiled into the .elc file. The value is negative on most
755 ;; machines, but not on all!
756 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
758 (defun listify-key-sequence (key)
759 "Convert a key sequence to a list of events."
762 (mapcar (function (lambda (c)
764 (logxor c listify-key-sequence-1)
768 (defsubst eventp (obj)
769 "True if the argument is an event object."
770 (or (and (integerp obj)
771 ;; Filter out integers too large to be events.
772 ;; M is the biggest modifier.
773 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
774 (characterp (event-basic-type obj)))
776 (get obj 'event-symbol-elements))
779 (get (car obj) 'event-symbol-elements))))
781 (defun event-modifiers (event)
782 "Return a list of symbols representing the modifier keys in event EVENT.
783 The elements of the list may include `meta', `control',
784 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
786 EVENT may be an event or an event type. If EVENT is a symbol
787 that has never been used in an event that has been read as input
788 in the current Emacs session, then this function can return nil,
789 even when EVENT actually has modifiers."
792 (setq type (car type)))
794 ;; Don't read event-symbol-elements directly since we're not
795 ;; sure the symbol has already been parsed.
796 (cdr (internal-event-symbol-parse-modifiers type))
798 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
799 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
800 (if (not (zerop (logand type ?\M-\^@)))
802 (if (or (not (zerop (logand type ?\C-\^@)))
804 (push 'control list))
805 (if (or (not (zerop (logand type ?\S-\^@)))
806 (/= char (downcase char)))
808 (or (zerop (logand type ?\H-\^@))
810 (or (zerop (logand type ?\s-\^@))
812 (or (zerop (logand type ?\A-\^@))
816 (defun event-basic-type (event)
817 "Return the basic type of the given event (all modifiers removed).
818 The value is a printing character (not upper case) or a symbol.
819 EVENT may be an event or an event type. If EVENT is a symbol
820 that has never been used in an event that has been read as input
821 in the current Emacs session, then this function may return nil."
823 (setq event (car event)))
825 (car (get event 'event-symbol-elements))
826 (let* ((base (logand event (1- ?\A-\^@)))
827 (uncontrolled (if (< base 32) (logior base 64) base)))
828 ;; There are some numbers that are invalid characters and
829 ;; cause `downcase' to get an error.
831 (downcase uncontrolled)
832 (error uncontrolled)))))
834 (defsubst mouse-movement-p (object)
835 "Return non-nil if OBJECT is a mouse movement event."
836 (eq (car-safe object) 'mouse-movement))
838 (defun mouse-event-p (object)
839 "Return non-nil if OBJECT is a mouse click event."
840 ;; is this really correct? maybe remove mouse-movement?
841 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
843 (defsubst event-start (event)
844 "Return the starting position of EVENT.
845 If EVENT is a mouse or key press or a mouse click, this returns the location
847 If EVENT is a drag, this returns the drag's starting position.
848 The return value is of the form
849 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
850 IMAGE (DX . DY) (WIDTH . HEIGHT))
851 The `posn-' functions access elements of such lists."
852 (if (consp event) (nth 1 event)
853 (list (selected-window) (point) '(0 . 0) 0)))
855 (defsubst event-end (event)
856 "Return the ending location of EVENT.
857 EVENT should be a click, drag, or key press event.
858 If EVENT is a click event, this function is the same as `event-start'.
859 The return value is of the form
860 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
861 IMAGE (DX . DY) (WIDTH . HEIGHT))
862 The `posn-' functions access elements of such lists."
863 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
864 (list (selected-window) (point) '(0 . 0) 0)))
866 (defsubst event-click-count (event)
867 "Return the multi-click count of EVENT, a click or drag event.
868 The return value is a positive integer."
869 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
871 ;;;; Extracting fields of the positions in an event.
873 (defsubst posn-window (position)
874 "Return the window in POSITION.
875 POSITION should be a list of the form returned by the `event-start'
876 and `event-end' functions."
879 (defsubst posn-area (position)
880 "Return the window area recorded in POSITION, or nil for the text area.
881 POSITION should be a list of the form returned by the `event-start'
882 and `event-end' functions."
883 (let ((area (if (consp (nth 1 position))
884 (car (nth 1 position))
886 (and (symbolp area) area)))
888 (defsubst posn-point (position)
889 "Return the buffer location in POSITION.
890 POSITION should be a list of the form returned by the `event-start'
891 and `event-end' functions."
893 (if (consp (nth 1 position))
894 (car (nth 1 position))
897 (defun posn-set-point (position)
898 "Move point to POSITION.
899 Select the corresponding window as well."
900 (if (not (windowp (posn-window position)))
901 (error "Position not in text area of window"))
902 (select-window (posn-window position))
903 (if (numberp (posn-point position))
904 (goto-char (posn-point position))))
906 (defsubst posn-x-y (position)
907 "Return the x and y coordinates in POSITION.
908 POSITION should be a list of the form returned by the `event-start'
909 and `event-end' functions."
912 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
914 (defun posn-col-row (position)
915 "Return the nominal column and row in POSITION, measured in characters.
916 The column and row values are approximations calculated from the x
917 and y coordinates in POSITION and the frame's default character width
919 For a scroll-bar event, the result column is 0, and the row
920 corresponds to the vertical position of the click in the scroll bar.
921 POSITION should be a list of the form returned by the `event-start'
922 and `event-end' functions."
923 (let* ((pair (posn-x-y position))
924 (window (posn-window position))
925 (area (posn-area position)))
929 ((eq area 'vertical-scroll-bar)
930 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
931 ((eq area 'horizontal-scroll-bar)
932 (cons (scroll-bar-scale pair (window-width window)) 0))
934 (let* ((frame (if (framep window) window (window-frame window)))
935 ;; FIXME: This should take line-spacing properties on
936 ;; newlines into account.
937 (spacing (when (display-graphic-p frame)
938 (or (with-current-buffer (window-buffer window)
940 (frame-parameter frame 'line-spacing)))))
941 (cond ((floatp spacing)
942 (setq spacing (truncate (* spacing
943 (frame-char-height frame)))))
946 (cons (/ (car pair) (frame-char-width frame))
947 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
949 (defun posn-actual-col-row (position)
950 "Return the actual column and row in POSITION, measured in characters.
951 These are the actual row number in the window and character number in that row.
952 Return nil if POSITION does not contain the actual position; in that case
953 `posn-col-row' can be used to get approximate values.
954 POSITION should be a list of the form returned by the `event-start'
955 and `event-end' functions."
958 (defsubst posn-timestamp (position)
959 "Return the timestamp of POSITION.
960 POSITION should be a list of the form returned by the `event-start'
961 and `event-end' functions."
964 (defsubst posn-string (position)
965 "Return the string object of POSITION.
966 Value is a cons (STRING . STRING-POS), or nil if not a string.
967 POSITION should be a list of the form returned by the `event-start'
968 and `event-end' functions."
971 (defsubst posn-image (position)
972 "Return the image object of POSITION.
973 Value is a list (image ...), or nil if not an image.
974 POSITION should be a list of the form returned by the `event-start'
975 and `event-end' functions."
978 (defsubst posn-object (position)
979 "Return the object (image or string) of POSITION.
980 Value is a list (image ...) for an image object, a cons cell
981 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
982 POSITION should be a list of the form returned by the `event-start'
983 and `event-end' functions."
984 (or (posn-image position) (posn-string position)))
986 (defsubst posn-object-x-y (position)
987 "Return the x and y coordinates relative to the object of POSITION.
988 POSITION should be a list of the form returned by the `event-start'
989 and `event-end' functions."
992 (defsubst posn-object-width-height (position)
993 "Return the pixel width and height of the object of POSITION.
994 POSITION should be a list of the form returned by the `event-start'
995 and `event-end' functions."
999 ;;;; Obsolescent names for functions.
1001 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1002 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1003 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1004 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1005 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1006 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1008 (make-obsolete 'char-bytes "now always returns 1." "20.4")
1009 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1011 (defun insert-string (&rest args)
1012 "Mocklisp-compatibility insert function.
1013 Like the function `insert' except that any argument that is a number
1014 is converted into a string by expressing it in decimal."
1016 (insert (if (integerp el) (number-to-string el) el))))
1017 (make-obsolete 'insert-string 'insert "22.1")
1019 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1020 (make-obsolete 'makehash 'make-hash-table "22.1")
1022 ;; Some programs still use this as a function.
1024 "Return the value of the `baud-rate' variable."
1026 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
1028 ;; These are used by VM and some old programs
1029 (defalias 'focus-frame 'ignore "")
1030 (make-obsolete 'focus-frame "it does nothing." "22.1")
1031 (defalias 'unfocus-frame 'ignore "")
1032 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1033 (make-obsolete 'make-variable-frame-local
1034 "explicitly check for a frame-parameter instead." "22.2")
1036 ;;;; Obsolescence declarations for variables, and aliases.
1038 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1039 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1040 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1042 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1043 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1045 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
1046 (make-obsolete-variable
1047 'mode-line-inverse-video
1048 "use the appropriate faces instead."
1050 (make-obsolete-variable
1051 'unread-command-char
1052 "use `unread-command-events' instead. That variable is a list of events
1053 to reread, so it now uses nil to mean `no event', instead of -1."
1056 ;; Lisp manual only updated in 22.1.
1057 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1060 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1061 (make-obsolete-variable 'x-lost-selection-hooks
1062 'x-lost-selection-functions "22.1")
1063 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1064 (make-obsolete-variable 'x-sent-selection-hooks
1065 'x-sent-selection-functions "22.1")
1067 ;; This was introduced in 21.4 for pre-unicode unification. That
1068 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1069 ;; Other uses are possible, so this variable is not _really_ obsolete,
1070 ;; but Stefan insists to mark it so.
1071 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1073 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1075 ;; These aliases exist in Emacs 19.34, and probably before, but were
1076 ;; only marked as obsolete in 23.1.
1077 ;; The lisp manual (since at least Emacs 21) describes them as
1078 ;; existing "for compatibility with Emacs version 18".
1079 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1081 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1085 ;;;; Alternate names for functions - these are not being phased out.
1087 (defalias 'send-string 'process-send-string)
1088 (defalias 'send-region 'process-send-region)
1089 (defalias 'string= 'string-equal)
1090 (defalias 'string< 'string-lessp)
1091 (defalias 'move-marker 'set-marker)
1092 (defalias 'rplaca 'setcar)
1093 (defalias 'rplacd 'setcdr)
1094 (defalias 'beep 'ding) ;preserve lingual purity
1095 (defalias 'indent-to-column 'indent-to)
1096 (defalias 'backward-delete-char 'delete-backward-char)
1097 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1098 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1099 (defalias 'int-to-string 'number-to-string)
1100 (defalias 'store-match-data 'set-match-data)
1101 (defalias 'chmod 'set-file-modes)
1102 (defalias 'mkdir 'make-directory)
1103 ;; These are the XEmacs names:
1104 (defalias 'point-at-eol 'line-end-position)
1105 (defalias 'point-at-bol 'line-beginning-position)
1107 (defalias 'user-original-login-name 'user-login-name)
1110 ;;;; Hook manipulation functions.
1112 (defun make-local-hook (hook)
1113 "Make the hook HOOK local to the current buffer.
1114 The return value is HOOK.
1116 You never need to call this function now that `add-hook' does it for you
1117 if its LOCAL argument is non-nil.
1119 When a hook is local, its local and global values
1120 work in concert: running the hook actually runs all the hook
1121 functions listed in *either* the local value *or* the global value
1122 of the hook variable.
1124 This function works by making t a member of the buffer-local value,
1125 which acts as a flag to run the hook functions in the default value as
1126 well. This works for all normal hooks, but does not work for most
1127 non-normal hooks yet. We will be changing the callers of non-normal
1128 hooks so that they can handle localness; this has to be done one by
1131 This function does nothing if HOOK is already local in the current
1134 Do not use `make-local-variable' to make a hook variable buffer-local."
1135 (if (local-variable-p hook)
1137 (or (boundp hook) (set hook nil))
1138 (make-local-variable hook)
1139 (set hook (list t)))
1141 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1143 (defun add-hook (hook function &optional append local)
1144 "Add to the value of HOOK the function FUNCTION.
1145 FUNCTION is not added if already present.
1146 FUNCTION is added (if necessary) at the beginning of the hook list
1147 unless the optional argument APPEND is non-nil, in which case
1148 FUNCTION is added at the end.
1150 The optional fourth argument, LOCAL, if non-nil, says to modify
1151 the hook's buffer-local value rather than its default value.
1152 This makes the hook buffer-local if needed, and it makes t a member
1153 of the buffer-local value. That acts as a flag to run the hook
1154 functions in the default value as well as in the local value.
1156 HOOK should be a symbol, and FUNCTION may be any valid function. If
1157 HOOK is void, it is first set to nil. If HOOK's value is a single
1158 function, it is changed to a list of functions."
1159 (or (boundp hook) (set hook nil))
1160 (or (default-boundp hook) (set-default hook nil))
1161 (if local (unless (local-variable-if-set-p hook)
1162 (set (make-local-variable hook) (list t)))
1163 ;; Detect the case where make-local-variable was used on a hook
1164 ;; and do what we used to do.
1165 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1167 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1168 ;; If the hook value is a single function, turn it into a list.
1169 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1170 (setq hook-value (list hook-value)))
1171 ;; Do the actual addition if necessary
1172 (unless (member function hook-value)
1175 (append hook-value (list function))
1176 (cons function hook-value))))
1177 ;; Set the actual variable
1180 ;; If HOOK isn't a permanent local,
1181 ;; but FUNCTION wants to survive a change of modes,
1182 ;; mark HOOK as partially permanent.
1183 (and (symbolp function)
1184 (get function 'permanent-local-hook)
1185 (not (get hook 'permanent-local))
1186 (put hook 'permanent-local 'permanent-local-hook))
1187 (set hook hook-value))
1188 (set-default hook hook-value))))
1190 (defun remove-hook (hook function &optional local)
1191 "Remove from the value of HOOK the function FUNCTION.
1192 HOOK should be a symbol, and FUNCTION may be any valid function. If
1193 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1194 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1196 The optional third argument, LOCAL, if non-nil, says to modify
1197 the hook's buffer-local value rather than its default value."
1198 (or (boundp hook) (set hook nil))
1199 (or (default-boundp hook) (set-default hook nil))
1200 ;; Do nothing if LOCAL is t but this hook has no local binding.
1201 (unless (and local (not (local-variable-p hook)))
1202 ;; Detect the case where make-local-variable was used on a hook
1203 ;; and do what we used to do.
1204 (when (and (local-variable-p hook)
1205 (not (and (consp (symbol-value hook))
1206 (memq t (symbol-value hook)))))
1208 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1209 ;; Remove the function, for both the list and the non-list cases.
1210 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1211 (if (equal hook-value function) (setq hook-value nil))
1212 (setq hook-value (delete function (copy-sequence hook-value))))
1213 ;; If the function is on the global hook, we need to shadow it locally
1214 ;;(when (and local (member function (default-value hook))
1215 ;; (not (member (cons 'not function) hook-value)))
1216 ;; (push (cons 'not function) hook-value))
1217 ;; Set the actual variable
1219 (set-default hook hook-value)
1220 (if (equal hook-value '(t))
1221 (kill-local-variable hook)
1222 (set hook hook-value))))))
1224 (defun add-to-list (list-var element &optional append compare-fn)
1225 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1226 The test for presence of ELEMENT is done with `equal',
1227 or with COMPARE-FN if that's non-nil.
1228 If ELEMENT is added, it is added at the beginning of the list,
1229 unless the optional argument APPEND is non-nil, in which case
1230 ELEMENT is added at the end.
1232 The return value is the new value of LIST-VAR.
1234 If you want to use `add-to-list' on a variable that is not defined
1235 until a certain package is loaded, you should put the call to `add-to-list'
1236 into a hook function that will be run only after loading the package.
1237 `eval-after-load' provides one way to do this. In some cases
1238 other hooks, such as major mode hooks, can do the job."
1241 (member element (symbol-value list-var)))
1242 ((eq compare-fn 'eq)
1243 (memq element (symbol-value list-var)))
1244 ((eq compare-fn 'eql)
1245 (memql element (symbol-value list-var)))
1247 (let ((lst (symbol-value list-var)))
1249 (not (funcall compare-fn element (car lst))))
1250 (setq lst (cdr lst)))
1252 (symbol-value list-var)
1255 (append (symbol-value list-var) (list element))
1256 (cons element (symbol-value list-var))))))
1259 (defun add-to-ordered-list (list-var element &optional order)
1260 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1261 The test for presence of ELEMENT is done with `eq'.
1263 The resulting list is reordered so that the elements are in the
1264 order given by each element's numeric list order. Elements
1265 without a numeric list order are placed at the end of the list.
1267 If the third optional argument ORDER is a number (integer or
1268 float), set the element's list order to the given value. If
1269 ORDER is nil or omitted, do not change the numeric order of
1270 ELEMENT. If ORDER has any other value, remove the numeric order
1271 of ELEMENT if it has one.
1273 The list order for each element is stored in LIST-VAR's
1274 `list-order' property.
1276 The return value is the new value of LIST-VAR."
1277 (let ((ordering (get list-var 'list-order)))
1279 (put list-var 'list-order
1280 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1282 (puthash element (and (numberp order) order) ordering))
1283 (unless (memq element (symbol-value list-var))
1284 (set list-var (cons element (symbol-value list-var))))
1285 (set list-var (sort (symbol-value list-var)
1287 (let ((oa (gethash a ordering))
1288 (ob (gethash b ordering)))
1293 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1294 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1295 Return the new history list.
1296 If MAXELT is non-nil, it specifies the maximum length of the history.
1297 Otherwise, the maximum history length is the value of the `history-length'
1298 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1300 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1301 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1302 if it is empty or a duplicate."
1304 (setq maxelt (or (get history-var 'history-length)
1306 (let ((history (symbol-value history-var))
1308 (when (and (listp history)
1310 (not (stringp newelt))
1311 (> (length newelt) 0))
1313 (not (equal (car history) newelt))))
1314 (if history-delete-duplicates
1315 (delete newelt history))
1316 (setq history (cons newelt history))
1317 (when (integerp maxelt)
1320 (setq tail (nthcdr (1- maxelt) history))
1322 (setcdr tail nil)))))
1323 (set history-var history)))
1328 (defvar delay-mode-hooks nil
1329 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1330 (defvar delayed-mode-hooks nil
1331 "List of delayed mode hooks waiting to be run.")
1332 (make-variable-buffer-local 'delayed-mode-hooks)
1333 (put 'delay-mode-hooks 'permanent-local t)
1335 (defvar after-change-major-mode-hook nil
1336 "Normal hook run at the very end of major mode functions.")
1338 (defun run-mode-hooks (&rest hooks)
1339 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1340 Execution is delayed if `delay-mode-hooks' is non-nil.
1341 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1342 after running the mode hooks.
1343 Major mode functions should use this instead of `run-hooks' when running their
1345 (if delay-mode-hooks
1347 (dolist (hook hooks)
1348 (push hook delayed-mode-hooks))
1349 ;; Normal case, just run the hook as before plus any delayed hooks.
1350 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1351 (setq delayed-mode-hooks nil)
1352 (apply 'run-hooks hooks)
1353 (run-hooks 'after-change-major-mode-hook)))
1355 (defmacro delay-mode-hooks (&rest body)
1356 "Execute BODY, but delay any `run-mode-hooks'.
1357 These hooks will be executed by the first following call to
1358 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1359 Only affects hooks run in the current buffer."
1360 (declare (debug t) (indent 0))
1362 (make-local-variable 'delay-mode-hooks)
1363 (let ((delay-mode-hooks t))
1366 ;; PUBLIC: find if the current mode derives from another.
1368 (defun derived-mode-p (&rest modes)
1369 "Non-nil if the current major mode is derived from one of MODES.
1370 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1371 (let ((parent major-mode))
1372 (while (and (not (memq parent modes))
1373 (setq parent (get parent 'derived-mode-parent))))
1378 ;; If a minor mode is not defined with define-minor-mode,
1379 ;; add it here explicitly.
1380 ;; isearch-mode is deliberately excluded, since you should
1381 ;; not call it yourself.
1382 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1383 overwrite-mode view-mode
1385 "List of all minor mode functions.")
1387 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1388 "Register a new minor mode.
1390 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1392 TOGGLE is a symbol which is the name of a buffer-local variable that
1393 is toggled on or off to say whether the minor mode is active or not.
1395 NAME specifies what will appear in the mode line when the minor mode
1396 is active. NAME should be either a string starting with a space, or a
1397 symbol whose value is such a string.
1399 Optional KEYMAP is the keymap for the minor mode that will be added
1400 to `minor-mode-map-alist'.
1402 Optional AFTER specifies that TOGGLE should be added after AFTER
1403 in `minor-mode-alist'.
1405 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1406 It defaults to (and should by convention be) TOGGLE.
1408 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1409 included in the mode-line minor mode menu.
1410 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1411 (unless (memq toggle minor-mode-list)
1412 (push toggle minor-mode-list))
1414 (unless toggle-fun (setq toggle-fun toggle))
1415 (unless (eq toggle-fun toggle)
1416 (put toggle :minor-mode-function toggle-fun))
1417 ;; Add the name to the minor-mode-alist.
1419 (let ((existing (assq toggle minor-mode-alist)))
1421 (setcdr existing (list name))
1422 (let ((tail minor-mode-alist) found)
1423 (while (and tail (not found))
1424 (if (eq after (caar tail))
1426 (setq tail (cdr tail))))
1428 (let ((rest (cdr found)))
1430 (nconc found (list (list toggle name)) rest))
1431 (setq minor-mode-alist (cons (list toggle name)
1432 minor-mode-alist)))))))
1433 ;; Add the toggle to the minor-modes menu if requested.
1434 (when (get toggle :included)
1435 (define-key mode-line-mode-menu
1439 (or (get toggle :menu-tag)
1440 (if (stringp name) name (symbol-name toggle)))
1441 (let ((mode-name (if (symbolp name) (symbol-value name))))
1442 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1443 (concat " (" (match-string 0 mode-name) ")"))))
1445 :button (cons :toggle toggle))))
1447 ;; Add the map to the minor-mode-map-alist.
1449 (let ((existing (assq toggle minor-mode-map-alist)))
1451 (setcdr existing keymap)
1452 (let ((tail minor-mode-map-alist) found)
1453 (while (and tail (not found))
1454 (if (eq after (caar tail))
1456 (setq tail (cdr tail))))
1458 (let ((rest (cdr found)))
1460 (nconc found (list (cons toggle keymap)) rest))
1461 (setq minor-mode-map-alist (cons (cons toggle keymap)
1462 minor-mode-map-alist))))))))
1466 ;; (defvar symbol-file-load-history-loaded nil
1467 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1468 ;; That file records the part of `load-history' for preloaded files,
1469 ;; which is cleared out before dumping to make Emacs smaller.")
1471 ;; (defun load-symbol-file-load-history ()
1472 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1473 ;; That file records the part of `load-history' for preloaded files,
1474 ;; which is cleared out before dumping to make Emacs smaller."
1475 ;; (unless symbol-file-load-history-loaded
1476 ;; (load (expand-file-name
1477 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1478 ;; (if (eq system-type 'ms-dos)
1480 ;; (format "fns-%s.el" emacs-version))
1482 ;; ;; The file name fns-%s.el already has a .el extension.
1484 ;; (setq symbol-file-load-history-loaded t)))
1486 (defun symbol-file (symbol &optional type)
1487 "Return the name of the file that defined SYMBOL.
1488 The value is normally an absolute file name. It can also be nil,
1489 if the definition is not associated with any file. If SYMBOL
1490 specifies an autoloaded function, the value can be a relative
1491 file name without extension.
1493 If TYPE is nil, then any kind of definition is acceptable. If
1494 TYPE is `defun', `defvar', or `defface', that specifies function
1495 definition, variable definition, or face definition only."
1496 (if (and (or (null type) (eq type 'defun))
1497 (symbolp symbol) (fboundp symbol)
1498 (eq 'autoload (car-safe (symbol-function symbol))))
1499 (nth 1 (symbol-function symbol))
1500 (let ((files load-history)
1504 (if (eq type 'defvar)
1505 ;; Variables are present just as their names.
1506 (member symbol (cdr (car files)))
1507 ;; Other types are represented as (TYPE . NAME).
1508 (member (cons type symbol) (cdr (car files))))
1509 ;; We accept all types, so look for variable def
1510 ;; and then for any other kind.
1511 (or (member symbol (cdr (car files)))
1512 (rassq symbol (cdr (car files)))))
1513 (setq file (car (car files)) files nil))
1514 (setq files (cdr files)))
1517 (defun locate-library (library &optional nosuffix path interactive-call)
1518 "Show the precise file name of Emacs library LIBRARY.
1519 LIBRARY should be a relative file name of the library, a string.
1520 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1521 nil (which is the default, see below).
1522 This command searches the directories in `load-path' like `\\[load-library]'
1523 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1524 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1525 to the specified name LIBRARY.
1527 If the optional third arg PATH is specified, that list of directories
1528 is used instead of `load-path'.
1530 When called from a program, the file name is normally returned as a
1531 string. When run interactively, the argument INTERACTIVE-CALL is t,
1532 and the file name is displayed in the echo area."
1533 (interactive (list (completing-read "Locate library: "
1535 'locate-file-completion-table
1536 load-path (get-load-suffixes)))
1539 (let ((file (locate-file library
1541 (append (unless nosuffix (get-load-suffixes))
1542 load-file-rep-suffixes))))
1543 (if interactive-call
1545 (message "Library is file %s" (abbreviate-file-name file))
1546 (message "No library %s in search path" library)))
1550 ;;;; Specifying things to do later.
1552 (defmacro eval-at-startup (&rest body)
1553 "Make arrangements to evaluate BODY when Emacs starts up.
1554 If this is run after Emacs startup, evaluate BODY immediately.
1557 This works by adding a function to `before-init-hook'.
1558 That function's doc string says which file created it."
1560 (if command-line-processed
1562 (add-hook 'before-init-hook
1563 '(lambda () ,(concat "From " (or load-file-name "no file"))
1568 (defun load-history-regexp (file)
1569 "Form a regexp to find FILE in `load-history'.
1570 FILE, a string, is described in the function `eval-after-load'."
1571 (if (file-name-absolute-p file)
1572 (setq file (file-truename file)))
1573 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1575 (if (file-name-extension file)
1577 ;; Note: regexp-opt can't be used here, since we need to call
1578 ;; this before Emacs has been fully started. 2006-05-21
1579 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1580 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1583 (defun load-history-filename-element (file-regexp)
1584 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1585 Return nil if there isn't one."
1586 (let* ((loads load-history)
1587 (load-elt (and loads (car loads))))
1590 (or (null (car load-elt))
1591 (not (string-match file-regexp (car load-elt)))))
1592 (setq loads (cdr loads)
1593 load-elt (and loads (car loads)))))
1596 (defun eval-after-load (file form)
1597 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1598 If FILE is already loaded, evaluate FORM right now.
1600 If a matching file is loaded again, FORM will be evaluated again.
1602 If FILE is a string, it may be either an absolute or a relative file
1603 name, and may have an extension \(e.g. \".el\") or may lack one, and
1604 additionally may or may not have an extension denoting a compressed
1605 format \(e.g. \".gz\").
1607 When FILE is absolute, this first converts it to a true name by chasing
1608 symbolic links. Only a file of this name \(see next paragraph regarding
1609 extensions) will trigger the evaluation of FORM. When FILE is relative,
1610 a file whose absolute true name ends in FILE will trigger evaluation.
1612 When FILE lacks an extension, a file name with any extension will trigger
1613 evaluation. Otherwise, its extension must match FILE's. A further
1614 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1617 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1618 is evaluated whenever that feature is `provide'd.
1620 Usually FILE is just a library name like \"font-lock\" or a feature name
1623 This function makes or adds to an entry on `after-load-alist'."
1624 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1625 ;; evaluating it now).
1626 (let* ((regexp-or-feature
1627 (if (stringp file) (load-history-regexp file) file))
1628 (elt (assoc regexp-or-feature after-load-alist)))
1630 (setq elt (list regexp-or-feature))
1631 (push elt after-load-alist))
1632 ;; Add FORM to the element unless it's already there.
1633 (unless (member form (cdr elt))
1634 (nconc elt (list form)))
1636 ;; Is there an already loaded file whose name (or `provide' name)
1638 (if (if (stringp file)
1639 (load-history-filename-element regexp-or-feature)
1643 (defun do-after-load-evaluation (abs-file)
1644 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1645 ABS-FILE, a string, should be the absolute true name of a file just loaded."
1646 (let ((after-load-elts after-load-alist)
1647 a-l-element file-elements file-element form)
1648 (while after-load-elts
1649 (setq a-l-element (car after-load-elts)
1650 after-load-elts (cdr after-load-elts))
1651 (when (and (stringp (car a-l-element))
1652 (string-match (car a-l-element) abs-file))
1653 (while (setq a-l-element (cdr a-l-element)) ; discard the file name
1654 (setq form (car a-l-element))
1657 (defun eval-next-after-load (file)
1658 "Read the following input sexp, and run it whenever FILE is loaded.
1659 This makes or adds to an entry on `after-load-alist'.
1660 FILE should be the name of a library, with no directory name."
1661 (eval-after-load file (read)))
1665 (defun process-lines (program &rest args)
1666 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1667 Signal an error if the program returns with a non-zero exit status."
1669 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1670 (unless (eq status 0)
1671 (error "%s exited with status %s" program status))
1672 (goto-char (point-min))
1675 (setq lines (cons (buffer-substring-no-properties
1676 (line-beginning-position)
1677 (line-end-position))
1680 (nreverse lines)))))
1682 ;; open-network-stream is a wrapper around make-network-process.
1684 (when (featurep 'make-network-process)
1685 (defun open-network-stream (name buffer host service)
1686 "Open a TCP connection for a service to a host.
1687 Returns a subprocess-object to represent the connection.
1688 Input and output work as for subprocesses; `delete-process' closes it.
1690 NAME is the name for the process. It is modified if necessary to make
1692 BUFFER is the buffer (or buffer name) to associate with the
1693 process. Process output goes at end of that buffer. BUFFER may
1694 be nil, meaning that this process is not associated with any buffer.
1695 HOST is the name or IP address of the host to connect to.
1696 SERVICE is the name of the service desired, or an integer specifying
1697 a port number to connect to.
1699 This is a wrapper around `make-network-process', and only offers a
1700 subset of its functionality."
1701 (make-network-process :name name :buffer buffer
1702 :host host :service service)))
1707 'process-kill-without-query
1708 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1710 (defun process-kill-without-query (process &optional flag)
1711 "Say no query needed if PROCESS is running when Emacs is exited.
1712 Optional second argument if non-nil says to require a query.
1713 Value is t if a query was formerly required."
1714 (let ((old (process-query-on-exit-flag process)))
1715 (set-process-query-on-exit-flag process nil)
1718 ;; process plist management
1720 (defun process-get (process propname)
1721 "Return the value of PROCESS' PROPNAME property.
1722 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1723 (plist-get (process-plist process) propname))
1725 (defun process-put (process propname value)
1726 "Change PROCESS' PROPNAME property to VALUE.
1727 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1728 (set-process-plist process
1729 (plist-put (process-plist process) propname value)))
1732 ;;;; Input and display facilities.
1734 (defvar read-quoted-char-radix 8
1735 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1736 Legitimate radix values are 8, 10 and 16.")
1738 (custom-declare-variable-early
1739 'read-quoted-char-radix 8
1740 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1741 Legitimate radix values are 8, 10 and 16."
1742 :type '(choice (const 8) (const 10) (const 16))
1743 :group 'editing-basics)
1745 (defun read-quoted-char (&optional prompt)
1746 "Like `read-char', but do not allow quitting.
1747 Also, if the first character read is an octal digit,
1748 we read any number of octal digits and return the
1749 specified character code. Any nondigit terminates the sequence.
1750 If the terminator is RET, it is discarded;
1751 any other terminator is used itself as input.
1753 The optional argument PROMPT specifies a string to use to prompt the user.
1754 The variable `read-quoted-char-radix' controls which radix to use
1756 (let ((message-log-max nil) done (first t) (code 0) char translated)
1758 (let ((inhibit-quit first)
1759 ;; Don't let C-h get the help message--only help function keys.
1762 "Type the special character you want to use,
1763 or the octal character code.
1764 RET terminates the character code and is discarded;
1765 any other non-digit terminates the character code and is then used as input."))
1766 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1767 (if inhibit-quit (setq quit-flag nil)))
1768 ;; Translate TAB key into control-I ASCII character, and so on.
1769 ;; Note: `read-char' does it using the `ascii-character' property.
1770 ;; We could try and use read-key-sequence instead, but then C-q ESC
1771 ;; or C-q C-x might not return immediately since ESC or C-x might be
1772 ;; bound to some prefix in function-key-map or key-translation-map.
1775 (char-resolve-modifiers char)
1777 (let ((translation (lookup-key local-function-key-map (vector char))))
1778 (if (arrayp translation)
1779 (setq translated (aref translation 0))))
1780 (cond ((null translated))
1781 ((not (integerp translated))
1782 (setq unread-command-events (list char)
1784 ((/= (logand translated ?\M-\^@) 0)
1785 ;; Turn a meta-character into a character with the 0200 bit set.
1786 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1788 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1789 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1790 (and prompt (setq prompt (message "%s %c" prompt translated))))
1791 ((and (<= ?a (downcase translated))
1792 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1793 (setq code (+ (* code read-quoted-char-radix)
1794 (+ 10 (- (downcase translated) ?a))))
1795 (and prompt (setq prompt (message "%s %c" prompt translated))))
1796 ((and (not first) (eq translated ?\C-m))
1799 (setq unread-command-events (list char)
1801 (t (setq code translated
1806 (defun read-passwd (prompt &optional confirm default)
1807 "Read a password, prompting with PROMPT, and return it.
1808 If optional CONFIRM is non-nil, read the password twice to make sure.
1809 Optional DEFAULT is a default password to use instead of empty input.
1811 This function echoes `.' for each character that the user types.
1813 The user ends with RET, LFD, or ESC. DEL or C-h rubs out.
1814 C-y yanks the current kill. C-u kills line.
1815 C-g quits; if `inhibit-quit' was non-nil around this function,
1816 then it returns nil if the user types C-g, but quit-flag remains set.
1818 Once the caller uses the password, it can erase the password
1819 by doing (clear-string STRING)."
1823 (while (not success)
1824 (let ((first (read-passwd prompt nil default))
1825 (second (read-passwd "Confirm password: " nil default)))
1826 (if (equal first second)
1828 (and (arrayp second) (clear-string second))
1829 (setq success first))
1830 (and (arrayp first) (clear-string first))
1831 (and (arrayp second) (clear-string second))
1832 (message "Password not repeated accurately; please start over")
1836 ;; Copy it so that add-text-properties won't modify
1837 ;; the object that was passed in by the caller.
1838 (prompt (copy-sequence prompt))
1841 (cursor-in-echo-area t)
1842 (message-log-max nil)
1843 (stop-keys (list 'return ?\r ?\n ?\e))
1844 (rubout-keys (list 'backspace ?\b ?\177)))
1845 (add-text-properties 0 (length prompt)
1846 minibuffer-prompt-properties prompt)
1847 (while (progn (message "%s%s"
1849 (make-string (length pass) ?.))
1850 ;; We used to use read-char-exclusive, but that
1851 ;; gives funny behavior when the user presses,
1852 ;; e.g., the arrow keys.
1853 (setq c (read-event nil t))
1854 (not (memq c stop-keys)))
1855 (clear-this-command-keys)
1856 (cond ((memq c rubout-keys) ; rubout
1857 (when (> (length pass) 0)
1858 (let ((new-pass (substring pass 0 -1)))
1859 (and (arrayp pass) (clear-string pass))
1860 (setq pass new-pass))))
1862 ((= c ?\C-u) ; kill line
1863 (and (arrayp pass) (clear-string pass))
1866 (let* ((str (condition-case nil
1873 (substring-no-properties str)))
1874 (and (arrayp pass) (clear-string pass))
1876 (setq pass new-pass))))
1877 ((characterp c) ; insert char
1878 (let* ((new-char (char-to-string c))
1879 (new-pass (concat pass new-char)))
1880 (and (arrayp pass) (clear-string pass))
1881 (clear-string new-char)
1883 (setq pass new-pass)))))
1885 (or pass default "")))))
1887 ;; This should be used by `call-interactively' for `n' specs.
1888 (defun read-number (prompt &optional default)
1889 "Read a numeric value in the minibuffer, prompting with PROMPT.
1890 DEFAULT specifies a default value to return if the user just types RET.
1891 The value of DEFAULT is inserted into PROMPT."
1895 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1896 (replace-match (format " (default %s)" default) t t prompt 1)
1897 (replace-regexp-in-string "[ \t]*\\'"
1898 (format " (default %s) " default)
1902 (let ((str (read-from-minibuffer prompt nil nil nil nil
1904 (number-to-string default)))))
1907 ((zerop (length str)) default)
1908 ((stringp str) (read str))))
1911 (message "Please enter a number.")
1916 (defun sit-for (seconds &optional nodisp obsolete)
1917 "Perform redisplay, then wait for SECONDS seconds or until input is available.
1918 SECONDS may be a floating-point value.
1919 \(On operating systems that do not support waiting for fractions of a
1920 second, floating-point values are rounded down to the nearest integer.)
1922 If optional arg NODISP is t, don't redisplay, just wait for input.
1923 Redisplay does not happen if input is available before it starts.
1925 Value is t if waited the full time with no input arriving, and nil otherwise.
1927 An obsolete, but still supported form is
1928 \(sit-for SECONDS &optional MILLISECONDS NODISP)
1929 where the optional arg MILLISECONDS specifies an additional wait period,
1930 in milliseconds; this was useful when Emacs was built without
1931 floating point support.
1933 \(fn SECONDS &optional NODISP)"
1934 (if (numberp nodisp)
1935 (setq seconds (+ seconds (* 1e-3 nodisp))
1937 (if obsolete (setq nodisp obsolete)))
1945 (or nodisp (redisplay)))
1947 (or nodisp (redisplay))
1948 (let ((read (read-event nil nil seconds)))
1951 ;; If last command was a prefix arg, e.g. C-u, push this event onto
1952 ;; unread-command-events as (t . EVENT) so it will be added to
1953 ;; this-command-keys by read-key-sequence.
1954 (if (eq overriding-terminal-local-map universal-argument-map)
1955 (setq read (cons t read)))
1956 (push read unread-command-events)
1959 ;;; Atomic change groups.
1961 (defmacro atomic-change-group (&rest body)
1962 "Perform BODY as an atomic change group.
1963 This means that if BODY exits abnormally,
1964 all of its changes to the current buffer are undone.
1965 This works regardless of whether undo is enabled in the buffer.
1967 This mechanism is transparent to ordinary use of undo;
1968 if undo is enabled in the buffer and BODY succeeds, the
1969 user can undo the change normally."
1970 (declare (indent 0) (debug t))
1971 (let ((handle (make-symbol "--change-group-handle--"))
1972 (success (make-symbol "--change-group-success--")))
1973 `(let ((,handle (prepare-change-group))
1974 ;; Don't truncate any undo data in the middle of this.
1975 (undo-outer-limit nil)
1976 (undo-limit most-positive-fixnum)
1977 (undo-strong-limit most-positive-fixnum)
1981 ;; This is inside the unwind-protect because
1982 ;; it enables undo if that was disabled; we need
1983 ;; to make sure that it gets disabled again.
1984 (activate-change-group ,handle)
1987 ;; Either of these functions will disable undo
1988 ;; if it was disabled before.
1990 (accept-change-group ,handle)
1991 (cancel-change-group ,handle))))))
1993 (defun prepare-change-group (&optional buffer)
1994 "Return a handle for the current buffer's state, for a change group.
1995 If you specify BUFFER, make a handle for BUFFER's state instead.
1997 Pass the handle to `activate-change-group' afterward to initiate
1998 the actual changes of the change group.
2000 To finish the change group, call either `accept-change-group' or
2001 `cancel-change-group' passing the same handle as argument. Call
2002 `accept-change-group' to accept the changes in the group as final;
2003 call `cancel-change-group' to undo them all. You should use
2004 `unwind-protect' to make sure the group is always finished. The call
2005 to `activate-change-group' should be inside the `unwind-protect'.
2006 Once you finish the group, don't use the handle again--don't try to
2007 finish the same group twice. For a simple example of correct use, see
2008 the source code of `atomic-change-group'.
2010 The handle records only the specified buffer. To make a multibuffer
2011 change group, call this function once for each buffer you want to
2012 cover, then use `nconc' to combine the returned values, like this:
2014 (nconc (prepare-change-group buffer-1)
2015 (prepare-change-group buffer-2))
2017 You can then activate that multibuffer change group with a single
2018 call to `activate-change-group' and finish it with a single call
2019 to `accept-change-group' or `cancel-change-group'."
2022 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2023 (list (cons (current-buffer) buffer-undo-list))))
2025 (defun activate-change-group (handle)
2026 "Activate a change group made with `prepare-change-group' (which see)."
2027 (dolist (elt handle)
2028 (with-current-buffer (car elt)
2029 (if (eq buffer-undo-list t)
2030 (setq buffer-undo-list nil)))))
2032 (defun accept-change-group (handle)
2033 "Finish a change group made with `prepare-change-group' (which see).
2034 This finishes the change group by accepting its changes as final."
2035 (dolist (elt handle)
2036 (with-current-buffer (car elt)
2038 (setq buffer-undo-list t)))))
2040 (defun cancel-change-group (handle)
2041 "Finish a change group made with `prepare-change-group' (which see).
2042 This finishes the change group by reverting all of its changes."
2043 (dolist (elt handle)
2044 (with-current-buffer (car elt)
2045 (setq elt (cdr elt))
2047 ;; Widen buffer temporarily so if the buffer was narrowed within
2048 ;; the body of `atomic-change-group' all changes can be undone.
2051 (if (consp elt) (car elt)))
2053 (if (consp elt) (cdr elt))))
2054 ;; Temporarily truncate the undo log at ELT.
2056 (setcar elt nil) (setcdr elt nil))
2057 (unless (eq last-command 'undo) (undo-start))
2058 ;; Make sure there's no confusion.
2059 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2060 (error "Undoing to some unrelated state"))
2063 (while (listp pending-undo-list) (undo-more 1)))
2064 ;; Reset the modified cons cell ELT to its original content.
2066 (setcar elt old-car)
2067 (setcdr elt old-cdr))
2068 ;; Revert the undo info to what it was when we grabbed the state.
2069 (setq buffer-undo-list elt))))))
2071 ;;;; Display-related functions.
2073 ;; For compatibility.
2074 (defalias 'redraw-modeline 'force-mode-line-update)
2076 (defun force-mode-line-update (&optional all)
2077 "Force redisplay of the current buffer's mode line and header line.
2078 With optional non-nil ALL, force redisplay of all mode lines and
2079 header lines. This function also forces recomputation of the
2080 menu bar menus and the frame title."
2081 (if all (save-excursion (set-buffer (other-buffer))))
2082 (set-buffer-modified-p (buffer-modified-p)))
2084 (defun momentary-string-display (string pos &optional exit-char message)
2085 "Momentarily display STRING in the buffer at POS.
2086 Display remains until next event is input.
2087 If POS is a marker, only its position is used; its buffer is ignored.
2088 Optional third arg EXIT-CHAR can be a character, event or event
2089 description list. EXIT-CHAR defaults to SPC. If the input is
2090 EXIT-CHAR it is swallowed; otherwise it is then available as
2091 input (as a command if nothing else).
2092 Display MESSAGE (optional fourth arg) in the echo area.
2093 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2094 (or exit-char (setq exit-char ?\s))
2095 (let ((ol (make-overlay pos pos))
2096 (message (copy-sequence string)))
2100 (overlay-put ol 'after-string message)
2102 ;; To avoid trouble with out-of-bounds position
2104 ;; If the message end is off screen, recenter now.
2105 (if (<= (window-end nil t) pos)
2106 (recenter (/ (window-height) 2))))
2107 (message (or message "Type %s to continue editing.")
2108 (single-key-description exit-char))
2110 (if (integerp exit-char)
2113 (setq char (read-char))
2114 (or (eq char exit-char)
2115 (setq unread-command-events (list char))))
2117 ;; `exit-char' is a character, hence it differs
2118 ;; from char, which is an event.
2119 (setq unread-command-events (list char))))
2120 ;; `exit-char' can be an event, or an event description list.
2121 (setq char (read-event))
2122 (or (eq char exit-char)
2123 (eq char (event-convert-list exit-char))
2124 (setq unread-command-events (list char))))))
2125 (delete-overlay ol))))
2128 ;;;; Overlay operations
2130 (defun copy-overlay (o)
2131 "Return a copy of overlay O."
2132 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
2133 ;; FIXME: there's no easy way to find the
2134 ;; insertion-type of the two markers.
2135 (overlay-buffer o)))
2136 (props (overlay-properties o)))
2138 (overlay-put o1 (pop props) (pop props)))
2141 (defun remove-overlays (&optional beg end name val)
2142 "Clear BEG and END of overlays whose property NAME has value VAL.
2143 Overlays might be moved and/or split.
2144 BEG and END default respectively to the beginning and end of buffer."
2145 ;; This speeds up the loops over overlays.
2146 (unless beg (setq beg (point-min)))
2147 (unless end (setq end (point-max)))
2148 (overlay-recenter end)
2150 (setq beg (prog1 end (setq end beg))))
2152 (dolist (o (overlays-in beg end))
2153 (when (eq (overlay-get o name) val)
2154 ;; Either push this overlay outside beg...end
2155 ;; or split it to exclude beg...end
2156 ;; or delete it entirely (if it is contained in beg...end).
2157 (if (< (overlay-start o) beg)
2158 (if (> (overlay-end o) end)
2160 (move-overlay (copy-overlay o)
2161 (overlay-start o) beg)
2162 (move-overlay o end (overlay-end o)))
2163 (move-overlay o (overlay-start o) beg))
2164 (if (> (overlay-end o) end)
2165 (move-overlay o end (overlay-end o))
2166 (delete-overlay o)))))))
2170 (defvar suspend-hook nil
2171 "Normal hook run by `suspend-emacs', before suspending.")
2173 (defvar suspend-resume-hook nil
2174 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2176 (defvar temp-buffer-show-hook nil
2177 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2178 When the hook runs, the temporary buffer is current, and the window it
2179 was displayed in is selected.")
2181 (defvar temp-buffer-setup-hook nil
2182 "Normal hook run by `with-output-to-temp-buffer' at the start.
2183 When the hook runs, the temporary buffer is current.
2184 This hook is normally set up with a function to put the buffer in Help
2187 ;; Avoid compiler warnings about this variable,
2188 ;; which has a special meaning on certain system types.
2189 (defvar buffer-file-type nil
2190 "Non-nil if the visited file is a binary file.
2191 This variable is meaningful on MS-DOG and Windows NT.
2192 On those systems, it is automatically local in every buffer.
2193 On other systems, this variable is normally always nil.")
2195 ;; The `assert' macro from the cl package signals
2196 ;; `cl-assertion-failed' at runtime so always define it.
2197 (put 'cl-assertion-failed 'error-conditions '(error))
2198 (put 'cl-assertion-failed 'error-message "Assertion failed")
2200 (defconst user-emacs-directory
2201 (if (eq system-type 'ms-dos)
2202 ;; MS-DOS cannot have initial dot.
2205 "Directory beneath which additional per-user Emacs-specific files are placed.
2206 Various programs in Emacs store information in this directory.
2207 Note that this should end with a directory separator.
2208 See also `locate-user-emacs-file'.")
2210 (defun locate-user-emacs-file (new-name &optional old-name)
2211 "Return an absolute per-user Emacs-specific file name.
2212 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2213 Else return NEW-NAME in `user-emacs-directory', creating the
2214 directory if it does not exist."
2215 (convert-standard-filename
2216 (let* ((home (concat "~" (or init-file-user "")))
2217 (at-home (and old-name (expand-file-name old-name home))))
2218 (if (and at-home (file-readable-p at-home))
2220 ;; Make sure `user-emacs-directory' exists,
2221 ;; unless we're in batch mode or dumping Emacs
2224 (file-accessible-directory-p (directory-file-name user-emacs-directory))
2225 (make-directory user-emacs-directory))
2226 (expand-file-name new-name user-emacs-directory)))))
2229 ;;;; Misc. useful functions.
2231 (defun find-tag-default ()
2232 "Determine default tag to search for, based on text at point.
2233 If there is no plausible default, return nil."
2234 (let (from to bound)
2236 ;; Look at text around `point'.
2238 (skip-syntax-backward "w_") (setq from (point)))
2240 (skip-syntax-forward "w_") (setq to (point)))
2242 ;; Look between `line-beginning-position' and `point'.
2244 (and (setq bound (line-beginning-position))
2245 (skip-syntax-backward "^w_" bound)
2246 (> (setq to (point)) bound)
2247 (skip-syntax-backward "w_")
2248 (setq from (point))))
2249 ;; Look between `point' and `line-end-position'.
2251 (and (setq bound (line-end-position))
2252 (skip-syntax-forward "^w_" bound)
2253 (< (setq from (point)) bound)
2254 (skip-syntax-forward "w_")
2255 (setq to (point)))))
2256 (buffer-substring-no-properties from to))))
2258 (defun play-sound (sound)
2259 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2260 The following keywords are recognized:
2262 :file FILE - read sound data from FILE. If FILE isn't an
2263 absolute file name, it is searched in `data-directory'.
2265 :data DATA - read sound data from string DATA.
2267 Exactly one of :file or :data must be present.
2269 :volume VOL - set volume to VOL. VOL must an integer in the
2270 range 0..100 or a float in the range 0..1.0. If not specified,
2271 don't change the volume setting of the sound device.
2273 :device DEVICE - play sound on DEVICE. If not specified,
2274 a system-dependent default device name is used.
2276 Note: :data and :device are currently not supported on Windows."
2277 (if (fboundp 'play-sound-internal)
2278 (play-sound-internal sound)
2279 (error "This Emacs binary lacks sound support")))
2281 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2283 (defun shell-quote-argument (argument)
2284 "Quote ARGUMENT for passing as argument to an inferior shell."
2285 (if (or (eq system-type 'ms-dos)
2286 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2287 ;; Quote using double quotes, but escape any existing quotes in
2288 ;; the argument with backslashes.
2292 (if (or (null (string-match "[^\"]" argument))
2293 (< (match-end 0) (length argument)))
2294 (while (string-match "[\"]" argument start)
2295 (setq end (match-beginning 0)
2296 result (concat result (substring argument start end)
2297 "\\" (substring argument end (1+ end)))
2299 (concat "\"" result (substring argument start) "\""))
2300 (if (equal argument "")
2302 ;; Quote everything except POSIX filename characters.
2303 ;; This should be safe enough even for really weird shells.
2304 (let ((result "") (start 0) end)
2305 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2306 (setq end (match-beginning 0)
2307 result (concat result (substring argument start end)
2308 "\\" (substring argument end (1+ end)))
2310 (concat result (substring argument start))))))
2312 (defun string-or-null-p (object)
2313 "Return t if OBJECT is a string or nil.
2314 Otherwise, return nil."
2315 (or (stringp object) (null object)))
2317 (defun booleanp (object)
2318 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2319 (memq object '(nil t)))
2321 (defun field-at-pos (pos)
2322 "Return the field at position POS, taking stickiness etc into account."
2323 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2324 (if (eq raw-field 'boundary)
2325 (get-char-property (1- (field-end pos)) 'field)
2329 ;;;; Support for yanking and text properties.
2331 (defvar yank-excluded-properties)
2333 (defun remove-yank-excluded-properties (start end)
2334 "Remove `yank-excluded-properties' between START and END positions.
2335 Replaces `category' properties with their defined properties."
2336 (let ((inhibit-read-only t))
2337 ;; Replace any `category' property with the properties it stands for.
2338 (unless (memq yank-excluded-properties '(t nil))
2341 (while (< (point) end)
2342 (let ((cat (get-text-property (point) 'category))
2345 (next-single-property-change (point) 'category nil end))
2347 (let (run-end2 original)
2348 (remove-list-of-text-properties (point) run-end '(category))
2349 (while (< (point) run-end)
2350 (setq run-end2 (next-property-change (point) nil run-end))
2351 (setq original (text-properties-at (point)))
2352 (set-text-properties (point) run-end2 (symbol-plist cat))
2353 (add-text-properties (point) run-end2 original)
2354 (goto-char run-end2))))
2355 (goto-char run-end)))))
2356 (if (eq yank-excluded-properties t)
2357 (set-text-properties start end nil)
2358 (remove-list-of-text-properties start end yank-excluded-properties))))
2360 (defvar yank-undo-function)
2362 (defun insert-for-yank (string)
2363 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2365 See `insert-for-yank-1' for more details."
2367 (while (setq to (next-single-property-change 0 'yank-handler string))
2368 (insert-for-yank-1 (substring string 0 to))
2369 (setq string (substring string to))))
2370 (insert-for-yank-1 string))
2372 (defun insert-for-yank-1 (string)
2373 "Insert STRING at point, stripping some text properties.
2375 Strip text properties from the inserted text according to
2376 `yank-excluded-properties'. Otherwise just like (insert STRING).
2378 If STRING has a non-nil `yank-handler' property on the first character,
2379 the normal insert behavior is modified in various ways. The value of
2380 the yank-handler property must be a list with one to four elements
2381 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2382 When FUNCTION is present and non-nil, it is called instead of `insert'
2383 to insert the string. FUNCTION takes one argument--the object to insert.
2384 If PARAM is present and non-nil, it replaces STRING as the object
2385 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2386 `yank-rectangle', PARAM may be a list of strings to insert as a
2388 If NOEXCLUDE is present and non-nil, the normal removal of the
2389 yank-excluded-properties is not performed; instead FUNCTION is
2390 responsible for removing those properties. This may be necessary
2391 if FUNCTION adjusts point before or after inserting the object.
2392 If UNDO is present and non-nil, it is a function that will be called
2393 by `yank-pop' to undo the insertion of the current object. It is
2394 called with two arguments, the start and end of the current region.
2395 FUNCTION may set `yank-undo-function' to override the UNDO value."
2396 (let* ((handler (and (stringp string)
2397 (get-text-property 0 'yank-handler string)))
2398 (param (or (nth 1 handler) string))
2400 (inhibit-read-only inhibit-read-only)
2403 (setq yank-undo-function t)
2404 (if (nth 0 handler) ;; FUNCTION
2405 (funcall (car handler) param)
2409 ;; Prevent read-only properties from interfering with the
2410 ;; following text property changes.
2411 (setq inhibit-read-only t)
2413 ;; What should we do with `font-lock-face' properties?
2414 (if font-lock-defaults
2415 ;; No, just wipe them.
2416 (remove-list-of-text-properties opoint end '(font-lock-face))
2417 ;; Convert them to `face'.
2420 (while (< (point) end)
2421 (let ((face (get-text-property (point) 'font-lock-face))
2424 (next-single-property-change (point) 'font-lock-face nil end))
2426 (remove-text-properties (point) run-end '(font-lock-face nil))
2427 (put-text-property (point) run-end 'face face))
2428 (goto-char run-end)))))
2430 (unless (nth 2 handler) ;; NOEXCLUDE
2431 (remove-yank-excluded-properties opoint (point)))
2433 ;; If last inserted char has properties, mark them as rear-nonsticky.
2434 (if (and (> end opoint)
2435 (text-properties-at (1- end)))
2436 (put-text-property (1- end) end 'rear-nonsticky t))
2438 (if (eq yank-undo-function t) ;; not set by FUNCTION
2439 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2440 (if (nth 4 handler) ;; COMMAND
2441 (setq this-command (nth 4 handler)))))
2443 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2444 "Insert before point a substring of BUFFER, without text properties.
2445 BUFFER may be a buffer or a buffer name.
2446 Arguments START and END are character positions specifying the substring.
2447 They default to the values of (point-min) and (point-max) in BUFFER."
2448 (let ((opoint (point)))
2449 (insert-buffer-substring buffer start end)
2450 (let ((inhibit-read-only t))
2451 (set-text-properties opoint (point) nil))))
2453 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2454 "Insert before point a part of BUFFER, stripping some text properties.
2455 BUFFER may be a buffer or a buffer name.
2456 Arguments START and END are character positions specifying the substring.
2457 They default to the values of (point-min) and (point-max) in BUFFER.
2458 Strip text properties from the inserted text according to
2459 `yank-excluded-properties'."
2460 ;; Since the buffer text should not normally have yank-handler properties,
2461 ;; there is no need to handle them here.
2462 (let ((opoint (point)))
2463 (insert-buffer-substring buffer start end)
2464 (remove-yank-excluded-properties opoint (point))))
2467 ;;;; Synchronous shell commands.
2469 (defun start-process-shell-command (name buffer &rest args)
2470 "Start a program in a subprocess. Return the process object for it.
2471 NAME is name for process. It is modified if necessary to make it unique.
2472 BUFFER is the buffer (or buffer name) to associate with the process.
2473 Process output goes at end of that buffer, unless you specify
2474 an output stream or filter function to handle the output.
2475 BUFFER may be also nil, meaning that this process is not associated
2477 COMMAND is the name of a shell command.
2478 Remaining arguments are the arguments for the command; they are all
2479 spliced together with blanks separating between each two of them, before
2480 passing the command to the shell.
2481 Wildcards and redirection are handled as usual in the shell.
2483 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
2484 ;; We used to use `exec' to replace the shell with the command,
2485 ;; but that failed to handle (...) and semicolon, etc.
2486 (start-process name buffer shell-file-name shell-command-switch
2487 (mapconcat 'identity args " ")))
2489 (defun start-file-process-shell-command (name buffer &rest args)
2490 "Start a program in a subprocess. Return the process object for it.
2491 Similar to `start-process-shell-command', but calls `start-file-process'."
2494 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2495 (if (file-remote-p default-directory) "-c" shell-command-switch)
2496 (mapconcat 'identity args " ")))
2498 (defun call-process-shell-command (command &optional infile buffer display
2500 "Execute the shell command COMMAND synchronously in separate process.
2501 The remaining arguments are optional.
2502 The program's input comes from file INFILE (nil means `/dev/null').
2503 Insert output in BUFFER before point; t means current buffer;
2504 nil for BUFFER means discard it; 0 means discard and don't wait.
2505 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2506 REAL-BUFFER says what to do with standard output, as above,
2507 while STDERR-FILE says what to do with standard error in the child.
2508 STDERR-FILE may be nil (discard standard error output),
2509 t (mix it with ordinary output), or a file name string.
2511 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2512 Remaining arguments are strings passed as additional arguments for COMMAND.
2513 Wildcards and redirection are handled as usual in the shell.
2515 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2516 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2517 status or a signal description string.
2518 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2519 ;; We used to use `exec' to replace the shell with the command,
2520 ;; but that failed to handle (...) and semicolon, etc.
2521 (call-process shell-file-name
2522 infile buffer display
2523 shell-command-switch
2524 (mapconcat 'identity (cons command args) " ")))
2526 (defun process-file-shell-command (command &optional infile buffer display
2528 "Process files synchronously in a separate process.
2529 Similar to `call-process-shell-command', but calls `process-file'."
2531 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2532 infile buffer display
2533 (if (file-remote-p default-directory) "-c" shell-command-switch)
2534 (mapconcat 'identity (cons command args) " ")))
2536 ;;;; Lisp macros to do various things temporarily.
2538 (defmacro with-current-buffer (buffer-or-name &rest body)
2539 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2540 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2541 The value returned is the value of the last form in BODY. See
2542 also `with-temp-buffer'."
2543 (declare (indent 1) (debug t))
2544 `(save-current-buffer
2545 (set-buffer ,buffer-or-name)
2548 (defmacro with-selected-window (window &rest body)
2549 "Execute the forms in BODY with WINDOW as the selected window.
2550 The value returned is the value of the last form in BODY.
2552 This macro saves and restores the selected window, as well as the
2553 selected window of each frame. It does not change the order of
2554 recently selected windows. If the previously selected window of
2555 some frame is no longer live at the end of BODY, that frame's
2556 selected window is left alone. If the selected window is no
2557 longer live, then whatever window is selected at the end of BODY
2560 This macro uses `save-current-buffer' to save and restore the
2561 current buffer, since otherwise its normal operation could
2562 potentially make a different buffer current. It does not alter
2563 the buffer list ordering."
2564 (declare (indent 1) (debug t))
2565 ;; Most of this code is a copy of save-selected-window.
2566 `(let ((save-selected-window-window (selected-window))
2567 ;; It is necessary to save all of these, because calling
2568 ;; select-window changes frame-selected-window for whatever
2569 ;; frame that window is in.
2570 (save-selected-window-alist
2571 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2573 (save-current-buffer
2575 (progn (select-window ,window 'norecord)
2577 (dolist (elt save-selected-window-alist)
2578 (and (frame-live-p (car elt))
2579 (window-live-p (cadr elt))
2580 (set-frame-selected-window (car elt) (cadr elt) 'norecord)))
2581 (when (window-live-p save-selected-window-window)
2582 (select-window save-selected-window-window 'norecord))))))
2584 (defmacro with-selected-frame (frame &rest body)
2585 "Execute the forms in BODY with FRAME as the selected frame.
2586 The value returned is the value of the last form in BODY.
2588 This macro neither changes the order of recently selected windows
2589 nor the buffer list."
2590 (declare (indent 1) (debug t))
2591 (let ((old-frame (make-symbol "old-frame"))
2592 (old-buffer (make-symbol "old-buffer")))
2593 `(let ((,old-frame (selected-frame))
2594 (,old-buffer (current-buffer)))
2596 (progn (select-frame ,frame 'norecord)
2598 (when (frame-live-p ,old-frame)
2599 (select-frame ,old-frame 'norecord))
2600 (when (buffer-live-p ,old-buffer)
2601 (set-buffer ,old-buffer))))))
2603 (defmacro with-temp-file (file &rest body)
2604 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2605 The value returned is the value of the last form in BODY.
2606 See also `with-temp-buffer'."
2608 (let ((temp-file (make-symbol "temp-file"))
2609 (temp-buffer (make-symbol "temp-buffer")))
2610 `(let ((,temp-file ,file)
2612 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2615 (with-current-buffer ,temp-buffer
2617 (with-current-buffer ,temp-buffer
2618 (write-region nil nil ,temp-file nil 0)))
2619 (and (buffer-name ,temp-buffer)
2620 (kill-buffer ,temp-buffer))))))
2622 (defmacro with-temp-message (message &rest body)
2623 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2624 The original message is restored to the echo area after BODY has finished.
2625 The value returned is the value of the last form in BODY.
2626 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2627 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2628 Use a MESSAGE of \"\" to temporarily clear the echo area."
2630 (let ((current-message (make-symbol "current-message"))
2631 (temp-message (make-symbol "with-temp-message")))
2632 `(let ((,temp-message ,message)
2637 (setq ,current-message (current-message))
2638 (message "%s" ,temp-message))
2641 (if ,current-message
2642 (message "%s" ,current-message)
2645 (defmacro with-temp-buffer (&rest body)
2646 "Create a temporary buffer, and evaluate BODY there like `progn'.
2647 See also `with-temp-file' and `with-output-to-string'."
2648 (declare (indent 0) (debug t))
2649 (let ((temp-buffer (make-symbol "temp-buffer")))
2650 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2651 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
2652 (with-current-buffer ,temp-buffer
2655 (and (buffer-name ,temp-buffer)
2656 (kill-buffer ,temp-buffer)))))))
2658 (defmacro with-output-to-string (&rest body)
2659 "Execute BODY, return the text it sent to `standard-output', as a string."
2660 (declare (indent 0) (debug t))
2661 `(let ((standard-output
2662 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2665 (let ((standard-output standard-output))
2667 (with-current-buffer standard-output
2669 (kill-buffer standard-output))))
2671 (defmacro with-local-quit (&rest body)
2672 "Execute BODY, allowing quits to terminate BODY but not escape further.
2673 When a quit terminates BODY, `with-local-quit' returns nil but
2674 requests another quit. That quit will be processed as soon as quitting
2675 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2676 (declare (debug t) (indent 0))
2677 `(condition-case nil
2678 (let ((inhibit-quit nil))
2680 (quit (setq quit-flag t)
2681 ;; This call is to give a chance to handle quit-flag
2682 ;; in case inhibit-quit is nil.
2683 ;; Without this, it will not be handled until the next function
2684 ;; call, and that might allow it to exit thru a condition-case
2685 ;; that intends to handle the quit signal next time.
2686 (eval '(ignore nil)))))
2688 (defmacro while-no-input (&rest body)
2689 "Execute BODY only as long as there's no pending input.
2690 If input arrives, that ends the execution of BODY,
2691 and `while-no-input' returns t. Quitting makes it return nil.
2692 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2693 (declare (debug t) (indent 0))
2694 (let ((catch-sym (make-symbol "input")))
2697 (let ((throw-on-input ',catch-sym))
2698 (or (input-pending-p)
2699 (progn ,@body)))))))
2701 (defmacro condition-case-no-debug (var bodyform &rest handlers)
2702 "Like `condition-case' except that it does not catch anything when debugging.
2703 More specifically if `debug-on-error' is set, then it does not catch any signal."
2704 (declare (debug condition-case) (indent 2))
2705 (let ((bodysym (make-symbol "body")))
2706 `(let ((,bodysym (lambda () ,bodyform)))
2709 (condition-case ,var
2713 (defmacro with-demoted-errors (&rest body)
2714 "Run BODY and demote any errors to simple messages.
2715 If `debug-on-error' is non-nil, run BODY without catching its errors.
2716 This is to be used around code which is not expected to signal an error
2717 but which should be robust in the unexpected case that an error is signaled."
2718 (declare (debug t) (indent 0))
2719 (let ((err (make-symbol "err")))
2720 `(condition-case-no-debug ,err
2722 (error (message "Error: %s" ,err) nil))))
2724 (defmacro combine-after-change-calls (&rest body)
2725 "Execute BODY, but don't call the after-change functions till the end.
2726 If BODY makes changes in the buffer, they are recorded
2727 and the functions on `after-change-functions' are called several times
2728 when BODY is finished.
2729 The return value is the value of the last form in BODY.
2731 If `before-change-functions' is non-nil, then calls to the after-change
2732 functions can't be deferred, so in that case this macro has no effect.
2734 Do not alter `after-change-functions' or `before-change-functions'
2736 (declare (indent 0) (debug t))
2738 (let ((combine-after-change-calls t))
2740 (combine-after-change-execute)))
2742 (defmacro with-case-table (table &rest body)
2743 "Execute the forms in BODY with TABLE as the current case table.
2744 The value returned is the value of the last form in BODY."
2745 (declare (indent 1) (debug t))
2746 (let ((old-case-table (make-symbol "table"))
2747 (old-buffer (make-symbol "buffer")))
2748 `(let ((,old-case-table (current-case-table))
2749 (,old-buffer (current-buffer)))
2751 (progn (set-case-table ,table)
2753 (with-current-buffer ,old-buffer
2754 (set-case-table ,old-case-table))))))
2756 ;;; Matching and match data.
2758 (defvar save-match-data-internal)
2760 ;; We use save-match-data-internal as the local variable because
2761 ;; that works ok in practice (people should not use that variable elsewhere).
2762 ;; We used to use an uninterned symbol; the compiler handles that properly
2763 ;; now, but it generates slower code.
2764 (defmacro save-match-data (&rest body)
2765 "Execute the BODY forms, restoring the global value of the match data.
2766 The value returned is the value of the last form in BODY."
2767 ;; It is better not to use backquote here,
2768 ;; because that makes a bootstrapping problem
2769 ;; if you need to recompile all the Lisp files using interpreted code.
2770 (declare (indent 0) (debug t))
2772 '((save-match-data-internal (match-data)))
2773 (list 'unwind-protect
2775 ;; It is safe to free (evaporate) markers immediately here,
2776 ;; as Lisp programs should not copy from save-match-data-internal.
2777 '(set-match-data save-match-data-internal 'evaporate))))
2779 (defun match-string (num &optional string)
2780 "Return string of text matched by last search.
2781 NUM specifies which parenthesized expression in the last regexp.
2782 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2783 Zero means the entire text matched by the whole regexp or whole string.
2784 STRING should be given if the last search was by `string-match' on STRING."
2785 (if (match-beginning num)
2787 (substring string (match-beginning num) (match-end num))
2788 (buffer-substring (match-beginning num) (match-end num)))))
2790 (defun match-string-no-properties (num &optional string)
2791 "Return string of text matched by last search, without text properties.
2792 NUM specifies which parenthesized expression in the last regexp.
2793 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2794 Zero means the entire text matched by the whole regexp or whole string.
2795 STRING should be given if the last search was by `string-match' on STRING."
2796 (if (match-beginning num)
2798 (substring-no-properties string (match-beginning num)
2800 (buffer-substring-no-properties (match-beginning num)
2804 (defun match-substitute-replacement (replacement
2805 &optional fixedcase literal string subexp)
2806 "Return REPLACEMENT as it will be inserted by `replace-match'.
2807 In other words, all back-references in the form `\\&' and `\\N'
2808 are substituted with actual strings matched by the last search.
2809 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
2810 meaning as for `replace-match'."
2811 (let ((match (match-string 0 string)))
2813 (set-match-data (mapcar (lambda (x)
2815 (- x (match-beginning 0))
2818 (replace-match replacement fixedcase literal match subexp))))
2821 (defun looking-back (regexp &optional limit greedy)
2822 "Return non-nil if text before point matches regular expression REGEXP.
2823 Like `looking-at' except matches before point, and is slower.
2824 LIMIT if non-nil speeds up the search by specifying a minimum
2825 starting position, to avoid checking matches that would start
2828 If GREEDY is non-nil, extend the match backwards as far as
2829 possible, stopping when a single additional previous character
2830 cannot be part of a match for REGEXP. When the match is
2831 extended, its starting position is allowed to occur before
2833 (let ((start (point))
2836 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2838 (if (and greedy pos)
2840 (narrow-to-region (point-min) start)
2841 (while (and (> pos (point-min))
2845 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2846 (setq pos (1- pos)))
2849 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2852 (defsubst looking-at-p (regexp)
2854 Same as `looking-at' except this function does not change the match data."
2855 (let ((inhibit-changing-match-data t))
2856 (looking-at regexp)))
2858 (defsubst string-match-p (regexp string &optional start)
2860 Same as `string-match' except this function does not change the match data."
2861 (let ((inhibit-changing-match-data t))
2862 (string-match regexp string start)))
2864 (defun subregexp-context-p (regexp pos &optional start)
2865 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2866 A subregexp context is one where a sub-regexp can appear.
2867 A non-subregexp context is for example within brackets, or within a
2868 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2869 If START is non-nil, it should be a position in REGEXP, smaller
2870 than POS, and known to be in a subregexp context."
2871 ;; Here's one possible implementation, with the great benefit that it
2872 ;; reuses the regexp-matcher's own parser, so it understands all the
2873 ;; details of the syntax. A disadvantage is that it needs to match the
2877 (string-match (substring regexp (or start 0) pos) "")
2880 (not (member (cadr err) '("Unmatched [ or [^"
2882 "Trailing backslash")))))
2883 ;; An alternative implementation:
2884 ;; (defconst re-context-re
2885 ;; (let* ((harmless-ch "[^\\[]")
2886 ;; (harmless-esc "\\\\[^{]")
2887 ;; (class-harmless-ch "[^][]")
2888 ;; (class-lb-harmless "[^]:]")
2889 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2890 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2891 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2893 ;; (concat "\\[^?]?"
2894 ;; "\\(" class-harmless-ch
2895 ;; "\\|" class-lb "\\)*"
2896 ;; "\\[?]")) ; special handling for bare [ at end of re
2897 ;; (braces "\\\\{[0-9,]+\\\\}"))
2898 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2899 ;; "\\|" class "\\|" braces "\\)*\\'"))
2900 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2901 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2906 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2907 "The default value of separators for `split-string'.
2909 A regexp matching strings of whitespace. May be locale-dependent
2910 \(as yet unimplemented). Should not match non-breaking spaces.
2912 Warning: binding this to a different value and using it as default is
2913 likely to have undesired semantics.")
2915 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2916 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2917 ;; expression leads to the equivalent implementation that if SEPARATORS
2918 ;; is defaulted, OMIT-NULLS is treated as t.
2919 (defun split-string (string &optional separators omit-nulls)
2920 "Split STRING into substrings bounded by matches for SEPARATORS.
2922 The beginning and end of STRING, and each match for SEPARATORS, are
2923 splitting points. The substrings matching SEPARATORS are removed, and
2924 the substrings between the splitting points are collected as a list,
2927 If SEPARATORS is non-nil, it should be a regular expression matching text
2928 which separates, but is not part of, the substrings. If nil it defaults to
2929 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2930 OMIT-NULLS is forced to t.
2932 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2933 that for the default value of SEPARATORS leading and trailing whitespace
2934 are effectively trimmed). If nil, all zero-length substrings are retained,
2935 which correctly parses CSV format, for example.
2937 Note that the effect of `(split-string STRING)' is the same as
2938 `(split-string STRING split-string-default-separators t)'. In the rare
2939 case that you wish to retain zero-length substrings when splitting on
2940 whitespace, use `(split-string STRING split-string-default-separators)'.
2942 Modifies the match data; use `save-match-data' if necessary."
2943 (let ((keep-nulls (not (if separators omit-nulls t)))
2944 (rexp (or separators split-string-default-separators))
2948 (while (and (string-match rexp string
2950 (= start (match-beginning 0))
2951 (< start (length string)))
2953 (< start (length string)))
2955 (if (or keep-nulls (< start (match-beginning 0)))
2957 (cons (substring string start (match-beginning 0))
2959 (setq start (match-end 0)))
2960 (if (or keep-nulls (< start (length string)))
2962 (cons (substring string start)
2966 (defun combine-and-quote-strings (strings &optional separator)
2967 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
2968 This tries to quote the strings to avoid ambiguity such that
2969 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2970 Only some SEPARATORs will work properly."
2971 (let* ((sep (or separator " "))
2972 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
2975 (if (string-match re str)
2976 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
2980 (defun split-string-and-unquote (string &optional separator)
2981 "Split the STRING into a list of strings.
2982 It understands Emacs Lisp quoting within STRING, such that
2983 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2984 The SEPARATOR regexp defaults to \"\\s-+\"."
2985 (let ((sep (or separator "\\s-+"))
2986 (i (string-match "\"" string)))
2988 (split-string string sep t) ; no quoting: easy
2989 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
2990 (let ((rfs (read-from-string string i)))
2992 (split-string-and-unquote (substring string (cdr rfs))
2996 ;;;; Replacement in strings.
2998 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2999 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3000 Unless optional argument INPLACE is non-nil, return a new string."
3001 (let ((i (length string))
3002 (newstr (if inplace string (copy-sequence string))))
3005 (if (eq (aref newstr i) fromchar)
3006 (aset newstr i tochar)))
3009 (defun replace-regexp-in-string (regexp rep string &optional
3010 fixedcase literal subexp start)
3011 "Replace all matches for REGEXP with REP in STRING.
3013 Return a new string containing the replacements.
3015 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3016 arguments with the same names of function `replace-match'. If START
3017 is non-nil, start replacements at that index in STRING.
3019 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3020 function. If it is a function, it is called with the actual text of each
3021 match, and its value is used as the replacement text. When REP is called,
3022 the match-data are the result of matching REGEXP against a substring
3025 To replace only the first match (if any), make REGEXP match up to \\'
3026 and replace a sub-expression, e.g.
3027 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3031 ;; To avoid excessive consing from multiple matches in long strings,
3032 ;; don't just call `replace-match' continually. Walk down the
3033 ;; string looking for matches of REGEXP and building up a (reversed)
3034 ;; list MATCHES. This comprises segments of STRING which weren't
3035 ;; matched interspersed with replacements for segments that were.
3036 ;; [For a `large' number of replacements it's more efficient to
3037 ;; operate in a temporary buffer; we can't tell from the function's
3038 ;; args whether to choose the buffer-based implementation, though it
3039 ;; might be reasonable to do so for long enough STRING.]
3040 (let ((l (length string))
3041 (start (or start 0))
3044 (while (and (< start l) (string-match regexp string start))
3045 (setq mb (match-beginning 0)
3047 ;; If we matched the empty string, make sure we advance by one char
3048 (when (= me mb) (setq me (min l (1+ mb))))
3049 ;; Generate a replacement for the matched substring.
3050 ;; Operate only on the substring to minimize string consing.
3051 ;; Set up match data for the substring for replacement;
3052 ;; presumably this is likely to be faster than munging the
3053 ;; match data directly in Lisp.
3054 (string-match regexp (setq str (substring string mb me)))
3056 (cons (replace-match (if (stringp rep)
3058 (funcall rep (match-string 0 str)))
3059 fixedcase literal str subexp)
3060 (cons (substring string start mb) ; unmatched prefix
3063 ;; Reconstruct a string from the pieces.
3064 (setq matches (cons (substring string start l) matches)) ; leftover
3065 (apply #'concat (nreverse matches)))))
3067 ;;;; invisibility specs
3069 (defun add-to-invisibility-spec (element)
3070 "Add ELEMENT to `buffer-invisibility-spec'.
3071 See documentation for `buffer-invisibility-spec' for the kind of elements
3073 (if (eq buffer-invisibility-spec t)
3074 (setq buffer-invisibility-spec (list t)))
3075 (setq buffer-invisibility-spec
3076 (cons element buffer-invisibility-spec)))
3078 (defun remove-from-invisibility-spec (element)
3079 "Remove ELEMENT from `buffer-invisibility-spec'."
3080 (if (consp buffer-invisibility-spec)
3081 (setq buffer-invisibility-spec
3082 (delete element buffer-invisibility-spec))))
3086 (defmacro with-syntax-table (table &rest body)
3087 "Evaluate BODY with syntax table of current buffer set to TABLE.
3088 The syntax table of the current buffer is saved, BODY is evaluated, and the
3089 saved table is restored, even in case of an abnormal exit.
3090 Value is what BODY returns."
3092 (let ((old-table (make-symbol "table"))
3093 (old-buffer (make-symbol "buffer")))
3094 `(let ((,old-table (syntax-table))
3095 (,old-buffer (current-buffer)))
3098 (set-syntax-table ,table)
3100 (save-current-buffer
3101 (set-buffer ,old-buffer)
3102 (set-syntax-table ,old-table))))))
3104 (defun make-syntax-table (&optional oldtable)
3105 "Return a new syntax table.
3106 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3107 from `standard-syntax-table' otherwise."
3108 (let ((table (make-char-table 'syntax-table nil)))
3109 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3112 (defun syntax-after (pos)
3113 "Return the raw syntax of the char after POS.
3114 If POS is outside the buffer's accessible portion, return nil."
3115 (unless (or (< pos (point-min)) (>= pos (point-max)))
3116 (let ((st (if parse-sexp-lookup-properties
3117 (get-char-property pos 'syntax-table))))
3119 (aref (or st (syntax-table)) (char-after pos))))))
3121 (defun syntax-class (syntax)
3122 "Return the syntax class part of the syntax descriptor SYNTAX.
3123 If SYNTAX is nil, return nil."
3124 (and syntax (logand (car syntax) 65535)))
3128 (defun text-clone-maintain (ol1 after beg end &optional len)
3129 "Propagate the changes made under the overlay OL1 to the other clones.
3130 This is used on the `modification-hooks' property of text clones."
3131 (when (and after (not undo-in-progress) (overlay-start ol1))
3132 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3133 (setq beg (max beg (+ (overlay-start ol1) margin)))
3134 (setq end (min end (- (overlay-end ol1) margin)))
3137 (when (overlay-get ol1 'text-clone-syntax)
3138 ;; Check content of the clone's text.
3139 (let ((cbeg (+ (overlay-start ol1) margin))
3140 (cend (- (overlay-end ol1) margin)))
3143 (if (not (re-search-forward
3144 (overlay-get ol1 'text-clone-syntax) cend t))
3145 ;; Mark the overlay for deletion.
3146 (overlay-put ol1 'text-clones nil)
3147 (when (< (match-end 0) cend)
3148 ;; Shrink the clone at its end.
3149 (setq end (min end (match-end 0)))
3150 (move-overlay ol1 (overlay-start ol1)
3151 (+ (match-end 0) margin)))
3152 (when (> (match-beginning 0) cbeg)
3153 ;; Shrink the clone at its beginning.
3154 (setq beg (max (match-beginning 0) beg))
3155 (move-overlay ol1 (- (match-beginning 0) margin)
3156 (overlay-end ol1)))))))
3157 ;; Now go ahead and update the clones.
3158 (let ((head (- beg (overlay-start ol1)))
3159 (tail (- (overlay-end ol1) end))
3160 (str (buffer-substring beg end))
3162 (inhibit-modification-hooks t))
3163 (dolist (ol2 (overlay-get ol1 'text-clones))
3164 (let ((oe (overlay-end ol2)))
3165 (unless (or (eq ol1 ol2) (null oe))
3166 (setq nothing-left nil)
3167 (let ((mod-beg (+ (overlay-start ol2) head)))
3168 ;;(overlay-put ol2 'modification-hooks nil)
3169 (goto-char (- (overlay-end ol2) tail))
3170 (unless (> mod-beg (point))
3171 (save-excursion (insert str))
3172 (delete-region mod-beg (point)))
3173 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3175 (if nothing-left (delete-overlay ol1))))))))
3177 (defun text-clone-create (start end &optional spreadp syntax)
3178 "Create a text clone of START...END at point.
3179 Text clones are chunks of text that are automatically kept identical:
3180 changes done to one of the clones will be immediately propagated to the other.
3182 The buffer's content at point is assumed to be already identical to
3183 the one between START and END.
3184 If SYNTAX is provided it's a regexp that describes the possible text of
3185 the clones; the clone will be shrunk or killed if necessary to ensure that
3186 its text matches the regexp.
3187 If SPREADP is non-nil it indicates that text inserted before/after the
3188 clone should be incorporated in the clone."
3189 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3190 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3191 ;; (with a one-char margin at each end) with `t nil'.
3192 ;; We opted for a larger overlay because it behaves better in the case
3193 ;; where the clone is reduced to the empty string (we want the overlay to
3194 ;; stay when the clone's content is the empty string and we want to use
3195 ;; `evaporate' to make sure those overlays get deleted when needed).
3197 (let* ((pt-end (+ (point) (- end start)))
3198 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3200 (end-margin (if (or (not spreadp)
3201 (>= pt-end (point-max))
3202 (>= start (point-max)))
3204 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3205 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3206 (dups (list ol1 ol2)))
3207 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3208 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3209 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3210 ;;(overlay-put ol1 'face 'underline)
3211 (overlay-put ol1 'evaporate t)
3212 (overlay-put ol1 'text-clones dups)
3214 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3215 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3216 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3217 ;;(overlay-put ol2 'face 'underline)
3218 (overlay-put ol2 'evaporate t)
3219 (overlay-put ol2 'text-clones dups)))
3221 ;;;; Mail user agents.
3223 ;; Here we include just enough for other packages to be able
3226 (defun define-mail-user-agent (symbol composefunc sendfunc
3227 &optional abortfunc hookvar)
3228 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3230 SYMBOL can be any Lisp symbol. Its function definition and/or
3231 value as a variable do not matter for this usage; we use only certain
3232 properties on its property list, to encode the rest of the arguments.
3234 COMPOSEFUNC is program callable function that composes an outgoing
3235 mail message buffer. This function should set up the basics of the
3236 buffer without requiring user interaction. It should populate the
3237 standard mail headers, leaving the `to:' and `subject:' headers blank
3240 COMPOSEFUNC should accept several optional arguments--the same
3241 arguments that `compose-mail' takes. See that function's documentation.
3243 SENDFUNC is the command a user would run to send the message.
3245 Optional ABORTFUNC is the command a user would run to abort the
3246 message. For mail packages that don't have a separate abort function,
3247 this can be `kill-buffer' (the equivalent of omitting this argument).
3249 Optional HOOKVAR is a hook variable that gets run before the message
3250 is actually sent. Callers that use the `mail-user-agent' may
3251 install a hook function temporarily on this hook variable.
3252 If HOOKVAR is nil, `mail-send-hook' is used.
3254 The properties used on SYMBOL are `composefunc', `sendfunc',
3255 `abortfunc', and `hookvar'."
3256 (put symbol 'composefunc composefunc)
3257 (put symbol 'sendfunc sendfunc)
3258 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3259 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3261 ;;;; Progress reporters.
3263 ;; Progress reporter has the following structure:
3265 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3272 ;; This weirdeness is for optimization reasons: we want
3273 ;; `progress-reporter-update' to be as fast as possible, so
3274 ;; `(car reporter)' is better than `(aref reporter 0)'.
3276 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3277 ;; digits of precision, it doesn't really matter here. On the other
3278 ;; hand, it greatly simplifies the code.
3280 (defsubst progress-reporter-update (reporter value)
3281 "Report progress of an operation in the echo area.
3282 However, if the change since last echo area update is too small
3283 or not enough time has passed, then do nothing (see
3284 `make-progress-reporter' for details).
3286 First parameter, REPORTER, should be the result of a call to
3287 `make-progress-reporter'. Second, VALUE, determines the actual
3288 progress of operation; it must be between MIN-VALUE and MAX-VALUE
3289 as passed to `make-progress-reporter'.
3291 This function is very inexpensive, you may not bother how often
3293 (when (>= value (car reporter))
3294 (progress-reporter-do-update reporter value)))
3296 (defun make-progress-reporter (message min-value max-value
3297 &optional current-value
3298 min-change min-time)
3299 "Return progress reporter object to be used with `progress-reporter-update'.
3301 MESSAGE is shown in the echo area. When at least 1% of operation
3302 is complete, the exact percentage will be appended to the
3303 MESSAGE. When you call `progress-reporter-done', word \"done\"
3304 is printed after the MESSAGE. You can change MESSAGE of an
3305 existing progress reporter with `progress-reporter-force-update'.
3307 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
3308 final (100% complete) states of operation. The latter should be
3309 larger; if this is not the case, then simply negate all values.
3310 Optional CURRENT-VALUE specifies the progress by the moment you
3311 call this function. You should omit it or set it to nil in most
3312 cases since it defaults to MIN-VALUE.
3314 Optional MIN-CHANGE determines the minimal change in percents to
3315 report (default is 1%.) Optional MIN-TIME specifies the minimal
3316 time before echo area updates (default is 0.2 seconds.) If
3317 `float-time' function is not present, then time is not tracked
3318 at all. If OS is not capable of measuring fractions of seconds,
3319 then this parameter is effectively rounded up."
3322 (setq min-time 0.2))
3324 (cons min-value ;; Force a call to `message' now
3325 (vector (if (and (fboundp 'float-time)
3331 (if min-change (max (min min-change 50) 1) 1)
3333 (progress-reporter-update reporter (or current-value min-value))
3336 (defun progress-reporter-force-update (reporter value &optional new-message)
3337 "Report progress of an operation in the echo area unconditionally.
3339 First two parameters are the same as for
3340 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
3341 change the displayed message."
3342 (let ((parameters (cdr reporter)))
3344 (aset parameters 3 new-message))
3345 (when (aref parameters 0)
3346 (aset parameters 0 (float-time)))
3347 (progress-reporter-do-update reporter value)))
3349 (defun progress-reporter-do-update (reporter value)
3350 (let* ((parameters (cdr reporter))
3351 (min-value (aref parameters 1))
3352 (max-value (aref parameters 2))
3353 (one-percent (/ (- max-value min-value) 100.0))
3354 (percentage (if (= max-value min-value)
3356 (truncate (/ (- value min-value) one-percent))))
3357 (update-time (aref parameters 0))
3358 (current-time (float-time))
3360 ;; See if enough time has passed since the last update.
3361 (or (not update-time)
3362 (when (>= current-time update-time)
3363 ;; Calculate time for the next update
3364 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3366 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
3367 ;; message this time because not enough time has passed, then use
3368 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
3369 ;; updates closer to MIN-TIME.
3371 (min (+ min-value (* (+ percentage
3372 (if enough-time-passed
3373 (aref parameters 4) ;; MIN-CHANGE
3377 (when (integerp value)
3378 (setcar reporter (ceiling (car reporter))))
3380 ;; Only print message if enough time has passed
3381 (when enough-time-passed
3382 (if (> percentage 0)
3383 (message "%s%d%%" (aref parameters 3) percentage)
3384 (message "%s" (aref parameters 3))))))
3386 (defun progress-reporter-done (reporter)
3387 "Print reporter's message followed by word \"done\" in echo area."
3388 (message "%sdone" (aref (cdr reporter) 3)))
3390 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3391 "Loop a certain number of times and report progress in the echo area.
3392 Evaluate BODY with VAR bound to successive integers running from
3393 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3394 the return value (nil if RESULT is omitted).
3396 At each iteration MESSAGE followed by progress percentage is
3397 printed in the echo area. After the loop is finished, MESSAGE
3398 followed by word \"done\" is printed. This macro is a
3399 convenience wrapper around `make-progress-reporter' and friends.
3401 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3402 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3403 (let ((temp (make-symbol "--dotimes-temp--"))
3404 (temp2 (make-symbol "--dotimes-temp2--"))
3408 (,(car spec) ,start)
3409 (,temp2 (make-progress-reporter ,message ,start ,end)))
3410 (while (< ,(car spec) ,temp)
3412 (progress-reporter-update ,temp2
3413 (setq ,(car spec) (1+ ,(car spec)))))
3414 (progress-reporter-done ,temp2)
3415 nil ,@(cdr (cdr spec)))))
3418 ;;;; Comparing version strings.
3420 (defvar version-separator "."
3421 "*Specify the string used to separate the version elements.
3423 Usually the separator is \".\", but it can be any other string.")
3426 (defvar version-regexp-alist
3427 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3428 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3429 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3430 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3431 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3432 "*Specify association between non-numeric version part and a priority.
3434 This association is used to handle version string like \"1.0pre2\",
3435 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3436 non-numeric part to an integer. For example:
3438 String Version Integer List Version
3439 \"1.0pre2\" (1 0 -1 2)
3440 \"1.0PRE2\" (1 0 -1 2)
3441 \"22.8beta3\" (22 8 -2 3)
3442 \"22.8 Beta3\" (22 8 -2 3)
3443 \"0.9alpha1\" (0 9 -3 1)
3444 \"0.9AlphA1\" (0 9 -3 1)
3445 \"0.9 alpha\" (0 9 -3)
3447 Each element has the following form:
3453 REGEXP regexp used to match non-numeric part of a version string.
3454 It should begin with a `^' anchor and end with a `$' to
3455 prevent false hits. Letter-case is ignored while matching
3458 PRIORITY negative integer which indicate the non-numeric priority.")
3461 (defun version-to-list (ver)
3462 "Convert version string VER into an integer list.
3464 The version syntax is given by the following EBNF:
3466 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3468 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3470 SEPARATOR ::= `version-separator' (which see)
3471 | `version-regexp-alist' (which see).
3473 The NUMBER part is optional if SEPARATOR is a match for an element
3474 in `version-regexp-alist'.
3476 As an example of valid version syntax:
3478 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3480 As an example of invalid version syntax:
3482 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3484 As an example of version convertion:
3486 String Version Integer List Version
3487 \"1.0.7.5\" (1 0 7 5)
3488 \"1.0pre2\" (1 0 -1 2)
3489 \"1.0PRE2\" (1 0 -1 2)
3490 \"22.8beta3\" (22 8 -2 3)
3491 \"22.8Beta3\" (22 8 -2 3)
3492 \"0.9alpha1\" (0 9 -3 1)
3493 \"0.9AlphA1\" (0 9 -3 1)
3494 \"0.9alpha\" (0 9 -3)
3496 See documentation for `version-separator' and `version-regexp-alist'."
3497 (or (and (stringp ver) (> (length ver) 0))
3498 (error "Invalid version string: '%s'" ver))
3499 ;; Change .x.y to 0.x.y
3500 (if (and (>= (length ver) (length version-separator))
3501 (string-equal (substring ver 0 (length version-separator))
3503 (setq ver (concat "0" ver)))
3506 (case-fold-search t) ; ignore case in matching
3508 (while (and (setq s (string-match "[0-9]+" ver i))
3510 ;; handle numeric part
3511 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3514 ;; handle non-numeric part
3515 (when (and (setq s (string-match "[^0-9]+" ver i))
3517 (setq s (substring ver i (match-end 0))
3519 ;; handle alpha, beta, pre, etc. separator
3520 (unless (string= s version-separator)
3521 (setq al version-regexp-alist)
3522 (while (and al (not (string-match (caar al) s)))
3524 (or al (error "Invalid version syntax: '%s'" ver))
3525 (setq lst (cons (cdar al) lst)))))
3527 (error "Invalid version syntax: '%s'" ver)
3531 (defun version-list-< (l1 l2)
3532 "Return t if integer list L1 is lesser than L2.
3534 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3535 etc. That is, the trailing zeroes are irrelevant. Also, integer
3536 list (1) is greater than (1 -1) which is greater than (1 -2)
3537 which is greater than (1 -3)."
3538 (while (and l1 l2 (= (car l1) (car l2)))
3542 ;; l1 not null and l2 not null
3543 ((and l1 l2) (< (car l1) (car l2)))
3544 ;; l1 null and l2 null ==> l1 length = l2 length
3545 ((and (null l1) (null l2)) nil)
3546 ;; l1 not null and l2 null ==> l1 length > l2 length
3547 (l1 (< (version-list-not-zero l1) 0))
3548 ;; l1 null and l2 not null ==> l2 length > l1 length
3549 (t (< 0 (version-list-not-zero l2)))))
3552 (defun version-list-= (l1 l2)
3553 "Return t if integer list L1 is equal to L2.
3555 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3556 etc. That is, the trailing zeroes are irrelevant. Also, integer
3557 list (1) is greater than (1 -1) which is greater than (1 -2)
3558 which is greater than (1 -3)."
3559 (while (and l1 l2 (= (car l1) (car l2)))
3563 ;; l1 not null and l2 not null
3565 ;; l1 null and l2 null ==> l1 length = l2 length
3566 ((and (null l1) (null l2)))
3567 ;; l1 not null and l2 null ==> l1 length > l2 length
3568 (l1 (zerop (version-list-not-zero l1)))
3569 ;; l1 null and l2 not null ==> l2 length > l1 length
3570 (t (zerop (version-list-not-zero l2)))))
3573 (defun version-list-<= (l1 l2)
3574 "Return t if integer list L1 is lesser than or equal to L2.
3576 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3577 etc. That is, the trailing zeroes are irrelevant. Also, integer
3578 list (1) is greater than (1 -1) which is greater than (1 -2)
3579 which is greater than (1 -3)."
3580 (while (and l1 l2 (= (car l1) (car l2)))
3584 ;; l1 not null and l2 not null
3585 ((and l1 l2) (< (car l1) (car l2)))
3586 ;; l1 null and l2 null ==> l1 length = l2 length
3587 ((and (null l1) (null l2)))
3588 ;; l1 not null and l2 null ==> l1 length > l2 length
3589 (l1 (<= (version-list-not-zero l1) 0))
3590 ;; l1 null and l2 not null ==> l2 length > l1 length
3591 (t (<= 0 (version-list-not-zero l2)))))
3593 (defun version-list-not-zero (lst)
3594 "Return the first non-zero element of integer list LST.
3596 If all LST elements are zeroes or LST is nil, return zero."
3597 (while (and lst (zerop (car lst)))
3598 (setq lst (cdr lst)))
3601 ;; there is no element different of zero
3605 (defun version< (v1 v2)
3606 "Return t if version V1 is lesser than V2.
3608 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3609 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3610 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3612 (version-list-< (version-to-list v1) (version-to-list v2)))
3615 (defun version<= (v1 v2)
3616 "Return t if version V1 is lesser than or equal to V2.
3618 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3619 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3620 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3622 (version-list-<= (version-to-list v1) (version-to-list v2)))
3624 (defun version= (v1 v2)
3625 "Return t if version V1 is equal to V2.
3627 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3628 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3629 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3631 (version-list-= (version-to-list v1) (version-to-list v2)))
3633 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3634 ;;; subr.el ends here