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 (if (null (featurep 'cl
))
200 ;; If we reload subr.el after having loaded CL, be careful not to
201 ;; overwrite CL's extended definition of `dolist', `dotimes', `declare'.
203 (defmacro dolist
(spec &rest body
)
205 Evaluate BODY with VAR bound to each car from LIST, in turn.
206 Then evaluate RESULT to get return value, default nil.
208 \(fn (VAR LIST [RESULT]) BODY...)"
209 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
210 ;; It would be cleaner to create an uninterned symbol,
211 ;; but that uses a lot more space when many functions in many files
213 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
214 (let ((temp '--dolist-tail--
))
215 ;; This is not a reliable test, but it does not matter because both
216 ;; semantics are acceptable, tho one is slightly faster with dynamic
217 ;; scoping and the other is slightly faster (and has cleaner semantics)
218 ;; with lexical scoping.
220 `(let ((,temp
,(nth 1 spec
)))
222 (let ((,(car spec
) (car ,temp
)))
224 (setq ,temp
(cdr ,temp
))))
225 ,@(if (cdr (cdr spec
))
226 ;; FIXME: This let often leads to "unused var" warnings.
227 `((let ((,(car spec
) nil
)) ,@(cdr (cdr spec
))))))
228 `(let ((,temp
,(nth 1 spec
))
231 (setq ,(car spec
) (car ,temp
))
233 (setq ,temp
(cdr ,temp
)))
234 ,@(if (cdr (cdr spec
))
235 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
))))))))
237 (defmacro dotimes
(spec &rest body
)
238 "Loop a certain number of times.
239 Evaluate BODY with VAR bound to successive integers running from 0,
240 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
241 the return value (nil if RESULT is omitted).
243 \(fn (VAR COUNT [RESULT]) BODY...)"
244 (declare (indent 1) (debug dolist
))
245 ;; It would be cleaner to create an uninterned symbol,
246 ;; but that uses a lot more space when many functions in many files
248 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
249 (let ((temp '--dotimes-limit--
)
252 ;; This is not a reliable test, but it does not matter because both
253 ;; semantics are acceptable, tho one is slightly faster with dynamic
254 ;; scoping and the other has cleaner semantics.
256 (let ((counter '--dotimes-counter--
))
259 (while (< ,counter
,temp
)
260 (let ((,(car spec
) ,counter
))
262 (setq ,counter
(1+ ,counter
)))
264 ;; FIXME: This let often leads to "unused var" warnings.
265 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
267 (,(car spec
) ,start
))
268 (while (< ,(car spec
) ,temp
)
270 (setq ,(car spec
) (1+ ,(car spec
))))
271 ,@(cdr (cdr spec
))))))
273 (defmacro declare
(&rest _specs
)
274 "Do not evaluate any arguments and return nil.
275 Treated as a declaration when used at the right place in a
276 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
277 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
281 (defmacro ignore-errors
(&rest body
)
282 "Execute BODY; if an error occurs, return nil.
283 Otherwise, return result of last form in BODY.
284 See also `with-demoted-errors' that does something similar
285 without silencing all errors."
286 (declare (debug t
) (indent 0))
287 `(condition-case nil
(progn ,@body
) (error nil
)))
289 ;;;; Basic Lisp functions.
291 (defun ignore (&rest _ignore
)
292 "Do nothing and return nil.
293 This function accepts any number of arguments, but ignores them."
297 ;; Signal a compile-error if the first arg is missing.
298 (defun error (&rest args
)
299 "Signal an error, making error message by passing all args to `format'.
300 In Emacs, the convention is that error messages start with a capital
301 letter but *do not* end with a period. Please follow this convention
302 for the sake of consistency."
304 (signal 'error
(list (apply 'format args
)))))
305 (set-advertised-calling-convention 'error
'(string &rest args
) "23.1")
307 (defun user-error (format &rest args
)
308 "Signal a pilot error, making error message by passing all args to `format'.
309 In Emacs, the convention is that error messages start with a capital
310 letter but *do not* end with a period. Please follow this convention
311 for the sake of consistency.
312 This is just like `error' except that `user-error's are expected to be the
313 result of an incorrect manipulation on the part of the user, rather than the
314 result of an actual problem."
316 (signal 'user-error
(list (apply #'format format args
)))))
318 ;; We put this here instead of in frame.el so that it's defined even on
319 ;; systems where frame.el isn't loaded.
320 (defun frame-configuration-p (object)
321 "Return non-nil if OBJECT seems to be a frame configuration.
322 Any list whose car is `frame-configuration' is assumed to be a frame
325 (eq (car object
) 'frame-configuration
)))
330 "Return the car of the car of X."
334 "Return the car of the cdr of X."
338 "Return the cdr of the car of X."
342 "Return the cdr of the cdr of X."
345 (defun last (list &optional n
)
346 "Return the last link of LIST. Its car is the last element.
347 If LIST is nil, return nil.
348 If N is non-nil, return the Nth-to-last link of LIST.
349 If N is bigger than the length of LIST, return LIST."
352 (let ((m (safe-length list
)))
353 (if (< n m
) (nthcdr (- m n
) list
) list
)))
355 (nthcdr (1- (safe-length list
)) list
))))
357 (defun butlast (list &optional n
)
358 "Return a copy of LIST with the last N elements removed."
359 (if (and n
(<= n
0)) list
360 (nbutlast (copy-sequence list
) n
)))
362 (defun nbutlast (list &optional n
)
363 "Modifies LIST to remove the last N elements."
364 (let ((m (length list
)))
368 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
371 (defun delete-dups (list)
372 "Destructively remove `equal' duplicates from LIST.
373 Store the result in LIST and return it. LIST must be a proper list.
374 Of several `equal' occurrences of an element in LIST, the first
378 (setcdr tail
(delete (car tail
) (cdr tail
)))
379 (setq tail
(cdr tail
))))
382 (defun number-sequence (from &optional to inc
)
383 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
384 INC is the increment used between numbers in the sequence and defaults to 1.
385 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
386 zero. TO is only included if there is an N for which TO = FROM + N * INC.
387 If TO is nil or numerically equal to FROM, return \(FROM).
388 If INC is positive and TO is less than FROM, or INC is negative
389 and TO is larger than FROM, return nil.
390 If INC is zero and TO is neither nil nor numerically equal to
391 FROM, signal an error.
393 This function is primarily designed for integer arguments.
394 Nevertheless, FROM, TO and INC can be integer or float. However,
395 floating point arithmetic is inexact. For instance, depending on
396 the machine, it may quite well happen that
397 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
398 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
399 elements. Thus, if some of the arguments are floats and one wants
400 to make sure that TO is included, one may have to explicitly write
401 TO as \(+ FROM \(* N INC)) or use a variable whose value was
402 computed with this exact expression. Alternatively, you can,
403 of course, also replace TO with a slightly larger value
404 \(or a slightly more negative value if INC is negative)."
405 (if (or (not to
) (= from to
))
407 (or inc
(setq inc
1))
408 (when (zerop inc
) (error "The increment can not be zero"))
409 (let (seq (n 0) (next from
))
412 (setq seq
(cons next seq
)
414 next
(+ from
(* n inc
))))
416 (setq seq
(cons next seq
)
418 next
(+ from
(* n inc
)))))
421 (defun copy-tree (tree &optional vecp
)
422 "Make a copy of TREE.
423 If TREE is a cons cell, this recursively copies both its car and its cdr.
424 Contrast to `copy-sequence', which copies only along the cdrs. With second
425 argument VECP, this copies vectors as well as conses."
429 (let ((newcar (car tree
)))
430 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
431 (setq newcar
(copy-tree (car tree
) vecp
)))
432 (push newcar result
))
433 (setq tree
(cdr tree
)))
434 (nconc (nreverse result
) tree
))
435 (if (and vecp
(vectorp tree
))
436 (let ((i (length (setq tree
(copy-sequence tree
)))))
437 (while (>= (setq i
(1- i
)) 0)
438 (aset tree i
(copy-tree (aref tree i
) vecp
)))
442 ;;;; Various list-search functions.
444 (defun assoc-default (key alist
&optional test default
)
445 "Find object KEY in a pseudo-alist ALIST.
446 ALIST is a list of conses or objects. Each element
447 (or the element's car, if it is a cons) is compared with KEY by
448 calling TEST, with two arguments: (i) the element or its car,
450 If that is non-nil, the element matches; then `assoc-default'
451 returns the element's cdr, if it is a cons, or DEFAULT if the
452 element is not a cons.
454 If no element matches, the value is nil.
455 If TEST is omitted or nil, `equal' is used."
456 (let (found (tail alist
) value
)
457 (while (and tail
(not found
))
458 (let ((elt (car tail
)))
459 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
460 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
461 (setq tail
(cdr tail
)))
464 (defun assoc-ignore-case (key alist
)
465 "Like `assoc', but ignores differences in case and text representation.
466 KEY must be a string. Upper-case and lower-case letters are treated as equal.
467 Unibyte strings are converted to multibyte for comparison."
468 (declare (obsolete assoc-string
"22.1"))
469 (assoc-string key alist t
))
471 (defun assoc-ignore-representation (key alist
)
472 "Like `assoc', but ignores differences in text representation.
473 KEY must be a string.
474 Unibyte strings are converted to multibyte for comparison."
475 (declare (obsolete assoc-string
"22.1"))
476 (assoc-string key alist nil
))
478 (defun member-ignore-case (elt list
)
479 "Like `member', but ignore differences in case and text representation.
480 ELT must be a string. Upper-case and lower-case letters are treated as equal.
481 Unibyte strings are converted to multibyte for comparison.
482 Non-strings in LIST are ignored."
484 (not (and (stringp (car list
))
485 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
486 (setq list
(cdr list
)))
489 (defun assq-delete-all (key alist
)
490 "Delete from ALIST all elements whose car is `eq' to KEY.
491 Return the modified alist.
492 Elements of ALIST that are not conses are ignored."
493 (while (and (consp (car alist
))
494 (eq (car (car alist
)) key
))
495 (setq alist
(cdr alist
)))
496 (let ((tail alist
) tail-cdr
)
497 (while (setq tail-cdr
(cdr tail
))
498 (if (and (consp (car tail-cdr
))
499 (eq (car (car tail-cdr
)) key
))
500 (setcdr tail
(cdr tail-cdr
))
501 (setq tail tail-cdr
))))
504 (defun rassq-delete-all (value alist
)
505 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
506 Return the modified alist.
507 Elements of ALIST that are not conses are ignored."
508 (while (and (consp (car alist
))
509 (eq (cdr (car alist
)) value
))
510 (setq alist
(cdr alist
)))
511 (let ((tail alist
) tail-cdr
)
512 (while (setq tail-cdr
(cdr tail
))
513 (if (and (consp (car tail-cdr
))
514 (eq (cdr (car tail-cdr
)) value
))
515 (setcdr tail
(cdr tail-cdr
))
516 (setq tail tail-cdr
))))
519 (defun remove (elt seq
)
520 "Return a copy of SEQ with all occurrences of ELT removed.
521 SEQ must be a list, vector, or string. The comparison is done with `equal'."
523 ;; If SEQ isn't a list, there's no need to copy SEQ because
524 ;; `delete' will return a new object.
526 (delete elt
(copy-sequence seq
))))
528 (defun remq (elt list
)
529 "Return LIST with all occurrences of ELT removed.
530 The comparison is done with `eq'. Contrary to `delq', this does not use
531 side-effects, and the argument LIST is not modified."
532 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
534 (delq elt
(copy-sequence list
))
540 "Convert KEYS to the internal Emacs key representation.
541 KEYS should be a string constant in the format used for
542 saving keyboard macros (see `edmacro-mode')."
543 ;; Don't use a defalias, since the `pure' property is only true for
544 ;; the calling convention of `kbd'.
545 (read-kbd-macro keys
))
549 "Beep to tell the user this binding is undefined."
553 ;; Prevent the \{...} documentation construct
554 ;; from mentioning keys that run this command.
555 (put 'undefined
'suppress-keymap t
)
557 (defun suppress-keymap (map &optional nodigits
)
558 "Make MAP override all normally self-inserting keys to be undefined.
559 Normally, as an exception, digits and minus-sign are set to make prefix args,
560 but optional second arg NODIGITS non-nil treats them like other chars."
561 (define-key map
[remap self-insert-command
] 'undefined
)
564 (define-key map
"-" 'negative-argument
)
565 ;; Make plain numbers do numeric args.
568 (define-key map
(char-to-string loop
) 'digit-argument
)
569 (setq loop
(1+ loop
))))))
571 (defun make-composed-keymap (maps &optional parent
)
572 "Construct a new keymap composed of MAPS and inheriting from PARENT.
573 When looking up a key in the returned map, the key is looked in each
574 keymap of MAPS in turn until a binding is found.
575 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
576 As always with keymap inheritance, a nil binding in MAPS overrides
577 any corresponding binding in PARENT, but it does not override corresponding
578 bindings in other keymaps of MAPS.
579 MAPS can be a list of keymaps or a single keymap.
580 PARENT if non-nil should be a keymap."
582 ,@(if (keymapp maps
) (list maps
) maps
)
585 (defun define-key-after (keymap key definition
&optional after
)
586 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
587 This is like `define-key' except that the binding for KEY is placed
588 just after the binding for the event AFTER, instead of at the beginning
589 of the map. Note that AFTER must be an event type (like KEY), NOT a command
592 If AFTER is t or omitted, the new binding goes at the end of the keymap.
593 AFTER should be a single event type--a symbol or a character, not a sequence.
595 Bindings are always added before any inherited map.
597 The order of bindings in a keymap only matters when it is used as
598 a menu, so this function is not useful for non-menu keymaps."
599 (unless after
(setq after t
))
601 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
603 (if (<= (length key
) 1) (aref key
0)
604 (setq keymap
(lookup-key keymap
606 (butlast (mapcar 'identity key
)))))
607 (aref key
(1- (length key
)))))
608 (let ((tail keymap
) done inserted
)
609 (while (and (not done
) tail
)
610 ;; Delete any earlier bindings for the same key.
611 (if (eq (car-safe (car (cdr tail
))) key
)
612 (setcdr tail
(cdr (cdr tail
))))
613 ;; If we hit an included map, go down that one.
614 (if (keymapp (car tail
)) (setq tail
(car tail
)))
615 ;; When we reach AFTER's binding, insert the new binding after.
616 ;; If we reach an inherited keymap, insert just before that.
617 ;; If we reach the end of this keymap, insert at the end.
618 (if (or (and (eq (car-safe (car tail
)) after
)
620 (eq (car (cdr tail
)) 'keymap
)
623 ;; Stop the scan only if we find a parent keymap.
624 ;; Keep going past the inserted element
625 ;; so we can delete any duplications that come later.
626 (if (eq (car (cdr tail
)) 'keymap
)
628 ;; Don't insert more than once.
630 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
632 (setq tail
(cdr tail
)))))
634 (defun map-keymap-sorted (function keymap
)
635 "Implement `map-keymap' with sorting.
636 Don't call this function; it is for internal use only."
638 (map-keymap (lambda (a b
) (push (cons a b
) list
))
640 (setq list
(sort list
642 (setq a
(car a
) b
(car b
))
644 (if (integerp b
) (< a b
)
647 ;; string< also accepts symbols.
650 (funcall function
(car p
) (cdr p
)))))
652 (defun keymap--menu-item-binding (val)
653 "Return the binding part of a menu-item."
655 ((not (consp val
)) val
) ;Not a menu-item.
656 ((eq 'menu-item
(car val
))
657 (let* ((binding (nth 2 val
))
658 (plist (nthcdr 3 val
))
659 (filter (plist-get plist
:filter
)))
660 (if filter
(funcall filter binding
)
662 ((and (consp (cdr val
)) (stringp (cadr val
)))
666 (t val
))) ;Not a menu-item either.
668 (defun keymap--menu-item-with-binding (item binding
)
669 "Build a menu-item like ITEM but with its binding changed to BINDING."
671 ((not (consp item
)) binding
) ;Not a menu-item.
672 ((eq 'menu-item
(car item
))
673 (setq item
(copy-sequence item
))
674 (let ((tail (nthcdr 2 item
)))
675 (setcar tail binding
)
676 ;; Remove any potential filter.
677 (if (plist-get (cdr tail
) :filter
)
678 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
680 ((and (consp (cdr item
)) (stringp (cadr item
)))
681 (cons (car item
) (cons (cadr item
) binding
)))
682 (t (cons (car item
) binding
))))
684 (defun keymap--merge-bindings (val1 val2
)
685 "Merge bindings VAL1 and VAL2."
686 (let ((map1 (keymap--menu-item-binding val1
))
687 (map2 (keymap--menu-item-binding val2
)))
688 (if (not (and (keymapp map1
) (keymapp map2
)))
689 ;; There's nothing to merge: val1 takes precedence.
691 (let ((map (list 'keymap map1 map2
))
692 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
693 (keymap--menu-item-with-binding item map
)))))
695 (defun keymap-canonicalize (map)
696 "Return a simpler equivalent keymap.
697 This resolves inheritance and redefinitions. The returned keymap
698 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
699 and use in active keymaps and menus.
700 Subkeymaps may be modified but are not canonicalized."
701 ;; FIXME: Problem with the difference between a nil binding
702 ;; that hides a binding in an inherited map and a nil binding that's ignored
703 ;; to let some further binding visible. Currently a nil binding hides all.
704 ;; FIXME: we may want to carefully (re)order elements in case they're
708 (prompt (keymap-prompt map
)))
710 (setq map
(map-keymap ;; -internal
713 ;; Treat char-ranges specially.
714 (push (cons key item
) ranges
)
715 (push (cons key item
) bindings
)))
717 ;; Create the new map.
718 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
719 (dolist (binding ranges
)
720 ;; Treat char-ranges specially. FIXME: need to merge as well.
721 (define-key map
(vector (car binding
)) (cdr binding
)))
722 ;; Process the bindings starting from the end.
723 (dolist (binding (prog1 bindings
(setq bindings
())))
724 (let* ((key (car binding
))
725 (oldbind (assq key bindings
)))
726 (push (if (not oldbind
)
727 ;; The normal case: no duplicate bindings.
729 ;; This is the second binding for this key.
730 (setq bindings
(delq oldbind bindings
))
731 (cons key
(keymap--merge-bindings (cdr binding
)
734 (nconc map bindings
)))
736 (put 'keyboard-translate-table
'char-table-extra-slots
0)
738 (defun keyboard-translate (from to
)
739 "Translate character FROM to TO on the current terminal.
740 This function creates a `keyboard-translate-table' if necessary
741 and then modifies one entry in it."
742 (or (char-table-p keyboard-translate-table
)
743 (setq keyboard-translate-table
744 (make-char-table 'keyboard-translate-table nil
)))
745 (aset keyboard-translate-table from to
))
747 ;;;; Key binding commands.
749 (defun global-set-key (key command
)
750 "Give KEY a global binding as COMMAND.
751 COMMAND is the command definition to use; usually it is
752 a symbol naming an interactively-callable function.
753 KEY is a key sequence; noninteractively, it is a string or vector
754 of characters or event types, and non-ASCII characters with codes
755 above 127 (such as ISO Latin-1) can be included if you use a vector.
757 Note that if KEY has a local binding in the current buffer,
758 that local binding will continue to shadow any global binding
759 that you make with this function."
760 (interactive "KSet key globally: \nCSet key %s to command: ")
761 (or (vectorp key
) (stringp key
)
762 (signal 'wrong-type-argument
(list 'arrayp key
)))
763 (define-key (current-global-map) key command
))
765 (defun local-set-key (key command
)
766 "Give KEY a local binding as COMMAND.
767 COMMAND is the command definition to use; usually it is
768 a symbol naming an interactively-callable function.
769 KEY is a key sequence; noninteractively, it is a string or vector
770 of characters or event types, and non-ASCII characters with codes
771 above 127 (such as ISO Latin-1) can be included if you use a vector.
773 The binding goes in the current buffer's local map,
774 which in most cases is shared with all other buffers in the same major mode."
775 (interactive "KSet key locally: \nCSet key %s locally to command: ")
776 (let ((map (current-local-map)))
778 (use-local-map (setq map
(make-sparse-keymap))))
779 (or (vectorp key
) (stringp key
)
780 (signal 'wrong-type-argument
(list 'arrayp key
)))
781 (define-key map key command
)))
783 (defun global-unset-key (key)
784 "Remove global binding of KEY.
785 KEY is a string or vector representing a sequence of keystrokes."
786 (interactive "kUnset key globally: ")
787 (global-set-key key nil
))
789 (defun local-unset-key (key)
790 "Remove local binding of KEY.
791 KEY is a string or vector representing a sequence of keystrokes."
792 (interactive "kUnset key locally: ")
793 (if (current-local-map)
794 (local-set-key key nil
))
797 ;;;; substitute-key-definition and its subroutines.
799 (defvar key-substitution-in-progress nil
800 "Used internally by `substitute-key-definition'.")
802 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
803 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
804 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
805 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
806 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
808 If you don't specify OLDMAP, you can usually get the same results
809 in a cleaner way with command remapping, like this:
810 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
811 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
812 ;; Don't document PREFIX in the doc string because we don't want to
813 ;; advertise it. It's meant for recursive calls only. Here's its
816 ;; If optional argument PREFIX is specified, it should be a key
817 ;; prefix, a string. Redefined bindings will then be bound to the
818 ;; original key, with PREFIX added at the front.
819 (or prefix
(setq prefix
""))
820 (let* ((scan (or oldmap keymap
))
821 (prefix1 (vconcat prefix
[nil]))
822 (key-substitution-in-progress
823 (cons scan key-substitution-in-progress)))
824 ;; Scan OLDMAP, finding each char or event-symbol that
825 ;; has any definition, and act on it with hack-key.
828 (aset prefix1 (length prefix) char)
829 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
832 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
833 (let (inner-def skipped menu-item)
834 ;; Find the actual command name within the binding.
835 (if (eq (car-safe defn) 'menu-item)
836 (setq menu-item defn defn (nth 2 defn))
837 ;; Skip past menu-prompt.
838 (while (stringp (car-safe defn))
839 (push (pop defn) skipped))
840 ;; Skip past cached key-equivalence data for menu items.
841 (if (consp (car-safe defn))
842 (setq defn (cdr defn))))
843 (if (or (eq defn olddef)
844 ;; Compare with equal if definition is a key sequence.
845 ;; That is useful for operating on function-key-map.
846 (and (or (stringp defn) (vectorp defn))
847 (equal defn olddef)))
848 (define-key keymap prefix
850 (let ((copy (copy-sequence menu-item)))
851 (setcar (nthcdr 2 copy) newdef)
853 (nconc (nreverse skipped) newdef)))
854 ;; Look past a symbol that names a keymap.
856 (or (indirect-function defn t) defn))
857 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
858 ;; avoid autoloading a keymap. This is mostly done to preserve the
859 ;; original non-autoloading behavior of pre-map-keymap times.
860 (if (and (keymapp inner-def)
861 ;; Avoid recursively scanning
862 ;; where KEYMAP does not have a submap.
863 (let ((elt (lookup-key keymap prefix)))
864 (or (null elt) (natnump elt) (keymapp elt)))
865 ;; Avoid recursively rescanning keymap being scanned.
866 (not (memq inner-def key-substitution-in-progress)))
867 ;; If this one isn't being scanned already, scan it now.
868 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
871 ;;;; The global keymap tree.
873 ;; global-map, esc-map, and ctl-x-map have their values set up in
874 ;; keymap.c; we just give them docstrings here.
876 (defvar global-map nil
877 "Default global keymap mapping Emacs keyboard input into commands.
878 The value is a keymap which is usually (but not necessarily) Emacs's
882 "Default keymap for ESC (meta) commands.
883 The normal global definition of the character ESC indirects to this keymap.")
885 (defvar ctl-x-map nil
886 "Default keymap for C-x commands.
887 The normal global definition of the character C-x indirects to this keymap.")
889 (defvar ctl-x-4-map (make-sparse-keymap)
890 "Keymap for subcommands of C-x 4.")
891 (defalias 'ctl-x-4-prefix ctl-x-4-map)
892 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
894 (defvar ctl-x-5-map (make-sparse-keymap)
895 "Keymap for frame commands.")
896 (defalias 'ctl-x-5-prefix ctl-x-5-map)
897 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
900 ;;;; Event manipulation functions.
902 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
904 (defun listify-key-sequence (key)
905 "Convert a key sequence to a list of events."
908 (mapcar (function (lambda (c)
910 (logxor c listify-key-sequence-1)
915 "True if the argument is an event object."
918 (and (symbolp obj) obj (not (keywordp obj)))
919 (and (consp obj) (symbolp (car obj))))))
921 (defun event-modifiers (event)
922 "Return a list of symbols representing the modifier keys in event EVENT.
923 The elements of the list may include `meta', `control',
924 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
926 EVENT may be an event or an event type. If EVENT is a symbol
927 that has never been used in an event that has been read as input
928 in the current Emacs session, then this function may fail to include
929 the `click' modifier."
932 (setq type (car type)))
934 ;; Don't read event-symbol-elements directly since we're not
935 ;; sure the symbol has already been parsed.
936 (cdr (internal-event-symbol-parse-modifiers type))
938 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
939 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
940 (if (not (zerop (logand type ?\M-\^@)))
942 (if (or (not (zerop (logand type ?\C-\^@)))
944 (push 'control list))
945 (if (or (not (zerop (logand type ?\S-\^@)))
946 (/= char (downcase char)))
948 (or (zerop (logand type ?\H-\^@))
950 (or (zerop (logand type ?\s-\^@))
952 (or (zerop (logand type ?\A-\^@))
956 (defun event-basic-type (event)
957 "Return the basic type of the given event (all modifiers removed).
958 The value is a printing character (not upper case) or a symbol.
959 EVENT may be an event or an event type. If EVENT is a symbol
960 that has never been used in an event that has been read as input
961 in the current Emacs session, then this function may return nil."
963 (setq event (car event)))
965 (car (get event 'event-symbol-elements))
966 (let* ((base (logand event (1- ?\A-\^@)))
967 (uncontrolled (if (< base 32) (logior base 64) base)))
968 ;; There are some numbers that are invalid characters and
969 ;; cause `downcase' to get an error.
971 (downcase uncontrolled)
972 (error uncontrolled)))))
974 (defsubst mouse-movement-p (object)
975 "Return non-nil if OBJECT is a mouse movement event."
976 (eq (car-safe object) 'mouse-movement))
978 (defun mouse-event-p (object)
979 "Return non-nil if OBJECT is a mouse click event."
980 ;; is this really correct? maybe remove mouse-movement?
981 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
983 (defun event-start (event)
984 "Return the starting position of EVENT.
985 EVENT should be a click, drag, or key press event.
986 If it is a key press event, the return value has the form
987 (WINDOW POS (0 . 0) 0)
988 If it is a click or drag event, it has the form
989 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
990 IMAGE (DX . DY) (WIDTH . HEIGHT))
991 The `posn-' functions access elements of such lists.
992 For more information, see Info node `(elisp)Click Events'.
994 If EVENT is a mouse or key press or a mouse click, this is the
995 position of the event. If EVENT is a drag, this is the starting
996 position of the drag."
997 (if (consp event) (nth 1 event)
999 (list (selected-window) (point) '(0 . 0) 0))))
1001 (defun event-end (event)
1002 "Return the ending location of EVENT.
1003 EVENT should be a click, drag, or key press event.
1004 If EVENT is a key press event, the return value has the form
1005 (WINDOW POS (0 . 0) 0)
1006 If EVENT is a click event, this function is the same as
1007 `event-start'. For click and drag events, the return value has
1009 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
1010 IMAGE (DX . DY) (WIDTH . HEIGHT))
1011 The `posn-' functions access elements of such lists.
1012 For more information, see Info node `(elisp)Click Events'.
1014 If EVENT is a mouse or key press or a mouse click, this is the
1015 position of the event. If EVENT is a drag, this is the starting
1016 position of the drag."
1017 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1019 (list (selected-window) (point) '(0 . 0) 0))))
1021 (defsubst event-click-count (event)
1022 "Return the multi-click count of EVENT, a click or drag event.
1023 The return value is a positive integer."
1024 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1026 ;;;; Extracting fields of the positions in an event.
1029 "Return non-nil if OBJ appears to be a valid `posn' object."
1030 (and (windowp (car-safe obj))
1031 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1032 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1033 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1035 (defsubst posn-window (position)
1036 "Return the window in POSITION.
1037 POSITION should be a list of the form returned by the `event-start'
1038 and `event-end' functions."
1041 (defsubst posn-area (position)
1042 "Return the window area recorded in POSITION, or nil for the text area.
1043 POSITION should be a list of the form returned by the `event-start'
1044 and `event-end' functions."
1045 (let ((area (if (consp (nth 1 position))
1046 (car (nth 1 position))
1048 (and (symbolp area) area)))
1050 (defsubst posn-point (position)
1051 "Return the buffer location in POSITION.
1052 POSITION should be a list of the form returned by the `event-start'
1053 and `event-end' functions."
1054 (or (nth 5 position)
1055 (if (consp (nth 1 position))
1056 (car (nth 1 position))
1059 (defun posn-set-point (position)
1060 "Move point to POSITION.
1061 Select the corresponding window as well."
1062 (if (not (windowp (posn-window position)))
1063 (error "Position not in text area of window"))
1064 (select-window (posn-window position))
1065 (if (numberp (posn-point position))
1066 (goto-char (posn-point position))))
1068 (defsubst posn-x-y (position)
1069 "Return the x and y coordinates in POSITION.
1070 The return value has the form (X . Y), where X and Y are given in
1071 pixels. POSITION should be a list of the form returned by
1072 `event-start' and `event-end'."
1075 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1077 (defun posn-col-row (position)
1078 "Return the nominal column and row in POSITION, measured in characters.
1079 The column and row values are approximations calculated from the x
1080 and y coordinates in POSITION and the frame's default character width
1082 For a scroll-bar event, the result column is 0, and the row
1083 corresponds to the vertical position of the click in the scroll bar.
1084 POSITION should be a list of the form returned by the `event-start'
1085 and `event-end' functions."
1086 (let* ((pair (posn-x-y position))
1087 (window (posn-window position))
1088 (area (posn-area position)))
1092 ((eq area 'vertical-scroll-bar)
1093 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1094 ((eq area 'horizontal-scroll-bar)
1095 (cons (scroll-bar-scale pair (window-width window)) 0))
1097 (let* ((frame (if (framep window) window (window-frame window)))
1098 ;; FIXME: This should take line-spacing properties on
1099 ;; newlines into account.
1100 (spacing (when (display-graphic-p frame)
1101 (or (with-current-buffer (window-buffer window)
1103 (frame-parameter frame 'line-spacing)))))
1104 (cond ((floatp spacing)
1105 (setq spacing (truncate (* spacing
1106 (frame-char-height frame)))))
1109 (cons (/ (car pair) (frame-char-width frame))
1110 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1111 (if (null (with-current-buffer (window-buffer window)
1112 header-line-format))
1115 (defun posn-actual-col-row (position)
1116 "Return the actual column and row in POSITION, measured in characters.
1117 These are the actual row number in the window and character number in that row.
1118 Return nil if POSITION does not contain the actual position; in that case
1119 `posn-col-row' can be used to get approximate values.
1120 POSITION should be a list of the form returned by the `event-start'
1121 and `event-end' functions."
1124 (defsubst posn-timestamp (position)
1125 "Return the timestamp of POSITION.
1126 POSITION should be a list of the form returned by the `event-start'
1127 and `event-end' functions."
1130 (defsubst posn-string (position)
1131 "Return the string object of POSITION.
1132 Value is a cons (STRING . STRING-POS), or nil if not a string.
1133 POSITION should be a list of the form returned by the `event-start'
1134 and `event-end' functions."
1137 (defsubst posn-image (position)
1138 "Return the image object of POSITION.
1139 Value is a list (image ...), or nil if not an image.
1140 POSITION should be a list of the form returned by the `event-start'
1141 and `event-end' functions."
1144 (defsubst posn-object (position)
1145 "Return the object (image or string) of POSITION.
1146 Value is a list (image ...) for an image object, a cons cell
1147 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1148 POSITION should be a list of the form returned by the `event-start'
1149 and `event-end' functions."
1150 (or (posn-image position) (posn-string position)))
1152 (defsubst posn-object-x-y (position)
1153 "Return the x and y coordinates relative to the object of POSITION.
1154 The return value has the form (DX . DY), where DX and DY are
1155 given in pixels. POSITION should be a list of the form returned
1156 by `event-start' and `event-end'."
1159 (defsubst posn-object-width-height (position)
1160 "Return the pixel width and height of the object of POSITION.
1161 The return value has the form (WIDTH . HEIGHT). POSITION should
1162 be a list of the form returned by `event-start' and `event-end'."
1166 ;;;; Obsolescent names for functions.
1168 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1169 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1170 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1171 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1172 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1173 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1175 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1176 (make-obsolete 'buffer-has-markers-at nil "24.3")
1178 (defun insert-string (&rest args)
1179 "Mocklisp-compatibility insert function.
1180 Like the function `insert' except that any argument that is a number
1181 is converted into a string by expressing it in decimal."
1182 (declare (obsolete insert "22.1"))
1184 (insert (if (integerp el) (number-to-string el) el))))
1186 (defun makehash (&optional test)
1187 (declare (obsolete make-hash-table "22.1"))
1188 (make-hash-table :test (or test 'eql)))
1190 ;; These are used by VM and some old programs
1191 (defalias 'focus-frame 'ignore "")
1192 (make-obsolete 'focus-frame "it does nothing." "22.1")
1193 (defalias 'unfocus-frame 'ignore "")
1194 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1195 (make-obsolete 'make-variable-frame-local
1196 "explicitly check for a frame-parameter instead." "22.2")
1197 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1198 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
1199 (set-advertised-calling-convention
1200 'all-completions '(string collection &optional predicate) "23.1")
1201 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1202 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1204 ;;;; Obsolescence declarations for variables, and aliases.
1206 ;; Special "default-FOO" variables which contain the default value of
1207 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1208 ;; slows down several unrelated variable operations; furthermore, they
1209 ;; can lead to really odd behavior if you decide to make them
1212 ;; Not used at all in Emacs, last time I checked:
1213 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1214 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1215 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1216 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1217 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1218 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1219 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1220 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1221 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1222 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1223 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1224 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1225 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1226 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1227 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1228 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1229 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1230 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1231 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1232 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1233 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1234 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1235 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1236 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1237 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1238 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1239 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1240 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1241 (make-obsolete-variable 'default-enable-multibyte-characters
1242 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1244 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1245 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1246 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1247 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1248 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1249 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1251 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1252 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1254 ;; Lisp manual only updated in 22.1.
1255 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1258 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1259 (make-obsolete-variable 'x-lost-selection-hooks
1260 'x-lost-selection-functions "22.1")
1261 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1262 (make-obsolete-variable 'x-sent-selection-hooks
1263 'x-sent-selection-functions "22.1")
1265 ;; This was introduced in 21.4 for pre-unicode unification. That
1266 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1267 ;; Other uses are possible, so this variable is not _really_ obsolete,
1268 ;; but Stefan insists to mark it so.
1269 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1271 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1273 ;;;; Alternate names for functions - these are not being phased out.
1275 (defalias 'send-string 'process-send-string)
1276 (defalias 'send-region 'process-send-region)
1277 (defalias 'string= 'string-equal)
1278 (defalias 'string< 'string-lessp)
1279 (defalias 'move-marker 'set-marker)
1280 (defalias 'rplaca 'setcar)
1281 (defalias 'rplacd 'setcdr)
1282 (defalias 'beep 'ding) ;preserve lingual purity
1283 (defalias 'indent-to-column 'indent-to)
1284 (defalias 'backward-delete-char 'delete-backward-char)
1285 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1286 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1287 (defalias 'int-to-string 'number-to-string)
1288 (defalias 'store-match-data 'set-match-data)
1289 (defalias 'chmod 'set-file-modes)
1290 (defalias 'mkdir 'make-directory)
1291 ;; These are the XEmacs names:
1292 (defalias 'point-at-eol 'line-end-position)
1293 (defalias 'point-at-bol 'line-beginning-position)
1295 (defalias 'user-original-login-name 'user-login-name)
1298 ;;;; Hook manipulation functions.
1300 (defun add-hook (hook function &optional append local)
1301 "Add to the value of HOOK the function FUNCTION.
1302 FUNCTION is not added if already present.
1303 FUNCTION is added (if necessary) at the beginning of the hook list
1304 unless the optional argument APPEND is non-nil, in which case
1305 FUNCTION is added at the end.
1307 The optional fourth argument, LOCAL, if non-nil, says to modify
1308 the hook's buffer-local value rather than its global value.
1309 This makes the hook buffer-local, and it makes t a member of the
1310 buffer-local value. That acts as a flag to run the hook
1311 functions of the global value as well as in the local value.
1313 HOOK should be a symbol, and FUNCTION may be any valid function. If
1314 HOOK is void, it is first set to nil. If HOOK's value is a single
1315 function, it is changed to a list of functions."
1316 (or (boundp hook) (set hook nil))
1317 (or (default-boundp hook) (set-default hook nil))
1318 (if local (unless (local-variable-if-set-p hook)
1319 (set (make-local-variable hook) (list t)))
1320 ;; Detect the case where make-local-variable was used on a hook
1321 ;; and do what we used to do.
1322 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1324 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1325 ;; If the hook value is a single function, turn it into a list.
1326 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1327 (setq hook-value (list hook-value)))
1328 ;; Do the actual addition if necessary
1329 (unless (member function hook-value)
1330 (when (stringp function)
1331 (setq function (purecopy function)))
1334 (append hook-value (list function))
1335 (cons function hook-value))))
1336 ;; Set the actual variable
1339 ;; If HOOK isn't a permanent local,
1340 ;; but FUNCTION wants to survive a change of modes,
1341 ;; mark HOOK as partially permanent.
1342 (and (symbolp function)
1343 (get function 'permanent-local-hook)
1344 (not (get hook 'permanent-local))
1345 (put hook 'permanent-local 'permanent-local-hook))
1346 (set hook hook-value))
1347 (set-default hook hook-value))))
1349 (defun remove-hook (hook function &optional local)
1350 "Remove from the value of HOOK the function FUNCTION.
1351 HOOK should be a symbol, and FUNCTION may be any valid function. If
1352 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1353 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1355 The optional third argument, LOCAL, if non-nil, says to modify
1356 the hook's buffer-local value rather than its default value."
1357 (or (boundp hook) (set hook nil))
1358 (or (default-boundp hook) (set-default hook nil))
1359 ;; Do nothing if LOCAL is t but this hook has no local binding.
1360 (unless (and local (not (local-variable-p hook)))
1361 ;; Detect the case where make-local-variable was used on a hook
1362 ;; and do what we used to do.
1363 (when (and (local-variable-p hook)
1364 (not (and (consp (symbol-value hook))
1365 (memq t (symbol-value hook)))))
1367 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1368 ;; Remove the function, for both the list and the non-list cases.
1369 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1370 (if (equal hook-value function) (setq hook-value nil))
1371 (setq hook-value (delete function (copy-sequence hook-value))))
1372 ;; If the function is on the global hook, we need to shadow it locally
1373 ;;(when (and local (member function (default-value hook))
1374 ;; (not (member (cons 'not function) hook-value)))
1375 ;; (push (cons 'not function) hook-value))
1376 ;; Set the actual variable
1378 (set-default hook hook-value)
1379 (if (equal hook-value '(t))
1380 (kill-local-variable hook)
1381 (set hook hook-value))))))
1383 (defmacro letrec (binders &rest body)
1384 "Bind variables according to BINDERS then eval BODY.
1385 The value of the last form in BODY is returned.
1386 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1387 SYMBOL to the value of VALUEFORM.
1388 All symbols are bound before the VALUEFORMs are evalled."
1389 ;; Only useful in lexical-binding mode.
1390 ;; As a special-form, we could implement it more efficiently (and cleanly,
1391 ;; making the vars actually unbound during evaluation of the binders).
1392 (declare (debug let) (indent 1))
1393 `(let ,(mapcar #'car binders)
1394 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1397 (defmacro with-wrapper-hook (hook args &rest body)
1398 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1399 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1400 around the preceding ones, like a set of nested `around' advices.
1402 Each hook function should accept an argument list consisting of a
1403 function FUN, followed by the additional arguments in ARGS.
1405 The first hook function in HOOK is passed a FUN that, if it is called
1406 with arguments ARGS, performs BODY (i.e., the default operation).
1407 The FUN passed to each successive hook function is defined based
1408 on the preceding hook functions; if called with arguments ARGS,
1409 it does what the `with-wrapper-hook' call would do if the
1410 preceding hook functions were the only ones present in HOOK.
1412 Each hook function may call its FUN argument as many times as it wishes,
1413 including never. In that case, such a hook function acts to replace
1414 the default definition altogether, and any preceding hook functions.
1415 Of course, a subsequent hook function may do the same thing.
1417 Each hook function definition is used to construct the FUN passed
1418 to the next hook function, if any. The last (or \"outermost\")
1419 FUN is then called once."
1420 (declare (indent 2) (debug (form sexp body)))
1421 ;; We need those two gensyms because CL's lexical scoping is not available
1422 ;; for function arguments :-(
1423 (let ((funs (make-symbol "funs"))
1424 (global (make-symbol "global"))
1425 (argssym (make-symbol "args"))
1426 (runrestofhook (make-symbol "runrestofhook")))
1427 ;; Since the hook is a wrapper, the loop has to be done via
1428 ;; recursion: a given hook function will call its parameter in order to
1429 ;; continue looping.
1430 `(letrec ((,runrestofhook
1431 (lambda (,funs ,global ,argssym)
1432 ;; `funs' holds the functions left on the hook and `global'
1433 ;; holds the functions left on the global part of the hook
1434 ;; (in case the hook is local).
1436 (if (eq t (car ,funs))
1437 (funcall ,runrestofhook
1438 (append ,global (cdr ,funs)) nil ,argssym)
1441 (lambda (,funs ,global &rest ,argssym)
1442 (funcall ,runrestofhook ,funs ,global ,argssym))
1443 (cdr ,funs) ,global)
1445 ;; Once there are no more functions on the hook, run
1446 ;; the original body.
1447 (apply (lambda ,args ,@body) ,argssym)))))
1448 (funcall ,runrestofhook ,hook
1449 ;; The global part of the hook, if any.
1451 `(if (local-variable-p ',hook)
1452 (default-value ',hook)))
1455 (defun add-to-list (list-var element &optional append compare-fn)
1456 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1457 The test for presence of ELEMENT is done with `equal',
1458 or with COMPARE-FN if that's non-nil.
1459 If ELEMENT is added, it is added at the beginning of the list,
1460 unless the optional argument APPEND is non-nil, in which case
1461 ELEMENT is added at the end.
1463 The return value is the new value of LIST-VAR.
1465 If you want to use `add-to-list' on a variable that is not defined
1466 until a certain package is loaded, you should put the call to `add-to-list'
1467 into a hook function that will be run only after loading the package.
1468 `eval-after-load' provides one way to do this. In some cases
1469 other hooks, such as major mode hooks, can do the job."
1472 (member element (symbol-value list-var)))
1473 ((eq compare-fn 'eq)
1474 (memq element (symbol-value list-var)))
1475 ((eq compare-fn 'eql)
1476 (memql element (symbol-value list-var)))
1478 (let ((lst (symbol-value list-var)))
1480 (not (funcall compare-fn element (car lst))))
1481 (setq lst (cdr lst)))
1483 (symbol-value list-var)
1486 (append (symbol-value list-var) (list element))
1487 (cons element (symbol-value list-var))))))
1490 (defun add-to-ordered-list (list-var element &optional order)
1491 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1492 The test for presence of ELEMENT is done with `eq'.
1494 The resulting list is reordered so that the elements are in the
1495 order given by each element's numeric list order. Elements
1496 without a numeric list order are placed at the end of the list.
1498 If the third optional argument ORDER is a number (integer or
1499 float), set the element's list order to the given value. If
1500 ORDER is nil or omitted, do not change the numeric order of
1501 ELEMENT. If ORDER has any other value, remove the numeric order
1502 of ELEMENT if it has one.
1504 The list order for each element is stored in LIST-VAR's
1505 `list-order' property.
1507 The return value is the new value of LIST-VAR."
1508 (let ((ordering (get list-var 'list-order)))
1510 (put list-var 'list-order
1511 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1513 (puthash element (and (numberp order) order) ordering))
1514 (unless (memq element (symbol-value list-var))
1515 (set list-var (cons element (symbol-value list-var))))
1516 (set list-var (sort (symbol-value list-var)
1518 (let ((oa (gethash a ordering))
1519 (ob (gethash b ordering)))
1524 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1525 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1526 Return the new history list.
1527 If MAXELT is non-nil, it specifies the maximum length of the history.
1528 Otherwise, the maximum history length is the value of the `history-length'
1529 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1531 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1532 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1533 if it is empty or a duplicate."
1535 (setq maxelt (or (get history-var 'history-length)
1537 (let ((history (symbol-value history-var))
1539 (when (and (listp history)
1541 (not (stringp newelt))
1542 (> (length newelt) 0))
1544 (not (equal (car history) newelt))))
1545 (if history-delete-duplicates
1546 (setq history (delete newelt history)))
1547 (setq history (cons newelt history))
1548 (when (integerp maxelt)
1551 (setq tail (nthcdr (1- maxelt) history))
1553 (setcdr tail nil)))))
1554 (set history-var history)))
1559 (defvar delay-mode-hooks nil
1560 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1561 (defvar delayed-mode-hooks nil
1562 "List of delayed mode hooks waiting to be run.")
1563 (make-variable-buffer-local 'delayed-mode-hooks)
1564 (put 'delay-mode-hooks 'permanent-local t)
1566 (defvar change-major-mode-after-body-hook nil
1567 "Normal hook run in major mode functions, before the mode hooks.")
1569 (defvar after-change-major-mode-hook nil
1570 "Normal hook run at the very end of major mode functions.")
1572 (defun run-mode-hooks (&rest hooks)
1573 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1574 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1575 just adds the HOOKS to the list `delayed-mode-hooks'.
1576 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1577 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1578 `after-change-major-mode-hook'. Major mode functions should use
1579 this instead of `run-hooks' when running their FOO-mode-hook."
1580 (if delay-mode-hooks
1582 (dolist (hook hooks)
1583 (push hook delayed-mode-hooks))
1584 ;; Normal case, just run the hook as before plus any delayed hooks.
1585 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1586 (setq delayed-mode-hooks nil)
1587 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1588 (run-hooks 'after-change-major-mode-hook)))
1590 (defmacro delay-mode-hooks (&rest body)
1591 "Execute BODY, but delay any `run-mode-hooks'.
1592 These hooks will be executed by the first following call to
1593 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1594 Only affects hooks run in the current buffer."
1595 (declare (debug t) (indent 0))
1597 (make-local-variable 'delay-mode-hooks)
1598 (let ((delay-mode-hooks t))
1601 ;; PUBLIC: find if the current mode derives from another.
1603 (defun derived-mode-p (&rest modes)
1604 "Non-nil if the current major mode is derived from one of MODES.
1605 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1606 (let ((parent major-mode))
1607 (while (and (not (memq parent modes))
1608 (setq parent (get parent 'derived-mode-parent))))
1613 ;; If a minor mode is not defined with define-minor-mode,
1614 ;; add it here explicitly.
1615 ;; isearch-mode is deliberately excluded, since you should
1616 ;; not call it yourself.
1617 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1618 overwrite-mode view-mode
1620 "List of all minor mode functions.")
1622 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1623 "Register a new minor mode.
1625 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1627 TOGGLE is a symbol which is the name of a buffer-local variable that
1628 is toggled on or off to say whether the minor mode is active or not.
1630 NAME specifies what will appear in the mode line when the minor mode
1631 is active. NAME should be either a string starting with a space, or a
1632 symbol whose value is such a string.
1634 Optional KEYMAP is the keymap for the minor mode that will be added
1635 to `minor-mode-map-alist'.
1637 Optional AFTER specifies that TOGGLE should be added after AFTER
1638 in `minor-mode-alist'.
1640 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1641 It defaults to (and should by convention be) TOGGLE.
1643 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1644 included in the mode-line minor mode menu.
1645 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1646 (unless (memq toggle minor-mode-list)
1647 (push toggle minor-mode-list))
1649 (unless toggle-fun (setq toggle-fun toggle))
1650 (unless (eq toggle-fun toggle)
1651 (put toggle :minor-mode-function toggle-fun))
1652 ;; Add the name to the minor-mode-alist.
1654 (let ((existing (assq toggle minor-mode-alist)))
1656 (setcdr existing (list name))
1657 (let ((tail minor-mode-alist) found)
1658 (while (and tail (not found))
1659 (if (eq after (caar tail))
1661 (setq tail (cdr tail))))
1663 (let ((rest (cdr found)))
1665 (nconc found (list (list toggle name)) rest))
1666 (push (list toggle name) minor-mode-alist))))))
1667 ;; Add the toggle to the minor-modes menu if requested.
1668 (when (get toggle :included)
1669 (define-key mode-line-mode-menu
1673 (or (get toggle :menu-tag)
1674 (if (stringp name) name (symbol-name toggle)))
1675 (let ((mode-name (if (symbolp name) (symbol-value name))))
1676 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1677 (concat " (" (match-string 0 mode-name) ")"))))
1679 :button (cons :toggle toggle))))
1681 ;; Add the map to the minor-mode-map-alist.
1683 (let ((existing (assq toggle minor-mode-map-alist)))
1685 (setcdr existing keymap)
1686 (let ((tail minor-mode-map-alist) found)
1687 (while (and tail (not found))
1688 (if (eq after (caar tail))
1690 (setq tail (cdr tail))))
1692 (let ((rest (cdr found)))
1694 (nconc found (list (cons toggle keymap)) rest))
1695 (push (cons toggle keymap) minor-mode-map-alist)))))))
1699 (defsubst autoloadp (object)
1700 "Non-nil if OBJECT is an autoload."
1701 (eq 'autoload (car-safe object)))
1703 ;; (defun autoload-type (object)
1704 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1705 ;; OBJECT should be an autoload object."
1706 ;; (when (autoloadp object)
1707 ;; (let ((type (nth 3 object)))
1708 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1709 ;; ((eq 'keymap t) 'macro)
1712 ;; (defalias 'autoload-file #'cadr
1713 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1714 ;; \n\(fn AUTOLOAD)")
1716 (defun symbol-file (symbol &optional type)
1717 "Return the name of the file that defined SYMBOL.
1718 The value is normally an absolute file name. It can also be nil,
1719 if the definition is not associated with any file. If SYMBOL
1720 specifies an autoloaded function, the value can be a relative
1721 file name without extension.
1723 If TYPE is nil, then any kind of definition is acceptable. If
1724 TYPE is `defun', `defvar', or `defface', that specifies function
1725 definition, variable definition, or face definition only."
1726 (if (and (or (null type) (eq type 'defun))
1727 (symbolp symbol) (fboundp symbol)
1728 (autoloadp (symbol-function symbol)))
1729 (nth 1 (symbol-function symbol))
1730 (let ((files load-history)
1734 (if (eq type 'defvar)
1735 ;; Variables are present just as their names.
1736 (member symbol (cdr (car files)))
1737 ;; Other types are represented as (TYPE . NAME).
1738 (member (cons type symbol) (cdr (car files))))
1739 ;; We accept all types, so look for variable def
1740 ;; and then for any other kind.
1741 (or (member symbol (cdr (car files)))
1742 (rassq symbol (cdr (car files)))))
1743 (setq file (car (car files)) files nil))
1744 (setq files (cdr files)))
1747 (defun locate-library (library &optional nosuffix path interactive-call)
1748 "Show the precise file name of Emacs library LIBRARY.
1749 LIBRARY should be a relative file name of the library, a string.
1750 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1751 nil (which is the default, see below).
1752 This command searches the directories in `load-path' like `\\[load-library]'
1753 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1754 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1755 to the specified name LIBRARY.
1757 If the optional third arg PATH is specified, that list of directories
1758 is used instead of `load-path'.
1760 When called from a program, the file name is normally returned as a
1761 string. When run interactively, the argument INTERACTIVE-CALL is t,
1762 and the file name is displayed in the echo area."
1763 (interactive (list (completing-read "Locate library: "
1765 'locate-file-completion-table
1766 load-path (get-load-suffixes)))
1769 (let ((file (locate-file library
1771 (append (unless nosuffix (get-load-suffixes))
1772 load-file-rep-suffixes))))
1773 (if interactive-call
1775 (message "Library is file %s" (abbreviate-file-name file))
1776 (message "No library %s in search path" library)))
1780 ;;;; Specifying things to do later.
1782 (defun load-history-regexp (file)
1783 "Form a regexp to find FILE in `load-history'.
1784 FILE, a string, is described in the function `eval-after-load'."
1785 (if (file-name-absolute-p file)
1786 (setq file (file-truename file)))
1787 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1789 (if (file-name-extension file)
1791 ;; Note: regexp-opt can't be used here, since we need to call
1792 ;; this before Emacs has been fully started. 2006-05-21
1793 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1794 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1797 (defun load-history-filename-element (file-regexp)
1798 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1799 Return nil if there isn't one."
1800 (let* ((loads load-history)
1801 (load-elt (and loads (car loads))))
1804 (or (null (car load-elt))
1805 (not (string-match file-regexp (car load-elt)))))
1806 (setq loads (cdr loads)
1807 load-elt (and loads (car loads)))))
1810 (put 'eval-after-load 'lisp-indent-function 1)
1811 (defun eval-after-load (file form)
1812 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
1813 If FILE is already loaded, evaluate FORM right now.
1815 If a matching file is loaded again, FORM will be evaluated again.
1817 If FILE is a string, it may be either an absolute or a relative file
1818 name, and may have an extension \(e.g. \".el\") or may lack one, and
1819 additionally may or may not have an extension denoting a compressed
1820 format \(e.g. \".gz\").
1822 When FILE is absolute, this first converts it to a true name by chasing
1823 symbolic links. Only a file of this name \(see next paragraph regarding
1824 extensions) will trigger the evaluation of FORM. When FILE is relative,
1825 a file whose absolute true name ends in FILE will trigger evaluation.
1827 When FILE lacks an extension, a file name with any extension will trigger
1828 evaluation. Otherwise, its extension must match FILE's. A further
1829 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1832 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1833 is evaluated at the end of any file that `provide's this feature.
1834 If the feature is provided when evaluating code not associated with a
1835 file, FORM is evaluated immediately after the provide statement.
1837 Usually FILE is just a library name like \"font-lock\" or a feature name
1840 This function makes or adds to an entry on `after-load-alist'."
1841 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1842 ;; evaluating it now).
1843 (let* ((regexp-or-feature
1845 (setq file (purecopy (load-history-regexp file)))
1847 (elt (assoc regexp-or-feature after-load-alist)))
1849 (setq elt (list regexp-or-feature))
1850 (push elt after-load-alist))
1851 ;; Make sure `form' is evalled in the current lexical/dynamic code.
1852 (setq form `(funcall ',(eval `(lambda () ,form) lexical-binding)))
1853 ;; Is there an already loaded file whose name (or `provide' name)
1855 (prog1 (if (if (stringp file)
1856 (load-history-filename-element regexp-or-feature)
1859 (when (symbolp regexp-or-feature)
1860 ;; For features, the after-load-alist elements get run when `provide' is
1861 ;; called rather than at the end of the file. So add an indirection to
1862 ;; make sure that `form' is really run "after-load" in case the provide
1863 ;; call happens early.
1866 (let ((fun (make-symbol "eval-after-load-helper")))
1867 (fset fun `(lambda (file)
1868 (if (not (equal file ',load-file-name))
1870 (remove-hook 'after-load-functions ',fun)
1872 (add-hook 'after-load-functions fun))
1873 ;; Not being provided from a file, run form right now.
1875 ;; Add FORM to the element unless it's already there.
1876 (unless (member form (cdr elt))
1877 (nconc elt (purecopy (list form)))))))
1879 (defvar after-load-functions nil
1880 "Special hook run after loading a file.
1881 Each function there is called with a single argument, the absolute
1882 name of the file just loaded.")
1884 (defun do-after-load-evaluation (abs-file)
1885 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1886 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1887 This function is called directly from the C code."
1888 ;; Run the relevant eval-after-load forms.
1889 (mapc #'(lambda (a-l-element)
1890 (when (and (stringp (car a-l-element))
1891 (string-match-p (car a-l-element) abs-file))
1892 ;; discard the file name regexp
1893 (mapc #'eval (cdr a-l-element))))
1895 ;; Complain when the user uses obsolete files.
1896 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1897 (run-with-timer 0 nil
1899 (message "Package %s is obsolete!"
1901 (string-match "\\.elc?\\>" file))))
1902 (file-name-nondirectory abs-file)))
1903 ;; Finally, run any other hook.
1904 (run-hook-with-args 'after-load-functions abs-file))
1906 (defun eval-next-after-load (file)
1907 "Read the following input sexp, and run it whenever FILE is loaded.
1908 This makes or adds to an entry on `after-load-alist'.
1909 FILE should be the name of a library, with no directory name."
1910 (declare (obsolete eval-after-load "23.2"))
1911 (eval-after-load file (read)))
1913 (defun display-delayed-warnings ()
1914 "Display delayed warnings from `delayed-warnings-list'.
1915 Used from `delayed-warnings-hook' (which see)."
1916 (dolist (warning (nreverse delayed-warnings-list))
1917 (apply 'display-warning warning))
1918 (setq delayed-warnings-list nil))
1920 (defun collapse-delayed-warnings ()
1921 "Remove duplicates from `delayed-warnings-list'.
1922 Collapse identical adjacent warnings into one (plus count).
1923 Used from `delayed-warnings-hook' (which see)."
1926 (while delayed-warnings-list
1927 (setq warning (pop delayed-warnings-list))
1928 (if (equal warning (car delayed-warnings-list))
1929 (setq count (1+ count))
1931 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
1934 (push warning collapsed)))
1935 (setq delayed-warnings-list (nreverse collapsed))))
1937 ;; At present this is only used for Emacs internals.
1938 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
1939 (defvar delayed-warnings-hook '(collapse-delayed-warnings
1940 display-delayed-warnings)
1941 "Normal hook run to process and display delayed warnings.
1942 By default, this hook contains functions to consolidate the
1943 warnings listed in `delayed-warnings-list', display them, and set
1944 `delayed-warnings-list' back to nil.")
1949 (defun process-lines (program &rest args)
1950 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1951 Signal an error if the program returns with a non-zero exit status."
1953 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1954 (unless (eq status 0)
1955 (error "%s exited with status %s" program status))
1956 (goto-char (point-min))
1959 (setq lines (cons (buffer-substring-no-properties
1960 (line-beginning-position)
1961 (line-end-position))
1964 (nreverse lines)))))
1966 (defun process-live-p (process)
1967 "Returns non-nil if PROCESS is alive.
1968 A process is considered alive if its status is `run', `open',
1969 `listen', `connect' or `stop'."
1970 (memq (process-status process)
1971 '(run open listen connect stop)))
1976 'process-kill-without-query
1977 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1979 (defun process-kill-without-query (process &optional _flag)
1980 "Say no query needed if PROCESS is running when Emacs is exited.
1981 Optional second argument if non-nil says to require a query.
1982 Value is t if a query was formerly required."
1983 (let ((old (process-query-on-exit-flag process)))
1984 (set-process-query-on-exit-flag process nil)
1987 (defun process-kill-buffer-query-function ()
1988 "Ask before killing a buffer that has a running process."
1989 (let ((process (get-buffer-process (current-buffer))))
1991 (not (memq (process-status process) '(run stop open listen)))
1992 (not (process-query-on-exit-flag process))
1994 (format "Buffer %S has a running process; kill it? "
1995 (buffer-name (current-buffer)))))))
1997 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1999 ;; process plist management
2001 (defun process-get (process propname)
2002 "Return the value of PROCESS' PROPNAME property.
2003 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
2004 (plist-get (process-plist process) propname))
2006 (defun process-put (process propname value)
2007 "Change PROCESS' PROPNAME property to VALUE.
2008 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2009 (set-process-plist process
2010 (plist-put (process-plist process) propname value)))
2013 ;;;; Input and display facilities.
2015 (defvar 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.")
2019 (custom-declare-variable-early
2020 'read-quoted-char-radix 8
2021 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2022 Legitimate radix values are 8, 10 and 16."
2023 :type '(choice (const 8) (const 10) (const 16))
2024 :group 'editing-basics)
2026 (defconst read-key-empty-map (make-sparse-keymap))
2028 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2030 (defun read-key (&optional prompt)
2031 "Read a key from the keyboard.
2032 Contrary to `read-event' this will not return a raw event but instead will
2033 obey the input decoding and translations usually done by `read-key-sequence'.
2034 So escape sequences and keyboard encoding are taken into account.
2035 When there's an ambiguity because the key looks like the prefix of
2036 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2037 ;; This overriding-terminal-local-map binding also happens to
2038 ;; disable quail's input methods, so although read-key-sequence
2039 ;; always inherits the input method, in practice read-key does not
2040 ;; inherit the input method (at least not if it's based on quail).
2041 (let ((overriding-terminal-local-map read-key-empty-map)
2042 (overriding-local-map nil)
2044 (old-global-map (current-global-map))
2045 (timer (run-with-idle-timer
2046 ;; Wait long enough that Emacs has the time to receive and
2047 ;; process all the raw events associated with the single-key.
2048 ;; But don't wait too long, or the user may find the delay
2049 ;; annoying (or keep hitting more keys which may then get
2050 ;; lost or misinterpreted).
2051 ;; This is only relevant for keys which Emacs perceives as
2052 ;; "prefixes", such as C-x (because of the C-x 8 map in
2053 ;; key-translate-table and the C-x @ map in function-key-map)
2054 ;; or ESC (because of terminal escape sequences in
2055 ;; input-decode-map).
2058 (let ((keys (this-command-keys-vector)))
2059 (unless (zerop (length keys))
2060 ;; `keys' is non-empty, so the user has hit at least
2061 ;; one key; there's no point waiting any longer, even
2062 ;; though read-key-sequence thinks we should wait
2063 ;; for more input to decide how to interpret the
2065 (throw 'read-key keys)))))))
2069 (let ((map (make-sparse-keymap)))
2070 ;; Don't hide the menu-bar and tool-bar entries.
2071 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2072 (define-key map [tool-bar]
2073 ;; This hack avoids evaluating the :filter (Bug#9922).
2074 (or (cdr (assq 'tool-bar global-map))
2075 (lookup-key global-map [tool-bar])))
2077 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
2078 (cancel-timer timer)
2079 (use-global-map old-global-map))))
2081 (defun read-quoted-char (&optional prompt)
2082 "Like `read-char', but do not allow quitting.
2083 Also, if the first character read is an octal digit,
2084 we read any number of octal digits and return the
2085 specified character code. Any nondigit terminates the sequence.
2086 If the terminator is RET, it is discarded;
2087 any other terminator is used itself as input.
2089 The optional argument PROMPT specifies a string to use to prompt the user.
2090 The variable `read-quoted-char-radix' controls which radix to use
2092 (let ((message-log-max nil) done (first t) (code 0) char translated)
2094 (let ((inhibit-quit first)
2095 ;; Don't let C-h get the help message--only help function keys.
2098 "Type the special character you want to use,
2099 or the octal character code.
2100 RET terminates the character code and is discarded;
2101 any other non-digit terminates the character code and is then used as input."))
2102 (setq char (read-event (and prompt (format "%s-" prompt)) t))
2103 (if inhibit-quit (setq quit-flag nil)))
2104 ;; Translate TAB key into control-I ASCII character, and so on.
2105 ;; Note: `read-char' does it using the `ascii-character' property.
2106 ;; We should try and use read-key instead.
2107 (let ((translation (lookup-key local-function-key-map (vector char))))
2108 (setq translated (if (arrayp translation)
2109 (aref translation 0)
2111 (if (integerp translated)
2112 (setq translated (char-resolve-modifiers translated)))
2113 (cond ((null translated))
2114 ((not (integerp translated))
2115 (setq unread-command-events (list char)
2117 ((/= (logand translated ?\M-\^@) 0)
2118 ;; Turn a meta-character into a character with the 0200 bit set.
2119 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
2121 ((and (<= ?0 translated)
2122 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
2123 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
2124 (and prompt (setq prompt (message "%s %c" prompt translated))))
2125 ((and (<= ?a (downcase translated))
2126 (< (downcase translated)
2127 (+ ?a -10 (min 36 read-quoted-char-radix))))
2128 (setq code (+ (* code read-quoted-char-radix)
2129 (+ 10 (- (downcase translated) ?a))))
2130 (and prompt (setq prompt (message "%s %c" prompt translated))))
2131 ((and (not first) (eq translated ?\C-m))
2134 (setq unread-command-events (list char)
2136 (t (setq code translated
2141 (defun read-passwd (prompt &optional confirm default)
2142 "Read a password, prompting with PROMPT, and return it.
2143 If optional CONFIRM is non-nil, read the password twice to make sure.
2144 Optional DEFAULT is a default password to use instead of empty input.
2146 This function echoes `.' for each character that the user types.
2148 Once the caller uses the password, it can erase the password
2149 by doing (clear-string STRING)."
2152 (while (not success)
2153 (let ((first (read-passwd prompt nil default))
2154 (second (read-passwd "Confirm password: " nil default)))
2155 (if (equal first second)
2157 (and (arrayp second) (clear-string second))
2158 (setq success first))
2159 (and (arrayp first) (clear-string first))
2160 (and (arrayp second) (clear-string second))
2161 (message "Password not repeated accurately; please start over")
2164 (let ((hide-chars-fun
2165 (lambda (beg end _len)
2166 (clear-this-command-keys)
2167 (setq beg (min end (max (minibuffer-prompt-end)
2169 (dotimes (i (- end beg))
2170 (put-text-property (+ i beg) (+ 1 i beg)
2171 'display (string ?.)))))
2173 (minibuffer-with-setup-hook
2175 (setq minibuf (current-buffer))
2176 ;; Turn off electricity.
2177 (set (make-local-variable 'post-self-insert-hook) nil)
2178 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2180 (let ((enable-recursive-minibuffers t))
2181 (read-string prompt nil t default)) ; t = "no history"
2182 (when (buffer-live-p minibuf)
2183 (with-current-buffer minibuf
2184 ;; Not sure why but it seems that there might be cases where the
2185 ;; minibuffer is not always properly reset later on, so undo
2186 ;; whatever we've done here (bug#11392).
2187 (remove-hook 'after-change-functions hide-chars-fun 'local)
2188 (kill-local-variable 'post-self-insert-hook)
2189 ;; And of course, don't keep the sensitive data around.
2190 (erase-buffer))))))))
2192 ;; This should be used by `call-interactively' for `n' specs.
2193 (defun read-number (prompt &optional default)
2194 "Read a numeric value in the minibuffer, prompting with PROMPT.
2195 DEFAULT specifies a default value to return if the user just types RET.
2196 The value of DEFAULT is inserted into PROMPT."
2198 (default1 (if (consp default) (car default) default)))
2201 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2202 (replace-match (format " (default %s)" default1) t t prompt 1)
2203 (replace-regexp-in-string "[ \t]*\\'"
2204 (format " (default %s) " default1)
2208 (let ((str (read-from-minibuffer
2209 prompt nil nil nil nil
2212 (mapcar 'number-to-string (delq nil default))
2213 (number-to-string default))))))
2216 ((zerop (length str)) default1)
2217 ((stringp str) (string-to-number str))))
2220 (message "Please enter a number.")
2225 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2226 "Read and return one of CHARS, prompting for PROMPT.
2227 Any input that is not one of CHARS is ignored.
2229 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2230 keyboard-quit events while waiting for a valid input."
2231 (unless (consp chars)
2232 (error "Called `read-char-choice' without valid char choices"))
2233 (let (char done show-help (helpbuf " *Char Help*"))
2234 (let ((cursor-in-echo-area t)
2235 (executing-kbd-macro executing-kbd-macro)
2237 (save-window-excursion ; in case we call help-form-show
2239 (unless (get-text-property 0 'face prompt)
2240 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2241 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2243 (and show-help (buffer-live-p (get-buffer helpbuf))
2244 (kill-buffer helpbuf))
2246 ((not (numberp char)))
2247 ;; If caller has set help-form, that's enough.
2248 ;; They don't explicitly have to add help-char to chars.
2255 ((and executing-kbd-macro (= char -1))
2256 ;; read-event returns -1 if we are in a kbd macro and
2257 ;; there are no more events in the macro. Attempt to
2258 ;; get an event interactively.
2259 (setq executing-kbd-macro nil))
2260 ((not inhibit-keyboard-quit)
2262 ((and (null esc-flag) (eq char ?\e))
2264 ((memq char '(?\C-g ?\e))
2265 (keyboard-quit))))))))
2266 ;; Display the question with the answer. But without cursor-in-echo-area.
2267 (message "%s%s" prompt (char-to-string char))
2270 (defun sit-for (seconds &optional nodisp obsolete)
2271 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2272 SECONDS may be a floating-point value.
2273 \(On operating systems that do not support waiting for fractions of a
2274 second, floating-point values are rounded down to the nearest integer.)
2276 If optional arg NODISP is t, don't redisplay, just wait for input.
2277 Redisplay does not happen if input is available before it starts.
2279 Value is t if waited the full time with no input arriving, and nil otherwise.
2281 An obsolete, but still supported form is
2282 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2283 where the optional arg MILLISECONDS specifies an additional wait period,
2284 in milliseconds; this was useful when Emacs was built without
2285 floating point support."
2286 (if (numberp nodisp)
2287 (setq seconds (+ seconds (* 1e-3 nodisp))
2289 (if obsolete (setq nodisp obsolete)))
2297 (or nodisp (redisplay)))
2299 (or nodisp (redisplay))
2300 (let ((read (read-event nil nil seconds)))
2303 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2304 ;; unread-command-events as (t . EVENT) so it will be added to
2305 ;; this-command-keys by read-key-sequence.
2306 (if (eq overriding-terminal-local-map universal-argument-map)
2307 (setq read (cons t read)))
2308 (push read unread-command-events)
2310 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2312 (defun y-or-n-p (prompt)
2313 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2314 PROMPT is the string to display to ask the question. It should
2315 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2317 No confirmation of the answer is requested; a single character is
2318 enough. SPC also means yes, and DEL means no.
2320 To be precise, this function translates user input into responses
2321 by consulting the bindings in `query-replace-map'; see the
2322 documentation of that variable for more information. In this
2323 case, the useful bindings are `act', `skip', `recenter',
2324 `scroll-up', `scroll-down', and `quit'.
2325 An `act' response means yes, and a `skip' response means no.
2326 A `quit' response means to invoke `keyboard-quit'.
2327 If the user enters `recenter', `scroll-up', or `scroll-down'
2328 responses, perform the requested window recentering or scrolling
2331 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2332 is nil and `use-dialog-box' is non-nil."
2333 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2334 ;; where all the keys were unbound (i.e. it somehow got triggered
2335 ;; within read-key, apparently). I had to kill it.
2336 (let ((answer 'recenter))
2339 (setq prompt (concat prompt
2340 (if (eq ?\s (aref prompt (1- (length prompt))))
2343 (let ((temp-prompt prompt))
2344 (while (not (memq answer '(act skip)))
2345 (let ((str (read-string temp-prompt)))
2346 (cond ((member str '("y" "Y")) (setq answer 'act))
2347 ((member str '("n" "N")) (setq answer 'skip))
2348 (t (setq temp-prompt (concat "Please answer y or n. "
2350 ((and (display-popup-menus-p)
2351 (listp last-nonmenu-event)
2354 (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2356 (setq prompt (concat prompt
2357 (if (eq ?\s (aref prompt (1- (length prompt))))
2361 (let* ((scroll-actions '(recenter scroll-up scroll-down
2362 scroll-other-window scroll-other-window-down))
2364 (let ((cursor-in-echo-area t))
2365 (when minibuffer-auto-raise
2366 (raise-frame (window-frame (minibuffer-window))))
2367 (read-key (propertize (if (memq answer scroll-actions)
2369 (concat "Please answer y or n. "
2371 'face 'minibuffer-prompt)))))
2372 (setq answer (lookup-key query-replace-map (vector key) t))
2374 ((memq answer '(skip act)) nil)
2375 ((eq answer 'recenter)
2377 ((eq answer 'scroll-up)
2378 (ignore-errors (scroll-up-command)) t)
2379 ((eq answer 'scroll-down)
2380 (ignore-errors (scroll-down-command)) t)
2381 ((eq answer 'scroll-other-window)
2382 (ignore-errors (scroll-other-window)) t)
2383 ((eq answer 'scroll-other-window-down)
2384 (ignore-errors (scroll-other-window-down)) t)
2385 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2386 (signal 'quit nil) t)
2390 (let ((ret (eq answer 'act)))
2391 (unless noninteractive
2392 ;; FIXME this prints one too many spaces, since prompt
2393 ;; already ends in a space. Eg "... (y or n) y".
2394 (message "%s %s" prompt (if ret "y" "n")))
2398 ;;; Atomic change groups.
2400 (defmacro atomic-change-group (&rest body)
2401 "Perform BODY as an atomic change group.
2402 This means that if BODY exits abnormally,
2403 all of its changes to the current buffer are undone.
2404 This works regardless of whether undo is enabled in the buffer.
2406 This mechanism is transparent to ordinary use of undo;
2407 if undo is enabled in the buffer and BODY succeeds, the
2408 user can undo the change normally."
2409 (declare (indent 0) (debug t))
2410 (let ((handle (make-symbol "--change-group-handle--"))
2411 (success (make-symbol "--change-group-success--")))
2412 `(let ((,handle (prepare-change-group))
2413 ;; Don't truncate any undo data in the middle of this.
2414 (undo-outer-limit nil)
2415 (undo-limit most-positive-fixnum)
2416 (undo-strong-limit most-positive-fixnum)
2420 ;; This is inside the unwind-protect because
2421 ;; it enables undo if that was disabled; we need
2422 ;; to make sure that it gets disabled again.
2423 (activate-change-group ,handle)
2426 ;; Either of these functions will disable undo
2427 ;; if it was disabled before.
2429 (accept-change-group ,handle)
2430 (cancel-change-group ,handle))))))
2432 (defun prepare-change-group (&optional buffer)
2433 "Return a handle for the current buffer's state, for a change group.
2434 If you specify BUFFER, make a handle for BUFFER's state instead.
2436 Pass the handle to `activate-change-group' afterward to initiate
2437 the actual changes of the change group.
2439 To finish the change group, call either `accept-change-group' or
2440 `cancel-change-group' passing the same handle as argument. Call
2441 `accept-change-group' to accept the changes in the group as final;
2442 call `cancel-change-group' to undo them all. You should use
2443 `unwind-protect' to make sure the group is always finished. The call
2444 to `activate-change-group' should be inside the `unwind-protect'.
2445 Once you finish the group, don't use the handle again--don't try to
2446 finish the same group twice. For a simple example of correct use, see
2447 the source code of `atomic-change-group'.
2449 The handle records only the specified buffer. To make a multibuffer
2450 change group, call this function once for each buffer you want to
2451 cover, then use `nconc' to combine the returned values, like this:
2453 (nconc (prepare-change-group buffer-1)
2454 (prepare-change-group buffer-2))
2456 You can then activate that multibuffer change group with a single
2457 call to `activate-change-group' and finish it with a single call
2458 to `accept-change-group' or `cancel-change-group'."
2461 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2462 (list (cons (current-buffer) buffer-undo-list))))
2464 (defun activate-change-group (handle)
2465 "Activate a change group made with `prepare-change-group' (which see)."
2466 (dolist (elt handle)
2467 (with-current-buffer (car elt)
2468 (if (eq buffer-undo-list t)
2469 (setq buffer-undo-list nil)))))
2471 (defun accept-change-group (handle)
2472 "Finish a change group made with `prepare-change-group' (which see).
2473 This finishes the change group by accepting its changes as final."
2474 (dolist (elt handle)
2475 (with-current-buffer (car elt)
2476 (if (eq (cdr elt) t)
2477 (setq buffer-undo-list t)))))
2479 (defun cancel-change-group (handle)
2480 "Finish a change group made with `prepare-change-group' (which see).
2481 This finishes the change group by reverting all of its changes."
2482 (dolist (elt handle)
2483 (with-current-buffer (car elt)
2484 (setq elt (cdr elt))
2486 ;; Widen buffer temporarily so if the buffer was narrowed within
2487 ;; the body of `atomic-change-group' all changes can be undone.
2490 (if (consp elt) (car elt)))
2492 (if (consp elt) (cdr elt))))
2493 ;; Temporarily truncate the undo log at ELT.
2495 (setcar elt nil) (setcdr elt nil))
2496 (unless (eq last-command 'undo) (undo-start))
2497 ;; Make sure there's no confusion.
2498 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2499 (error "Undoing to some unrelated state"))
2502 (while (listp pending-undo-list) (undo-more 1)))
2503 ;; Reset the modified cons cell ELT to its original content.
2505 (setcar elt old-car)
2506 (setcdr elt old-cdr))
2507 ;; Revert the undo info to what it was when we grabbed the state.
2508 (setq buffer-undo-list elt))))))
2510 ;;;; Display-related functions.
2512 ;; For compatibility.
2513 (define-obsolete-function-alias 'redraw-modeline
2514 'force-mode-line-update "24.3")
2516 (defun force-mode-line-update (&optional all)
2517 "Force redisplay of the current buffer's mode line and header line.
2518 With optional non-nil ALL, force redisplay of all mode lines and
2519 header lines. This function also forces recomputation of the
2520 menu bar menus and the frame title."
2521 (if all (with-current-buffer (other-buffer)))
2522 (set-buffer-modified-p (buffer-modified-p)))
2524 (defun momentary-string-display (string pos &optional exit-char message)
2525 "Momentarily display STRING in the buffer at POS.
2526 Display remains until next event is input.
2527 If POS is a marker, only its position is used; its buffer is ignored.
2528 Optional third arg EXIT-CHAR can be a character, event or event
2529 description list. EXIT-CHAR defaults to SPC. If the input is
2530 EXIT-CHAR it is swallowed; otherwise it is then available as
2531 input (as a command if nothing else).
2532 Display MESSAGE (optional fourth arg) in the echo area.
2533 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2534 (or exit-char (setq exit-char ?\s))
2535 (let ((ol (make-overlay pos pos))
2536 (str (copy-sequence string)))
2540 (overlay-put ol 'after-string str)
2542 ;; To avoid trouble with out-of-bounds position
2544 ;; If the string end is off screen, recenter now.
2545 (if (<= (window-end nil t) pos)
2546 (recenter (/ (window-height) 2))))
2547 (message (or message "Type %s to continue editing.")
2548 (single-key-description exit-char))
2549 (let ((event (read-event)))
2550 ;; `exit-char' can be an event, or an event description list.
2551 (or (eq event exit-char)
2552 (eq event (event-convert-list exit-char))
2553 (setq unread-command-events (list event)))))
2554 (delete-overlay ol))))
2557 ;;;; Overlay operations
2559 (defun copy-overlay (o)
2560 "Return a copy of overlay O."
2561 (let ((o1 (if (overlay-buffer o)
2562 (make-overlay (overlay-start o) (overlay-end o)
2563 ;; FIXME: there's no easy way to find the
2564 ;; insertion-type of the two markers.
2566 (let ((o1 (make-overlay (point-min) (point-min))))
2569 (props (overlay-properties o)))
2571 (overlay-put o1 (pop props) (pop props)))
2574 (defun remove-overlays (&optional beg end name val)
2575 "Clear BEG and END of overlays whose property NAME has value VAL.
2576 Overlays might be moved and/or split.
2577 BEG and END default respectively to the beginning and end of buffer."
2578 ;; This speeds up the loops over overlays.
2579 (unless beg (setq beg (point-min)))
2580 (unless end (setq end (point-max)))
2581 (overlay-recenter end)
2583 (setq beg (prog1 end (setq end beg))))
2585 (dolist (o (overlays-in beg end))
2586 (when (eq (overlay-get o name) val)
2587 ;; Either push this overlay outside beg...end
2588 ;; or split it to exclude beg...end
2589 ;; or delete it entirely (if it is contained in beg...end).
2590 (if (< (overlay-start o) beg)
2591 (if (> (overlay-end o) end)
2593 (move-overlay (copy-overlay o)
2594 (overlay-start o) beg)
2595 (move-overlay o end (overlay-end o)))
2596 (move-overlay o (overlay-start o) beg))
2597 (if (> (overlay-end o) end)
2598 (move-overlay o end (overlay-end o))
2599 (delete-overlay o)))))))
2603 (defvar suspend-hook nil
2604 "Normal hook run by `suspend-emacs', before suspending.")
2606 (defvar suspend-resume-hook nil
2607 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2609 (defvar temp-buffer-show-hook nil
2610 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2611 When the hook runs, the temporary buffer is current, and the window it
2612 was displayed in is selected.")
2614 (defvar temp-buffer-setup-hook nil
2615 "Normal hook run by `with-output-to-temp-buffer' at the start.
2616 When the hook runs, the temporary buffer is current.
2617 This hook is normally set up with a function to put the buffer in Help
2620 ;; Avoid compiler warnings about this variable,
2621 ;; which has a special meaning on certain system types.
2622 (defvar buffer-file-type nil
2623 "Non-nil if the visited file is a binary file.
2624 This variable is meaningful on MS-DOG and Windows NT.
2625 On those systems, it is automatically local in every buffer.
2626 On other systems, this variable is normally always nil.")
2628 ;; The `assert' macro from the cl package signals
2629 ;; `cl-assertion-failed' at runtime so always define it.
2630 (put 'cl-assertion-failed 'error-conditions '(error))
2631 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2633 (defconst user-emacs-directory
2634 (if (eq system-type 'ms-dos)
2635 ;; MS-DOS cannot have initial dot.
2638 "Directory beneath which additional per-user Emacs-specific files are placed.
2639 Various programs in Emacs store information in this directory.
2640 Note that this should end with a directory separator.
2641 See also `locate-user-emacs-file'.")
2643 (defun locate-user-emacs-file (new-name &optional old-name)
2644 "Return an absolute per-user Emacs-specific file name.
2645 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2646 Else return NEW-NAME in `user-emacs-directory', creating the
2647 directory if it does not exist."
2648 (convert-standard-filename
2649 (let* ((home (concat "~" (or init-file-user "")))
2650 (at-home (and old-name (expand-file-name old-name home))))
2651 (if (and at-home (file-readable-p at-home))
2653 ;; Make sure `user-emacs-directory' exists,
2654 ;; unless we're in batch mode or dumping Emacs
2657 (file-accessible-directory-p
2658 (directory-file-name user-emacs-directory))
2659 (let ((umask (default-file-modes)))
2662 (set-default-file-modes ?\700)
2663 (make-directory user-emacs-directory))
2664 (set-default-file-modes umask))))
2665 (abbreviate-file-name
2666 (expand-file-name new-name user-emacs-directory))))))
2668 ;;;; Misc. useful functions.
2670 (defsubst buffer-narrowed-p ()
2671 "Return non-nil if the current buffer is narrowed."
2672 (/= (- (point-max) (point-min)) (buffer-size)))
2674 (defun find-tag-default ()
2675 "Determine default tag to search for, based on text at point.
2676 If there is no plausible default, return nil."
2677 (let (from to bound)
2679 ;; Look at text around `point'.
2681 (skip-syntax-backward "w_") (setq from (point)))
2683 (skip-syntax-forward "w_") (setq to (point)))
2685 ;; Look between `line-beginning-position' and `point'.
2687 (and (setq bound (line-beginning-position))
2688 (skip-syntax-backward "^w_" bound)
2689 (> (setq to (point)) bound)
2690 (skip-syntax-backward "w_")
2691 (setq from (point))))
2692 ;; Look between `point' and `line-end-position'.
2694 (and (setq bound (line-end-position))
2695 (skip-syntax-forward "^w_" bound)
2696 (< (setq from (point)) bound)
2697 (skip-syntax-forward "w_")
2698 (setq to (point)))))
2699 (buffer-substring-no-properties from to))))
2701 (defun play-sound (sound)
2702 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2703 The following keywords are recognized:
2705 :file FILE - read sound data from FILE. If FILE isn't an
2706 absolute file name, it is searched in `data-directory'.
2708 :data DATA - read sound data from string DATA.
2710 Exactly one of :file or :data must be present.
2712 :volume VOL - set volume to VOL. VOL must an integer in the
2713 range 0..100 or a float in the range 0..1.0. If not specified,
2714 don't change the volume setting of the sound device.
2716 :device DEVICE - play sound on DEVICE. If not specified,
2717 a system-dependent default device name is used.
2719 Note: :data and :device are currently not supported on Windows."
2720 (if (fboundp 'play-sound-internal)
2721 (play-sound-internal sound)
2722 (error "This Emacs binary lacks sound support")))
2724 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2726 (defun shell-quote-argument (argument)
2727 "Quote ARGUMENT for passing as argument to an inferior shell."
2729 ((eq system-type 'ms-dos)
2730 ;; Quote using double quotes, but escape any existing quotes in
2731 ;; the argument with backslashes.
2735 (if (or (null (string-match "[^\"]" argument))
2736 (< (match-end 0) (length argument)))
2737 (while (string-match "[\"]" argument start)
2738 (setq end (match-beginning 0)
2739 result (concat result (substring argument start end)
2740 "\\" (substring argument end (1+ end)))
2742 (concat "\"" result (substring argument start) "\"")))
2744 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2746 ;; First, quote argument so that CommandLineToArgvW will
2747 ;; understand it. See
2748 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2749 ;; After we perform that level of quoting, escape shell
2750 ;; metacharacters so that cmd won't mangle our argument. If the
2751 ;; argument contains no double quote characters, we can just
2752 ;; surround it with double quotes. Otherwise, we need to prefix
2753 ;; each shell metacharacter with a caret.
2756 ;; escape backslashes at end of string
2757 (replace-regexp-in-string
2760 ;; escape backslashes and quotes in string body
2761 (replace-regexp-in-string
2766 (if (string-match "[%!\"]" argument)
2769 (replace-regexp-in-string
2770 "\\([%!()\"<>&|^]\\)"
2774 (concat "\"" argument "\"")))
2777 (if (equal argument "")
2779 ;; Quote everything except POSIX filename characters.
2780 ;; This should be safe enough even for really weird shells.
2781 (replace-regexp-in-string
2783 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2786 (defun string-or-null-p (object)
2787 "Return t if OBJECT is a string or nil.
2788 Otherwise, return nil."
2789 (or (stringp object) (null object)))
2791 (defun booleanp (object)
2792 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2793 Otherwise, return nil."
2794 (and (memq object '(nil t)) t))
2796 (defun field-at-pos (pos)
2797 "Return the field at position POS, taking stickiness etc into account."
2798 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2799 (if (eq raw-field 'boundary)
2800 (get-char-property (1- (field-end pos)) 'field)
2803 (defun sha1 (object &optional start end binary)
2804 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2805 OBJECT is either a string or a buffer. Optional arguments START and
2806 END are character positions specifying which portion of OBJECT for
2807 computing the hash. If BINARY is non-nil, return a string in binary
2809 (secure-hash 'sha1 object start end binary))
2811 (defun function-get (f prop &optional autoload)
2812 "Return the value of property PROP of function F.
2813 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2814 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2815 if it's an autoloaded macro."
2817 (while (and (symbolp f)
2818 (null (setq val (get f prop)))
2820 (let ((fundef (symbol-function f)))
2821 (if (and autoload (autoloadp fundef)
2823 (autoload-do-load fundef f
2824 (if (eq autoload 'macro)
2826 nil ;Re-try `get' on the same `f'.
2830 ;;;; Support for yanking and text properties.
2832 (defvar yank-handled-properties)
2833 (defvar yank-excluded-properties)
2835 (defun remove-yank-excluded-properties (start end)
2836 "Process text properties between START and END, inserted for a `yank'.
2837 Perform the handling specified by `yank-handled-properties', then
2838 remove properties specified by `yank-excluded-properties'."
2839 (let ((inhibit-read-only t))
2840 (dolist (handler yank-handled-properties)
2841 (let ((prop (car handler))
2844 (while (< run-start end)
2845 (let ((value (get-text-property run-start prop))
2846 (run-end (next-single-property-change
2847 run-start prop nil end)))
2848 (funcall fun value run-start run-end)
2849 (setq run-start run-end)))))
2850 (if (eq yank-excluded-properties t)
2851 (set-text-properties start end nil)
2852 (remove-list-of-text-properties start end yank-excluded-properties))))
2854 (defvar yank-undo-function)
2856 (defun insert-for-yank (string)
2857 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2859 See `insert-for-yank-1' for more details."
2861 (while (setq to (next-single-property-change 0 'yank-handler string))
2862 (insert-for-yank-1 (substring string 0 to))
2863 (setq string (substring string to))))
2864 (insert-for-yank-1 string))
2866 (defun insert-for-yank-1 (string)
2867 "Insert STRING at point for the `yank' command.
2868 This function is like `insert', except it honors the variables
2869 `yank-handled-properties' and `yank-excluded-properties', and the
2870 `yank-handler' text property.
2872 Properties listed in `yank-handled-properties' are processed,
2873 then those listed in `yank-excluded-properties' are discarded.
2875 If STRING has a non-nil `yank-handler' property on its first
2876 character, the normal insert behavior is altered. The value of
2877 the `yank-handler' property must be a list of one to four
2878 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2879 FUNCTION, if non-nil, should be a function of one argument, an
2880 object to insert; it is called instead of `insert'.
2881 PARAM, if present and non-nil, replaces STRING as the argument to
2882 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2883 may be a list of strings to insert as a rectangle.
2884 If NOEXCLUDE is present and non-nil, the normal removal of
2885 `yank-excluded-properties' is not performed; instead FUNCTION is
2886 responsible for the removal. This may be necessary if FUNCTION
2887 adjusts point before or after inserting the object.
2888 UNDO, if present and non-nil, should be a function to be called
2889 by `yank-pop' to undo the insertion of the current object. It is
2890 given two arguments, the start and end of the region. FUNCTION
2891 may set `yank-undo-function' to override UNDO."
2892 (let* ((handler (and (stringp string)
2893 (get-text-property 0 'yank-handler string)))
2894 (param (or (nth 1 handler) string))
2896 (inhibit-read-only inhibit-read-only)
2899 (setq yank-undo-function t)
2900 (if (nth 0 handler) ; FUNCTION
2901 (funcall (car handler) param)
2905 ;; Prevent read-only properties from interfering with the
2906 ;; following text property changes.
2907 (setq inhibit-read-only t)
2909 (unless (nth 2 handler) ; NOEXCLUDE
2910 (remove-yank-excluded-properties opoint end))
2912 ;; If last inserted char has properties, mark them as rear-nonsticky.
2913 (if (and (> end opoint)
2914 (text-properties-at (1- end)))
2915 (put-text-property (1- end) end 'rear-nonsticky t))
2917 (if (eq yank-undo-function t) ; not set by FUNCTION
2918 (setq yank-undo-function (nth 3 handler))) ; UNDO
2919 (if (nth 4 handler) ; COMMAND
2920 (setq this-command (nth 4 handler)))))
2922 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2923 "Insert before point a substring of BUFFER, without text properties.
2924 BUFFER may be a buffer or a buffer name.
2925 Arguments START and END are character positions specifying the substring.
2926 They default to the values of (point-min) and (point-max) in BUFFER."
2927 (let ((opoint (point)))
2928 (insert-buffer-substring buffer start end)
2929 (let ((inhibit-read-only t))
2930 (set-text-properties opoint (point) nil))))
2932 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2933 "Insert before point a part of BUFFER, stripping some text properties.
2934 BUFFER may be a buffer or a buffer name.
2935 Arguments START and END are character positions specifying the substring.
2936 They default to the values of (point-min) and (point-max) in BUFFER.
2937 Strip text properties from the inserted text according to
2938 `yank-excluded-properties'."
2939 ;; Since the buffer text should not normally have yank-handler properties,
2940 ;; there is no need to handle them here.
2941 (let ((opoint (point)))
2942 (insert-buffer-substring buffer start end)
2943 (remove-yank-excluded-properties opoint (point))))
2945 (defun yank-handle-font-lock-face-property (face start end)
2946 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2947 START and END denote the start and end of the text to act on.
2948 Do nothing if FACE is nil."
2950 (null font-lock-defaults)
2951 (put-text-property start end 'face face)))
2953 ;; This removes `mouse-face' properties in *Help* buffer buttons:
2954 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2955 (defun yank-handle-category-property (category start end)
2956 "Apply property category CATEGORY's properties between START and END."
2958 (let ((start2 start))
2959 (while (< start2 end)
2960 (let ((end2 (next-property-change start2 nil end))
2961 (original (text-properties-at start2)))
2962 (set-text-properties start2 end2 (symbol-plist category))
2963 (add-text-properties start2 end2 original)
2964 (setq start2 end2))))))
2967 ;;;; Synchronous shell commands.
2969 (defun start-process-shell-command (name buffer &rest args)
2970 "Start a program in a subprocess. Return the process object for it.
2971 NAME is name for process. It is modified if necessary to make it unique.
2972 BUFFER is the buffer (or buffer name) to associate with the process.
2973 Process output goes at end of that buffer, unless you specify
2974 an output stream or filter function to handle the output.
2975 BUFFER may be also nil, meaning that this process is not associated
2977 COMMAND is the shell command to run.
2979 An old calling convention accepted any number of arguments after COMMAND,
2980 which were just concatenated to COMMAND. This is still supported but strongly
2982 ;; We used to use `exec' to replace the shell with the command,
2983 ;; but that failed to handle (...) and semicolon, etc.
2984 (start-process name buffer shell-file-name shell-command-switch
2985 (mapconcat 'identity args " ")))
2986 (set-advertised-calling-convention 'start-process-shell-command
2987 '(name buffer command) "23.1")
2989 (defun start-file-process-shell-command (name buffer &rest args)
2990 "Start a program in a subprocess. Return the process object for it.
2991 Similar to `start-process-shell-command', but calls `start-file-process'."
2994 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2995 (if (file-remote-p default-directory) "-c" shell-command-switch)
2996 (mapconcat 'identity args " ")))
2997 (set-advertised-calling-convention 'start-file-process-shell-command
2998 '(name buffer command) "23.1")
3000 (defun call-process-shell-command (command &optional infile buffer display
3002 "Execute the shell command COMMAND synchronously in separate process.
3003 The remaining arguments are optional.
3004 The program's input comes from file INFILE (nil means `/dev/null').
3005 Insert output in BUFFER before point; t means current buffer;
3006 nil for BUFFER means discard it; 0 means discard and don't wait.
3007 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3008 REAL-BUFFER says what to do with standard output, as above,
3009 while STDERR-FILE says what to do with standard error in the child.
3010 STDERR-FILE may be nil (discard standard error output),
3011 t (mix it with ordinary output), or a file name string.
3013 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
3014 Remaining arguments are strings passed as additional arguments for COMMAND.
3015 Wildcards and redirection are handled as usual in the shell.
3017 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
3018 Otherwise it waits for COMMAND to terminate and returns a numeric exit
3019 status or a signal description string.
3020 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
3021 ;; We used to use `exec' to replace the shell with the command,
3022 ;; but that failed to handle (...) and semicolon, etc.
3023 (call-process shell-file-name
3024 infile buffer display
3025 shell-command-switch
3026 (mapconcat 'identity (cons command args) " ")))
3028 (defun process-file-shell-command (command &optional infile buffer display
3030 "Process files synchronously in a separate process.
3031 Similar to `call-process-shell-command', but calls `process-file'."
3033 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3034 infile buffer display
3035 (if (file-remote-p default-directory) "-c" shell-command-switch)
3036 (mapconcat 'identity (cons command args) " ")))
3038 ;;;; Lisp macros to do various things temporarily.
3040 (defmacro with-current-buffer (buffer-or-name &rest body)
3041 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3042 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3043 The value returned is the value of the last form in BODY. See
3044 also `with-temp-buffer'."
3045 (declare (indent 1) (debug t))
3046 `(save-current-buffer
3047 (set-buffer ,buffer-or-name)
3050 (defun internal--before-with-selected-window (window)
3051 (let ((other-frame (window-frame window)))
3052 (list window (selected-window)
3053 ;; Selecting a window on another frame also changes that
3054 ;; frame's frame-selected-window. We must save&restore it.
3055 (unless (eq (selected-frame) other-frame)
3056 (frame-selected-window other-frame))
3057 ;; Also remember the top-frame if on ttys.
3058 (unless (eq (selected-frame) other-frame)
3059 (tty-top-frame other-frame)))))
3061 (defun internal--after-with-selected-window (state)
3062 ;; First reset frame-selected-window.
3063 (when (window-live-p (nth 2 state))
3064 ;; We don't use set-frame-selected-window because it does not
3065 ;; pass the `norecord' argument to Fselect_window.
3066 (select-window (nth 2 state) 'norecord)
3067 (and (frame-live-p (nth 3 state))
3068 (not (eq (tty-top-frame) (nth 3 state)))
3069 (select-frame (nth 3 state) 'norecord)))
3070 ;; Then reset the actual selected-window.
3071 (when (window-live-p (nth 1 state))
3072 (select-window (nth 1 state) 'norecord)))
3074 (defmacro with-selected-window (window &rest body)
3075 "Execute the forms in BODY with WINDOW as the selected window.
3076 The value returned is the value of the last form in BODY.
3078 This macro saves and restores the selected window, as well as the
3079 selected window of each frame. It does not change the order of
3080 recently selected windows. If the previously selected window of
3081 some frame is no longer live at the end of BODY, that frame's
3082 selected window is left alone. If the selected window is no
3083 longer live, then whatever window is selected at the end of BODY
3086 This macro uses `save-current-buffer' to save and restore the
3087 current buffer, since otherwise its normal operation could
3088 potentially make a different buffer current. It does not alter
3089 the buffer list ordering."
3090 (declare (indent 1) (debug t))
3091 `(let ((save-selected-window--state
3092 (internal--before-with-selected-window ,window)))
3093 (save-current-buffer
3095 (progn (select-window (car save-selected-window--state) 'norecord)
3097 (internal--after-with-selected-window save-selected-window--state)))))
3099 (defmacro with-selected-frame (frame &rest body)
3100 "Execute the forms in BODY with FRAME as the selected frame.
3101 The value returned is the value of the last form in BODY.
3103 This macro saves and restores the selected frame, and changes the
3104 order of neither the recently selected windows nor the buffers in
3106 (declare (indent 1) (debug t))
3107 (let ((old-frame (make-symbol "old-frame"))
3108 (old-buffer (make-symbol "old-buffer")))
3109 `(let ((,old-frame (selected-frame))
3110 (,old-buffer (current-buffer)))
3112 (progn (select-frame ,frame 'norecord)
3114 (when (frame-live-p ,old-frame)
3115 (select-frame ,old-frame 'norecord))
3116 (when (buffer-live-p ,old-buffer)
3117 (set-buffer ,old-buffer))))))
3119 (defmacro save-window-excursion (&rest body)
3120 "Execute BODY, then restore previous window configuration.
3121 This macro saves the window configuration on the selected frame,
3122 executes BODY, then calls `set-window-configuration' to restore
3123 the saved window configuration. The return value is the last
3124 form in BODY. The window configuration is also restored if BODY
3127 BEWARE: Most uses of this macro introduce bugs.
3128 E.g. it should not be used to try and prevent some code from opening
3129 a new window, since that window may sometimes appear in another frame,
3130 in which case `save-window-excursion' cannot help."
3131 (declare (indent 0) (debug t))
3132 (let ((c (make-symbol "wconfig")))
3133 `(let ((,c (current-window-configuration)))
3134 (unwind-protect (progn ,@body)
3135 (set-window-configuration ,c)))))
3137 (defun temp-output-buffer-show (buffer)
3138 "Internal function for `with-output-to-temp-buffer'."
3139 (with-current-buffer buffer
3140 (set-buffer-modified-p nil)
3141 (goto-char (point-min)))
3143 (if temp-buffer-show-function
3144 (funcall temp-buffer-show-function buffer)
3145 (with-current-buffer buffer
3147 (let ((window-combination-limit
3148 ;; When `window-combination-limit' equals
3149 ;; `temp-buffer' or `temp-buffer-resize' and
3150 ;; `temp-buffer-resize-mode' is enabled in this
3151 ;; buffer bind it to t so resizing steals space
3152 ;; preferably from the window that was split.
3153 (if (or (eq window-combination-limit 'temp-buffer)
3154 (and (eq window-combination-limit
3155 'temp-buffer-resize)
3156 temp-buffer-resize-mode))
3158 window-combination-limit)))
3159 (display-buffer buffer)))
3160 (frame (and window (window-frame window))))
3162 (unless (eq frame (selected-frame))
3163 (make-frame-visible frame))
3164 (setq minibuffer-scroll-window window)
3165 (set-window-hscroll window 0)
3166 ;; Don't try this with NOFORCE non-nil!
3167 (set-window-start window (point-min) t)
3168 ;; This hould not be necessary.
3169 (set-window-point window (point-min))
3170 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3171 (with-selected-window window
3172 (run-hooks 'temp-buffer-show-hook))))))
3176 (defmacro with-output-to-temp-buffer (bufname &rest body)
3177 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3179 This construct makes buffer BUFNAME empty before running BODY.
3180 It does not make the buffer current for BODY.
3181 Instead it binds `standard-output' to that buffer, so that output
3182 generated with `prin1' and similar functions in BODY goes into
3185 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3186 it in a window, but does not select it. The normal way to do this is
3187 by calling `display-buffer', then running `temp-buffer-show-hook'.
3188 However, if `temp-buffer-show-function' is non-nil, it calls that
3189 function instead (and does not run `temp-buffer-show-hook'). The
3190 function gets one argument, the buffer to display.
3192 The return value of `with-output-to-temp-buffer' is the value of the
3193 last form in BODY. If BODY does not finish normally, the buffer
3194 BUFNAME is not displayed.
3196 This runs the hook `temp-buffer-setup-hook' before BODY,
3197 with the buffer BUFNAME temporarily current. It runs the hook
3198 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3199 buffer temporarily current, and the window that was used to display it
3200 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3201 if it uses `temp-buffer-show-function'."
3203 (let ((old-dir (make-symbol "old-dir"))
3204 (buf (make-symbol "buf")))
3205 `(let* ((,old-dir default-directory)
3207 (with-current-buffer (get-buffer-create ,bufname)
3208 (prog1 (current-buffer)
3209 (kill-all-local-variables)
3210 ;; FIXME: delete_all_overlays
3211 (setq default-directory ,old-dir)
3212 (setq buffer-read-only nil)
3213 (setq buffer-file-name nil)
3214 (setq buffer-undo-list t)
3215 (let ((inhibit-read-only t)
3216 (inhibit-modification-hooks t))
3218 (run-hooks 'temp-buffer-setup-hook)))))
3219 (standard-output ,buf))
3220 (prog1 (progn ,@body)
3221 (temp-output-buffer-show ,buf)))))
3223 (defmacro with-temp-file (file &rest body)
3224 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3225 The value returned is the value of the last form in BODY.
3226 See also `with-temp-buffer'."
3227 (declare (indent 1) (debug t))
3228 (let ((temp-file (make-symbol "temp-file"))
3229 (temp-buffer (make-symbol "temp-buffer")))
3230 `(let ((,temp-file ,file)
3232 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3235 (with-current-buffer ,temp-buffer
3237 (with-current-buffer ,temp-buffer
3238 (write-region nil nil ,temp-file nil 0)))
3239 (and (buffer-name ,temp-buffer)
3240 (kill-buffer ,temp-buffer))))))
3242 (defmacro with-temp-message (message &rest body)
3243 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3244 The original message is restored to the echo area after BODY has finished.
3245 The value returned is the value of the last form in BODY.
3246 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3247 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3248 Use a MESSAGE of \"\" to temporarily clear the echo area."
3249 (declare (debug t) (indent 1))
3250 (let ((current-message (make-symbol "current-message"))
3251 (temp-message (make-symbol "with-temp-message")))
3252 `(let ((,temp-message ,message)
3257 (setq ,current-message (current-message))
3258 (message "%s" ,temp-message))
3261 (if ,current-message
3262 (message "%s" ,current-message)
3265 (defmacro with-temp-buffer (&rest body)
3266 "Create a temporary buffer, and evaluate BODY there like `progn'.
3267 See also `with-temp-file' and `with-output-to-string'."
3268 (declare (indent 0) (debug t))
3269 (let ((temp-buffer (make-symbol "temp-buffer")))
3270 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3271 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3272 (with-current-buffer ,temp-buffer
3275 (and (buffer-name ,temp-buffer)
3276 (kill-buffer ,temp-buffer)))))))
3278 (defmacro with-silent-modifications (&rest body)
3279 "Execute BODY, pretending it does not modify the buffer.
3280 If BODY performs real modifications to the buffer's text, other
3281 than cosmetic ones, undo data may become corrupted.
3283 This macro will run BODY normally, but doesn't count its buffer
3284 modifications as being buffer modifications. This affects things
3285 like buffer-modified-p, checking whether the file is locked by
3286 someone else, running buffer modification hooks, and other things
3289 Typically used around modifications of text-properties which do
3290 not really affect the buffer's content."
3291 (declare (debug t) (indent 0))
3292 (let ((modified (make-symbol "modified")))
3293 `(let* ((,modified (buffer-modified-p))
3294 (buffer-undo-list t)
3295 (inhibit-read-only t)
3296 (inhibit-modification-hooks t)
3298 ;; Avoid setting and removing file locks and checking
3299 ;; buffer's uptodate-ness w.r.t the underlying file.
3301 buffer-file-truename)
3306 (restore-buffer-modified-p nil))))))
3308 (defmacro with-output-to-string (&rest body)
3309 "Execute BODY, return the text it sent to `standard-output', as a string."
3310 (declare (indent 0) (debug t))
3311 `(let ((standard-output
3312 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3315 (let ((standard-output standard-output))
3317 (with-current-buffer standard-output
3319 (kill-buffer standard-output))))
3321 (defmacro with-local-quit (&rest body)
3322 "Execute BODY, allowing quits to terminate BODY but not escape further.
3323 When a quit terminates BODY, `with-local-quit' returns nil but
3324 requests another quit. That quit will be processed as soon as quitting
3325 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3326 (declare (debug t) (indent 0))
3327 `(condition-case nil
3328 (let ((inhibit-quit nil))
3330 (quit (setq quit-flag t)
3331 ;; This call is to give a chance to handle quit-flag
3332 ;; in case inhibit-quit is nil.
3333 ;; Without this, it will not be handled until the next function
3334 ;; call, and that might allow it to exit thru a condition-case
3335 ;; that intends to handle the quit signal next time.
3336 (eval '(ignore nil)))))
3338 (defmacro while-no-input (&rest body)
3339 "Execute BODY only as long as there's no pending input.
3340 If input arrives, that ends the execution of BODY,
3341 and `while-no-input' returns t. Quitting makes it return nil.
3342 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3343 (declare (debug t) (indent 0))
3344 (let ((catch-sym (make-symbol "input")))
3347 (let ((throw-on-input ',catch-sym))
3348 (or (input-pending-p)
3349 (progn ,@body)))))))
3351 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3352 "Like `condition-case' except that it does not catch anything when debugging.
3353 More specifically if `debug-on-error' is set, then it does not catch any signal."
3354 (declare (debug condition-case) (indent 2))
3355 (let ((bodysym (make-symbol "body")))
3356 `(let ((,bodysym (lambda () ,bodyform)))
3359 (condition-case ,var
3363 (define-obsolete-function-alias 'condition-case-no-debug
3364 'condition-case-unless-debug "24.1")
3366 (defmacro with-demoted-errors (&rest body)
3367 "Run BODY and demote any errors to simple messages.
3368 If `debug-on-error' is non-nil, run BODY without catching its errors.
3369 This is to be used around code which is not expected to signal an error
3370 but which should be robust in the unexpected case that an error is signaled."
3371 (declare (debug t) (indent 0))
3372 (let ((err (make-symbol "err")))
3373 `(condition-case-unless-debug ,err
3375 (error (message "Error: %S" ,err) nil))))
3377 (defmacro combine-after-change-calls (&rest body)
3378 "Execute BODY, but don't call the after-change functions till the end.
3379 If BODY makes changes in the buffer, they are recorded
3380 and the functions on `after-change-functions' are called several times
3381 when BODY is finished.
3382 The return value is the value of the last form in BODY.
3384 If `before-change-functions' is non-nil, then calls to the after-change
3385 functions can't be deferred, so in that case this macro has no effect.
3387 Do not alter `after-change-functions' or `before-change-functions'
3389 (declare (indent 0) (debug t))
3391 (let ((combine-after-change-calls t))
3393 (combine-after-change-execute)))
3395 (defmacro with-case-table (table &rest body)
3396 "Execute the forms in BODY with TABLE as the current case table.
3397 The value returned is the value of the last form in BODY."
3398 (declare (indent 1) (debug t))
3399 (let ((old-case-table (make-symbol "table"))
3400 (old-buffer (make-symbol "buffer")))
3401 `(let ((,old-case-table (current-case-table))
3402 (,old-buffer (current-buffer)))
3404 (progn (set-case-table ,table)
3406 (with-current-buffer ,old-buffer
3407 (set-case-table ,old-case-table))))))
3409 ;;; Matching and match data.
3411 (defvar save-match-data-internal)
3413 ;; We use save-match-data-internal as the local variable because
3414 ;; that works ok in practice (people should not use that variable elsewhere).
3415 ;; We used to use an uninterned symbol; the compiler handles that properly
3416 ;; now, but it generates slower code.
3417 (defmacro save-match-data (&rest body)
3418 "Execute the BODY forms, restoring the global value of the match data.
3419 The value returned is the value of the last form in BODY."
3420 ;; It is better not to use backquote here,
3421 ;; because that makes a bootstrapping problem
3422 ;; if you need to recompile all the Lisp files using interpreted code.
3423 (declare (indent 0) (debug t))
3425 '((save-match-data-internal (match-data)))
3426 (list 'unwind-protect
3428 ;; It is safe to free (evaporate) markers immediately here,
3429 ;; as Lisp programs should not copy from save-match-data-internal.
3430 '(set-match-data save-match-data-internal 'evaporate))))
3432 (defun match-string (num &optional string)
3433 "Return string of text matched by last search.
3434 NUM specifies which parenthesized expression in the last regexp.
3435 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3436 Zero means the entire text matched by the whole regexp or whole string.
3437 STRING should be given if the last search was by `string-match' on STRING.
3438 If STRING is nil, the current buffer should be the same buffer
3439 the search/match was performed in."
3440 (if (match-beginning num)
3442 (substring string (match-beginning num) (match-end num))
3443 (buffer-substring (match-beginning num) (match-end num)))))
3445 (defun match-string-no-properties (num &optional string)
3446 "Return string of text matched by last search, without text properties.
3447 NUM specifies which parenthesized expression in the last regexp.
3448 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3449 Zero means the entire text matched by the whole regexp or whole string.
3450 STRING should be given if the last search was by `string-match' on STRING.
3451 If STRING is nil, the current buffer should be the same buffer
3452 the search/match was performed in."
3453 (if (match-beginning num)
3455 (substring-no-properties string (match-beginning num)
3457 (buffer-substring-no-properties (match-beginning num)
3461 (defun match-substitute-replacement (replacement
3462 &optional fixedcase literal string subexp)
3463 "Return REPLACEMENT as it will be inserted by `replace-match'.
3464 In other words, all back-references in the form `\\&' and `\\N'
3465 are substituted with actual strings matched by the last search.
3466 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3467 meaning as for `replace-match'."
3468 (let ((match (match-string 0 string)))
3470 (set-match-data (mapcar (lambda (x)
3472 (- x (match-beginning 0))
3475 (replace-match replacement fixedcase literal match subexp))))
3478 (defun looking-back (regexp &optional limit greedy)
3479 "Return non-nil if text before point matches regular expression REGEXP.
3480 Like `looking-at' except matches before point, and is slower.
3481 LIMIT if non-nil speeds up the search by specifying a minimum
3482 starting position, to avoid checking matches that would start
3485 If GREEDY is non-nil, extend the match backwards as far as
3486 possible, stopping when a single additional previous character
3487 cannot be part of a match for REGEXP. When the match is
3488 extended, its starting position is allowed to occur before
3490 (let ((start (point))
3493 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3495 (if (and greedy pos)
3497 (narrow-to-region (point-min) start)
3498 (while (and (> pos (point-min))
3502 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3503 (setq pos (1- pos)))
3506 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3509 (defsubst looking-at-p (regexp)
3511 Same as `looking-at' except this function does not change the match data."
3512 (let ((inhibit-changing-match-data t))
3513 (looking-at regexp)))
3515 (defsubst string-match-p (regexp string &optional start)
3517 Same as `string-match' except this function does not change the match data."
3518 (let ((inhibit-changing-match-data t))
3519 (string-match regexp string start)))
3521 (defun subregexp-context-p (regexp pos &optional start)
3522 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3523 A subregexp context is one where a sub-regexp can appear.
3524 A non-subregexp context is for example within brackets, or within a
3525 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3526 If START is non-nil, it should be a position in REGEXP, smaller
3527 than POS, and known to be in a subregexp context."
3528 ;; Here's one possible implementation, with the great benefit that it
3529 ;; reuses the regexp-matcher's own parser, so it understands all the
3530 ;; details of the syntax. A disadvantage is that it needs to match the
3534 (string-match (substring regexp (or start 0) pos) "")
3537 (not (member (cadr err) '("Unmatched [ or [^"
3539 "Trailing backslash")))))
3540 ;; An alternative implementation:
3541 ;; (defconst re-context-re
3542 ;; (let* ((harmless-ch "[^\\[]")
3543 ;; (harmless-esc "\\\\[^{]")
3544 ;; (class-harmless-ch "[^][]")
3545 ;; (class-lb-harmless "[^]:]")
3546 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3547 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3548 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3550 ;; (concat "\\[^?]?"
3551 ;; "\\(" class-harmless-ch
3552 ;; "\\|" class-lb "\\)*"
3553 ;; "\\[?]")) ; special handling for bare [ at end of re
3554 ;; (braces "\\\\{[0-9,]+\\\\}"))
3555 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3556 ;; "\\|" class "\\|" braces "\\)*\\'"))
3557 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3558 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3563 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3564 "The default value of separators for `split-string'.
3566 A regexp matching strings of whitespace. May be locale-dependent
3567 \(as yet unimplemented). Should not match non-breaking spaces.
3569 Warning: binding this to a different value and using it as default is
3570 likely to have undesired semantics.")
3572 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3573 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3574 ;; expression leads to the equivalent implementation that if SEPARATORS
3575 ;; is defaulted, OMIT-NULLS is treated as t.
3576 (defun split-string (string &optional separators omit-nulls)
3577 "Split STRING into substrings bounded by matches for SEPARATORS.
3579 The beginning and end of STRING, and each match for SEPARATORS, are
3580 splitting points. The substrings matching SEPARATORS are removed, and
3581 the substrings between the splitting points are collected as a list,
3584 If SEPARATORS is non-nil, it should be a regular expression matching text
3585 which separates, but is not part of, the substrings. If nil it defaults to
3586 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3587 OMIT-NULLS is forced to t.
3589 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3590 that for the default value of SEPARATORS leading and trailing whitespace
3591 are effectively trimmed). If nil, all zero-length substrings are retained,
3592 which correctly parses CSV format, for example.
3594 Note that the effect of `(split-string STRING)' is the same as
3595 `(split-string STRING split-string-default-separators t)'. In the rare
3596 case that you wish to retain zero-length substrings when splitting on
3597 whitespace, use `(split-string STRING split-string-default-separators)'.
3599 Modifies the match data; use `save-match-data' if necessary."
3600 (let ((keep-nulls (not (if separators omit-nulls t)))
3601 (rexp (or separators split-string-default-separators))
3605 (while (and (string-match rexp string
3607 (= start (match-beginning 0))
3608 (< start (length string)))
3610 (< start (length string)))
3612 (if (or keep-nulls (< start (match-beginning 0)))
3614 (cons (substring string start (match-beginning 0))
3616 (setq start (match-end 0)))
3617 (if (or keep-nulls (< start (length string)))
3619 (cons (substring string start)
3623 (defun combine-and-quote-strings (strings &optional separator)
3624 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3625 This tries to quote the strings to avoid ambiguity such that
3626 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3627 Only some SEPARATORs will work properly."
3628 (let* ((sep (or separator " "))
3629 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3632 (if (string-match re str)
3633 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3637 (defun split-string-and-unquote (string &optional separator)
3638 "Split the STRING into a list of strings.
3639 It understands Emacs Lisp quoting within STRING, such that
3640 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3641 The SEPARATOR regexp defaults to \"\\s-+\"."
3642 (let ((sep (or separator "\\s-+"))
3643 (i (string-match "\"" string)))
3645 (split-string string sep t) ; no quoting: easy
3646 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3647 (let ((rfs (read-from-string string i)))
3649 (split-string-and-unquote (substring string (cdr rfs))
3653 ;;;; Replacement in strings.
3655 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3656 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3657 Unless optional argument INPLACE is non-nil, return a new string."
3658 (let ((i (length string))
3659 (newstr (if inplace string (copy-sequence string))))
3662 (if (eq (aref newstr i) fromchar)
3663 (aset newstr i tochar)))
3666 (defun replace-regexp-in-string (regexp rep string &optional
3667 fixedcase literal subexp start)
3668 "Replace all matches for REGEXP with REP in STRING.
3670 Return a new string containing the replacements.
3672 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3673 arguments with the same names of function `replace-match'. If START
3674 is non-nil, start replacements at that index in STRING.
3676 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3677 function. If it is a function, it is called with the actual text of each
3678 match, and its value is used as the replacement text. When REP is called,
3679 the match data are the result of matching REGEXP against a substring
3682 To replace only the first match (if any), make REGEXP match up to \\'
3683 and replace a sub-expression, e.g.
3684 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3687 ;; To avoid excessive consing from multiple matches in long strings,
3688 ;; don't just call `replace-match' continually. Walk down the
3689 ;; string looking for matches of REGEXP and building up a (reversed)
3690 ;; list MATCHES. This comprises segments of STRING which weren't
3691 ;; matched interspersed with replacements for segments that were.
3692 ;; [For a `large' number of replacements it's more efficient to
3693 ;; operate in a temporary buffer; we can't tell from the function's
3694 ;; args whether to choose the buffer-based implementation, though it
3695 ;; might be reasonable to do so for long enough STRING.]
3696 (let ((l (length string))
3697 (start (or start 0))
3700 (while (and (< start l) (string-match regexp string start))
3701 (setq mb (match-beginning 0)
3703 ;; If we matched the empty string, make sure we advance by one char
3704 (when (= me mb) (setq me (min l (1+ mb))))
3705 ;; Generate a replacement for the matched substring.
3706 ;; Operate only on the substring to minimize string consing.
3707 ;; Set up match data for the substring for replacement;
3708 ;; presumably this is likely to be faster than munging the
3709 ;; match data directly in Lisp.
3710 (string-match regexp (setq str (substring string mb me)))
3712 (cons (replace-match (if (stringp rep)
3714 (funcall rep (match-string 0 str)))
3715 fixedcase literal str subexp)
3716 (cons (substring string start mb) ; unmatched prefix
3719 ;; Reconstruct a string from the pieces.
3720 (setq matches (cons (substring string start l) matches)) ; leftover
3721 (apply #'concat (nreverse matches)))))
3723 (defun string-prefix-p (str1 str2 &optional ignore-case)
3724 "Return non-nil if STR1 is a prefix of STR2.
3725 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3726 to case differences."
3727 (eq t (compare-strings str1 nil nil
3728 str2 0 (length str1) ignore-case)))
3730 (defun bidi-string-mark-left-to-right (str)
3731 "Return a string that can be safely inserted in left-to-right text.
3733 Normally, inserting a string with right-to-left (RTL) script into
3734 a buffer may cause some subsequent text to be displayed as part
3735 of the RTL segment (usually this affects punctuation characters).
3736 This function returns a string which displays as STR but forces
3737 subsequent text to be displayed as left-to-right.
3739 If STR contains any RTL character, this function returns a string
3740 consisting of STR followed by an invisible left-to-right mark
3741 \(LRM) character. Otherwise, it returns STR."
3742 (unless (stringp str)
3743 (signal 'wrong-type-argument (list 'stringp str)))
3744 (if (string-match "\\cR" str)
3745 (concat str (propertize (string ?\x200e) 'invisible t))
3748 ;;;; invisibility specs
3750 (defun add-to-invisibility-spec (element)
3751 "Add ELEMENT to `buffer-invisibility-spec'.
3752 See documentation for `buffer-invisibility-spec' for the kind of elements
3754 (if (eq buffer-invisibility-spec t)
3755 (setq buffer-invisibility-spec (list t)))
3756 (setq buffer-invisibility-spec
3757 (cons element buffer-invisibility-spec)))
3759 (defun remove-from-invisibility-spec (element)
3760 "Remove ELEMENT from `buffer-invisibility-spec'."
3761 (if (consp buffer-invisibility-spec)
3762 (setq buffer-invisibility-spec
3763 (delete element buffer-invisibility-spec))))
3767 (defmacro with-syntax-table (table &rest body)
3768 "Evaluate BODY with syntax table of current buffer set to TABLE.
3769 The syntax table of the current buffer is saved, BODY is evaluated, and the
3770 saved table is restored, even in case of an abnormal exit.
3771 Value is what BODY returns."
3772 (declare (debug t) (indent 1))
3773 (let ((old-table (make-symbol "table"))
3774 (old-buffer (make-symbol "buffer")))
3775 `(let ((,old-table (syntax-table))
3776 (,old-buffer (current-buffer)))
3779 (set-syntax-table ,table)
3781 (save-current-buffer
3782 (set-buffer ,old-buffer)
3783 (set-syntax-table ,old-table))))))
3785 (defun make-syntax-table (&optional oldtable)
3786 "Return a new syntax table.
3787 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3788 from `standard-syntax-table' otherwise."
3789 (let ((table (make-char-table 'syntax-table nil)))
3790 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3793 (defun syntax-after (pos)
3794 "Return the raw syntax descriptor for the char after POS.
3795 If POS is outside the buffer's accessible portion, return nil."
3796 (unless (or (< pos (point-min)) (>= pos (point-max)))
3797 (let ((st (if parse-sexp-lookup-properties
3798 (get-char-property pos 'syntax-table))))
3800 (aref (or st (syntax-table)) (char-after pos))))))
3802 (defun syntax-class (syntax)
3803 "Return the code for the syntax class described by SYNTAX.
3805 SYNTAX should be a raw syntax descriptor; the return value is a
3806 integer which encodes the corresponding syntax class. See Info
3807 node `(elisp)Syntax Table Internals' for a list of codes.
3809 If SYNTAX is nil, return nil."
3810 (and syntax (logand (car syntax) 65535)))
3814 (defun text-clone-maintain (ol1 after beg end &optional _len)
3815 "Propagate the changes made under the overlay OL1 to the other clones.
3816 This is used on the `modification-hooks' property of text clones."
3817 (when (and after (not undo-in-progress) (overlay-start ol1))
3818 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3819 (setq beg (max beg (+ (overlay-start ol1) margin)))
3820 (setq end (min end (- (overlay-end ol1) margin)))
3823 (when (overlay-get ol1 'text-clone-syntax)
3824 ;; Check content of the clone's text.
3825 (let ((cbeg (+ (overlay-start ol1) margin))
3826 (cend (- (overlay-end ol1) margin)))
3829 (if (not (re-search-forward
3830 (overlay-get ol1 'text-clone-syntax) cend t))
3831 ;; Mark the overlay for deletion.
3832 (overlay-put ol1 'text-clones nil)
3833 (when (< (match-end 0) cend)
3834 ;; Shrink the clone at its end.
3835 (setq end (min end (match-end 0)))
3836 (move-overlay ol1 (overlay-start ol1)
3837 (+ (match-end 0) margin)))
3838 (when (> (match-beginning 0) cbeg)
3839 ;; Shrink the clone at its beginning.
3840 (setq beg (max (match-beginning 0) beg))
3841 (move-overlay ol1 (- (match-beginning 0) margin)
3842 (overlay-end ol1)))))))
3843 ;; Now go ahead and update the clones.
3844 (let ((head (- beg (overlay-start ol1)))
3845 (tail (- (overlay-end ol1) end))
3846 (str (buffer-substring beg end))
3848 (inhibit-modification-hooks t))
3849 (dolist (ol2 (overlay-get ol1 'text-clones))
3850 (let ((oe (overlay-end ol2)))
3851 (unless (or (eq ol1 ol2) (null oe))
3852 (setq nothing-left nil)
3853 (let ((mod-beg (+ (overlay-start ol2) head)))
3854 ;;(overlay-put ol2 'modification-hooks nil)
3855 (goto-char (- (overlay-end ol2) tail))
3856 (unless (> mod-beg (point))
3857 (save-excursion (insert str))
3858 (delete-region mod-beg (point)))
3859 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3861 (if nothing-left (delete-overlay ol1))))))))
3863 (defun text-clone-create (start end &optional spreadp syntax)
3864 "Create a text clone of START...END at point.
3865 Text clones are chunks of text that are automatically kept identical:
3866 changes done to one of the clones will be immediately propagated to the other.
3868 The buffer's content at point is assumed to be already identical to
3869 the one between START and END.
3870 If SYNTAX is provided it's a regexp that describes the possible text of
3871 the clones; the clone will be shrunk or killed if necessary to ensure that
3872 its text matches the regexp.
3873 If SPREADP is non-nil it indicates that text inserted before/after the
3874 clone should be incorporated in the clone."
3875 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3876 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3877 ;; (with a one-char margin at each end) with `t nil'.
3878 ;; We opted for a larger overlay because it behaves better in the case
3879 ;; where the clone is reduced to the empty string (we want the overlay to
3880 ;; stay when the clone's content is the empty string and we want to use
3881 ;; `evaporate' to make sure those overlays get deleted when needed).
3883 (let* ((pt-end (+ (point) (- end start)))
3884 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3886 (end-margin (if (or (not spreadp)
3887 (>= pt-end (point-max))
3888 (>= start (point-max)))
3890 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3891 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3892 (dups (list ol1 ol2)))
3893 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3894 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3895 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3896 ;;(overlay-put ol1 'face 'underline)
3897 (overlay-put ol1 'evaporate t)
3898 (overlay-put ol1 'text-clones dups)
3900 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3901 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3902 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3903 ;;(overlay-put ol2 'face 'underline)
3904 (overlay-put ol2 'evaporate t)
3905 (overlay-put ol2 'text-clones dups)))
3907 ;;;; Mail user agents.
3909 ;; Here we include just enough for other packages to be able
3912 (defun define-mail-user-agent (symbol composefunc sendfunc
3913 &optional abortfunc hookvar)
3914 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3916 SYMBOL can be any Lisp symbol. Its function definition and/or
3917 value as a variable do not matter for this usage; we use only certain
3918 properties on its property list, to encode the rest of the arguments.
3920 COMPOSEFUNC is program callable function that composes an outgoing
3921 mail message buffer. This function should set up the basics of the
3922 buffer without requiring user interaction. It should populate the
3923 standard mail headers, leaving the `to:' and `subject:' headers blank
3926 COMPOSEFUNC should accept several optional arguments--the same
3927 arguments that `compose-mail' takes. See that function's documentation.
3929 SENDFUNC is the command a user would run to send the message.
3931 Optional ABORTFUNC is the command a user would run to abort the
3932 message. For mail packages that don't have a separate abort function,
3933 this can be `kill-buffer' (the equivalent of omitting this argument).
3935 Optional HOOKVAR is a hook variable that gets run before the message
3936 is actually sent. Callers that use the `mail-user-agent' may
3937 install a hook function temporarily on this hook variable.
3938 If HOOKVAR is nil, `mail-send-hook' is used.
3940 The properties used on SYMBOL are `composefunc', `sendfunc',
3941 `abortfunc', and `hookvar'."
3942 (put symbol 'composefunc composefunc)
3943 (put symbol 'sendfunc sendfunc)
3944 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3945 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3947 (defun set-temporary-overlay-map (map &optional keep-pred)
3948 "Set MAP as a temporary overlay map.
3949 When KEEP-PRED is `t', using a key from the temporary keymap
3950 leaves this keymap activated. KEEP-PRED can also be a function,
3951 which will have the same effect when it returns `t'.
3952 When KEEP-PRED is nil, the temporary keymap is used only once."
3953 (let* ((clearfunsym (make-symbol "clear-temporary-overlay-map"))
3954 (overlaysym (make-symbol "t"))
3955 (alist (list (cons overlaysym map)))
3957 ;; FIXME: Use lexical-binding.
3959 (unless ,(cond ((null keep-pred) nil)
3963 (this-command-keys-vector))))
3964 (t `(funcall ',keep-pred)))
3965 (set ',overlaysym nil) ;Just in case.
3966 (remove-hook 'pre-command-hook ',clearfunsym)
3967 (setq emulation-mode-map-alists
3968 (delq ',alist emulation-mode-map-alists))))))
3969 (set overlaysym overlaysym)
3970 (fset clearfunsym clearfun)
3971 (add-hook 'pre-command-hook clearfunsym)
3972 ;; FIXME: That's the keymaps with highest precedence, except for
3973 ;; the `keymap' text-property ;-(
3974 (push alist emulation-mode-map-alists)))
3976 ;;;; Progress reporters.
3978 ;; Progress reporter has the following structure:
3980 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3987 ;; This weirdness is for optimization reasons: we want
3988 ;; `progress-reporter-update' to be as fast as possible, so
3989 ;; `(car reporter)' is better than `(aref reporter 0)'.
3991 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3992 ;; digits of precision, it doesn't really matter here. On the other
3993 ;; hand, it greatly simplifies the code.
3995 (defsubst progress-reporter-update (reporter &optional value)
3996 "Report progress of an operation in the echo area.
3997 REPORTER should be the result of a call to `make-progress-reporter'.
3999 If REPORTER is a numerical progress reporter---i.e. if it was
4000 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4001 `make-progress-reporter'---then VALUE should be a number between
4002 MIN-VALUE and MAX-VALUE.
4004 If REPORTER is a non-numerical reporter, VALUE should be nil.
4006 This function is relatively inexpensive. If the change since
4007 last update is too small or insufficient time has passed, it does
4009 (when (or (not (numberp value)) ; For pulsing reporter
4010 (>= value (car reporter))) ; For numerical reporter
4011 (progress-reporter-do-update reporter value)))
4013 (defun make-progress-reporter (message &optional min-value max-value
4014 current-value min-change min-time)
4015 "Return progress reporter object for use with `progress-reporter-update'.
4017 MESSAGE is shown in the echo area, with a status indicator
4018 appended to the end. When you call `progress-reporter-done', the
4019 word \"done\" is printed after the MESSAGE. You can change the
4020 MESSAGE of an existing progress reporter by calling
4021 `progress-reporter-force-update'.
4023 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4024 and final (100% complete) states of operation; the latter should
4025 be larger. In this case, the status message shows the percentage
4028 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4029 message shows a \"spinning\", non-numeric indicator.
4031 Optional CURRENT-VALUE is the initial progress; the default is
4033 Optional MIN-CHANGE is the minimal change in percents to report;
4035 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4036 and/or MAX-VALUE are nil.
4038 Optional MIN-TIME specifies the minimum interval time between
4039 echo area updates (default is 0.2 seconds.) If the function
4040 `float-time' is not present, time is not tracked at all. If the
4041 OS is not capable of measuring fractions of seconds, this
4042 parameter is effectively rounded up."
4043 (when (string-match "[[:alnum:]]\\'" message)
4044 (setq message (concat message "...")))
4046 (setq min-time 0.2))
4048 ;; Force a call to `message' now
4049 (cons (or min-value 0)
4050 (vector (if (and (fboundp 'float-time)
4056 (if min-change (max (min min-change 50) 1) 1)
4058 (progress-reporter-update reporter (or current-value min-value))
4061 (defun progress-reporter-force-update (reporter &optional value new-message)
4062 "Report progress of an operation in the echo area unconditionally.
4064 The first two arguments are the same as in `progress-reporter-update'.
4065 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4066 (let ((parameters (cdr reporter)))
4068 (aset parameters 3 new-message))
4069 (when (aref parameters 0)
4070 (aset parameters 0 (float-time)))
4071 (progress-reporter-do-update reporter value)))
4073 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4074 "Characters to use for pulsing progress reporters.")
4076 (defun progress-reporter-do-update (reporter value)
4077 (let* ((parameters (cdr reporter))
4078 (update-time (aref parameters 0))
4079 (min-value (aref parameters 1))
4080 (max-value (aref parameters 2))
4081 (text (aref parameters 3))
4082 (current-time (float-time))
4084 ;; See if enough time has passed since the last update.
4085 (or (not update-time)
4086 (when (>= current-time update-time)
4087 ;; Calculate time for the next update
4088 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4089 (cond ((and min-value max-value)
4090 ;; Numerical indicator
4091 (let* ((one-percent (/ (- max-value min-value) 100.0))
4092 (percentage (if (= max-value min-value)
4094 (truncate (/ (- value min-value)
4096 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4097 ;; message because not enough time has passed, use 1
4098 ;; instead of MIN-CHANGE. This makes delays between echo
4099 ;; area updates closer to MIN-TIME.
4101 (min (+ min-value (* (+ percentage
4102 (if enough-time-passed
4108 (when (integerp value)
4109 (setcar reporter (ceiling (car reporter))))
4110 ;; Only print message if enough time has passed
4111 (when enough-time-passed
4112 (if (> percentage 0)
4113 (message "%s%d%%" text percentage)
4114 (message "%s" text)))))
4115 ;; Pulsing indicator
4117 (let ((index (mod (1+ (car reporter)) 4))
4118 (message-log-max nil))
4119 (setcar reporter index)
4122 (aref progress-reporter--pulse-characters
4125 (defun progress-reporter-done (reporter)
4126 "Print reporter's message followed by word \"done\" in echo area."
4127 (message "%sdone" (aref (cdr reporter) 3)))
4129 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4130 "Loop a certain number of times and report progress in the echo area.
4131 Evaluate BODY with VAR bound to successive integers running from
4132 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4133 the return value (nil if RESULT is omitted).
4135 At each iteration MESSAGE followed by progress percentage is
4136 printed in the echo area. After the loop is finished, MESSAGE
4137 followed by word \"done\" is printed. This macro is a
4138 convenience wrapper around `make-progress-reporter' and friends.
4140 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4141 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4142 (let ((temp (make-symbol "--dotimes-temp--"))
4143 (temp2 (make-symbol "--dotimes-temp2--"))
4147 (,(car spec) ,start)
4148 (,temp2 (make-progress-reporter ,message ,start ,end)))
4149 (while (< ,(car spec) ,temp)
4151 (progress-reporter-update ,temp2
4152 (setq ,(car spec) (1+ ,(car spec)))))
4153 (progress-reporter-done ,temp2)
4154 nil ,@(cdr (cdr spec)))))
4157 ;;;; Comparing version strings.
4159 (defconst version-separator "."
4160 "Specify the string used to separate the version elements.
4162 Usually the separator is \".\", but it can be any other string.")
4165 (defconst version-regexp-alist
4166 '(("^[-_+ ]?alpha$" . -3)
4167 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
4168 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
4169 ("^[-_+ ]?beta$" . -2)
4170 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
4171 "Specify association between non-numeric version and its priority.
4173 This association is used to handle version string like \"1.0pre2\",
4174 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4175 non-numeric part of a version string to an integer. For example:
4177 String Version Integer List Version
4178 \"1.0pre2\" (1 0 -1 2)
4179 \"1.0PRE2\" (1 0 -1 2)
4180 \"22.8beta3\" (22 8 -2 3)
4181 \"22.8 Beta3\" (22 8 -2 3)
4182 \"0.9alpha1\" (0 9 -3 1)
4183 \"0.9AlphA1\" (0 9 -3 1)
4184 \"0.9 alpha\" (0 9 -3)
4186 Each element has the following form:
4192 REGEXP regexp used to match non-numeric part of a version string.
4193 It should begin with the `^' anchor and end with a `$' to
4194 prevent false hits. Letter-case is ignored while matching
4197 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4200 (defun version-to-list (ver)
4201 "Convert version string VER into a list of integers.
4203 The version syntax is given by the following EBNF:
4205 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4207 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4209 SEPARATOR ::= `version-separator' (which see)
4210 | `version-regexp-alist' (which see).
4212 The NUMBER part is optional if SEPARATOR is a match for an element
4213 in `version-regexp-alist'.
4215 Examples of valid version syntax:
4217 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4219 Examples of invalid version syntax:
4221 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4223 Examples of version conversion:
4225 Version String Version as a List of Integers
4226 \"1.0.7.5\" (1 0 7 5)
4227 \"1.0pre2\" (1 0 -1 2)
4228 \"1.0PRE2\" (1 0 -1 2)
4229 \"22.8beta3\" (22 8 -2 3)
4230 \"22.8Beta3\" (22 8 -2 3)
4231 \"0.9alpha1\" (0 9 -3 1)
4232 \"0.9AlphA1\" (0 9 -3 1)
4233 \"0.9alpha\" (0 9 -3)
4235 See documentation for `version-separator' and `version-regexp-alist'."
4236 (or (and (stringp ver) (> (length ver) 0))
4237 (error "Invalid version string: '%s'" ver))
4238 ;; Change .x.y to 0.x.y
4239 (if (and (>= (length ver) (length version-separator))
4240 (string-equal (substring ver 0 (length version-separator))
4242 (setq ver (concat "0" ver)))
4245 (case-fold-search t) ; ignore case in matching
4247 (while (and (setq s (string-match "[0-9]+" ver i))
4249 ;; handle numeric part
4250 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4253 ;; handle non-numeric part
4254 (when (and (setq s (string-match "[^0-9]+" ver i))
4256 (setq s (substring ver i (match-end 0))
4258 ;; handle alpha, beta, pre, etc. separator
4259 (unless (string= s version-separator)
4260 (setq al version-regexp-alist)
4261 (while (and al (not (string-match (caar al) s)))
4264 (push (cdar al) lst))
4265 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4266 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4267 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4269 (t (error "Invalid version syntax: '%s'" ver))))))
4271 (error "Invalid version syntax: '%s'" ver)
4275 (defun version-list-< (l1 l2)
4276 "Return t if L1, a list specification of a version, is lower than L2.
4278 Note that a version specified by the list (1) is equal to (1 0),
4279 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4280 Also, a version given by the list (1) is higher than (1 -1), which in
4281 turn is higher than (1 -2), which is higher than (1 -3)."
4282 (while (and l1 l2 (= (car l1) (car l2)))
4286 ;; l1 not null and l2 not null
4287 ((and l1 l2) (< (car l1) (car l2)))
4288 ;; l1 null and l2 null ==> l1 length = l2 length
4289 ((and (null l1) (null l2)) nil)
4290 ;; l1 not null and l2 null ==> l1 length > l2 length
4291 (l1 (< (version-list-not-zero l1) 0))
4292 ;; l1 null and l2 not null ==> l2 length > l1 length
4293 (t (< 0 (version-list-not-zero l2)))))
4296 (defun version-list-= (l1 l2)
4297 "Return t if L1, a list specification of a version, is equal to L2.
4299 Note that a version specified by the list (1) is equal to (1 0),
4300 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4301 Also, a version given by the list (1) is higher than (1 -1), which in
4302 turn is higher than (1 -2), which is higher than (1 -3)."
4303 (while (and l1 l2 (= (car l1) (car l2)))
4307 ;; l1 not null and l2 not null
4309 ;; l1 null and l2 null ==> l1 length = l2 length
4310 ((and (null l1) (null l2)))
4311 ;; l1 not null and l2 null ==> l1 length > l2 length
4312 (l1 (zerop (version-list-not-zero l1)))
4313 ;; l1 null and l2 not null ==> l2 length > l1 length
4314 (t (zerop (version-list-not-zero l2)))))
4317 (defun version-list-<= (l1 l2)
4318 "Return t if L1, a list specification of a version, is lower or equal to L2.
4320 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4321 etc. That is, the trailing zeroes are insignificant. Also, integer
4322 list (1) is greater than (1 -1) which is greater than (1 -2)
4323 which is greater than (1 -3)."
4324 (while (and l1 l2 (= (car l1) (car l2)))
4328 ;; l1 not null and l2 not null
4329 ((and l1 l2) (< (car l1) (car l2)))
4330 ;; l1 null and l2 null ==> l1 length = l2 length
4331 ((and (null l1) (null l2)))
4332 ;; l1 not null and l2 null ==> l1 length > l2 length
4333 (l1 (<= (version-list-not-zero l1) 0))
4334 ;; l1 null and l2 not null ==> l2 length > l1 length
4335 (t (<= 0 (version-list-not-zero l2)))))
4337 (defun version-list-not-zero (lst)
4338 "Return the first non-zero element of LST, which is a list of integers.
4340 If all LST elements are zeros or LST is nil, return zero."
4341 (while (and lst (zerop (car lst)))
4342 (setq lst (cdr lst)))
4345 ;; there is no element different of zero
4349 (defun version< (v1 v2)
4350 "Return t if version V1 is lower (older) than V2.
4352 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4353 etc. That is, the trailing \".0\"s are insignificant. Also, version
4354 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4355 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4357 (version-list-< (version-to-list v1) (version-to-list v2)))
4360 (defun version<= (v1 v2)
4361 "Return t if version V1 is lower (older) than or equal to V2.
4363 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4364 etc. That is, the trailing \".0\"s are insignificant. Also, version
4365 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4366 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4368 (version-list-<= (version-to-list v1) (version-to-list v2)))
4370 (defun version= (v1 v2)
4371 "Return t if version V1 is equal to V2.
4373 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4374 etc. That is, the trailing \".0\"s are insignificant. Also, version
4375 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4376 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4378 (version-list-= (version-to-list v1) (version-to-list v2)))
4382 (defconst menu-bar-separator '("--")
4383 "Separator for menus.")
4385 ;; The following statement ought to be in print.c, but `provide' can't
4387 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4388 (when (hash-table-p (car (read-from-string
4389 (prin1-to-string (make-hash-table)))))
4390 (provide 'hashtable-print-readable))
4392 ;;; subr.el ends here