1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2011
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 (defvar custom-declare-variable-list nil
30 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
31 Each element of this list holds the arguments to one call to `defcustom'.")
33 ;; Use this, rather than defcustom, in subr.el and other files loaded
35 (defun custom-declare-variable-early (&rest arguments
)
36 (setq custom-declare-variable-list
37 (cons arguments custom-declare-variable-list
)))
39 (defmacro declare-function
(fn file
&optional arglist fileonly
)
40 "Tell the byte-compiler that function FN is defined, in FILE.
41 Optional ARGLIST is the argument list used by the function. The
42 FILE argument is not used by the byte-compiler, but by the
43 `check-declare' package, which checks that FILE contains a
44 definition for FN. ARGLIST is used by both the byte-compiler and
45 `check-declare' to check for consistency.
47 FILE can be either a Lisp file (in which case the \".el\"
48 extension is optional), or a C file. C files are expanded
49 relative to the Emacs \"src/\" directory. Lisp files are
50 searched for using `locate-library', and if that fails they are
51 expanded relative to the location of the file containing the
52 declaration. A FILE with an \"ext:\" prefix is an external file.
53 `check-declare' will check such files if they are found, and skip
54 them without error if they are not.
56 FILEONLY non-nil means that `check-declare' will only check that
57 FILE exists, not that it defines FN. This is intended for
58 function-definitions that `check-declare' does not recognize, e.g.
61 To specify a value for FILEONLY without passing an argument list,
62 set ARGLIST to t. This is necessary because nil means an
63 empty argument list, rather than an unspecified one.
65 Note that for the purposes of `check-declare', this statement
66 must be the first non-whitespace on a line.
68 For more information, see Info node `(elisp)Declaring Functions'."
69 ;; Does nothing - byte-compile-declare-function does the work.
73 ;;;; Basic Lisp macros.
77 (defmacro noreturn
(form)
78 "Evaluate FORM, expecting it not to return.
79 If FORM does return, signal an error."
81 (error "Form marked with `noreturn' did return")))
83 (defmacro 1value
(form)
84 "Evaluate FORM, expecting a constant return value.
85 This is the global do-nothing version. There is also `testcover-1value'
86 that complains if FORM ever does return differing values."
89 (defmacro def-edebug-spec
(symbol spec
)
90 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
91 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
92 0 (instrument no arguments); t (instrument all arguments);
93 a symbol (naming a function with an Edebug specification); or a list.
94 The elements of the list describe the argument types; see
95 Info node `(elisp)Specification List' for details."
96 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
98 (defmacro lambda
(&rest cdr
)
99 "Return a lambda expression.
100 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
101 self-quoting; the result of evaluating the lambda expression is the
102 expression itself. The lambda expression may then be treated as a
103 function, i.e., stored as the function value of a symbol, passed to
104 `funcall' or `mapcar', etc.
106 ARGS should take the same form as an argument list for a `defun'.
107 DOCSTRING is an optional documentation string.
108 If present, it should describe how to call the function.
109 But documentation strings are usually not useful in nameless functions.
110 INTERACTIVE should be a call to the function `interactive', which see.
111 It may also be omitted.
112 BODY should be a list of Lisp expressions.
114 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
115 ;; Note that this definition should not use backquotes; subr.el should not
116 ;; depend on backquote.el.
117 (list 'function
(cons 'lambda cdr
)))
119 (defun apply-partially (fun &rest args
)
120 "Return a function that is a partial application of FUN to ARGS.
121 ARGS is a list of the first N arguments to pass to FUN.
122 The result is a new function which does the same as FUN, except that
123 the first N arguments are fixed at the values with which this function
125 `(closure (t) (&rest args
)
126 (apply ',fun
,@(mapcar (lambda (arg) `',arg
) args
) args
)))
128 (if (null (featurep 'cl
))
130 ;; If we reload subr.el after having loaded CL, be careful not to
131 ;; overwrite CL's extended definition of `dolist', `dotimes',
132 ;; `declare', `push' and `pop'.
133 (defmacro push
(newelt listname
)
134 "Add NEWELT to the list stored in the symbol LISTNAME.
135 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
136 LISTNAME must be a symbol."
137 (declare (debug (form sexp
)))
139 (list 'cons newelt listname
)))
141 (defmacro pop
(listname)
142 "Return the first element of LISTNAME's value, and remove it from the list.
143 LISTNAME must be a symbol whose value is a list.
144 If the value is nil, `pop' returns nil but does not actually
146 (declare (debug (sexp)))
148 (list 'prog1 listname
149 (list 'setq listname
(list 'cdr listname
)))))
152 (defmacro when
(cond &rest body
)
153 "If COND yields non-nil, do BODY, else return nil.
154 When COND yields non-nil, eval BODY forms sequentially and return
155 value of last one, or nil if there are none.
158 (declare (indent 1) (debug t
))
159 (list 'if cond
(cons 'progn body
)))
161 (defmacro unless
(cond &rest body
)
162 "If COND yields nil, do BODY, else return nil.
163 When COND yields nil, eval BODY forms sequentially and return
164 value of last one, or nil if there are none.
167 (declare (indent 1) (debug t
))
168 (cons 'if
(cons cond
(cons nil body
))))
170 (if (null (featurep 'cl
))
172 ;; If we reload subr.el after having loaded CL, be careful not to
173 ;; overwrite CL's extended definition of `dolist', `dotimes',
174 ;; `declare', `push' and `pop'.
176 (defmacro dolist
(spec &rest body
)
178 Evaluate BODY with VAR bound to each car from LIST, in turn.
179 Then evaluate RESULT to get return value, default nil.
181 \(fn (VAR LIST [RESULT]) BODY...)"
182 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
183 ;; It would be cleaner to create an uninterned symbol,
184 ;; but that uses a lot more space when many functions in many files
186 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
187 (let ((temp '--dolist-tail--
))
188 ;; This is not a reliable test, but it does not matter because both
189 ;; semantics are acceptable, tho one is slightly faster with dynamic
190 ;; scoping and the other is slightly faster (and has cleaner semantics)
191 ;; with lexical scoping.
193 `(let ((,temp
,(nth 1 spec
)))
195 (let ((,(car spec
) (car ,temp
)))
197 (setq ,temp
(cdr ,temp
))))
198 ,@(if (cdr (cdr spec
))
199 ;; FIXME: This let often leads to "unused var" warnings.
200 `((let ((,(car spec
) nil
)) ,@(cdr (cdr spec
))))))
201 `(let ((,temp
,(nth 1 spec
))
204 (setq ,(car spec
) (car ,temp
))
206 (setq ,temp
(cdr ,temp
)))
207 ,@(if (cdr (cdr spec
))
208 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
))))))))
210 (defmacro dotimes
(spec &rest body
)
211 "Loop a certain number of times.
212 Evaluate BODY with VAR bound to successive integers running from 0,
213 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
214 the return value (nil if RESULT is omitted).
216 \(fn (VAR COUNT [RESULT]) BODY...)"
217 (declare (indent 1) (debug dolist
))
218 ;; It would be cleaner to create an uninterned symbol,
219 ;; but that uses a lot more space when many functions in many files
221 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
222 (let ((temp '--dotimes-limit--
)
225 ;; This is not a reliable test, but it does not matter because both
226 ;; semantics are acceptable, tho one is slightly faster with dynamic
227 ;; scoping and the other has cleaner semantics.
229 (let ((counter '--dotimes-counter--
))
232 (while (< ,counter
,temp
)
233 (let ((,(car spec
) ,counter
))
235 (setq ,counter
(1+ ,counter
)))
237 ;; FIXME: This let often leads to "unused var" warnings.
238 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
240 (,(car spec
) ,start
))
241 (while (< ,(car spec
) ,temp
)
243 (setq ,(car spec
) (1+ ,(car spec
))))
244 ,@(cdr (cdr spec
))))))
246 (defmacro declare
(&rest _specs
)
247 "Do not evaluate any arguments and return nil.
248 Treated as a declaration when used at the right place in a
249 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
253 (defmacro ignore-errors
(&rest body
)
254 "Execute BODY; if an error occurs, return nil.
255 Otherwise, return result of last form in BODY."
256 (declare (debug t
) (indent 0))
257 `(condition-case nil
(progn ,@body
) (error nil
)))
259 ;;;; Basic Lisp functions.
261 (defun ignore (&rest _ignore
)
262 "Do nothing and return nil.
263 This function accepts any number of arguments, but ignores them."
267 ;; Signal a compile-error if the first arg is missing.
268 (defun error (&rest args
)
269 "Signal an error, making error message by passing all args to `format'.
270 In Emacs, the convention is that error messages start with a capital
271 letter but *do not* end with a period. Please follow this convention
272 for the sake of consistency."
274 (signal 'error
(list (apply 'format args
)))))
275 (set-advertised-calling-convention 'error
'(string &rest args
) "23.1")
277 ;; We put this here instead of in frame.el so that it's defined even on
278 ;; systems where frame.el isn't loaded.
279 (defun frame-configuration-p (object)
280 "Return non-nil if OBJECT seems to be a frame configuration.
281 Any list whose car is `frame-configuration' is assumed to be a frame
284 (eq (car object
) 'frame-configuration
)))
289 "Return the car of the car of X."
293 "Return the car of the cdr of X."
297 "Return the cdr of the car of X."
301 "Return the cdr of the cdr of X."
304 (defun last (list &optional n
)
305 "Return the last link of LIST. Its car is the last element.
306 If LIST is nil, return nil.
307 If N is non-nil, return the Nth-to-last link of LIST.
308 If N is bigger than the length of LIST, return LIST."
311 (let ((m (safe-length list
)))
312 (if (< n m
) (nthcdr (- m n
) list
) list
)))
314 (nthcdr (1- (safe-length list
)) list
))))
316 (defun butlast (list &optional n
)
317 "Return a copy of LIST with the last N elements removed."
318 (if (and n
(<= n
0)) list
319 (nbutlast (copy-sequence list
) n
)))
321 (defun nbutlast (list &optional n
)
322 "Modifies LIST to remove the last N elements."
323 (let ((m (length list
)))
327 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
330 (defun delete-dups (list)
331 "Destructively remove `equal' duplicates from LIST.
332 Store the result in LIST and return it. LIST must be a proper list.
333 Of several `equal' occurrences of an element in LIST, the first
337 (setcdr tail
(delete (car tail
) (cdr tail
)))
338 (setq tail
(cdr tail
))))
341 (defun number-sequence (from &optional to inc
)
342 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
343 INC is the increment used between numbers in the sequence and defaults to 1.
344 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
345 zero. TO is only included if there is an N for which TO = FROM + N * INC.
346 If TO is nil or numerically equal to FROM, return \(FROM).
347 If INC is positive and TO is less than FROM, or INC is negative
348 and TO is larger than FROM, return nil.
349 If INC is zero and TO is neither nil nor numerically equal to
350 FROM, signal an error.
352 This function is primarily designed for integer arguments.
353 Nevertheless, FROM, TO and INC can be integer or float. However,
354 floating point arithmetic is inexact. For instance, depending on
355 the machine, it may quite well happen that
356 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
357 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
358 elements. Thus, if some of the arguments are floats and one wants
359 to make sure that TO is included, one may have to explicitly write
360 TO as \(+ FROM \(* N INC)) or use a variable whose value was
361 computed with this exact expression. Alternatively, you can,
362 of course, also replace TO with a slightly larger value
363 \(or a slightly more negative value if INC is negative)."
364 (if (or (not to
) (= from to
))
366 (or inc
(setq inc
1))
367 (when (zerop inc
) (error "The increment can not be zero"))
368 (let (seq (n 0) (next from
))
371 (setq seq
(cons next seq
)
373 next
(+ from
(* n inc
))))
375 (setq seq
(cons next seq
)
377 next
(+ from
(* n inc
)))))
380 (defun copy-tree (tree &optional vecp
)
381 "Make a copy of TREE.
382 If TREE is a cons cell, this recursively copies both its car and its cdr.
383 Contrast to `copy-sequence', which copies only along the cdrs. With second
384 argument VECP, this copies vectors as well as conses."
388 (let ((newcar (car tree
)))
389 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
390 (setq newcar
(copy-tree (car tree
) vecp
)))
391 (push newcar result
))
392 (setq tree
(cdr tree
)))
393 (nconc (nreverse result
) tree
))
394 (if (and vecp
(vectorp tree
))
395 (let ((i (length (setq tree
(copy-sequence tree
)))))
396 (while (>= (setq i
(1- i
)) 0)
397 (aset tree i
(copy-tree (aref tree i
) vecp
)))
401 ;;;; Various list-search functions.
403 (defun assoc-default (key alist
&optional test default
)
404 "Find object KEY in a pseudo-alist ALIST.
405 ALIST is a list of conses or objects. Each element
406 (or the element's car, if it is a cons) is compared with KEY by
407 calling TEST, with two arguments: (i) the element or its car,
409 If that is non-nil, the element matches; then `assoc-default'
410 returns the element's cdr, if it is a cons, or DEFAULT if the
411 element is not a cons.
413 If no element matches, the value is nil.
414 If TEST is omitted or nil, `equal' is used."
415 (let (found (tail alist
) value
)
416 (while (and tail
(not found
))
417 (let ((elt (car tail
)))
418 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
419 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
420 (setq tail
(cdr tail
)))
423 (make-obsolete 'assoc-ignore-case
'assoc-string
"22.1")
424 (defun assoc-ignore-case (key alist
)
425 "Like `assoc', but ignores differences in case and text representation.
426 KEY must be a string. Upper-case and lower-case letters are treated as equal.
427 Unibyte strings are converted to multibyte for comparison."
428 (assoc-string key alist t
))
430 (make-obsolete 'assoc-ignore-representation
'assoc-string
"22.1")
431 (defun assoc-ignore-representation (key alist
)
432 "Like `assoc', but ignores differences in text representation.
433 KEY must be a string.
434 Unibyte strings are converted to multibyte for comparison."
435 (assoc-string key alist nil
))
437 (defun member-ignore-case (elt list
)
438 "Like `member', but ignore differences in case and text representation.
439 ELT must be a string. Upper-case and lower-case letters are treated as equal.
440 Unibyte strings are converted to multibyte for comparison.
441 Non-strings in LIST are ignored."
443 (not (and (stringp (car list
))
444 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
445 (setq list
(cdr list
)))
448 (defun assq-delete-all (key alist
)
449 "Delete from ALIST all elements whose car is `eq' to KEY.
450 Return the modified alist.
451 Elements of ALIST that are not conses are ignored."
452 (while (and (consp (car alist
))
453 (eq (car (car alist
)) key
))
454 (setq alist
(cdr alist
)))
455 (let ((tail alist
) tail-cdr
)
456 (while (setq tail-cdr
(cdr tail
))
457 (if (and (consp (car tail-cdr
))
458 (eq (car (car tail-cdr
)) key
))
459 (setcdr tail
(cdr tail-cdr
))
460 (setq tail tail-cdr
))))
463 (defun rassq-delete-all (value alist
)
464 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
465 Return the modified alist.
466 Elements of ALIST that are not conses are ignored."
467 (while (and (consp (car alist
))
468 (eq (cdr (car alist
)) value
))
469 (setq alist
(cdr alist
)))
470 (let ((tail alist
) tail-cdr
)
471 (while (setq tail-cdr
(cdr tail
))
472 (if (and (consp (car tail-cdr
))
473 (eq (cdr (car tail-cdr
)) value
))
474 (setcdr tail
(cdr tail-cdr
))
475 (setq tail tail-cdr
))))
478 (defun remove (elt seq
)
479 "Return a copy of SEQ with all occurrences of ELT removed.
480 SEQ must be a list, vector, or string. The comparison is done with `equal'."
482 ;; If SEQ isn't a list, there's no need to copy SEQ because
483 ;; `delete' will return a new object.
485 (delete elt
(copy-sequence seq
))))
487 (defun remq (elt list
)
488 "Return LIST with all occurrences of ELT removed.
489 The comparison is done with `eq'. Contrary to `delq', this does not use
490 side-effects, and the argument LIST is not modified."
491 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
493 (delq elt
(copy-sequence list
))
499 "Convert KEYS to the internal Emacs key representation.
500 KEYS should be a string constant in the format used for
501 saving keyboard macros (see `edmacro-mode')."
502 (read-kbd-macro keys
))
505 "Beep to tell the user this binding is undefined."
509 ;; Prevent the \{...} documentation construct
510 ;; from mentioning keys that run this command.
511 (put 'undefined
'suppress-keymap t
)
513 (defun suppress-keymap (map &optional nodigits
)
514 "Make MAP override all normally self-inserting keys to be undefined.
515 Normally, as an exception, digits and minus-sign are set to make prefix args,
516 but optional second arg NODIGITS non-nil treats them like other chars."
517 (define-key map
[remap self-insert-command
] 'undefined
)
520 (define-key map
"-" 'negative-argument
)
521 ;; Make plain numbers do numeric args.
524 (define-key map
(char-to-string loop
) 'digit-argument
)
525 (setq loop
(1+ loop
))))))
527 (defun make-composed-keymap (maps &optional parent
)
528 "Construct a new keymap composed of MAPS and inheriting from PARENT.
529 When looking up a key in the returned map, the key is looked in each
530 keymap of MAPS in turn until a binding is found.
531 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
532 As always with keymap inheritance, a nil binding in MAPS overrides
533 any corresponding binding in PARENT, but it does not override corresponding
534 bindings in other keymaps of MAPS.
535 MAPS can be a list of keymaps or a single keymap.
536 PARENT if non-nil should be a keymap."
538 ,@(if (keymapp maps
) (list maps
) maps
)
541 (defun define-key-after (keymap key definition
&optional after
)
542 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
543 This is like `define-key' except that the binding for KEY is placed
544 just after the binding for the event AFTER, instead of at the beginning
545 of the map. Note that AFTER must be an event type (like KEY), NOT a command
548 If AFTER is t or omitted, the new binding goes at the end of the keymap.
549 AFTER should be a single event type--a symbol or a character, not a sequence.
551 Bindings are always added before any inherited map.
553 The order of bindings in a keymap only matters when it is used as
554 a menu, so this function is not useful for non-menu keymaps."
555 (unless after
(setq after t
))
557 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
559 (if (<= (length key
) 1) (aref key
0)
560 (setq keymap
(lookup-key keymap
562 (butlast (mapcar 'identity key
)))))
563 (aref key
(1- (length key
)))))
564 (let ((tail keymap
) done inserted
)
565 (while (and (not done
) tail
)
566 ;; Delete any earlier bindings for the same key.
567 (if (eq (car-safe (car (cdr tail
))) key
)
568 (setcdr tail
(cdr (cdr tail
))))
569 ;; If we hit an included map, go down that one.
570 (if (keymapp (car tail
)) (setq tail
(car tail
)))
571 ;; When we reach AFTER's binding, insert the new binding after.
572 ;; If we reach an inherited keymap, insert just before that.
573 ;; If we reach the end of this keymap, insert at the end.
574 (if (or (and (eq (car-safe (car tail
)) after
)
576 (eq (car (cdr tail
)) 'keymap
)
579 ;; Stop the scan only if we find a parent keymap.
580 ;; Keep going past the inserted element
581 ;; so we can delete any duplications that come later.
582 (if (eq (car (cdr tail
)) 'keymap
)
584 ;; Don't insert more than once.
586 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
588 (setq tail
(cdr tail
)))))
590 (defun map-keymap-sorted (function keymap
)
591 "Implement `map-keymap' with sorting.
592 Don't call this function; it is for internal use only."
594 (map-keymap (lambda (a b
) (push (cons a b
) list
))
596 (setq list
(sort list
598 (setq a
(car a
) b
(car b
))
600 (if (integerp b
) (< a b
)
603 ;; string< also accepts symbols.
606 (funcall function
(car p
) (cdr p
)))))
608 (defun keymap--menu-item-binding (val)
609 "Return the binding part of a menu-item."
611 ((not (consp val
)) val
) ;Not a menu-item.
612 ((eq 'menu-item
(car val
))
613 (let* ((binding (nth 2 val
))
614 (plist (nthcdr 3 val
))
615 (filter (plist-get plist
:filter
)))
616 (if filter
(funcall filter binding
)
618 ((and (consp (cdr val
)) (stringp (cadr val
)))
622 (t val
))) ;Not a menu-item either.
624 (defun keymap--menu-item-with-binding (item binding
)
625 "Build a menu-item like ITEM but with its binding changed to BINDING."
627 ((eq 'menu-item
(car item
))
628 (setq item
(copy-sequence item
))
629 (let ((tail (nthcdr 2 item
)))
630 (setcar tail binding
)
631 ;; Remove any potential filter.
632 (if (plist-get (cdr tail
) :filter
)
633 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
635 ((and (consp (cdr item
)) (stringp (cadr item
)))
636 (cons (car item
) (cons (cadr item
) binding
)))
637 (t (cons (car item
) binding
))))
639 (defun keymap--merge-bindings (val1 val2
)
640 "Merge bindings VAL1 and VAL2."
641 (let ((map1 (keymap--menu-item-binding val1
))
642 (map2 (keymap--menu-item-binding val2
)))
643 (if (not (and (keymapp map1
) (keymapp map2
)))
644 ;; There's nothing to merge: val1 takes precedence.
646 (let ((map (list 'keymap map1 map2
))
647 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
648 (keymap--menu-item-with-binding item map
)))))
650 (defun keymap-canonicalize (map)
651 "Return a simpler equivalent keymap.
652 This resolves inheritance and redefinitions. The returned keymap
653 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
654 and use in active keymaps and menus.
655 Subkeymaps may be modified but are not canonicalized."
656 ;; FIXME: Problem with the difference between a nil binding
657 ;; that hides a binding in an inherited map and a nil binding that's ignored
658 ;; to let some further binding visible. Currently a nil binding hides all.
659 ;; FIXME: we may want to carefully (re)order elements in case they're
663 (prompt (keymap-prompt map
)))
665 (setq map
(map-keymap ;; -internal
668 ;; Treat char-ranges specially.
669 (push (cons key item
) ranges
)
670 (push (cons key item
) bindings
)))
672 ;; Create the new map.
673 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
674 (dolist (binding ranges
)
675 ;; Treat char-ranges specially. FIXME: need to merge as well.
676 (define-key map
(vector (car binding
)) (cdr binding
)))
677 ;; Process the bindings starting from the end.
678 (dolist (binding (prog1 bindings
(setq bindings
())))
679 (let* ((key (car binding
))
681 (oldbind (assq key bindings
)))
682 (push (if (not oldbind
)
683 ;; The normal case: no duplicate bindings.
685 ;; This is the second binding for this key.
686 (setq bindings
(delq oldbind bindings
))
687 (cons key
(keymap--merge-bindings (cdr binding
)
690 (nconc map bindings
)))
692 (put 'keyboard-translate-table
'char-table-extra-slots
0)
694 (defun keyboard-translate (from to
)
695 "Translate character FROM to TO at a low level.
696 This function creates a `keyboard-translate-table' if necessary
697 and then modifies one entry in it."
698 (or (char-table-p keyboard-translate-table
)
699 (setq keyboard-translate-table
700 (make-char-table 'keyboard-translate-table nil
)))
701 (aset keyboard-translate-table from to
))
703 ;;;; Key binding commands.
705 (defun global-set-key (key command
)
706 "Give KEY a global binding as COMMAND.
707 COMMAND is the command definition to use; usually it is
708 a symbol naming an interactively-callable function.
709 KEY is a key sequence; noninteractively, it is a string or vector
710 of characters or event types, and non-ASCII characters with codes
711 above 127 (such as ISO Latin-1) can be included if you use a vector.
713 Note that if KEY has a local binding in the current buffer,
714 that local binding will continue to shadow any global binding
715 that you make with this function."
716 (interactive "KSet key globally: \nCSet key %s to command: ")
717 (or (vectorp key
) (stringp key
)
718 (signal 'wrong-type-argument
(list 'arrayp key
)))
719 (define-key (current-global-map) key command
))
721 (defun local-set-key (key command
)
722 "Give KEY a local binding as COMMAND.
723 COMMAND is the command definition to use; usually it is
724 a symbol naming an interactively-callable function.
725 KEY is a key sequence; noninteractively, it is a string or vector
726 of characters or event types, and non-ASCII characters with codes
727 above 127 (such as ISO Latin-1) can be included if you use a vector.
729 The binding goes in the current buffer's local map,
730 which in most cases is shared with all other buffers in the same major mode."
731 (interactive "KSet key locally: \nCSet key %s locally to command: ")
732 (let ((map (current-local-map)))
734 (use-local-map (setq map
(make-sparse-keymap))))
735 (or (vectorp key
) (stringp key
)
736 (signal 'wrong-type-argument
(list 'arrayp key
)))
737 (define-key map key command
)))
739 (defun global-unset-key (key)
740 "Remove global binding of KEY.
741 KEY is a string or vector representing a sequence of keystrokes."
742 (interactive "kUnset key globally: ")
743 (global-set-key key nil
))
745 (defun local-unset-key (key)
746 "Remove local binding of KEY.
747 KEY is a string or vector representing a sequence of keystrokes."
748 (interactive "kUnset key locally: ")
749 (if (current-local-map)
750 (local-set-key key nil
))
753 ;;;; substitute-key-definition and its subroutines.
755 (defvar key-substitution-in-progress nil
756 "Used internally by `substitute-key-definition'.")
758 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
759 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
760 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
761 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
762 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
764 If you don't specify OLDMAP, you can usually get the same results
765 in a cleaner way with command remapping, like this:
766 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
767 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
768 ;; Don't document PREFIX in the doc string because we don't want to
769 ;; advertise it. It's meant for recursive calls only. Here's its
772 ;; If optional argument PREFIX is specified, it should be a key
773 ;; prefix, a string. Redefined bindings will then be bound to the
774 ;; original key, with PREFIX added at the front.
775 (or prefix
(setq prefix
""))
776 (let* ((scan (or oldmap keymap
))
777 (prefix1 (vconcat prefix
[nil]))
778 (key-substitution-in-progress
779 (cons scan key-substitution-in-progress)))
780 ;; Scan OLDMAP, finding each char or event-symbol that
781 ;; has any definition, and act on it with hack-key.
784 (aset prefix1 (length prefix) char)
785 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
788 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
789 (let (inner-def skipped menu-item)
790 ;; Find the actual command name within the binding.
791 (if (eq (car-safe defn) 'menu-item)
792 (setq menu-item defn defn (nth 2 defn))
793 ;; Skip past menu-prompt.
794 (while (stringp (car-safe defn))
795 (push (pop defn) skipped))
796 ;; Skip past cached key-equivalence data for menu items.
797 (if (consp (car-safe defn))
798 (setq defn (cdr defn))))
799 (if (or (eq defn olddef)
800 ;; Compare with equal if definition is a key sequence.
801 ;; That is useful for operating on function-key-map.
802 (and (or (stringp defn) (vectorp defn))
803 (equal defn olddef)))
804 (define-key keymap prefix
806 (let ((copy (copy-sequence menu-item)))
807 (setcar (nthcdr 2 copy) newdef)
809 (nconc (nreverse skipped) newdef)))
810 ;; Look past a symbol that names a keymap.
812 (or (indirect-function defn t) defn))
813 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
814 ;; avoid autoloading a keymap. This is mostly done to preserve the
815 ;; original non-autoloading behavior of pre-map-keymap times.
816 (if (and (keymapp inner-def)
817 ;; Avoid recursively scanning
818 ;; where KEYMAP does not have a submap.
819 (let ((elt (lookup-key keymap prefix)))
820 (or (null elt) (natnump elt) (keymapp elt)))
821 ;; Avoid recursively rescanning keymap being scanned.
822 (not (memq inner-def key-substitution-in-progress)))
823 ;; If this one isn't being scanned already, scan it now.
824 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
827 ;;;; The global keymap tree.
829 ;; global-map, esc-map, and ctl-x-map have their values set up in
830 ;; keymap.c; we just give them docstrings here.
832 (defvar global-map nil
833 "Default global keymap mapping Emacs keyboard input into commands.
834 The value is a keymap which is usually (but not necessarily) Emacs's
838 "Default keymap for ESC (meta) commands.
839 The normal global definition of the character ESC indirects to this keymap.")
841 (defvar ctl-x-map nil
842 "Default keymap for C-x commands.
843 The normal global definition of the character C-x indirects to this keymap.")
845 (defvar ctl-x-4-map (make-sparse-keymap)
846 "Keymap for subcommands of C-x 4.")
847 (defalias 'ctl-x-4-prefix ctl-x-4-map)
848 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
850 (defvar ctl-x-5-map (make-sparse-keymap)
851 "Keymap for frame commands.")
852 (defalias 'ctl-x-5-prefix ctl-x-5-map)
853 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
856 ;;;; Event manipulation functions.
858 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
860 (defun listify-key-sequence (key)
861 "Convert a key sequence to a list of events."
864 (mapcar (function (lambda (c)
866 (logxor c listify-key-sequence-1)
870 (defsubst eventp (obj)
871 "True if the argument is an event object."
872 (or (and (integerp obj)
873 ;; Filter out integers too large to be events.
874 ;; M is the biggest modifier.
875 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
876 (characterp (event-basic-type obj)))
878 (get obj 'event-symbol-elements))
881 (get (car obj) 'event-symbol-elements))))
883 (defun event-modifiers (event)
884 "Return a list of symbols representing the modifier keys in event EVENT.
885 The elements of the list may include `meta', `control',
886 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
888 EVENT may be an event or an event type. If EVENT is a symbol
889 that has never been used in an event that has been read as input
890 in the current Emacs session, then this function may fail to include
891 the `click' modifier."
894 (setq type (car type)))
896 ;; Don't read event-symbol-elements directly since we're not
897 ;; sure the symbol has already been parsed.
898 (cdr (internal-event-symbol-parse-modifiers type))
900 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
901 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
902 (if (not (zerop (logand type ?\M-\^@)))
904 (if (or (not (zerop (logand type ?\C-\^@)))
906 (push 'control list))
907 (if (or (not (zerop (logand type ?\S-\^@)))
908 (/= char (downcase char)))
910 (or (zerop (logand type ?\H-\^@))
912 (or (zerop (logand type ?\s-\^@))
914 (or (zerop (logand type ?\A-\^@))
918 (defun event-basic-type (event)
919 "Return the basic type of the given event (all modifiers removed).
920 The value is a printing character (not upper case) or a symbol.
921 EVENT may be an event or an event type. If EVENT is a symbol
922 that has never been used in an event that has been read as input
923 in the current Emacs session, then this function may return nil."
925 (setq event (car event)))
927 (car (get event 'event-symbol-elements))
928 (let* ((base (logand event (1- ?\A-\^@)))
929 (uncontrolled (if (< base 32) (logior base 64) base)))
930 ;; There are some numbers that are invalid characters and
931 ;; cause `downcase' to get an error.
933 (downcase uncontrolled)
934 (error uncontrolled)))))
936 (defsubst mouse-movement-p (object)
937 "Return non-nil if OBJECT is a mouse movement event."
938 (eq (car-safe object) 'mouse-movement))
940 (defun mouse-event-p (object)
941 "Return non-nil if OBJECT is a mouse click event."
942 ;; is this really correct? maybe remove mouse-movement?
943 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
945 (defsubst event-start (event)
946 "Return the starting position of EVENT.
947 EVENT should be a click, drag, or key press event.
948 If it is a key press event, the return value has the form
949 (WINDOW POS (0 . 0) 0)
950 If it is a click or drag event, it has the form
951 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
952 IMAGE (DX . DY) (WIDTH . HEIGHT))
953 The `posn-' functions access elements of such lists.
954 For more information, see Info node `(elisp)Click Events'.
956 If EVENT is a mouse or key press or a mouse click, this is the
957 position of the event. If EVENT is a drag, this is the starting
958 position of the drag."
959 (if (consp event) (nth 1 event)
960 (list (selected-window) (point) '(0 . 0) 0)))
962 (defsubst event-end (event)
963 "Return the ending location of EVENT.
964 EVENT should be a click, drag, or key press event.
965 If EVENT is a key press event, the return value has the form
966 (WINDOW POS (0 . 0) 0)
967 If EVENT is a click event, this function is the same as
968 `event-start'. For click and drag events, the return value has
970 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
971 IMAGE (DX . DY) (WIDTH . HEIGHT))
972 The `posn-' functions access elements of such lists.
973 For more information, see Info node `(elisp)Click Events'.
975 If EVENT is a mouse or key press or a mouse click, this is the
976 position of the event. If EVENT is a drag, this is the starting
977 position of the drag."
978 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
979 (list (selected-window) (point) '(0 . 0) 0)))
981 (defsubst event-click-count (event)
982 "Return the multi-click count of EVENT, a click or drag event.
983 The return value is a positive integer."
984 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
986 ;;;; Extracting fields of the positions in an event.
988 (defsubst posn-window (position)
989 "Return the window in POSITION.
990 POSITION should be a list of the form returned by the `event-start'
991 and `event-end' functions."
994 (defsubst posn-area (position)
995 "Return the window area recorded in POSITION, or nil for the text area.
996 POSITION should be a list of the form returned by the `event-start'
997 and `event-end' functions."
998 (let ((area (if (consp (nth 1 position))
999 (car (nth 1 position))
1001 (and (symbolp area) area)))
1003 (defsubst posn-point (position)
1004 "Return the buffer location in POSITION.
1005 POSITION should be a list of the form returned by the `event-start'
1006 and `event-end' functions."
1007 (or (nth 5 position)
1008 (if (consp (nth 1 position))
1009 (car (nth 1 position))
1012 (defun posn-set-point (position)
1013 "Move point to POSITION.
1014 Select the corresponding window as well."
1015 (if (not (windowp (posn-window position)))
1016 (error "Position not in text area of window"))
1017 (select-window (posn-window position))
1018 (if (numberp (posn-point position))
1019 (goto-char (posn-point position))))
1021 (defsubst posn-x-y (position)
1022 "Return the x and y coordinates in POSITION.
1023 The return value has the form (X . Y), where X and Y are given in
1024 pixels. POSITION should be a list of the form returned by
1025 `event-start' and `event-end'."
1028 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1030 (defun posn-col-row (position)
1031 "Return the nominal column and row in POSITION, measured in characters.
1032 The column and row values are approximations calculated from the x
1033 and y coordinates in POSITION and the frame's default character width
1035 For a scroll-bar event, the result column is 0, and the row
1036 corresponds to the vertical position of the click in the scroll bar.
1037 POSITION should be a list of the form returned by the `event-start'
1038 and `event-end' functions."
1039 (let* ((pair (posn-x-y position))
1040 (window (posn-window position))
1041 (area (posn-area position)))
1045 ((eq area 'vertical-scroll-bar)
1046 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1047 ((eq area 'horizontal-scroll-bar)
1048 (cons (scroll-bar-scale pair (window-width window)) 0))
1050 (let* ((frame (if (framep window) window (window-frame window)))
1051 ;; FIXME: This should take line-spacing properties on
1052 ;; newlines into account.
1053 (spacing (when (display-graphic-p frame)
1054 (or (with-current-buffer (window-buffer window)
1056 (frame-parameter frame 'line-spacing)))))
1057 (cond ((floatp spacing)
1058 (setq spacing (truncate (* spacing
1059 (frame-char-height frame)))))
1062 (cons (/ (car pair) (frame-char-width frame))
1063 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1064 (if (null (with-current-buffer (window-buffer window)
1065 header-line-format))
1068 (defun posn-actual-col-row (position)
1069 "Return the actual column and row in POSITION, measured in characters.
1070 These are the actual row number in the window and character number in that row.
1071 Return nil if POSITION does not contain the actual position; in that case
1072 `posn-col-row' can be used to get approximate values.
1073 POSITION should be a list of the form returned by the `event-start'
1074 and `event-end' functions."
1077 (defsubst posn-timestamp (position)
1078 "Return the timestamp of POSITION.
1079 POSITION should be a list of the form returned by the `event-start'
1080 and `event-end' functions."
1083 (defsubst posn-string (position)
1084 "Return the string object of POSITION.
1085 Value is a cons (STRING . STRING-POS), or nil if not a string.
1086 POSITION should be a list of the form returned by the `event-start'
1087 and `event-end' functions."
1090 (defsubst posn-image (position)
1091 "Return the image object of POSITION.
1092 Value is a list (image ...), or nil if not an image.
1093 POSITION should be a list of the form returned by the `event-start'
1094 and `event-end' functions."
1097 (defsubst posn-object (position)
1098 "Return the object (image or string) of POSITION.
1099 Value is a list (image ...) for an image object, a cons cell
1100 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1101 POSITION should be a list of the form returned by the `event-start'
1102 and `event-end' functions."
1103 (or (posn-image position) (posn-string position)))
1105 (defsubst posn-object-x-y (position)
1106 "Return the x and y coordinates relative to the object of POSITION.
1107 The return value has the form (DX . DY), where DX and DY are
1108 given in pixels. POSITION should be a list of the form returned
1109 by `event-start' and `event-end'."
1112 (defsubst posn-object-width-height (position)
1113 "Return the pixel width and height of the object of POSITION.
1114 The return value has the form (WIDTH . HEIGHT). POSITION should
1115 be a list of the form returned by `event-start' and `event-end'."
1119 ;;;; Obsolescent names for functions.
1121 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1122 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1123 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1124 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1125 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1126 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1128 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1130 (defun insert-string (&rest args)
1131 "Mocklisp-compatibility insert function.
1132 Like the function `insert' except that any argument that is a number
1133 is converted into a string by expressing it in decimal."
1135 (insert (if (integerp el) (number-to-string el) el))))
1136 (make-obsolete 'insert-string 'insert "22.1")
1138 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1139 (make-obsolete 'makehash 'make-hash-table "22.1")
1141 ;; These are used by VM and some old programs
1142 (defalias 'focus-frame 'ignore "")
1143 (make-obsolete 'focus-frame "it does nothing." "22.1")
1144 (defalias 'unfocus-frame 'ignore "")
1145 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1146 (make-obsolete 'make-variable-frame-local
1147 "explicitly check for a frame-parameter instead." "22.2")
1148 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1149 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
1150 (set-advertised-calling-convention
1151 'all-completions '(string collection &optional predicate) "23.1")
1152 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1154 ;;;; Obsolescence declarations for variables, and aliases.
1156 ;; Special "default-FOO" variables which contain the default value of
1157 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1158 ;; slows down several unrelated variable operations; furthermore, they
1159 ;; can lead to really odd behavior if you decide to make them
1162 ;; Not used at all in Emacs, last time I checked:
1163 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1164 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1165 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1166 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1167 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1168 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1169 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1170 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1171 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1172 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1173 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1174 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1175 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1176 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1177 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1178 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1179 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1180 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1181 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1182 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1183 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1184 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1185 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1186 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1187 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1188 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1189 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1190 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1191 (make-obsolete-variable 'default-enable-multibyte-characters
1192 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1194 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1195 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1196 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1197 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1198 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1199 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1201 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1202 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1204 (make-obsolete-variable
1205 'mode-line-inverse-video
1206 "use the appropriate faces instead."
1208 (make-obsolete-variable
1209 'unread-command-char
1210 "use `unread-command-events' instead. That variable is a list of events
1211 to reread, so it now uses nil to mean `no event', instead of -1."
1214 ;; Lisp manual only updated in 22.1.
1215 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1218 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1219 (make-obsolete-variable 'x-lost-selection-hooks
1220 'x-lost-selection-functions "22.1")
1221 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1222 (make-obsolete-variable 'x-sent-selection-hooks
1223 'x-sent-selection-functions "22.1")
1225 ;; This was introduced in 21.4 for pre-unicode unification. That
1226 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1227 ;; Other uses are possible, so this variable is not _really_ obsolete,
1228 ;; but Stefan insists to mark it so.
1229 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1231 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1233 ;; These aliases exist in Emacs 19.34, and probably before, but were
1234 ;; only marked as obsolete in 23.1.
1235 ;; The lisp manual (since at least Emacs 21) describes them as
1236 ;; existing "for compatibility with Emacs version 18".
1237 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1239 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1243 ;;;; Alternate names for functions - these are not being phased out.
1245 (defalias 'send-string 'process-send-string)
1246 (defalias 'send-region 'process-send-region)
1247 (defalias 'string= 'string-equal)
1248 (defalias 'string< 'string-lessp)
1249 (defalias 'move-marker 'set-marker)
1250 (defalias 'rplaca 'setcar)
1251 (defalias 'rplacd 'setcdr)
1252 (defalias 'beep 'ding) ;preserve lingual purity
1253 (defalias 'indent-to-column 'indent-to)
1254 (defalias 'backward-delete-char 'delete-backward-char)
1255 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1256 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1257 (defalias 'int-to-string 'number-to-string)
1258 (defalias 'store-match-data 'set-match-data)
1259 (defalias 'chmod 'set-file-modes)
1260 (defalias 'mkdir 'make-directory)
1261 ;; These are the XEmacs names:
1262 (defalias 'point-at-eol 'line-end-position)
1263 (defalias 'point-at-bol 'line-beginning-position)
1265 (defalias 'user-original-login-name 'user-login-name)
1268 ;;;; Hook manipulation functions.
1270 (defun add-hook (hook function &optional append local)
1271 "Add to the value of HOOK the function FUNCTION.
1272 FUNCTION is not added if already present.
1273 FUNCTION is added (if necessary) at the beginning of the hook list
1274 unless the optional argument APPEND is non-nil, in which case
1275 FUNCTION is added at the end.
1277 The optional fourth argument, LOCAL, if non-nil, says to modify
1278 the hook's buffer-local value rather than its global value.
1279 This makes the hook buffer-local, and it makes t a member of the
1280 buffer-local value. That acts as a flag to run the hook
1281 functions of the global value as well as in the local value.
1283 HOOK should be a symbol, and FUNCTION may be any valid function. If
1284 HOOK is void, it is first set to nil. If HOOK's value is a single
1285 function, it is changed to a list of functions."
1286 (or (boundp hook) (set hook nil))
1287 (or (default-boundp hook) (set-default hook nil))
1288 (if local (unless (local-variable-if-set-p hook)
1289 (set (make-local-variable hook) (list t)))
1290 ;; Detect the case where make-local-variable was used on a hook
1291 ;; and do what we used to do.
1292 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1294 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1295 ;; If the hook value is a single function, turn it into a list.
1296 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1297 (setq hook-value (list hook-value)))
1298 ;; Do the actual addition if necessary
1299 (unless (member function hook-value)
1300 (when (stringp function)
1301 (setq function (purecopy function)))
1304 (append hook-value (list function))
1305 (cons function hook-value))))
1306 ;; Set the actual variable
1309 ;; If HOOK isn't a permanent local,
1310 ;; but FUNCTION wants to survive a change of modes,
1311 ;; mark HOOK as partially permanent.
1312 (and (symbolp function)
1313 (get function 'permanent-local-hook)
1314 (not (get hook 'permanent-local))
1315 (put hook 'permanent-local 'permanent-local-hook))
1316 (set hook hook-value))
1317 (set-default hook hook-value))))
1319 (defun remove-hook (hook function &optional local)
1320 "Remove from the value of HOOK the function FUNCTION.
1321 HOOK should be a symbol, and FUNCTION may be any valid function. If
1322 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1323 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1325 The optional third argument, LOCAL, if non-nil, says to modify
1326 the hook's buffer-local value rather than its default value."
1327 (or (boundp hook) (set hook nil))
1328 (or (default-boundp hook) (set-default hook nil))
1329 ;; Do nothing if LOCAL is t but this hook has no local binding.
1330 (unless (and local (not (local-variable-p hook)))
1331 ;; Detect the case where make-local-variable was used on a hook
1332 ;; and do what we used to do.
1333 (when (and (local-variable-p hook)
1334 (not (and (consp (symbol-value hook))
1335 (memq t (symbol-value hook)))))
1337 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1338 ;; Remove the function, for both the list and the non-list cases.
1339 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1340 (if (equal hook-value function) (setq hook-value nil))
1341 (setq hook-value (delete function (copy-sequence hook-value))))
1342 ;; If the function is on the global hook, we need to shadow it locally
1343 ;;(when (and local (member function (default-value hook))
1344 ;; (not (member (cons 'not function) hook-value)))
1345 ;; (push (cons 'not function) hook-value))
1346 ;; Set the actual variable
1348 (set-default hook hook-value)
1349 (if (equal hook-value '(t))
1350 (kill-local-variable hook)
1351 (set hook hook-value))))))
1353 (defmacro letrec (binders &rest body)
1354 "Bind variables according to BINDERS then eval BODY.
1355 The value of the last form in BODY is returned.
1356 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1357 SYMBOL to the value of VALUEFORM.
1358 All symbols are bound before the VALUEFORMs are evalled."
1359 ;; Only useful in lexical-binding mode.
1360 ;; As a special-form, we could implement it more efficiently (and cleanly,
1361 ;; making the vars actually unbound during evaluation of the binders).
1362 (declare (debug let) (indent 1))
1363 `(let ,(mapcar #'car binders)
1364 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1367 (defmacro with-wrapper-hook (hook args &rest body)
1368 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1369 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1370 around the preceding ones, like a set of nested `around' advices.
1372 Each hook function should accept an argument list consisting of a
1373 function FUN, followed by the additional arguments in ARGS.
1375 The FUN passed to the first hook function in HOOK performs BODY,
1376 if it is called with arguments ARGS. The FUN passed to each
1377 successive hook function is defined based on the preceding hook
1378 functions; if called with arguments ARGS, it does what the
1379 `with-wrapper-hook' call would do if the preceding hook functions
1380 were the only ones present in HOOK.
1382 In the function definition of each hook function, FUN can be
1383 called any number of times (including not calling it at all).
1384 That function definition is then used to construct the FUN passed
1385 to the next hook function, if any. The last (or \"outermost\")
1386 FUN is then called once."
1387 (declare (indent 2) (debug (form sexp body)))
1388 ;; We need those two gensyms because CL's lexical scoping is not available
1389 ;; for function arguments :-(
1390 (let ((funs (make-symbol "funs"))
1391 (global (make-symbol "global"))
1392 (argssym (make-symbol "args"))
1393 (runrestofhook (make-symbol "runrestofhook")))
1394 ;; Since the hook is a wrapper, the loop has to be done via
1395 ;; recursion: a given hook function will call its parameter in order to
1396 ;; continue looping.
1397 `(letrec ((,runrestofhook
1398 (lambda (,funs ,global ,argssym)
1399 ;; `funs' holds the functions left on the hook and `global'
1400 ;; holds the functions left on the global part of the hook
1401 ;; (in case the hook is local).
1403 (if (eq t (car ,funs))
1404 (funcall ,runrestofhook
1405 (append ,global (cdr ,funs)) nil ,argssym)
1408 (lambda (,funs ,global &rest ,argssym)
1409 (funcall ,runrestofhook ,funs ,global ,argssym))
1410 (cdr ,funs) ,global)
1412 ;; Once there are no more functions on the hook, run
1413 ;; the original body.
1414 (apply (lambda ,args ,@body) ,argssym)))))
1415 (funcall ,runrestofhook ,hook
1416 ;; The global part of the hook, if any.
1418 `(if (local-variable-p ',hook)
1419 (default-value ',hook)))
1422 (defun add-to-list (list-var element &optional append compare-fn)
1423 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1424 The test for presence of ELEMENT is done with `equal',
1425 or with COMPARE-FN if that's non-nil.
1426 If ELEMENT is added, it is added at the beginning of the list,
1427 unless the optional argument APPEND is non-nil, in which case
1428 ELEMENT is added at the end.
1430 The return value is the new value of LIST-VAR.
1432 If you want to use `add-to-list' on a variable that is not defined
1433 until a certain package is loaded, you should put the call to `add-to-list'
1434 into a hook function that will be run only after loading the package.
1435 `eval-after-load' provides one way to do this. In some cases
1436 other hooks, such as major mode hooks, can do the job."
1439 (member element (symbol-value list-var)))
1440 ((eq compare-fn 'eq)
1441 (memq element (symbol-value list-var)))
1442 ((eq compare-fn 'eql)
1443 (memql element (symbol-value list-var)))
1445 (let ((lst (symbol-value list-var)))
1447 (not (funcall compare-fn element (car lst))))
1448 (setq lst (cdr lst)))
1450 (symbol-value list-var)
1453 (append (symbol-value list-var) (list element))
1454 (cons element (symbol-value list-var))))))
1457 (defun add-to-ordered-list (list-var element &optional order)
1458 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1459 The test for presence of ELEMENT is done with `eq'.
1461 The resulting list is reordered so that the elements are in the
1462 order given by each element's numeric list order. Elements
1463 without a numeric list order are placed at the end of the list.
1465 If the third optional argument ORDER is a number (integer or
1466 float), set the element's list order to the given value. If
1467 ORDER is nil or omitted, do not change the numeric order of
1468 ELEMENT. If ORDER has any other value, remove the numeric order
1469 of ELEMENT if it has one.
1471 The list order for each element is stored in LIST-VAR's
1472 `list-order' property.
1474 The return value is the new value of LIST-VAR."
1475 (let ((ordering (get list-var 'list-order)))
1477 (put list-var 'list-order
1478 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1480 (puthash element (and (numberp order) order) ordering))
1481 (unless (memq element (symbol-value list-var))
1482 (set list-var (cons element (symbol-value list-var))))
1483 (set list-var (sort (symbol-value list-var)
1485 (let ((oa (gethash a ordering))
1486 (ob (gethash b ordering)))
1491 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1492 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1493 Return the new history list.
1494 If MAXELT is non-nil, it specifies the maximum length of the history.
1495 Otherwise, the maximum history length is the value of the `history-length'
1496 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1498 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1499 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1500 if it is empty or a duplicate."
1502 (setq maxelt (or (get history-var 'history-length)
1504 (let ((history (symbol-value history-var))
1506 (when (and (listp history)
1508 (not (stringp newelt))
1509 (> (length newelt) 0))
1511 (not (equal (car history) newelt))))
1512 (if history-delete-duplicates
1513 (delete newelt history))
1514 (setq history (cons newelt history))
1515 (when (integerp maxelt)
1518 (setq tail (nthcdr (1- maxelt) history))
1520 (setcdr tail nil)))))
1521 (set history-var history)))
1526 (defvar delay-mode-hooks nil
1527 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1528 (defvar delayed-mode-hooks nil
1529 "List of delayed mode hooks waiting to be run.")
1530 (make-variable-buffer-local 'delayed-mode-hooks)
1531 (put 'delay-mode-hooks 'permanent-local t)
1533 (defvar change-major-mode-after-body-hook nil
1534 "Normal hook run in major mode functions, before the mode hooks.")
1536 (defvar after-change-major-mode-hook nil
1537 "Normal hook run at the very end of major mode functions.")
1539 (defun run-mode-hooks (&rest hooks)
1540 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1541 Execution is delayed if the variable `delay-mode-hooks' is non-nil.
1542 Otherwise, runs the mode hooks and then `after-change-major-mode-hook'.
1543 Major mode functions should use this instead of `run-hooks' when running their
1545 (if delay-mode-hooks
1547 (dolist (hook hooks)
1548 (push hook delayed-mode-hooks))
1549 ;; Normal case, just run the hook as before plus any delayed hooks.
1550 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1551 (setq delayed-mode-hooks nil)
1552 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1553 (run-hooks 'after-change-major-mode-hook)))
1555 (defmacro delay-mode-hooks (&rest body)
1556 "Execute BODY, but delay any `run-mode-hooks'.
1557 These hooks will be executed by the first following call to
1558 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1559 Only affects hooks run in the current buffer."
1560 (declare (debug t) (indent 0))
1562 (make-local-variable 'delay-mode-hooks)
1563 (let ((delay-mode-hooks t))
1566 ;; PUBLIC: find if the current mode derives from another.
1568 (defun derived-mode-p (&rest modes)
1569 "Non-nil if the current major mode is derived from one of MODES.
1570 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1571 (let ((parent major-mode))
1572 (while (and (not (memq parent modes))
1573 (setq parent (get parent 'derived-mode-parent))))
1578 ;; If a minor mode is not defined with define-minor-mode,
1579 ;; add it here explicitly.
1580 ;; isearch-mode is deliberately excluded, since you should
1581 ;; not call it yourself.
1582 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1583 overwrite-mode view-mode
1585 "List of all minor mode functions.")
1587 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1588 "Register a new minor mode.
1590 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1592 TOGGLE is a symbol which is the name of a buffer-local variable that
1593 is toggled on or off to say whether the minor mode is active or not.
1595 NAME specifies what will appear in the mode line when the minor mode
1596 is active. NAME should be either a string starting with a space, or a
1597 symbol whose value is such a string.
1599 Optional KEYMAP is the keymap for the minor mode that will be added
1600 to `minor-mode-map-alist'.
1602 Optional AFTER specifies that TOGGLE should be added after AFTER
1603 in `minor-mode-alist'.
1605 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1606 It defaults to (and should by convention be) TOGGLE.
1608 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1609 included in the mode-line minor mode menu.
1610 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1611 (unless (memq toggle minor-mode-list)
1612 (push toggle minor-mode-list))
1614 (unless toggle-fun (setq toggle-fun toggle))
1615 (unless (eq toggle-fun toggle)
1616 (put toggle :minor-mode-function toggle-fun))
1617 ;; Add the name to the minor-mode-alist.
1619 (let ((existing (assq toggle minor-mode-alist)))
1621 (setcdr existing (list name))
1622 (let ((tail minor-mode-alist) found)
1623 (while (and tail (not found))
1624 (if (eq after (caar tail))
1626 (setq tail (cdr tail))))
1628 (let ((rest (cdr found)))
1630 (nconc found (list (list toggle name)) rest))
1631 (push (list toggle name) minor-mode-alist))))))
1632 ;; Add the toggle to the minor-modes menu if requested.
1633 (when (get toggle :included)
1634 (define-key mode-line-mode-menu
1638 (or (get toggle :menu-tag)
1639 (if (stringp name) name (symbol-name toggle)))
1640 (let ((mode-name (if (symbolp name) (symbol-value name))))
1641 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1642 (concat " (" (match-string 0 mode-name) ")"))))
1644 :button (cons :toggle toggle))))
1646 ;; Add the map to the minor-mode-map-alist.
1648 (let ((existing (assq toggle minor-mode-map-alist)))
1650 (setcdr existing keymap)
1651 (let ((tail minor-mode-map-alist) found)
1652 (while (and tail (not found))
1653 (if (eq after (caar tail))
1655 (setq tail (cdr tail))))
1657 (let ((rest (cdr found)))
1659 (nconc found (list (cons toggle keymap)) rest))
1660 (push (cons toggle keymap) minor-mode-map-alist)))))))
1664 (defun symbol-file (symbol &optional type)
1665 "Return the name of the file that defined SYMBOL.
1666 The value is normally an absolute file name. It can also be nil,
1667 if the definition is not associated with any file. If SYMBOL
1668 specifies an autoloaded function, the value can be a relative
1669 file name without extension.
1671 If TYPE is nil, then any kind of definition is acceptable. If
1672 TYPE is `defun', `defvar', or `defface', that specifies function
1673 definition, variable definition, or face definition only."
1674 (if (and (or (null type) (eq type 'defun))
1675 (symbolp symbol) (fboundp symbol)
1676 (eq 'autoload (car-safe (symbol-function symbol))))
1677 (nth 1 (symbol-function symbol))
1678 (let ((files load-history)
1682 (if (eq type 'defvar)
1683 ;; Variables are present just as their names.
1684 (member symbol (cdr (car files)))
1685 ;; Other types are represented as (TYPE . NAME).
1686 (member (cons type symbol) (cdr (car files))))
1687 ;; We accept all types, so look for variable def
1688 ;; and then for any other kind.
1689 (or (member symbol (cdr (car files)))
1690 (rassq symbol (cdr (car files)))))
1691 (setq file (car (car files)) files nil))
1692 (setq files (cdr files)))
1695 (defun locate-library (library &optional nosuffix path interactive-call)
1696 "Show the precise file name of Emacs library LIBRARY.
1697 LIBRARY should be a relative file name of the library, a string.
1698 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1699 nil (which is the default, see below).
1700 This command searches the directories in `load-path' like `\\[load-library]'
1701 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1702 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1703 to the specified name LIBRARY.
1705 If the optional third arg PATH is specified, that list of directories
1706 is used instead of `load-path'.
1708 When called from a program, the file name is normally returned as a
1709 string. When run interactively, the argument INTERACTIVE-CALL is t,
1710 and the file name is displayed in the echo area."
1711 (interactive (list (completing-read "Locate library: "
1713 'locate-file-completion-table
1714 load-path (get-load-suffixes)))
1717 (let ((file (locate-file library
1719 (append (unless nosuffix (get-load-suffixes))
1720 load-file-rep-suffixes))))
1721 (if interactive-call
1723 (message "Library is file %s" (abbreviate-file-name file))
1724 (message "No library %s in search path" library)))
1728 ;;;; Specifying things to do later.
1730 (defun load-history-regexp (file)
1731 "Form a regexp to find FILE in `load-history'.
1732 FILE, a string, is described in the function `eval-after-load'."
1733 (if (file-name-absolute-p file)
1734 (setq file (file-truename file)))
1735 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1737 (if (file-name-extension file)
1739 ;; Note: regexp-opt can't be used here, since we need to call
1740 ;; this before Emacs has been fully started. 2006-05-21
1741 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1742 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1745 (defun load-history-filename-element (file-regexp)
1746 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1747 Return nil if there isn't one."
1748 (let* ((loads load-history)
1749 (load-elt (and loads (car loads))))
1752 (or (null (car load-elt))
1753 (not (string-match file-regexp (car load-elt)))))
1754 (setq loads (cdr loads)
1755 load-elt (and loads (car loads)))))
1758 (put 'eval-after-load 'lisp-indent-function 1)
1759 (defun eval-after-load (file form)
1760 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
1761 If FILE is already loaded, evaluate FORM right now.
1763 If a matching file is loaded again, FORM will be evaluated again.
1765 If FILE is a string, it may be either an absolute or a relative file
1766 name, and may have an extension \(e.g. \".el\") or may lack one, and
1767 additionally may or may not have an extension denoting a compressed
1768 format \(e.g. \".gz\").
1770 When FILE is absolute, this first converts it to a true name by chasing
1771 symbolic links. Only a file of this name \(see next paragraph regarding
1772 extensions) will trigger the evaluation of FORM. When FILE is relative,
1773 a file whose absolute true name ends in FILE will trigger evaluation.
1775 When FILE lacks an extension, a file name with any extension will trigger
1776 evaluation. Otherwise, its extension must match FILE's. A further
1777 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1780 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1781 is evaluated at the end of any file that `provide's this feature.
1783 Usually FILE is just a library name like \"font-lock\" or a feature name
1786 This function makes or adds to an entry on `after-load-alist'."
1787 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1788 ;; evaluating it now).
1789 (let* ((regexp-or-feature
1791 (setq file (purecopy (load-history-regexp file)))
1793 (elt (assoc regexp-or-feature after-load-alist)))
1795 (setq elt (list regexp-or-feature))
1796 (push elt after-load-alist))
1797 ;; Make sure `form' is evalled in the current lexical/dynamic code.
1798 (setq form `(funcall ',(eval `(lambda () ,form) lexical-binding)))
1799 (when (symbolp regexp-or-feature)
1800 ;; For features, the after-load-alist elements get run when `provide' is
1801 ;; called rather than at the end of the file. So add an indirection to
1802 ;; make sure that `form' is really run "after-load" in case the provide
1803 ;; call happens early.
1805 `(when load-file-name
1806 (let ((fun (make-symbol "eval-after-load-helper")))
1807 (fset fun `(lambda (file)
1808 (if (not (equal file ',load-file-name))
1810 (remove-hook 'after-load-functions ',fun)
1812 (add-hook 'after-load-functions fun)))))
1813 ;; Add FORM to the element unless it's already there.
1814 (unless (member form (cdr elt))
1815 (nconc elt (purecopy (list form))))
1817 ;; Is there an already loaded file whose name (or `provide' name)
1819 (if (if (stringp file)
1820 (load-history-filename-element regexp-or-feature)
1824 (defvar after-load-functions nil
1825 "Special hook run after loading a file.
1826 Each function there is called with a single argument, the absolute
1827 name of the file just loaded.")
1829 (defun do-after-load-evaluation (abs-file)
1830 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1831 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1832 This function is called directly from the C code."
1833 ;; Run the relevant eval-after-load forms.
1834 (mapc #'(lambda (a-l-element)
1835 (when (and (stringp (car a-l-element))
1836 (string-match-p (car a-l-element) abs-file))
1837 ;; discard the file name regexp
1838 (mapc #'eval (cdr a-l-element))))
1840 ;; Complain when the user uses obsolete files.
1841 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1842 (run-with-timer 0 nil
1844 (message "Package %s is obsolete!"
1846 (string-match "\\.elc?\\>" file))))
1847 (file-name-nondirectory abs-file)))
1848 ;; Finally, run any other hook.
1849 (run-hook-with-args 'after-load-functions abs-file))
1851 (defun eval-next-after-load (file)
1852 "Read the following input sexp, and run it whenever FILE is loaded.
1853 This makes or adds to an entry on `after-load-alist'.
1854 FILE should be the name of a library, with no directory name."
1855 (eval-after-load file (read)))
1856 (make-obsolete 'eval-next-after-load `eval-after-load "23.2")
1858 (defun display-delayed-warnings ()
1859 "Display delayed warnings from `delayed-warnings-list'.
1860 This is the default value of `delayed-warnings-hook'."
1861 (dolist (warning (nreverse delayed-warnings-list))
1862 (apply 'display-warning warning))
1863 (setq delayed-warnings-list nil))
1865 (defvar delayed-warnings-hook '(display-delayed-warnings)
1866 "Normal hook run to process delayed warnings.
1867 Functions in this hook should access the `delayed-warnings-list'
1868 variable (which see) and remove from it the warnings they process.")
1873 (defun process-lines (program &rest args)
1874 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1875 Signal an error if the program returns with a non-zero exit status."
1877 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1878 (unless (eq status 0)
1879 (error "%s exited with status %s" program status))
1880 (goto-char (point-min))
1883 (setq lines (cons (buffer-substring-no-properties
1884 (line-beginning-position)
1885 (line-end-position))
1888 (nreverse lines)))))
1890 (defun process-live-p (process)
1891 "Returns non-nil if PROCESS is alive.
1892 A process is considered alive if its status is `run', `open',
1893 `listen', `connect' or `stop'."
1894 (memq (process-status process)
1895 '(run open listen connect stop)))
1900 'process-kill-without-query
1901 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1903 (defun process-kill-without-query (process &optional _flag)
1904 "Say no query needed if PROCESS is running when Emacs is exited.
1905 Optional second argument if non-nil says to require a query.
1906 Value is t if a query was formerly required."
1907 (let ((old (process-query-on-exit-flag process)))
1908 (set-process-query-on-exit-flag process nil)
1911 (defun process-kill-buffer-query-function ()
1912 "Ask before killing a buffer that has a running process."
1913 (let ((process (get-buffer-process (current-buffer))))
1915 (not (memq (process-status process) '(run stop open listen)))
1916 (not (process-query-on-exit-flag process))
1918 (format "Buffer %S has a running process; kill it? "
1919 (buffer-name (current-buffer)))))))
1921 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1923 ;; process plist management
1925 (defun process-get (process propname)
1926 "Return the value of PROCESS' PROPNAME property.
1927 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1928 (plist-get (process-plist process) propname))
1930 (defun process-put (process propname value)
1931 "Change PROCESS' PROPNAME property to VALUE.
1932 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1933 (set-process-plist process
1934 (plist-put (process-plist process) propname value)))
1937 ;;;; Input and display facilities.
1939 (defvar read-quoted-char-radix 8
1940 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1941 Legitimate radix values are 8, 10 and 16.")
1943 (custom-declare-variable-early
1944 'read-quoted-char-radix 8
1945 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1946 Legitimate radix values are 8, 10 and 16."
1947 :type '(choice (const 8) (const 10) (const 16))
1948 :group 'editing-basics)
1950 (defconst read-key-empty-map (make-sparse-keymap))
1952 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
1954 (defun read-key (&optional prompt)
1955 "Read a key from the keyboard.
1956 Contrary to `read-event' this will not return a raw event but instead will
1957 obey the input decoding and translations usually done by `read-key-sequence'.
1958 So escape sequences and keyboard encoding are taken into account.
1959 When there's an ambiguity because the key looks like the prefix of
1960 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1961 (let ((overriding-terminal-local-map read-key-empty-map)
1962 (overriding-local-map nil)
1964 (old-global-map (current-global-map))
1965 (timer (run-with-idle-timer
1966 ;; Wait long enough that Emacs has the time to receive and
1967 ;; process all the raw events associated with the single-key.
1968 ;; But don't wait too long, or the user may find the delay
1969 ;; annoying (or keep hitting more keys which may then get
1970 ;; lost or misinterpreted).
1971 ;; This is only relevant for keys which Emacs perceives as
1972 ;; "prefixes", such as C-x (because of the C-x 8 map in
1973 ;; key-translate-table and the C-x @ map in function-key-map)
1974 ;; or ESC (because of terminal escape sequences in
1975 ;; input-decode-map).
1978 (let ((keys (this-command-keys-vector)))
1979 (unless (zerop (length keys))
1980 ;; `keys' is non-empty, so the user has hit at least
1981 ;; one key; there's no point waiting any longer, even
1982 ;; though read-key-sequence thinks we should wait
1983 ;; for more input to decide how to interpret the
1985 (throw 'read-key keys)))))))
1989 (let ((map (make-sparse-keymap)))
1990 ;; Don't hide the menu-bar and tool-bar entries.
1991 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
1992 (define-key map [tool-bar] (lookup-key global-map [tool-bar]))
1994 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
1995 (cancel-timer timer)
1996 (use-global-map old-global-map))))
1998 (defun read-quoted-char (&optional prompt)
1999 "Like `read-char', but do not allow quitting.
2000 Also, if the first character read is an octal digit,
2001 we read any number of octal digits and return the
2002 specified character code. Any nondigit terminates the sequence.
2003 If the terminator is RET, it is discarded;
2004 any other terminator is used itself as input.
2006 The optional argument PROMPT specifies a string to use to prompt the user.
2007 The variable `read-quoted-char-radix' controls which radix to use
2009 (let ((message-log-max nil) done (first t) (code 0) char translated)
2011 (let ((inhibit-quit first)
2012 ;; Don't let C-h get the help message--only help function keys.
2015 "Type the special character you want to use,
2016 or the octal character code.
2017 RET terminates the character code and is discarded;
2018 any other non-digit terminates the character code and is then used as input."))
2019 (setq char (read-event (and prompt (format "%s-" prompt)) t))
2020 (if inhibit-quit (setq quit-flag nil)))
2021 ;; Translate TAB key into control-I ASCII character, and so on.
2022 ;; Note: `read-char' does it using the `ascii-character' property.
2023 ;; We should try and use read-key instead.
2024 (let ((translation (lookup-key local-function-key-map (vector char))))
2025 (setq translated (if (arrayp translation)
2026 (aref translation 0)
2028 (if (integerp translated)
2029 (setq translated (char-resolve-modifiers translated)))
2030 (cond ((null translated))
2031 ((not (integerp translated))
2032 (setq unread-command-events (list char)
2034 ((/= (logand translated ?\M-\^@) 0)
2035 ;; Turn a meta-character into a character with the 0200 bit set.
2036 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
2038 ((and (<= ?0 translated)
2039 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
2040 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
2041 (and prompt (setq prompt (message "%s %c" prompt translated))))
2042 ((and (<= ?a (downcase translated))
2043 (< (downcase translated)
2044 (+ ?a -10 (min 36 read-quoted-char-radix))))
2045 (setq code (+ (* code read-quoted-char-radix)
2046 (+ 10 (- (downcase translated) ?a))))
2047 (and prompt (setq prompt (message "%s %c" prompt translated))))
2048 ((and (not first) (eq translated ?\C-m))
2051 (setq unread-command-events (list char)
2053 (t (setq code translated
2058 (defun read-passwd (prompt &optional confirm default)
2059 "Read a password, prompting with PROMPT, and return it.
2060 If optional CONFIRM is non-nil, read the password twice to make sure.
2061 Optional DEFAULT is a default password to use instead of empty input.
2063 This function echoes `.' for each character that the user types.
2065 The user ends with RET, LFD, or ESC. DEL or C-h rubs out.
2066 C-y yanks the current kill. C-u kills line.
2067 C-g quits; if `inhibit-quit' was non-nil around this function,
2068 then it returns nil if the user types C-g, but `quit-flag' remains set.
2070 Once the caller uses the password, it can erase the password
2071 by doing (clear-string STRING)."
2075 (while (not success)
2076 (let ((first (read-passwd prompt nil default))
2077 (second (read-passwd "Confirm password: " nil default)))
2078 (if (equal first second)
2080 (and (arrayp second) (clear-string second))
2081 (setq success first))
2082 (and (arrayp first) (clear-string first))
2083 (and (arrayp second) (clear-string second))
2084 (message "Password not repeated accurately; please start over")
2088 ;; Copy it so that add-text-properties won't modify
2089 ;; the object that was passed in by the caller.
2090 (prompt (copy-sequence prompt))
2093 (cursor-in-echo-area t)
2094 (message-log-max nil)
2095 (stop-keys (list 'return ?\r ?\n ?\e))
2096 (rubout-keys (list 'backspace ?\b ?\177)))
2097 (add-text-properties 0 (length prompt)
2098 minibuffer-prompt-properties prompt)
2099 (while (progn (message "%s%s"
2101 (make-string (length pass) ?.))
2103 (not (memq c stop-keys)))
2104 (clear-this-command-keys)
2105 (cond ((memq c rubout-keys) ; rubout
2106 (when (> (length pass) 0)
2107 (let ((new-pass (substring pass 0 -1)))
2108 (and (arrayp pass) (clear-string pass))
2109 (setq pass new-pass))))
2110 ((eq c ?\C-g) (keyboard-quit))
2112 ((= c ?\C-u) ; kill line
2113 (and (arrayp pass) (clear-string pass))
2116 (let* ((str (condition-case nil
2123 (substring-no-properties str)))
2124 (and (arrayp pass) (clear-string pass))
2126 (setq pass new-pass))))
2127 ((characterp c) ; insert char
2128 (let* ((new-char (char-to-string c))
2129 (new-pass (concat pass new-char)))
2130 (and (arrayp pass) (clear-string pass))
2131 (clear-string new-char)
2133 (setq pass new-pass)))))
2135 (or pass default "")))))
2137 ;; This should be used by `call-interactively' for `n' specs.
2138 (defun read-number (prompt &optional default)
2139 "Read a numeric value in the minibuffer, prompting with PROMPT.
2140 DEFAULT specifies a default value to return if the user just types RET.
2141 The value of DEFAULT is inserted into PROMPT."
2145 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2146 (replace-match (format " (default %s)" default) t t prompt 1)
2147 (replace-regexp-in-string "[ \t]*\\'"
2148 (format " (default %s) " default)
2152 (let ((str (read-from-minibuffer prompt nil nil nil nil
2154 (number-to-string default)))))
2157 ((zerop (length str)) default)
2158 ((stringp str) (read str))))
2161 (message "Please enter a number.")
2166 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2167 "Read and return one of CHARS, prompting for PROMPT.
2168 Any input that is not one of CHARS is ignored.
2170 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2171 keyboard-quit events while waiting for a valid input."
2172 (unless (consp chars)
2173 (error "Called `read-char-choice' without valid char choices"))
2174 (let (char done show-help (helpbuf " *Char Help*"))
2175 (let ((cursor-in-echo-area t)
2176 (executing-kbd-macro executing-kbd-macro))
2177 (save-window-excursion ; in case we call help-form-show
2179 (unless (get-text-property 0 'face prompt)
2180 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2181 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2183 (and show-help (buffer-live-p (get-buffer helpbuf))
2184 (kill-buffer helpbuf))
2186 ((not (numberp char)))
2187 ;; If caller has set help-form, that's enough.
2188 ;; They don't explicitly have to add help-char to chars.
2195 ((and executing-kbd-macro (= char -1))
2196 ;; read-event returns -1 if we are in a kbd macro and
2197 ;; there are no more events in the macro. Attempt to
2198 ;; get an event interactively.
2199 (setq executing-kbd-macro nil))
2200 ((and (not inhibit-keyboard-quit) (eq char ?\C-g))
2201 (keyboard-quit))))))
2202 ;; Display the question with the answer. But without cursor-in-echo-area.
2203 (message "%s%s" prompt (char-to-string char))
2206 (defun sit-for (seconds &optional nodisp obsolete)
2207 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2208 SECONDS may be a floating-point value.
2209 \(On operating systems that do not support waiting for fractions of a
2210 second, floating-point values are rounded down to the nearest integer.)
2212 If optional arg NODISP is t, don't redisplay, just wait for input.
2213 Redisplay does not happen if input is available before it starts.
2215 Value is t if waited the full time with no input arriving, and nil otherwise.
2217 An obsolete, but still supported form is
2218 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2219 where the optional arg MILLISECONDS specifies an additional wait period,
2220 in milliseconds; this was useful when Emacs was built without
2221 floating point support."
2222 (if (numberp nodisp)
2223 (setq seconds (+ seconds (* 1e-3 nodisp))
2225 (if obsolete (setq nodisp obsolete)))
2233 (or nodisp (redisplay)))
2235 (or nodisp (redisplay))
2236 (let ((read (read-event nil nil seconds)))
2239 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2240 ;; unread-command-events as (t . EVENT) so it will be added to
2241 ;; this-command-keys by read-key-sequence.
2242 (if (eq overriding-terminal-local-map universal-argument-map)
2243 (setq read (cons t read)))
2244 (push read unread-command-events)
2246 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2248 (defun y-or-n-p (prompt)
2249 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2250 PROMPT is the string to display to ask the question. It should
2251 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2253 No confirmation of the answer is requested; a single character is enough.
2254 Also accepts Space to mean yes, or Delete to mean no. \(Actually, it uses
2255 the bindings in `query-replace-map'; see the documentation of that variable
2256 for more information. In this case, the useful bindings are `act', `skip',
2257 `recenter', and `quit'.\)
2259 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2260 is nil and `use-dialog-box' is non-nil."
2261 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2262 ;; where all the keys were unbound (i.e. it somehow got triggered
2263 ;; within read-key, apparently). I had to kill it.
2264 (let ((answer 'recenter))
2265 (if (and (display-popup-menus-p)
2266 (listp last-nonmenu-event)
2269 (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip))))
2270 (setq prompt (concat prompt
2271 (if (eq ?\s (aref prompt (1- (length prompt))))
2276 (let ((cursor-in-echo-area t))
2277 (when minibuffer-auto-raise
2278 (raise-frame (window-frame (minibuffer-window))))
2279 (read-key (propertize (if (eq answer 'recenter)
2281 (concat "Please answer y or n. "
2283 'face 'minibuffer-prompt)))))
2284 (setq answer (lookup-key query-replace-map (vector key) t))
2286 ((memq answer '(skip act)) nil)
2287 ((eq answer 'recenter) (recenter) t)
2288 ((memq answer '(exit-prefix quit)) (signal 'quit nil) t)
2292 (let ((ret (eq answer 'act)))
2293 (unless noninteractive
2294 (message "%s %s" prompt (if ret "y" "n")))
2298 ;;; Atomic change groups.
2300 (defmacro atomic-change-group (&rest body)
2301 "Perform BODY as an atomic change group.
2302 This means that if BODY exits abnormally,
2303 all of its changes to the current buffer are undone.
2304 This works regardless of whether undo is enabled in the buffer.
2306 This mechanism is transparent to ordinary use of undo;
2307 if undo is enabled in the buffer and BODY succeeds, the
2308 user can undo the change normally."
2309 (declare (indent 0) (debug t))
2310 (let ((handle (make-symbol "--change-group-handle--"))
2311 (success (make-symbol "--change-group-success--")))
2312 `(let ((,handle (prepare-change-group))
2313 ;; Don't truncate any undo data in the middle of this.
2314 (undo-outer-limit nil)
2315 (undo-limit most-positive-fixnum)
2316 (undo-strong-limit most-positive-fixnum)
2320 ;; This is inside the unwind-protect because
2321 ;; it enables undo if that was disabled; we need
2322 ;; to make sure that it gets disabled again.
2323 (activate-change-group ,handle)
2326 ;; Either of these functions will disable undo
2327 ;; if it was disabled before.
2329 (accept-change-group ,handle)
2330 (cancel-change-group ,handle))))))
2332 (defun prepare-change-group (&optional buffer)
2333 "Return a handle for the current buffer's state, for a change group.
2334 If you specify BUFFER, make a handle for BUFFER's state instead.
2336 Pass the handle to `activate-change-group' afterward to initiate
2337 the actual changes of the change group.
2339 To finish the change group, call either `accept-change-group' or
2340 `cancel-change-group' passing the same handle as argument. Call
2341 `accept-change-group' to accept the changes in the group as final;
2342 call `cancel-change-group' to undo them all. You should use
2343 `unwind-protect' to make sure the group is always finished. The call
2344 to `activate-change-group' should be inside the `unwind-protect'.
2345 Once you finish the group, don't use the handle again--don't try to
2346 finish the same group twice. For a simple example of correct use, see
2347 the source code of `atomic-change-group'.
2349 The handle records only the specified buffer. To make a multibuffer
2350 change group, call this function once for each buffer you want to
2351 cover, then use `nconc' to combine the returned values, like this:
2353 (nconc (prepare-change-group buffer-1)
2354 (prepare-change-group buffer-2))
2356 You can then activate that multibuffer change group with a single
2357 call to `activate-change-group' and finish it with a single call
2358 to `accept-change-group' or `cancel-change-group'."
2361 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2362 (list (cons (current-buffer) buffer-undo-list))))
2364 (defun activate-change-group (handle)
2365 "Activate a change group made with `prepare-change-group' (which see)."
2366 (dolist (elt handle)
2367 (with-current-buffer (car elt)
2368 (if (eq buffer-undo-list t)
2369 (setq buffer-undo-list nil)))))
2371 (defun accept-change-group (handle)
2372 "Finish a change group made with `prepare-change-group' (which see).
2373 This finishes the change group by accepting its changes as final."
2374 (dolist (elt handle)
2375 (with-current-buffer (car elt)
2377 (setq buffer-undo-list t)))))
2379 (defun cancel-change-group (handle)
2380 "Finish a change group made with `prepare-change-group' (which see).
2381 This finishes the change group by reverting all of its changes."
2382 (dolist (elt handle)
2383 (with-current-buffer (car elt)
2384 (setq elt (cdr elt))
2386 ;; Widen buffer temporarily so if the buffer was narrowed within
2387 ;; the body of `atomic-change-group' all changes can be undone.
2390 (if (consp elt) (car elt)))
2392 (if (consp elt) (cdr elt))))
2393 ;; Temporarily truncate the undo log at ELT.
2395 (setcar elt nil) (setcdr elt nil))
2396 (unless (eq last-command 'undo) (undo-start))
2397 ;; Make sure there's no confusion.
2398 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2399 (error "Undoing to some unrelated state"))
2402 (while (listp pending-undo-list) (undo-more 1)))
2403 ;; Reset the modified cons cell ELT to its original content.
2405 (setcar elt old-car)
2406 (setcdr elt old-cdr))
2407 ;; Revert the undo info to what it was when we grabbed the state.
2408 (setq buffer-undo-list elt))))))
2410 ;;;; Display-related functions.
2412 ;; For compatibility.
2413 (defalias 'redraw-modeline 'force-mode-line-update)
2415 (defun force-mode-line-update (&optional all)
2416 "Force redisplay of the current buffer's mode line and header line.
2417 With optional non-nil ALL, force redisplay of all mode lines and
2418 header lines. This function also forces recomputation of the
2419 menu bar menus and the frame title."
2420 (if all (with-current-buffer (other-buffer)))
2421 (set-buffer-modified-p (buffer-modified-p)))
2423 (defun momentary-string-display (string pos &optional exit-char message)
2424 "Momentarily display STRING in the buffer at POS.
2425 Display remains until next event is input.
2426 If POS is a marker, only its position is used; its buffer is ignored.
2427 Optional third arg EXIT-CHAR can be a character, event or event
2428 description list. EXIT-CHAR defaults to SPC. If the input is
2429 EXIT-CHAR it is swallowed; otherwise it is then available as
2430 input (as a command if nothing else).
2431 Display MESSAGE (optional fourth arg) in the echo area.
2432 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2433 (or exit-char (setq exit-char ?\s))
2434 (let ((ol (make-overlay pos pos))
2435 (str (copy-sequence string)))
2439 (overlay-put ol 'after-string str)
2441 ;; To avoid trouble with out-of-bounds position
2443 ;; If the string end is off screen, recenter now.
2444 (if (<= (window-end nil t) pos)
2445 (recenter (/ (window-height) 2))))
2446 (message (or message "Type %s to continue editing.")
2447 (single-key-description exit-char))
2448 (let ((event (read-event)))
2449 ;; `exit-char' can be an event, or an event description list.
2450 (or (eq event exit-char)
2451 (eq event (event-convert-list exit-char))
2452 (setq unread-command-events (list event)))))
2453 (delete-overlay ol))))
2456 ;;;; Overlay operations
2458 (defun copy-overlay (o)
2459 "Return a copy of overlay O."
2460 (let ((o1 (if (overlay-buffer o)
2461 (make-overlay (overlay-start o) (overlay-end o)
2462 ;; FIXME: there's no easy way to find the
2463 ;; insertion-type of the two markers.
2465 (let ((o1 (make-overlay (point-min) (point-min))))
2468 (props (overlay-properties o)))
2470 (overlay-put o1 (pop props) (pop props)))
2473 (defun remove-overlays (&optional beg end name val)
2474 "Clear BEG and END of overlays whose property NAME has value VAL.
2475 Overlays might be moved and/or split.
2476 BEG and END default respectively to the beginning and end of buffer."
2477 ;; This speeds up the loops over overlays.
2478 (unless beg (setq beg (point-min)))
2479 (unless end (setq end (point-max)))
2480 (overlay-recenter end)
2482 (setq beg (prog1 end (setq end beg))))
2484 (dolist (o (overlays-in beg end))
2485 (when (eq (overlay-get o name) val)
2486 ;; Either push this overlay outside beg...end
2487 ;; or split it to exclude beg...end
2488 ;; or delete it entirely (if it is contained in beg...end).
2489 (if (< (overlay-start o) beg)
2490 (if (> (overlay-end o) end)
2492 (move-overlay (copy-overlay o)
2493 (overlay-start o) beg)
2494 (move-overlay o end (overlay-end o)))
2495 (move-overlay o (overlay-start o) beg))
2496 (if (> (overlay-end o) end)
2497 (move-overlay o end (overlay-end o))
2498 (delete-overlay o)))))))
2502 (defvar suspend-hook nil
2503 "Normal hook run by `suspend-emacs', before suspending.")
2505 (defvar suspend-resume-hook nil
2506 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2508 (defvar temp-buffer-show-hook nil
2509 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2510 When the hook runs, the temporary buffer is current, and the window it
2511 was displayed in is selected.")
2513 (defvar temp-buffer-setup-hook nil
2514 "Normal hook run by `with-output-to-temp-buffer' at the start.
2515 When the hook runs, the temporary buffer is current.
2516 This hook is normally set up with a function to put the buffer in Help
2519 ;; Avoid compiler warnings about this variable,
2520 ;; which has a special meaning on certain system types.
2521 (defvar buffer-file-type nil
2522 "Non-nil if the visited file is a binary file.
2523 This variable is meaningful on MS-DOG and Windows NT.
2524 On those systems, it is automatically local in every buffer.
2525 On other systems, this variable is normally always nil.")
2527 ;; The `assert' macro from the cl package signals
2528 ;; `cl-assertion-failed' at runtime so always define it.
2529 (put 'cl-assertion-failed 'error-conditions '(error))
2530 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2532 (defconst user-emacs-directory
2533 (if (eq system-type 'ms-dos)
2534 ;; MS-DOS cannot have initial dot.
2537 "Directory beneath which additional per-user Emacs-specific files are placed.
2538 Various programs in Emacs store information in this directory.
2539 Note that this should end with a directory separator.
2540 See also `locate-user-emacs-file'.")
2542 (defun locate-user-emacs-file (new-name &optional old-name)
2543 "Return an absolute per-user Emacs-specific file name.
2544 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2545 Else return NEW-NAME in `user-emacs-directory', creating the
2546 directory if it does not exist."
2547 (convert-standard-filename
2548 (let* ((home (concat "~" (or init-file-user "")))
2549 (at-home (and old-name (expand-file-name old-name home))))
2550 (if (and at-home (file-readable-p at-home))
2552 ;; Make sure `user-emacs-directory' exists,
2553 ;; unless we're in batch mode or dumping Emacs
2556 (file-accessible-directory-p
2557 (directory-file-name user-emacs-directory))
2558 (let ((umask (default-file-modes)))
2561 (set-default-file-modes ?\700)
2562 (make-directory user-emacs-directory))
2563 (set-default-file-modes umask))))
2564 (abbreviate-file-name
2565 (expand-file-name new-name user-emacs-directory))))))
2567 ;;;; Misc. useful functions.
2569 (defun find-tag-default ()
2570 "Determine default tag to search for, based on text at point.
2571 If there is no plausible default, return nil."
2572 (let (from to bound)
2574 ;; Look at text around `point'.
2576 (skip-syntax-backward "w_") (setq from (point)))
2578 (skip-syntax-forward "w_") (setq to (point)))
2580 ;; Look between `line-beginning-position' and `point'.
2582 (and (setq bound (line-beginning-position))
2583 (skip-syntax-backward "^w_" bound)
2584 (> (setq to (point)) bound)
2585 (skip-syntax-backward "w_")
2586 (setq from (point))))
2587 ;; Look between `point' and `line-end-position'.
2589 (and (setq bound (line-end-position))
2590 (skip-syntax-forward "^w_" bound)
2591 (< (setq from (point)) bound)
2592 (skip-syntax-forward "w_")
2593 (setq to (point)))))
2594 (buffer-substring-no-properties from to))))
2596 (defun play-sound (sound)
2597 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2598 The following keywords are recognized:
2600 :file FILE - read sound data from FILE. If FILE isn't an
2601 absolute file name, it is searched in `data-directory'.
2603 :data DATA - read sound data from string DATA.
2605 Exactly one of :file or :data must be present.
2607 :volume VOL - set volume to VOL. VOL must an integer in the
2608 range 0..100 or a float in the range 0..1.0. If not specified,
2609 don't change the volume setting of the sound device.
2611 :device DEVICE - play sound on DEVICE. If not specified,
2612 a system-dependent default device name is used.
2614 Note: :data and :device are currently not supported on Windows."
2615 (if (fboundp 'play-sound-internal)
2616 (play-sound-internal sound)
2617 (error "This Emacs binary lacks sound support")))
2619 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2621 (defun shell-quote-argument (argument)
2622 "Quote ARGUMENT for passing as argument to an inferior shell."
2624 ((eq system-type 'ms-dos)
2625 ;; Quote using double quotes, but escape any existing quotes in
2626 ;; the argument with backslashes.
2630 (if (or (null (string-match "[^\"]" argument))
2631 (< (match-end 0) (length argument)))
2632 (while (string-match "[\"]" argument start)
2633 (setq end (match-beginning 0)
2634 result (concat result (substring argument start end)
2635 "\\" (substring argument end (1+ end)))
2637 (concat "\"" result (substring argument start) "\"")))
2639 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2641 ;; First, quote argument so that CommandLineToArgvW will
2642 ;; understand it. See
2643 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2644 ;; After we perform that level of quoting, escape shell
2645 ;; metacharacters so that cmd won't mangle our argument. If the
2646 ;; argument contains no double quote characters, we can just
2647 ;; surround it with double quotes. Otherwise, we need to prefix
2648 ;; each shell metacharacter with a caret.
2651 ;; escape backslashes at end of string
2652 (replace-regexp-in-string
2655 ;; escape backslashes and quotes in string body
2656 (replace-regexp-in-string
2661 (if (string-match "[%!\"]" argument)
2664 (replace-regexp-in-string
2665 "\\([%!()\"<>&|^]\\)"
2669 (concat "\"" argument "\"")))
2672 (if (equal argument "")
2674 ;; Quote everything except POSIX filename characters.
2675 ;; This should be safe enough even for really weird shells.
2676 (replace-regexp-in-string
2678 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2681 (defun string-or-null-p (object)
2682 "Return t if OBJECT is a string or nil.
2683 Otherwise, return nil."
2684 (or (stringp object) (null object)))
2686 (defun booleanp (object)
2687 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2688 Otherwise, return nil."
2689 (and (memq object '(nil t)) t))
2691 (defun field-at-pos (pos)
2692 "Return the field at position POS, taking stickiness etc into account."
2693 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2694 (if (eq raw-field 'boundary)
2695 (get-char-property (1- (field-end pos)) 'field)
2698 (defun sha1 (object &optional start end binary)
2699 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2700 OBJECT is either a string or a buffer. Optional arguments START and
2701 END are character positions specifying which portion of OBJECT for
2702 computing the hash. If BINARY is non-nil, return a string in binary
2704 (secure-hash 'sha1 object start end binary))
2707 ;;;; Support for yanking and text properties.
2709 (defvar yank-excluded-properties)
2711 (defun remove-yank-excluded-properties (start end)
2712 "Remove `yank-excluded-properties' between START and END positions.
2713 Replaces `category' properties with their defined properties."
2714 (let ((inhibit-read-only t))
2715 ;; Replace any `category' property with the properties it stands
2716 ;; for. This is to remove `mouse-face' properties that are placed
2717 ;; on categories in *Help* buffers' buttons. See
2718 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2720 (unless (memq yank-excluded-properties '(t nil))
2723 (while (< (point) end)
2724 (let ((cat (get-text-property (point) 'category))
2727 (next-single-property-change (point) 'category nil end))
2729 (let (run-end2 original)
2730 (remove-list-of-text-properties (point) run-end '(category))
2731 (while (< (point) run-end)
2732 (setq run-end2 (next-property-change (point) nil run-end))
2733 (setq original (text-properties-at (point)))
2734 (set-text-properties (point) run-end2 (symbol-plist cat))
2735 (add-text-properties (point) run-end2 original)
2736 (goto-char run-end2))))
2737 (goto-char run-end)))))
2738 (if (eq yank-excluded-properties t)
2739 (set-text-properties start end nil)
2740 (remove-list-of-text-properties start end yank-excluded-properties))))
2742 (defvar yank-undo-function)
2744 (defun insert-for-yank (string)
2745 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2747 See `insert-for-yank-1' for more details."
2749 (while (setq to (next-single-property-change 0 'yank-handler string))
2750 (insert-for-yank-1 (substring string 0 to))
2751 (setq string (substring string to))))
2752 (insert-for-yank-1 string))
2754 (defun insert-for-yank-1 (string)
2755 "Insert STRING at point, stripping some text properties.
2757 Strip text properties from the inserted text according to
2758 `yank-excluded-properties'. Otherwise just like (insert STRING).
2760 If STRING has a non-nil `yank-handler' property on the first character,
2761 the normal insert behavior is modified in various ways. The value of
2762 the yank-handler property must be a list with one to four elements
2763 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2764 When FUNCTION is present and non-nil, it is called instead of `insert'
2765 to insert the string. FUNCTION takes one argument--the object to insert.
2766 If PARAM is present and non-nil, it replaces STRING as the object
2767 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2768 `yank-rectangle', PARAM may be a list of strings to insert as a
2770 If NOEXCLUDE is present and non-nil, the normal removal of the
2771 `yank-excluded-properties' is not performed; instead FUNCTION is
2772 responsible for removing those properties. This may be necessary
2773 if FUNCTION adjusts point before or after inserting the object.
2774 If UNDO is present and non-nil, it is a function that will be called
2775 by `yank-pop' to undo the insertion of the current object. It is
2776 called with two arguments, the start and end of the current region.
2777 FUNCTION may set `yank-undo-function' to override the UNDO value."
2778 (let* ((handler (and (stringp string)
2779 (get-text-property 0 'yank-handler string)))
2780 (param (or (nth 1 handler) string))
2782 (inhibit-read-only inhibit-read-only)
2785 (setq yank-undo-function t)
2786 (if (nth 0 handler) ;; FUNCTION
2787 (funcall (car handler) param)
2791 ;; Prevent read-only properties from interfering with the
2792 ;; following text property changes.
2793 (setq inhibit-read-only t)
2795 ;; What should we do with `font-lock-face' properties?
2796 (if font-lock-defaults
2797 ;; No, just wipe them.
2798 (remove-list-of-text-properties opoint end '(font-lock-face))
2799 ;; Convert them to `face'.
2802 (while (< (point) end)
2803 (let ((face (get-text-property (point) 'font-lock-face))
2806 (next-single-property-change (point) 'font-lock-face nil end))
2808 (remove-text-properties (point) run-end '(font-lock-face nil))
2809 (put-text-property (point) run-end 'face face))
2810 (goto-char run-end)))))
2812 (unless (nth 2 handler) ;; NOEXCLUDE
2813 (remove-yank-excluded-properties opoint (point)))
2815 ;; If last inserted char has properties, mark them as rear-nonsticky.
2816 (if (and (> end opoint)
2817 (text-properties-at (1- end)))
2818 (put-text-property (1- end) end 'rear-nonsticky t))
2820 (if (eq yank-undo-function t) ;; not set by FUNCTION
2821 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2822 (if (nth 4 handler) ;; COMMAND
2823 (setq this-command (nth 4 handler)))))
2825 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2826 "Insert before point a substring of BUFFER, without text properties.
2827 BUFFER may be a buffer or a buffer name.
2828 Arguments START and END are character positions specifying the substring.
2829 They default to the values of (point-min) and (point-max) in BUFFER."
2830 (let ((opoint (point)))
2831 (insert-buffer-substring buffer start end)
2832 (let ((inhibit-read-only t))
2833 (set-text-properties opoint (point) nil))))
2835 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2836 "Insert before point a part of BUFFER, stripping some text properties.
2837 BUFFER may be a buffer or a buffer name.
2838 Arguments START and END are character positions specifying the substring.
2839 They default to the values of (point-min) and (point-max) in BUFFER.
2840 Strip text properties from the inserted text according to
2841 `yank-excluded-properties'."
2842 ;; Since the buffer text should not normally have yank-handler properties,
2843 ;; there is no need to handle them here.
2844 (let ((opoint (point)))
2845 (insert-buffer-substring buffer start end)
2846 (remove-yank-excluded-properties opoint (point))))
2849 ;;;; Synchronous shell commands.
2851 (defun start-process-shell-command (name buffer &rest args)
2852 "Start a program in a subprocess. Return the process object for it.
2853 NAME is name for process. It is modified if necessary to make it unique.
2854 BUFFER is the buffer (or buffer name) to associate with the process.
2855 Process output goes at end of that buffer, unless you specify
2856 an output stream or filter function to handle the output.
2857 BUFFER may be also nil, meaning that this process is not associated
2859 COMMAND is the shell command to run.
2861 An old calling convention accepted any number of arguments after COMMAND,
2862 which were just concatenated to COMMAND. This is still supported but strongly
2864 ;; We used to use `exec' to replace the shell with the command,
2865 ;; but that failed to handle (...) and semicolon, etc.
2866 (start-process name buffer shell-file-name shell-command-switch
2867 (mapconcat 'identity args " ")))
2868 (set-advertised-calling-convention 'start-process-shell-command
2869 '(name buffer command) "23.1")
2871 (defun start-file-process-shell-command (name buffer &rest args)
2872 "Start a program in a subprocess. Return the process object for it.
2873 Similar to `start-process-shell-command', but calls `start-file-process'."
2876 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2877 (if (file-remote-p default-directory) "-c" shell-command-switch)
2878 (mapconcat 'identity args " ")))
2879 (set-advertised-calling-convention 'start-file-process-shell-command
2880 '(name buffer command) "23.1")
2882 (defun call-process-shell-command (command &optional infile buffer display
2884 "Execute the shell command COMMAND synchronously in separate process.
2885 The remaining arguments are optional.
2886 The program's input comes from file INFILE (nil means `/dev/null').
2887 Insert output in BUFFER before point; t means current buffer;
2888 nil for BUFFER means discard it; 0 means discard and don't wait.
2889 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2890 REAL-BUFFER says what to do with standard output, as above,
2891 while STDERR-FILE says what to do with standard error in the child.
2892 STDERR-FILE may be nil (discard standard error output),
2893 t (mix it with ordinary output), or a file name string.
2895 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2896 Remaining arguments are strings passed as additional arguments for COMMAND.
2897 Wildcards and redirection are handled as usual in the shell.
2899 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2900 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2901 status or a signal description string.
2902 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2903 ;; We used to use `exec' to replace the shell with the command,
2904 ;; but that failed to handle (...) and semicolon, etc.
2905 (call-process shell-file-name
2906 infile buffer display
2907 shell-command-switch
2908 (mapconcat 'identity (cons command args) " ")))
2910 (defun process-file-shell-command (command &optional infile buffer display
2912 "Process files synchronously in a separate process.
2913 Similar to `call-process-shell-command', but calls `process-file'."
2915 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2916 infile buffer display
2917 (if (file-remote-p default-directory) "-c" shell-command-switch)
2918 (mapconcat 'identity (cons command args) " ")))
2920 ;;;; Lisp macros to do various things temporarily.
2922 (defmacro with-current-buffer (buffer-or-name &rest body)
2923 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2924 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2925 The value returned is the value of the last form in BODY. See
2926 also `with-temp-buffer'."
2927 (declare (indent 1) (debug t))
2928 `(save-current-buffer
2929 (set-buffer ,buffer-or-name)
2932 (defmacro with-selected-window (window &rest body)
2933 "Execute the forms in BODY with WINDOW as the selected window.
2934 The value returned is the value of the last form in BODY.
2936 This macro saves and restores the selected window, as well as the
2937 selected window of each frame. It does not change the order of
2938 recently selected windows. If the previously selected window of
2939 some frame is no longer live at the end of BODY, that frame's
2940 selected window is left alone. If the selected window is no
2941 longer live, then whatever window is selected at the end of BODY
2944 This macro uses `save-current-buffer' to save and restore the
2945 current buffer, since otherwise its normal operation could
2946 potentially make a different buffer current. It does not alter
2947 the buffer list ordering."
2948 (declare (indent 1) (debug t))
2949 ;; Most of this code is a copy of save-selected-window.
2950 `(let ((save-selected-window-window (selected-window))
2951 ;; It is necessary to save all of these, because calling
2952 ;; select-window changes frame-selected-window for whatever
2953 ;; frame that window is in.
2954 (save-selected-window-alist
2955 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2957 (save-current-buffer
2959 (progn (select-window ,window 'norecord)
2961 (dolist (elt save-selected-window-alist)
2962 (and (frame-live-p (car elt))
2963 (window-live-p (cadr elt))
2964 (set-frame-selected-window (car elt) (cadr elt) 'norecord)))
2965 (when (window-live-p save-selected-window-window)
2966 (select-window save-selected-window-window 'norecord))))))
2968 (defmacro with-selected-frame (frame &rest body)
2969 "Execute the forms in BODY with FRAME as the selected frame.
2970 The value returned is the value of the last form in BODY.
2972 This macro neither changes the order of recently selected windows
2973 nor the buffer list."
2974 (declare (indent 1) (debug t))
2975 (let ((old-frame (make-symbol "old-frame"))
2976 (old-buffer (make-symbol "old-buffer")))
2977 `(let ((,old-frame (selected-frame))
2978 (,old-buffer (current-buffer)))
2980 (progn (select-frame ,frame 'norecord)
2982 (when (frame-live-p ,old-frame)
2983 (select-frame ,old-frame 'norecord))
2984 (when (buffer-live-p ,old-buffer)
2985 (set-buffer ,old-buffer))))))
2987 (defmacro save-window-excursion (&rest body)
2988 "Execute BODY, preserving window sizes and contents.
2989 Return the value of the last form in BODY.
2990 Restore which buffer appears in which window, where display starts,
2991 and the value of point and mark for each window.
2992 Also restore the choice of selected window.
2993 Also restore which buffer is current.
2994 Does not restore the value of point in current buffer.
2996 BEWARE: Most uses of this macro introduce bugs.
2997 E.g. it should not be used to try and prevent some code from opening
2998 a new window, since that window may sometimes appear in another frame,
2999 in which case `save-window-excursion' cannot help."
3000 (declare (indent 0) (debug t))
3001 (let ((c (make-symbol "wconfig")))
3002 `(let ((,c (current-window-configuration)))
3003 (unwind-protect (progn ,@body)
3004 (set-window-configuration ,c)))))
3006 (defmacro with-output-to-temp-buffer (bufname &rest body)
3007 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3009 This construct makes buffer BUFNAME empty before running BODY.
3010 It does not make the buffer current for BODY.
3011 Instead it binds `standard-output' to that buffer, so that output
3012 generated with `prin1' and similar functions in BODY goes into
3015 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3016 it in a window, but does not select it. The normal way to do this is
3017 by calling `display-buffer', then running `temp-buffer-show-hook'.
3018 However, if `temp-buffer-show-function' is non-nil, it calls that
3019 function instead (and does not run `temp-buffer-show-hook'). The
3020 function gets one argument, the buffer to display.
3022 The return value of `with-output-to-temp-buffer' is the value of the
3023 last form in BODY. If BODY does not finish normally, the buffer
3024 BUFNAME is not displayed.
3026 This runs the hook `temp-buffer-setup-hook' before BODY,
3027 with the buffer BUFNAME temporarily current. It runs the hook
3028 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3029 buffer temporarily current, and the window that was used to display it
3030 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3031 if it uses `temp-buffer-show-function'."
3033 (let ((old-dir (make-symbol "old-dir"))
3034 (buf (make-symbol "buf")))
3035 `(let* ((,old-dir default-directory)
3037 (with-current-buffer (get-buffer-create ,bufname)
3038 (prog1 (current-buffer)
3039 (kill-all-local-variables)
3040 ;; FIXME: delete_all_overlays
3041 (setq default-directory ,old-dir)
3042 (setq buffer-read-only nil)
3043 (setq buffer-file-name nil)
3044 (setq buffer-undo-list t)
3045 (let ((inhibit-read-only t)
3046 (inhibit-modification-hooks t))
3048 (run-hooks 'temp-buffer-setup-hook)))))
3049 (standard-output ,buf))
3050 (prog1 (progn ,@body)
3051 (internal-temp-output-buffer-show ,buf)))))
3053 (defmacro with-temp-file (file &rest body)
3054 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3055 The value returned is the value of the last form in BODY.
3056 See also `with-temp-buffer'."
3057 (declare (indent 1) (debug t))
3058 (let ((temp-file (make-symbol "temp-file"))
3059 (temp-buffer (make-symbol "temp-buffer")))
3060 `(let ((,temp-file ,file)
3062 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3065 (with-current-buffer ,temp-buffer
3067 (with-current-buffer ,temp-buffer
3068 (write-region nil nil ,temp-file nil 0)))
3069 (and (buffer-name ,temp-buffer)
3070 (kill-buffer ,temp-buffer))))))
3072 (defmacro with-temp-message (message &rest body)
3073 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3074 The original message is restored to the echo area after BODY has finished.
3075 The value returned is the value of the last form in BODY.
3076 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3077 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3078 Use a MESSAGE of \"\" to temporarily clear the echo area."
3079 (declare (debug t) (indent 1))
3080 (let ((current-message (make-symbol "current-message"))
3081 (temp-message (make-symbol "with-temp-message")))
3082 `(let ((,temp-message ,message)
3087 (setq ,current-message (current-message))
3088 (message "%s" ,temp-message))
3091 (if ,current-message
3092 (message "%s" ,current-message)
3095 (defmacro with-temp-buffer (&rest body)
3096 "Create a temporary buffer, and evaluate BODY there like `progn'.
3097 See also `with-temp-file' and `with-output-to-string'."
3098 (declare (indent 0) (debug t))
3099 (let ((temp-buffer (make-symbol "temp-buffer")))
3100 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3101 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3102 (with-current-buffer ,temp-buffer
3105 (and (buffer-name ,temp-buffer)
3106 (kill-buffer ,temp-buffer)))))))
3108 (defmacro with-silent-modifications (&rest body)
3109 "Execute BODY, pretending it does not modify the buffer.
3110 If BODY performs real modifications to the buffer's text, other
3111 than cosmetic ones, undo data may become corrupted.
3113 This macro will run BODY normally, but doesn't count its buffer
3114 modifications as being buffer modifications. This affects things
3115 like buffer-modified-p, checking whether the file is locked by
3116 someone else, running buffer modification hooks, and other things
3119 Typically used around modifications of text-properties which do
3120 not really affect the buffer's content."
3121 (declare (debug t) (indent 0))
3122 (let ((modified (make-symbol "modified")))
3123 `(let* ((,modified (buffer-modified-p))
3124 (buffer-undo-list t)
3125 (inhibit-read-only t)
3126 (inhibit-modification-hooks t)
3128 ;; Avoid setting and removing file locks and checking
3129 ;; buffer's uptodate-ness w.r.t the underlying file.
3131 buffer-file-truename)
3136 (restore-buffer-modified-p nil))))))
3138 (defmacro with-output-to-string (&rest body)
3139 "Execute BODY, return the text it sent to `standard-output', as a string."
3140 (declare (indent 0) (debug t))
3141 `(let ((standard-output
3142 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3145 (let ((standard-output standard-output))
3147 (with-current-buffer standard-output
3149 (kill-buffer standard-output))))
3151 (defmacro with-local-quit (&rest body)
3152 "Execute BODY, allowing quits to terminate BODY but not escape further.
3153 When a quit terminates BODY, `with-local-quit' returns nil but
3154 requests another quit. That quit will be processed as soon as quitting
3155 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3156 (declare (debug t) (indent 0))
3157 `(condition-case nil
3158 (let ((inhibit-quit nil))
3160 (quit (setq quit-flag t)
3161 ;; This call is to give a chance to handle quit-flag
3162 ;; in case inhibit-quit is nil.
3163 ;; Without this, it will not be handled until the next function
3164 ;; call, and that might allow it to exit thru a condition-case
3165 ;; that intends to handle the quit signal next time.
3166 (eval '(ignore nil)))))
3168 (defmacro while-no-input (&rest body)
3169 "Execute BODY only as long as there's no pending input.
3170 If input arrives, that ends the execution of BODY,
3171 and `while-no-input' returns t. Quitting makes it return nil.
3172 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3173 (declare (debug t) (indent 0))
3174 (let ((catch-sym (make-symbol "input")))
3177 (let ((throw-on-input ',catch-sym))
3178 (or (input-pending-p)
3179 (progn ,@body)))))))
3181 (defmacro condition-case-no-debug (var bodyform &rest handlers)
3182 "Like `condition-case' except that it does not catch anything when debugging.
3183 More specifically if `debug-on-error' is set, then it does not catch any signal."
3184 (declare (debug condition-case) (indent 2))
3185 (let ((bodysym (make-symbol "body")))
3186 `(let ((,bodysym (lambda () ,bodyform)))
3189 (condition-case ,var
3193 (defmacro with-demoted-errors (&rest body)
3194 "Run BODY and demote any errors to simple messages.
3195 If `debug-on-error' is non-nil, run BODY without catching its errors.
3196 This is to be used around code which is not expected to signal an error
3197 but which should be robust in the unexpected case that an error is signaled."
3198 (declare (debug t) (indent 0))
3199 (let ((err (make-symbol "err")))
3200 `(condition-case-no-debug ,err
3202 (error (message "Error: %S" ,err) nil))))
3204 (defmacro combine-after-change-calls (&rest body)
3205 "Execute BODY, but don't call the after-change functions till the end.
3206 If BODY makes changes in the buffer, they are recorded
3207 and the functions on `after-change-functions' are called several times
3208 when BODY is finished.
3209 The return value is the value of the last form in BODY.
3211 If `before-change-functions' is non-nil, then calls to the after-change
3212 functions can't be deferred, so in that case this macro has no effect.
3214 Do not alter `after-change-functions' or `before-change-functions'
3216 (declare (indent 0) (debug t))
3218 (let ((combine-after-change-calls t))
3220 (combine-after-change-execute)))
3222 (defmacro with-case-table (table &rest body)
3223 "Execute the forms in BODY with TABLE as the current case table.
3224 The value returned is the value of the last form in BODY."
3225 (declare (indent 1) (debug t))
3226 (let ((old-case-table (make-symbol "table"))
3227 (old-buffer (make-symbol "buffer")))
3228 `(let ((,old-case-table (current-case-table))
3229 (,old-buffer (current-buffer)))
3231 (progn (set-case-table ,table)
3233 (with-current-buffer ,old-buffer
3234 (set-case-table ,old-case-table))))))
3236 ;;; Matching and match data.
3238 (defvar save-match-data-internal)
3240 ;; We use save-match-data-internal as the local variable because
3241 ;; that works ok in practice (people should not use that variable elsewhere).
3242 ;; We used to use an uninterned symbol; the compiler handles that properly
3243 ;; now, but it generates slower code.
3244 (defmacro save-match-data (&rest body)
3245 "Execute the BODY forms, restoring the global value of the match data.
3246 The value returned is the value of the last form in BODY."
3247 ;; It is better not to use backquote here,
3248 ;; because that makes a bootstrapping problem
3249 ;; if you need to recompile all the Lisp files using interpreted code.
3250 (declare (indent 0) (debug t))
3252 '((save-match-data-internal (match-data)))
3253 (list 'unwind-protect
3255 ;; It is safe to free (evaporate) markers immediately here,
3256 ;; as Lisp programs should not copy from save-match-data-internal.
3257 '(set-match-data save-match-data-internal 'evaporate))))
3259 (defun match-string (num &optional string)
3260 "Return string of text matched by last search.
3261 NUM specifies which parenthesized expression in the last regexp.
3262 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3263 Zero means the entire text matched by the whole regexp or whole string.
3264 STRING should be given if the last search was by `string-match' on STRING.
3265 If STRING is nil, the current buffer should be the same buffer
3266 the search/match was performed in."
3267 (if (match-beginning num)
3269 (substring string (match-beginning num) (match-end num))
3270 (buffer-substring (match-beginning num) (match-end num)))))
3272 (defun match-string-no-properties (num &optional string)
3273 "Return string of text matched by last search, without text properties.
3274 NUM specifies which parenthesized expression in the last regexp.
3275 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3276 Zero means the entire text matched by the whole regexp or whole string.
3277 STRING should be given if the last search was by `string-match' on STRING.
3278 If STRING is nil, the current buffer should be the same buffer
3279 the search/match was performed in."
3280 (if (match-beginning num)
3282 (substring-no-properties string (match-beginning num)
3284 (buffer-substring-no-properties (match-beginning num)
3288 (defun match-substitute-replacement (replacement
3289 &optional fixedcase literal string subexp)
3290 "Return REPLACEMENT as it will be inserted by `replace-match'.
3291 In other words, all back-references in the form `\\&' and `\\N'
3292 are substituted with actual strings matched by the last search.
3293 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3294 meaning as for `replace-match'."
3295 (let ((match (match-string 0 string)))
3297 (set-match-data (mapcar (lambda (x)
3299 (- x (match-beginning 0))
3302 (replace-match replacement fixedcase literal match subexp))))
3305 (defun looking-back (regexp &optional limit greedy)
3306 "Return non-nil if text before point matches regular expression REGEXP.
3307 Like `looking-at' except matches before point, and is slower.
3308 LIMIT if non-nil speeds up the search by specifying a minimum
3309 starting position, to avoid checking matches that would start
3312 If GREEDY is non-nil, extend the match backwards as far as
3313 possible, stopping when a single additional previous character
3314 cannot be part of a match for REGEXP. When the match is
3315 extended, its starting position is allowed to occur before
3317 (let ((start (point))
3320 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3322 (if (and greedy pos)
3324 (narrow-to-region (point-min) start)
3325 (while (and (> pos (point-min))
3329 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3330 (setq pos (1- pos)))
3333 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3336 (defsubst looking-at-p (regexp)
3338 Same as `looking-at' except this function does not change the match data."
3339 (let ((inhibit-changing-match-data t))
3340 (looking-at regexp)))
3342 (defsubst string-match-p (regexp string &optional start)
3344 Same as `string-match' except this function does not change the match data."
3345 (let ((inhibit-changing-match-data t))
3346 (string-match regexp string start)))
3348 (defun subregexp-context-p (regexp pos &optional start)
3349 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3350 A subregexp context is one where a sub-regexp can appear.
3351 A non-subregexp context is for example within brackets, or within a
3352 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3353 If START is non-nil, it should be a position in REGEXP, smaller
3354 than POS, and known to be in a subregexp context."
3355 ;; Here's one possible implementation, with the great benefit that it
3356 ;; reuses the regexp-matcher's own parser, so it understands all the
3357 ;; details of the syntax. A disadvantage is that it needs to match the
3361 (string-match (substring regexp (or start 0) pos) "")
3364 (not (member (cadr err) '("Unmatched [ or [^"
3366 "Trailing backslash")))))
3367 ;; An alternative implementation:
3368 ;; (defconst re-context-re
3369 ;; (let* ((harmless-ch "[^\\[]")
3370 ;; (harmless-esc "\\\\[^{]")
3371 ;; (class-harmless-ch "[^][]")
3372 ;; (class-lb-harmless "[^]:]")
3373 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3374 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3375 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3377 ;; (concat "\\[^?]?"
3378 ;; "\\(" class-harmless-ch
3379 ;; "\\|" class-lb "\\)*"
3380 ;; "\\[?]")) ; special handling for bare [ at end of re
3381 ;; (braces "\\\\{[0-9,]+\\\\}"))
3382 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3383 ;; "\\|" class "\\|" braces "\\)*\\'"))
3384 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3385 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3390 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3391 "The default value of separators for `split-string'.
3393 A regexp matching strings of whitespace. May be locale-dependent
3394 \(as yet unimplemented). Should not match non-breaking spaces.
3396 Warning: binding this to a different value and using it as default is
3397 likely to have undesired semantics.")
3399 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3400 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3401 ;; expression leads to the equivalent implementation that if SEPARATORS
3402 ;; is defaulted, OMIT-NULLS is treated as t.
3403 (defun split-string (string &optional separators omit-nulls)
3404 "Split STRING into substrings bounded by matches for SEPARATORS.
3406 The beginning and end of STRING, and each match for SEPARATORS, are
3407 splitting points. The substrings matching SEPARATORS are removed, and
3408 the substrings between the splitting points are collected as a list,
3411 If SEPARATORS is non-nil, it should be a regular expression matching text
3412 which separates, but is not part of, the substrings. If nil it defaults to
3413 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3414 OMIT-NULLS is forced to t.
3416 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3417 that for the default value of SEPARATORS leading and trailing whitespace
3418 are effectively trimmed). If nil, all zero-length substrings are retained,
3419 which correctly parses CSV format, for example.
3421 Note that the effect of `(split-string STRING)' is the same as
3422 `(split-string STRING split-string-default-separators t)'. In the rare
3423 case that you wish to retain zero-length substrings when splitting on
3424 whitespace, use `(split-string STRING split-string-default-separators)'.
3426 Modifies the match data; use `save-match-data' if necessary."
3427 (let ((keep-nulls (not (if separators omit-nulls t)))
3428 (rexp (or separators split-string-default-separators))
3432 (while (and (string-match rexp string
3434 (= start (match-beginning 0))
3435 (< start (length string)))
3437 (< start (length string)))
3439 (if (or keep-nulls (< start (match-beginning 0)))
3441 (cons (substring string start (match-beginning 0))
3443 (setq start (match-end 0)))
3444 (if (or keep-nulls (< start (length string)))
3446 (cons (substring string start)
3450 (defun combine-and-quote-strings (strings &optional separator)
3451 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3452 This tries to quote the strings to avoid ambiguity such that
3453 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3454 Only some SEPARATORs will work properly."
3455 (let* ((sep (or separator " "))
3456 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3459 (if (string-match re str)
3460 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3464 (defun split-string-and-unquote (string &optional separator)
3465 "Split the STRING into a list of strings.
3466 It understands Emacs Lisp quoting within STRING, such that
3467 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3468 The SEPARATOR regexp defaults to \"\\s-+\"."
3469 (let ((sep (or separator "\\s-+"))
3470 (i (string-match "\"" string)))
3472 (split-string string sep t) ; no quoting: easy
3473 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3474 (let ((rfs (read-from-string string i)))
3476 (split-string-and-unquote (substring string (cdr rfs))
3480 ;;;; Replacement in strings.
3482 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3483 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3484 Unless optional argument INPLACE is non-nil, return a new string."
3485 (let ((i (length string))
3486 (newstr (if inplace string (copy-sequence string))))
3489 (if (eq (aref newstr i) fromchar)
3490 (aset newstr i tochar)))
3493 (defun replace-regexp-in-string (regexp rep string &optional
3494 fixedcase literal subexp start)
3495 "Replace all matches for REGEXP with REP in STRING.
3497 Return a new string containing the replacements.
3499 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3500 arguments with the same names of function `replace-match'. If START
3501 is non-nil, start replacements at that index in STRING.
3503 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3504 function. If it is a function, it is called with the actual text of each
3505 match, and its value is used as the replacement text. When REP is called,
3506 the match data are the result of matching REGEXP against a substring
3509 To replace only the first match (if any), make REGEXP match up to \\'
3510 and replace a sub-expression, e.g.
3511 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3515 ;; To avoid excessive consing from multiple matches in long strings,
3516 ;; don't just call `replace-match' continually. Walk down the
3517 ;; string looking for matches of REGEXP and building up a (reversed)
3518 ;; list MATCHES. This comprises segments of STRING which weren't
3519 ;; matched interspersed with replacements for segments that were.
3520 ;; [For a `large' number of replacements it's more efficient to
3521 ;; operate in a temporary buffer; we can't tell from the function's
3522 ;; args whether to choose the buffer-based implementation, though it
3523 ;; might be reasonable to do so for long enough STRING.]
3524 (let ((l (length string))
3525 (start (or start 0))
3528 (while (and (< start l) (string-match regexp string start))
3529 (setq mb (match-beginning 0)
3531 ;; If we matched the empty string, make sure we advance by one char
3532 (when (= me mb) (setq me (min l (1+ mb))))
3533 ;; Generate a replacement for the matched substring.
3534 ;; Operate only on the substring to minimize string consing.
3535 ;; Set up match data for the substring for replacement;
3536 ;; presumably this is likely to be faster than munging the
3537 ;; match data directly in Lisp.
3538 (string-match regexp (setq str (substring string mb me)))
3540 (cons (replace-match (if (stringp rep)
3542 (funcall rep (match-string 0 str)))
3543 fixedcase literal str subexp)
3544 (cons (substring string start mb) ; unmatched prefix
3547 ;; Reconstruct a string from the pieces.
3548 (setq matches (cons (substring string start l) matches)) ; leftover
3549 (apply #'concat (nreverse matches)))))
3551 (defun string-prefix-p (str1 str2 &optional ignore-case)
3552 "Return non-nil if STR1 is a prefix of STR2.
3553 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3554 to case differences."
3555 (eq t (compare-strings str1 nil nil
3556 str2 0 (length str1) ignore-case)))
3558 (defun bidi-string-mark-left-to-right (str)
3559 "Return a string that can be safely inserted in left-to-right text.
3561 Normally, inserting a string with right-to-left (RTL) script into
3562 a buffer may cause some subsequent text to be displayed as part
3563 of the RTL segment (usually this affects punctuation characters).
3564 This function returns a string which displays as STR but forces
3565 subsequent text to be displayed as left-to-right.
3567 If STR contains any RTL character, this function returns a string
3568 consisting of STR followed by an invisible left-to-right mark
3569 \(LRM) character. Otherwise, it returns STR."
3570 (unless (stringp str)
3571 (signal 'wrong-type-argument (list 'stringp str)))
3572 (if (string-match "\\cR" str)
3573 (concat str (propertize (string ?\x200e) 'invisible t))
3576 ;;;; invisibility specs
3578 (defun add-to-invisibility-spec (element)
3579 "Add ELEMENT to `buffer-invisibility-spec'.
3580 See documentation for `buffer-invisibility-spec' for the kind of elements
3582 (if (eq buffer-invisibility-spec t)
3583 (setq buffer-invisibility-spec (list t)))
3584 (setq buffer-invisibility-spec
3585 (cons element buffer-invisibility-spec)))
3587 (defun remove-from-invisibility-spec (element)
3588 "Remove ELEMENT from `buffer-invisibility-spec'."
3589 (if (consp buffer-invisibility-spec)
3590 (setq buffer-invisibility-spec
3591 (delete element buffer-invisibility-spec))))
3595 (defmacro with-syntax-table (table &rest body)
3596 "Evaluate BODY with syntax table of current buffer set to TABLE.
3597 The syntax table of the current buffer is saved, BODY is evaluated, and the
3598 saved table is restored, even in case of an abnormal exit.
3599 Value is what BODY returns."
3600 (declare (debug t) (indent 1))
3601 (let ((old-table (make-symbol "table"))
3602 (old-buffer (make-symbol "buffer")))
3603 `(let ((,old-table (syntax-table))
3604 (,old-buffer (current-buffer)))
3607 (set-syntax-table ,table)
3609 (save-current-buffer
3610 (set-buffer ,old-buffer)
3611 (set-syntax-table ,old-table))))))
3613 (defun make-syntax-table (&optional oldtable)
3614 "Return a new syntax table.
3615 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3616 from `standard-syntax-table' otherwise."
3617 (let ((table (make-char-table 'syntax-table nil)))
3618 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3621 (defun syntax-after (pos)
3622 "Return the raw syntax of the char after POS.
3623 If POS is outside the buffer's accessible portion, return nil."
3624 (unless (or (< pos (point-min)) (>= pos (point-max)))
3625 (let ((st (if parse-sexp-lookup-properties
3626 (get-char-property pos 'syntax-table))))
3628 (aref (or st (syntax-table)) (char-after pos))))))
3630 (defun syntax-class (syntax)
3631 "Return the syntax class part of the syntax descriptor SYNTAX.
3632 If SYNTAX is nil, return nil."
3633 (and syntax (logand (car syntax) 65535)))
3637 (defun text-clone-maintain (ol1 after beg end &optional _len)
3638 "Propagate the changes made under the overlay OL1 to the other clones.
3639 This is used on the `modification-hooks' property of text clones."
3640 (when (and after (not undo-in-progress) (overlay-start ol1))
3641 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3642 (setq beg (max beg (+ (overlay-start ol1) margin)))
3643 (setq end (min end (- (overlay-end ol1) margin)))
3646 (when (overlay-get ol1 'text-clone-syntax)
3647 ;; Check content of the clone's text.
3648 (let ((cbeg (+ (overlay-start ol1) margin))
3649 (cend (- (overlay-end ol1) margin)))
3652 (if (not (re-search-forward
3653 (overlay-get ol1 'text-clone-syntax) cend t))
3654 ;; Mark the overlay for deletion.
3655 (overlay-put ol1 'text-clones nil)
3656 (when (< (match-end 0) cend)
3657 ;; Shrink the clone at its end.
3658 (setq end (min end (match-end 0)))
3659 (move-overlay ol1 (overlay-start ol1)
3660 (+ (match-end 0) margin)))
3661 (when (> (match-beginning 0) cbeg)
3662 ;; Shrink the clone at its beginning.
3663 (setq beg (max (match-beginning 0) beg))
3664 (move-overlay ol1 (- (match-beginning 0) margin)
3665 (overlay-end ol1)))))))
3666 ;; Now go ahead and update the clones.
3667 (let ((head (- beg (overlay-start ol1)))
3668 (tail (- (overlay-end ol1) end))
3669 (str (buffer-substring beg end))
3671 (inhibit-modification-hooks t))
3672 (dolist (ol2 (overlay-get ol1 'text-clones))
3673 (let ((oe (overlay-end ol2)))
3674 (unless (or (eq ol1 ol2) (null oe))
3675 (setq nothing-left nil)
3676 (let ((mod-beg (+ (overlay-start ol2) head)))
3677 ;;(overlay-put ol2 'modification-hooks nil)
3678 (goto-char (- (overlay-end ol2) tail))
3679 (unless (> mod-beg (point))
3680 (save-excursion (insert str))
3681 (delete-region mod-beg (point)))
3682 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3684 (if nothing-left (delete-overlay ol1))))))))
3686 (defun text-clone-create (start end &optional spreadp syntax)
3687 "Create a text clone of START...END at point.
3688 Text clones are chunks of text that are automatically kept identical:
3689 changes done to one of the clones will be immediately propagated to the other.
3691 The buffer's content at point is assumed to be already identical to
3692 the one between START and END.
3693 If SYNTAX is provided it's a regexp that describes the possible text of
3694 the clones; the clone will be shrunk or killed if necessary to ensure that
3695 its text matches the regexp.
3696 If SPREADP is non-nil it indicates that text inserted before/after the
3697 clone should be incorporated in the clone."
3698 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3699 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3700 ;; (with a one-char margin at each end) with `t nil'.
3701 ;; We opted for a larger overlay because it behaves better in the case
3702 ;; where the clone is reduced to the empty string (we want the overlay to
3703 ;; stay when the clone's content is the empty string and we want to use
3704 ;; `evaporate' to make sure those overlays get deleted when needed).
3706 (let* ((pt-end (+ (point) (- end start)))
3707 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3709 (end-margin (if (or (not spreadp)
3710 (>= pt-end (point-max))
3711 (>= start (point-max)))
3713 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3714 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3715 (dups (list ol1 ol2)))
3716 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3717 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3718 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3719 ;;(overlay-put ol1 'face 'underline)
3720 (overlay-put ol1 'evaporate t)
3721 (overlay-put ol1 'text-clones dups)
3723 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3724 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3725 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3726 ;;(overlay-put ol2 'face 'underline)
3727 (overlay-put ol2 'evaporate t)
3728 (overlay-put ol2 'text-clones dups)))
3730 ;;;; Mail user agents.
3732 ;; Here we include just enough for other packages to be able
3735 (defun define-mail-user-agent (symbol composefunc sendfunc
3736 &optional abortfunc hookvar)
3737 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3739 SYMBOL can be any Lisp symbol. Its function definition and/or
3740 value as a variable do not matter for this usage; we use only certain
3741 properties on its property list, to encode the rest of the arguments.
3743 COMPOSEFUNC is program callable function that composes an outgoing
3744 mail message buffer. This function should set up the basics of the
3745 buffer without requiring user interaction. It should populate the
3746 standard mail headers, leaving the `to:' and `subject:' headers blank
3749 COMPOSEFUNC should accept several optional arguments--the same
3750 arguments that `compose-mail' takes. See that function's documentation.
3752 SENDFUNC is the command a user would run to send the message.
3754 Optional ABORTFUNC is the command a user would run to abort the
3755 message. For mail packages that don't have a separate abort function,
3756 this can be `kill-buffer' (the equivalent of omitting this argument).
3758 Optional HOOKVAR is a hook variable that gets run before the message
3759 is actually sent. Callers that use the `mail-user-agent' may
3760 install a hook function temporarily on this hook variable.
3761 If HOOKVAR is nil, `mail-send-hook' is used.
3763 The properties used on SYMBOL are `composefunc', `sendfunc',
3764 `abortfunc', and `hookvar'."
3765 (put symbol 'composefunc composefunc)
3766 (put symbol 'sendfunc sendfunc)
3767 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3768 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3770 ;;;; Progress reporters.
3772 ;; Progress reporter has the following structure:
3774 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3781 ;; This weirdeness is for optimization reasons: we want
3782 ;; `progress-reporter-update' to be as fast as possible, so
3783 ;; `(car reporter)' is better than `(aref reporter 0)'.
3785 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3786 ;; digits of precision, it doesn't really matter here. On the other
3787 ;; hand, it greatly simplifies the code.
3789 (defsubst progress-reporter-update (reporter &optional value)
3790 "Report progress of an operation in the echo area.
3791 REPORTER should be the result of a call to `make-progress-reporter'.
3793 If REPORTER is a numerical progress reporter---i.e. if it was
3794 made using non-nil MIN-VALUE and MAX-VALUE arguments to
3795 `make-progress-reporter'---then VALUE should be a number between
3796 MIN-VALUE and MAX-VALUE.
3798 If REPORTER is a non-numerical reporter, VALUE should be nil.
3800 This function is relatively inexpensive. If the change since
3801 last update is too small or insufficient time has passed, it does
3803 (when (or (not (numberp value)) ; For pulsing reporter
3804 (>= value (car reporter))) ; For numerical reporter
3805 (progress-reporter-do-update reporter value)))
3807 (defun make-progress-reporter (message &optional min-value max-value
3808 current-value min-change min-time)
3809 "Return progress reporter object for use with `progress-reporter-update'.
3811 MESSAGE is shown in the echo area, with a status indicator
3812 appended to the end. When you call `progress-reporter-done', the
3813 word \"done\" is printed after the MESSAGE. You can change the
3814 MESSAGE of an existing progress reporter by calling
3815 `progress-reporter-force-update'.
3817 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
3818 and final (100% complete) states of operation; the latter should
3819 be larger. In this case, the status message shows the percentage
3822 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
3823 message shows a \"spinning\", non-numeric indicator.
3825 Optional CURRENT-VALUE is the initial progress; the default is
3827 Optional MIN-CHANGE is the minimal change in percents to report;
3829 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
3830 and/or MAX-VALUE are nil.
3832 Optional MIN-TIME specifies the minimum interval time between
3833 echo area updates (default is 0.2 seconds.) If the function
3834 `float-time' is not present, time is not tracked at all. If the
3835 OS is not capable of measuring fractions of seconds, this
3836 parameter is effectively rounded up."
3837 (when (string-match "[[:alnum:]]\\'" message)
3838 (setq message (concat message "...")))
3840 (setq min-time 0.2))
3842 ;; Force a call to `message' now
3843 (cons (or min-value 0)
3844 (vector (if (and (fboundp 'float-time)
3850 (if min-change (max (min min-change 50) 1) 1)
3852 (progress-reporter-update reporter (or current-value min-value))
3855 (defun progress-reporter-force-update (reporter &optional value new-message)
3856 "Report progress of an operation in the echo area unconditionally.
3858 The first two arguments are the same as in `progress-reporter-update'.
3859 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
3860 (let ((parameters (cdr reporter)))
3862 (aset parameters 3 new-message))
3863 (when (aref parameters 0)
3864 (aset parameters 0 (float-time)))
3865 (progress-reporter-do-update reporter value)))
3867 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
3868 "Characters to use for pulsing progress reporters.")
3870 (defun progress-reporter-do-update (reporter value)
3871 (let* ((parameters (cdr reporter))
3872 (update-time (aref parameters 0))
3873 (min-value (aref parameters 1))
3874 (max-value (aref parameters 2))
3875 (text (aref parameters 3))
3876 (current-time (float-time))
3878 ;; See if enough time has passed since the last update.
3879 (or (not update-time)
3880 (when (>= current-time update-time)
3881 ;; Calculate time for the next update
3882 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3883 (cond ((and min-value max-value)
3884 ;; Numerical indicator
3885 (let* ((one-percent (/ (- max-value min-value) 100.0))
3886 (percentage (if (= max-value min-value)
3888 (truncate (/ (- value min-value)
3890 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
3891 ;; message because not enough time has passed, use 1
3892 ;; instead of MIN-CHANGE. This makes delays between echo
3893 ;; area updates closer to MIN-TIME.
3895 (min (+ min-value (* (+ percentage
3896 (if enough-time-passed
3902 (when (integerp value)
3903 (setcar reporter (ceiling (car reporter))))
3904 ;; Only print message if enough time has passed
3905 (when enough-time-passed
3906 (if (> percentage 0)
3907 (message "%s%d%%" text percentage)
3908 (message "%s" text)))))
3909 ;; Pulsing indicator
3911 (let ((index (mod (1+ (car reporter)) 4))
3912 (message-log-max nil))
3913 (setcar reporter index)
3916 (aref progress-reporter--pulse-characters
3919 (defun progress-reporter-done (reporter)
3920 "Print reporter's message followed by word \"done\" in echo area."
3921 (message "%sdone" (aref (cdr reporter) 3)))
3923 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3924 "Loop a certain number of times and report progress in the echo area.
3925 Evaluate BODY with VAR bound to successive integers running from
3926 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3927 the return value (nil if RESULT is omitted).
3929 At each iteration MESSAGE followed by progress percentage is
3930 printed in the echo area. After the loop is finished, MESSAGE
3931 followed by word \"done\" is printed. This macro is a
3932 convenience wrapper around `make-progress-reporter' and friends.
3934 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3935 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3936 (let ((temp (make-symbol "--dotimes-temp--"))
3937 (temp2 (make-symbol "--dotimes-temp2--"))
3941 (,(car spec) ,start)
3942 (,temp2 (make-progress-reporter ,message ,start ,end)))
3943 (while (< ,(car spec) ,temp)
3945 (progress-reporter-update ,temp2
3946 (setq ,(car spec) (1+ ,(car spec)))))
3947 (progress-reporter-done ,temp2)
3948 nil ,@(cdr (cdr spec)))))
3951 ;;;; Comparing version strings.
3953 (defconst version-separator "."
3954 "Specify the string used to separate the version elements.
3956 Usually the separator is \".\", but it can be any other string.")
3959 (defconst version-regexp-alist
3960 '(("^[-_+ ]?alpha$" . -3)
3961 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3962 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3963 ("^[-_+ ]?beta$" . -2)
3964 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
3965 "Specify association between non-numeric version and its priority.
3967 This association is used to handle version string like \"1.0pre2\",
3968 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3969 non-numeric part of a version string to an integer. For example:
3971 String Version Integer List Version
3972 \"1.0pre2\" (1 0 -1 2)
3973 \"1.0PRE2\" (1 0 -1 2)
3974 \"22.8beta3\" (22 8 -2 3)
3975 \"22.8 Beta3\" (22 8 -2 3)
3976 \"0.9alpha1\" (0 9 -3 1)
3977 \"0.9AlphA1\" (0 9 -3 1)
3978 \"0.9 alpha\" (0 9 -3)
3980 Each element has the following form:
3986 REGEXP regexp used to match non-numeric part of a version string.
3987 It should begin with the `^' anchor and end with a `$' to
3988 prevent false hits. Letter-case is ignored while matching
3991 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
3994 (defun version-to-list (ver)
3995 "Convert version string VER into a list of integers.
3997 The version syntax is given by the following EBNF:
3999 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4001 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4003 SEPARATOR ::= `version-separator' (which see)
4004 | `version-regexp-alist' (which see).
4006 The NUMBER part is optional if SEPARATOR is a match for an element
4007 in `version-regexp-alist'.
4009 Examples of valid version syntax:
4011 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4013 Examples of invalid version syntax:
4015 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4017 Examples of version conversion:
4019 Version String Version as a List of Integers
4020 \"1.0.7.5\" (1 0 7 5)
4021 \"1.0pre2\" (1 0 -1 2)
4022 \"1.0PRE2\" (1 0 -1 2)
4023 \"22.8beta3\" (22 8 -2 3)
4024 \"22.8Beta3\" (22 8 -2 3)
4025 \"0.9alpha1\" (0 9 -3 1)
4026 \"0.9AlphA1\" (0 9 -3 1)
4027 \"0.9alpha\" (0 9 -3)
4029 See documentation for `version-separator' and `version-regexp-alist'."
4030 (or (and (stringp ver) (> (length ver) 0))
4031 (error "Invalid version string: '%s'" ver))
4032 ;; Change .x.y to 0.x.y
4033 (if (and (>= (length ver) (length version-separator))
4034 (string-equal (substring ver 0 (length version-separator))
4036 (setq ver (concat "0" ver)))
4039 (case-fold-search t) ; ignore case in matching
4041 (while (and (setq s (string-match "[0-9]+" ver i))
4043 ;; handle numeric part
4044 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4047 ;; handle non-numeric part
4048 (when (and (setq s (string-match "[^0-9]+" ver i))
4050 (setq s (substring ver i (match-end 0))
4052 ;; handle alpha, beta, pre, etc. separator
4053 (unless (string= s version-separator)
4054 (setq al version-regexp-alist)
4055 (while (and al (not (string-match (caar al) s)))
4058 (push (cdar al) lst))
4059 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4060 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4061 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4063 (t (error "Invalid version syntax: '%s'" ver))))))
4065 (error "Invalid version syntax: '%s'" ver)
4069 (defun version-list-< (l1 l2)
4070 "Return t if L1, a list specification of a version, is lower than L2.
4072 Note that a version specified by the list (1) is equal to (1 0),
4073 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4074 Also, a version given by the list (1) is higher than (1 -1), which in
4075 turn is higher than (1 -2), which is higher than (1 -3)."
4076 (while (and l1 l2 (= (car l1) (car l2)))
4080 ;; l1 not null and l2 not null
4081 ((and l1 l2) (< (car l1) (car l2)))
4082 ;; l1 null and l2 null ==> l1 length = l2 length
4083 ((and (null l1) (null l2)) nil)
4084 ;; l1 not null and l2 null ==> l1 length > l2 length
4085 (l1 (< (version-list-not-zero l1) 0))
4086 ;; l1 null and l2 not null ==> l2 length > l1 length
4087 (t (< 0 (version-list-not-zero l2)))))
4090 (defun version-list-= (l1 l2)
4091 "Return t if L1, a list specification of a version, is equal to L2.
4093 Note that a version specified by the list (1) is equal to (1 0),
4094 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4095 Also, a version given by the list (1) is higher than (1 -1), which in
4096 turn is higher than (1 -2), which is higher than (1 -3)."
4097 (while (and l1 l2 (= (car l1) (car l2)))
4101 ;; l1 not null and l2 not null
4103 ;; l1 null and l2 null ==> l1 length = l2 length
4104 ((and (null l1) (null l2)))
4105 ;; l1 not null and l2 null ==> l1 length > l2 length
4106 (l1 (zerop (version-list-not-zero l1)))
4107 ;; l1 null and l2 not null ==> l2 length > l1 length
4108 (t (zerop (version-list-not-zero l2)))))
4111 (defun version-list-<= (l1 l2)
4112 "Return t if L1, a list specification of a version, is lower or equal to L2.
4114 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4115 etc. That is, the trailing zeroes are insignificant. Also, integer
4116 list (1) is greater than (1 -1) which is greater than (1 -2)
4117 which is greater than (1 -3)."
4118 (while (and l1 l2 (= (car l1) (car l2)))
4122 ;; l1 not null and l2 not null
4123 ((and l1 l2) (< (car l1) (car l2)))
4124 ;; l1 null and l2 null ==> l1 length = l2 length
4125 ((and (null l1) (null l2)))
4126 ;; l1 not null and l2 null ==> l1 length > l2 length
4127 (l1 (<= (version-list-not-zero l1) 0))
4128 ;; l1 null and l2 not null ==> l2 length > l1 length
4129 (t (<= 0 (version-list-not-zero l2)))))
4131 (defun version-list-not-zero (lst)
4132 "Return the first non-zero element of LST, which is a list of integers.
4134 If all LST elements are zeros or LST is nil, return zero."
4135 (while (and lst (zerop (car lst)))
4136 (setq lst (cdr lst)))
4139 ;; there is no element different of zero
4143 (defun version< (v1 v2)
4144 "Return t if version V1 is lower (older) than V2.
4146 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4147 etc. That is, the trailing \".0\"s are insignificant. Also, version
4148 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4149 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4151 (version-list-< (version-to-list v1) (version-to-list v2)))
4154 (defun version<= (v1 v2)
4155 "Return t if version V1 is lower (older) than or equal to V2.
4157 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4158 etc. That is, the trailing \".0\"s are insignificant. Also, version
4159 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4160 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4162 (version-list-<= (version-to-list v1) (version-to-list v2)))
4164 (defun version= (v1 v2)
4165 "Return t if version V1 is equal to V2.
4167 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4168 etc. That is, the trailing \".0\"s are insignificant. Also, version
4169 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4170 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4172 (version-list-= (version-to-list v1) (version-to-list v2)))
4176 (defconst menu-bar-separator '("--")
4177 "Separator for menus.")
4179 ;; The following statement ought to be in print.c, but `provide' can't
4181 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4182 (when (hash-table-p (car (read-from-string
4183 (prin1-to-string (make-hash-table)))))
4184 (provide 'hashtable-print-readable))
4186 ;;; subr.el ends here