1 ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2012
4 ;; Free Software Foundation, Inc.
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 (defsubst 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 (or (nth 5 position)
1052 (if (consp (nth 1 position))
1053 (car (nth 1 position))
1056 (defun posn-set-point (position)
1057 "Move point to POSITION.
1058 Select the corresponding window as well."
1059 (if (not (windowp (posn-window position)))
1060 (error "Position not in text area of window"))
1061 (select-window (posn-window position))
1062 (if (numberp (posn-point position))
1063 (goto-char (posn-point position))))
1065 (defsubst posn-x-y (position)
1066 "Return the x and y coordinates in POSITION.
1067 The return value has the form (X . Y), where X and Y are given in
1068 pixels. POSITION should be a list of the form returned by
1069 `event-start' and `event-end'."
1072 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1074 (defun posn-col-row (position)
1075 "Return the nominal column and row in POSITION, measured in characters.
1076 The column and row values are approximations calculated from the x
1077 and y coordinates in POSITION and the frame's default character width
1079 For a scroll-bar event, the result column is 0, and the row
1080 corresponds to the vertical position of the click in the scroll bar.
1081 POSITION should be a list of the form returned by the `event-start'
1082 and `event-end' functions."
1083 (let* ((pair (posn-x-y position))
1084 (window (posn-window position))
1085 (area (posn-area position)))
1089 ((eq area 'vertical-scroll-bar)
1090 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1091 ((eq area 'horizontal-scroll-bar)
1092 (cons (scroll-bar-scale pair (window-width window)) 0))
1094 (let* ((frame (if (framep window) window (window-frame window)))
1095 ;; FIXME: This should take line-spacing properties on
1096 ;; newlines into account.
1097 (spacing (when (display-graphic-p frame)
1098 (or (with-current-buffer (window-buffer window)
1100 (frame-parameter frame 'line-spacing)))))
1101 (cond ((floatp spacing)
1102 (setq spacing (truncate (* spacing
1103 (frame-char-height frame)))))
1106 (cons (/ (car pair) (frame-char-width frame))
1107 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1108 (if (null (with-current-buffer (window-buffer window)
1109 header-line-format))
1112 (defun posn-actual-col-row (position)
1113 "Return the actual column and row in POSITION, measured in characters.
1114 These are the actual row number in the window and character number in that row.
1115 Return nil if POSITION does not contain the actual position; in that case
1116 `posn-col-row' can be used to get approximate values.
1117 POSITION should be a list of the form returned by the `event-start'
1118 and `event-end' functions."
1121 (defsubst posn-timestamp (position)
1122 "Return the timestamp of POSITION.
1123 POSITION should be a list of the form returned by the `event-start'
1124 and `event-end' functions."
1127 (defsubst posn-string (position)
1128 "Return the string object of POSITION.
1129 Value is a cons (STRING . STRING-POS), or nil if not a string.
1130 POSITION should be a list of the form returned by the `event-start'
1131 and `event-end' functions."
1134 (defsubst posn-image (position)
1135 "Return the image object of POSITION.
1136 Value is a list (image ...), or nil if not an image.
1137 POSITION should be a list of the form returned by the `event-start'
1138 and `event-end' functions."
1141 (defsubst posn-object (position)
1142 "Return the object (image or string) of POSITION.
1143 Value is a list (image ...) for an image object, a cons cell
1144 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1145 POSITION should be a list of the form returned by the `event-start'
1146 and `event-end' functions."
1147 (or (posn-image position) (posn-string position)))
1149 (defsubst posn-object-x-y (position)
1150 "Return the x and y coordinates relative to the object of POSITION.
1151 The return value has the form (DX . DY), where DX and DY are
1152 given in pixels. POSITION should be a list of the form returned
1153 by `event-start' and `event-end'."
1156 (defsubst posn-object-width-height (position)
1157 "Return the pixel width and height of the object of POSITION.
1158 The return value has the form (WIDTH . HEIGHT). POSITION should
1159 be a list of the form returned by `event-start' and `event-end'."
1163 ;;;; Obsolescent names for functions.
1165 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1166 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1167 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1168 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1169 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1170 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1172 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1173 (make-obsolete 'buffer-has-markers-at nil "24.3")
1175 (defun insert-string (&rest args)
1176 "Mocklisp-compatibility insert function.
1177 Like the function `insert' except that any argument that is a number
1178 is converted into a string by expressing it in decimal."
1179 (declare (obsolete insert "22.1"))
1181 (insert (if (integerp el) (number-to-string el) el))))
1183 (defun makehash (&optional test)
1184 (declare (obsolete make-hash-table "22.1"))
1185 (make-hash-table :test (or test 'eql)))
1187 ;; These are used by VM and some old programs
1188 (defalias 'focus-frame 'ignore "")
1189 (make-obsolete 'focus-frame "it does nothing." "22.1")
1190 (defalias 'unfocus-frame 'ignore "")
1191 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1192 (make-obsolete 'make-variable-frame-local
1193 "explicitly check for a frame-parameter instead." "22.2")
1194 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1195 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
1196 (set-advertised-calling-convention
1197 'all-completions '(string collection &optional predicate) "23.1")
1198 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1199 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1201 ;;;; Obsolescence declarations for variables, and aliases.
1203 ;; Special "default-FOO" variables which contain the default value of
1204 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1205 ;; slows down several unrelated variable operations; furthermore, they
1206 ;; can lead to really odd behavior if you decide to make them
1209 ;; Not used at all in Emacs, last time I checked:
1210 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1211 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1212 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1213 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1214 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1215 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1216 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1217 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1218 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1219 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1220 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1221 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1222 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1223 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1224 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1225 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1226 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1227 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1228 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1229 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1230 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1231 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1232 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1233 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1234 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1235 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1236 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1237 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1238 (make-obsolete-variable 'default-enable-multibyte-characters
1239 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1241 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1242 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1243 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1244 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1245 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1246 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1248 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1249 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1251 ;; Lisp manual only updated in 22.1.
1252 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1255 (define-obsolete-variable-alias 'x-lost-selection-hooks
1256 'x-lost-selection-functions "22.1")
1257 (define-obsolete-variable-alias 'x-sent-selection-hooks
1258 'x-sent-selection-functions "22.1")
1260 ;; This was introduced in 21.4 for pre-unicode unification. That
1261 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1262 ;; Other uses are possible, so this variable is not _really_ obsolete,
1263 ;; but Stefan insists to mark it so.
1264 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1266 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1268 ;;;; Alternate names for functions - these are not being phased out.
1270 (defalias 'send-string 'process-send-string)
1271 (defalias 'send-region 'process-send-region)
1272 (defalias 'string= 'string-equal)
1273 (defalias 'string< 'string-lessp)
1274 (defalias 'move-marker 'set-marker)
1275 (defalias 'rplaca 'setcar)
1276 (defalias 'rplacd 'setcdr)
1277 (defalias 'beep 'ding) ;preserve lingual purity
1278 (defalias 'indent-to-column 'indent-to)
1279 (defalias 'backward-delete-char 'delete-backward-char)
1280 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1281 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1282 (defalias 'int-to-string 'number-to-string)
1283 (defalias 'store-match-data 'set-match-data)
1284 (defalias 'chmod 'set-file-modes)
1285 (defalias 'mkdir 'make-directory)
1286 ;; These are the XEmacs names:
1287 (defalias 'point-at-eol 'line-end-position)
1288 (defalias 'point-at-bol 'line-beginning-position)
1290 (defalias 'user-original-login-name 'user-login-name)
1293 ;;;; Hook manipulation functions.
1295 (defun add-hook (hook function &optional append local)
1296 "Add to the value of HOOK the function FUNCTION.
1297 FUNCTION is not added if already present.
1298 FUNCTION is added (if necessary) at the beginning of the hook list
1299 unless the optional argument APPEND is non-nil, in which case
1300 FUNCTION is added at the end.
1302 The optional fourth argument, LOCAL, if non-nil, says to modify
1303 the hook's buffer-local value rather than its global value.
1304 This makes the hook buffer-local, and it makes t a member of the
1305 buffer-local value. That acts as a flag to run the hook
1306 functions of the global value as well as in the local value.
1308 HOOK should be a symbol, and FUNCTION may be any valid function. If
1309 HOOK is void, it is first set to nil. If HOOK's value is a single
1310 function, it is changed to a list of functions."
1311 (or (boundp hook) (set hook nil))
1312 (or (default-boundp hook) (set-default hook nil))
1313 (if local (unless (local-variable-if-set-p hook)
1314 (set (make-local-variable hook) (list t)))
1315 ;; Detect the case where make-local-variable was used on a hook
1316 ;; and do what we used to do.
1317 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1319 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1320 ;; If the hook value is a single function, turn it into a list.
1321 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1322 (setq hook-value (list hook-value)))
1323 ;; Do the actual addition if necessary
1324 (unless (member function hook-value)
1325 (when (stringp function)
1326 (setq function (purecopy function)))
1329 (append hook-value (list function))
1330 (cons function hook-value))))
1331 ;; Set the actual variable
1334 ;; If HOOK isn't a permanent local,
1335 ;; but FUNCTION wants to survive a change of modes,
1336 ;; mark HOOK as partially permanent.
1337 (and (symbolp function)
1338 (get function 'permanent-local-hook)
1339 (not (get hook 'permanent-local))
1340 (put hook 'permanent-local 'permanent-local-hook))
1341 (set hook hook-value))
1342 (set-default hook hook-value))))
1344 (defun remove-hook (hook function &optional local)
1345 "Remove from the value of HOOK the function FUNCTION.
1346 HOOK should be a symbol, and FUNCTION may be any valid function. If
1347 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1348 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1350 The optional third argument, LOCAL, if non-nil, says to modify
1351 the hook's buffer-local value rather than its default value."
1352 (or (boundp hook) (set hook nil))
1353 (or (default-boundp hook) (set-default hook nil))
1354 ;; Do nothing if LOCAL is t but this hook has no local binding.
1355 (unless (and local (not (local-variable-p hook)))
1356 ;; Detect the case where make-local-variable was used on a hook
1357 ;; and do what we used to do.
1358 (when (and (local-variable-p hook)
1359 (not (and (consp (symbol-value hook))
1360 (memq t (symbol-value hook)))))
1362 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1363 ;; Remove the function, for both the list and the non-list cases.
1364 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1365 (if (equal hook-value function) (setq hook-value nil))
1366 (setq hook-value (delete function (copy-sequence hook-value))))
1367 ;; If the function is on the global hook, we need to shadow it locally
1368 ;;(when (and local (member function (default-value hook))
1369 ;; (not (member (cons 'not function) hook-value)))
1370 ;; (push (cons 'not function) hook-value))
1371 ;; Set the actual variable
1373 (set-default hook hook-value)
1374 (if (equal hook-value '(t))
1375 (kill-local-variable hook)
1376 (set hook hook-value))))))
1378 (defmacro letrec (binders &rest body)
1379 "Bind variables according to BINDERS then eval BODY.
1380 The value of the last form in BODY is returned.
1381 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1382 SYMBOL to the value of VALUEFORM.
1383 All symbols are bound before the VALUEFORMs are evalled."
1384 ;; Only useful in lexical-binding mode.
1385 ;; As a special-form, we could implement it more efficiently (and cleanly,
1386 ;; making the vars actually unbound during evaluation of the binders).
1387 (declare (debug let) (indent 1))
1388 `(let ,(mapcar #'car binders)
1389 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1392 (defmacro with-wrapper-hook (hook args &rest body)
1393 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1394 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1395 around the preceding ones, like a set of nested `around' advices.
1397 Each hook function should accept an argument list consisting of a
1398 function FUN, followed by the additional arguments in ARGS.
1400 The first hook function in HOOK is passed a FUN that, if it is called
1401 with arguments ARGS, performs BODY (i.e., the default operation).
1402 The FUN passed to each successive hook function is defined based
1403 on the preceding hook functions; if called with arguments ARGS,
1404 it does what the `with-wrapper-hook' call would do if the
1405 preceding hook functions were the only ones present in HOOK.
1407 Each hook function may call its FUN argument as many times as it wishes,
1408 including never. In that case, such a hook function acts to replace
1409 the default definition altogether, and any preceding hook functions.
1410 Of course, a subsequent hook function may do the same thing.
1412 Each hook function definition is used to construct the FUN passed
1413 to the next hook function, if any. The last (or \"outermost\")
1414 FUN is then called once."
1415 (declare (indent 2) (debug (form sexp body)))
1416 ;; We need those two gensyms because CL's lexical scoping is not available
1417 ;; for function arguments :-(
1418 (let ((funs (make-symbol "funs"))
1419 (global (make-symbol "global"))
1420 (argssym (make-symbol "args"))
1421 (runrestofhook (make-symbol "runrestofhook")))
1422 ;; Since the hook is a wrapper, the loop has to be done via
1423 ;; recursion: a given hook function will call its parameter in order to
1424 ;; continue looping.
1425 `(letrec ((,runrestofhook
1426 (lambda (,funs ,global ,argssym)
1427 ;; `funs' holds the functions left on the hook and `global'
1428 ;; holds the functions left on the global part of the hook
1429 ;; (in case the hook is local).
1431 (if (eq t (car ,funs))
1432 (funcall ,runrestofhook
1433 (append ,global (cdr ,funs)) nil ,argssym)
1436 (lambda (,funs ,global &rest ,argssym)
1437 (funcall ,runrestofhook ,funs ,global ,argssym))
1438 (cdr ,funs) ,global)
1440 ;; Once there are no more functions on the hook, run
1441 ;; the original body.
1442 (apply (lambda ,args ,@body) ,argssym)))))
1443 (funcall ,runrestofhook ,hook
1444 ;; The global part of the hook, if any.
1446 `(if (local-variable-p ',hook)
1447 (default-value ',hook)))
1450 (defun add-to-list (list-var element &optional append compare-fn)
1451 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1452 The test for presence of ELEMENT is done with `equal',
1453 or with COMPARE-FN if that's non-nil.
1454 If ELEMENT is added, it is added at the beginning of the list,
1455 unless the optional argument APPEND is non-nil, in which case
1456 ELEMENT is added at the end.
1458 The return value is the new value of LIST-VAR.
1460 If you want to use `add-to-list' on a variable that is not defined
1461 until a certain package is loaded, you should put the call to `add-to-list'
1462 into a hook function that will be run only after loading the package.
1463 `eval-after-load' provides one way to do this. In some cases
1464 other hooks, such as major mode hooks, can do the job."
1467 (member element (symbol-value list-var)))
1468 ((eq compare-fn 'eq)
1469 (memq element (symbol-value list-var)))
1470 ((eq compare-fn 'eql)
1471 (memql element (symbol-value list-var)))
1473 (let ((lst (symbol-value list-var)))
1475 (not (funcall compare-fn element (car lst))))
1476 (setq lst (cdr lst)))
1478 (symbol-value list-var)
1481 (append (symbol-value list-var) (list element))
1482 (cons element (symbol-value list-var))))))
1485 (defun add-to-ordered-list (list-var element &optional order)
1486 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1487 The test for presence of ELEMENT is done with `eq'.
1489 The resulting list is reordered so that the elements are in the
1490 order given by each element's numeric list order. Elements
1491 without a numeric list order are placed at the end of the list.
1493 If the third optional argument ORDER is a number (integer or
1494 float), set the element's list order to the given value. If
1495 ORDER is nil or omitted, do not change the numeric order of
1496 ELEMENT. If ORDER has any other value, remove the numeric order
1497 of ELEMENT if it has one.
1499 The list order for each element is stored in LIST-VAR's
1500 `list-order' property.
1502 The return value is the new value of LIST-VAR."
1503 (let ((ordering (get list-var 'list-order)))
1505 (put list-var 'list-order
1506 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1508 (puthash element (and (numberp order) order) ordering))
1509 (unless (memq element (symbol-value list-var))
1510 (set list-var (cons element (symbol-value list-var))))
1511 (set list-var (sort (symbol-value list-var)
1513 (let ((oa (gethash a ordering))
1514 (ob (gethash b ordering)))
1519 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1520 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1521 Return the new history list.
1522 If MAXELT is non-nil, it specifies the maximum length of the history.
1523 Otherwise, the maximum history length is the value of the `history-length'
1524 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1526 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1527 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1528 if it is empty or a duplicate."
1530 (setq maxelt (or (get history-var 'history-length)
1532 (let ((history (symbol-value history-var))
1534 (when (and (listp history)
1536 (not (stringp newelt))
1537 (> (length newelt) 0))
1539 (not (equal (car history) newelt))))
1540 (if history-delete-duplicates
1541 (setq history (delete newelt history)))
1542 (setq history (cons newelt history))
1543 (when (integerp maxelt)
1546 (setq tail (nthcdr (1- maxelt) history))
1548 (setcdr tail nil)))))
1549 (set history-var history)))
1554 (defvar delay-mode-hooks nil
1555 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1556 (defvar delayed-mode-hooks nil
1557 "List of delayed mode hooks waiting to be run.")
1558 (make-variable-buffer-local 'delayed-mode-hooks)
1559 (put 'delay-mode-hooks 'permanent-local t)
1561 (defvar change-major-mode-after-body-hook nil
1562 "Normal hook run in major mode functions, before the mode hooks.")
1564 (defvar after-change-major-mode-hook nil
1565 "Normal hook run at the very end of major mode functions.")
1567 (defun run-mode-hooks (&rest hooks)
1568 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1569 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1570 just adds the HOOKS to the list `delayed-mode-hooks'.
1571 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1572 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1573 `after-change-major-mode-hook'. Major mode functions should use
1574 this instead of `run-hooks' when running their FOO-mode-hook."
1575 (if delay-mode-hooks
1577 (dolist (hook hooks)
1578 (push hook delayed-mode-hooks))
1579 ;; Normal case, just run the hook as before plus any delayed hooks.
1580 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1581 (setq delayed-mode-hooks nil)
1582 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1583 (run-hooks 'after-change-major-mode-hook)))
1585 (defmacro delay-mode-hooks (&rest body)
1586 "Execute BODY, but delay any `run-mode-hooks'.
1587 These hooks will be executed by the first following call to
1588 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1589 Only affects hooks run in the current buffer."
1590 (declare (debug t) (indent 0))
1592 (make-local-variable 'delay-mode-hooks)
1593 (let ((delay-mode-hooks t))
1596 ;; PUBLIC: find if the current mode derives from another.
1598 (defun derived-mode-p (&rest modes)
1599 "Non-nil if the current major mode is derived from one of MODES.
1600 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1601 (let ((parent major-mode))
1602 (while (and (not (memq parent modes))
1603 (setq parent (get parent 'derived-mode-parent))))
1608 ;; If a minor mode is not defined with define-minor-mode,
1609 ;; add it here explicitly.
1610 ;; isearch-mode is deliberately excluded, since you should
1611 ;; not call it yourself.
1612 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1613 overwrite-mode view-mode
1615 "List of all minor mode functions.")
1617 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1618 "Register a new minor mode.
1620 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1622 TOGGLE is a symbol which is the name of a buffer-local variable that
1623 is toggled on or off to say whether the minor mode is active or not.
1625 NAME specifies what will appear in the mode line when the minor mode
1626 is active. NAME should be either a string starting with a space, or a
1627 symbol whose value is such a string.
1629 Optional KEYMAP is the keymap for the minor mode that will be added
1630 to `minor-mode-map-alist'.
1632 Optional AFTER specifies that TOGGLE should be added after AFTER
1633 in `minor-mode-alist'.
1635 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1636 It defaults to (and should by convention be) TOGGLE.
1638 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1639 included in the mode-line minor mode menu.
1640 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1641 (unless (memq toggle minor-mode-list)
1642 (push toggle minor-mode-list))
1644 (unless toggle-fun (setq toggle-fun toggle))
1645 (unless (eq toggle-fun toggle)
1646 (put toggle :minor-mode-function toggle-fun))
1647 ;; Add the name to the minor-mode-alist.
1649 (let ((existing (assq toggle minor-mode-alist)))
1651 (setcdr existing (list name))
1652 (let ((tail minor-mode-alist) found)
1653 (while (and tail (not found))
1654 (if (eq after (caar tail))
1656 (setq tail (cdr tail))))
1658 (let ((rest (cdr found)))
1660 (nconc found (list (list toggle name)) rest))
1661 (push (list toggle name) minor-mode-alist))))))
1662 ;; Add the toggle to the minor-modes menu if requested.
1663 (when (get toggle :included)
1664 (define-key mode-line-mode-menu
1668 (or (get toggle :menu-tag)
1669 (if (stringp name) name (symbol-name toggle)))
1670 (let ((mode-name (if (symbolp name) (symbol-value name))))
1671 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1672 (concat " (" (match-string 0 mode-name) ")"))))
1674 :button (cons :toggle toggle))))
1676 ;; Add the map to the minor-mode-map-alist.
1678 (let ((existing (assq toggle minor-mode-map-alist)))
1680 (setcdr existing keymap)
1681 (let ((tail minor-mode-map-alist) found)
1682 (while (and tail (not found))
1683 (if (eq after (caar tail))
1685 (setq tail (cdr tail))))
1687 (let ((rest (cdr found)))
1689 (nconc found (list (cons toggle keymap)) rest))
1690 (push (cons toggle keymap) minor-mode-map-alist)))))))
1694 (defsubst autoloadp (object)
1695 "Non-nil if OBJECT is an autoload."
1696 (eq 'autoload (car-safe object)))
1698 ;; (defun autoload-type (object)
1699 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1700 ;; OBJECT should be an autoload object."
1701 ;; (when (autoloadp object)
1702 ;; (let ((type (nth 3 object)))
1703 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1704 ;; ((eq 'keymap t) 'macro)
1707 ;; (defalias 'autoload-file #'cadr
1708 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1709 ;; \n\(fn AUTOLOAD)")
1711 (defun symbol-file (symbol &optional type)
1712 "Return the name of the file that defined SYMBOL.
1713 The value is normally an absolute file name. It can also be nil,
1714 if the definition is not associated with any file. If SYMBOL
1715 specifies an autoloaded function, the value can be a relative
1716 file name without extension.
1718 If TYPE is nil, then any kind of definition is acceptable. If
1719 TYPE is `defun', `defvar', or `defface', that specifies function
1720 definition, variable definition, or face definition only."
1721 (if (and (or (null type) (eq type 'defun))
1722 (symbolp symbol) (fboundp symbol)
1723 (autoloadp (symbol-function symbol)))
1724 (nth 1 (symbol-function symbol))
1725 (let ((files load-history)
1729 (if (eq type 'defvar)
1730 ;; Variables are present just as their names.
1731 (member symbol (cdr (car files)))
1732 ;; Other types are represented as (TYPE . NAME).
1733 (member (cons type symbol) (cdr (car files))))
1734 ;; We accept all types, so look for variable def
1735 ;; and then for any other kind.
1736 (or (member symbol (cdr (car files)))
1737 (rassq symbol (cdr (car files)))))
1738 (setq file (car (car files)) files nil))
1739 (setq files (cdr files)))
1742 (defun locate-library (library &optional nosuffix path interactive-call)
1743 "Show the precise file name of Emacs library LIBRARY.
1744 LIBRARY should be a relative file name of the library, a string.
1745 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1746 nil (which is the default, see below).
1747 This command searches the directories in `load-path' like `\\[load-library]'
1748 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1749 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1750 to the specified name LIBRARY.
1752 If the optional third arg PATH is specified, that list of directories
1753 is used instead of `load-path'.
1755 When called from a program, the file name is normally returned as a
1756 string. When run interactively, the argument INTERACTIVE-CALL is t,
1757 and the file name is displayed in the echo area."
1758 (interactive (list (completing-read "Locate library: "
1760 'locate-file-completion-table
1761 load-path (get-load-suffixes)))
1764 (let ((file (locate-file library
1766 (append (unless nosuffix (get-load-suffixes))
1767 load-file-rep-suffixes))))
1768 (if interactive-call
1770 (message "Library is file %s" (abbreviate-file-name file))
1771 (message "No library %s in search path" library)))
1775 ;;;; Specifying things to do later.
1777 (defun load-history-regexp (file)
1778 "Form a regexp to find FILE in `load-history'.
1779 FILE, a string, is described in the function `eval-after-load'."
1780 (if (file-name-absolute-p file)
1781 (setq file (file-truename file)))
1782 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1784 (if (file-name-extension file)
1786 ;; Note: regexp-opt can't be used here, since we need to call
1787 ;; this before Emacs has been fully started. 2006-05-21
1788 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1789 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1792 (defun load-history-filename-element (file-regexp)
1793 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1794 Return nil if there isn't one."
1795 (let* ((loads load-history)
1796 (load-elt (and loads (car loads))))
1799 (or (null (car load-elt))
1800 (not (string-match file-regexp (car load-elt)))))
1801 (setq loads (cdr loads)
1802 load-elt (and loads (car loads)))))
1805 (put 'eval-after-load 'lisp-indent-function 1)
1806 (defun eval-after-load (file form)
1807 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
1808 If FILE is already loaded, evaluate FORM right now.
1810 If a matching file is loaded again, FORM will be evaluated again.
1812 If FILE is a string, it may be either an absolute or a relative file
1813 name, and may have an extension \(e.g. \".el\") or may lack one, and
1814 additionally may or may not have an extension denoting a compressed
1815 format \(e.g. \".gz\").
1817 When FILE is absolute, this first converts it to a true name by chasing
1818 symbolic links. Only a file of this name \(see next paragraph regarding
1819 extensions) will trigger the evaluation of FORM. When FILE is relative,
1820 a file whose absolute true name ends in FILE will trigger evaluation.
1822 When FILE lacks an extension, a file name with any extension will trigger
1823 evaluation. Otherwise, its extension must match FILE's. A further
1824 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1827 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1828 is evaluated at the end of any file that `provide's this feature.
1829 If the feature is provided when evaluating code not associated with a
1830 file, FORM is evaluated immediately after the provide statement.
1832 Usually FILE is just a library name like \"font-lock\" or a feature name
1835 This function makes or adds to an entry on `after-load-alist'."
1836 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1837 ;; evaluating it now).
1838 (let* ((regexp-or-feature
1840 (setq file (purecopy (load-history-regexp file)))
1842 (elt (assoc regexp-or-feature after-load-alist)))
1844 (setq elt (list regexp-or-feature))
1845 (push elt after-load-alist))
1846 ;; Make sure `form' is evalled in the current lexical/dynamic code.
1847 (setq form `(funcall ',(eval `(lambda () ,form) lexical-binding)))
1848 ;; Is there an already loaded file whose name (or `provide' name)
1850 (prog1 (if (if (stringp file)
1851 (load-history-filename-element regexp-or-feature)
1854 (when (symbolp regexp-or-feature)
1855 ;; For features, the after-load-alist elements get run when `provide' is
1856 ;; called rather than at the end of the file. So add an indirection to
1857 ;; make sure that `form' is really run "after-load" in case the provide
1858 ;; call happens early.
1861 (let ((fun (make-symbol "eval-after-load-helper")))
1862 (fset fun `(lambda (file)
1863 (if (not (equal file ',load-file-name))
1865 (remove-hook 'after-load-functions ',fun)
1867 (add-hook 'after-load-functions fun))
1868 ;; Not being provided from a file, run form right now.
1870 ;; Add FORM to the element unless it's already there.
1871 (unless (member form (cdr elt))
1872 (nconc elt (purecopy (list form)))))))
1874 (defvar after-load-functions nil
1875 "Special hook run after loading a file.
1876 Each function there is called with a single argument, the absolute
1877 name of the file just loaded.")
1879 (defun do-after-load-evaluation (abs-file)
1880 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1881 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1882 This function is called directly from the C code."
1883 ;; Run the relevant eval-after-load forms.
1884 (mapc #'(lambda (a-l-element)
1885 (when (and (stringp (car a-l-element))
1886 (string-match-p (car a-l-element) abs-file))
1887 ;; discard the file name regexp
1888 (mapc #'eval (cdr a-l-element))))
1890 ;; Complain when the user uses obsolete files.
1891 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1892 (run-with-timer 0 nil
1894 (message "Package %s is obsolete!"
1896 (string-match "\\.elc?\\>" file))))
1897 (file-name-nondirectory abs-file)))
1898 ;; Finally, run any other hook.
1899 (run-hook-with-args 'after-load-functions abs-file))
1901 (defun eval-next-after-load (file)
1902 "Read the following input sexp, and run it whenever FILE is loaded.
1903 This makes or adds to an entry on `after-load-alist'.
1904 FILE should be the name of a library, with no directory name."
1905 (declare (obsolete eval-after-load "23.2"))
1906 (eval-after-load file (read)))
1908 (defun display-delayed-warnings ()
1909 "Display delayed warnings from `delayed-warnings-list'.
1910 Used from `delayed-warnings-hook' (which see)."
1911 (dolist (warning (nreverse delayed-warnings-list))
1912 (apply 'display-warning warning))
1913 (setq delayed-warnings-list nil))
1915 (defun collapse-delayed-warnings ()
1916 "Remove duplicates from `delayed-warnings-list'.
1917 Collapse identical adjacent warnings into one (plus count).
1918 Used from `delayed-warnings-hook' (which see)."
1921 (while delayed-warnings-list
1922 (setq warning (pop delayed-warnings-list))
1923 (if (equal warning (car delayed-warnings-list))
1924 (setq count (1+ count))
1926 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
1929 (push warning collapsed)))
1930 (setq delayed-warnings-list (nreverse collapsed))))
1932 ;; At present this is only used for Emacs internals.
1933 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
1934 (defvar delayed-warnings-hook '(collapse-delayed-warnings
1935 display-delayed-warnings)
1936 "Normal hook run to process and display delayed warnings.
1937 By default, this hook contains functions to consolidate the
1938 warnings listed in `delayed-warnings-list', display them, and set
1939 `delayed-warnings-list' back to nil.")
1944 (defun process-lines (program &rest args)
1945 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1946 Signal an error if the program returns with a non-zero exit status."
1948 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1949 (unless (eq status 0)
1950 (error "%s exited with status %s" program status))
1951 (goto-char (point-min))
1954 (setq lines (cons (buffer-substring-no-properties
1955 (line-beginning-position)
1956 (line-end-position))
1959 (nreverse lines)))))
1961 (defun process-live-p (process)
1962 "Returns non-nil if PROCESS is alive.
1963 A process is considered alive if its status is `run', `open',
1964 `listen', `connect' or `stop'."
1965 (memq (process-status process)
1966 '(run open listen connect stop)))
1971 'process-kill-without-query
1972 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1974 (defun process-kill-without-query (process &optional _flag)
1975 "Say no query needed if PROCESS is running when Emacs is exited.
1976 Optional second argument if non-nil says to require a query.
1977 Value is t if a query was formerly required."
1978 (let ((old (process-query-on-exit-flag process)))
1979 (set-process-query-on-exit-flag process nil)
1982 (defun process-kill-buffer-query-function ()
1983 "Ask before killing a buffer that has a running process."
1984 (let ((process (get-buffer-process (current-buffer))))
1986 (not (memq (process-status process) '(run stop open listen)))
1987 (not (process-query-on-exit-flag process))
1989 (format "Buffer %S has a running process; kill it? "
1990 (buffer-name (current-buffer)))))))
1992 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1994 ;; process plist management
1996 (defun process-get (process propname)
1997 "Return the value of PROCESS' PROPNAME property.
1998 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1999 (plist-get (process-plist process) propname))
2001 (defun process-put (process propname value)
2002 "Change PROCESS' PROPNAME property to VALUE.
2003 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2004 (set-process-plist process
2005 (plist-put (process-plist process) propname value)))
2008 ;;;; Input and display facilities.
2010 (defvar read-quoted-char-radix 8
2011 "Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2012 Legitimate radix values are 8, 10 and 16.")
2014 (custom-declare-variable-early
2015 'read-quoted-char-radix 8
2016 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2017 Legitimate radix values are 8, 10 and 16."
2018 :type '(choice (const 8) (const 10) (const 16))
2019 :group 'editing-basics)
2021 (defconst read-key-empty-map (make-sparse-keymap))
2023 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2025 (defun read-key (&optional prompt)
2026 "Read a key from the keyboard.
2027 Contrary to `read-event' this will not return a raw event but instead will
2028 obey the input decoding and translations usually done by `read-key-sequence'.
2029 So escape sequences and keyboard encoding are taken into account.
2030 When there's an ambiguity because the key looks like the prefix of
2031 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2032 ;; This overriding-terminal-local-map binding also happens to
2033 ;; disable quail's input methods, so although read-key-sequence
2034 ;; always inherits the input method, in practice read-key does not
2035 ;; inherit the input method (at least not if it's based on quail).
2036 (let ((overriding-terminal-local-map read-key-empty-map)
2037 (overriding-local-map nil)
2039 (old-global-map (current-global-map))
2040 (timer (run-with-idle-timer
2041 ;; Wait long enough that Emacs has the time to receive and
2042 ;; process all the raw events associated with the single-key.
2043 ;; But don't wait too long, or the user may find the delay
2044 ;; annoying (or keep hitting more keys which may then get
2045 ;; lost or misinterpreted).
2046 ;; This is only relevant for keys which Emacs perceives as
2047 ;; "prefixes", such as C-x (because of the C-x 8 map in
2048 ;; key-translate-table and the C-x @ map in function-key-map)
2049 ;; or ESC (because of terminal escape sequences in
2050 ;; input-decode-map).
2053 (let ((keys (this-command-keys-vector)))
2054 (unless (zerop (length keys))
2055 ;; `keys' is non-empty, so the user has hit at least
2056 ;; one key; there's no point waiting any longer, even
2057 ;; though read-key-sequence thinks we should wait
2058 ;; for more input to decide how to interpret the
2060 (throw 'read-key keys)))))))
2064 (let ((map (make-sparse-keymap)))
2065 ;; Don't hide the menu-bar and tool-bar entries.
2066 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2067 (define-key map [tool-bar]
2068 ;; This hack avoids evaluating the :filter (Bug#9922).
2069 (or (cdr (assq 'tool-bar global-map))
2070 (lookup-key global-map [tool-bar])))
2072 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
2073 (cancel-timer timer)
2074 (use-global-map old-global-map))))
2076 (defun read-quoted-char (&optional prompt)
2077 "Like `read-char', but do not allow quitting.
2078 Also, if the first character read is an octal digit,
2079 we read any number of octal digits and return the
2080 specified character code. Any nondigit terminates the sequence.
2081 If the terminator is RET, it is discarded;
2082 any other terminator is used itself as input.
2084 The optional argument PROMPT specifies a string to use to prompt the user.
2085 The variable `read-quoted-char-radix' controls which radix to use
2087 (let ((message-log-max nil) done (first t) (code 0) char translated)
2089 (let ((inhibit-quit first)
2090 ;; Don't let C-h get the help message--only help function keys.
2093 "Type the special character you want to use,
2094 or the octal character code.
2095 RET terminates the character code and is discarded;
2096 any other non-digit terminates the character code and is then used as input."))
2097 (setq char (read-event (and prompt (format "%s-" prompt)) t))
2098 (if inhibit-quit (setq quit-flag nil)))
2099 ;; Translate TAB key into control-I ASCII character, and so on.
2100 ;; Note: `read-char' does it using the `ascii-character' property.
2101 ;; We should try and use read-key instead.
2102 (let ((translation (lookup-key local-function-key-map (vector char))))
2103 (setq translated (if (arrayp translation)
2104 (aref translation 0)
2106 (if (integerp translated)
2107 (setq translated (char-resolve-modifiers translated)))
2108 (cond ((null translated))
2109 ((not (integerp translated))
2110 (setq unread-command-events (list char)
2112 ((/= (logand translated ?\M-\^@) 0)
2113 ;; Turn a meta-character into a character with the 0200 bit set.
2114 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
2116 ((and (<= ?0 translated)
2117 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
2118 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
2119 (and prompt (setq prompt (message "%s %c" prompt translated))))
2120 ((and (<= ?a (downcase translated))
2121 (< (downcase translated)
2122 (+ ?a -10 (min 36 read-quoted-char-radix))))
2123 (setq code (+ (* code read-quoted-char-radix)
2124 (+ 10 (- (downcase translated) ?a))))
2125 (and prompt (setq prompt (message "%s %c" prompt translated))))
2126 ((and (not first) (eq translated ?\C-m))
2129 (setq unread-command-events (list char)
2131 (t (setq code translated
2136 (defvar read-passwd-map
2137 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2138 ;; minibuffer-local-map along the way!
2139 (let ((map (make-sparse-keymap)))
2140 (set-keymap-parent map minibuffer-local-map)
2141 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2143 "Keymap used while reading passwords.")
2145 (defun read-passwd (prompt &optional confirm default)
2146 "Read a password, prompting with PROMPT, and return it.
2147 If optional CONFIRM is non-nil, read the password twice to make sure.
2148 Optional DEFAULT is a default password to use instead of empty input.
2150 This function echoes `.' for each character that the user types.
2152 Once the caller uses the password, it can erase the password
2153 by doing (clear-string STRING)."
2156 (while (not success)
2157 (let ((first (read-passwd prompt nil default))
2158 (second (read-passwd "Confirm password: " nil default)))
2159 (if (equal first second)
2161 (and (arrayp second) (clear-string second))
2162 (setq success first))
2163 (and (arrayp first) (clear-string first))
2164 (and (arrayp second) (clear-string second))
2165 (message "Password not repeated accurately; please start over")
2168 (let ((hide-chars-fun
2169 (lambda (beg end _len)
2170 (clear-this-command-keys)
2171 (setq beg (min end (max (minibuffer-prompt-end)
2173 (dotimes (i (- end beg))
2174 (put-text-property (+ i beg) (+ 1 i beg)
2175 'display (string ?.)))))
2177 (minibuffer-with-setup-hook
2179 (setq minibuf (current-buffer))
2180 ;; Turn off electricity.
2181 (setq-local post-self-insert-hook nil)
2182 (setq-local buffer-undo-list t)
2183 (setq-local select-active-regions nil)
2184 (use-local-map read-passwd-map)
2185 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2187 (let ((enable-recursive-minibuffers t))
2188 (read-string prompt nil t default)) ; t = "no history"
2189 (when (buffer-live-p minibuf)
2190 (with-current-buffer minibuf
2191 ;; Not sure why but it seems that there might be cases where the
2192 ;; minibuffer is not always properly reset later on, so undo
2193 ;; whatever we've done here (bug#11392).
2194 (remove-hook 'after-change-functions hide-chars-fun 'local)
2195 (kill-local-variable 'post-self-insert-hook)
2196 ;; And of course, don't keep the sensitive data around.
2197 (erase-buffer))))))))
2199 ;; This should be used by `call-interactively' for `n' specs.
2200 (defun read-number (prompt &optional default)
2201 "Read a numeric value in the minibuffer, prompting with PROMPT.
2202 DEFAULT specifies a default value to return if the user just types RET.
2203 The value of DEFAULT is inserted into PROMPT."
2205 (default1 (if (consp default) (car default) default)))
2208 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2209 (replace-match (format " (default %s)" default1) t t prompt 1)
2210 (replace-regexp-in-string "[ \t]*\\'"
2211 (format " (default %s) " default1)
2215 (let ((str (read-from-minibuffer
2216 prompt nil nil nil nil
2219 (mapcar 'number-to-string (delq nil default))
2220 (number-to-string default))))))
2223 ((zerop (length str)) default1)
2224 ((stringp str) (string-to-number str))))
2227 (message "Please enter a number.")
2232 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2233 "Read and return one of CHARS, prompting for PROMPT.
2234 Any input that is not one of CHARS is ignored.
2236 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2237 keyboard-quit events while waiting for a valid input."
2238 (unless (consp chars)
2239 (error "Called `read-char-choice' without valid char choices"))
2240 (let (char done show-help (helpbuf " *Char Help*"))
2241 (let ((cursor-in-echo-area t)
2242 (executing-kbd-macro executing-kbd-macro)
2244 (save-window-excursion ; in case we call help-form-show
2246 (unless (get-text-property 0 'face prompt)
2247 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2248 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2250 (and show-help (buffer-live-p (get-buffer helpbuf))
2251 (kill-buffer helpbuf))
2253 ((not (numberp char)))
2254 ;; If caller has set help-form, that's enough.
2255 ;; They don't explicitly have to add help-char to chars.
2262 ((and executing-kbd-macro (= char -1))
2263 ;; read-event returns -1 if we are in a kbd macro and
2264 ;; there are no more events in the macro. Attempt to
2265 ;; get an event interactively.
2266 (setq executing-kbd-macro nil))
2267 ((not inhibit-keyboard-quit)
2269 ((and (null esc-flag) (eq char ?\e))
2271 ((memq char '(?\C-g ?\e))
2272 (keyboard-quit))))))))
2273 ;; Display the question with the answer. But without cursor-in-echo-area.
2274 (message "%s%s" prompt (char-to-string char))
2277 (defun sit-for (seconds &optional nodisp obsolete)
2278 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2279 SECONDS may be a floating-point value.
2280 \(On operating systems that do not support waiting for fractions of a
2281 second, floating-point values are rounded down to the nearest integer.)
2283 If optional arg NODISP is t, don't redisplay, just wait for input.
2284 Redisplay does not happen if input is available before it starts.
2286 Value is t if waited the full time with no input arriving, and nil otherwise.
2288 An obsolete, but still supported form is
2289 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2290 where the optional arg MILLISECONDS specifies an additional wait period,
2291 in milliseconds; this was useful when Emacs was built without
2292 floating point support."
2293 (if (numberp nodisp)
2294 (setq seconds (+ seconds (* 1e-3 nodisp))
2296 (if obsolete (setq nodisp obsolete)))
2304 (or nodisp (redisplay)))
2306 (or nodisp (redisplay))
2307 (let ((read (read-event nil nil seconds)))
2310 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2311 ;; unread-command-events as (t . EVENT) so it will be added to
2312 ;; this-command-keys by read-key-sequence.
2313 (if (eq overriding-terminal-local-map universal-argument-map)
2314 (setq read (cons t read)))
2315 (push read unread-command-events)
2317 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2319 (defun y-or-n-p (prompt)
2320 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2321 PROMPT is the string to display to ask the question. It should
2322 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2324 No confirmation of the answer is requested; a single character is
2325 enough. SPC also means yes, and DEL means no.
2327 To be precise, this function translates user input into responses
2328 by consulting the bindings in `query-replace-map'; see the
2329 documentation of that variable for more information. In this
2330 case, the useful bindings are `act', `skip', `recenter',
2331 `scroll-up', `scroll-down', and `quit'.
2332 An `act' response means yes, and a `skip' response means no.
2333 A `quit' response means to invoke `keyboard-quit'.
2334 If the user enters `recenter', `scroll-up', or `scroll-down'
2335 responses, perform the requested window recentering or scrolling
2338 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2339 is nil and `use-dialog-box' is non-nil."
2340 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2341 ;; where all the keys were unbound (i.e. it somehow got triggered
2342 ;; within read-key, apparently). I had to kill it.
2343 (let ((answer 'recenter))
2346 (setq prompt (concat prompt
2347 (if (eq ?\s (aref prompt (1- (length prompt))))
2350 (let ((temp-prompt prompt))
2351 (while (not (memq answer '(act skip)))
2352 (let ((str (read-string temp-prompt)))
2353 (cond ((member str '("y" "Y")) (setq answer 'act))
2354 ((member str '("n" "N")) (setq answer 'skip))
2355 (t (setq temp-prompt (concat "Please answer y or n. "
2357 ((and (display-popup-menus-p)
2358 (listp last-nonmenu-event)
2361 (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2363 (setq prompt (concat prompt
2364 (if (eq ?\s (aref prompt (1- (length prompt))))
2368 (let* ((scroll-actions '(recenter scroll-up scroll-down
2369 scroll-other-window scroll-other-window-down))
2371 (let ((cursor-in-echo-area t))
2372 (when minibuffer-auto-raise
2373 (raise-frame (window-frame (minibuffer-window))))
2374 (read-key (propertize (if (memq answer scroll-actions)
2376 (concat "Please answer y or n. "
2378 'face 'minibuffer-prompt)))))
2379 (setq answer (lookup-key query-replace-map (vector key) t))
2381 ((memq answer '(skip act)) nil)
2382 ((eq answer 'recenter)
2384 ((eq answer 'scroll-up)
2385 (ignore-errors (scroll-up-command)) t)
2386 ((eq answer 'scroll-down)
2387 (ignore-errors (scroll-down-command)) t)
2388 ((eq answer 'scroll-other-window)
2389 (ignore-errors (scroll-other-window)) t)
2390 ((eq answer 'scroll-other-window-down)
2391 (ignore-errors (scroll-other-window-down)) t)
2392 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2393 (signal 'quit nil) t)
2397 (let ((ret (eq answer 'act)))
2398 (unless noninteractive
2399 ;; FIXME this prints one too many spaces, since prompt
2400 ;; already ends in a space. Eg "... (y or n) y".
2401 (message "%s %s" prompt (if ret "y" "n")))
2405 ;;; Atomic change groups.
2407 (defmacro atomic-change-group (&rest body)
2408 "Perform BODY as an atomic change group.
2409 This means that if BODY exits abnormally,
2410 all of its changes to the current buffer are undone.
2411 This works regardless of whether undo is enabled in the buffer.
2413 This mechanism is transparent to ordinary use of undo;
2414 if undo is enabled in the buffer and BODY succeeds, the
2415 user can undo the change normally."
2416 (declare (indent 0) (debug t))
2417 (let ((handle (make-symbol "--change-group-handle--"))
2418 (success (make-symbol "--change-group-success--")))
2419 `(let ((,handle (prepare-change-group))
2420 ;; Don't truncate any undo data in the middle of this.
2421 (undo-outer-limit nil)
2422 (undo-limit most-positive-fixnum)
2423 (undo-strong-limit most-positive-fixnum)
2427 ;; This is inside the unwind-protect because
2428 ;; it enables undo if that was disabled; we need
2429 ;; to make sure that it gets disabled again.
2430 (activate-change-group ,handle)
2433 ;; Either of these functions will disable undo
2434 ;; if it was disabled before.
2436 (accept-change-group ,handle)
2437 (cancel-change-group ,handle))))))
2439 (defun prepare-change-group (&optional buffer)
2440 "Return a handle for the current buffer's state, for a change group.
2441 If you specify BUFFER, make a handle for BUFFER's state instead.
2443 Pass the handle to `activate-change-group' afterward to initiate
2444 the actual changes of the change group.
2446 To finish the change group, call either `accept-change-group' or
2447 `cancel-change-group' passing the same handle as argument. Call
2448 `accept-change-group' to accept the changes in the group as final;
2449 call `cancel-change-group' to undo them all. You should use
2450 `unwind-protect' to make sure the group is always finished. The call
2451 to `activate-change-group' should be inside the `unwind-protect'.
2452 Once you finish the group, don't use the handle again--don't try to
2453 finish the same group twice. For a simple example of correct use, see
2454 the source code of `atomic-change-group'.
2456 The handle records only the specified buffer. To make a multibuffer
2457 change group, call this function once for each buffer you want to
2458 cover, then use `nconc' to combine the returned values, like this:
2460 (nconc (prepare-change-group buffer-1)
2461 (prepare-change-group buffer-2))
2463 You can then activate that multibuffer change group with a single
2464 call to `activate-change-group' and finish it with a single call
2465 to `accept-change-group' or `cancel-change-group'."
2468 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2469 (list (cons (current-buffer) buffer-undo-list))))
2471 (defun activate-change-group (handle)
2472 "Activate a change group made with `prepare-change-group' (which see)."
2473 (dolist (elt handle)
2474 (with-current-buffer (car elt)
2475 (if (eq buffer-undo-list t)
2476 (setq buffer-undo-list nil)))))
2478 (defun accept-change-group (handle)
2479 "Finish a change group made with `prepare-change-group' (which see).
2480 This finishes the change group by accepting its changes as final."
2481 (dolist (elt handle)
2482 (with-current-buffer (car elt)
2483 (if (eq (cdr elt) t)
2484 (setq buffer-undo-list t)))))
2486 (defun cancel-change-group (handle)
2487 "Finish a change group made with `prepare-change-group' (which see).
2488 This finishes the change group by reverting all of its changes."
2489 (dolist (elt handle)
2490 (with-current-buffer (car elt)
2491 (setq elt (cdr elt))
2493 ;; Widen buffer temporarily so if the buffer was narrowed within
2494 ;; the body of `atomic-change-group' all changes can be undone.
2497 (if (consp elt) (car elt)))
2499 (if (consp elt) (cdr elt))))
2500 ;; Temporarily truncate the undo log at ELT.
2502 (setcar elt nil) (setcdr elt nil))
2503 (unless (eq last-command 'undo) (undo-start))
2504 ;; Make sure there's no confusion.
2505 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2506 (error "Undoing to some unrelated state"))
2509 (while (listp pending-undo-list) (undo-more 1)))
2510 ;; Reset the modified cons cell ELT to its original content.
2512 (setcar elt old-car)
2513 (setcdr elt old-cdr))
2514 ;; Revert the undo info to what it was when we grabbed the state.
2515 (setq buffer-undo-list elt))))))
2517 ;;;; Display-related functions.
2519 ;; For compatibility.
2520 (define-obsolete-function-alias 'redraw-modeline
2521 'force-mode-line-update "24.3")
2523 (defun force-mode-line-update (&optional all)
2524 "Force redisplay of the current buffer's mode line and header line.
2525 With optional non-nil ALL, force redisplay of all mode lines and
2526 header lines. This function also forces recomputation of the
2527 menu bar menus and the frame title."
2528 (if all (with-current-buffer (other-buffer)))
2529 (set-buffer-modified-p (buffer-modified-p)))
2531 (defun momentary-string-display (string pos &optional exit-char message)
2532 "Momentarily display STRING in the buffer at POS.
2533 Display remains until next event is input.
2534 If POS is a marker, only its position is used; its buffer is ignored.
2535 Optional third arg EXIT-CHAR can be a character, event or event
2536 description list. EXIT-CHAR defaults to SPC. If the input is
2537 EXIT-CHAR it is swallowed; otherwise it is then available as
2538 input (as a command if nothing else).
2539 Display MESSAGE (optional fourth arg) in the echo area.
2540 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2541 (or exit-char (setq exit-char ?\s))
2542 (let ((ol (make-overlay pos pos))
2543 (str (copy-sequence string)))
2547 (overlay-put ol 'after-string str)
2549 ;; To avoid trouble with out-of-bounds position
2551 ;; If the string end is off screen, recenter now.
2552 (if (<= (window-end nil t) pos)
2553 (recenter (/ (window-height) 2))))
2554 (message (or message "Type %s to continue editing.")
2555 (single-key-description exit-char))
2556 (let ((event (read-event)))
2557 ;; `exit-char' can be an event, or an event description list.
2558 (or (eq event exit-char)
2559 (eq event (event-convert-list exit-char))
2560 (setq unread-command-events (list event)))))
2561 (delete-overlay ol))))
2564 ;;;; Overlay operations
2566 (defun copy-overlay (o)
2567 "Return a copy of overlay O."
2568 (let ((o1 (if (overlay-buffer o)
2569 (make-overlay (overlay-start o) (overlay-end o)
2570 ;; FIXME: there's no easy way to find the
2571 ;; insertion-type of the two markers.
2573 (let ((o1 (make-overlay (point-min) (point-min))))
2576 (props (overlay-properties o)))
2578 (overlay-put o1 (pop props) (pop props)))
2581 (defun remove-overlays (&optional beg end name val)
2582 "Clear BEG and END of overlays whose property NAME has value VAL.
2583 Overlays might be moved and/or split.
2584 BEG and END default respectively to the beginning and end of buffer."
2585 ;; This speeds up the loops over overlays.
2586 (unless beg (setq beg (point-min)))
2587 (unless end (setq end (point-max)))
2588 (overlay-recenter end)
2590 (setq beg (prog1 end (setq end beg))))
2592 (dolist (o (overlays-in beg end))
2593 (when (eq (overlay-get o name) val)
2594 ;; Either push this overlay outside beg...end
2595 ;; or split it to exclude beg...end
2596 ;; or delete it entirely (if it is contained in beg...end).
2597 (if (< (overlay-start o) beg)
2598 (if (> (overlay-end o) end)
2600 (move-overlay (copy-overlay o)
2601 (overlay-start o) beg)
2602 (move-overlay o end (overlay-end o)))
2603 (move-overlay o (overlay-start o) beg))
2604 (if (> (overlay-end o) end)
2605 (move-overlay o end (overlay-end o))
2606 (delete-overlay o)))))))
2610 (defvar suspend-hook nil
2611 "Normal hook run by `suspend-emacs', before suspending.")
2613 (defvar suspend-resume-hook nil
2614 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2616 (defvar temp-buffer-show-hook nil
2617 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2618 When the hook runs, the temporary buffer is current, and the window it
2619 was displayed in is selected.")
2621 (defvar temp-buffer-setup-hook nil
2622 "Normal hook run by `with-output-to-temp-buffer' at the start.
2623 When the hook runs, the temporary buffer is current.
2624 This hook is normally set up with a function to put the buffer in Help
2627 ;; Avoid compiler warnings about this variable,
2628 ;; which has a special meaning on certain system types.
2629 (defvar buffer-file-type nil
2630 "Non-nil if the visited file is a binary file.
2631 This variable is meaningful on MS-DOG and Windows NT.
2632 On those systems, it is automatically local in every buffer.
2633 On other systems, this variable is normally always nil.")
2635 ;; The `assert' macro from the cl package signals
2636 ;; `cl-assertion-failed' at runtime so always define it.
2637 (put 'cl-assertion-failed 'error-conditions '(error))
2638 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2640 (defconst user-emacs-directory
2641 (if (eq system-type 'ms-dos)
2642 ;; MS-DOS cannot have initial dot.
2645 "Directory beneath which additional per-user Emacs-specific files are placed.
2646 Various programs in Emacs store information in this directory.
2647 Note that this should end with a directory separator.
2648 See also `locate-user-emacs-file'.")
2650 (defun locate-user-emacs-file (new-name &optional old-name)
2651 "Return an absolute per-user Emacs-specific file name.
2652 If NEW-NAME exists in `user-emacs-directory', return it.
2653 Else If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2654 Else return NEW-NAME in `user-emacs-directory', creating the
2655 directory if it does not exist."
2656 (convert-standard-filename
2657 (let* ((home (concat "~" (or init-file-user "")))
2658 (at-home (and old-name (expand-file-name old-name home)))
2659 (bestname (abbreviate-file-name
2660 (expand-file-name new-name user-emacs-directory))))
2661 (if (and at-home (not (file-readable-p bestname))
2662 (file-readable-p at-home))
2664 ;; Make sure `user-emacs-directory' exists,
2665 ;; unless we're in batch mode or dumping Emacs
2668 (file-accessible-directory-p
2669 (directory-file-name user-emacs-directory))
2670 (let ((umask (default-file-modes)))
2673 (set-default-file-modes ?\700)
2674 (make-directory user-emacs-directory))
2675 (set-default-file-modes umask))))
2678 ;;;; Misc. useful functions.
2680 (defsubst buffer-narrowed-p ()
2681 "Return non-nil if the current buffer is narrowed."
2682 (/= (- (point-max) (point-min)) (buffer-size)))
2684 (defun find-tag-default ()
2685 "Determine default tag to search for, based on text at point.
2686 If there is no plausible default, return nil."
2687 (let (from to bound)
2689 ;; Look at text around `point'.
2691 (skip-syntax-backward "w_") (setq from (point)))
2693 (skip-syntax-forward "w_") (setq to (point)))
2695 ;; Look between `line-beginning-position' and `point'.
2697 (and (setq bound (line-beginning-position))
2698 (skip-syntax-backward "^w_" bound)
2699 (> (setq to (point)) bound)
2700 (skip-syntax-backward "w_")
2701 (setq from (point))))
2702 ;; Look between `point' and `line-end-position'.
2704 (and (setq bound (line-end-position))
2705 (skip-syntax-forward "^w_" bound)
2706 (< (setq from (point)) bound)
2707 (skip-syntax-forward "w_")
2708 (setq to (point)))))
2709 (buffer-substring-no-properties from to))))
2711 (defun play-sound (sound)
2712 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2713 The following keywords are recognized:
2715 :file FILE - read sound data from FILE. If FILE isn't an
2716 absolute file name, it is searched in `data-directory'.
2718 :data DATA - read sound data from string DATA.
2720 Exactly one of :file or :data must be present.
2722 :volume VOL - set volume to VOL. VOL must an integer in the
2723 range 0..100 or a float in the range 0..1.0. If not specified,
2724 don't change the volume setting of the sound device.
2726 :device DEVICE - play sound on DEVICE. If not specified,
2727 a system-dependent default device name is used.
2729 Note: :data and :device are currently not supported on Windows."
2730 (if (fboundp 'play-sound-internal)
2731 (play-sound-internal sound)
2732 (error "This Emacs binary lacks sound support")))
2734 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2736 (defun shell-quote-argument (argument)
2737 "Quote ARGUMENT for passing as argument to an inferior shell."
2739 ((eq system-type 'ms-dos)
2740 ;; Quote using double quotes, but escape any existing quotes in
2741 ;; the argument with backslashes.
2745 (if (or (null (string-match "[^\"]" argument))
2746 (< (match-end 0) (length argument)))
2747 (while (string-match "[\"]" argument start)
2748 (setq end (match-beginning 0)
2749 result (concat result (substring argument start end)
2750 "\\" (substring argument end (1+ end)))
2752 (concat "\"" result (substring argument start) "\"")))
2754 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2756 ;; First, quote argument so that CommandLineToArgvW will
2757 ;; understand it. See
2758 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2759 ;; After we perform that level of quoting, escape shell
2760 ;; metacharacters so that cmd won't mangle our argument. If the
2761 ;; argument contains no double quote characters, we can just
2762 ;; surround it with double quotes. Otherwise, we need to prefix
2763 ;; each shell metacharacter with a caret.
2766 ;; escape backslashes at end of string
2767 (replace-regexp-in-string
2770 ;; escape backslashes and quotes in string body
2771 (replace-regexp-in-string
2776 (if (string-match "[%!\"]" argument)
2779 (replace-regexp-in-string
2780 "\\([%!()\"<>&|^]\\)"
2784 (concat "\"" argument "\"")))
2787 (if (equal argument "")
2789 ;; Quote everything except POSIX filename characters.
2790 ;; This should be safe enough even for really weird shells.
2791 (replace-regexp-in-string
2793 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2796 (defun string-or-null-p (object)
2797 "Return t if OBJECT is a string or nil.
2798 Otherwise, return nil."
2799 (or (stringp object) (null object)))
2801 (defun booleanp (object)
2802 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2803 Otherwise, return nil."
2804 (and (memq object '(nil t)) t))
2806 (defun special-form-p (object)
2807 "Non-nil if and only if OBJECT is a special form."
2808 (if (and (symbolp object) (fboundp object))
2809 (setq object (indirect-function object)))
2810 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2812 (defun field-at-pos (pos)
2813 "Return the field at position POS, taking stickiness etc into account."
2814 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2815 (if (eq raw-field 'boundary)
2816 (get-char-property (1- (field-end pos)) 'field)
2819 (defun sha1 (object &optional start end binary)
2820 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2821 OBJECT is either a string or a buffer. Optional arguments START and
2822 END are character positions specifying which portion of OBJECT for
2823 computing the hash. If BINARY is non-nil, return a string in binary
2825 (secure-hash 'sha1 object start end binary))
2827 (defun function-get (f prop &optional autoload)
2828 "Return the value of property PROP of function F.
2829 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2830 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2831 if it's an autoloaded macro."
2833 (while (and (symbolp f)
2834 (null (setq val (get f prop)))
2836 (let ((fundef (symbol-function f)))
2837 (if (and autoload (autoloadp fundef)
2839 (autoload-do-load fundef f
2840 (if (eq autoload 'macro)
2842 nil ;Re-try `get' on the same `f'.
2846 ;;;; Support for yanking and text properties.
2848 (defvar yank-handled-properties)
2849 (defvar yank-excluded-properties)
2851 (defun remove-yank-excluded-properties (start end)
2852 "Process text properties between START and END, inserted for a `yank'.
2853 Perform the handling specified by `yank-handled-properties', then
2854 remove properties specified by `yank-excluded-properties'."
2855 (let ((inhibit-read-only t))
2856 (dolist (handler yank-handled-properties)
2857 (let ((prop (car handler))
2860 (while (< run-start end)
2861 (let ((value (get-text-property run-start prop))
2862 (run-end (next-single-property-change
2863 run-start prop nil end)))
2864 (funcall fun value run-start run-end)
2865 (setq run-start run-end)))))
2866 (if (eq yank-excluded-properties t)
2867 (set-text-properties start end nil)
2868 (remove-list-of-text-properties start end yank-excluded-properties))))
2870 (defvar yank-undo-function)
2872 (defun insert-for-yank (string)
2873 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2875 See `insert-for-yank-1' for more details."
2877 (while (setq to (next-single-property-change 0 'yank-handler string))
2878 (insert-for-yank-1 (substring string 0 to))
2879 (setq string (substring string to))))
2880 (insert-for-yank-1 string))
2882 (defun insert-for-yank-1 (string)
2883 "Insert STRING at point for the `yank' command.
2884 This function is like `insert', except it honors the variables
2885 `yank-handled-properties' and `yank-excluded-properties', and the
2886 `yank-handler' text property.
2888 Properties listed in `yank-handled-properties' are processed,
2889 then those listed in `yank-excluded-properties' are discarded.
2891 If STRING has a non-nil `yank-handler' property on its first
2892 character, the normal insert behavior is altered. The value of
2893 the `yank-handler' property must be a list of one to four
2894 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2895 FUNCTION, if non-nil, should be a function of one argument, an
2896 object to insert; it is called instead of `insert'.
2897 PARAM, if present and non-nil, replaces STRING as the argument to
2898 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2899 may be a list of strings to insert as a rectangle.
2900 If NOEXCLUDE is present and non-nil, the normal removal of
2901 `yank-excluded-properties' is not performed; instead FUNCTION is
2902 responsible for the removal. This may be necessary if FUNCTION
2903 adjusts point before or after inserting the object.
2904 UNDO, if present and non-nil, should be a function to be called
2905 by `yank-pop' to undo the insertion of the current object. It is
2906 given two arguments, the start and end of the region. FUNCTION
2907 may set `yank-undo-function' to override UNDO."
2908 (let* ((handler (and (stringp string)
2909 (get-text-property 0 'yank-handler string)))
2910 (param (or (nth 1 handler) string))
2912 (inhibit-read-only inhibit-read-only)
2915 (setq yank-undo-function t)
2916 (if (nth 0 handler) ; FUNCTION
2917 (funcall (car handler) param)
2921 ;; Prevent read-only properties from interfering with the
2922 ;; following text property changes.
2923 (setq inhibit-read-only t)
2925 (unless (nth 2 handler) ; NOEXCLUDE
2926 (remove-yank-excluded-properties opoint end))
2928 ;; If last inserted char has properties, mark them as rear-nonsticky.
2929 (if (and (> end opoint)
2930 (text-properties-at (1- end)))
2931 (put-text-property (1- end) end 'rear-nonsticky t))
2933 (if (eq yank-undo-function t) ; not set by FUNCTION
2934 (setq yank-undo-function (nth 3 handler))) ; UNDO
2935 (if (nth 4 handler) ; COMMAND
2936 (setq this-command (nth 4 handler)))))
2938 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2939 "Insert before point a substring of BUFFER, without text properties.
2940 BUFFER may be a buffer or a buffer name.
2941 Arguments START and END are character positions specifying the substring.
2942 They default to the values of (point-min) and (point-max) in BUFFER."
2943 (let ((opoint (point)))
2944 (insert-buffer-substring buffer start end)
2945 (let ((inhibit-read-only t))
2946 (set-text-properties opoint (point) nil))))
2948 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2949 "Insert before point a part of BUFFER, stripping some 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 Before insertion, process text properties according to
2954 `yank-handled-properties' and `yank-excluded-properties'."
2955 ;; Since the buffer text should not normally have yank-handler properties,
2956 ;; there is no need to handle them here.
2957 (let ((opoint (point)))
2958 (insert-buffer-substring buffer start end)
2959 (remove-yank-excluded-properties opoint (point))))
2961 (defun yank-handle-font-lock-face-property (face start end)
2962 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2963 START and END denote the start and end of the text to act on.
2964 Do nothing if FACE is nil."
2966 (null font-lock-defaults)
2967 (put-text-property start end 'face face)))
2969 ;; This removes `mouse-face' properties in *Help* buffer buttons:
2970 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2971 (defun yank-handle-category-property (category start end)
2972 "Apply property category CATEGORY's properties between START and END."
2974 (let ((start2 start))
2975 (while (< start2 end)
2976 (let ((end2 (next-property-change start2 nil end))
2977 (original (text-properties-at start2)))
2978 (set-text-properties start2 end2 (symbol-plist category))
2979 (add-text-properties start2 end2 original)
2980 (setq start2 end2))))))
2983 ;;;; Synchronous shell commands.
2985 (defun start-process-shell-command (name buffer &rest args)
2986 "Start a program in a subprocess. Return the process object for it.
2987 NAME is name for process. It is modified if necessary to make it unique.
2988 BUFFER is the buffer (or buffer name) to associate with the process.
2989 Process output goes at end of that buffer, unless you specify
2990 an output stream or filter function to handle the output.
2991 BUFFER may be also nil, meaning that this process is not associated
2993 COMMAND is the shell command to run.
2995 An old calling convention accepted any number of arguments after COMMAND,
2996 which were just concatenated to COMMAND. This is still supported but strongly
2998 ;; We used to use `exec' to replace the shell with the command,
2999 ;; but that failed to handle (...) and semicolon, etc.
3000 (start-process name buffer shell-file-name shell-command-switch
3001 (mapconcat 'identity args " ")))
3002 (set-advertised-calling-convention 'start-process-shell-command
3003 '(name buffer command) "23.1")
3005 (defun start-file-process-shell-command (name buffer &rest args)
3006 "Start a program in a subprocess. Return the process object for it.
3007 Similar to `start-process-shell-command', but calls `start-file-process'."
3010 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3011 (if (file-remote-p default-directory) "-c" shell-command-switch)
3012 (mapconcat 'identity args " ")))
3013 (set-advertised-calling-convention 'start-file-process-shell-command
3014 '(name buffer command) "23.1")
3016 (defun call-process-shell-command (command &optional infile buffer display
3018 "Execute the shell command COMMAND synchronously in separate process.
3019 The remaining arguments are optional.
3020 The program's input comes from file INFILE (nil means `/dev/null').
3021 Insert output in BUFFER before point; t means current buffer;
3022 nil for BUFFER means discard it; 0 means discard and don't wait.
3023 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3024 REAL-BUFFER says what to do with standard output, as above,
3025 while STDERR-FILE says what to do with standard error in the child.
3026 STDERR-FILE may be nil (discard standard error output),
3027 t (mix it with ordinary output), or a file name string.
3029 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
3030 Remaining arguments are strings passed as additional arguments for COMMAND.
3031 Wildcards and redirection are handled as usual in the shell.
3033 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
3034 Otherwise it waits for COMMAND to terminate and returns a numeric exit
3035 status or a signal description string.
3036 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
3037 ;; We used to use `exec' to replace the shell with the command,
3038 ;; but that failed to handle (...) and semicolon, etc.
3039 (call-process shell-file-name
3040 infile buffer display
3041 shell-command-switch
3042 (mapconcat 'identity (cons command args) " ")))
3044 (defun process-file-shell-command (command &optional infile buffer display
3046 "Process files synchronously in a separate process.
3047 Similar to `call-process-shell-command', but calls `process-file'."
3049 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3050 infile buffer display
3051 (if (file-remote-p default-directory) "-c" shell-command-switch)
3052 (mapconcat 'identity (cons command args) " ")))
3054 ;;;; Lisp macros to do various things temporarily.
3056 (defmacro with-current-buffer (buffer-or-name &rest body)
3057 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3058 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3059 The value returned is the value of the last form in BODY. See
3060 also `with-temp-buffer'."
3061 (declare (indent 1) (debug t))
3062 `(save-current-buffer
3063 (set-buffer ,buffer-or-name)
3066 (defun internal--before-with-selected-window (window)
3067 (let ((other-frame (window-frame window)))
3068 (list window (selected-window)
3069 ;; Selecting a window on another frame also changes that
3070 ;; frame's frame-selected-window. We must save&restore it.
3071 (unless (eq (selected-frame) other-frame)
3072 (frame-selected-window other-frame))
3073 ;; Also remember the top-frame if on ttys.
3074 (unless (eq (selected-frame) other-frame)
3075 (tty-top-frame other-frame)))))
3077 (defun internal--after-with-selected-window (state)
3078 ;; First reset frame-selected-window.
3079 (when (window-live-p (nth 2 state))
3080 ;; We don't use set-frame-selected-window because it does not
3081 ;; pass the `norecord' argument to Fselect_window.
3082 (select-window (nth 2 state) 'norecord)
3083 (and (frame-live-p (nth 3 state))
3084 (not (eq (tty-top-frame) (nth 3 state)))
3085 (select-frame (nth 3 state) 'norecord)))
3086 ;; Then reset the actual selected-window.
3087 (when (window-live-p (nth 1 state))
3088 (select-window (nth 1 state) 'norecord)))
3090 (defmacro with-selected-window (window &rest body)
3091 "Execute the forms in BODY with WINDOW as the selected window.
3092 The value returned is the value of the last form in BODY.
3094 This macro saves and restores the selected window, as well as the
3095 selected window of each frame. It does not change the order of
3096 recently selected windows. If the previously selected window of
3097 some frame is no longer live at the end of BODY, that frame's
3098 selected window is left alone. If the selected window is no
3099 longer live, then whatever window is selected at the end of BODY
3102 This macro uses `save-current-buffer' to save and restore the
3103 current buffer, since otherwise its normal operation could
3104 potentially make a different buffer current. It does not alter
3105 the buffer list ordering."
3106 (declare (indent 1) (debug t))
3107 `(let ((save-selected-window--state
3108 (internal--before-with-selected-window ,window)))
3109 (save-current-buffer
3111 (progn (select-window (car save-selected-window--state) 'norecord)
3113 (internal--after-with-selected-window save-selected-window--state)))))
3115 (defmacro with-selected-frame (frame &rest body)
3116 "Execute the forms in BODY with FRAME as the selected frame.
3117 The value returned is the value of the last form in BODY.
3119 This macro saves and restores the selected frame, and changes the
3120 order of neither the recently selected windows nor the buffers in
3122 (declare (indent 1) (debug t))
3123 (let ((old-frame (make-symbol "old-frame"))
3124 (old-buffer (make-symbol "old-buffer")))
3125 `(let ((,old-frame (selected-frame))
3126 (,old-buffer (current-buffer)))
3128 (progn (select-frame ,frame 'norecord)
3130 (when (frame-live-p ,old-frame)
3131 (select-frame ,old-frame 'norecord))
3132 (when (buffer-live-p ,old-buffer)
3133 (set-buffer ,old-buffer))))))
3135 (defmacro save-window-excursion (&rest body)
3136 "Execute BODY, then restore previous window configuration.
3137 This macro saves the window configuration on the selected frame,
3138 executes BODY, then calls `set-window-configuration' to restore
3139 the saved window configuration. The return value is the last
3140 form in BODY. The window configuration is also restored if BODY
3143 BEWARE: Most uses of this macro introduce bugs.
3144 E.g. it should not be used to try and prevent some code from opening
3145 a new window, since that window may sometimes appear in another frame,
3146 in which case `save-window-excursion' cannot help."
3147 (declare (indent 0) (debug t))
3148 (let ((c (make-symbol "wconfig")))
3149 `(let ((,c (current-window-configuration)))
3150 (unwind-protect (progn ,@body)
3151 (set-window-configuration ,c)))))
3153 (defun internal-temp-output-buffer-show (buffer)
3154 "Internal function for `with-output-to-temp-buffer'."
3155 (with-current-buffer buffer
3156 (set-buffer-modified-p nil)
3157 (goto-char (point-min)))
3159 (if temp-buffer-show-function
3160 (funcall temp-buffer-show-function buffer)
3161 (with-current-buffer buffer
3163 (let ((window-combination-limit
3164 ;; When `window-combination-limit' equals
3165 ;; `temp-buffer' or `temp-buffer-resize' and
3166 ;; `temp-buffer-resize-mode' is enabled in this
3167 ;; buffer bind it to t so resizing steals space
3168 ;; preferably from the window that was split.
3169 (if (or (eq window-combination-limit 'temp-buffer)
3170 (and (eq window-combination-limit
3171 'temp-buffer-resize)
3172 temp-buffer-resize-mode))
3174 window-combination-limit)))
3175 (display-buffer buffer)))
3176 (frame (and window (window-frame window))))
3178 (unless (eq frame (selected-frame))
3179 (make-frame-visible frame))
3180 (setq minibuffer-scroll-window window)
3181 (set-window-hscroll window 0)
3182 ;; Don't try this with NOFORCE non-nil!
3183 (set-window-start window (point-min) t)
3184 ;; This should not be necessary.
3185 (set-window-point window (point-min))
3186 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3187 (with-selected-window window
3188 (run-hooks 'temp-buffer-show-hook))))))
3192 (defmacro with-output-to-temp-buffer (bufname &rest body)
3193 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3195 This construct makes buffer BUFNAME empty before running BODY.
3196 It does not make the buffer current for BODY.
3197 Instead it binds `standard-output' to that buffer, so that output
3198 generated with `prin1' and similar functions in BODY goes into
3201 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3202 it in a window, but does not select it. The normal way to do this is
3203 by calling `display-buffer', then running `temp-buffer-show-hook'.
3204 However, if `temp-buffer-show-function' is non-nil, it calls that
3205 function instead (and does not run `temp-buffer-show-hook'). The
3206 function gets one argument, the buffer to display.
3208 The return value of `with-output-to-temp-buffer' is the value of the
3209 last form in BODY. If BODY does not finish normally, the buffer
3210 BUFNAME is not displayed.
3212 This runs the hook `temp-buffer-setup-hook' before BODY,
3213 with the buffer BUFNAME temporarily current. It runs the hook
3214 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3215 buffer temporarily current, and the window that was used to display it
3216 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3217 if it uses `temp-buffer-show-function'."
3219 (let ((old-dir (make-symbol "old-dir"))
3220 (buf (make-symbol "buf")))
3221 `(let* ((,old-dir default-directory)
3223 (with-current-buffer (get-buffer-create ,bufname)
3224 (prog1 (current-buffer)
3225 (kill-all-local-variables)
3226 ;; FIXME: delete_all_overlays
3227 (setq default-directory ,old-dir)
3228 (setq buffer-read-only nil)
3229 (setq buffer-file-name nil)
3230 (setq buffer-undo-list t)
3231 (let ((inhibit-read-only t)
3232 (inhibit-modification-hooks t))
3234 (run-hooks 'temp-buffer-setup-hook)))))
3235 (standard-output ,buf))
3236 (prog1 (progn ,@body)
3237 (internal-temp-output-buffer-show ,buf)))))
3239 (defmacro with-temp-file (file &rest body)
3240 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3241 The value returned is the value of the last form in BODY.
3242 See also `with-temp-buffer'."
3243 (declare (indent 1) (debug t))
3244 (let ((temp-file (make-symbol "temp-file"))
3245 (temp-buffer (make-symbol "temp-buffer")))
3246 `(let ((,temp-file ,file)
3248 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3251 (with-current-buffer ,temp-buffer
3253 (with-current-buffer ,temp-buffer
3254 (write-region nil nil ,temp-file nil 0)))
3255 (and (buffer-name ,temp-buffer)
3256 (kill-buffer ,temp-buffer))))))
3258 (defmacro with-temp-message (message &rest body)
3259 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3260 The original message is restored to the echo area after BODY has finished.
3261 The value returned is the value of the last form in BODY.
3262 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3263 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3264 Use a MESSAGE of \"\" to temporarily clear the echo area."
3265 (declare (debug t) (indent 1))
3266 (let ((current-message (make-symbol "current-message"))
3267 (temp-message (make-symbol "with-temp-message")))
3268 `(let ((,temp-message ,message)
3273 (setq ,current-message (current-message))
3274 (message "%s" ,temp-message))
3277 (if ,current-message
3278 (message "%s" ,current-message)
3281 (defmacro with-temp-buffer (&rest body)
3282 "Create a temporary buffer, and evaluate BODY there like `progn'.
3283 See also `with-temp-file' and `with-output-to-string'."
3284 (declare (indent 0) (debug t))
3285 (let ((temp-buffer (make-symbol "temp-buffer")))
3286 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3287 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3288 (with-current-buffer ,temp-buffer
3291 (and (buffer-name ,temp-buffer)
3292 (kill-buffer ,temp-buffer)))))))
3294 (defmacro with-silent-modifications (&rest body)
3295 "Execute BODY, pretending it does not modify the buffer.
3296 If BODY performs real modifications to the buffer's text, other
3297 than cosmetic ones, undo data may become corrupted.
3299 This macro will run BODY normally, but doesn't count its buffer
3300 modifications as being buffer modifications. This affects things
3301 like buffer-modified-p, checking whether the file is locked by
3302 someone else, running buffer modification hooks, and other things
3305 Typically used around modifications of text-properties which do
3306 not really affect the buffer's content."
3307 (declare (debug t) (indent 0))
3308 (let ((modified (make-symbol "modified")))
3309 `(let* ((,modified (buffer-modified-p))
3310 (buffer-undo-list t)
3311 (inhibit-read-only t)
3312 (inhibit-modification-hooks t)
3314 ;; Avoid setting and removing file locks and checking
3315 ;; buffer's uptodate-ness w.r.t the underlying file.
3317 buffer-file-truename)
3322 (restore-buffer-modified-p nil))))))
3324 (defmacro with-output-to-string (&rest body)
3325 "Execute BODY, return the text it sent to `standard-output', as a string."
3326 (declare (indent 0) (debug t))
3327 `(let ((standard-output
3328 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3331 (let ((standard-output standard-output))
3333 (with-current-buffer standard-output
3335 (kill-buffer standard-output))))
3337 (defmacro with-local-quit (&rest body)
3338 "Execute BODY, allowing quits to terminate BODY but not escape further.
3339 When a quit terminates BODY, `with-local-quit' returns nil but
3340 requests another quit. That quit will be processed as soon as quitting
3341 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3342 (declare (debug t) (indent 0))
3343 `(condition-case nil
3344 (let ((inhibit-quit nil))
3346 (quit (setq quit-flag t)
3347 ;; This call is to give a chance to handle quit-flag
3348 ;; in case inhibit-quit is nil.
3349 ;; Without this, it will not be handled until the next function
3350 ;; call, and that might allow it to exit thru a condition-case
3351 ;; that intends to handle the quit signal next time.
3352 (eval '(ignore nil)))))
3354 (defmacro while-no-input (&rest body)
3355 "Execute BODY only as long as there's no pending input.
3356 If input arrives, that ends the execution of BODY,
3357 and `while-no-input' returns t. Quitting makes it return nil.
3358 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3359 (declare (debug t) (indent 0))
3360 (let ((catch-sym (make-symbol "input")))
3363 (let ((throw-on-input ',catch-sym))
3364 (or (input-pending-p)
3365 (progn ,@body)))))))
3367 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3368 "Like `condition-case' except that it does not catch anything when debugging.
3369 More specifically if `debug-on-error' is set, then it does not catch any signal."
3370 (declare (debug condition-case) (indent 2))
3371 (let ((bodysym (make-symbol "body")))
3372 `(let ((,bodysym (lambda () ,bodyform)))
3375 (condition-case ,var
3379 (define-obsolete-function-alias 'condition-case-no-debug
3380 'condition-case-unless-debug "24.1")
3382 (defmacro with-demoted-errors (&rest body)
3383 "Run BODY and demote any errors to simple messages.
3384 If `debug-on-error' is non-nil, run BODY without catching its errors.
3385 This is to be used around code which is not expected to signal an error
3386 but which should be robust in the unexpected case that an error is signaled."
3387 (declare (debug t) (indent 0))
3388 (let ((err (make-symbol "err")))
3389 `(condition-case-unless-debug ,err
3391 (error (message "Error: %S" ,err) nil))))
3393 (defmacro combine-after-change-calls (&rest body)
3394 "Execute BODY, but don't call the after-change functions till the end.
3395 If BODY makes changes in the buffer, they are recorded
3396 and the functions on `after-change-functions' are called several times
3397 when BODY is finished.
3398 The return value is the value of the last form in BODY.
3400 If `before-change-functions' is non-nil, then calls to the after-change
3401 functions can't be deferred, so in that case this macro has no effect.
3403 Do not alter `after-change-functions' or `before-change-functions'
3405 (declare (indent 0) (debug t))
3407 (let ((combine-after-change-calls t))
3409 (combine-after-change-execute)))
3411 (defmacro with-case-table (table &rest body)
3412 "Execute the forms in BODY with TABLE as the current case table.
3413 The value returned is the value of the last form in BODY."
3414 (declare (indent 1) (debug t))
3415 (let ((old-case-table (make-symbol "table"))
3416 (old-buffer (make-symbol "buffer")))
3417 `(let ((,old-case-table (current-case-table))
3418 (,old-buffer (current-buffer)))
3420 (progn (set-case-table ,table)
3422 (with-current-buffer ,old-buffer
3423 (set-case-table ,old-case-table))))))
3425 ;;; Matching and match data.
3427 (defvar save-match-data-internal)
3429 ;; We use save-match-data-internal as the local variable because
3430 ;; that works ok in practice (people should not use that variable elsewhere).
3431 ;; We used to use an uninterned symbol; the compiler handles that properly
3432 ;; now, but it generates slower code.
3433 (defmacro save-match-data (&rest body)
3434 "Execute the BODY forms, restoring the global value of the match data.
3435 The value returned is the value of the last form in BODY."
3436 ;; It is better not to use backquote here,
3437 ;; because that makes a bootstrapping problem
3438 ;; if you need to recompile all the Lisp files using interpreted code.
3439 (declare (indent 0) (debug t))
3441 '((save-match-data-internal (match-data)))
3442 (list 'unwind-protect
3444 ;; It is safe to free (evaporate) markers immediately here,
3445 ;; as Lisp programs should not copy from save-match-data-internal.
3446 '(set-match-data save-match-data-internal 'evaporate))))
3448 (defun match-string (num &optional string)
3449 "Return string of text matched by last search.
3450 NUM specifies which parenthesized expression in the last regexp.
3451 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3452 Zero means the entire text matched by the whole regexp or whole string.
3453 STRING should be given if the last search was by `string-match' on STRING.
3454 If STRING is nil, the current buffer should be the same buffer
3455 the search/match was performed in."
3456 (if (match-beginning num)
3458 (substring string (match-beginning num) (match-end num))
3459 (buffer-substring (match-beginning num) (match-end num)))))
3461 (defun match-string-no-properties (num &optional string)
3462 "Return string of text matched by last search, without text properties.
3463 NUM specifies which parenthesized expression in the last regexp.
3464 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3465 Zero means the entire text matched by the whole regexp or whole string.
3466 STRING should be given if the last search was by `string-match' on STRING.
3467 If STRING is nil, the current buffer should be the same buffer
3468 the search/match was performed in."
3469 (if (match-beginning num)
3471 (substring-no-properties string (match-beginning num)
3473 (buffer-substring-no-properties (match-beginning num)
3477 (defun match-substitute-replacement (replacement
3478 &optional fixedcase literal string subexp)
3479 "Return REPLACEMENT as it will be inserted by `replace-match'.
3480 In other words, all back-references in the form `\\&' and `\\N'
3481 are substituted with actual strings matched by the last search.
3482 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3483 meaning as for `replace-match'."
3484 (let ((match (match-string 0 string)))
3486 (set-match-data (mapcar (lambda (x)
3488 (- x (match-beginning 0))
3491 (replace-match replacement fixedcase literal match subexp))))
3494 (defun looking-back (regexp &optional limit greedy)
3495 "Return non-nil if text before point matches regular expression REGEXP.
3496 Like `looking-at' except matches before point, and is slower.
3497 LIMIT if non-nil speeds up the search by specifying a minimum
3498 starting position, to avoid checking matches that would start
3501 If GREEDY is non-nil, extend the match backwards as far as
3502 possible, stopping when a single additional previous character
3503 cannot be part of a match for REGEXP. When the match is
3504 extended, its starting position is allowed to occur before
3506 (let ((start (point))
3509 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3511 (if (and greedy pos)
3513 (narrow-to-region (point-min) start)
3514 (while (and (> pos (point-min))
3518 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3519 (setq pos (1- pos)))
3522 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3525 (defsubst looking-at-p (regexp)
3527 Same as `looking-at' except this function does not change the match data."
3528 (let ((inhibit-changing-match-data t))
3529 (looking-at regexp)))
3531 (defsubst string-match-p (regexp string &optional start)
3533 Same as `string-match' except this function does not change the match data."
3534 (let ((inhibit-changing-match-data t))
3535 (string-match regexp string start)))
3537 (defun subregexp-context-p (regexp pos &optional start)
3538 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3539 A subregexp context is one where a sub-regexp can appear.
3540 A non-subregexp context is for example within brackets, or within a
3541 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3542 If START is non-nil, it should be a position in REGEXP, smaller
3543 than POS, and known to be in a subregexp context."
3544 ;; Here's one possible implementation, with the great benefit that it
3545 ;; reuses the regexp-matcher's own parser, so it understands all the
3546 ;; details of the syntax. A disadvantage is that it needs to match the
3550 (string-match (substring regexp (or start 0) pos) "")
3553 (not (member (cadr err) '("Unmatched [ or [^"
3555 "Trailing backslash")))))
3556 ;; An alternative implementation:
3557 ;; (defconst re-context-re
3558 ;; (let* ((harmless-ch "[^\\[]")
3559 ;; (harmless-esc "\\\\[^{]")
3560 ;; (class-harmless-ch "[^][]")
3561 ;; (class-lb-harmless "[^]:]")
3562 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3563 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3564 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3566 ;; (concat "\\[^?]?"
3567 ;; "\\(" class-harmless-ch
3568 ;; "\\|" class-lb "\\)*"
3569 ;; "\\[?]")) ; special handling for bare [ at end of re
3570 ;; (braces "\\\\{[0-9,]+\\\\}"))
3571 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3572 ;; "\\|" class "\\|" braces "\\)*\\'"))
3573 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3574 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3579 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3580 "The default value of separators for `split-string'.
3582 A regexp matching strings of whitespace. May be locale-dependent
3583 \(as yet unimplemented). Should not match non-breaking spaces.
3585 Warning: binding this to a different value and using it as default is
3586 likely to have undesired semantics.")
3588 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3589 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3590 ;; expression leads to the equivalent implementation that if SEPARATORS
3591 ;; is defaulted, OMIT-NULLS is treated as t.
3592 (defun split-string (string &optional separators omit-nulls)
3593 "Split STRING into substrings bounded by matches for SEPARATORS.
3595 The beginning and end of STRING, and each match for SEPARATORS, are
3596 splitting points. The substrings matching SEPARATORS are removed, and
3597 the substrings between the splitting points are collected as a list,
3600 If SEPARATORS is non-nil, it should be a regular expression matching text
3601 which separates, but is not part of, the substrings. If nil it defaults to
3602 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3603 OMIT-NULLS is forced to t.
3605 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3606 that for the default value of SEPARATORS leading and trailing whitespace
3607 are effectively trimmed). If nil, all zero-length substrings are retained,
3608 which correctly parses CSV format, for example.
3610 Note that the effect of `(split-string STRING)' is the same as
3611 `(split-string STRING split-string-default-separators t)'. In the rare
3612 case that you wish to retain zero-length substrings when splitting on
3613 whitespace, use `(split-string STRING split-string-default-separators)'.
3615 Modifies the match data; use `save-match-data' if necessary."
3616 (let ((keep-nulls (not (if separators omit-nulls t)))
3617 (rexp (or separators split-string-default-separators))
3621 (while (and (string-match rexp string
3623 (= start (match-beginning 0))
3624 (< start (length string)))
3626 (< start (length string)))
3628 (if (or keep-nulls (< start (match-beginning 0)))
3630 (cons (substring string start (match-beginning 0))
3632 (setq start (match-end 0)))
3633 (if (or keep-nulls (< start (length string)))
3635 (cons (substring string start)
3639 (defun combine-and-quote-strings (strings &optional separator)
3640 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3641 This tries to quote the strings to avoid ambiguity such that
3642 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3643 Only some SEPARATORs will work properly."
3644 (let* ((sep (or separator " "))
3645 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3648 (if (string-match re str)
3649 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3653 (defun split-string-and-unquote (string &optional separator)
3654 "Split the STRING into a list of strings.
3655 It understands Emacs Lisp quoting within STRING, such that
3656 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3657 The SEPARATOR regexp defaults to \"\\s-+\"."
3658 (let ((sep (or separator "\\s-+"))
3659 (i (string-match "\"" string)))
3661 (split-string string sep t) ; no quoting: easy
3662 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3663 (let ((rfs (read-from-string string i)))
3665 (split-string-and-unquote (substring string (cdr rfs))
3669 ;;;; Replacement in strings.
3671 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3672 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3673 Unless optional argument INPLACE is non-nil, return a new string."
3674 (let ((i (length string))
3675 (newstr (if inplace string (copy-sequence string))))
3678 (if (eq (aref newstr i) fromchar)
3679 (aset newstr i tochar)))
3682 (defun replace-regexp-in-string (regexp rep string &optional
3683 fixedcase literal subexp start)
3684 "Replace all matches for REGEXP with REP in STRING.
3686 Return a new string containing the replacements.
3688 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3689 arguments with the same names of function `replace-match'. If START
3690 is non-nil, start replacements at that index in STRING.
3692 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3693 function. If it is a function, it is called with the actual text of each
3694 match, and its value is used as the replacement text. When REP is called,
3695 the match data are the result of matching REGEXP against a substring
3698 To replace only the first match (if any), make REGEXP match up to \\'
3699 and replace a sub-expression, e.g.
3700 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3703 ;; To avoid excessive consing from multiple matches in long strings,
3704 ;; don't just call `replace-match' continually. Walk down the
3705 ;; string looking for matches of REGEXP and building up a (reversed)
3706 ;; list MATCHES. This comprises segments of STRING which weren't
3707 ;; matched interspersed with replacements for segments that were.
3708 ;; [For a `large' number of replacements it's more efficient to
3709 ;; operate in a temporary buffer; we can't tell from the function's
3710 ;; args whether to choose the buffer-based implementation, though it
3711 ;; might be reasonable to do so for long enough STRING.]
3712 (let ((l (length string))
3713 (start (or start 0))
3716 (while (and (< start l) (string-match regexp string start))
3717 (setq mb (match-beginning 0)
3719 ;; If we matched the empty string, make sure we advance by one char
3720 (when (= me mb) (setq me (min l (1+ mb))))
3721 ;; Generate a replacement for the matched substring.
3722 ;; Operate only on the substring to minimize string consing.
3723 ;; Set up match data for the substring for replacement;
3724 ;; presumably this is likely to be faster than munging the
3725 ;; match data directly in Lisp.
3726 (string-match regexp (setq str (substring string mb me)))
3728 (cons (replace-match (if (stringp rep)
3730 (funcall rep (match-string 0 str)))
3731 fixedcase literal str subexp)
3732 (cons (substring string start mb) ; unmatched prefix
3735 ;; Reconstruct a string from the pieces.
3736 (setq matches (cons (substring string start l) matches)) ; leftover
3737 (apply #'concat (nreverse matches)))))
3739 (defun string-prefix-p (str1 str2 &optional ignore-case)
3740 "Return non-nil if STR1 is a prefix of STR2.
3741 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3742 to case differences."
3743 (eq t (compare-strings str1 nil nil
3744 str2 0 (length str1) ignore-case)))
3746 (defun bidi-string-mark-left-to-right (str)
3747 "Return a string that can be safely inserted in left-to-right text.
3749 Normally, inserting a string with right-to-left (RTL) script into
3750 a buffer may cause some subsequent text to be displayed as part
3751 of the RTL segment (usually this affects punctuation characters).
3752 This function returns a string which displays as STR but forces
3753 subsequent text to be displayed as left-to-right.
3755 If STR contains any RTL character, this function returns a string
3756 consisting of STR followed by an invisible left-to-right mark
3757 \(LRM) character. Otherwise, it returns STR."
3758 (unless (stringp str)
3759 (signal 'wrong-type-argument (list 'stringp str)))
3760 (if (string-match "\\cR" str)
3761 (concat str (propertize (string ?\x200e) 'invisible t))
3764 ;;;; invisibility specs
3766 (defun add-to-invisibility-spec (element)
3767 "Add ELEMENT to `buffer-invisibility-spec'.
3768 See documentation for `buffer-invisibility-spec' for the kind of elements
3770 (if (eq buffer-invisibility-spec t)
3771 (setq buffer-invisibility-spec (list t)))
3772 (setq buffer-invisibility-spec
3773 (cons element buffer-invisibility-spec)))
3775 (defun remove-from-invisibility-spec (element)
3776 "Remove ELEMENT from `buffer-invisibility-spec'."
3777 (if (consp buffer-invisibility-spec)
3778 (setq buffer-invisibility-spec
3779 (delete element buffer-invisibility-spec))))
3783 (defmacro with-syntax-table (table &rest body)
3784 "Evaluate BODY with syntax table of current buffer set to TABLE.
3785 The syntax table of the current buffer is saved, BODY is evaluated, and the
3786 saved table is restored, even in case of an abnormal exit.
3787 Value is what BODY returns."
3788 (declare (debug t) (indent 1))
3789 (let ((old-table (make-symbol "table"))
3790 (old-buffer (make-symbol "buffer")))
3791 `(let ((,old-table (syntax-table))
3792 (,old-buffer (current-buffer)))
3795 (set-syntax-table ,table)
3797 (save-current-buffer
3798 (set-buffer ,old-buffer)
3799 (set-syntax-table ,old-table))))))
3801 (defun make-syntax-table (&optional oldtable)
3802 "Return a new syntax table.
3803 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3804 from `standard-syntax-table' otherwise."
3805 (let ((table (make-char-table 'syntax-table nil)))
3806 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3809 (defun syntax-after (pos)
3810 "Return the raw syntax descriptor for the char after POS.
3811 If POS is outside the buffer's accessible portion, return nil."
3812 (unless (or (< pos (point-min)) (>= pos (point-max)))
3813 (let ((st (if parse-sexp-lookup-properties
3814 (get-char-property pos 'syntax-table))))
3816 (aref (or st (syntax-table)) (char-after pos))))))
3818 (defun syntax-class (syntax)
3819 "Return the code for the syntax class described by SYNTAX.
3821 SYNTAX should be a raw syntax descriptor; the return value is a
3822 integer which encodes the corresponding syntax class. See Info
3823 node `(elisp)Syntax Table Internals' for a list of codes.
3825 If SYNTAX is nil, return nil."
3826 (and syntax (logand (car syntax) 65535)))
3830 (defun text-clone-maintain (ol1 after beg end &optional _len)
3831 "Propagate the changes made under the overlay OL1 to the other clones.
3832 This is used on the `modification-hooks' property of text clones."
3833 (when (and after (not undo-in-progress) (overlay-start ol1))
3834 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3835 (setq beg (max beg (+ (overlay-start ol1) margin)))
3836 (setq end (min end (- (overlay-end ol1) margin)))
3839 (when (overlay-get ol1 'text-clone-syntax)
3840 ;; Check content of the clone's text.
3841 (let ((cbeg (+ (overlay-start ol1) margin))
3842 (cend (- (overlay-end ol1) margin)))
3845 (if (not (re-search-forward
3846 (overlay-get ol1 'text-clone-syntax) cend t))
3847 ;; Mark the overlay for deletion.
3848 (overlay-put ol1 'text-clones nil)
3849 (when (< (match-end 0) cend)
3850 ;; Shrink the clone at its end.
3851 (setq end (min end (match-end 0)))
3852 (move-overlay ol1 (overlay-start ol1)
3853 (+ (match-end 0) margin)))
3854 (when (> (match-beginning 0) cbeg)
3855 ;; Shrink the clone at its beginning.
3856 (setq beg (max (match-beginning 0) beg))
3857 (move-overlay ol1 (- (match-beginning 0) margin)
3858 (overlay-end ol1)))))))
3859 ;; Now go ahead and update the clones.
3860 (let ((head (- beg (overlay-start ol1)))
3861 (tail (- (overlay-end ol1) end))
3862 (str (buffer-substring beg end))
3864 (inhibit-modification-hooks t))
3865 (dolist (ol2 (overlay-get ol1 'text-clones))
3866 (let ((oe (overlay-end ol2)))
3867 (unless (or (eq ol1 ol2) (null oe))
3868 (setq nothing-left nil)
3869 (let ((mod-beg (+ (overlay-start ol2) head)))
3870 ;;(overlay-put ol2 'modification-hooks nil)
3871 (goto-char (- (overlay-end ol2) tail))
3872 (unless (> mod-beg (point))
3873 (save-excursion (insert str))
3874 (delete-region mod-beg (point)))
3875 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3877 (if nothing-left (delete-overlay ol1))))))))
3879 (defun text-clone-create (start end &optional spreadp syntax)
3880 "Create a text clone of START...END at point.
3881 Text clones are chunks of text that are automatically kept identical:
3882 changes done to one of the clones will be immediately propagated to the other.
3884 The buffer's content at point is assumed to be already identical to
3885 the one between START and END.
3886 If SYNTAX is provided it's a regexp that describes the possible text of
3887 the clones; the clone will be shrunk or killed if necessary to ensure that
3888 its text matches the regexp.
3889 If SPREADP is non-nil it indicates that text inserted before/after the
3890 clone should be incorporated in the clone."
3891 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3892 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3893 ;; (with a one-char margin at each end) with `t nil'.
3894 ;; We opted for a larger overlay because it behaves better in the case
3895 ;; where the clone is reduced to the empty string (we want the overlay to
3896 ;; stay when the clone's content is the empty string and we want to use
3897 ;; `evaporate' to make sure those overlays get deleted when needed).
3899 (let* ((pt-end (+ (point) (- end start)))
3900 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3902 (end-margin (if (or (not spreadp)
3903 (>= pt-end (point-max))
3904 (>= start (point-max)))
3906 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3907 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3908 (dups (list ol1 ol2)))
3909 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3910 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3911 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3912 ;;(overlay-put ol1 'face 'underline)
3913 (overlay-put ol1 'evaporate t)
3914 (overlay-put ol1 'text-clones dups)
3916 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3917 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3918 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3919 ;;(overlay-put ol2 'face 'underline)
3920 (overlay-put ol2 'evaporate t)
3921 (overlay-put ol2 'text-clones dups)))
3923 ;;;; Mail user agents.
3925 ;; Here we include just enough for other packages to be able
3928 (defun define-mail-user-agent (symbol composefunc sendfunc
3929 &optional abortfunc hookvar)
3930 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3932 SYMBOL can be any Lisp symbol. Its function definition and/or
3933 value as a variable do not matter for this usage; we use only certain
3934 properties on its property list, to encode the rest of the arguments.
3936 COMPOSEFUNC is program callable function that composes an outgoing
3937 mail message buffer. This function should set up the basics of the
3938 buffer without requiring user interaction. It should populate the
3939 standard mail headers, leaving the `to:' and `subject:' headers blank
3942 COMPOSEFUNC should accept several optional arguments--the same
3943 arguments that `compose-mail' takes. See that function's documentation.
3945 SENDFUNC is the command a user would run to send the message.
3947 Optional ABORTFUNC is the command a user would run to abort the
3948 message. For mail packages that don't have a separate abort function,
3949 this can be `kill-buffer' (the equivalent of omitting this argument).
3951 Optional HOOKVAR is a hook variable that gets run before the message
3952 is actually sent. Callers that use the `mail-user-agent' may
3953 install a hook function temporarily on this hook variable.
3954 If HOOKVAR is nil, `mail-send-hook' is used.
3956 The properties used on SYMBOL are `composefunc', `sendfunc',
3957 `abortfunc', and `hookvar'."
3958 (put symbol 'composefunc composefunc)
3959 (put symbol 'sendfunc sendfunc)
3960 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3961 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3963 (defun set-temporary-overlay-map (map &optional keep-pred)
3964 "Set MAP as a temporary overlay map.
3965 When KEEP-PRED is `t', using a key from the temporary keymap
3966 leaves this keymap activated. KEEP-PRED can also be a function,
3967 which will have the same effect when it returns `t'.
3968 When KEEP-PRED is nil, the temporary keymap is used only once."
3969 (let* ((clearfunsym (make-symbol "clear-temporary-overlay-map"))
3970 (overlaysym (make-symbol "t"))
3971 (alist (list (cons overlaysym map)))
3973 ;; FIXME: Use lexical-binding.
3975 (unless ,(cond ((null keep-pred) nil)
3979 (this-command-keys-vector))))
3980 (t `(funcall ',keep-pred)))
3981 (set ',overlaysym nil) ;Just in case.
3982 (remove-hook 'pre-command-hook ',clearfunsym)
3983 (setq emulation-mode-map-alists
3984 (delq ',alist emulation-mode-map-alists))))))
3985 (set overlaysym overlaysym)
3986 (fset clearfunsym clearfun)
3987 (add-hook 'pre-command-hook clearfunsym)
3988 ;; FIXME: That's the keymaps with highest precedence, except for
3989 ;; the `keymap' text-property ;-(
3990 (push alist emulation-mode-map-alists)))
3992 ;;;; Progress reporters.
3994 ;; Progress reporter has the following structure:
3996 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4003 ;; This weirdness is for optimization reasons: we want
4004 ;; `progress-reporter-update' to be as fast as possible, so
4005 ;; `(car reporter)' is better than `(aref reporter 0)'.
4007 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4008 ;; digits of precision, it doesn't really matter here. On the other
4009 ;; hand, it greatly simplifies the code.
4011 (defsubst progress-reporter-update (reporter &optional value)
4012 "Report progress of an operation in the echo area.
4013 REPORTER should be the result of a call to `make-progress-reporter'.
4015 If REPORTER is a numerical progress reporter---i.e. if it was
4016 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4017 `make-progress-reporter'---then VALUE should be a number between
4018 MIN-VALUE and MAX-VALUE.
4020 If REPORTER is a non-numerical reporter, VALUE should be nil.
4022 This function is relatively inexpensive. If the change since
4023 last update is too small or insufficient time has passed, it does
4025 (when (or (not (numberp value)) ; For pulsing reporter
4026 (>= value (car reporter))) ; For numerical reporter
4027 (progress-reporter-do-update reporter value)))
4029 (defun make-progress-reporter (message &optional min-value max-value
4030 current-value min-change min-time)
4031 "Return progress reporter object for use with `progress-reporter-update'.
4033 MESSAGE is shown in the echo area, with a status indicator
4034 appended to the end. When you call `progress-reporter-done', the
4035 word \"done\" is printed after the MESSAGE. You can change the
4036 MESSAGE of an existing progress reporter by calling
4037 `progress-reporter-force-update'.
4039 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4040 and final (100% complete) states of operation; the latter should
4041 be larger. In this case, the status message shows the percentage
4044 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4045 message shows a \"spinning\", non-numeric indicator.
4047 Optional CURRENT-VALUE is the initial progress; the default is
4049 Optional MIN-CHANGE is the minimal change in percents to report;
4051 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4052 and/or MAX-VALUE are nil.
4054 Optional MIN-TIME specifies the minimum interval time between
4055 echo area updates (default is 0.2 seconds.) If the function
4056 `float-time' is not present, time is not tracked at all. If the
4057 OS is not capable of measuring fractions of seconds, this
4058 parameter is effectively rounded up."
4059 (when (string-match "[[:alnum:]]\\'" message)
4060 (setq message (concat message "...")))
4062 (setq min-time 0.2))
4064 ;; Force a call to `message' now
4065 (cons (or min-value 0)
4066 (vector (if (and (fboundp 'float-time)
4072 (if min-change (max (min min-change 50) 1) 1)
4074 (progress-reporter-update reporter (or current-value min-value))
4077 (defun progress-reporter-force-update (reporter &optional value new-message)
4078 "Report progress of an operation in the echo area unconditionally.
4080 The first two arguments are the same as in `progress-reporter-update'.
4081 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4082 (let ((parameters (cdr reporter)))
4084 (aset parameters 3 new-message))
4085 (when (aref parameters 0)
4086 (aset parameters 0 (float-time)))
4087 (progress-reporter-do-update reporter value)))
4089 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4090 "Characters to use for pulsing progress reporters.")
4092 (defun progress-reporter-do-update (reporter value)
4093 (let* ((parameters (cdr reporter))
4094 (update-time (aref parameters 0))
4095 (min-value (aref parameters 1))
4096 (max-value (aref parameters 2))
4097 (text (aref parameters 3))
4098 (current-time (float-time))
4100 ;; See if enough time has passed since the last update.
4101 (or (not update-time)
4102 (when (>= current-time update-time)
4103 ;; Calculate time for the next update
4104 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4105 (cond ((and min-value max-value)
4106 ;; Numerical indicator
4107 (let* ((one-percent (/ (- max-value min-value) 100.0))
4108 (percentage (if (= max-value min-value)
4110 (truncate (/ (- value min-value)
4112 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4113 ;; message because not enough time has passed, use 1
4114 ;; instead of MIN-CHANGE. This makes delays between echo
4115 ;; area updates closer to MIN-TIME.
4117 (min (+ min-value (* (+ percentage
4118 (if enough-time-passed
4124 (when (integerp value)
4125 (setcar reporter (ceiling (car reporter))))
4126 ;; Only print message if enough time has passed
4127 (when enough-time-passed
4128 (if (> percentage 0)
4129 (message "%s%d%%" text percentage)
4130 (message "%s" text)))))
4131 ;; Pulsing indicator
4133 (let ((index (mod (1+ (car reporter)) 4))
4134 (message-log-max nil))
4135 (setcar reporter index)
4138 (aref progress-reporter--pulse-characters
4141 (defun progress-reporter-done (reporter)
4142 "Print reporter's message followed by word \"done\" in echo area."
4143 (message "%sdone" (aref (cdr reporter) 3)))
4145 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4146 "Loop a certain number of times and report progress in the echo area.
4147 Evaluate BODY with VAR bound to successive integers running from
4148 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4149 the return value (nil if RESULT is omitted).
4151 At each iteration MESSAGE followed by progress percentage is
4152 printed in the echo area. After the loop is finished, MESSAGE
4153 followed by word \"done\" is printed. This macro is a
4154 convenience wrapper around `make-progress-reporter' and friends.
4156 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4157 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4158 (let ((temp (make-symbol "--dotimes-temp--"))
4159 (temp2 (make-symbol "--dotimes-temp2--"))
4163 (,(car spec) ,start)
4164 (,temp2 (make-progress-reporter ,message ,start ,end)))
4165 (while (< ,(car spec) ,temp)
4167 (progress-reporter-update ,temp2
4168 (setq ,(car spec) (1+ ,(car spec)))))
4169 (progress-reporter-done ,temp2)
4170 nil ,@(cdr (cdr spec)))))
4173 ;;;; Comparing version strings.
4175 (defconst version-separator "."
4176 "Specify the string used to separate the version elements.
4178 Usually the separator is \".\", but it can be any other string.")
4181 (defconst version-regexp-alist
4182 '(("^[-_+ ]?alpha$" . -3)
4183 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
4184 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
4185 ("^[-_+ ]?beta$" . -2)
4186 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
4187 "Specify association between non-numeric version and its priority.
4189 This association is used to handle version string like \"1.0pre2\",
4190 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4191 non-numeric part of a version string to an integer. For example:
4193 String Version Integer List Version
4194 \"1.0pre2\" (1 0 -1 2)
4195 \"1.0PRE2\" (1 0 -1 2)
4196 \"22.8beta3\" (22 8 -2 3)
4197 \"22.8 Beta3\" (22 8 -2 3)
4198 \"0.9alpha1\" (0 9 -3 1)
4199 \"0.9AlphA1\" (0 9 -3 1)
4200 \"0.9 alpha\" (0 9 -3)
4202 Each element has the following form:
4208 REGEXP regexp used to match non-numeric part of a version string.
4209 It should begin with the `^' anchor and end with a `$' to
4210 prevent false hits. Letter-case is ignored while matching
4213 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4216 (defun version-to-list (ver)
4217 "Convert version string VER into a list of integers.
4219 The version syntax is given by the following EBNF:
4221 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4223 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4225 SEPARATOR ::= `version-separator' (which see)
4226 | `version-regexp-alist' (which see).
4228 The NUMBER part is optional if SEPARATOR is a match for an element
4229 in `version-regexp-alist'.
4231 Examples of valid version syntax:
4233 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4235 Examples of invalid version syntax:
4237 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4239 Examples of version conversion:
4241 Version String Version as a List of Integers
4242 \"1.0.7.5\" (1 0 7 5)
4243 \"1.0pre2\" (1 0 -1 2)
4244 \"1.0PRE2\" (1 0 -1 2)
4245 \"22.8beta3\" (22 8 -2 3)
4246 \"22.8Beta3\" (22 8 -2 3)
4247 \"0.9alpha1\" (0 9 -3 1)
4248 \"0.9AlphA1\" (0 9 -3 1)
4249 \"0.9alpha\" (0 9 -3)
4251 See documentation for `version-separator' and `version-regexp-alist'."
4252 (or (and (stringp ver) (> (length ver) 0))
4253 (error "Invalid version string: '%s'" ver))
4254 ;; Change .x.y to 0.x.y
4255 (if (and (>= (length ver) (length version-separator))
4256 (string-equal (substring ver 0 (length version-separator))
4258 (setq ver (concat "0" ver)))
4261 (case-fold-search t) ; ignore case in matching
4263 (while (and (setq s (string-match "[0-9]+" ver i))
4265 ;; handle numeric part
4266 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4269 ;; handle non-numeric part
4270 (when (and (setq s (string-match "[^0-9]+" ver i))
4272 (setq s (substring ver i (match-end 0))
4274 ;; handle alpha, beta, pre, etc. separator
4275 (unless (string= s version-separator)
4276 (setq al version-regexp-alist)
4277 (while (and al (not (string-match (caar al) s)))
4280 (push (cdar al) lst))
4281 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4282 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4283 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4285 (t (error "Invalid version syntax: '%s'" ver))))))
4287 (error "Invalid version syntax: '%s'" ver)
4291 (defun version-list-< (l1 l2)
4292 "Return t if L1, a list specification of a version, is lower than L2.
4294 Note that a version specified by the list (1) is equal to (1 0),
4295 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4296 Also, a version given by the list (1) is higher than (1 -1), which in
4297 turn is higher than (1 -2), which is higher than (1 -3)."
4298 (while (and l1 l2 (= (car l1) (car l2)))
4302 ;; l1 not null and l2 not null
4303 ((and l1 l2) (< (car l1) (car l2)))
4304 ;; l1 null and l2 null ==> l1 length = l2 length
4305 ((and (null l1) (null l2)) nil)
4306 ;; l1 not null and l2 null ==> l1 length > l2 length
4307 (l1 (< (version-list-not-zero l1) 0))
4308 ;; l1 null and l2 not null ==> l2 length > l1 length
4309 (t (< 0 (version-list-not-zero l2)))))
4312 (defun version-list-= (l1 l2)
4313 "Return t if L1, a list specification of a version, is equal to L2.
4315 Note that a version specified by the list (1) is equal to (1 0),
4316 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4317 Also, a version given by the list (1) is higher than (1 -1), which in
4318 turn is higher than (1 -2), which is higher than (1 -3)."
4319 (while (and l1 l2 (= (car l1) (car l2)))
4323 ;; l1 not null and l2 not null
4325 ;; l1 null and l2 null ==> l1 length = l2 length
4326 ((and (null l1) (null l2)))
4327 ;; l1 not null and l2 null ==> l1 length > l2 length
4328 (l1 (zerop (version-list-not-zero l1)))
4329 ;; l1 null and l2 not null ==> l2 length > l1 length
4330 (t (zerop (version-list-not-zero l2)))))
4333 (defun version-list-<= (l1 l2)
4334 "Return t if L1, a list specification of a version, is lower or equal to L2.
4336 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4337 etc. That is, the trailing zeroes are insignificant. Also, integer
4338 list (1) is greater than (1 -1) which is greater than (1 -2)
4339 which is greater than (1 -3)."
4340 (while (and l1 l2 (= (car l1) (car l2)))
4344 ;; l1 not null and l2 not null
4345 ((and l1 l2) (< (car l1) (car l2)))
4346 ;; l1 null and l2 null ==> l1 length = l2 length
4347 ((and (null l1) (null l2)))
4348 ;; l1 not null and l2 null ==> l1 length > l2 length
4349 (l1 (<= (version-list-not-zero l1) 0))
4350 ;; l1 null and l2 not null ==> l2 length > l1 length
4351 (t (<= 0 (version-list-not-zero l2)))))
4353 (defun version-list-not-zero (lst)
4354 "Return the first non-zero element of LST, which is a list of integers.
4356 If all LST elements are zeros or LST is nil, return zero."
4357 (while (and lst (zerop (car lst)))
4358 (setq lst (cdr lst)))
4361 ;; there is no element different of zero
4365 (defun version< (v1 v2)
4366 "Return t if version V1 is lower (older) than V2.
4368 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4369 etc. That is, the trailing \".0\"s are insignificant. Also, version
4370 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4371 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4373 (version-list-< (version-to-list v1) (version-to-list v2)))
4376 (defun version<= (v1 v2)
4377 "Return t if version V1 is lower (older) than or equal to V2.
4379 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4380 etc. That is, the trailing \".0\"s are insignificant. Also, version
4381 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4382 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4384 (version-list-<= (version-to-list v1) (version-to-list v2)))
4386 (defun version= (v1 v2)
4387 "Return t if version V1 is equal to V2.
4389 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4390 etc. That is, the trailing \".0\"s are insignificant. Also, version
4391 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4392 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4394 (version-list-= (version-to-list v1) (version-to-list v2)))
4398 (defconst menu-bar-separator '("--")
4399 "Separator for menus.")
4401 ;; The following statement ought to be in print.c, but `provide' can't
4403 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4404 (when (hash-table-p (car (read-from-string
4405 (prin1-to-string (make-hash-table)))))
4406 (provide 'hashtable-print-readable))
4408 ;;; subr.el ends here