1 ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2013 Free Software
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; Beware: while this file has tag `utf-8', before it's compiled, it gets
30 ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
32 (defvar custom-declare-variable-list nil
33 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
34 Each element of this list holds the arguments to one call to `defcustom'.")
36 ;; Use this, rather than defcustom, in subr.el and other files loaded
38 (defun custom-declare-variable-early (&rest arguments
)
39 (setq custom-declare-variable-list
40 (cons arguments custom-declare-variable-list
)))
42 (defmacro declare-function
(fn file
&optional arglist fileonly
)
43 "Tell the byte-compiler that function FN is defined, in FILE.
44 Optional ARGLIST is the argument list used by the function. The
45 FILE argument is not used by the byte-compiler, but by the
46 `check-declare' package, which checks that FILE contains a
47 definition for FN. ARGLIST is used by both the byte-compiler and
48 `check-declare' to check for consistency.
50 FILE can be either a Lisp file (in which case the \".el\"
51 extension is optional), or a C file. C files are expanded
52 relative to the Emacs \"src/\" directory. Lisp files are
53 searched for using `locate-library', and if that fails they are
54 expanded relative to the location of the file containing the
55 declaration. A FILE with an \"ext:\" prefix is an external file.
56 `check-declare' will check such files if they are found, and skip
57 them without error if they are not.
59 FILEONLY non-nil means that `check-declare' will only check that
60 FILE exists, not that it defines FN. This is intended for
61 function-definitions that `check-declare' does not recognize, e.g.
64 To specify a value for FILEONLY without passing an argument list,
65 set ARGLIST to t. This is necessary because nil means an
66 empty argument list, rather than an unspecified one.
68 Note that for the purposes of `check-declare', this statement
69 must be the first non-whitespace on a line.
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."
85 (error "Form marked with `noreturn' did return")))
87 (defmacro 1value
(form)
88 "Evaluate FORM, expecting a constant return value.
89 This is the global do-nothing version. There is also `testcover-1value'
90 that complains if FORM ever does return differing values."
94 (defmacro def-edebug-spec
(symbol spec
)
95 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
96 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
97 0 (instrument no arguments); t (instrument all arguments);
98 a symbol (naming a function with an Edebug specification); or a list.
99 The elements of the list describe the argument types; see
100 Info node `(elisp)Specification List' for details."
101 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
103 (defmacro lambda
(&rest cdr
)
104 "Return a lambda expression.
105 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
106 self-quoting; the result of evaluating the lambda expression is the
107 expression itself. The lambda expression may then be treated as a
108 function, i.e., stored as the function value of a symbol, passed to
109 `funcall' or `mapcar', etc.
111 ARGS should take the same form as an argument list for a `defun'.
112 DOCSTRING is an optional documentation string.
113 If present, it should describe how to call the function.
114 But documentation strings are usually not useful in nameless functions.
115 INTERACTIVE should be a call to the function `interactive', which see.
116 It may also be omitted.
117 BODY should be a list of Lisp expressions.
119 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
120 (declare (doc-string 2) (indent defun
)
121 (debug (&define lambda-list
123 [&optional
("interactive" interactive
)]
125 ;; Note that this definition should not use backquotes; subr.el should not
126 ;; depend on backquote.el.
127 (list 'function
(cons 'lambda cdr
)))
129 (defmacro setq-local
(var val
)
130 "Set variable VAR to value VAL in current buffer."
131 ;; Can't use backquote here, it's too early in the bootstrap.
132 (list 'set
(list 'make-local-variable
(list 'quote var
)) val
))
134 (defmacro defvar-local
(var val
&optional docstring
)
135 "Define VAR as a buffer-local variable with default value VAL.
136 Like `defvar' but additionally marks the variable as being automatically
137 buffer-local wherever it is set."
138 (declare (debug defvar
) (doc-string 3))
139 ;; Can't use backquote here, it's too early in the bootstrap.
140 (list 'progn
(list 'defvar var val docstring
)
141 (list 'make-variable-buffer-local
(list 'quote var
))))
143 (defun apply-partially (fun &rest args
)
144 "Return a function that is a partial application of FUN to ARGS.
145 ARGS is a list of the first N arguments to pass to FUN.
146 The result is a new function which does the same as FUN, except that
147 the first N arguments are fixed at the values with which this function
149 `(closure (t) (&rest args
)
150 (apply ',fun
,@(mapcar (lambda (arg) `',arg
) args
) args
)))
152 (defmacro push
(newelt place
)
153 "Add NEWELT to the list stored in the generalized variable PLACE.
154 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
155 except that PLACE is only evaluated once (after NEWELT)."
156 (declare (debug (form gv-place
)))
158 ;; Important special case, to avoid triggering GV too early in
161 (list 'cons newelt place
))
163 (macroexp-let2 macroexp-copyable-p v newelt
164 (gv-letplace (getter setter
) place
165 (funcall setter
`(cons ,v
,getter
))))))
167 (defmacro pop
(place)
168 "Return the first element of PLACE's value, and remove it from the list.
169 PLACE must be a generalized variable whose value is a list.
170 If the value is nil, `pop' returns nil but does not actually
172 (declare (debug (gv-place)))
175 ;; So we can use `pop' in the bootstrap before `gv' can be used.
176 (list 'prog1 place
(list 'setq place
(list 'cdr place
)))
177 (gv-letplace (getter setter
) place
178 `(prog1 ,getter
,(funcall setter
`(cdr ,getter
)))))))
180 (defmacro when
(cond &rest body
)
181 "If COND yields non-nil, do BODY, else return nil.
182 When COND yields non-nil, eval BODY forms sequentially and return
183 value of last one, or nil if there are none.
186 (declare (indent 1) (debug t
))
187 (list 'if cond
(cons 'progn body
)))
189 (defmacro unless
(cond &rest body
)
190 "If COND yields nil, do BODY, else return nil.
191 When COND yields nil, eval BODY forms sequentially and return
192 value of last one, or nil if there are none.
195 (declare (indent 1) (debug t
))
196 (cons 'if
(cons cond
(cons nil body
))))
198 (defmacro dolist
(spec &rest body
)
200 Evaluate BODY with VAR bound to each car from LIST, in turn.
201 Then evaluate RESULT to get return value, default nil.
203 \(fn (VAR LIST [RESULT]) BODY...)"
204 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
205 ;; It would be cleaner to create an uninterned symbol,
206 ;; but that uses a lot more space when many functions in many files
208 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
209 (let ((temp '--dolist-tail--
))
210 ;; This is not a reliable test, but it does not matter because both
211 ;; semantics are acceptable, tho one is slightly faster with dynamic
212 ;; scoping and the other is slightly faster (and has cleaner semantics)
213 ;; with lexical scoping.
215 `(let ((,temp
,(nth 1 spec
)))
217 (let ((,(car spec
) (car ,temp
)))
219 (setq ,temp
(cdr ,temp
))))
221 `(let ((,temp
,(nth 1 spec
))
224 (setq ,(car spec
) (car ,temp
))
226 (setq ,temp
(cdr ,temp
)))
227 ,@(if (cdr (cdr spec
))
228 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
))))))))
230 (defmacro dotimes
(spec &rest body
)
231 "Loop a certain number of times.
232 Evaluate BODY with VAR bound to successive integers running from 0,
233 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
234 the return value (nil if RESULT is omitted).
236 \(fn (VAR COUNT [RESULT]) BODY...)"
237 (declare (indent 1) (debug dolist
))
238 ;; It would be cleaner to create an uninterned symbol,
239 ;; but that uses a lot more space when many functions in many files
241 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
242 (let ((temp '--dotimes-limit--
)
245 ;; This is not a reliable test, but it does not matter because both
246 ;; semantics are acceptable, tho one is slightly faster with dynamic
247 ;; scoping and the other has cleaner semantics.
249 (let ((counter '--dotimes-counter--
))
252 (while (< ,counter
,temp
)
253 (let ((,(car spec
) ,counter
))
255 (setq ,counter
(1+ ,counter
)))
257 ;; FIXME: This let often leads to "unused var" warnings.
258 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
260 (,(car spec
) ,start
))
261 (while (< ,(car spec
) ,temp
)
263 (setq ,(car spec
) (1+ ,(car spec
))))
264 ,@(cdr (cdr spec
))))))
266 (defmacro declare
(&rest _specs
)
267 "Do not evaluate any arguments, and return nil.
268 If a `declare' form appears as the first form in the body of a
269 `defun' or `defmacro' form, SPECS specifies various additional
270 information about the function or macro; these go into effect
271 during the evaluation of the `defun' or `defmacro' form.
273 The possible values of SPECS are specified by
274 `defun-declarations-alist' and `macro-declarations-alist'."
275 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
278 (defmacro ignore-errors
(&rest body
)
279 "Execute BODY; if an error occurs, return nil.
280 Otherwise, return result of last form in BODY.
281 See also `with-demoted-errors' that does something similar
282 without silencing all errors."
283 (declare (debug t
) (indent 0))
284 `(condition-case nil
(progn ,@body
) (error nil
)))
286 ;;;; Basic Lisp functions.
288 (defun ignore (&rest _ignore
)
289 "Do nothing and return nil.
290 This function accepts any number of arguments, but ignores them."
294 ;; Signal a compile-error if the first arg is missing.
295 (defun error (&rest args
)
296 "Signal an error, making error message by passing all args to `format'.
297 In Emacs, the convention is that error messages start with a capital
298 letter but *do not* end with a period. Please follow this convention
299 for the sake of consistency."
301 (signal 'error
(list (apply 'format args
)))))
302 (set-advertised-calling-convention 'error
'(string &rest args
) "23.1")
304 (defun user-error (format &rest args
)
305 "Signal a pilot error, making error message by passing all args to `format'.
306 In Emacs, the convention is that error messages start with a capital
307 letter but *do not* end with a period. Please follow this convention
308 for the sake of consistency.
309 This is just like `error' except that `user-error's are expected to be the
310 result of an incorrect manipulation on the part of the user, rather than the
311 result of an actual problem."
313 (signal 'user-error
(list (apply #'format format args
)))))
315 ;; We put this here instead of in frame.el so that it's defined even on
316 ;; systems where frame.el isn't loaded.
317 (defun frame-configuration-p (object)
318 "Return non-nil if OBJECT seems to be a frame configuration.
319 Any list whose car is `frame-configuration' is assumed to be a frame
322 (eq (car object
) 'frame-configuration
)))
327 "Return the car of the car of X."
331 "Return the car of the cdr of X."
335 "Return the cdr of the car of X."
339 "Return the cdr of the cdr of X."
342 (defun last (list &optional n
)
343 "Return the last link of LIST. Its car is the last element.
344 If LIST is nil, return nil.
345 If N is non-nil, return the Nth-to-last link of LIST.
346 If N is bigger than the length of LIST, return LIST."
349 (let ((m (safe-length list
)))
350 (if (< n m
) (nthcdr (- m n
) list
) list
)))
352 (nthcdr (1- (safe-length list
)) list
))))
354 (defun butlast (list &optional n
)
355 "Return a copy of LIST with the last N elements removed."
356 (if (and n
(<= n
0)) list
357 (nbutlast (copy-sequence list
) n
)))
359 (defun nbutlast (list &optional n
)
360 "Modifies LIST to remove the last N elements."
361 (let ((m (length list
)))
365 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
368 (defun delete-dups (list)
369 "Destructively remove `equal' duplicates from LIST.
370 Store the result in LIST and return it. LIST must be a proper list.
371 Of several `equal' occurrences of an element in LIST, the first
375 (setcdr tail
(delete (car tail
) (cdr tail
)))
376 (setq tail
(cdr tail
))))
379 (defun number-sequence (from &optional to inc
)
380 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
381 INC is the increment used between numbers in the sequence and defaults to 1.
382 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
383 zero. TO is only included if there is an N for which TO = FROM + N * INC.
384 If TO is nil or numerically equal to FROM, return \(FROM).
385 If INC is positive and TO is less than FROM, or INC is negative
386 and TO is larger than FROM, return nil.
387 If INC is zero and TO is neither nil nor numerically equal to
388 FROM, signal an error.
390 This function is primarily designed for integer arguments.
391 Nevertheless, FROM, TO and INC can be integer or float. However,
392 floating point arithmetic is inexact. For instance, depending on
393 the machine, it may quite well happen that
394 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
395 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
396 elements. Thus, if some of the arguments are floats and one wants
397 to make sure that TO is included, one may have to explicitly write
398 TO as \(+ FROM \(* N INC)) or use a variable whose value was
399 computed with this exact expression. Alternatively, you can,
400 of course, also replace TO with a slightly larger value
401 \(or a slightly more negative value if INC is negative)."
402 (if (or (not to
) (= from to
))
404 (or inc
(setq inc
1))
405 (when (zerop inc
) (error "The increment can not be zero"))
406 (let (seq (n 0) (next from
))
409 (setq seq
(cons next seq
)
411 next
(+ from
(* n inc
))))
413 (setq seq
(cons next seq
)
415 next
(+ from
(* n inc
)))))
418 (defun copy-tree (tree &optional vecp
)
419 "Make a copy of TREE.
420 If TREE is a cons cell, this recursively copies both its car and its cdr.
421 Contrast to `copy-sequence', which copies only along the cdrs. With second
422 argument VECP, this copies vectors as well as conses."
426 (let ((newcar (car tree
)))
427 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
428 (setq newcar
(copy-tree (car tree
) vecp
)))
429 (push newcar result
))
430 (setq tree
(cdr tree
)))
431 (nconc (nreverse result
) tree
))
432 (if (and vecp
(vectorp tree
))
433 (let ((i (length (setq tree
(copy-sequence tree
)))))
434 (while (>= (setq i
(1- i
)) 0)
435 (aset tree i
(copy-tree (aref tree i
) vecp
)))
439 ;;;; Various list-search functions.
441 (defun assoc-default (key alist
&optional test default
)
442 "Find object KEY in a pseudo-alist ALIST.
443 ALIST is a list of conses or objects. Each element
444 (or the element's car, if it is a cons) is compared with KEY by
445 calling TEST, with two arguments: (i) the element or its car,
447 If that is non-nil, the element matches; then `assoc-default'
448 returns the element's cdr, if it is a cons, or DEFAULT if the
449 element is not a cons.
451 If no element matches, the value is nil.
452 If TEST is omitted or nil, `equal' is used."
453 (let (found (tail alist
) value
)
454 (while (and tail
(not found
))
455 (let ((elt (car tail
)))
456 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
457 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
458 (setq tail
(cdr tail
)))
461 (defun assoc-ignore-case (key alist
)
462 "Like `assoc', but ignores differences in case and text representation.
463 KEY must be a string. Upper-case and lower-case letters are treated as equal.
464 Unibyte strings are converted to multibyte for comparison."
465 (declare (obsolete assoc-string
"22.1"))
466 (assoc-string key alist t
))
468 (defun assoc-ignore-representation (key alist
)
469 "Like `assoc', but ignores differences in text representation.
470 KEY must be a string.
471 Unibyte strings are converted to multibyte for comparison."
472 (declare (obsolete assoc-string
"22.1"))
473 (assoc-string key alist nil
))
475 (defun member-ignore-case (elt list
)
476 "Like `member', but ignore differences in case and text representation.
477 ELT must be a string. Upper-case and lower-case letters are treated as equal.
478 Unibyte strings are converted to multibyte for comparison.
479 Non-strings in LIST are ignored."
481 (not (and (stringp (car list
))
482 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
483 (setq list
(cdr list
)))
486 (defun assq-delete-all (key alist
)
487 "Delete from ALIST all elements whose car is `eq' to KEY.
488 Return the modified alist.
489 Elements of ALIST that are not conses are ignored."
490 (while (and (consp (car alist
))
491 (eq (car (car alist
)) key
))
492 (setq alist
(cdr alist
)))
493 (let ((tail alist
) tail-cdr
)
494 (while (setq tail-cdr
(cdr tail
))
495 (if (and (consp (car tail-cdr
))
496 (eq (car (car tail-cdr
)) key
))
497 (setcdr tail
(cdr tail-cdr
))
498 (setq tail tail-cdr
))))
501 (defun rassq-delete-all (value alist
)
502 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
503 Return the modified alist.
504 Elements of ALIST that are not conses are ignored."
505 (while (and (consp (car alist
))
506 (eq (cdr (car alist
)) value
))
507 (setq alist
(cdr alist
)))
508 (let ((tail alist
) tail-cdr
)
509 (while (setq tail-cdr
(cdr tail
))
510 (if (and (consp (car tail-cdr
))
511 (eq (cdr (car tail-cdr
)) value
))
512 (setcdr tail
(cdr tail-cdr
))
513 (setq tail tail-cdr
))))
516 (defun remove (elt seq
)
517 "Return a copy of SEQ with all occurrences of ELT removed.
518 SEQ must be a list, vector, or string. The comparison is done with `equal'."
520 ;; If SEQ isn't a list, there's no need to copy SEQ because
521 ;; `delete' will return a new object.
523 (delete elt
(copy-sequence seq
))))
525 (defun remq (elt list
)
526 "Return LIST with all occurrences of ELT removed.
527 The comparison is done with `eq'. Contrary to `delq', this does not use
528 side-effects, and the argument LIST is not modified."
529 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
531 (delq elt
(copy-sequence list
))
537 "Convert KEYS to the internal Emacs key representation.
538 KEYS should be a string constant in the format used for
539 saving keyboard macros (see `edmacro-mode')."
540 ;; Don't use a defalias, since the `pure' property is only true for
541 ;; the calling convention of `kbd'.
542 (read-kbd-macro keys
))
546 "Beep to tell the user this binding is undefined."
550 ;; Prevent the \{...} documentation construct
551 ;; from mentioning keys that run this command.
552 (put 'undefined
'suppress-keymap t
)
554 (defun suppress-keymap (map &optional nodigits
)
555 "Make MAP override all normally self-inserting keys to be undefined.
556 Normally, as an exception, digits and minus-sign are set to make prefix args,
557 but optional second arg NODIGITS non-nil treats them like other chars."
558 (define-key map
[remap self-insert-command
] 'undefined
)
561 (define-key map
"-" 'negative-argument
)
562 ;; Make plain numbers do numeric args.
565 (define-key map
(char-to-string loop
) 'digit-argument
)
566 (setq loop
(1+ loop
))))))
568 (defun make-composed-keymap (maps &optional parent
)
569 "Construct a new keymap composed of MAPS and inheriting from PARENT.
570 When looking up a key in the returned map, the key is looked in each
571 keymap of MAPS in turn until a binding is found.
572 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
573 As always with keymap inheritance, a nil binding in MAPS overrides
574 any corresponding binding in PARENT, but it does not override corresponding
575 bindings in other keymaps of MAPS.
576 MAPS can be a list of keymaps or a single keymap.
577 PARENT if non-nil should be a keymap."
579 ,@(if (keymapp maps
) (list maps
) maps
)
582 (defun define-key-after (keymap key definition
&optional after
)
583 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
584 This is like `define-key' except that the binding for KEY is placed
585 just after the binding for the event AFTER, instead of at the beginning
586 of the map. Note that AFTER must be an event type (like KEY), NOT a command
589 If AFTER is t or omitted, the new binding goes at the end of the keymap.
590 AFTER should be a single event type--a symbol or a character, not a sequence.
592 Bindings are always added before any inherited map.
594 The order of bindings in a keymap only matters when it is used as
595 a menu, so this function is not useful for non-menu keymaps."
596 (unless after
(setq after t
))
598 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
600 (if (<= (length key
) 1) (aref key
0)
601 (setq keymap
(lookup-key keymap
603 (butlast (mapcar 'identity key
)))))
604 (aref key
(1- (length key
)))))
605 (let ((tail keymap
) done inserted
)
606 (while (and (not done
) tail
)
607 ;; Delete any earlier bindings for the same key.
608 (if (eq (car-safe (car (cdr tail
))) key
)
609 (setcdr tail
(cdr (cdr tail
))))
610 ;; If we hit an included map, go down that one.
611 (if (keymapp (car tail
)) (setq tail
(car tail
)))
612 ;; When we reach AFTER's binding, insert the new binding after.
613 ;; If we reach an inherited keymap, insert just before that.
614 ;; If we reach the end of this keymap, insert at the end.
615 (if (or (and (eq (car-safe (car tail
)) after
)
617 (eq (car (cdr tail
)) 'keymap
)
620 ;; Stop the scan only if we find a parent keymap.
621 ;; Keep going past the inserted element
622 ;; so we can delete any duplications that come later.
623 (if (eq (car (cdr tail
)) 'keymap
)
625 ;; Don't insert more than once.
627 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
629 (setq tail
(cdr tail
)))))
631 (defun map-keymap-sorted (function keymap
)
632 "Implement `map-keymap' with sorting.
633 Don't call this function; it is for internal use only."
635 (map-keymap (lambda (a b
) (push (cons a b
) list
))
637 (setq list
(sort list
639 (setq a
(car a
) b
(car b
))
641 (if (integerp b
) (< a b
)
644 ;; string< also accepts symbols.
647 (funcall function
(car p
) (cdr p
)))))
649 (defun keymap--menu-item-binding (val)
650 "Return the binding part of a menu-item."
652 ((not (consp val
)) val
) ;Not a menu-item.
653 ((eq 'menu-item
(car val
))
654 (let* ((binding (nth 2 val
))
655 (plist (nthcdr 3 val
))
656 (filter (plist-get plist
:filter
)))
657 (if filter
(funcall filter binding
)
659 ((and (consp (cdr val
)) (stringp (cadr val
)))
663 (t val
))) ;Not a menu-item either.
665 (defun keymap--menu-item-with-binding (item binding
)
666 "Build a menu-item like ITEM but with its binding changed to BINDING."
668 ((not (consp item
)) binding
) ;Not a menu-item.
669 ((eq 'menu-item
(car item
))
670 (setq item
(copy-sequence item
))
671 (let ((tail (nthcdr 2 item
)))
672 (setcar tail binding
)
673 ;; Remove any potential filter.
674 (if (plist-get (cdr tail
) :filter
)
675 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
677 ((and (consp (cdr item
)) (stringp (cadr item
)))
678 (cons (car item
) (cons (cadr item
) binding
)))
679 (t (cons (car item
) binding
))))
681 (defun keymap--merge-bindings (val1 val2
)
682 "Merge bindings VAL1 and VAL2."
683 (let ((map1 (keymap--menu-item-binding val1
))
684 (map2 (keymap--menu-item-binding val2
)))
685 (if (not (and (keymapp map1
) (keymapp map2
)))
686 ;; There's nothing to merge: val1 takes precedence.
688 (let ((map (list 'keymap map1 map2
))
689 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
690 (keymap--menu-item-with-binding item map
)))))
692 (defun keymap-canonicalize (map)
693 "Return a simpler equivalent keymap.
694 This resolves inheritance and redefinitions. The returned keymap
695 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
696 and use in active keymaps and menus.
697 Subkeymaps may be modified but are not canonicalized."
698 ;; FIXME: Problem with the difference between a nil binding
699 ;; that hides a binding in an inherited map and a nil binding that's ignored
700 ;; to let some further binding visible. Currently a nil binding hides all.
701 ;; FIXME: we may want to carefully (re)order elements in case they're
705 (prompt (keymap-prompt map
)))
707 (setq map
(map-keymap ;; -internal
710 ;; Treat char-ranges specially.
711 (push (cons key item
) ranges
)
712 (push (cons key item
) bindings
)))
714 ;; Create the new map.
715 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
716 (dolist (binding ranges
)
717 ;; Treat char-ranges specially. FIXME: need to merge as well.
718 (define-key map
(vector (car binding
)) (cdr binding
)))
719 ;; Process the bindings starting from the end.
720 (dolist (binding (prog1 bindings
(setq bindings
())))
721 (let* ((key (car binding
))
722 (oldbind (assq key bindings
)))
723 (push (if (not oldbind
)
724 ;; The normal case: no duplicate bindings.
726 ;; This is the second binding for this key.
727 (setq bindings
(delq oldbind bindings
))
728 (cons key
(keymap--merge-bindings (cdr binding
)
731 (nconc map bindings
)))
733 (put 'keyboard-translate-table
'char-table-extra-slots
0)
735 (defun keyboard-translate (from to
)
736 "Translate character FROM to TO on the current terminal.
737 This function creates a `keyboard-translate-table' if necessary
738 and then modifies one entry in it."
739 (or (char-table-p keyboard-translate-table
)
740 (setq keyboard-translate-table
741 (make-char-table 'keyboard-translate-table nil
)))
742 (aset keyboard-translate-table from to
))
744 ;;;; Key binding commands.
746 (defun global-set-key (key command
)
747 "Give KEY a global binding as COMMAND.
748 COMMAND is the command definition to use; usually it is
749 a symbol naming an interactively-callable function.
750 KEY is a key sequence; noninteractively, it is a string or vector
751 of characters or event types, and non-ASCII characters with codes
752 above 127 (such as ISO Latin-1) can be included if you use a vector.
754 Note that if KEY has a local binding in the current buffer,
755 that local binding will continue to shadow any global binding
756 that you make with this function."
757 (interactive "KSet key globally: \nCSet key %s to command: ")
758 (or (vectorp key
) (stringp key
)
759 (signal 'wrong-type-argument
(list 'arrayp key
)))
760 (define-key (current-global-map) key command
))
762 (defun local-set-key (key command
)
763 "Give KEY a local binding as COMMAND.
764 COMMAND is the command definition to use; usually it is
765 a symbol naming an interactively-callable function.
766 KEY is a key sequence; noninteractively, it is a string or vector
767 of characters or event types, and non-ASCII characters with codes
768 above 127 (such as ISO Latin-1) can be included if you use a vector.
770 The binding goes in the current buffer's local map,
771 which in most cases is shared with all other buffers in the same major mode."
772 (interactive "KSet key locally: \nCSet key %s locally to command: ")
773 (let ((map (current-local-map)))
775 (use-local-map (setq map
(make-sparse-keymap))))
776 (or (vectorp key
) (stringp key
)
777 (signal 'wrong-type-argument
(list 'arrayp key
)))
778 (define-key map key command
)))
780 (defun global-unset-key (key)
781 "Remove global binding of KEY.
782 KEY is a string or vector representing a sequence of keystrokes."
783 (interactive "kUnset key globally: ")
784 (global-set-key key nil
))
786 (defun local-unset-key (key)
787 "Remove local binding of KEY.
788 KEY is a string or vector representing a sequence of keystrokes."
789 (interactive "kUnset key locally: ")
790 (if (current-local-map)
791 (local-set-key key nil
))
794 ;;;; substitute-key-definition and its subroutines.
796 (defvar key-substitution-in-progress nil
797 "Used internally by `substitute-key-definition'.")
799 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
800 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
801 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
802 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
803 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
805 If you don't specify OLDMAP, you can usually get the same results
806 in a cleaner way with command remapping, like this:
807 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
808 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
809 ;; Don't document PREFIX in the doc string because we don't want to
810 ;; advertise it. It's meant for recursive calls only. Here's its
813 ;; If optional argument PREFIX is specified, it should be a key
814 ;; prefix, a string. Redefined bindings will then be bound to the
815 ;; original key, with PREFIX added at the front.
816 (or prefix
(setq prefix
""))
817 (let* ((scan (or oldmap keymap
))
818 (prefix1 (vconcat prefix
[nil]))
819 (key-substitution-in-progress
820 (cons scan key-substitution-in-progress)))
821 ;; Scan OLDMAP, finding each char or event-symbol that
822 ;; has any definition, and act on it with hack-key.
825 (aset prefix1 (length prefix) char)
826 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
829 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
830 (let (inner-def skipped menu-item)
831 ;; Find the actual command name within the binding.
832 (if (eq (car-safe defn) 'menu-item)
833 (setq menu-item defn defn (nth 2 defn))
834 ;; Skip past menu-prompt.
835 (while (stringp (car-safe defn))
836 (push (pop defn) skipped))
837 ;; Skip past cached key-equivalence data for menu items.
838 (if (consp (car-safe defn))
839 (setq defn (cdr defn))))
840 (if (or (eq defn olddef)
841 ;; Compare with equal if definition is a key sequence.
842 ;; That is useful for operating on function-key-map.
843 (and (or (stringp defn) (vectorp defn))
844 (equal defn olddef)))
845 (define-key keymap prefix
847 (let ((copy (copy-sequence menu-item)))
848 (setcar (nthcdr 2 copy) newdef)
850 (nconc (nreverse skipped) newdef)))
851 ;; Look past a symbol that names a keymap.
853 (or (indirect-function defn t) defn))
854 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
855 ;; avoid autoloading a keymap. This is mostly done to preserve the
856 ;; original non-autoloading behavior of pre-map-keymap times.
857 (if (and (keymapp inner-def)
858 ;; Avoid recursively scanning
859 ;; where KEYMAP does not have a submap.
860 (let ((elt (lookup-key keymap prefix)))
861 (or (null elt) (natnump elt) (keymapp elt)))
862 ;; Avoid recursively rescanning keymap being scanned.
863 (not (memq inner-def key-substitution-in-progress)))
864 ;; If this one isn't being scanned already, scan it now.
865 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
868 ;;;; The global keymap tree.
870 ;; global-map, esc-map, and ctl-x-map have their values set up in
871 ;; keymap.c; we just give them docstrings here.
873 (defvar global-map nil
874 "Default global keymap mapping Emacs keyboard input into commands.
875 The value is a keymap which is usually (but not necessarily) Emacs's
879 "Default keymap for ESC (meta) commands.
880 The normal global definition of the character ESC indirects to this keymap.")
882 (defvar ctl-x-map nil
883 "Default keymap for C-x commands.
884 The normal global definition of the character C-x indirects to this keymap.")
886 (defvar ctl-x-4-map (make-sparse-keymap)
887 "Keymap for subcommands of C-x 4.")
888 (defalias 'ctl-x-4-prefix ctl-x-4-map)
889 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
891 (defvar ctl-x-5-map (make-sparse-keymap)
892 "Keymap for frame commands.")
893 (defalias 'ctl-x-5-prefix ctl-x-5-map)
894 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
897 ;;;; Event manipulation functions.
899 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
901 (defun listify-key-sequence (key)
902 "Convert a key sequence to a list of events."
905 (mapcar (function (lambda (c)
907 (logxor c listify-key-sequence-1)
912 "True if the argument is an event object."
915 (and (symbolp obj) obj (not (keywordp obj)))
916 (and (consp obj) (symbolp (car obj))))))
918 (defun event-modifiers (event)
919 "Return a list of symbols representing the modifier keys in event EVENT.
920 The elements of the list may include `meta', `control',
921 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
923 EVENT may be an event or an event type. If EVENT is a symbol
924 that has never been used in an event that has been read as input
925 in the current Emacs session, then this function may fail to include
926 the `click' modifier."
929 (setq type (car type)))
931 ;; Don't read event-symbol-elements directly since we're not
932 ;; sure the symbol has already been parsed.
933 (cdr (internal-event-symbol-parse-modifiers type))
935 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
936 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
937 (if (not (zerop (logand type ?\M-\^@)))
939 (if (or (not (zerop (logand type ?\C-\^@)))
941 (push 'control list))
942 (if (or (not (zerop (logand type ?\S-\^@)))
943 (/= char (downcase char)))
945 (or (zerop (logand type ?\H-\^@))
947 (or (zerop (logand type ?\s-\^@))
949 (or (zerop (logand type ?\A-\^@))
953 (defun event-basic-type (event)
954 "Return the basic type of the given event (all modifiers removed).
955 The value is a printing character (not upper case) or a symbol.
956 EVENT may be an event or an event type. If EVENT is a symbol
957 that has never been used in an event that has been read as input
958 in the current Emacs session, then this function may return nil."
960 (setq event (car event)))
962 (car (get event 'event-symbol-elements))
963 (let* ((base (logand event (1- ?\A-\^@)))
964 (uncontrolled (if (< base 32) (logior base 64) base)))
965 ;; There are some numbers that are invalid characters and
966 ;; cause `downcase' to get an error.
968 (downcase uncontrolled)
969 (error uncontrolled)))))
971 (defsubst mouse-movement-p (object)
972 "Return non-nil if OBJECT is a mouse movement event."
973 (eq (car-safe object) 'mouse-movement))
975 (defun mouse-event-p (object)
976 "Return non-nil if OBJECT is a mouse click event."
977 ;; is this really correct? maybe remove mouse-movement?
978 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
980 (defun event-start (event)
981 "Return the starting position of EVENT.
982 EVENT should be a click, drag, or key press event.
983 If it is a key press event, the return value has the form
984 (WINDOW POS (0 . 0) 0)
985 If it is a click or drag event, it has the form
986 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
987 IMAGE (DX . DY) (WIDTH . HEIGHT))
988 The `posn-' functions access elements of such lists.
989 For more information, see Info node `(elisp)Click Events'.
991 If EVENT is a mouse or key press or a mouse click, this is the
992 position of the event. If EVENT is a drag, this is the starting
993 position of the drag."
994 (if (consp event) (nth 1 event)
996 (list (selected-window) (point) '(0 . 0) 0))))
998 (defun event-end (event)
999 "Return the ending location of EVENT.
1000 EVENT should be a click, drag, or key press event.
1001 If EVENT is a key press event, the return value has the form
1002 (WINDOW POS (0 . 0) 0)
1003 If EVENT is a click event, this function is the same as
1004 `event-start'. For click and drag events, the return value has
1006 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
1007 IMAGE (DX . DY) (WIDTH . HEIGHT))
1008 The `posn-' functions access elements of such lists.
1009 For more information, see Info node `(elisp)Click Events'.
1011 If EVENT is a mouse or key press or a mouse click, this is the
1012 position of the event. If EVENT is a drag, this is the starting
1013 position of the drag."
1014 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1016 (list (selected-window) (point) '(0 . 0) 0))))
1018 (defsubst event-click-count (event)
1019 "Return the multi-click count of EVENT, a click or drag event.
1020 The return value is a positive integer."
1021 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1023 ;;;; Extracting fields of the positions in an event.
1026 "Return non-nil if OBJ appears to be a valid `posn' object."
1027 (and (windowp (car-safe obj))
1028 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1029 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1030 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1032 (defsubst posn-window (position)
1033 "Return the window in POSITION.
1034 POSITION should be a list of the form returned by the `event-start'
1035 and `event-end' functions."
1038 (defsubst posn-area (position)
1039 "Return the window area recorded in POSITION, or nil for the text area.
1040 POSITION should be a list of the form returned by the `event-start'
1041 and `event-end' functions."
1042 (let ((area (if (consp (nth 1 position))
1043 (car (nth 1 position))
1045 (and (symbolp area) area)))
1047 (defun posn-point (position)
1048 "Return the buffer location in POSITION.
1049 POSITION should be a list of the form returned by the `event-start'
1050 and `event-end' functions.
1051 Returns nil if POSITION does not correspond to any buffer location (e.g.
1052 a click on a scroll bar)."
1053 (or (nth 5 position)
1054 (let ((pt (nth 1 position)))
1056 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1057 (if (integerp pt) pt)))))
1059 (defun posn-set-point (position)
1060 "Move point to POSITION.
1061 Select the corresponding window as well."
1062 (if (not (windowp (posn-window position)))
1063 (error "Position not in text area of window"))
1064 (select-window (posn-window position))
1065 (if (numberp (posn-point position))
1066 (goto-char (posn-point position))))
1068 (defsubst posn-x-y (position)
1069 "Return the x and y coordinates in POSITION.
1070 The return value has the form (X . Y), where X and Y are given in
1071 pixels. POSITION should be a list of the form returned by
1072 `event-start' and `event-end'."
1075 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1077 (defun posn-col-row (position)
1078 "Return the nominal column and row in POSITION, measured in characters.
1079 The column and row values are approximations calculated from the x
1080 and y coordinates in POSITION and the frame's default character width
1082 For a scroll-bar event, the result column is 0, and the row
1083 corresponds to the vertical position of the click in the scroll bar.
1084 POSITION should be a list of the form returned by the `event-start'
1085 and `event-end' functions."
1086 (let* ((pair (posn-x-y position))
1087 (window (posn-window position))
1088 (area (posn-area position)))
1092 ((eq area 'vertical-scroll-bar)
1093 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1094 ((eq area 'horizontal-scroll-bar)
1095 (cons (scroll-bar-scale pair (window-width window)) 0))
1097 (let* ((frame (if (framep window) window (window-frame window)))
1098 ;; FIXME: This should take line-spacing properties on
1099 ;; newlines into account.
1100 (spacing (when (display-graphic-p frame)
1101 (or (with-current-buffer (window-buffer window)
1103 (frame-parameter frame 'line-spacing)))))
1104 (cond ((floatp spacing)
1105 (setq spacing (truncate (* spacing
1106 (frame-char-height frame)))))
1109 (cons (/ (car pair) (frame-char-width frame))
1110 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1111 (if (null (with-current-buffer (window-buffer window)
1112 header-line-format))
1115 (defun posn-actual-col-row (position)
1116 "Return the actual column and row in POSITION, measured in characters.
1117 These are the actual row number in the window and character number in that row.
1118 Return nil if POSITION does not contain the actual position; in that case
1119 `posn-col-row' can be used to get approximate values.
1120 POSITION should be a list of the form returned by the `event-start'
1121 and `event-end' functions."
1124 (defsubst posn-timestamp (position)
1125 "Return the timestamp of POSITION.
1126 POSITION should be a list of the form returned by the `event-start'
1127 and `event-end' functions."
1130 (defun posn-string (position)
1131 "Return the string object of POSITION.
1132 Value is a cons (STRING . STRING-POS), or nil if not a string.
1133 POSITION should be a list of the form returned by the `event-start'
1134 and `event-end' functions."
1135 (let ((x (nth 4 position)))
1136 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1137 (when (consp x) x)))
1139 (defsubst posn-image (position)
1140 "Return the image object of POSITION.
1141 Value is a list (image ...), or nil if not an image.
1142 POSITION should be a list of the form returned by the `event-start'
1143 and `event-end' functions."
1146 (defsubst posn-object (position)
1147 "Return the object (image or string) of POSITION.
1148 Value is a list (image ...) for an image object, a cons cell
1149 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1150 POSITION should be a list of the form returned by the `event-start'
1151 and `event-end' functions."
1152 (or (posn-image position) (posn-string position)))
1154 (defsubst posn-object-x-y (position)
1155 "Return the x and y coordinates relative to the object of POSITION.
1156 The return value has the form (DX . DY), where DX and DY are
1157 given in pixels. POSITION should be a list of the form returned
1158 by `event-start' and `event-end'."
1161 (defsubst posn-object-width-height (position)
1162 "Return the pixel width and height of the object of POSITION.
1163 The return value has the form (WIDTH . HEIGHT). POSITION should
1164 be a list of the form returned by `event-start' and `event-end'."
1168 ;;;; Obsolescent names for functions.
1170 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1171 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1172 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1173 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1174 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1175 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1177 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1178 (make-obsolete 'buffer-has-markers-at nil "24.3")
1180 (defun insert-string (&rest args)
1181 "Mocklisp-compatibility insert function.
1182 Like the function `insert' except that any argument that is a number
1183 is converted into a string by expressing it in decimal."
1184 (declare (obsolete insert "22.1"))
1186 (insert (if (integerp el) (number-to-string el) el))))
1188 (defun makehash (&optional test)
1189 (declare (obsolete make-hash-table "22.1"))
1190 (make-hash-table :test (or test 'eql)))
1192 ;; These are used by VM and some old programs
1193 (defalias 'focus-frame 'ignore "")
1194 (make-obsolete 'focus-frame "it does nothing." "22.1")
1195 (defalias 'unfocus-frame 'ignore "")
1196 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1197 (make-obsolete 'make-variable-frame-local
1198 "explicitly check for a frame-parameter instead." "22.2")
1199 (set-advertised-calling-convention
1200 'all-completions '(string collection &optional predicate) "23.1")
1201 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1202 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1204 ;;;; Obsolescence declarations for variables, and aliases.
1206 ;; Special "default-FOO" variables which contain the default value of
1207 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1208 ;; slows down several unrelated variable operations; furthermore, they
1209 ;; can lead to really odd behavior if you decide to make them
1212 ;; Not used at all in Emacs, last time I checked:
1213 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1214 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1215 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1216 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1217 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1218 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1219 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1220 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1221 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1222 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1223 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1224 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1225 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1226 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1227 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1228 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1229 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1230 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1231 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1232 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1233 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1234 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1235 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1236 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1237 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1238 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1239 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1240 (make-obsolete-variable 'default-enable-multibyte-characters
1241 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1243 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1244 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1245 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1246 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1247 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1248 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1250 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1251 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1253 ;; Lisp manual only updated in 22.1.
1254 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1257 (define-obsolete-variable-alias 'x-lost-selection-hooks
1258 'x-lost-selection-functions "22.1")
1259 (define-obsolete-variable-alias 'x-sent-selection-hooks
1260 'x-sent-selection-functions "22.1")
1262 ;; This was introduced in 21.4 for pre-unicode unification. That
1263 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1264 ;; Other uses are possible, so this variable is not _really_ obsolete,
1265 ;; but Stefan insists to mark it so.
1266 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1268 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1270 ;;;; Alternate names for functions - these are not being phased out.
1272 (defalias 'send-string 'process-send-string)
1273 (defalias 'send-region 'process-send-region)
1274 (defalias 'string= 'string-equal)
1275 (defalias 'string< 'string-lessp)
1276 (defalias 'move-marker 'set-marker)
1277 (defalias 'rplaca 'setcar)
1278 (defalias 'rplacd 'setcdr)
1279 (defalias 'beep 'ding) ;preserve lingual purity
1280 (defalias 'indent-to-column 'indent-to)
1281 (defalias 'backward-delete-char 'delete-backward-char)
1282 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1283 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1284 (defalias 'int-to-string 'number-to-string)
1285 (defalias 'store-match-data 'set-match-data)
1286 (defalias 'chmod 'set-file-modes)
1287 (defalias 'mkdir 'make-directory)
1288 ;; These are the XEmacs names:
1289 (defalias 'point-at-eol 'line-end-position)
1290 (defalias 'point-at-bol 'line-beginning-position)
1292 (defalias 'user-original-login-name 'user-login-name)
1295 ;;;; Hook manipulation functions.
1297 (defun add-hook (hook function &optional append local)
1298 "Add to the value of HOOK the function FUNCTION.
1299 FUNCTION is not added if already present.
1300 FUNCTION is added (if necessary) at the beginning of the hook list
1301 unless the optional argument APPEND is non-nil, in which case
1302 FUNCTION is added at the end.
1304 The optional fourth argument, LOCAL, if non-nil, says to modify
1305 the hook's buffer-local value rather than its global value.
1306 This makes the hook buffer-local, and it makes t a member of the
1307 buffer-local value. That acts as a flag to run the hook
1308 functions of the global value as well as in the local value.
1310 HOOK should be a symbol, and FUNCTION may be any valid function. If
1311 HOOK is void, it is first set to nil. If HOOK's value is a single
1312 function, it is changed to a list of functions."
1313 (or (boundp hook) (set hook nil))
1314 (or (default-boundp hook) (set-default hook nil))
1315 (if local (unless (local-variable-if-set-p hook)
1316 (set (make-local-variable hook) (list t)))
1317 ;; Detect the case where make-local-variable was used on a hook
1318 ;; and do what we used to do.
1319 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1321 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1322 ;; If the hook value is a single function, turn it into a list.
1323 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1324 (setq hook-value (list hook-value)))
1325 ;; Do the actual addition if necessary
1326 (unless (member function hook-value)
1327 (when (stringp function)
1328 (setq function (purecopy function)))
1331 (append hook-value (list function))
1332 (cons function hook-value))))
1333 ;; Set the actual variable
1336 ;; If HOOK isn't a permanent local,
1337 ;; but FUNCTION wants to survive a change of modes,
1338 ;; mark HOOK as partially permanent.
1339 (and (symbolp function)
1340 (get function 'permanent-local-hook)
1341 (not (get hook 'permanent-local))
1342 (put hook 'permanent-local 'permanent-local-hook))
1343 (set hook hook-value))
1344 (set-default hook hook-value))))
1346 (defun remove-hook (hook function &optional local)
1347 "Remove from the value of HOOK the function FUNCTION.
1348 HOOK should be a symbol, and FUNCTION may be any valid function. If
1349 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1350 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1352 The optional third argument, LOCAL, if non-nil, says to modify
1353 the hook's buffer-local value rather than its default value."
1354 (or (boundp hook) (set hook nil))
1355 (or (default-boundp hook) (set-default hook nil))
1356 ;; Do nothing if LOCAL is t but this hook has no local binding.
1357 (unless (and local (not (local-variable-p hook)))
1358 ;; Detect the case where make-local-variable was used on a hook
1359 ;; and do what we used to do.
1360 (when (and (local-variable-p hook)
1361 (not (and (consp (symbol-value hook))
1362 (memq t (symbol-value hook)))))
1364 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1365 ;; Remove the function, for both the list and the non-list cases.
1366 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1367 (if (equal hook-value function) (setq hook-value nil))
1368 (setq hook-value (delete function (copy-sequence hook-value))))
1369 ;; If the function is on the global hook, we need to shadow it locally
1370 ;;(when (and local (member function (default-value hook))
1371 ;; (not (member (cons 'not function) hook-value)))
1372 ;; (push (cons 'not function) hook-value))
1373 ;; Set the actual variable
1375 (set-default hook hook-value)
1376 (if (equal hook-value '(t))
1377 (kill-local-variable hook)
1378 (set hook hook-value))))))
1380 (defmacro letrec (binders &rest body)
1381 "Bind variables according to BINDERS then eval BODY.
1382 The value of the last form in BODY is returned.
1383 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1384 SYMBOL to the value of VALUEFORM.
1385 All symbols are bound before the VALUEFORMs are evalled."
1386 ;; Only useful in lexical-binding mode.
1387 ;; As a special-form, we could implement it more efficiently (and cleanly,
1388 ;; making the vars actually unbound during evaluation of the binders).
1389 (declare (debug let) (indent 1))
1390 `(let ,(mapcar #'car binders)
1391 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1394 (defmacro with-wrapper-hook (hook args &rest body)
1395 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1396 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1397 around the preceding ones, like a set of nested `around' advices.
1399 Each hook function should accept an argument list consisting of a
1400 function FUN, followed by the additional arguments in ARGS.
1402 The first hook function in HOOK is passed a FUN that, if it is called
1403 with arguments ARGS, performs BODY (i.e., the default operation).
1404 The FUN passed to each successive hook function is defined based
1405 on the preceding hook functions; if called with arguments ARGS,
1406 it does what the `with-wrapper-hook' call would do if the
1407 preceding hook functions were the only ones present in HOOK.
1409 Each hook function may call its FUN argument as many times as it wishes,
1410 including never. In that case, such a hook function acts to replace
1411 the default definition altogether, and any preceding hook functions.
1412 Of course, a subsequent hook function may do the same thing.
1414 Each hook function definition is used to construct the FUN passed
1415 to the next hook function, if any. The last (or \"outermost\")
1416 FUN is then called once."
1417 (declare (indent 2) (debug (form sexp body)))
1418 ;; We need those two gensyms because CL's lexical scoping is not available
1419 ;; for function arguments :-(
1420 (let ((funs (make-symbol "funs"))
1421 (global (make-symbol "global"))
1422 (argssym (make-symbol "args"))
1423 (runrestofhook (make-symbol "runrestofhook")))
1424 ;; Since the hook is a wrapper, the loop has to be done via
1425 ;; recursion: a given hook function will call its parameter in order to
1426 ;; continue looping.
1427 `(letrec ((,runrestofhook
1428 (lambda (,funs ,global ,argssym)
1429 ;; `funs' holds the functions left on the hook and `global'
1430 ;; holds the functions left on the global part of the hook
1431 ;; (in case the hook is local).
1433 (if (eq t (car ,funs))
1434 (funcall ,runrestofhook
1435 (append ,global (cdr ,funs)) nil ,argssym)
1438 (lambda (,funs ,global &rest ,argssym)
1439 (funcall ,runrestofhook ,funs ,global ,argssym))
1440 (cdr ,funs) ,global)
1442 ;; Once there are no more functions on the hook, run
1443 ;; the original body.
1444 (apply (lambda ,args ,@body) ,argssym)))))
1445 (funcall ,runrestofhook ,hook
1446 ;; The global part of the hook, if any.
1448 `(if (local-variable-p ',hook)
1449 (default-value ',hook)))
1452 (defun add-to-list (list-var element &optional append compare-fn)
1453 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1454 The test for presence of ELEMENT is done with `equal',
1455 or with COMPARE-FN if that's non-nil.
1456 If ELEMENT is added, it is added at the beginning of the list,
1457 unless the optional argument APPEND is non-nil, in which case
1458 ELEMENT is added at the end.
1460 The return value is the new value of LIST-VAR.
1462 If you want to use `add-to-list' on a variable that is not defined
1463 until a certain package is loaded, you should put the call to `add-to-list'
1464 into a hook function that will be run only after loading the package.
1465 `eval-after-load' provides one way to do this. In some cases
1466 other hooks, such as major mode hooks, can do the job."
1469 (member element (symbol-value list-var)))
1470 ((eq compare-fn 'eq)
1471 (memq element (symbol-value list-var)))
1472 ((eq compare-fn 'eql)
1473 (memql element (symbol-value list-var)))
1475 (let ((lst (symbol-value list-var)))
1477 (not (funcall compare-fn element (car lst))))
1478 (setq lst (cdr lst)))
1480 (symbol-value list-var)
1483 (append (symbol-value list-var) (list element))
1484 (cons element (symbol-value list-var))))))
1487 (defun add-to-ordered-list (list-var element &optional order)
1488 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1489 The test for presence of ELEMENT is done with `eq'.
1491 The resulting list is reordered so that the elements are in the
1492 order given by each element's numeric list order. Elements
1493 without a numeric list order are placed at the end of the list.
1495 If the third optional argument ORDER is a number (integer or
1496 float), set the element's list order to the given value. If
1497 ORDER is nil or omitted, do not change the numeric order of
1498 ELEMENT. If ORDER has any other value, remove the numeric order
1499 of ELEMENT if it has one.
1501 The list order for each element is stored in LIST-VAR's
1502 `list-order' property.
1504 The return value is the new value of LIST-VAR."
1505 (let ((ordering (get list-var 'list-order)))
1507 (put list-var 'list-order
1508 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1510 (puthash element (and (numberp order) order) ordering))
1511 (unless (memq element (symbol-value list-var))
1512 (set list-var (cons element (symbol-value list-var))))
1513 (set list-var (sort (symbol-value list-var)
1515 (let ((oa (gethash a ordering))
1516 (ob (gethash b ordering)))
1521 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1522 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1523 Return the new history list.
1524 If MAXELT is non-nil, it specifies the maximum length of the history.
1525 Otherwise, the maximum history length is the value of the `history-length'
1526 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1528 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1529 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1530 if it is empty or a duplicate."
1532 (setq maxelt (or (get history-var 'history-length)
1534 (let ((history (symbol-value history-var))
1536 (when (and (listp history)
1538 (not (stringp newelt))
1539 (> (length newelt) 0))
1541 (not (equal (car history) newelt))))
1542 (if history-delete-duplicates
1543 (setq history (delete newelt history)))
1544 (setq history (cons newelt history))
1545 (when (integerp maxelt)
1548 (setq tail (nthcdr (1- maxelt) history))
1550 (setcdr tail nil)))))
1551 (set history-var history)))
1556 (defvar delay-mode-hooks nil
1557 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1558 (defvar delayed-mode-hooks nil
1559 "List of delayed mode hooks waiting to be run.")
1560 (make-variable-buffer-local 'delayed-mode-hooks)
1561 (put 'delay-mode-hooks 'permanent-local t)
1563 (defvar change-major-mode-after-body-hook nil
1564 "Normal hook run in major mode functions, before the mode hooks.")
1566 (defvar after-change-major-mode-hook nil
1567 "Normal hook run at the very end of major mode functions.")
1569 (defun run-mode-hooks (&rest hooks)
1570 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1571 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1572 just adds the HOOKS to the list `delayed-mode-hooks'.
1573 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1574 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1575 `after-change-major-mode-hook'. Major mode functions should use
1576 this instead of `run-hooks' when running their FOO-mode-hook."
1577 (if delay-mode-hooks
1579 (dolist (hook hooks)
1580 (push hook delayed-mode-hooks))
1581 ;; Normal case, just run the hook as before plus any delayed hooks.
1582 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1583 (setq delayed-mode-hooks nil)
1584 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1585 (run-hooks 'after-change-major-mode-hook)))
1587 (defmacro delay-mode-hooks (&rest body)
1588 "Execute BODY, but delay any `run-mode-hooks'.
1589 These hooks will be executed by the first following call to
1590 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1591 Only affects hooks run in the current buffer."
1592 (declare (debug t) (indent 0))
1594 (make-local-variable 'delay-mode-hooks)
1595 (let ((delay-mode-hooks t))
1598 ;; PUBLIC: find if the current mode derives from another.
1600 (defun derived-mode-p (&rest modes)
1601 "Non-nil if the current major mode is derived from one of MODES.
1602 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1603 (let ((parent major-mode))
1604 (while (and (not (memq parent modes))
1605 (setq parent (get parent 'derived-mode-parent))))
1610 ;; If a minor mode is not defined with define-minor-mode,
1611 ;; add it here explicitly.
1612 ;; isearch-mode is deliberately excluded, since you should
1613 ;; not call it yourself.
1614 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1615 overwrite-mode view-mode
1617 "List of all minor mode functions.")
1619 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1620 "Register a new minor mode.
1622 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1624 TOGGLE is a symbol which is the name of a buffer-local variable that
1625 is toggled on or off to say whether the minor mode is active or not.
1627 NAME specifies what will appear in the mode line when the minor mode
1628 is active. NAME should be either a string starting with a space, or a
1629 symbol whose value is such a string.
1631 Optional KEYMAP is the keymap for the minor mode that will be added
1632 to `minor-mode-map-alist'.
1634 Optional AFTER specifies that TOGGLE should be added after AFTER
1635 in `minor-mode-alist'.
1637 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1638 It defaults to (and should by convention be) TOGGLE.
1640 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1641 included in the mode-line minor mode menu.
1642 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1643 (unless (memq toggle minor-mode-list)
1644 (push toggle minor-mode-list))
1646 (unless toggle-fun (setq toggle-fun toggle))
1647 (unless (eq toggle-fun toggle)
1648 (put toggle :minor-mode-function toggle-fun))
1649 ;; Add the name to the minor-mode-alist.
1651 (let ((existing (assq toggle minor-mode-alist)))
1653 (setcdr existing (list name))
1654 (let ((tail minor-mode-alist) found)
1655 (while (and tail (not found))
1656 (if (eq after (caar tail))
1658 (setq tail (cdr tail))))
1660 (let ((rest (cdr found)))
1662 (nconc found (list (list toggle name)) rest))
1663 (push (list toggle name) minor-mode-alist))))))
1664 ;; Add the toggle to the minor-modes menu if requested.
1665 (when (get toggle :included)
1666 (define-key mode-line-mode-menu
1670 (or (get toggle :menu-tag)
1671 (if (stringp name) name (symbol-name toggle)))
1672 (let ((mode-name (if (symbolp name) (symbol-value name))))
1673 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1674 (concat " (" (match-string 0 mode-name) ")"))))
1676 :button (cons :toggle toggle))))
1678 ;; Add the map to the minor-mode-map-alist.
1680 (let ((existing (assq toggle minor-mode-map-alist)))
1682 (setcdr existing keymap)
1683 (let ((tail minor-mode-map-alist) found)
1684 (while (and tail (not found))
1685 (if (eq after (caar tail))
1687 (setq tail (cdr tail))))
1689 (let ((rest (cdr found)))
1691 (nconc found (list (cons toggle keymap)) rest))
1692 (push (cons toggle keymap) minor-mode-map-alist)))))))
1696 (defsubst autoloadp (object)
1697 "Non-nil if OBJECT is an autoload."
1698 (eq 'autoload (car-safe object)))
1700 ;; (defun autoload-type (object)
1701 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1702 ;; OBJECT should be an autoload object."
1703 ;; (when (autoloadp object)
1704 ;; (let ((type (nth 3 object)))
1705 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1706 ;; ((eq 'keymap t) 'macro)
1709 ;; (defalias 'autoload-file #'cadr
1710 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1711 ;; \n\(fn AUTOLOAD)")
1713 (defun symbol-file (symbol &optional type)
1714 "Return the name of the file that defined SYMBOL.
1715 The value is normally an absolute file name. It can also be nil,
1716 if the definition is not associated with any file. If SYMBOL
1717 specifies an autoloaded function, the value can be a relative
1718 file name without extension.
1720 If TYPE is nil, then any kind of definition is acceptable. If
1721 TYPE is `defun', `defvar', or `defface', that specifies function
1722 definition, variable definition, or face definition only."
1723 (if (and (or (null type) (eq type 'defun))
1724 (symbolp symbol) (fboundp symbol)
1725 (autoloadp (symbol-function symbol)))
1726 (nth 1 (symbol-function symbol))
1727 (let ((files load-history)
1731 (if (eq type 'defvar)
1732 ;; Variables are present just as their names.
1733 (member symbol (cdr (car files)))
1734 ;; Other types are represented as (TYPE . NAME).
1735 (member (cons type symbol) (cdr (car files))))
1736 ;; We accept all types, so look for variable def
1737 ;; and then for any other kind.
1738 (or (member symbol (cdr (car files)))
1739 (rassq symbol (cdr (car files)))))
1740 (setq file (car (car files)) files nil))
1741 (setq files (cdr files)))
1744 (defun locate-library (library &optional nosuffix path interactive-call)
1745 "Show the precise file name of Emacs library LIBRARY.
1746 LIBRARY should be a relative file name of the library, a string.
1747 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1748 nil (which is the default, see below).
1749 This command searches the directories in `load-path' like `\\[load-library]'
1750 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1751 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1752 to the specified name LIBRARY.
1754 If the optional third arg PATH is specified, that list of directories
1755 is used instead of `load-path'.
1757 When called from a program, the file name is normally returned as a
1758 string. When run interactively, the argument INTERACTIVE-CALL is t,
1759 and the file name is displayed in the echo area."
1760 (interactive (list (completing-read "Locate library: "
1762 'locate-file-completion-table
1763 load-path (get-load-suffixes)))
1766 (let ((file (locate-file library
1768 (append (unless nosuffix (get-load-suffixes))
1769 load-file-rep-suffixes))))
1770 (if interactive-call
1772 (message "Library is file %s" (abbreviate-file-name file))
1773 (message "No library %s in search path" library)))
1777 ;;;; Specifying things to do later.
1779 (defun load-history-regexp (file)
1780 "Form a regexp to find FILE in `load-history'.
1781 FILE, a string, is described in the function `eval-after-load'."
1782 (if (file-name-absolute-p file)
1783 (setq file (file-truename file)))
1784 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1786 (if (file-name-extension file)
1788 ;; Note: regexp-opt can't be used here, since we need to call
1789 ;; this before Emacs has been fully started. 2006-05-21
1790 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1791 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1794 (defun load-history-filename-element (file-regexp)
1795 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1796 Return nil if there isn't one."
1797 (let* ((loads load-history)
1798 (load-elt (and loads (car loads))))
1801 (or (null (car load-elt))
1802 (not (string-match file-regexp (car load-elt)))))
1803 (setq loads (cdr loads)
1804 load-elt (and loads (car loads)))))
1807 (put 'eval-after-load 'lisp-indent-function 1)
1808 (defun eval-after-load (file form)
1809 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
1810 If FILE is already loaded, evaluate FORM right now.
1812 If a matching file is loaded again, FORM will be evaluated again.
1814 If FILE is a string, it may be either an absolute or a relative file
1815 name, and may have an extension \(e.g. \".el\") or may lack one, and
1816 additionally may or may not have an extension denoting a compressed
1817 format \(e.g. \".gz\").
1819 When FILE is absolute, this first converts it to a true name by chasing
1820 symbolic links. Only a file of this name \(see next paragraph regarding
1821 extensions) will trigger the evaluation of FORM. When FILE is relative,
1822 a file whose absolute true name ends in FILE will trigger evaluation.
1824 When FILE lacks an extension, a file name with any extension will trigger
1825 evaluation. Otherwise, its extension must match FILE's. A further
1826 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1829 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1830 is evaluated at the end of any file that `provide's this feature.
1831 If the feature is provided when evaluating code not associated with a
1832 file, FORM is evaluated immediately after the provide statement.
1834 Usually FILE is just a library name like \"font-lock\" or a feature name
1837 This function makes or adds to an entry on `after-load-alist'."
1838 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1839 ;; evaluating it now).
1840 (let* ((regexp-or-feature
1842 (setq file (purecopy (load-history-regexp file)))
1844 (elt (assoc regexp-or-feature after-load-alist)))
1846 (setq elt (list regexp-or-feature))
1847 (push elt after-load-alist))
1848 ;; Make sure `form' is evalled in the current lexical/dynamic code.
1849 (setq form `(funcall ',(eval `(lambda () ,form) lexical-binding)))
1850 ;; Is there an already loaded file whose name (or `provide' name)
1852 (prog1 (if (if (stringp file)
1853 (load-history-filename-element regexp-or-feature)
1856 (when (symbolp regexp-or-feature)
1857 ;; For features, the after-load-alist elements get run when `provide' is
1858 ;; called rather than at the end of the file. So add an indirection to
1859 ;; make sure that `form' is really run "after-load" in case the provide
1860 ;; call happens early.
1863 (let ((fun (make-symbol "eval-after-load-helper")))
1864 (fset fun `(lambda (file)
1865 (if (not (equal file ',load-file-name))
1867 (remove-hook 'after-load-functions ',fun)
1869 (add-hook 'after-load-functions fun))
1870 ;; Not being provided from a file, run form right now.
1872 ;; Add FORM to the element unless it's already there.
1873 (unless (member form (cdr elt))
1874 (nconc elt (list form))))))
1876 (defvar after-load-functions nil
1877 "Special hook run after loading a file.
1878 Each function there is called with a single argument, the absolute
1879 name of the file just loaded.")
1881 (defun do-after-load-evaluation (abs-file)
1882 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1883 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1884 This function is called directly from the C code."
1885 ;; Run the relevant eval-after-load forms.
1886 (mapc #'(lambda (a-l-element)
1887 (when (and (stringp (car a-l-element))
1888 (string-match-p (car a-l-element) abs-file))
1889 ;; discard the file name regexp
1890 (mapc #'eval (cdr a-l-element))))
1892 ;; Complain when the user uses obsolete files.
1893 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1894 (run-with-timer 0 nil
1896 (message "Package %s is obsolete!"
1898 (string-match "\\.elc?\\>" file))))
1899 (file-name-nondirectory abs-file)))
1900 ;; Finally, run any other hook.
1901 (run-hook-with-args 'after-load-functions abs-file))
1903 (defun eval-next-after-load (file)
1904 "Read the following input sexp, and run it whenever FILE is loaded.
1905 This makes or adds to an entry on `after-load-alist'.
1906 FILE should be the name of a library, with no directory name."
1907 (declare (obsolete eval-after-load "23.2"))
1908 (eval-after-load file (read)))
1910 (defun display-delayed-warnings ()
1911 "Display delayed warnings from `delayed-warnings-list'.
1912 Used from `delayed-warnings-hook' (which see)."
1913 (dolist (warning (nreverse delayed-warnings-list))
1914 (apply 'display-warning warning))
1915 (setq delayed-warnings-list nil))
1917 (defun collapse-delayed-warnings ()
1918 "Remove duplicates from `delayed-warnings-list'.
1919 Collapse identical adjacent warnings into one (plus count).
1920 Used from `delayed-warnings-hook' (which see)."
1923 (while delayed-warnings-list
1924 (setq warning (pop delayed-warnings-list))
1925 (if (equal warning (car delayed-warnings-list))
1926 (setq count (1+ count))
1928 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
1931 (push warning collapsed)))
1932 (setq delayed-warnings-list (nreverse collapsed))))
1934 ;; At present this is only used for Emacs internals.
1935 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
1936 (defvar delayed-warnings-hook '(collapse-delayed-warnings
1937 display-delayed-warnings)
1938 "Normal hook run to process and display delayed warnings.
1939 By default, this hook contains functions to consolidate the
1940 warnings listed in `delayed-warnings-list', display them, and set
1941 `delayed-warnings-list' back to nil.")
1946 (defun process-lines (program &rest args)
1947 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1948 Signal an error if the program returns with a non-zero exit status."
1950 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1951 (unless (eq status 0)
1952 (error "%s exited with status %s" program status))
1953 (goto-char (point-min))
1956 (setq lines (cons (buffer-substring-no-properties
1957 (line-beginning-position)
1958 (line-end-position))
1961 (nreverse lines)))))
1963 (defun process-live-p (process)
1964 "Returns non-nil if PROCESS is alive.
1965 A process is considered alive if its status is `run', `open',
1966 `listen', `connect' or `stop'."
1967 (memq (process-status process)
1968 '(run open listen connect stop)))
1973 'process-kill-without-query
1974 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1976 (defun process-kill-without-query (process &optional _flag)
1977 "Say no query needed if PROCESS is running when Emacs is exited.
1978 Optional second argument if non-nil says to require a query.
1979 Value is t if a query was formerly required."
1980 (let ((old (process-query-on-exit-flag process)))
1981 (set-process-query-on-exit-flag process nil)
1984 (defun process-kill-buffer-query-function ()
1985 "Ask before killing a buffer that has a running process."
1986 (let ((process (get-buffer-process (current-buffer))))
1988 (not (memq (process-status process) '(run stop open listen)))
1989 (not (process-query-on-exit-flag process))
1991 (format "Buffer %S has a running process; kill it? "
1992 (buffer-name (current-buffer)))))))
1994 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1996 ;; process plist management
1998 (defun process-get (process propname)
1999 "Return the value of PROCESS' PROPNAME property.
2000 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
2001 (plist-get (process-plist process) propname))
2003 (defun process-put (process propname value)
2004 "Change PROCESS' PROPNAME property to VALUE.
2005 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2006 (set-process-plist process
2007 (plist-put (process-plist process) propname value)))
2010 ;;;; Input and display facilities.
2012 (defvar read-quoted-char-radix 8
2013 "Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2014 Legitimate radix values are 8, 10 and 16.")
2016 (custom-declare-variable-early
2017 'read-quoted-char-radix 8
2018 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2019 Legitimate radix values are 8, 10 and 16."
2020 :type '(choice (const 8) (const 10) (const 16))
2021 :group 'editing-basics)
2023 (defconst read-key-empty-map (make-sparse-keymap))
2025 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2027 (defun read-key (&optional prompt)
2028 "Read a key from the keyboard.
2029 Contrary to `read-event' this will not return a raw event but instead will
2030 obey the input decoding and translations usually done by `read-key-sequence'.
2031 So escape sequences and keyboard encoding are taken into account.
2032 When there's an ambiguity because the key looks like the prefix of
2033 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2034 ;; This overriding-terminal-local-map binding also happens to
2035 ;; disable quail's input methods, so although read-key-sequence
2036 ;; always inherits the input method, in practice read-key does not
2037 ;; inherit the input method (at least not if it's based on quail).
2038 (let ((overriding-terminal-local-map read-key-empty-map)
2039 (overriding-local-map nil)
2041 (old-global-map (current-global-map))
2042 (timer (run-with-idle-timer
2043 ;; Wait long enough that Emacs has the time to receive and
2044 ;; process all the raw events associated with the single-key.
2045 ;; But don't wait too long, or the user may find the delay
2046 ;; annoying (or keep hitting more keys which may then get
2047 ;; lost or misinterpreted).
2048 ;; This is only relevant for keys which Emacs perceives as
2049 ;; "prefixes", such as C-x (because of the C-x 8 map in
2050 ;; key-translate-table and the C-x @ map in function-key-map)
2051 ;; or ESC (because of terminal escape sequences in
2052 ;; input-decode-map).
2055 (let ((keys (this-command-keys-vector)))
2056 (unless (zerop (length keys))
2057 ;; `keys' is non-empty, so the user has hit at least
2058 ;; one key; there's no point waiting any longer, even
2059 ;; though read-key-sequence thinks we should wait
2060 ;; for more input to decide how to interpret the
2062 (throw 'read-key keys)))))))
2066 (let ((map (make-sparse-keymap)))
2067 ;; Don't hide the menu-bar and tool-bar entries.
2068 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2069 (define-key map [tool-bar]
2070 ;; This hack avoids evaluating the :filter (Bug#9922).
2071 (or (cdr (assq 'tool-bar global-map))
2072 (lookup-key global-map [tool-bar])))
2074 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
2075 (cancel-timer timer)
2076 (use-global-map old-global-map))))
2078 (defun read-quoted-char (&optional prompt)
2079 "Like `read-char', but do not allow quitting.
2080 Also, if the first character read is an octal digit,
2081 we read any number of octal digits and return the
2082 specified character code. Any nondigit terminates the sequence.
2083 If the terminator is RET, it is discarded;
2084 any other terminator is used itself as input.
2086 The optional argument PROMPT specifies a string to use to prompt the user.
2087 The variable `read-quoted-char-radix' controls which radix to use
2089 (let ((message-log-max nil) done (first t) (code 0) char translated)
2091 (let ((inhibit-quit first)
2092 ;; Don't let C-h get the help message--only help function keys.
2095 "Type the special character you want to use,
2096 or the octal character code.
2097 RET terminates the character code and is discarded;
2098 any other non-digit terminates the character code and is then used as input."))
2099 (setq char (read-event (and prompt (format "%s-" prompt)) t))
2100 (if inhibit-quit (setq quit-flag nil)))
2101 ;; Translate TAB key into control-I ASCII character, and so on.
2102 ;; Note: `read-char' does it using the `ascii-character' property.
2103 ;; We should try and use read-key instead.
2104 (let ((translation (lookup-key local-function-key-map (vector char))))
2105 (setq translated (if (arrayp translation)
2106 (aref translation 0)
2108 (if (integerp translated)
2109 (setq translated (char-resolve-modifiers translated)))
2110 (cond ((null translated))
2111 ((not (integerp translated))
2112 (setq unread-command-events (list char)
2114 ((/= (logand translated ?\M-\^@) 0)
2115 ;; Turn a meta-character into a character with the 0200 bit set.
2116 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
2118 ((and (<= ?0 translated)
2119 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
2120 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
2121 (and prompt (setq prompt (message "%s %c" prompt translated))))
2122 ((and (<= ?a (downcase translated))
2123 (< (downcase translated)
2124 (+ ?a -10 (min 36 read-quoted-char-radix))))
2125 (setq code (+ (* code read-quoted-char-radix)
2126 (+ 10 (- (downcase translated) ?a))))
2127 (and prompt (setq prompt (message "%s %c" prompt translated))))
2128 ((and (not first) (eq translated ?\C-m))
2131 (setq unread-command-events (list char)
2133 (t (setq code translated
2138 (defvar read-passwd-map
2139 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2140 ;; minibuffer-local-map along the way!
2141 (let ((map (make-sparse-keymap)))
2142 (set-keymap-parent map minibuffer-local-map)
2143 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2145 "Keymap used while reading passwords.")
2147 (defun read-passwd (prompt &optional confirm default)
2148 "Read a password, prompting with PROMPT, and return it.
2149 If optional CONFIRM is non-nil, read the password twice to make sure.
2150 Optional DEFAULT is a default password to use instead of empty input.
2152 This function echoes `.' for each character that the user types.
2154 Once the caller uses the password, it can erase the password
2155 by doing (clear-string STRING)."
2158 (while (not success)
2159 (let ((first (read-passwd prompt nil default))
2160 (second (read-passwd "Confirm password: " nil default)))
2161 (if (equal first second)
2163 (and (arrayp second) (clear-string second))
2164 (setq success first))
2165 (and (arrayp first) (clear-string first))
2166 (and (arrayp second) (clear-string second))
2167 (message "Password not repeated accurately; please start over")
2170 (let ((hide-chars-fun
2171 (lambda (beg end _len)
2172 (clear-this-command-keys)
2173 (setq beg (min end (max (minibuffer-prompt-end)
2175 (dotimes (i (- end beg))
2176 (put-text-property (+ i beg) (+ 1 i beg)
2177 'display (string ?.)))))
2179 (minibuffer-with-setup-hook
2181 (setq minibuf (current-buffer))
2182 ;; Turn off electricity.
2183 (setq-local post-self-insert-hook nil)
2184 (setq-local buffer-undo-list t)
2185 (setq-local select-active-regions nil)
2186 (use-local-map read-passwd-map)
2187 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2189 (let ((enable-recursive-minibuffers t))
2190 (read-string prompt nil t default)) ; t = "no history"
2191 (when (buffer-live-p minibuf)
2192 (with-current-buffer minibuf
2193 ;; Not sure why but it seems that there might be cases where the
2194 ;; minibuffer is not always properly reset later on, so undo
2195 ;; whatever we've done here (bug#11392).
2196 (remove-hook 'after-change-functions hide-chars-fun 'local)
2197 (kill-local-variable 'post-self-insert-hook)
2198 ;; And of course, don't keep the sensitive data around.
2199 (erase-buffer))))))))
2201 ;; This should be used by `call-interactively' for `n' specs.
2202 (defun read-number (prompt &optional default)
2203 "Read a numeric value in the minibuffer, prompting with PROMPT.
2204 DEFAULT specifies a default value to return if the user just types RET.
2205 The value of DEFAULT is inserted into PROMPT."
2207 (default1 (if (consp default) (car default) default)))
2210 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2211 (replace-match (format " (default %s)" default1) t t prompt 1)
2212 (replace-regexp-in-string "[ \t]*\\'"
2213 (format " (default %s) " default1)
2217 (let ((str (read-from-minibuffer
2218 prompt nil nil nil nil
2221 (mapcar 'number-to-string (delq nil default))
2222 (number-to-string default))))))
2225 ((zerop (length str)) default1)
2226 ((stringp str) (string-to-number str))))
2229 (message "Please enter a number.")
2234 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2235 "Read and return one of CHARS, prompting for PROMPT.
2236 Any input that is not one of CHARS is ignored.
2238 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2239 keyboard-quit events while waiting for a valid input."
2240 (unless (consp chars)
2241 (error "Called `read-char-choice' without valid char choices"))
2242 (let (char done show-help (helpbuf " *Char Help*"))
2243 (let ((cursor-in-echo-area t)
2244 (executing-kbd-macro executing-kbd-macro)
2246 (save-window-excursion ; in case we call help-form-show
2248 (unless (get-text-property 0 'face prompt)
2249 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2250 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2252 (and show-help (buffer-live-p (get-buffer helpbuf))
2253 (kill-buffer helpbuf))
2255 ((not (numberp char)))
2256 ;; If caller has set help-form, that's enough.
2257 ;; They don't explicitly have to add help-char to chars.
2264 ((and executing-kbd-macro (= char -1))
2265 ;; read-event returns -1 if we are in a kbd macro and
2266 ;; there are no more events in the macro. Attempt to
2267 ;; get an event interactively.
2268 (setq executing-kbd-macro nil))
2269 ((not inhibit-keyboard-quit)
2271 ((and (null esc-flag) (eq char ?\e))
2273 ((memq char '(?\C-g ?\e))
2274 (keyboard-quit))))))))
2275 ;; Display the question with the answer. But without cursor-in-echo-area.
2276 (message "%s%s" prompt (char-to-string char))
2279 (defun sit-for (seconds &optional nodisp obsolete)
2280 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2281 SECONDS may be a floating-point value.
2282 \(On operating systems that do not support waiting for fractions of a
2283 second, floating-point values are rounded down to the nearest integer.)
2285 If optional arg NODISP is t, don't redisplay, just wait for input.
2286 Redisplay does not happen if input is available before it starts.
2288 Value is t if waited the full time with no input arriving, and nil otherwise.
2290 An obsolete, but still supported form is
2291 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2292 where the optional arg MILLISECONDS specifies an additional wait period,
2293 in milliseconds; this was useful when Emacs was built without
2294 floating point support."
2295 (if (numberp nodisp)
2296 (setq seconds (+ seconds (* 1e-3 nodisp))
2298 (if obsolete (setq nodisp obsolete)))
2306 (or nodisp (redisplay)))
2308 (or nodisp (redisplay))
2309 (let ((read (read-event nil nil seconds)))
2312 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2313 ;; unread-command-events as (t . EVENT) so it will be added to
2314 ;; this-command-keys by read-key-sequence.
2315 (if (eq overriding-terminal-local-map universal-argument-map)
2316 (setq read (cons t read)))
2317 (push read unread-command-events)
2319 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2321 (defun y-or-n-p (prompt)
2322 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2323 PROMPT is the string to display to ask the question. It should
2324 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2326 No confirmation of the answer is requested; a single character is
2327 enough. SPC also means yes, and DEL means no.
2329 To be precise, this function translates user input into responses
2330 by consulting the bindings in `query-replace-map'; see the
2331 documentation of that variable for more information. In this
2332 case, the useful bindings are `act', `skip', `recenter',
2333 `scroll-up', `scroll-down', and `quit'.
2334 An `act' response means yes, and a `skip' response means no.
2335 A `quit' response means to invoke `keyboard-quit'.
2336 If the user enters `recenter', `scroll-up', or `scroll-down'
2337 responses, perform the requested window recentering or scrolling
2340 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2341 is nil and `use-dialog-box' is non-nil."
2342 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2343 ;; where all the keys were unbound (i.e. it somehow got triggered
2344 ;; within read-key, apparently). I had to kill it.
2345 (let ((answer 'recenter))
2348 (setq prompt (concat prompt
2349 (if (eq ?\s (aref prompt (1- (length prompt))))
2352 (let ((temp-prompt prompt))
2353 (while (not (memq answer '(act skip)))
2354 (let ((str (read-string temp-prompt)))
2355 (cond ((member str '("y" "Y")) (setq answer 'act))
2356 ((member str '("n" "N")) (setq answer 'skip))
2357 (t (setq temp-prompt (concat "Please answer y or n. "
2359 ((and (display-popup-menus-p)
2360 (listp last-nonmenu-event)
2363 (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2365 (setq prompt (concat prompt
2366 (if (eq ?\s (aref prompt (1- (length prompt))))
2370 (let* ((scroll-actions '(recenter scroll-up scroll-down
2371 scroll-other-window scroll-other-window-down))
2373 (let ((cursor-in-echo-area t))
2374 (when minibuffer-auto-raise
2375 (raise-frame (window-frame (minibuffer-window))))
2376 (read-key (propertize (if (memq answer scroll-actions)
2378 (concat "Please answer y or n. "
2380 'face 'minibuffer-prompt)))))
2381 (setq answer (lookup-key query-replace-map (vector key) t))
2383 ((memq answer '(skip act)) nil)
2384 ((eq answer 'recenter)
2386 ((eq answer 'scroll-up)
2387 (ignore-errors (scroll-up-command)) t)
2388 ((eq answer 'scroll-down)
2389 (ignore-errors (scroll-down-command)) t)
2390 ((eq answer 'scroll-other-window)
2391 (ignore-errors (scroll-other-window)) t)
2392 ((eq answer 'scroll-other-window-down)
2393 (ignore-errors (scroll-other-window-down)) t)
2394 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2395 (signal 'quit nil) t)
2399 (let ((ret (eq answer 'act)))
2400 (unless noninteractive
2401 ;; FIXME this prints one too many spaces, since prompt
2402 ;; already ends in a space. Eg "... (y or n) y".
2403 (message "%s %s" prompt (if ret "y" "n")))
2407 ;;; Atomic change groups.
2409 (defmacro atomic-change-group (&rest body)
2410 "Perform BODY as an atomic change group.
2411 This means that if BODY exits abnormally,
2412 all of its changes to the current buffer are undone.
2413 This works regardless of whether undo is enabled in the buffer.
2415 This mechanism is transparent to ordinary use of undo;
2416 if undo is enabled in the buffer and BODY succeeds, the
2417 user can undo the change normally."
2418 (declare (indent 0) (debug t))
2419 (let ((handle (make-symbol "--change-group-handle--"))
2420 (success (make-symbol "--change-group-success--")))
2421 `(let ((,handle (prepare-change-group))
2422 ;; Don't truncate any undo data in the middle of this.
2423 (undo-outer-limit nil)
2424 (undo-limit most-positive-fixnum)
2425 (undo-strong-limit most-positive-fixnum)
2429 ;; This is inside the unwind-protect because
2430 ;; it enables undo if that was disabled; we need
2431 ;; to make sure that it gets disabled again.
2432 (activate-change-group ,handle)
2435 ;; Either of these functions will disable undo
2436 ;; if it was disabled before.
2438 (accept-change-group ,handle)
2439 (cancel-change-group ,handle))))))
2441 (defun prepare-change-group (&optional buffer)
2442 "Return a handle for the current buffer's state, for a change group.
2443 If you specify BUFFER, make a handle for BUFFER's state instead.
2445 Pass the handle to `activate-change-group' afterward to initiate
2446 the actual changes of the change group.
2448 To finish the change group, call either `accept-change-group' or
2449 `cancel-change-group' passing the same handle as argument. Call
2450 `accept-change-group' to accept the changes in the group as final;
2451 call `cancel-change-group' to undo them all. You should use
2452 `unwind-protect' to make sure the group is always finished. The call
2453 to `activate-change-group' should be inside the `unwind-protect'.
2454 Once you finish the group, don't use the handle again--don't try to
2455 finish the same group twice. For a simple example of correct use, see
2456 the source code of `atomic-change-group'.
2458 The handle records only the specified buffer. To make a multibuffer
2459 change group, call this function once for each buffer you want to
2460 cover, then use `nconc' to combine the returned values, like this:
2462 (nconc (prepare-change-group buffer-1)
2463 (prepare-change-group buffer-2))
2465 You can then activate that multibuffer change group with a single
2466 call to `activate-change-group' and finish it with a single call
2467 to `accept-change-group' or `cancel-change-group'."
2470 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2471 (list (cons (current-buffer) buffer-undo-list))))
2473 (defun activate-change-group (handle)
2474 "Activate a change group made with `prepare-change-group' (which see)."
2475 (dolist (elt handle)
2476 (with-current-buffer (car elt)
2477 (if (eq buffer-undo-list t)
2478 (setq buffer-undo-list nil)))))
2480 (defun accept-change-group (handle)
2481 "Finish a change group made with `prepare-change-group' (which see).
2482 This finishes the change group by accepting its changes as final."
2483 (dolist (elt handle)
2484 (with-current-buffer (car elt)
2485 (if (eq (cdr elt) t)
2486 (setq buffer-undo-list t)))))
2488 (defun cancel-change-group (handle)
2489 "Finish a change group made with `prepare-change-group' (which see).
2490 This finishes the change group by reverting all of its changes."
2491 (dolist (elt handle)
2492 (with-current-buffer (car elt)
2493 (setq elt (cdr elt))
2495 ;; Widen buffer temporarily so if the buffer was narrowed within
2496 ;; the body of `atomic-change-group' all changes can be undone.
2499 (if (consp elt) (car elt)))
2501 (if (consp elt) (cdr elt))))
2502 ;; Temporarily truncate the undo log at ELT.
2504 (setcar elt nil) (setcdr elt nil))
2505 (unless (eq last-command 'undo) (undo-start))
2506 ;; Make sure there's no confusion.
2507 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2508 (error "Undoing to some unrelated state"))
2511 (while (listp pending-undo-list) (undo-more 1)))
2512 ;; Reset the modified cons cell ELT to its original content.
2514 (setcar elt old-car)
2515 (setcdr elt old-cdr))
2516 ;; Revert the undo info to what it was when we grabbed the state.
2517 (setq buffer-undo-list elt))))))
2519 ;;;; Display-related functions.
2521 ;; For compatibility.
2522 (define-obsolete-function-alias 'redraw-modeline
2523 'force-mode-line-update "24.3")
2525 (defun force-mode-line-update (&optional all)
2526 "Force redisplay of the current buffer's mode line and header line.
2527 With optional non-nil ALL, force redisplay of all mode lines and
2528 header lines. This function also forces recomputation of the
2529 menu bar menus and the frame title."
2530 (if all (with-current-buffer (other-buffer)))
2531 (set-buffer-modified-p (buffer-modified-p)))
2533 (defun momentary-string-display (string pos &optional exit-char message)
2534 "Momentarily display STRING in the buffer at POS.
2535 Display remains until next event is input.
2536 If POS is a marker, only its position is used; its buffer is ignored.
2537 Optional third arg EXIT-CHAR can be a character, event or event
2538 description list. EXIT-CHAR defaults to SPC. If the input is
2539 EXIT-CHAR it is swallowed; otherwise it is then available as
2540 input (as a command if nothing else).
2541 Display MESSAGE (optional fourth arg) in the echo area.
2542 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2543 (or exit-char (setq exit-char ?\s))
2544 (let ((ol (make-overlay pos pos))
2545 (str (copy-sequence string)))
2549 (overlay-put ol 'after-string str)
2551 ;; To avoid trouble with out-of-bounds position
2553 ;; If the string end is off screen, recenter now.
2554 (if (<= (window-end nil t) pos)
2555 (recenter (/ (window-height) 2))))
2556 (message (or message "Type %s to continue editing.")
2557 (single-key-description exit-char))
2558 (let ((event (read-event)))
2559 ;; `exit-char' can be an event, or an event description list.
2560 (or (eq event exit-char)
2561 (eq event (event-convert-list exit-char))
2562 (setq unread-command-events (list event)))))
2563 (delete-overlay ol))))
2566 ;;;; Overlay operations
2568 (defun copy-overlay (o)
2569 "Return a copy of overlay O."
2570 (let ((o1 (if (overlay-buffer o)
2571 (make-overlay (overlay-start o) (overlay-end o)
2572 ;; FIXME: there's no easy way to find the
2573 ;; insertion-type of the two markers.
2575 (let ((o1 (make-overlay (point-min) (point-min))))
2578 (props (overlay-properties o)))
2580 (overlay-put o1 (pop props) (pop props)))
2583 (defun remove-overlays (&optional beg end name val)
2584 "Clear BEG and END of overlays whose property NAME has value VAL.
2585 Overlays might be moved and/or split.
2586 BEG and END default respectively to the beginning and end of buffer."
2587 ;; This speeds up the loops over overlays.
2588 (unless beg (setq beg (point-min)))
2589 (unless end (setq end (point-max)))
2590 (overlay-recenter end)
2592 (setq beg (prog1 end (setq end beg))))
2594 (dolist (o (overlays-in beg end))
2595 (when (eq (overlay-get o name) val)
2596 ;; Either push this overlay outside beg...end
2597 ;; or split it to exclude beg...end
2598 ;; or delete it entirely (if it is contained in beg...end).
2599 (if (< (overlay-start o) beg)
2600 (if (> (overlay-end o) end)
2602 (move-overlay (copy-overlay o)
2603 (overlay-start o) beg)
2604 (move-overlay o end (overlay-end o)))
2605 (move-overlay o (overlay-start o) beg))
2606 (if (> (overlay-end o) end)
2607 (move-overlay o end (overlay-end o))
2608 (delete-overlay o)))))))
2612 (defvar suspend-hook nil
2613 "Normal hook run by `suspend-emacs', before suspending.")
2615 (defvar suspend-resume-hook nil
2616 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2618 (defvar temp-buffer-show-hook nil
2619 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2620 When the hook runs, the temporary buffer is current, and the window it
2621 was displayed in is selected.")
2623 (defvar temp-buffer-setup-hook nil
2624 "Normal hook run by `with-output-to-temp-buffer' at the start.
2625 When the hook runs, the temporary buffer is current.
2626 This hook is normally set up with a function to put the buffer in Help
2629 ;; The `assert' macro from the cl package signals
2630 ;; `cl-assertion-failed' at runtime so always define it.
2631 (put 'cl-assertion-failed 'error-conditions '(error))
2632 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2634 (defconst user-emacs-directory
2635 (if (eq system-type 'ms-dos)
2636 ;; MS-DOS cannot have initial dot.
2639 "Directory beneath which additional per-user Emacs-specific files are placed.
2640 Various programs in Emacs store information in this directory.
2641 Note that this should end with a directory separator.
2642 See also `locate-user-emacs-file'.")
2644 (defun locate-user-emacs-file (new-name &optional old-name)
2645 "Return an absolute per-user Emacs-specific file name.
2646 If NEW-NAME exists in `user-emacs-directory', return it.
2647 Else If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2648 Else return NEW-NAME in `user-emacs-directory', creating the
2649 directory if it does not exist."
2650 (convert-standard-filename
2651 (let* ((home (concat "~" (or init-file-user "")))
2652 (at-home (and old-name (expand-file-name old-name home)))
2653 (bestname (abbreviate-file-name
2654 (expand-file-name new-name user-emacs-directory))))
2655 (if (and at-home (not (file-readable-p bestname))
2656 (file-readable-p at-home))
2658 ;; Make sure `user-emacs-directory' exists,
2659 ;; unless we're in batch mode or dumping Emacs
2662 (file-accessible-directory-p
2663 (directory-file-name user-emacs-directory))
2664 (let ((umask (default-file-modes)))
2667 (set-default-file-modes ?\700)
2668 (make-directory user-emacs-directory))
2669 (set-default-file-modes umask))))
2672 ;;;; Misc. useful functions.
2674 (defsubst buffer-narrowed-p ()
2675 "Return non-nil if the current buffer is narrowed."
2676 (/= (- (point-max) (point-min)) (buffer-size)))
2678 (defun find-tag-default ()
2679 "Determine default tag to search for, based on text at point.
2680 If there is no plausible default, return nil."
2681 (let (from to bound)
2683 ;; Look at text around `point'.
2685 (skip-syntax-backward "w_") (setq from (point)))
2687 (skip-syntax-forward "w_") (setq to (point)))
2689 ;; Look between `line-beginning-position' and `point'.
2691 (and (setq bound (line-beginning-position))
2692 (skip-syntax-backward "^w_" bound)
2693 (> (setq to (point)) bound)
2694 (skip-syntax-backward "w_")
2695 (setq from (point))))
2696 ;; Look between `point' and `line-end-position'.
2698 (and (setq bound (line-end-position))
2699 (skip-syntax-forward "^w_" bound)
2700 (< (setq from (point)) bound)
2701 (skip-syntax-forward "w_")
2702 (setq to (point)))))
2703 (buffer-substring-no-properties from to))))
2705 (defun find-tag-default-as-regexp ()
2706 "Return regexp that matches the default tag at point.
2707 If there is no tag at point, return nil.
2709 When in a major mode that does not provide its own
2710 `find-tag-default-function', return a regexp that matches the
2711 symbol at point exactly."
2712 (let* ((tagf (or find-tag-default-function
2713 (get major-mode 'find-tag-default-function)
2715 (tag (funcall tagf)))
2717 ((eq tagf 'find-tag-default)
2718 (format "\\_<%s\\_>" (regexp-quote tag)))
2719 (t (regexp-quote tag)))))
2721 (defun play-sound (sound)
2722 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2723 The following keywords are recognized:
2725 :file FILE - read sound data from FILE. If FILE isn't an
2726 absolute file name, it is searched in `data-directory'.
2728 :data DATA - read sound data from string DATA.
2730 Exactly one of :file or :data must be present.
2732 :volume VOL - set volume to VOL. VOL must an integer in the
2733 range 0..100 or a float in the range 0..1.0. If not specified,
2734 don't change the volume setting of the sound device.
2736 :device DEVICE - play sound on DEVICE. If not specified,
2737 a system-dependent default device name is used.
2739 Note: :data and :device are currently not supported on Windows."
2740 (if (fboundp 'play-sound-internal)
2741 (play-sound-internal sound)
2742 (error "This Emacs binary lacks sound support")))
2744 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2746 (defun shell-quote-argument (argument)
2747 "Quote ARGUMENT for passing as argument to an inferior shell."
2749 ((eq system-type 'ms-dos)
2750 ;; Quote using double quotes, but escape any existing quotes in
2751 ;; the argument with backslashes.
2755 (if (or (null (string-match "[^\"]" argument))
2756 (< (match-end 0) (length argument)))
2757 (while (string-match "[\"]" argument start)
2758 (setq end (match-beginning 0)
2759 result (concat result (substring argument start end)
2760 "\\" (substring argument end (1+ end)))
2762 (concat "\"" result (substring argument start) "\"")))
2764 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2766 ;; First, quote argument so that CommandLineToArgvW will
2767 ;; understand it. See
2768 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2769 ;; After we perform that level of quoting, escape shell
2770 ;; metacharacters so that cmd won't mangle our argument. If the
2771 ;; argument contains no double quote characters, we can just
2772 ;; surround it with double quotes. Otherwise, we need to prefix
2773 ;; each shell metacharacter with a caret.
2776 ;; escape backslashes at end of string
2777 (replace-regexp-in-string
2780 ;; escape backslashes and quotes in string body
2781 (replace-regexp-in-string
2786 (if (string-match "[%!\"]" argument)
2789 (replace-regexp-in-string
2790 "\\([%!()\"<>&|^]\\)"
2794 (concat "\"" argument "\"")))
2797 (if (equal argument "")
2799 ;; Quote everything except POSIX filename characters.
2800 ;; This should be safe enough even for really weird shells.
2801 (replace-regexp-in-string
2803 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2806 (defun string-or-null-p (object)
2807 "Return t if OBJECT is a string or nil.
2808 Otherwise, return nil."
2809 (or (stringp object) (null object)))
2811 (defun booleanp (object)
2812 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2813 Otherwise, return nil."
2814 (and (memq object '(nil t)) t))
2816 (defun special-form-p (object)
2817 "Non-nil if and only if OBJECT is a special form."
2818 (if (and (symbolp object) (fboundp object))
2819 (setq object (indirect-function object t)))
2820 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2822 (defun field-at-pos (pos)
2823 "Return the field at position POS, taking stickiness etc into account."
2824 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2825 (if (eq raw-field 'boundary)
2826 (get-char-property (1- (field-end pos)) 'field)
2829 (defun sha1 (object &optional start end binary)
2830 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2831 OBJECT is either a string or a buffer. Optional arguments START and
2832 END are character positions specifying which portion of OBJECT for
2833 computing the hash. If BINARY is non-nil, return a string in binary
2835 (secure-hash 'sha1 object start end binary))
2837 (defun function-get (f prop &optional autoload)
2838 "Return the value of property PROP of function F.
2839 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2840 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2841 if it's an autoloaded macro."
2843 (while (and (symbolp f)
2844 (null (setq val (get f prop)))
2846 (let ((fundef (symbol-function f)))
2847 (if (and autoload (autoloadp fundef)
2849 (autoload-do-load fundef f
2850 (if (eq autoload 'macro)
2852 nil ;Re-try `get' on the same `f'.
2856 ;;;; Support for yanking and text properties.
2858 (defvar yank-handled-properties)
2859 (defvar yank-excluded-properties)
2861 (defun remove-yank-excluded-properties (start end)
2862 "Process text properties between START and END, inserted for a `yank'.
2863 Perform the handling specified by `yank-handled-properties', then
2864 remove properties specified by `yank-excluded-properties'."
2865 (let ((inhibit-read-only t))
2866 (dolist (handler yank-handled-properties)
2867 (let ((prop (car handler))
2870 (while (< run-start end)
2871 (let ((value (get-text-property run-start prop))
2872 (run-end (next-single-property-change
2873 run-start prop nil end)))
2874 (funcall fun value run-start run-end)
2875 (setq run-start run-end)))))
2876 (if (eq yank-excluded-properties t)
2877 (set-text-properties start end nil)
2878 (remove-list-of-text-properties start end yank-excluded-properties))))
2880 (defvar yank-undo-function)
2882 (defun insert-for-yank (string)
2883 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2885 See `insert-for-yank-1' for more details."
2887 (while (setq to (next-single-property-change 0 'yank-handler string))
2888 (insert-for-yank-1 (substring string 0 to))
2889 (setq string (substring string to))))
2890 (insert-for-yank-1 string))
2892 (defun insert-for-yank-1 (string)
2893 "Insert STRING at point for the `yank' command.
2894 This function is like `insert', except it honors the variables
2895 `yank-handled-properties' and `yank-excluded-properties', and the
2896 `yank-handler' text property.
2898 Properties listed in `yank-handled-properties' are processed,
2899 then those listed in `yank-excluded-properties' are discarded.
2901 If STRING has a non-nil `yank-handler' property on its first
2902 character, the normal insert behavior is altered. The value of
2903 the `yank-handler' property must be a list of one to four
2904 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2905 FUNCTION, if non-nil, should be a function of one argument, an
2906 object to insert; it is called instead of `insert'.
2907 PARAM, if present and non-nil, replaces STRING as the argument to
2908 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2909 may be a list of strings to insert as a rectangle.
2910 If NOEXCLUDE is present and non-nil, the normal removal of
2911 `yank-excluded-properties' is not performed; instead FUNCTION is
2912 responsible for the removal. This may be necessary if FUNCTION
2913 adjusts point before or after inserting the object.
2914 UNDO, if present and non-nil, should be a function to be called
2915 by `yank-pop' to undo the insertion of the current object. It is
2916 given two arguments, the start and end of the region. FUNCTION
2917 may set `yank-undo-function' to override UNDO."
2918 (let* ((handler (and (stringp string)
2919 (get-text-property 0 'yank-handler string)))
2920 (param (or (nth 1 handler) string))
2922 (inhibit-read-only inhibit-read-only)
2925 (setq yank-undo-function t)
2926 (if (nth 0 handler) ; FUNCTION
2927 (funcall (car handler) param)
2931 ;; Prevent read-only properties from interfering with the
2932 ;; following text property changes.
2933 (setq inhibit-read-only t)
2935 (unless (nth 2 handler) ; NOEXCLUDE
2936 (remove-yank-excluded-properties opoint end))
2938 ;; If last inserted char has properties, mark them as rear-nonsticky.
2939 (if (and (> end opoint)
2940 (text-properties-at (1- end)))
2941 (put-text-property (1- end) end 'rear-nonsticky t))
2943 (if (eq yank-undo-function t) ; not set by FUNCTION
2944 (setq yank-undo-function (nth 3 handler))) ; UNDO
2945 (if (nth 4 handler) ; COMMAND
2946 (setq this-command (nth 4 handler)))))
2948 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2949 "Insert before point a substring of BUFFER, without text properties.
2950 BUFFER may be a buffer or a buffer name.
2951 Arguments START and END are character positions specifying the substring.
2952 They default to the values of (point-min) and (point-max) in BUFFER."
2953 (let ((opoint (point)))
2954 (insert-buffer-substring buffer start end)
2955 (let ((inhibit-read-only t))
2956 (set-text-properties opoint (point) nil))))
2958 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2959 "Insert before point a part of BUFFER, stripping some text properties.
2960 BUFFER may be a buffer or a buffer name.
2961 Arguments START and END are character positions specifying the substring.
2962 They default to the values of (point-min) and (point-max) in BUFFER.
2963 Before insertion, process text properties according to
2964 `yank-handled-properties' and `yank-excluded-properties'."
2965 ;; Since the buffer text should not normally have yank-handler properties,
2966 ;; there is no need to handle them here.
2967 (let ((opoint (point)))
2968 (insert-buffer-substring buffer start end)
2969 (remove-yank-excluded-properties opoint (point))))
2971 (defun yank-handle-font-lock-face-property (face start end)
2972 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2973 START and END denote the start and end of the text to act on.
2974 Do nothing if FACE is nil."
2976 (null font-lock-defaults)
2977 (put-text-property start end 'face face)))
2979 ;; This removes `mouse-face' properties in *Help* buffer buttons:
2980 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2981 (defun yank-handle-category-property (category start end)
2982 "Apply property category CATEGORY's properties between START and END."
2984 (let ((start2 start))
2985 (while (< start2 end)
2986 (let ((end2 (next-property-change start2 nil end))
2987 (original (text-properties-at start2)))
2988 (set-text-properties start2 end2 (symbol-plist category))
2989 (add-text-properties start2 end2 original)
2990 (setq start2 end2))))))
2993 ;;;; Synchronous shell commands.
2995 (defun start-process-shell-command (name buffer &rest args)
2996 "Start a program in a subprocess. Return the process object for it.
2997 NAME is name for process. It is modified if necessary to make it unique.
2998 BUFFER is the buffer (or buffer name) to associate with the process.
2999 Process output goes at end of that buffer, unless you specify
3000 an output stream or filter function to handle the output.
3001 BUFFER may be also nil, meaning that this process is not associated
3003 COMMAND is the shell command to run.
3005 An old calling convention accepted any number of arguments after COMMAND,
3006 which were just concatenated to COMMAND. This is still supported but strongly
3008 ;; We used to use `exec' to replace the shell with the command,
3009 ;; but that failed to handle (...) and semicolon, etc.
3010 (start-process name buffer shell-file-name shell-command-switch
3011 (mapconcat 'identity args " ")))
3012 (set-advertised-calling-convention 'start-process-shell-command
3013 '(name buffer command) "23.1")
3015 (defun start-file-process-shell-command (name buffer &rest args)
3016 "Start a program in a subprocess. Return the process object for it.
3017 Similar to `start-process-shell-command', but calls `start-file-process'."
3020 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3021 (if (file-remote-p default-directory) "-c" shell-command-switch)
3022 (mapconcat 'identity args " ")))
3023 (set-advertised-calling-convention 'start-file-process-shell-command
3024 '(name buffer command) "23.1")
3026 (defun call-process-shell-command (command &optional infile buffer display
3028 "Execute the shell command COMMAND synchronously in separate process.
3029 The remaining arguments are optional.
3030 The program's input comes from file INFILE (nil means `/dev/null').
3031 Insert output in BUFFER before point; t means current buffer;
3032 nil for BUFFER means discard it; 0 means discard and don't wait.
3033 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3034 REAL-BUFFER says what to do with standard output, as above,
3035 while STDERR-FILE says what to do with standard error in the child.
3036 STDERR-FILE may be nil (discard standard error output),
3037 t (mix it with ordinary output), or a file name string.
3039 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
3040 Remaining arguments are strings passed as additional arguments for COMMAND.
3041 Wildcards and redirection are handled as usual in the shell.
3043 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
3044 Otherwise it waits for COMMAND to terminate and returns a numeric exit
3045 status or a signal description string.
3046 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
3047 ;; We used to use `exec' to replace the shell with the command,
3048 ;; but that failed to handle (...) and semicolon, etc.
3049 (call-process shell-file-name
3050 infile buffer display
3051 shell-command-switch
3052 (mapconcat 'identity (cons command args) " ")))
3054 (defun process-file-shell-command (command &optional infile buffer display
3056 "Process files synchronously in a separate process.
3057 Similar to `call-process-shell-command', but calls `process-file'."
3059 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3060 infile buffer display
3061 (if (file-remote-p default-directory) "-c" shell-command-switch)
3062 (mapconcat 'identity (cons command args) " ")))
3064 ;;;; Lisp macros to do various things temporarily.
3066 (defmacro with-current-buffer (buffer-or-name &rest body)
3067 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3068 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3069 The value returned is the value of the last form in BODY. See
3070 also `with-temp-buffer'."
3071 (declare (indent 1) (debug t))
3072 `(save-current-buffer
3073 (set-buffer ,buffer-or-name)
3076 (defun internal--before-with-selected-window (window)
3077 (let ((other-frame (window-frame window)))
3078 (list window (selected-window)
3079 ;; Selecting a window on another frame also changes that
3080 ;; frame's frame-selected-window. We must save&restore it.
3081 (unless (eq (selected-frame) other-frame)
3082 (frame-selected-window other-frame))
3083 ;; Also remember the top-frame if on ttys.
3084 (unless (eq (selected-frame) other-frame)
3085 (tty-top-frame other-frame)))))
3087 (defun internal--after-with-selected-window (state)
3088 ;; First reset frame-selected-window.
3089 (when (window-live-p (nth 2 state))
3090 ;; We don't use set-frame-selected-window because it does not
3091 ;; pass the `norecord' argument to Fselect_window.
3092 (select-window (nth 2 state) 'norecord)
3093 (and (frame-live-p (nth 3 state))
3094 (not (eq (tty-top-frame) (nth 3 state)))
3095 (select-frame (nth 3 state) 'norecord)))
3096 ;; Then reset the actual selected-window.
3097 (when (window-live-p (nth 1 state))
3098 (select-window (nth 1 state) 'norecord)))
3100 (defmacro with-selected-window (window &rest body)
3101 "Execute the forms in BODY with WINDOW as the selected window.
3102 The value returned is the value of the last form in BODY.
3104 This macro saves and restores the selected window, as well as the
3105 selected window of each frame. It does not change the order of
3106 recently selected windows. If the previously selected window of
3107 some frame is no longer live at the end of BODY, that frame's
3108 selected window is left alone. If the selected window is no
3109 longer live, then whatever window is selected at the end of BODY
3112 This macro uses `save-current-buffer' to save and restore the
3113 current buffer, since otherwise its normal operation could
3114 potentially make a different buffer current. It does not alter
3115 the buffer list ordering."
3116 (declare (indent 1) (debug t))
3117 `(let ((save-selected-window--state
3118 (internal--before-with-selected-window ,window)))
3119 (save-current-buffer
3121 (progn (select-window (car save-selected-window--state) 'norecord)
3123 (internal--after-with-selected-window save-selected-window--state)))))
3125 (defmacro with-selected-frame (frame &rest body)
3126 "Execute the forms in BODY with FRAME as the selected frame.
3127 The value returned is the value of the last form in BODY.
3129 This macro saves and restores the selected frame, and changes the
3130 order of neither the recently selected windows nor the buffers in
3132 (declare (indent 1) (debug t))
3133 (let ((old-frame (make-symbol "old-frame"))
3134 (old-buffer (make-symbol "old-buffer")))
3135 `(let ((,old-frame (selected-frame))
3136 (,old-buffer (current-buffer)))
3138 (progn (select-frame ,frame 'norecord)
3140 (when (frame-live-p ,old-frame)
3141 (select-frame ,old-frame 'norecord))
3142 (when (buffer-live-p ,old-buffer)
3143 (set-buffer ,old-buffer))))))
3145 (defmacro save-window-excursion (&rest body)
3146 "Execute BODY, then restore previous window configuration.
3147 This macro saves the window configuration on the selected frame,
3148 executes BODY, then calls `set-window-configuration' to restore
3149 the saved window configuration. The return value is the last
3150 form in BODY. The window configuration is also restored if BODY
3153 BEWARE: Most uses of this macro introduce bugs.
3154 E.g. it should not be used to try and prevent some code from opening
3155 a new window, since that window may sometimes appear in another frame,
3156 in which case `save-window-excursion' cannot help."
3157 (declare (indent 0) (debug t))
3158 (let ((c (make-symbol "wconfig")))
3159 `(let ((,c (current-window-configuration)))
3160 (unwind-protect (progn ,@body)
3161 (set-window-configuration ,c)))))
3163 (defun internal-temp-output-buffer-show (buffer)
3164 "Internal function for `with-output-to-temp-buffer'."
3165 (with-current-buffer buffer
3166 (set-buffer-modified-p nil)
3167 (goto-char (point-min)))
3169 (if temp-buffer-show-function
3170 (funcall temp-buffer-show-function buffer)
3171 (with-current-buffer buffer
3173 (let ((window-combination-limit
3174 ;; When `window-combination-limit' equals
3175 ;; `temp-buffer' or `temp-buffer-resize' and
3176 ;; `temp-buffer-resize-mode' is enabled in this
3177 ;; buffer bind it to t so resizing steals space
3178 ;; preferably from the window that was split.
3179 (if (or (eq window-combination-limit 'temp-buffer)
3180 (and (eq window-combination-limit
3181 'temp-buffer-resize)
3182 temp-buffer-resize-mode))
3184 window-combination-limit)))
3185 (display-buffer buffer)))
3186 (frame (and window (window-frame window))))
3188 (unless (eq frame (selected-frame))
3189 (make-frame-visible frame))
3190 (setq minibuffer-scroll-window window)
3191 (set-window-hscroll window 0)
3192 ;; Don't try this with NOFORCE non-nil!
3193 (set-window-start window (point-min) t)
3194 ;; This should not be necessary.
3195 (set-window-point window (point-min))
3196 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3197 (with-selected-window window
3198 (run-hooks 'temp-buffer-show-hook))))))
3202 ;; Doc is very similar to with-temp-buffer-window.
3203 (defmacro with-output-to-temp-buffer (bufname &rest body)
3204 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3206 This construct makes buffer BUFNAME empty before running BODY.
3207 It does not make the buffer current for BODY.
3208 Instead it binds `standard-output' to that buffer, so that output
3209 generated with `prin1' and similar functions in BODY goes into
3212 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3213 it in a window, but does not select it. The normal way to do this is
3214 by calling `display-buffer', then running `temp-buffer-show-hook'.
3215 However, if `temp-buffer-show-function' is non-nil, it calls that
3216 function instead (and does not run `temp-buffer-show-hook'). The
3217 function gets one argument, the buffer to display.
3219 The return value of `with-output-to-temp-buffer' is the value of the
3220 last form in BODY. If BODY does not finish normally, the buffer
3221 BUFNAME is not displayed.
3223 This runs the hook `temp-buffer-setup-hook' before BODY,
3224 with the buffer BUFNAME temporarily current. It runs the hook
3225 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3226 buffer temporarily current, and the window that was used to display it
3227 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3228 if it uses `temp-buffer-show-function'.
3230 See the related form `with-temp-buffer-window'."
3232 (let ((old-dir (make-symbol "old-dir"))
3233 (buf (make-symbol "buf")))
3234 `(let* ((,old-dir default-directory)
3236 (with-current-buffer (get-buffer-create ,bufname)
3237 (prog1 (current-buffer)
3238 (kill-all-local-variables)
3239 ;; FIXME: delete_all_overlays
3240 (setq default-directory ,old-dir)
3241 (setq buffer-read-only nil)
3242 (setq buffer-file-name nil)
3243 (setq buffer-undo-list t)
3244 (let ((inhibit-read-only t)
3245 (inhibit-modification-hooks t))
3247 (run-hooks 'temp-buffer-setup-hook)))))
3248 (standard-output ,buf))
3249 (prog1 (progn ,@body)
3250 (internal-temp-output-buffer-show ,buf)))))
3252 (defmacro with-temp-file (file &rest body)
3253 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3254 The value returned is the value of the last form in BODY.
3255 See also `with-temp-buffer'."
3256 (declare (indent 1) (debug t))
3257 (let ((temp-file (make-symbol "temp-file"))
3258 (temp-buffer (make-symbol "temp-buffer")))
3259 `(let ((,temp-file ,file)
3261 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3264 (with-current-buffer ,temp-buffer
3266 (with-current-buffer ,temp-buffer
3267 (write-region nil nil ,temp-file nil 0)))
3268 (and (buffer-name ,temp-buffer)
3269 (kill-buffer ,temp-buffer))))))
3271 (defmacro with-temp-message (message &rest body)
3272 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3273 The original message is restored to the echo area after BODY has finished.
3274 The value returned is the value of the last form in BODY.
3275 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3276 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3277 Use a MESSAGE of \"\" to temporarily clear the echo area."
3278 (declare (debug t) (indent 1))
3279 (let ((current-message (make-symbol "current-message"))
3280 (temp-message (make-symbol "with-temp-message")))
3281 `(let ((,temp-message ,message)
3286 (setq ,current-message (current-message))
3287 (message "%s" ,temp-message))
3290 (if ,current-message
3291 (message "%s" ,current-message)
3294 (defmacro with-temp-buffer (&rest body)
3295 "Create a temporary buffer, and evaluate BODY there like `progn'.
3296 See also `with-temp-file' and `with-output-to-string'."
3297 (declare (indent 0) (debug t))
3298 (let ((temp-buffer (make-symbol "temp-buffer")))
3299 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3300 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3301 (with-current-buffer ,temp-buffer
3304 (and (buffer-name ,temp-buffer)
3305 (kill-buffer ,temp-buffer)))))))
3307 (defmacro with-silent-modifications (&rest body)
3308 "Execute BODY, pretending it does not modify the buffer.
3309 If BODY performs real modifications to the buffer's text, other
3310 than cosmetic ones, undo data may become corrupted.
3312 This macro will run BODY normally, but doesn't count its buffer
3313 modifications as being buffer modifications. This affects things
3314 like buffer-modified-p, checking whether the file is locked by
3315 someone else, running buffer modification hooks, and other things
3318 Typically used around modifications of text-properties which do
3319 not really affect the buffer's content."
3320 (declare (debug t) (indent 0))
3321 (let ((modified (make-symbol "modified")))
3322 `(let* ((,modified (buffer-modified-p))
3323 (buffer-undo-list t)
3324 (inhibit-read-only t)
3325 (inhibit-modification-hooks t)
3327 ;; Avoid setting and removing file locks and checking
3328 ;; buffer's uptodate-ness w.r.t the underlying file.
3330 buffer-file-truename)
3335 (restore-buffer-modified-p nil))))))
3337 (defmacro with-output-to-string (&rest body)
3338 "Execute BODY, return the text it sent to `standard-output', as a string."
3339 (declare (indent 0) (debug t))
3340 `(let ((standard-output
3341 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3344 (let ((standard-output standard-output))
3346 (with-current-buffer standard-output
3348 (kill-buffer standard-output))))
3350 (defmacro with-local-quit (&rest body)
3351 "Execute BODY, allowing quits to terminate BODY but not escape further.
3352 When a quit terminates BODY, `with-local-quit' returns nil but
3353 requests another quit. That quit will be processed as soon as quitting
3354 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3355 (declare (debug t) (indent 0))
3356 `(condition-case nil
3357 (let ((inhibit-quit nil))
3359 (quit (setq quit-flag t)
3360 ;; This call is to give a chance to handle quit-flag
3361 ;; in case inhibit-quit is nil.
3362 ;; Without this, it will not be handled until the next function
3363 ;; call, and that might allow it to exit thru a condition-case
3364 ;; that intends to handle the quit signal next time.
3365 (eval '(ignore nil)))))
3367 (defmacro while-no-input (&rest body)
3368 "Execute BODY only as long as there's no pending input.
3369 If input arrives, that ends the execution of BODY,
3370 and `while-no-input' returns t. Quitting makes it return nil.
3371 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3372 (declare (debug t) (indent 0))
3373 (let ((catch-sym (make-symbol "input")))
3376 (let ((throw-on-input ',catch-sym))
3377 (or (input-pending-p)
3378 (progn ,@body)))))))
3380 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3381 "Like `condition-case' except that it does not prevent debugging.
3382 More specifically if `debug-on-error' is set then the debugger will be invoked
3383 even if this catches the signal."
3384 (declare (debug condition-case) (indent 2))
3385 `(condition-case ,var
3387 ,@(mapcar (lambda (handler)
3388 `((debug ,@(if (listp (car handler)) (car handler)
3389 (list (car handler))))
3393 (define-obsolete-function-alias 'condition-case-no-debug
3394 'condition-case-unless-debug "24.1")
3396 (defmacro with-demoted-errors (&rest body)
3397 "Run BODY and demote any errors to simple messages.
3398 If `debug-on-error' is non-nil, run BODY without catching its errors.
3399 This is to be used around code which is not expected to signal an error
3400 but which should be robust in the unexpected case that an error is signaled."
3401 (declare (debug t) (indent 0))
3402 (let ((err (make-symbol "err")))
3403 `(condition-case-unless-debug ,err
3405 (error (message "Error: %S" ,err) nil))))
3407 (defmacro combine-after-change-calls (&rest body)
3408 "Execute BODY, but don't call the after-change functions till the end.
3409 If BODY makes changes in the buffer, they are recorded
3410 and the functions on `after-change-functions' are called several times
3411 when BODY is finished.
3412 The return value is the value of the last form in BODY.
3414 If `before-change-functions' is non-nil, then calls to the after-change
3415 functions can't be deferred, so in that case this macro has no effect.
3417 Do not alter `after-change-functions' or `before-change-functions'
3419 (declare (indent 0) (debug t))
3421 (let ((combine-after-change-calls t))
3423 (combine-after-change-execute)))
3425 (defmacro with-case-table (table &rest body)
3426 "Execute the forms in BODY with TABLE as the current case table.
3427 The value returned is the value of the last form in BODY."
3428 (declare (indent 1) (debug t))
3429 (let ((old-case-table (make-symbol "table"))
3430 (old-buffer (make-symbol "buffer")))
3431 `(let ((,old-case-table (current-case-table))
3432 (,old-buffer (current-buffer)))
3434 (progn (set-case-table ,table)
3436 (with-current-buffer ,old-buffer
3437 (set-case-table ,old-case-table))))))
3439 ;;; Matching and match data.
3441 (defvar save-match-data-internal)
3443 ;; We use save-match-data-internal as the local variable because
3444 ;; that works ok in practice (people should not use that variable elsewhere).
3445 ;; We used to use an uninterned symbol; the compiler handles that properly
3446 ;; now, but it generates slower code.
3447 (defmacro save-match-data (&rest body)
3448 "Execute the BODY forms, restoring the global value of the match data.
3449 The value returned is the value of the last form in BODY."
3450 ;; It is better not to use backquote here,
3451 ;; because that makes a bootstrapping problem
3452 ;; if you need to recompile all the Lisp files using interpreted code.
3453 (declare (indent 0) (debug t))
3455 '((save-match-data-internal (match-data)))
3456 (list 'unwind-protect
3458 ;; It is safe to free (evaporate) markers immediately here,
3459 ;; as Lisp programs should not copy from save-match-data-internal.
3460 '(set-match-data save-match-data-internal 'evaporate))))
3462 (defun match-string (num &optional string)
3463 "Return string of text matched by last search.
3464 NUM specifies which parenthesized expression in the last regexp.
3465 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3466 Zero means the entire text matched by the whole regexp or whole string.
3467 STRING should be given if the last search was by `string-match' on STRING.
3468 If STRING is nil, the current buffer should be the same buffer
3469 the search/match was performed in."
3470 (if (match-beginning num)
3472 (substring string (match-beginning num) (match-end num))
3473 (buffer-substring (match-beginning num) (match-end num)))))
3475 (defun match-string-no-properties (num &optional string)
3476 "Return string of text matched by last search, without text properties.
3477 NUM specifies which parenthesized expression in the last regexp.
3478 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3479 Zero means the entire text matched by the whole regexp or whole string.
3480 STRING should be given if the last search was by `string-match' on STRING.
3481 If STRING is nil, the current buffer should be the same buffer
3482 the search/match was performed in."
3483 (if (match-beginning num)
3485 (substring-no-properties string (match-beginning num)
3487 (buffer-substring-no-properties (match-beginning num)
3491 (defun match-substitute-replacement (replacement
3492 &optional fixedcase literal string subexp)
3493 "Return REPLACEMENT as it will be inserted by `replace-match'.
3494 In other words, all back-references in the form `\\&' and `\\N'
3495 are substituted with actual strings matched by the last search.
3496 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3497 meaning as for `replace-match'."
3498 (let ((match (match-string 0 string)))
3500 (set-match-data (mapcar (lambda (x)
3502 (- x (match-beginning 0))
3505 (replace-match replacement fixedcase literal match subexp))))
3508 (defun looking-back (regexp &optional limit greedy)
3509 "Return non-nil if text before point matches regular expression REGEXP.
3510 Like `looking-at' except matches before point, and is slower.
3511 LIMIT if non-nil speeds up the search by specifying a minimum
3512 starting position, to avoid checking matches that would start
3515 If GREEDY is non-nil, extend the match backwards as far as
3516 possible, stopping when a single additional previous character
3517 cannot be part of a match for REGEXP. When the match is
3518 extended, its starting position is allowed to occur before
3520 (let ((start (point))
3523 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3525 (if (and greedy pos)
3527 (narrow-to-region (point-min) start)
3528 (while (and (> pos (point-min))
3532 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3533 (setq pos (1- pos)))
3536 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3539 (defsubst looking-at-p (regexp)
3541 Same as `looking-at' except this function does not change the match data."
3542 (let ((inhibit-changing-match-data t))
3543 (looking-at regexp)))
3545 (defsubst string-match-p (regexp string &optional start)
3547 Same as `string-match' except this function does not change the match data."
3548 (let ((inhibit-changing-match-data t))
3549 (string-match regexp string start)))
3551 (defun subregexp-context-p (regexp pos &optional start)
3552 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3553 A subregexp context is one where a sub-regexp can appear.
3554 A non-subregexp context is for example within brackets, or within a
3555 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3556 If START is non-nil, it should be a position in REGEXP, smaller
3557 than POS, and known to be in a subregexp context."
3558 ;; Here's one possible implementation, with the great benefit that it
3559 ;; reuses the regexp-matcher's own parser, so it understands all the
3560 ;; details of the syntax. A disadvantage is that it needs to match the
3564 (string-match (substring regexp (or start 0) pos) "")
3567 (not (member (cadr err) '("Unmatched [ or [^"
3569 "Trailing backslash")))))
3570 ;; An alternative implementation:
3571 ;; (defconst re-context-re
3572 ;; (let* ((harmless-ch "[^\\[]")
3573 ;; (harmless-esc "\\\\[^{]")
3574 ;; (class-harmless-ch "[^][]")
3575 ;; (class-lb-harmless "[^]:]")
3576 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3577 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3578 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3580 ;; (concat "\\[^?]?"
3581 ;; "\\(" class-harmless-ch
3582 ;; "\\|" class-lb "\\)*"
3583 ;; "\\[?]")) ; special handling for bare [ at end of re
3584 ;; (braces "\\\\{[0-9,]+\\\\}"))
3585 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3586 ;; "\\|" class "\\|" braces "\\)*\\'"))
3587 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3588 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3593 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3594 "The default value of separators for `split-string'.
3596 A regexp matching strings of whitespace. May be locale-dependent
3597 \(as yet unimplemented). Should not match non-breaking spaces.
3599 Warning: binding this to a different value and using it as default is
3600 likely to have undesired semantics.")
3602 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3603 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3604 ;; expression leads to the equivalent implementation that if SEPARATORS
3605 ;; is defaulted, OMIT-NULLS is treated as t.
3606 (defun split-string (string &optional separators omit-nulls)
3607 "Split STRING into substrings bounded by matches for SEPARATORS.
3609 The beginning and end of STRING, and each match for SEPARATORS, are
3610 splitting points. The substrings matching SEPARATORS are removed, and
3611 the substrings between the splitting points are collected as a list,
3614 If SEPARATORS is non-nil, it should be a regular expression matching text
3615 which separates, but is not part of, the substrings. If nil it defaults to
3616 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3617 OMIT-NULLS is forced to t.
3619 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3620 that for the default value of SEPARATORS leading and trailing whitespace
3621 are effectively trimmed). If nil, all zero-length substrings are retained,
3622 which correctly parses CSV format, for example.
3624 Note that the effect of `(split-string STRING)' is the same as
3625 `(split-string STRING split-string-default-separators t)'. In the rare
3626 case that you wish to retain zero-length substrings when splitting on
3627 whitespace, use `(split-string STRING split-string-default-separators)'.
3629 Modifies the match data; use `save-match-data' if necessary."
3630 (let ((keep-nulls (not (if separators omit-nulls t)))
3631 (rexp (or separators split-string-default-separators))
3635 (while (and (string-match rexp string
3637 (= start (match-beginning 0))
3638 (< start (length string)))
3640 (< start (length string)))
3642 (if (or keep-nulls (< start (match-beginning 0)))
3644 (cons (substring string start (match-beginning 0))
3646 (setq start (match-end 0)))
3647 (if (or keep-nulls (< start (length string)))
3649 (cons (substring string start)
3653 (defun combine-and-quote-strings (strings &optional separator)
3654 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3655 This tries to quote the strings to avoid ambiguity such that
3656 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3657 Only some SEPARATORs will work properly."
3658 (let* ((sep (or separator " "))
3659 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3662 (if (string-match re str)
3663 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3667 (defun split-string-and-unquote (string &optional separator)
3668 "Split the STRING into a list of strings.
3669 It understands Emacs Lisp quoting within STRING, such that
3670 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3671 The SEPARATOR regexp defaults to \"\\s-+\"."
3672 (let ((sep (or separator "\\s-+"))
3673 (i (string-match "\"" string)))
3675 (split-string string sep t) ; no quoting: easy
3676 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3677 (let ((rfs (read-from-string string i)))
3679 (split-string-and-unquote (substring string (cdr rfs))
3683 ;;;; Replacement in strings.
3685 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3686 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3687 Unless optional argument INPLACE is non-nil, return a new string."
3688 (let ((i (length string))
3689 (newstr (if inplace string (copy-sequence string))))
3692 (if (eq (aref newstr i) fromchar)
3693 (aset newstr i tochar)))
3696 (defun replace-regexp-in-string (regexp rep string &optional
3697 fixedcase literal subexp start)
3698 "Replace all matches for REGEXP with REP in STRING.
3700 Return a new string containing the replacements.
3702 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3703 arguments with the same names of function `replace-match'. If START
3704 is non-nil, start replacements at that index in STRING.
3706 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3707 function. If it is a function, it is called with the actual text of each
3708 match, and its value is used as the replacement text. When REP is called,
3709 the match data are the result of matching REGEXP against a substring
3712 To replace only the first match (if any), make REGEXP match up to \\'
3713 and replace a sub-expression, e.g.
3714 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3717 ;; To avoid excessive consing from multiple matches in long strings,
3718 ;; don't just call `replace-match' continually. Walk down the
3719 ;; string looking for matches of REGEXP and building up a (reversed)
3720 ;; list MATCHES. This comprises segments of STRING which weren't
3721 ;; matched interspersed with replacements for segments that were.
3722 ;; [For a `large' number of replacements it's more efficient to
3723 ;; operate in a temporary buffer; we can't tell from the function's
3724 ;; args whether to choose the buffer-based implementation, though it
3725 ;; might be reasonable to do so for long enough STRING.]
3726 (let ((l (length string))
3727 (start (or start 0))
3730 (while (and (< start l) (string-match regexp string start))
3731 (setq mb (match-beginning 0)
3733 ;; If we matched the empty string, make sure we advance by one char
3734 (when (= me mb) (setq me (min l (1+ mb))))
3735 ;; Generate a replacement for the matched substring.
3736 ;; Operate only on the substring to minimize string consing.
3737 ;; Set up match data for the substring for replacement;
3738 ;; presumably this is likely to be faster than munging the
3739 ;; match data directly in Lisp.
3740 (string-match regexp (setq str (substring string mb me)))
3742 (cons (replace-match (if (stringp rep)
3744 (funcall rep (match-string 0 str)))
3745 fixedcase literal str subexp)
3746 (cons (substring string start mb) ; unmatched prefix
3749 ;; Reconstruct a string from the pieces.
3750 (setq matches (cons (substring string start l) matches)) ; leftover
3751 (apply #'concat (nreverse matches)))))
3753 (defun string-prefix-p (str1 str2 &optional ignore-case)
3754 "Return non-nil if STR1 is a prefix of STR2.
3755 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3756 to case differences."
3757 (eq t (compare-strings str1 nil nil
3758 str2 0 (length str1) ignore-case)))
3760 (defun bidi-string-mark-left-to-right (str)
3761 "Return a string that can be safely inserted in left-to-right text.
3763 Normally, inserting a string with right-to-left (RTL) script into
3764 a buffer may cause some subsequent text to be displayed as part
3765 of the RTL segment (usually this affects punctuation characters).
3766 This function returns a string which displays as STR but forces
3767 subsequent text to be displayed as left-to-right.
3769 If STR contains any RTL character, this function returns a string
3770 consisting of STR followed by an invisible left-to-right mark
3771 \(LRM) character. Otherwise, it returns STR."
3772 (unless (stringp str)
3773 (signal 'wrong-type-argument (list 'stringp str)))
3774 (if (string-match "\\cR" str)
3775 (concat str (propertize (string ?\x200e) 'invisible t))
3778 ;;;; invisibility specs
3780 (defun add-to-invisibility-spec (element)
3781 "Add ELEMENT to `buffer-invisibility-spec'.
3782 See documentation for `buffer-invisibility-spec' for the kind of elements
3784 (if (eq buffer-invisibility-spec t)
3785 (setq buffer-invisibility-spec (list t)))
3786 (setq buffer-invisibility-spec
3787 (cons element buffer-invisibility-spec)))
3789 (defun remove-from-invisibility-spec (element)
3790 "Remove ELEMENT from `buffer-invisibility-spec'."
3791 (if (consp buffer-invisibility-spec)
3792 (setq buffer-invisibility-spec
3793 (delete element buffer-invisibility-spec))))
3797 (defmacro with-syntax-table (table &rest body)
3798 "Evaluate BODY with syntax table of current buffer set to TABLE.
3799 The syntax table of the current buffer is saved, BODY is evaluated, and the
3800 saved table is restored, even in case of an abnormal exit.
3801 Value is what BODY returns."
3802 (declare (debug t) (indent 1))
3803 (let ((old-table (make-symbol "table"))
3804 (old-buffer (make-symbol "buffer")))
3805 `(let ((,old-table (syntax-table))
3806 (,old-buffer (current-buffer)))
3809 (set-syntax-table ,table)
3811 (save-current-buffer
3812 (set-buffer ,old-buffer)
3813 (set-syntax-table ,old-table))))))
3815 (defun make-syntax-table (&optional oldtable)
3816 "Return a new syntax table.
3817 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3818 from `standard-syntax-table' otherwise."
3819 (let ((table (make-char-table 'syntax-table nil)))
3820 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3823 (defun syntax-after (pos)
3824 "Return the raw syntax descriptor for the char after POS.
3825 If POS is outside the buffer's accessible portion, return nil."
3826 (unless (or (< pos (point-min)) (>= pos (point-max)))
3827 (let ((st (if parse-sexp-lookup-properties
3828 (get-char-property pos 'syntax-table))))
3830 (aref (or st (syntax-table)) (char-after pos))))))
3832 (defun syntax-class (syntax)
3833 "Return the code for the syntax class described by SYNTAX.
3835 SYNTAX should be a raw syntax descriptor; the return value is a
3836 integer which encodes the corresponding syntax class. See Info
3837 node `(elisp)Syntax Table Internals' for a list of codes.
3839 If SYNTAX is nil, return nil."
3840 (and syntax (logand (car syntax) 65535)))
3844 (defun text-clone-maintain (ol1 after beg end &optional _len)
3845 "Propagate the changes made under the overlay OL1 to the other clones.
3846 This is used on the `modification-hooks' property of text clones."
3847 (when (and after (not undo-in-progress) (overlay-start ol1))
3848 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3849 (setq beg (max beg (+ (overlay-start ol1) margin)))
3850 (setq end (min end (- (overlay-end ol1) margin)))
3853 (when (overlay-get ol1 'text-clone-syntax)
3854 ;; Check content of the clone's text.
3855 (let ((cbeg (+ (overlay-start ol1) margin))
3856 (cend (- (overlay-end ol1) margin)))
3859 (if (not (re-search-forward
3860 (overlay-get ol1 'text-clone-syntax) cend t))
3861 ;; Mark the overlay for deletion.
3863 (when (< (match-end 0) cend)
3864 ;; Shrink the clone at its end.
3865 (setq end (min end (match-end 0)))
3866 (move-overlay ol1 (overlay-start ol1)
3867 (+ (match-end 0) margin)))
3868 (when (> (match-beginning 0) cbeg)
3869 ;; Shrink the clone at its beginning.
3870 (setq beg (max (match-beginning 0) beg))
3871 (move-overlay ol1 (- (match-beginning 0) margin)
3872 (overlay-end ol1)))))))
3873 ;; Now go ahead and update the clones.
3874 (let ((head (- beg (overlay-start ol1)))
3875 (tail (- (overlay-end ol1) end))
3876 (str (buffer-substring beg end))
3878 (inhibit-modification-hooks t))
3879 (dolist (ol2 (overlay-get ol1 'text-clones))
3880 (let ((oe (overlay-end ol2)))
3881 (unless (or (eq ol1 ol2) (null oe))
3882 (setq nothing-left nil)
3883 (let ((mod-beg (+ (overlay-start ol2) head)))
3884 ;;(overlay-put ol2 'modification-hooks nil)
3885 (goto-char (- (overlay-end ol2) tail))
3886 (unless (> mod-beg (point))
3887 (save-excursion (insert str))
3888 (delete-region mod-beg (point)))
3889 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3891 (if nothing-left (delete-overlay ol1))))))))
3893 (defun text-clone-create (start end &optional spreadp syntax)
3894 "Create a text clone of START...END at point.
3895 Text clones are chunks of text that are automatically kept identical:
3896 changes done to one of the clones will be immediately propagated to the other.
3898 The buffer's content at point is assumed to be already identical to
3899 the one between START and END.
3900 If SYNTAX is provided it's a regexp that describes the possible text of
3901 the clones; the clone will be shrunk or killed if necessary to ensure that
3902 its text matches the regexp.
3903 If SPREADP is non-nil it indicates that text inserted before/after the
3904 clone should be incorporated in the clone."
3905 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3906 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3907 ;; (with a one-char margin at each end) with `t nil'.
3908 ;; We opted for a larger overlay because it behaves better in the case
3909 ;; where the clone is reduced to the empty string (we want the overlay to
3910 ;; stay when the clone's content is the empty string and we want to use
3911 ;; `evaporate' to make sure those overlays get deleted when needed).
3913 (let* ((pt-end (+ (point) (- end start)))
3914 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3916 (end-margin (if (or (not spreadp)
3917 (>= pt-end (point-max))
3918 (>= start (point-max)))
3920 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3921 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3922 (dups (list ol1 ol2)))
3923 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3924 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3925 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3926 ;;(overlay-put ol1 'face 'underline)
3927 (overlay-put ol1 'evaporate t)
3928 (overlay-put ol1 'text-clones dups)
3930 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3931 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3932 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3933 ;;(overlay-put ol2 'face 'underline)
3934 (overlay-put ol2 'evaporate t)
3935 (overlay-put ol2 'text-clones dups)))
3937 ;;;; Mail user agents.
3939 ;; Here we include just enough for other packages to be able
3942 (defun define-mail-user-agent (symbol composefunc sendfunc
3943 &optional abortfunc hookvar)
3944 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3946 SYMBOL can be any Lisp symbol. Its function definition and/or
3947 value as a variable do not matter for this usage; we use only certain
3948 properties on its property list, to encode the rest of the arguments.
3950 COMPOSEFUNC is program callable function that composes an outgoing
3951 mail message buffer. This function should set up the basics of the
3952 buffer without requiring user interaction. It should populate the
3953 standard mail headers, leaving the `to:' and `subject:' headers blank
3956 COMPOSEFUNC should accept several optional arguments--the same
3957 arguments that `compose-mail' takes. See that function's documentation.
3959 SENDFUNC is the command a user would run to send the message.
3961 Optional ABORTFUNC is the command a user would run to abort the
3962 message. For mail packages that don't have a separate abort function,
3963 this can be `kill-buffer' (the equivalent of omitting this argument).
3965 Optional HOOKVAR is a hook variable that gets run before the message
3966 is actually sent. Callers that use the `mail-user-agent' may
3967 install a hook function temporarily on this hook variable.
3968 If HOOKVAR is nil, `mail-send-hook' is used.
3970 The properties used on SYMBOL are `composefunc', `sendfunc',
3971 `abortfunc', and `hookvar'."
3972 (put symbol 'composefunc composefunc)
3973 (put symbol 'sendfunc sendfunc)
3974 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3975 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3977 (defvar called-interactively-p-functions nil
3978 "Special hook called to skip special frames in `called-interactively-p'.
3979 The functions are called with 3 arguments: (I FRAME1 FRAME2),
3980 where FRAME1 is a \"current frame\", FRAME2 is the next frame,
3981 I is the index of the frame after FRAME2. It should return nil
3982 if those frames don't seem special and otherwise, it should return
3983 the number of frames to skip (minus 1).")
3985 (defmacro internal--called-interactively-p--get-frame (n)
3986 ;; `sym' will hold a global variable, which will be used kind of like C's
3987 ;; "static" variables.
3988 (let ((sym (make-symbol "base-index")))
3991 (unless (boundp ',sym)
3993 (while (not (eq (indirect-function (nth 1 (backtrace-frame i)) t)
3994 (indirect-function 'called-interactively-p)))
3997 ;; (unless (eq (nth 1 (backtrace-frame ,sym)) 'called-interactively-p)
3998 ;; (error "called-interactively-p: %s is out-of-sync!" ,sym))
3999 (backtrace-frame (+ ,sym ,n)))))
4001 (defun called-interactively-p (&optional kind)
4002 "Return t if the containing function was called by `call-interactively'.
4003 If KIND is `interactive', then only return t if the call was made
4004 interactively by the user, i.e. not in `noninteractive' mode nor
4005 when `executing-kbd-macro'.
4006 If KIND is `any', on the other hand, it will return t for any kind of
4007 interactive call, including being called as the binding of a key or
4008 from a keyboard macro, even in `noninteractive' mode.
4010 This function is very brittle, it may fail to return the intended result when
4011 the code is debugged, advised, or instrumented in some form. Some macros and
4012 special forms (such as `condition-case') may also sometimes wrap their bodies
4013 in a `lambda', so any call to `called-interactively-p' from those bodies will
4014 indicate whether that lambda (rather than the surrounding function) was called
4017 Instead of using this function, it is cleaner and more reliable to give your
4018 function an extra optional argument whose `interactive' spec specifies
4019 non-nil unconditionally (\"p\" is a good way to do this), or via
4020 \(not (or executing-kbd-macro noninteractive)).
4022 The only known proper use of `interactive' for KIND is in deciding
4023 whether to display a helpful message, or how to display it. If you're
4024 thinking of using it for any other purpose, it is quite likely that
4025 you're making a mistake. Think: what do you want to do when the
4026 command is called from a keyboard macro?"
4027 (declare (advertised-calling-convention (kind) "23.1"))
4028 (when (not (and (eq kind 'interactive)
4029 (or executing-kbd-macro noninteractive)))
4030 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4034 (setq frame nextframe)
4035 (setq nextframe (internal--called-interactively-p--get-frame i))
4036 ;; (message "Frame %d = %S" i nextframe)
4038 (funcall get-next-frame) ;; Get the first frame.
4040 ;; FIXME: The edebug and advice handling should be made modular and
4041 ;; provided directly by edebug.el and nadvice.el.
4043 ;; frame =(backtrace-frame i-2)
4044 ;; nextframe=(backtrace-frame i-1)
4045 (funcall get-next-frame)
4046 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4047 ;; branches within local functions, which then messes up the
4048 ;; `backtrace-frame' data we get,
4050 ;; Skip special forms (from non-compiled code).
4051 (and frame (null (car frame)))
4052 ;; Skip also `interactive-p' (because we don't want to know if
4053 ;; interactive-p was called interactively but if it's caller was)
4054 ;; and `byte-code' (idem; this appears in subexpressions of things
4055 ;; like condition-case, which are wrapped in a separate bytecode
4057 ;; FIXME: For lexical-binding code, this is much worse,
4058 ;; because the frames look like "byte-code -> funcall -> #[...]",
4059 ;; which is not a reliable signature.
4060 (memq (nth 1 frame) '(interactive-p 'byte-code))
4061 ;; Skip package-specific stack-frames.
4062 (let ((skip (run-hook-with-args-until-success
4063 'called-interactively-p-functions
4064 i frame nextframe)))
4068 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4069 ;; Now `frame' should be "the function from which we were called".
4070 (pcase (cons frame nextframe)
4071 ;; No subr calls `interactive-p', so we can rule that out.
4072 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
4073 ;; Somehow, I sometimes got `command-execute' rather than
4074 ;; `call-interactively' on my stacktrace !?
4075 ;;(`(,_ . (t command-execute . ,_)) t)
4076 (`(,_ . (t call-interactively . ,_)) t)))))
4078 (defun interactive-p ()
4079 "Return t if the containing function was run directly by user input.
4080 This means that the function was called with `call-interactively'
4081 \(which includes being called as the binding of a key)
4082 and input is currently coming from the keyboard (not a keyboard macro),
4083 and Emacs is not running in batch mode (`noninteractive' is nil).
4085 The only known proper use of `interactive-p' is in deciding whether to
4086 display a helpful message, or how to display it. If you're thinking
4087 of using it for any other purpose, it is quite likely that you're
4088 making a mistake. Think: what do you want to do when the command is
4089 called from a keyboard macro or in batch mode?
4091 To test whether your function was called with `call-interactively',
4092 either (i) add an extra optional argument and give it an `interactive'
4093 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
4094 use `called-interactively-p'."
4095 (declare (obsolete called-interactively-p "23.2"))
4096 (called-interactively-p 'interactive))
4098 (defun function-arity (f &optional num)
4099 "Return the (MIN . MAX) arity of F.
4100 If the maximum arity is infinite, MAX is `many'.
4101 F can be a function or a macro.
4102 If NUM is non-nil, return non-nil iff F can be called with NUM args."
4103 (if (symbolp f) (setq f (indirect-function f)))
4104 (if (eq (car-safe f) 'macro) (setq f (cdr f)))
4107 (let ((x (subr-arity f)))
4108 (if (eq (cdr x) 'unevalled) (cons (car x) 'many)))
4109 (let* ((args (if (consp f) (cadr f) (aref f 0)))
4111 (opt (memq '&optional args))
4112 (rest (memq '&rest args))
4113 (min (- max (length opt))))
4115 (cons min (if rest 'many (1- max)))
4117 (cons (- max (length rest)) 'many)
4118 (cons min max)))))))
4121 (and (>= num (car res))
4122 (or (eq 'many (cdr res)) (<= num (cdr res)))))))
4124 (defun set-temporary-overlay-map (map &optional keep-pred)
4125 "Set MAP as a temporary keymap taking precedence over most other keymaps.
4126 Note that this does NOT take precedence over the \"overriding\" maps
4127 `overriding-terminal-local-map' and `overriding-local-map' (or the
4128 `keymap' text property). Unlike those maps, if no match for a key is
4129 found in MAP, the normal key lookup sequence then continues.
4131 Normally, MAP is used only once. If the optional argument
4132 KEEP-PRED is t, MAP stays active if a key from MAP is used.
4133 KEEP-PRED can also be a function of no arguments: if it returns
4134 non-nil then MAP stays active."
4135 (let* ((clearfunsym (make-symbol "clear-temporary-overlay-map"))
4136 (overlaysym (make-symbol "t"))
4137 (alist (list (cons overlaysym map)))
4139 ;; FIXME: Use lexical-binding.
4141 (unless ,(cond ((null keep-pred) nil)
4145 (this-command-keys-vector))))
4146 (t `(funcall ',keep-pred)))
4147 (set ',overlaysym nil) ;Just in case.
4148 (remove-hook 'pre-command-hook ',clearfunsym)
4149 (setq emulation-mode-map-alists
4150 (delq ',alist emulation-mode-map-alists))))))
4151 (set overlaysym overlaysym)
4152 (fset clearfunsym clearfun)
4153 (add-hook 'pre-command-hook clearfunsym)
4154 ;; FIXME: That's the keymaps with highest precedence, except for
4155 ;; the `keymap' text-property ;-(
4156 (push alist emulation-mode-map-alists)))
4158 ;;;; Progress reporters.
4160 ;; Progress reporter has the following structure:
4162 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4169 ;; This weirdness is for optimization reasons: we want
4170 ;; `progress-reporter-update' to be as fast as possible, so
4171 ;; `(car reporter)' is better than `(aref reporter 0)'.
4173 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4174 ;; digits of precision, it doesn't really matter here. On the other
4175 ;; hand, it greatly simplifies the code.
4177 (defsubst progress-reporter-update (reporter &optional value)
4178 "Report progress of an operation in the echo area.
4179 REPORTER should be the result of a call to `make-progress-reporter'.
4181 If REPORTER is a numerical progress reporter---i.e. if it was
4182 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4183 `make-progress-reporter'---then VALUE should be a number between
4184 MIN-VALUE and MAX-VALUE.
4186 If REPORTER is a non-numerical reporter, VALUE should be nil.
4188 This function is relatively inexpensive. If the change since
4189 last update is too small or insufficient time has passed, it does
4191 (when (or (not (numberp value)) ; For pulsing reporter
4192 (>= value (car reporter))) ; For numerical reporter
4193 (progress-reporter-do-update reporter value)))
4195 (defun make-progress-reporter (message &optional min-value max-value
4196 current-value min-change min-time)
4197 "Return progress reporter object for use with `progress-reporter-update'.
4199 MESSAGE is shown in the echo area, with a status indicator
4200 appended to the end. When you call `progress-reporter-done', the
4201 word \"done\" is printed after the MESSAGE. You can change the
4202 MESSAGE of an existing progress reporter by calling
4203 `progress-reporter-force-update'.
4205 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4206 and final (100% complete) states of operation; the latter should
4207 be larger. In this case, the status message shows the percentage
4210 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4211 message shows a \"spinning\", non-numeric indicator.
4213 Optional CURRENT-VALUE is the initial progress; the default is
4215 Optional MIN-CHANGE is the minimal change in percents to report;
4217 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4218 and/or MAX-VALUE are nil.
4220 Optional MIN-TIME specifies the minimum interval time between
4221 echo area updates (default is 0.2 seconds.) If the function
4222 `float-time' is not present, time is not tracked at all. If the
4223 OS is not capable of measuring fractions of seconds, this
4224 parameter is effectively rounded up."
4225 (when (string-match "[[:alnum:]]\\'" message)
4226 (setq message (concat message "...")))
4228 (setq min-time 0.2))
4230 ;; Force a call to `message' now
4231 (cons (or min-value 0)
4232 (vector (if (and (fboundp 'float-time)
4238 (if min-change (max (min min-change 50) 1) 1)
4240 (progress-reporter-update reporter (or current-value min-value))
4243 (defun progress-reporter-force-update (reporter &optional value new-message)
4244 "Report progress of an operation in the echo area unconditionally.
4246 The first two arguments are the same as in `progress-reporter-update'.
4247 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4248 (let ((parameters (cdr reporter)))
4250 (aset parameters 3 new-message))
4251 (when (aref parameters 0)
4252 (aset parameters 0 (float-time)))
4253 (progress-reporter-do-update reporter value)))
4255 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4256 "Characters to use for pulsing progress reporters.")
4258 (defun progress-reporter-do-update (reporter value)
4259 (let* ((parameters (cdr reporter))
4260 (update-time (aref parameters 0))
4261 (min-value (aref parameters 1))
4262 (max-value (aref parameters 2))
4263 (text (aref parameters 3))
4264 (current-time (float-time))
4266 ;; See if enough time has passed since the last update.
4267 (or (not update-time)
4268 (when (>= current-time update-time)
4269 ;; Calculate time for the next update
4270 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4271 (cond ((and min-value max-value)
4272 ;; Numerical indicator
4273 (let* ((one-percent (/ (- max-value min-value) 100.0))
4274 (percentage (if (= max-value min-value)
4276 (truncate (/ (- value min-value)
4278 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4279 ;; message because not enough time has passed, use 1
4280 ;; instead of MIN-CHANGE. This makes delays between echo
4281 ;; area updates closer to MIN-TIME.
4283 (min (+ min-value (* (+ percentage
4284 (if enough-time-passed
4290 (when (integerp value)
4291 (setcar reporter (ceiling (car reporter))))
4292 ;; Only print message if enough time has passed
4293 (when enough-time-passed
4294 (if (> percentage 0)
4295 (message "%s%d%%" text percentage)
4296 (message "%s" text)))))
4297 ;; Pulsing indicator
4299 (let ((index (mod (1+ (car reporter)) 4))
4300 (message-log-max nil))
4301 (setcar reporter index)
4304 (aref progress-reporter--pulse-characters
4307 (defun progress-reporter-done (reporter)
4308 "Print reporter's message followed by word \"done\" in echo area."
4309 (message "%sdone" (aref (cdr reporter) 3)))
4311 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4312 "Loop a certain number of times and report progress in the echo area.
4313 Evaluate BODY with VAR bound to successive integers running from
4314 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4315 the return value (nil if RESULT is omitted).
4317 At each iteration MESSAGE followed by progress percentage is
4318 printed in the echo area. After the loop is finished, MESSAGE
4319 followed by word \"done\" is printed. This macro is a
4320 convenience wrapper around `make-progress-reporter' and friends.
4322 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4323 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4324 (let ((temp (make-symbol "--dotimes-temp--"))
4325 (temp2 (make-symbol "--dotimes-temp2--"))
4329 (,(car spec) ,start)
4330 (,temp2 (make-progress-reporter ,message ,start ,end)))
4331 (while (< ,(car spec) ,temp)
4333 (progress-reporter-update ,temp2
4334 (setq ,(car spec) (1+ ,(car spec)))))
4335 (progress-reporter-done ,temp2)
4336 nil ,@(cdr (cdr spec)))))
4339 ;;;; Support for watching filesystem events.
4341 (defun inotify-event-p (event)
4342 "Check if EVENT is an inotify event."
4344 (>= (length event) 3)
4345 (eq (car event) 'file-inotify)))
4348 (defun inotify-handle-event (event)
4349 "Handle inotify file system monitoring event.
4350 If EVENT is an inotify filewatch event, call its callback.
4351 Otherwise, signal a `filewatch-error'."
4353 (unless (inotify-event-p event)
4354 (signal 'filewatch-error (cons "Not a valid inotify event" event)))
4355 (funcall (nth 2 event) (nth 1 event)))
4357 (defun w32notify-handle-event (event)
4358 "Handle MS-Windows file system monitoring event.
4359 If EVENT is an MS-Windows filewatch event, call its callback.
4360 Otherwise, signal a `filewatch-error'."
4362 (if (and (eq (car event) 'file-w32notify)
4363 (= (length event) 3))
4364 (funcall (nth 2 event) (nth 1 event))
4365 (signal 'filewatch-error
4366 (cons "Not a valid MS-Windows file-notify event" event))))
4369 ;;;; Comparing version strings.
4371 (defconst version-separator "."
4372 "Specify the string used to separate the version elements.
4374 Usually the separator is \".\", but it can be any other string.")
4377 (defconst version-regexp-alist
4378 '(("^[-_+ ]?alpha$" . -3)
4379 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
4380 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
4381 ("^[-_+ ]?beta$" . -2)
4382 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
4383 "Specify association between non-numeric version and its priority.
4385 This association is used to handle version string like \"1.0pre2\",
4386 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4387 non-numeric part of a version string to an integer. For example:
4389 String Version Integer List Version
4390 \"1.0pre2\" (1 0 -1 2)
4391 \"1.0PRE2\" (1 0 -1 2)
4392 \"22.8beta3\" (22 8 -2 3)
4393 \"22.8 Beta3\" (22 8 -2 3)
4394 \"0.9alpha1\" (0 9 -3 1)
4395 \"0.9AlphA1\" (0 9 -3 1)
4396 \"0.9 alpha\" (0 9 -3)
4398 Each element has the following form:
4404 REGEXP regexp used to match non-numeric part of a version string.
4405 It should begin with the `^' anchor and end with a `$' to
4406 prevent false hits. Letter-case is ignored while matching
4409 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4412 (defun version-to-list (ver)
4413 "Convert version string VER into a list of integers.
4415 The version syntax is given by the following EBNF:
4417 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4419 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4421 SEPARATOR ::= `version-separator' (which see)
4422 | `version-regexp-alist' (which see).
4424 The NUMBER part is optional if SEPARATOR is a match for an element
4425 in `version-regexp-alist'.
4427 Examples of valid version syntax:
4429 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4431 Examples of invalid version syntax:
4433 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4435 Examples of version conversion:
4437 Version String Version as a List of Integers
4438 \"1.0.7.5\" (1 0 7 5)
4439 \"1.0pre2\" (1 0 -1 2)
4440 \"1.0PRE2\" (1 0 -1 2)
4441 \"22.8beta3\" (22 8 -2 3)
4442 \"22.8Beta3\" (22 8 -2 3)
4443 \"0.9alpha1\" (0 9 -3 1)
4444 \"0.9AlphA1\" (0 9 -3 1)
4445 \"0.9alpha\" (0 9 -3)
4447 See documentation for `version-separator' and `version-regexp-alist'."
4448 (or (and (stringp ver) (> (length ver) 0))
4449 (error "Invalid version string: '%s'" ver))
4450 ;; Change .x.y to 0.x.y
4451 (if (and (>= (length ver) (length version-separator))
4452 (string-equal (substring ver 0 (length version-separator))
4454 (setq ver (concat "0" ver)))
4457 (case-fold-search t) ; ignore case in matching
4459 (while (and (setq s (string-match "[0-9]+" ver i))
4461 ;; handle numeric part
4462 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4465 ;; handle non-numeric part
4466 (when (and (setq s (string-match "[^0-9]+" ver i))
4468 (setq s (substring ver i (match-end 0))
4470 ;; handle alpha, beta, pre, etc. separator
4471 (unless (string= s version-separator)
4472 (setq al version-regexp-alist)
4473 (while (and al (not (string-match (caar al) s)))
4476 (push (cdar al) lst))
4477 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4478 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4479 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4481 (t (error "Invalid version syntax: '%s'" ver))))))
4483 (error "Invalid version syntax: '%s'" ver)
4487 (defun version-list-< (l1 l2)
4488 "Return t if L1, a list specification of a version, is lower than L2.
4490 Note that a version specified by the list (1) is equal to (1 0),
4491 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4492 Also, a version given by the list (1) is higher than (1 -1), which in
4493 turn is higher than (1 -2), which is higher than (1 -3)."
4494 (while (and l1 l2 (= (car l1) (car l2)))
4498 ;; l1 not null and l2 not null
4499 ((and l1 l2) (< (car l1) (car l2)))
4500 ;; l1 null and l2 null ==> l1 length = l2 length
4501 ((and (null l1) (null l2)) nil)
4502 ;; l1 not null and l2 null ==> l1 length > l2 length
4503 (l1 (< (version-list-not-zero l1) 0))
4504 ;; l1 null and l2 not null ==> l2 length > l1 length
4505 (t (< 0 (version-list-not-zero l2)))))
4508 (defun version-list-= (l1 l2)
4509 "Return t if L1, a list specification of a version, is equal to L2.
4511 Note that a version specified by the list (1) is equal to (1 0),
4512 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4513 Also, a version given by the list (1) is higher than (1 -1), which in
4514 turn is higher than (1 -2), which is higher than (1 -3)."
4515 (while (and l1 l2 (= (car l1) (car l2)))
4519 ;; l1 not null and l2 not null
4521 ;; l1 null and l2 null ==> l1 length = l2 length
4522 ((and (null l1) (null l2)))
4523 ;; l1 not null and l2 null ==> l1 length > l2 length
4524 (l1 (zerop (version-list-not-zero l1)))
4525 ;; l1 null and l2 not null ==> l2 length > l1 length
4526 (t (zerop (version-list-not-zero l2)))))
4529 (defun version-list-<= (l1 l2)
4530 "Return t if L1, a list specification of a version, is lower or equal to L2.
4532 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4533 etc. That is, the trailing zeroes are insignificant. Also, integer
4534 list (1) is greater than (1 -1) which is greater than (1 -2)
4535 which is greater than (1 -3)."
4536 (while (and l1 l2 (= (car l1) (car l2)))
4540 ;; l1 not null and l2 not null
4541 ((and l1 l2) (< (car l1) (car l2)))
4542 ;; l1 null and l2 null ==> l1 length = l2 length
4543 ((and (null l1) (null l2)))
4544 ;; l1 not null and l2 null ==> l1 length > l2 length
4545 (l1 (<= (version-list-not-zero l1) 0))
4546 ;; l1 null and l2 not null ==> l2 length > l1 length
4547 (t (<= 0 (version-list-not-zero l2)))))
4549 (defun version-list-not-zero (lst)
4550 "Return the first non-zero element of LST, which is a list of integers.
4552 If all LST elements are zeros or LST is nil, return zero."
4553 (while (and lst (zerop (car lst)))
4554 (setq lst (cdr lst)))
4557 ;; there is no element different of zero
4561 (defun version< (v1 v2)
4562 "Return t if version V1 is lower (older) than V2.
4564 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4565 etc. That is, the trailing \".0\"s are insignificant. Also, version
4566 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4567 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4569 (version-list-< (version-to-list v1) (version-to-list v2)))
4572 (defun version<= (v1 v2)
4573 "Return t if version V1 is lower (older) than or equal to V2.
4575 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4576 etc. That is, the trailing \".0\"s are insignificant. Also, version
4577 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4578 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4580 (version-list-<= (version-to-list v1) (version-to-list v2)))
4582 (defun version= (v1 v2)
4583 "Return t if version V1 is equal to V2.
4585 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4586 etc. That is, the trailing \".0\"s are insignificant. Also, version
4587 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4588 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4590 (version-list-= (version-to-list v1) (version-to-list v2)))
4594 (defconst menu-bar-separator '("--")
4595 "Separator for menus.")
4597 ;; The following statement ought to be in print.c, but `provide' can't
4599 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4600 (when (hash-table-p (car (read-from-string
4601 (prin1-to-string (make-hash-table)))))
4602 (provide 'hashtable-print-readable))
4604 ;;; subr.el ends here