1 ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2012
4 ;; Free Software Foundation, Inc.
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 (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 (declare (doc-string 2) (indent defun
)
116 (debug (&define lambda-list
118 [&optional
("interactive" interactive
)]
120 ;; Note that this definition should not use backquotes; subr.el should not
121 ;; depend on backquote.el.
122 (list 'function
(cons 'lambda cdr
)))
124 (defmacro setq-local
(var val
)
125 "Set variable VAR to value VAL in current buffer."
126 ;; Can't use backquote here, it's too early in the bootstrap.
127 (list 'set
(list 'make-local-variable
(list 'quote var
)) val
))
129 (defmacro defvar-local
(var val
&optional docstring
)
130 "Define VAR as a buffer-local variable with default value VAL.
131 Like `defvar' but additionally marks the variable as being automatically
132 buffer-local wherever it is set."
133 (declare (debug defvar
) (doc-string 3))
134 ;; Can't use backquote here, it's too early in the bootstrap.
135 (list 'progn
(list 'defvar var val docstring
)
136 (list 'make-variable-buffer-local
(list 'quote var
))))
138 (defun apply-partially (fun &rest args
)
139 "Return a function that is a partial application of FUN to ARGS.
140 ARGS is a list of the first N arguments to pass to FUN.
141 The result is a new function which does the same as FUN, except that
142 the first N arguments are fixed at the values with which this function
144 `(closure (t) (&rest args
)
145 (apply ',fun
,@(mapcar (lambda (arg) `',arg
) args
) args
)))
147 (if (null (featurep 'cl
))
149 ;; If we reload subr.el after having loaded CL, be careful not to
150 ;; overwrite CL's extended definition of `dolist', `dotimes',
151 ;; `declare', `push' and `pop'.
152 (defmacro push
(newelt listname
)
153 "Add NEWELT to the list stored in the symbol LISTNAME.
154 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
155 LISTNAME must be a symbol."
156 (declare (debug (form sexp
)))
158 (list 'cons newelt listname
)))
160 (defmacro pop
(listname)
161 "Return the first element of LISTNAME's value, and remove it from the list.
162 LISTNAME must be a symbol whose value is a list.
163 If the value is nil, `pop' returns nil but does not actually
165 (declare (debug (sexp)))
167 (list 'prog1 listname
168 (list 'setq listname
(list 'cdr listname
)))))
171 (defmacro when
(cond &rest body
)
172 "If COND yields non-nil, do BODY, else return nil.
173 When COND yields non-nil, eval BODY forms sequentially and return
174 value of last one, or nil if there are none.
177 (declare (indent 1) (debug t
))
178 (list 'if cond
(cons 'progn body
)))
180 (defmacro unless
(cond &rest body
)
181 "If COND yields nil, do BODY, else return nil.
182 When COND yields nil, eval BODY forms sequentially and return
183 value of last one, or nil if there are none.
186 (declare (indent 1) (debug t
))
187 (cons 'if
(cons cond
(cons nil body
))))
189 (if (null (featurep 'cl
))
191 ;; If we reload subr.el after having loaded CL, be careful not to
192 ;; overwrite CL's extended definition of `dolist', `dotimes',
193 ;; `declare', `push' and `pop'.
195 (defmacro dolist
(spec &rest body
)
197 Evaluate BODY with VAR bound to each car from LIST, in turn.
198 Then evaluate RESULT to get return value, default nil.
200 \(fn (VAR LIST [RESULT]) BODY...)"
201 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
202 ;; It would be cleaner to create an uninterned symbol,
203 ;; but that uses a lot more space when many functions in many files
205 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
206 (let ((temp '--dolist-tail--
))
207 ;; This is not a reliable test, but it does not matter because both
208 ;; semantics are acceptable, tho one is slightly faster with dynamic
209 ;; scoping and the other is slightly faster (and has cleaner semantics)
210 ;; with lexical scoping.
212 `(let ((,temp
,(nth 1 spec
)))
214 (let ((,(car spec
) (car ,temp
)))
216 (setq ,temp
(cdr ,temp
))))
217 ,@(if (cdr (cdr spec
))
218 ;; FIXME: This let often leads to "unused var" warnings.
219 `((let ((,(car spec
) nil
)) ,@(cdr (cdr spec
))))))
220 `(let ((,temp
,(nth 1 spec
))
223 (setq ,(car spec
) (car ,temp
))
225 (setq ,temp
(cdr ,temp
)))
226 ,@(if (cdr (cdr spec
))
227 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
))))))))
229 (defmacro dotimes
(spec &rest body
)
230 "Loop a certain number of times.
231 Evaluate BODY with VAR bound to successive integers running from 0,
232 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
233 the return value (nil if RESULT is omitted).
235 \(fn (VAR COUNT [RESULT]) BODY...)"
236 (declare (indent 1) (debug dolist
))
237 ;; It would be cleaner to create an uninterned symbol,
238 ;; but that uses a lot more space when many functions in many files
240 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
241 (let ((temp '--dotimes-limit--
)
244 ;; This is not a reliable test, but it does not matter because both
245 ;; semantics are acceptable, tho one is slightly faster with dynamic
246 ;; scoping and the other has cleaner semantics.
248 (let ((counter '--dotimes-counter--
))
251 (while (< ,counter
,temp
)
252 (let ((,(car spec
) ,counter
))
254 (setq ,counter
(1+ ,counter
)))
256 ;; FIXME: This let often leads to "unused var" warnings.
257 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
259 (,(car spec
) ,start
))
260 (while (< ,(car spec
) ,temp
)
262 (setq ,(car spec
) (1+ ,(car spec
))))
263 ,@(cdr (cdr spec
))))))
265 (defmacro declare
(&rest _specs
)
266 "Do not evaluate any arguments and return nil.
267 Treated as a declaration when used at the right place in a
268 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
272 (defmacro ignore-errors
(&rest body
)
273 "Execute BODY; if an error occurs, return nil.
274 Otherwise, return result of last form in BODY."
275 (declare (debug t
) (indent 0))
276 `(condition-case nil
(progn ,@body
) (error nil
)))
278 ;;;; Basic Lisp functions.
280 (defun ignore (&rest _ignore
)
281 "Do nothing and return nil.
282 This function accepts any number of arguments, but ignores them."
286 ;; Signal a compile-error if the first arg is missing.
287 (defun error (&rest args
)
288 "Signal an error, making error message by passing all args to `format'.
289 In Emacs, the convention is that error messages start with a capital
290 letter but *do not* end with a period. Please follow this convention
291 for the sake of consistency."
293 (signal 'error
(list (apply 'format args
)))))
294 (set-advertised-calling-convention 'error
'(string &rest args
) "23.1")
296 (defun user-error (format &rest args
)
297 "Signal a pilot error, making error message by passing all args to `format'.
298 In Emacs, the convention is that error messages start with a capital
299 letter but *do not* end with a period. Please follow this convention
300 for the sake of consistency.
301 This is just like `error' except that `user-error's are expected to be the
302 result of an incorrect manipulation on the part of the user, rather than the
303 result of an actual problem."
305 (signal 'user-error
(list (apply #'format format args
)))))
307 ;; We put this here instead of in frame.el so that it's defined even on
308 ;; systems where frame.el isn't loaded.
309 (defun frame-configuration-p (object)
310 "Return non-nil if OBJECT seems to be a frame configuration.
311 Any list whose car is `frame-configuration' is assumed to be a frame
314 (eq (car object
) 'frame-configuration
)))
319 "Return the car of the car of X."
323 "Return the car of the cdr of X."
327 "Return the cdr of the car of X."
331 "Return the cdr of the cdr of X."
334 (defun last (list &optional n
)
335 "Return the last link of LIST. Its car is the last element.
336 If LIST is nil, return nil.
337 If N is non-nil, return the Nth-to-last link of LIST.
338 If N is bigger than the length of LIST, return LIST."
341 (let ((m (safe-length list
)))
342 (if (< n m
) (nthcdr (- m n
) list
) list
)))
344 (nthcdr (1- (safe-length list
)) list
))))
346 (defun butlast (list &optional n
)
347 "Return a copy of LIST with the last N elements removed."
348 (if (and n
(<= n
0)) list
349 (nbutlast (copy-sequence list
) n
)))
351 (defun nbutlast (list &optional n
)
352 "Modifies LIST to remove the last N elements."
353 (let ((m (length list
)))
357 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
360 (defun delete-dups (list)
361 "Destructively remove `equal' duplicates from LIST.
362 Store the result in LIST and return it. LIST must be a proper list.
363 Of several `equal' occurrences of an element in LIST, the first
367 (setcdr tail
(delete (car tail
) (cdr tail
)))
368 (setq tail
(cdr tail
))))
371 (defun number-sequence (from &optional to inc
)
372 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
373 INC is the increment used between numbers in the sequence and defaults to 1.
374 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
375 zero. TO is only included if there is an N for which TO = FROM + N * INC.
376 If TO is nil or numerically equal to FROM, return \(FROM).
377 If INC is positive and TO is less than FROM, or INC is negative
378 and TO is larger than FROM, return nil.
379 If INC is zero and TO is neither nil nor numerically equal to
380 FROM, signal an error.
382 This function is primarily designed for integer arguments.
383 Nevertheless, FROM, TO and INC can be integer or float. However,
384 floating point arithmetic is inexact. For instance, depending on
385 the machine, it may quite well happen that
386 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
387 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
388 elements. Thus, if some of the arguments are floats and one wants
389 to make sure that TO is included, one may have to explicitly write
390 TO as \(+ FROM \(* N INC)) or use a variable whose value was
391 computed with this exact expression. Alternatively, you can,
392 of course, also replace TO with a slightly larger value
393 \(or a slightly more negative value if INC is negative)."
394 (if (or (not to
) (= from to
))
396 (or inc
(setq inc
1))
397 (when (zerop inc
) (error "The increment can not be zero"))
398 (let (seq (n 0) (next from
))
401 (setq seq
(cons next seq
)
403 next
(+ from
(* n inc
))))
405 (setq seq
(cons next seq
)
407 next
(+ from
(* n inc
)))))
410 (defun copy-tree (tree &optional vecp
)
411 "Make a copy of TREE.
412 If TREE is a cons cell, this recursively copies both its car and its cdr.
413 Contrast to `copy-sequence', which copies only along the cdrs. With second
414 argument VECP, this copies vectors as well as conses."
418 (let ((newcar (car tree
)))
419 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
420 (setq newcar
(copy-tree (car tree
) vecp
)))
421 (push newcar result
))
422 (setq tree
(cdr tree
)))
423 (nconc (nreverse result
) tree
))
424 (if (and vecp
(vectorp tree
))
425 (let ((i (length (setq tree
(copy-sequence tree
)))))
426 (while (>= (setq i
(1- i
)) 0)
427 (aset tree i
(copy-tree (aref tree i
) vecp
)))
431 ;;;; Various list-search functions.
433 (defun assoc-default (key alist
&optional test default
)
434 "Find object KEY in a pseudo-alist ALIST.
435 ALIST is a list of conses or objects. Each element
436 (or the element's car, if it is a cons) is compared with KEY by
437 calling TEST, with two arguments: (i) the element or its car,
439 If that is non-nil, the element matches; then `assoc-default'
440 returns the element's cdr, if it is a cons, or DEFAULT if the
441 element is not a cons.
443 If no element matches, the value is nil.
444 If TEST is omitted or nil, `equal' is used."
445 (let (found (tail alist
) value
)
446 (while (and tail
(not found
))
447 (let ((elt (car tail
)))
448 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
449 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
450 (setq tail
(cdr tail
)))
453 (make-obsolete 'assoc-ignore-case
'assoc-string
"22.1")
454 (defun assoc-ignore-case (key alist
)
455 "Like `assoc', but ignores differences in case and text representation.
456 KEY must be a string. Upper-case and lower-case letters are treated as equal.
457 Unibyte strings are converted to multibyte for comparison."
458 (assoc-string key alist t
))
460 (make-obsolete 'assoc-ignore-representation
'assoc-string
"22.1")
461 (defun assoc-ignore-representation (key alist
)
462 "Like `assoc', but ignores differences in text representation.
463 KEY must be a string.
464 Unibyte strings are converted to multibyte for comparison."
465 (assoc-string key alist nil
))
467 (defun member-ignore-case (elt list
)
468 "Like `member', but ignore differences in case and text representation.
469 ELT must be a string. Upper-case and lower-case letters are treated as equal.
470 Unibyte strings are converted to multibyte for comparison.
471 Non-strings in LIST are ignored."
473 (not (and (stringp (car list
))
474 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
475 (setq list
(cdr list
)))
478 (defun assq-delete-all (key alist
)
479 "Delete from ALIST all elements whose car is `eq' to KEY.
480 Return the modified alist.
481 Elements of ALIST that are not conses are ignored."
482 (while (and (consp (car alist
))
483 (eq (car (car alist
)) key
))
484 (setq alist
(cdr alist
)))
485 (let ((tail alist
) tail-cdr
)
486 (while (setq tail-cdr
(cdr tail
))
487 (if (and (consp (car tail-cdr
))
488 (eq (car (car tail-cdr
)) key
))
489 (setcdr tail
(cdr tail-cdr
))
490 (setq tail tail-cdr
))))
493 (defun rassq-delete-all (value alist
)
494 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
495 Return the modified alist.
496 Elements of ALIST that are not conses are ignored."
497 (while (and (consp (car alist
))
498 (eq (cdr (car alist
)) value
))
499 (setq alist
(cdr alist
)))
500 (let ((tail alist
) tail-cdr
)
501 (while (setq tail-cdr
(cdr tail
))
502 (if (and (consp (car tail-cdr
))
503 (eq (cdr (car tail-cdr
)) value
))
504 (setcdr tail
(cdr tail-cdr
))
505 (setq tail tail-cdr
))))
508 (defun remove (elt seq
)
509 "Return a copy of SEQ with all occurrences of ELT removed.
510 SEQ must be a list, vector, or string. The comparison is done with `equal'."
512 ;; If SEQ isn't a list, there's no need to copy SEQ because
513 ;; `delete' will return a new object.
515 (delete elt
(copy-sequence seq
))))
517 (defun remq (elt list
)
518 "Return LIST with all occurrences of ELT removed.
519 The comparison is done with `eq'. Contrary to `delq', this does not use
520 side-effects, and the argument LIST is not modified."
521 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
523 (delq elt
(copy-sequence list
))
529 "Convert KEYS to the internal Emacs key representation.
530 KEYS should be a string constant in the format used for
531 saving keyboard macros (see `edmacro-mode')."
532 ;; Don't use a defalias, since the `pure' property is only true for
533 ;; the calling convention of `kbd'.
534 (read-kbd-macro keys
))
538 "Beep to tell the user this binding is undefined."
542 ;; Prevent the \{...} documentation construct
543 ;; from mentioning keys that run this command.
544 (put 'undefined
'suppress-keymap t
)
546 (defun suppress-keymap (map &optional nodigits
)
547 "Make MAP override all normally self-inserting keys to be undefined.
548 Normally, as an exception, digits and minus-sign are set to make prefix args,
549 but optional second arg NODIGITS non-nil treats them like other chars."
550 (define-key map
[remap self-insert-command
] 'undefined
)
553 (define-key map
"-" 'negative-argument
)
554 ;; Make plain numbers do numeric args.
557 (define-key map
(char-to-string loop
) 'digit-argument
)
558 (setq loop
(1+ loop
))))))
560 (defun make-composed-keymap (maps &optional parent
)
561 "Construct a new keymap composed of MAPS and inheriting from PARENT.
562 When looking up a key in the returned map, the key is looked in each
563 keymap of MAPS in turn until a binding is found.
564 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
565 As always with keymap inheritance, a nil binding in MAPS overrides
566 any corresponding binding in PARENT, but it does not override corresponding
567 bindings in other keymaps of MAPS.
568 MAPS can be a list of keymaps or a single keymap.
569 PARENT if non-nil should be a keymap."
571 ,@(if (keymapp maps
) (list maps
) maps
)
574 (defun define-key-after (keymap key definition
&optional after
)
575 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
576 This is like `define-key' except that the binding for KEY is placed
577 just after the binding for the event AFTER, instead of at the beginning
578 of the map. Note that AFTER must be an event type (like KEY), NOT a command
581 If AFTER is t or omitted, the new binding goes at the end of the keymap.
582 AFTER should be a single event type--a symbol or a character, not a sequence.
584 Bindings are always added before any inherited map.
586 The order of bindings in a keymap only matters when it is used as
587 a menu, so this function is not useful for non-menu keymaps."
588 (unless after
(setq after t
))
590 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
592 (if (<= (length key
) 1) (aref key
0)
593 (setq keymap
(lookup-key keymap
595 (butlast (mapcar 'identity key
)))))
596 (aref key
(1- (length key
)))))
597 (let ((tail keymap
) done inserted
)
598 (while (and (not done
) tail
)
599 ;; Delete any earlier bindings for the same key.
600 (if (eq (car-safe (car (cdr tail
))) key
)
601 (setcdr tail
(cdr (cdr tail
))))
602 ;; If we hit an included map, go down that one.
603 (if (keymapp (car tail
)) (setq tail
(car tail
)))
604 ;; When we reach AFTER's binding, insert the new binding after.
605 ;; If we reach an inherited keymap, insert just before that.
606 ;; If we reach the end of this keymap, insert at the end.
607 (if (or (and (eq (car-safe (car tail
)) after
)
609 (eq (car (cdr tail
)) 'keymap
)
612 ;; Stop the scan only if we find a parent keymap.
613 ;; Keep going past the inserted element
614 ;; so we can delete any duplications that come later.
615 (if (eq (car (cdr tail
)) 'keymap
)
617 ;; Don't insert more than once.
619 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
621 (setq tail
(cdr tail
)))))
623 (defun map-keymap-sorted (function keymap
)
624 "Implement `map-keymap' with sorting.
625 Don't call this function; it is for internal use only."
627 (map-keymap (lambda (a b
) (push (cons a b
) list
))
629 (setq list
(sort list
631 (setq a
(car a
) b
(car b
))
633 (if (integerp b
) (< a b
)
636 ;; string< also accepts symbols.
639 (funcall function
(car p
) (cdr p
)))))
641 (defun keymap--menu-item-binding (val)
642 "Return the binding part of a menu-item."
644 ((not (consp val
)) val
) ;Not a menu-item.
645 ((eq 'menu-item
(car val
))
646 (let* ((binding (nth 2 val
))
647 (plist (nthcdr 3 val
))
648 (filter (plist-get plist
:filter
)))
649 (if filter
(funcall filter binding
)
651 ((and (consp (cdr val
)) (stringp (cadr val
)))
655 (t val
))) ;Not a menu-item either.
657 (defun keymap--menu-item-with-binding (item binding
)
658 "Build a menu-item like ITEM but with its binding changed to BINDING."
660 ((not (consp item
)) binding
) ;Not a menu-item.
661 ((eq 'menu-item
(car item
))
662 (setq item
(copy-sequence item
))
663 (let ((tail (nthcdr 2 item
)))
664 (setcar tail binding
)
665 ;; Remove any potential filter.
666 (if (plist-get (cdr tail
) :filter
)
667 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
669 ((and (consp (cdr item
)) (stringp (cadr item
)))
670 (cons (car item
) (cons (cadr item
) binding
)))
671 (t (cons (car item
) binding
))))
673 (defun keymap--merge-bindings (val1 val2
)
674 "Merge bindings VAL1 and VAL2."
675 (let ((map1 (keymap--menu-item-binding val1
))
676 (map2 (keymap--menu-item-binding val2
)))
677 (if (not (and (keymapp map1
) (keymapp map2
)))
678 ;; There's nothing to merge: val1 takes precedence.
680 (let ((map (list 'keymap map1 map2
))
681 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
682 (keymap--menu-item-with-binding item map
)))))
684 (defun keymap-canonicalize (map)
685 "Return a simpler equivalent keymap.
686 This resolves inheritance and redefinitions. The returned keymap
687 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
688 and use in active keymaps and menus.
689 Subkeymaps may be modified but are not canonicalized."
690 ;; FIXME: Problem with the difference between a nil binding
691 ;; that hides a binding in an inherited map and a nil binding that's ignored
692 ;; to let some further binding visible. Currently a nil binding hides all.
693 ;; FIXME: we may want to carefully (re)order elements in case they're
697 (prompt (keymap-prompt map
)))
699 (setq map
(map-keymap ;; -internal
702 ;; Treat char-ranges specially.
703 (push (cons key item
) ranges
)
704 (push (cons key item
) bindings
)))
706 ;; Create the new map.
707 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
708 (dolist (binding ranges
)
709 ;; Treat char-ranges specially. FIXME: need to merge as well.
710 (define-key map
(vector (car binding
)) (cdr binding
)))
711 ;; Process the bindings starting from the end.
712 (dolist (binding (prog1 bindings
(setq bindings
())))
713 (let* ((key (car binding
))
714 (oldbind (assq key bindings
)))
715 (push (if (not oldbind
)
716 ;; The normal case: no duplicate bindings.
718 ;; This is the second binding for this key.
719 (setq bindings
(delq oldbind bindings
))
720 (cons key
(keymap--merge-bindings (cdr binding
)
723 (nconc map bindings
)))
725 (put 'keyboard-translate-table
'char-table-extra-slots
0)
727 (defun keyboard-translate (from to
)
728 "Translate character FROM to TO at a low level.
729 This function creates a `keyboard-translate-table' if necessary
730 and then modifies one entry in it."
731 (or (char-table-p keyboard-translate-table
)
732 (setq keyboard-translate-table
733 (make-char-table 'keyboard-translate-table nil
)))
734 (aset keyboard-translate-table from to
))
736 ;;;; Key binding commands.
738 (defun global-set-key (key command
)
739 "Give KEY a global binding as COMMAND.
740 COMMAND is the command definition to use; usually it is
741 a symbol naming an interactively-callable function.
742 KEY is a key sequence; noninteractively, it is a string or vector
743 of characters or event types, and non-ASCII characters with codes
744 above 127 (such as ISO Latin-1) can be included if you use a vector.
746 Note that if KEY has a local binding in the current buffer,
747 that local binding will continue to shadow any global binding
748 that you make with this function."
749 (interactive "KSet key globally: \nCSet key %s to command: ")
750 (or (vectorp key
) (stringp key
)
751 (signal 'wrong-type-argument
(list 'arrayp key
)))
752 (define-key (current-global-map) key command
))
754 (defun local-set-key (key command
)
755 "Give KEY a local binding as COMMAND.
756 COMMAND is the command definition to use; usually it is
757 a symbol naming an interactively-callable function.
758 KEY is a key sequence; noninteractively, it is a string or vector
759 of characters or event types, and non-ASCII characters with codes
760 above 127 (such as ISO Latin-1) can be included if you use a vector.
762 The binding goes in the current buffer's local map,
763 which in most cases is shared with all other buffers in the same major mode."
764 (interactive "KSet key locally: \nCSet key %s locally to command: ")
765 (let ((map (current-local-map)))
767 (use-local-map (setq map
(make-sparse-keymap))))
768 (or (vectorp key
) (stringp key
)
769 (signal 'wrong-type-argument
(list 'arrayp key
)))
770 (define-key map key command
)))
772 (defun global-unset-key (key)
773 "Remove global binding of KEY.
774 KEY is a string or vector representing a sequence of keystrokes."
775 (interactive "kUnset key globally: ")
776 (global-set-key key nil
))
778 (defun local-unset-key (key)
779 "Remove local binding of KEY.
780 KEY is a string or vector representing a sequence of keystrokes."
781 (interactive "kUnset key locally: ")
782 (if (current-local-map)
783 (local-set-key key nil
))
786 ;;;; substitute-key-definition and its subroutines.
788 (defvar key-substitution-in-progress nil
789 "Used internally by `substitute-key-definition'.")
791 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
792 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
793 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
794 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
795 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
797 If you don't specify OLDMAP, you can usually get the same results
798 in a cleaner way with command remapping, like this:
799 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
800 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
801 ;; Don't document PREFIX in the doc string because we don't want to
802 ;; advertise it. It's meant for recursive calls only. Here's its
805 ;; If optional argument PREFIX is specified, it should be a key
806 ;; prefix, a string. Redefined bindings will then be bound to the
807 ;; original key, with PREFIX added at the front.
808 (or prefix
(setq prefix
""))
809 (let* ((scan (or oldmap keymap
))
810 (prefix1 (vconcat prefix
[nil]))
811 (key-substitution-in-progress
812 (cons scan key-substitution-in-progress)))
813 ;; Scan OLDMAP, finding each char or event-symbol that
814 ;; has any definition, and act on it with hack-key.
817 (aset prefix1 (length prefix) char)
818 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
821 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
822 (let (inner-def skipped menu-item)
823 ;; Find the actual command name within the binding.
824 (if (eq (car-safe defn) 'menu-item)
825 (setq menu-item defn defn (nth 2 defn))
826 ;; Skip past menu-prompt.
827 (while (stringp (car-safe defn))
828 (push (pop defn) skipped))
829 ;; Skip past cached key-equivalence data for menu items.
830 (if (consp (car-safe defn))
831 (setq defn (cdr defn))))
832 (if (or (eq defn olddef)
833 ;; Compare with equal if definition is a key sequence.
834 ;; That is useful for operating on function-key-map.
835 (and (or (stringp defn) (vectorp defn))
836 (equal defn olddef)))
837 (define-key keymap prefix
839 (let ((copy (copy-sequence menu-item)))
840 (setcar (nthcdr 2 copy) newdef)
842 (nconc (nreverse skipped) newdef)))
843 ;; Look past a symbol that names a keymap.
845 (or (indirect-function defn t) defn))
846 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
847 ;; avoid autoloading a keymap. This is mostly done to preserve the
848 ;; original non-autoloading behavior of pre-map-keymap times.
849 (if (and (keymapp inner-def)
850 ;; Avoid recursively scanning
851 ;; where KEYMAP does not have a submap.
852 (let ((elt (lookup-key keymap prefix)))
853 (or (null elt) (natnump elt) (keymapp elt)))
854 ;; Avoid recursively rescanning keymap being scanned.
855 (not (memq inner-def key-substitution-in-progress)))
856 ;; If this one isn't being scanned already, scan it now.
857 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
860 ;;;; The global keymap tree.
862 ;; global-map, esc-map, and ctl-x-map have their values set up in
863 ;; keymap.c; we just give them docstrings here.
865 (defvar global-map nil
866 "Default global keymap mapping Emacs keyboard input into commands.
867 The value is a keymap which is usually (but not necessarily) Emacs's
871 "Default keymap for ESC (meta) commands.
872 The normal global definition of the character ESC indirects to this keymap.")
874 (defvar ctl-x-map nil
875 "Default keymap for C-x commands.
876 The normal global definition of the character C-x indirects to this keymap.")
878 (defvar ctl-x-4-map (make-sparse-keymap)
879 "Keymap for subcommands of C-x 4.")
880 (defalias 'ctl-x-4-prefix ctl-x-4-map)
881 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
883 (defvar ctl-x-5-map (make-sparse-keymap)
884 "Keymap for frame commands.")
885 (defalias 'ctl-x-5-prefix ctl-x-5-map)
886 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
889 ;;;; Event manipulation functions.
891 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
893 (defun listify-key-sequence (key)
894 "Convert a key sequence to a list of events."
897 (mapcar (function (lambda (c)
899 (logxor c listify-key-sequence-1)
903 (defsubst eventp (obj)
904 "True if the argument is an event object."
905 (or (and (integerp obj)
906 ;; FIXME: Why bother?
907 ;; Filter out integers too large to be events.
908 ;; M is the biggest modifier.
909 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
910 (characterp (event-basic-type obj)))
912 (get obj 'event-symbol-elements))
915 (get (car obj) 'event-symbol-elements))))
917 (defun event-modifiers (event)
918 "Return a list of symbols representing the modifier keys in event EVENT.
919 The elements of the list may include `meta', `control',
920 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
922 EVENT may be an event or an event type. If EVENT is a symbol
923 that has never been used in an event that has been read as input
924 in the current Emacs session, then this function may fail to include
925 the `click' modifier."
928 (setq type (car type)))
930 ;; Don't read event-symbol-elements directly since we're not
931 ;; sure the symbol has already been parsed.
932 (cdr (internal-event-symbol-parse-modifiers type))
934 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
935 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
936 (if (not (zerop (logand type ?\M-\^@)))
938 (if (or (not (zerop (logand type ?\C-\^@)))
940 (push 'control list))
941 (if (or (not (zerop (logand type ?\S-\^@)))
942 (/= char (downcase char)))
944 (or (zerop (logand type ?\H-\^@))
946 (or (zerop (logand type ?\s-\^@))
948 (or (zerop (logand type ?\A-\^@))
952 (defun event-basic-type (event)
953 "Return the basic type of the given event (all modifiers removed).
954 The value is a printing character (not upper case) or a symbol.
955 EVENT may be an event or an event type. If EVENT is a symbol
956 that has never been used in an event that has been read as input
957 in the current Emacs session, then this function may return nil."
959 (setq event (car event)))
961 (car (get event 'event-symbol-elements))
962 (let* ((base (logand event (1- ?\A-\^@)))
963 (uncontrolled (if (< base 32) (logior base 64) base)))
964 ;; There are some numbers that are invalid characters and
965 ;; cause `downcase' to get an error.
967 (downcase uncontrolled)
968 (error uncontrolled)))))
970 (defsubst mouse-movement-p (object)
971 "Return non-nil if OBJECT is a mouse movement event."
972 (eq (car-safe object) 'mouse-movement))
974 (defun mouse-event-p (object)
975 "Return non-nil if OBJECT is a mouse click event."
976 ;; is this really correct? maybe remove mouse-movement?
977 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
979 (defsubst event-start (event)
980 "Return the starting position of EVENT.
981 EVENT should be a click, drag, or key press event.
982 If it is a key press event, the return value has the form
983 (WINDOW POS (0 . 0) 0)
984 If it is a click or drag event, it has the form
985 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
986 IMAGE (DX . DY) (WIDTH . HEIGHT))
987 The `posn-' functions access elements of such lists.
988 For more information, see Info node `(elisp)Click Events'.
990 If EVENT is a mouse or key press or a mouse click, this is the
991 position of the event. If EVENT is a drag, this is the starting
992 position of the drag."
993 (if (consp event) (nth 1 event)
994 (list (selected-window) (point) '(0 . 0) 0)))
996 (defsubst event-end (event)
997 "Return the ending location of EVENT.
998 EVENT should be a click, drag, or key press event.
999 If EVENT is a key press event, the return value has the form
1000 (WINDOW POS (0 . 0) 0)
1001 If EVENT is a click event, this function is the same as
1002 `event-start'. For click and drag events, the return value has
1004 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
1005 IMAGE (DX . DY) (WIDTH . HEIGHT))
1006 The `posn-' functions access elements of such lists.
1007 For more information, see Info node `(elisp)Click Events'.
1009 If EVENT is a mouse or key press or a mouse click, this is the
1010 position of the event. If EVENT is a drag, this is the starting
1011 position of the drag."
1012 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1013 (list (selected-window) (point) '(0 . 0) 0)))
1015 (defsubst event-click-count (event)
1016 "Return the multi-click count of EVENT, a click or drag event.
1017 The return value is a positive integer."
1018 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1020 ;;;; Extracting fields of the positions in an event.
1022 (defsubst posn-window (position)
1023 "Return the window in POSITION.
1024 POSITION should be a list of the form returned by the `event-start'
1025 and `event-end' functions."
1028 (defsubst posn-area (position)
1029 "Return the window area recorded in POSITION, or nil for the text area.
1030 POSITION should be a list of the form returned by the `event-start'
1031 and `event-end' functions."
1032 (let ((area (if (consp (nth 1 position))
1033 (car (nth 1 position))
1035 (and (symbolp area) area)))
1037 (defsubst posn-point (position)
1038 "Return the buffer location in POSITION.
1039 POSITION should be a list of the form returned by the `event-start'
1040 and `event-end' functions."
1041 (or (nth 5 position)
1042 (if (consp (nth 1 position))
1043 (car (nth 1 position))
1046 (defun posn-set-point (position)
1047 "Move point to POSITION.
1048 Select the corresponding window as well."
1049 (if (not (windowp (posn-window position)))
1050 (error "Position not in text area of window"))
1051 (select-window (posn-window position))
1052 (if (numberp (posn-point position))
1053 (goto-char (posn-point position))))
1055 (defsubst posn-x-y (position)
1056 "Return the x and y coordinates in POSITION.
1057 The return value has the form (X . Y), where X and Y are given in
1058 pixels. POSITION should be a list of the form returned by
1059 `event-start' and `event-end'."
1062 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1064 (defun posn-col-row (position)
1065 "Return the nominal column and row in POSITION, measured in characters.
1066 The column and row values are approximations calculated from the x
1067 and y coordinates in POSITION and the frame's default character width
1069 For a scroll-bar event, the result column is 0, and the row
1070 corresponds to the vertical position of the click in the scroll bar.
1071 POSITION should be a list of the form returned by the `event-start'
1072 and `event-end' functions."
1073 (let* ((pair (posn-x-y position))
1074 (window (posn-window position))
1075 (area (posn-area position)))
1079 ((eq area 'vertical-scroll-bar)
1080 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1081 ((eq area 'horizontal-scroll-bar)
1082 (cons (scroll-bar-scale pair (window-width window)) 0))
1084 (let* ((frame (if (framep window) window (window-frame window)))
1085 ;; FIXME: This should take line-spacing properties on
1086 ;; newlines into account.
1087 (spacing (when (display-graphic-p frame)
1088 (or (with-current-buffer (window-buffer window)
1090 (frame-parameter frame 'line-spacing)))))
1091 (cond ((floatp spacing)
1092 (setq spacing (truncate (* spacing
1093 (frame-char-height frame)))))
1096 (cons (/ (car pair) (frame-char-width frame))
1097 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1098 (if (null (with-current-buffer (window-buffer window)
1099 header-line-format))
1102 (defun posn-actual-col-row (position)
1103 "Return the actual column and row in POSITION, measured in characters.
1104 These are the actual row number in the window and character number in that row.
1105 Return nil if POSITION does not contain the actual position; in that case
1106 `posn-col-row' can be used to get approximate values.
1107 POSITION should be a list of the form returned by the `event-start'
1108 and `event-end' functions."
1111 (defsubst posn-timestamp (position)
1112 "Return the timestamp of POSITION.
1113 POSITION should be a list of the form returned by the `event-start'
1114 and `event-end' functions."
1117 (defsubst posn-string (position)
1118 "Return the string object of POSITION.
1119 Value is a cons (STRING . STRING-POS), or nil if not a string.
1120 POSITION should be a list of the form returned by the `event-start'
1121 and `event-end' functions."
1124 (defsubst posn-image (position)
1125 "Return the image object of POSITION.
1126 Value is a list (image ...), or nil if not an image.
1127 POSITION should be a list of the form returned by the `event-start'
1128 and `event-end' functions."
1131 (defsubst posn-object (position)
1132 "Return the object (image or string) of POSITION.
1133 Value is a list (image ...) for an image object, a cons cell
1134 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1135 POSITION should be a list of the form returned by the `event-start'
1136 and `event-end' functions."
1137 (or (posn-image position) (posn-string position)))
1139 (defsubst posn-object-x-y (position)
1140 "Return the x and y coordinates relative to the object of POSITION.
1141 The return value has the form (DX . DY), where DX and DY are
1142 given in pixels. POSITION should be a list of the form returned
1143 by `event-start' and `event-end'."
1146 (defsubst posn-object-width-height (position)
1147 "Return the pixel width and height of the object of POSITION.
1148 The return value has the form (WIDTH . HEIGHT). POSITION should
1149 be a list of the form returned by `event-start' and `event-end'."
1153 ;;;; Obsolescent names for functions.
1155 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1156 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1157 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1158 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1159 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1160 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1162 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1163 (make-obsolete 'buffer-has-markers-at nil "24.2")
1165 (defun insert-string (&rest args)
1166 "Mocklisp-compatibility insert function.
1167 Like the function `insert' except that any argument that is a number
1168 is converted into a string by expressing it in decimal."
1170 (insert (if (integerp el) (number-to-string el) el))))
1171 (make-obsolete 'insert-string 'insert "22.1")
1173 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1174 (make-obsolete 'makehash 'make-hash-table "22.1")
1176 ;; These are used by VM and some old programs
1177 (defalias 'focus-frame 'ignore "")
1178 (make-obsolete 'focus-frame "it does nothing." "22.1")
1179 (defalias 'unfocus-frame 'ignore "")
1180 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1181 (make-obsolete 'make-variable-frame-local
1182 "explicitly check for a frame-parameter instead." "22.2")
1183 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1184 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
1185 (set-advertised-calling-convention
1186 'all-completions '(string collection &optional predicate) "23.1")
1187 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1189 ;;;; Obsolescence declarations for variables, and aliases.
1191 ;; Special "default-FOO" variables which contain the default value of
1192 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1193 ;; slows down several unrelated variable operations; furthermore, they
1194 ;; can lead to really odd behavior if you decide to make them
1197 ;; Not used at all in Emacs, last time I checked:
1198 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1199 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1200 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1201 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1202 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1203 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1204 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1205 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1206 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1207 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1208 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1209 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1210 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1211 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1212 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1213 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1214 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1215 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1216 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1217 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1218 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1219 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1220 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1221 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1222 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1223 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1224 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1225 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1226 (make-obsolete-variable 'default-enable-multibyte-characters
1227 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1229 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1230 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1231 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1232 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1233 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1234 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1236 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1237 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1239 (make-obsolete-variable
1240 'mode-line-inverse-video
1241 "use the appropriate faces instead."
1243 (make-obsolete-variable
1244 'unread-command-char
1245 "use `unread-command-events' instead. That variable is a list of events
1246 to reread, so it now uses nil to mean `no event', instead of -1."
1249 ;; Lisp manual only updated in 22.1.
1250 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1253 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1254 (make-obsolete-variable 'x-lost-selection-hooks
1255 'x-lost-selection-functions "22.1")
1256 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1257 (make-obsolete-variable 'x-sent-selection-hooks
1258 'x-sent-selection-functions "22.1")
1260 ;; This was introduced in 21.4 for pre-unicode unification. That
1261 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1262 ;; Other uses are possible, so this variable is not _really_ obsolete,
1263 ;; but Stefan insists to mark it so.
1264 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1266 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1268 ;; These aliases exist in Emacs 19.34, and probably before, but were
1269 ;; only marked as obsolete in 23.1.
1270 ;; The lisp manual (since at least Emacs 21) describes them as
1271 ;; existing "for compatibility with Emacs version 18".
1272 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1274 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1278 ;;;; Alternate names for functions - these are not being phased out.
1280 (defalias 'send-string 'process-send-string)
1281 (defalias 'send-region 'process-send-region)
1282 (defalias 'string= 'string-equal)
1283 (defalias 'string< 'string-lessp)
1284 (defalias 'move-marker 'set-marker)
1285 (defalias 'rplaca 'setcar)
1286 (defalias 'rplacd 'setcdr)
1287 (defalias 'beep 'ding) ;preserve lingual purity
1288 (defalias 'indent-to-column 'indent-to)
1289 (defalias 'backward-delete-char 'delete-backward-char)
1290 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1291 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1292 (defalias 'int-to-string 'number-to-string)
1293 (defalias 'store-match-data 'set-match-data)
1294 (defalias 'chmod 'set-file-modes)
1295 (defalias 'mkdir 'make-directory)
1296 ;; These are the XEmacs names:
1297 (defalias 'point-at-eol 'line-end-position)
1298 (defalias 'point-at-bol 'line-beginning-position)
1300 (defalias 'user-original-login-name 'user-login-name)
1303 ;;;; Hook manipulation functions.
1305 (defun add-hook (hook function &optional append local)
1306 "Add to the value of HOOK the function FUNCTION.
1307 FUNCTION is not added if already present.
1308 FUNCTION is added (if necessary) at the beginning of the hook list
1309 unless the optional argument APPEND is non-nil, in which case
1310 FUNCTION is added at the end.
1312 The optional fourth argument, LOCAL, if non-nil, says to modify
1313 the hook's buffer-local value rather than its global value.
1314 This makes the hook buffer-local, and it makes t a member of the
1315 buffer-local value. That acts as a flag to run the hook
1316 functions of the global value as well as in the local value.
1318 HOOK should be a symbol, and FUNCTION may be any valid function. If
1319 HOOK is void, it is first set to nil. If HOOK's value is a single
1320 function, it is changed to a list of functions."
1321 (or (boundp hook) (set hook nil))
1322 (or (default-boundp hook) (set-default hook nil))
1323 (if local (unless (local-variable-if-set-p hook)
1324 (set (make-local-variable hook) (list t)))
1325 ;; Detect the case where make-local-variable was used on a hook
1326 ;; and do what we used to do.
1327 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1329 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1330 ;; If the hook value is a single function, turn it into a list.
1331 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1332 (setq hook-value (list hook-value)))
1333 ;; Do the actual addition if necessary
1334 (unless (member function hook-value)
1335 (when (stringp function)
1336 (setq function (purecopy function)))
1339 (append hook-value (list function))
1340 (cons function hook-value))))
1341 ;; Set the actual variable
1344 ;; If HOOK isn't a permanent local,
1345 ;; but FUNCTION wants to survive a change of modes,
1346 ;; mark HOOK as partially permanent.
1347 (and (symbolp function)
1348 (get function 'permanent-local-hook)
1349 (not (get hook 'permanent-local))
1350 (put hook 'permanent-local 'permanent-local-hook))
1351 (set hook hook-value))
1352 (set-default hook hook-value))))
1354 (defun remove-hook (hook function &optional local)
1355 "Remove from the value of HOOK the function FUNCTION.
1356 HOOK should be a symbol, and FUNCTION may be any valid function. If
1357 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1358 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1360 The optional third argument, LOCAL, if non-nil, says to modify
1361 the hook's buffer-local value rather than its default value."
1362 (or (boundp hook) (set hook nil))
1363 (or (default-boundp hook) (set-default hook nil))
1364 ;; Do nothing if LOCAL is t but this hook has no local binding.
1365 (unless (and local (not (local-variable-p hook)))
1366 ;; Detect the case where make-local-variable was used on a hook
1367 ;; and do what we used to do.
1368 (when (and (local-variable-p hook)
1369 (not (and (consp (symbol-value hook))
1370 (memq t (symbol-value hook)))))
1372 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1373 ;; Remove the function, for both the list and the non-list cases.
1374 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1375 (if (equal hook-value function) (setq hook-value nil))
1376 (setq hook-value (delete function (copy-sequence hook-value))))
1377 ;; If the function is on the global hook, we need to shadow it locally
1378 ;;(when (and local (member function (default-value hook))
1379 ;; (not (member (cons 'not function) hook-value)))
1380 ;; (push (cons 'not function) hook-value))
1381 ;; Set the actual variable
1383 (set-default hook hook-value)
1384 (if (equal hook-value '(t))
1385 (kill-local-variable hook)
1386 (set hook hook-value))))))
1388 (defmacro letrec (binders &rest body)
1389 "Bind variables according to BINDERS then eval BODY.
1390 The value of the last form in BODY is returned.
1391 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1392 SYMBOL to the value of VALUEFORM.
1393 All symbols are bound before the VALUEFORMs are evalled."
1394 ;; Only useful in lexical-binding mode.
1395 ;; As a special-form, we could implement it more efficiently (and cleanly,
1396 ;; making the vars actually unbound during evaluation of the binders).
1397 (declare (debug let) (indent 1))
1398 `(let ,(mapcar #'car binders)
1399 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1402 (defmacro with-wrapper-hook (hook args &rest body)
1403 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1404 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1405 around the preceding ones, like a set of nested `around' advices.
1407 Each hook function should accept an argument list consisting of a
1408 function FUN, followed by the additional arguments in ARGS.
1410 The first hook function in HOOK is passed a FUN that, if it is called
1411 with arguments ARGS, performs BODY (i.e., the default operation).
1412 The FUN passed to each successive hook function is defined based
1413 on the preceding hook functions; if called with arguments ARGS,
1414 it does what the `with-wrapper-hook' call would do if the
1415 preceding hook functions were the only ones present in HOOK.
1417 Each hook function may call its FUN argument as many times as it wishes,
1418 including never. In that case, such a hook function acts to replace
1419 the default definition altogether, and any preceding hook functions.
1420 Of course, a subsequent hook function may do the same thing.
1422 Each hook function definition is used to construct the FUN passed
1423 to the next hook function, if any. The last (or \"outermost\")
1424 FUN is then called once."
1425 (declare (indent 2) (debug (form sexp body)))
1426 ;; We need those two gensyms because CL's lexical scoping is not available
1427 ;; for function arguments :-(
1428 (let ((funs (make-symbol "funs"))
1429 (global (make-symbol "global"))
1430 (argssym (make-symbol "args"))
1431 (runrestofhook (make-symbol "runrestofhook")))
1432 ;; Since the hook is a wrapper, the loop has to be done via
1433 ;; recursion: a given hook function will call its parameter in order to
1434 ;; continue looping.
1435 `(letrec ((,runrestofhook
1436 (lambda (,funs ,global ,argssym)
1437 ;; `funs' holds the functions left on the hook and `global'
1438 ;; holds the functions left on the global part of the hook
1439 ;; (in case the hook is local).
1441 (if (eq t (car ,funs))
1442 (funcall ,runrestofhook
1443 (append ,global (cdr ,funs)) nil ,argssym)
1446 (lambda (,funs ,global &rest ,argssym)
1447 (funcall ,runrestofhook ,funs ,global ,argssym))
1448 (cdr ,funs) ,global)
1450 ;; Once there are no more functions on the hook, run
1451 ;; the original body.
1452 (apply (lambda ,args ,@body) ,argssym)))))
1453 (funcall ,runrestofhook ,hook
1454 ;; The global part of the hook, if any.
1456 `(if (local-variable-p ',hook)
1457 (default-value ',hook)))
1460 (defun add-to-list (list-var element &optional append compare-fn)
1461 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1462 The test for presence of ELEMENT is done with `equal',
1463 or with COMPARE-FN if that's non-nil.
1464 If ELEMENT is added, it is added at the beginning of the list,
1465 unless the optional argument APPEND is non-nil, in which case
1466 ELEMENT is added at the end.
1468 The return value is the new value of LIST-VAR.
1470 If you want to use `add-to-list' on a variable that is not defined
1471 until a certain package is loaded, you should put the call to `add-to-list'
1472 into a hook function that will be run only after loading the package.
1473 `eval-after-load' provides one way to do this. In some cases
1474 other hooks, such as major mode hooks, can do the job."
1477 (member element (symbol-value list-var)))
1478 ((eq compare-fn 'eq)
1479 (memq element (symbol-value list-var)))
1480 ((eq compare-fn 'eql)
1481 (memql element (symbol-value list-var)))
1483 (let ((lst (symbol-value list-var)))
1485 (not (funcall compare-fn element (car lst))))
1486 (setq lst (cdr lst)))
1488 (symbol-value list-var)
1491 (append (symbol-value list-var) (list element))
1492 (cons element (symbol-value list-var))))))
1495 (defun add-to-ordered-list (list-var element &optional order)
1496 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1497 The test for presence of ELEMENT is done with `eq'.
1499 The resulting list is reordered so that the elements are in the
1500 order given by each element's numeric list order. Elements
1501 without a numeric list order are placed at the end of the list.
1503 If the third optional argument ORDER is a number (integer or
1504 float), set the element's list order to the given value. If
1505 ORDER is nil or omitted, do not change the numeric order of
1506 ELEMENT. If ORDER has any other value, remove the numeric order
1507 of ELEMENT if it has one.
1509 The list order for each element is stored in LIST-VAR's
1510 `list-order' property.
1512 The return value is the new value of LIST-VAR."
1513 (let ((ordering (get list-var 'list-order)))
1515 (put list-var 'list-order
1516 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1518 (puthash element (and (numberp order) order) ordering))
1519 (unless (memq element (symbol-value list-var))
1520 (set list-var (cons element (symbol-value list-var))))
1521 (set list-var (sort (symbol-value list-var)
1523 (let ((oa (gethash a ordering))
1524 (ob (gethash b ordering)))
1529 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1530 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1531 Return the new history list.
1532 If MAXELT is non-nil, it specifies the maximum length of the history.
1533 Otherwise, the maximum history length is the value of the `history-length'
1534 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1536 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1537 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1538 if it is empty or a duplicate."
1540 (setq maxelt (or (get history-var 'history-length)
1542 (let ((history (symbol-value history-var))
1544 (when (and (listp history)
1546 (not (stringp newelt))
1547 (> (length newelt) 0))
1549 (not (equal (car history) newelt))))
1550 (if history-delete-duplicates
1551 (delete newelt history))
1552 (setq history (cons newelt history))
1553 (when (integerp maxelt)
1556 (setq tail (nthcdr (1- maxelt) history))
1558 (setcdr tail nil)))))
1559 (set history-var history)))
1564 (defvar delay-mode-hooks nil
1565 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1566 (defvar delayed-mode-hooks nil
1567 "List of delayed mode hooks waiting to be run.")
1568 (make-variable-buffer-local 'delayed-mode-hooks)
1569 (put 'delay-mode-hooks 'permanent-local t)
1571 (defvar change-major-mode-after-body-hook nil
1572 "Normal hook run in major mode functions, before the mode hooks.")
1574 (defvar after-change-major-mode-hook nil
1575 "Normal hook run at the very end of major mode functions.")
1577 (defun run-mode-hooks (&rest hooks)
1578 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1579 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1580 just adds the HOOKS to the list `delayed-mode-hooks'.
1581 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1582 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1583 `after-change-major-mode-hook'. Major mode functions should use
1584 this instead of `run-hooks' when running their FOO-mode-hook."
1585 (if delay-mode-hooks
1587 (dolist (hook hooks)
1588 (push hook delayed-mode-hooks))
1589 ;; Normal case, just run the hook as before plus any delayed hooks.
1590 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1591 (setq delayed-mode-hooks nil)
1592 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1593 (run-hooks 'after-change-major-mode-hook)))
1595 (defmacro delay-mode-hooks (&rest body)
1596 "Execute BODY, but delay any `run-mode-hooks'.
1597 These hooks will be executed by the first following call to
1598 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1599 Only affects hooks run in the current buffer."
1600 (declare (debug t) (indent 0))
1602 (make-local-variable 'delay-mode-hooks)
1603 (let ((delay-mode-hooks t))
1606 ;; PUBLIC: find if the current mode derives from another.
1608 (defun derived-mode-p (&rest modes)
1609 "Non-nil if the current major mode is derived from one of MODES.
1610 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1611 (let ((parent major-mode))
1612 (while (and (not (memq parent modes))
1613 (setq parent (get parent 'derived-mode-parent))))
1618 ;; If a minor mode is not defined with define-minor-mode,
1619 ;; add it here explicitly.
1620 ;; isearch-mode is deliberately excluded, since you should
1621 ;; not call it yourself.
1622 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1623 overwrite-mode view-mode
1625 "List of all minor mode functions.")
1627 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1628 "Register a new minor mode.
1630 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1632 TOGGLE is a symbol which is the name of a buffer-local variable that
1633 is toggled on or off to say whether the minor mode is active or not.
1635 NAME specifies what will appear in the mode line when the minor mode
1636 is active. NAME should be either a string starting with a space, or a
1637 symbol whose value is such a string.
1639 Optional KEYMAP is the keymap for the minor mode that will be added
1640 to `minor-mode-map-alist'.
1642 Optional AFTER specifies that TOGGLE should be added after AFTER
1643 in `minor-mode-alist'.
1645 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1646 It defaults to (and should by convention be) TOGGLE.
1648 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1649 included in the mode-line minor mode menu.
1650 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1651 (unless (memq toggle minor-mode-list)
1652 (push toggle minor-mode-list))
1654 (unless toggle-fun (setq toggle-fun toggle))
1655 (unless (eq toggle-fun toggle)
1656 (put toggle :minor-mode-function toggle-fun))
1657 ;; Add the name to the minor-mode-alist.
1659 (let ((existing (assq toggle minor-mode-alist)))
1661 (setcdr existing (list name))
1662 (let ((tail minor-mode-alist) found)
1663 (while (and tail (not found))
1664 (if (eq after (caar tail))
1666 (setq tail (cdr tail))))
1668 (let ((rest (cdr found)))
1670 (nconc found (list (list toggle name)) rest))
1671 (push (list toggle name) minor-mode-alist))))))
1672 ;; Add the toggle to the minor-modes menu if requested.
1673 (when (get toggle :included)
1674 (define-key mode-line-mode-menu
1678 (or (get toggle :menu-tag)
1679 (if (stringp name) name (symbol-name toggle)))
1680 (let ((mode-name (if (symbolp name) (symbol-value name))))
1681 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1682 (concat " (" (match-string 0 mode-name) ")"))))
1684 :button (cons :toggle toggle))))
1686 ;; Add the map to the minor-mode-map-alist.
1688 (let ((existing (assq toggle minor-mode-map-alist)))
1690 (setcdr existing keymap)
1691 (let ((tail minor-mode-map-alist) found)
1692 (while (and tail (not found))
1693 (if (eq after (caar tail))
1695 (setq tail (cdr tail))))
1697 (let ((rest (cdr found)))
1699 (nconc found (list (cons toggle keymap)) rest))
1700 (push (cons toggle keymap) minor-mode-map-alist)))))))
1704 (defun symbol-file (symbol &optional type)
1705 "Return the name of the file that defined SYMBOL.
1706 The value is normally an absolute file name. It can also be nil,
1707 if the definition is not associated with any file. If SYMBOL
1708 specifies an autoloaded function, the value can be a relative
1709 file name without extension.
1711 If TYPE is nil, then any kind of definition is acceptable. If
1712 TYPE is `defun', `defvar', or `defface', that specifies function
1713 definition, variable definition, or face definition only."
1714 (if (and (or (null type) (eq type 'defun))
1715 (symbolp symbol) (fboundp symbol)
1716 (eq 'autoload (car-safe (symbol-function symbol))))
1717 (nth 1 (symbol-function symbol))
1718 (let ((files load-history)
1722 (if (eq type 'defvar)
1723 ;; Variables are present just as their names.
1724 (member symbol (cdr (car files)))
1725 ;; Other types are represented as (TYPE . NAME).
1726 (member (cons type symbol) (cdr (car files))))
1727 ;; We accept all types, so look for variable def
1728 ;; and then for any other kind.
1729 (or (member symbol (cdr (car files)))
1730 (rassq symbol (cdr (car files)))))
1731 (setq file (car (car files)) files nil))
1732 (setq files (cdr files)))
1735 (defun locate-library (library &optional nosuffix path interactive-call)
1736 "Show the precise file name of Emacs library LIBRARY.
1737 LIBRARY should be a relative file name of the library, a string.
1738 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1739 nil (which is the default, see below).
1740 This command searches the directories in `load-path' like `\\[load-library]'
1741 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1742 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1743 to the specified name LIBRARY.
1745 If the optional third arg PATH is specified, that list of directories
1746 is used instead of `load-path'.
1748 When called from a program, the file name is normally returned as a
1749 string. When run interactively, the argument INTERACTIVE-CALL is t,
1750 and the file name is displayed in the echo area."
1751 (interactive (list (completing-read "Locate library: "
1753 'locate-file-completion-table
1754 load-path (get-load-suffixes)))
1757 (let ((file (locate-file library
1759 (append (unless nosuffix (get-load-suffixes))
1760 load-file-rep-suffixes))))
1761 (if interactive-call
1763 (message "Library is file %s" (abbreviate-file-name file))
1764 (message "No library %s in search path" library)))
1768 ;;;; Specifying things to do later.
1770 (defun load-history-regexp (file)
1771 "Form a regexp to find FILE in `load-history'.
1772 FILE, a string, is described in the function `eval-after-load'."
1773 (if (file-name-absolute-p file)
1774 (setq file (file-truename file)))
1775 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1777 (if (file-name-extension file)
1779 ;; Note: regexp-opt can't be used here, since we need to call
1780 ;; this before Emacs has been fully started. 2006-05-21
1781 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1782 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1785 (defun load-history-filename-element (file-regexp)
1786 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1787 Return nil if there isn't one."
1788 (let* ((loads load-history)
1789 (load-elt (and loads (car loads))))
1792 (or (null (car load-elt))
1793 (not (string-match file-regexp (car load-elt)))))
1794 (setq loads (cdr loads)
1795 load-elt (and loads (car loads)))))
1798 (put 'eval-after-load 'lisp-indent-function 1)
1799 (defun eval-after-load (file form)
1800 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
1801 If FILE is already loaded, evaluate FORM right now.
1803 If a matching file is loaded again, FORM will be evaluated again.
1805 If FILE is a string, it may be either an absolute or a relative file
1806 name, and may have an extension \(e.g. \".el\") or may lack one, and
1807 additionally may or may not have an extension denoting a compressed
1808 format \(e.g. \".gz\").
1810 When FILE is absolute, this first converts it to a true name by chasing
1811 symbolic links. Only a file of this name \(see next paragraph regarding
1812 extensions) will trigger the evaluation of FORM. When FILE is relative,
1813 a file whose absolute true name ends in FILE will trigger evaluation.
1815 When FILE lacks an extension, a file name with any extension will trigger
1816 evaluation. Otherwise, its extension must match FILE's. A further
1817 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1820 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1821 is evaluated at the end of any file that `provide's this feature.
1822 If the feature is provided when evaluating code not associated with a
1823 file, FORM is evaluated immediately after the provide statement.
1825 Usually FILE is just a library name like \"font-lock\" or a feature name
1828 This function makes or adds to an entry on `after-load-alist'."
1829 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1830 ;; evaluating it now).
1831 (let* ((regexp-or-feature
1833 (setq file (purecopy (load-history-regexp file)))
1835 (elt (assoc regexp-or-feature after-load-alist)))
1837 (setq elt (list regexp-or-feature))
1838 (push elt after-load-alist))
1839 ;; Make sure `form' is evalled in the current lexical/dynamic code.
1840 (setq form `(funcall ',(eval `(lambda () ,form) lexical-binding)))
1841 ;; Is there an already loaded file whose name (or `provide' name)
1843 (prog1 (if (if (stringp file)
1844 (load-history-filename-element regexp-or-feature)
1847 (when (symbolp regexp-or-feature)
1848 ;; For features, the after-load-alist elements get run when `provide' is
1849 ;; called rather than at the end of the file. So add an indirection to
1850 ;; make sure that `form' is really run "after-load" in case the provide
1851 ;; call happens early.
1854 (let ((fun (make-symbol "eval-after-load-helper")))
1855 (fset fun `(lambda (file)
1856 (if (not (equal file ',load-file-name))
1858 (remove-hook 'after-load-functions ',fun)
1860 (add-hook 'after-load-functions fun))
1861 ;; Not being provided from a file, run form right now.
1863 ;; Add FORM to the element unless it's already there.
1864 (unless (member form (cdr elt))
1865 (nconc elt (purecopy (list form)))))))
1867 (defvar after-load-functions nil
1868 "Special hook run after loading a file.
1869 Each function there is called with a single argument, the absolute
1870 name of the file just loaded.")
1872 (defun do-after-load-evaluation (abs-file)
1873 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1874 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1875 This function is called directly from the C code."
1876 ;; Run the relevant eval-after-load forms.
1877 (mapc #'(lambda (a-l-element)
1878 (when (and (stringp (car a-l-element))
1879 (string-match-p (car a-l-element) abs-file))
1880 ;; discard the file name regexp
1881 (mapc #'eval (cdr a-l-element))))
1883 ;; Complain when the user uses obsolete files.
1884 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1885 (run-with-timer 0 nil
1887 (message "Package %s is obsolete!"
1889 (string-match "\\.elc?\\>" file))))
1890 (file-name-nondirectory abs-file)))
1891 ;; Finally, run any other hook.
1892 (run-hook-with-args 'after-load-functions abs-file))
1894 (defun eval-next-after-load (file)
1895 "Read the following input sexp, and run it whenever FILE is loaded.
1896 This makes or adds to an entry on `after-load-alist'.
1897 FILE should be the name of a library, with no directory name."
1898 (eval-after-load file (read)))
1899 (make-obsolete 'eval-next-after-load `eval-after-load "23.2")
1901 (defun display-delayed-warnings ()
1902 "Display delayed warnings from `delayed-warnings-list'.
1903 Used from `delayed-warnings-hook' (which see)."
1904 (dolist (warning (nreverse delayed-warnings-list))
1905 (apply 'display-warning warning))
1906 (setq delayed-warnings-list nil))
1908 (defun collapse-delayed-warnings ()
1909 "Remove duplicates from `delayed-warnings-list'.
1910 Collapse identical adjacent warnings into one (plus count).
1911 Used from `delayed-warnings-hook' (which see)."
1914 (while delayed-warnings-list
1915 (setq warning (pop delayed-warnings-list))
1916 (if (equal warning (car delayed-warnings-list))
1917 (setq count (1+ count))
1919 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
1922 (push warning collapsed)))
1923 (setq delayed-warnings-list (nreverse collapsed))))
1925 ;; At present this is only used for Emacs internals.
1926 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
1927 (defvar delayed-warnings-hook '(collapse-delayed-warnings
1928 display-delayed-warnings)
1929 "Normal hook run to process and display delayed warnings.
1930 By default, this hook contains functions to consolidate the
1931 warnings listed in `delayed-warnings-list', display them, and set
1932 `delayed-warnings-list' back to nil.")
1937 (defun process-lines (program &rest args)
1938 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1939 Signal an error if the program returns with a non-zero exit status."
1941 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1942 (unless (eq status 0)
1943 (error "%s exited with status %s" program status))
1944 (goto-char (point-min))
1947 (setq lines (cons (buffer-substring-no-properties
1948 (line-beginning-position)
1949 (line-end-position))
1952 (nreverse lines)))))
1954 (defun process-live-p (process)
1955 "Returns non-nil if PROCESS is alive.
1956 A process is considered alive if its status is `run', `open',
1957 `listen', `connect' or `stop'."
1958 (memq (process-status process)
1959 '(run open listen connect stop)))
1964 'process-kill-without-query
1965 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1967 (defun process-kill-without-query (process &optional _flag)
1968 "Say no query needed if PROCESS is running when Emacs is exited.
1969 Optional second argument if non-nil says to require a query.
1970 Value is t if a query was formerly required."
1971 (let ((old (process-query-on-exit-flag process)))
1972 (set-process-query-on-exit-flag process nil)
1975 (defun process-kill-buffer-query-function ()
1976 "Ask before killing a buffer that has a running process."
1977 (let ((process (get-buffer-process (current-buffer))))
1979 (not (memq (process-status process) '(run stop open listen)))
1980 (not (process-query-on-exit-flag process))
1982 (format "Buffer %S has a running process; kill it? "
1983 (buffer-name (current-buffer)))))))
1985 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1987 ;; process plist management
1989 (defun process-get (process propname)
1990 "Return the value of PROCESS' PROPNAME property.
1991 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1992 (plist-get (process-plist process) propname))
1994 (defun process-put (process propname value)
1995 "Change PROCESS' PROPNAME property to VALUE.
1996 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1997 (set-process-plist process
1998 (plist-put (process-plist process) propname value)))
2001 ;;;; Input and display facilities.
2003 (defvar read-quoted-char-radix 8
2004 "Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2005 Legitimate radix values are 8, 10 and 16.")
2007 (custom-declare-variable-early
2008 'read-quoted-char-radix 8
2009 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2010 Legitimate radix values are 8, 10 and 16."
2011 :type '(choice (const 8) (const 10) (const 16))
2012 :group 'editing-basics)
2014 (defconst read-key-empty-map (make-sparse-keymap))
2016 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2018 (defun read-key (&optional prompt)
2019 "Read a key from the keyboard.
2020 Contrary to `read-event' this will not return a raw event but instead will
2021 obey the input decoding and translations usually done by `read-key-sequence'.
2022 So escape sequences and keyboard encoding are taken into account.
2023 When there's an ambiguity because the key looks like the prefix of
2024 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2025 ;; This overriding-terminal-local-map binding also happens to
2026 ;; disable quail's input methods, so although read-key-sequence
2027 ;; always inherits the input method, in practice read-key does not
2028 ;; inherit the input method (at least not if it's based on quail).
2029 (let ((overriding-terminal-local-map read-key-empty-map)
2030 (overriding-local-map nil)
2032 (old-global-map (current-global-map))
2033 (timer (run-with-idle-timer
2034 ;; Wait long enough that Emacs has the time to receive and
2035 ;; process all the raw events associated with the single-key.
2036 ;; But don't wait too long, or the user may find the delay
2037 ;; annoying (or keep hitting more keys which may then get
2038 ;; lost or misinterpreted).
2039 ;; This is only relevant for keys which Emacs perceives as
2040 ;; "prefixes", such as C-x (because of the C-x 8 map in
2041 ;; key-translate-table and the C-x @ map in function-key-map)
2042 ;; or ESC (because of terminal escape sequences in
2043 ;; input-decode-map).
2046 (let ((keys (this-command-keys-vector)))
2047 (unless (zerop (length keys))
2048 ;; `keys' is non-empty, so the user has hit at least
2049 ;; one key; there's no point waiting any longer, even
2050 ;; though read-key-sequence thinks we should wait
2051 ;; for more input to decide how to interpret the
2053 (throw 'read-key keys)))))))
2057 (let ((map (make-sparse-keymap)))
2058 ;; Don't hide the menu-bar and tool-bar entries.
2059 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2060 (define-key map [tool-bar]
2061 ;; This hack avoids evaluating the :filter (Bug#9922).
2062 (or (cdr (assq 'tool-bar global-map))
2063 (lookup-key global-map [tool-bar])))
2065 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
2066 (cancel-timer timer)
2067 (use-global-map old-global-map))))
2069 (defun read-quoted-char (&optional prompt)
2070 "Like `read-char', but do not allow quitting.
2071 Also, if the first character read is an octal digit,
2072 we read any number of octal digits and return the
2073 specified character code. Any nondigit terminates the sequence.
2074 If the terminator is RET, it is discarded;
2075 any other terminator is used itself as input.
2077 The optional argument PROMPT specifies a string to use to prompt the user.
2078 The variable `read-quoted-char-radix' controls which radix to use
2080 (let ((message-log-max nil) done (first t) (code 0) char translated)
2082 (let ((inhibit-quit first)
2083 ;; Don't let C-h get the help message--only help function keys.
2086 "Type the special character you want to use,
2087 or the octal character code.
2088 RET terminates the character code and is discarded;
2089 any other non-digit terminates the character code and is then used as input."))
2090 (setq char (read-event (and prompt (format "%s-" prompt)) t))
2091 (if inhibit-quit (setq quit-flag nil)))
2092 ;; Translate TAB key into control-I ASCII character, and so on.
2093 ;; Note: `read-char' does it using the `ascii-character' property.
2094 ;; We should try and use read-key instead.
2095 (let ((translation (lookup-key local-function-key-map (vector char))))
2096 (setq translated (if (arrayp translation)
2097 (aref translation 0)
2099 (if (integerp translated)
2100 (setq translated (char-resolve-modifiers translated)))
2101 (cond ((null translated))
2102 ((not (integerp translated))
2103 (setq unread-command-events (list char)
2105 ((/= (logand translated ?\M-\^@) 0)
2106 ;; Turn a meta-character into a character with the 0200 bit set.
2107 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
2109 ((and (<= ?0 translated)
2110 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
2111 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
2112 (and prompt (setq prompt (message "%s %c" prompt translated))))
2113 ((and (<= ?a (downcase translated))
2114 (< (downcase translated)
2115 (+ ?a -10 (min 36 read-quoted-char-radix))))
2116 (setq code (+ (* code read-quoted-char-radix)
2117 (+ 10 (- (downcase translated) ?a))))
2118 (and prompt (setq prompt (message "%s %c" prompt translated))))
2119 ((and (not first) (eq translated ?\C-m))
2122 (setq unread-command-events (list char)
2124 (t (setq code translated
2129 (defun read-passwd (prompt &optional confirm default)
2130 "Read a password, prompting with PROMPT, and return it.
2131 If optional CONFIRM is non-nil, read the password twice to make sure.
2132 Optional DEFAULT is a default password to use instead of empty input.
2134 This function echoes `.' for each character that the user types.
2136 Once the caller uses the password, it can erase the password
2137 by doing (clear-string STRING)."
2140 (while (not success)
2141 (let ((first (read-passwd prompt nil default))
2142 (second (read-passwd "Confirm password: " nil default)))
2143 (if (equal first second)
2145 (and (arrayp second) (clear-string second))
2146 (setq success first))
2147 (and (arrayp first) (clear-string first))
2148 (and (arrayp second) (clear-string second))
2149 (message "Password not repeated accurately; please start over")
2152 (let ((hide-chars-fun
2153 (lambda (beg end _len)
2154 (clear-this-command-keys)
2155 (setq beg (min end (max (minibuffer-prompt-end)
2157 (dotimes (i (- end beg))
2158 (put-text-property (+ i beg) (+ 1 i beg)
2159 'display (string ?.)))))
2161 (minibuffer-with-setup-hook
2163 (setq minibuf (current-buffer))
2164 ;; Turn off electricity.
2165 (set (make-local-variable 'post-self-insert-hook) nil)
2166 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2168 (read-string prompt nil
2169 (let ((sym (make-symbol "forget-history")))
2173 (when (buffer-live-p minibuf)
2174 (with-current-buffer minibuf
2175 ;; Not sure why but it seems that there might be cases where the
2176 ;; minibuffer is not always properly reset later on, so undo
2177 ;; whatever we've done here (bug#11392).
2178 (remove-hook 'after-change-functions hide-chars-fun 'local)
2179 (kill-local-variable 'post-self-insert-hook)
2180 ;; And of course, don't keep the sensitive data around.
2181 (erase-buffer))))))))
2183 ;; This should be used by `call-interactively' for `n' specs.
2184 (defun read-number (prompt &optional default)
2185 "Read a numeric value in the minibuffer, prompting with PROMPT.
2186 DEFAULT specifies a default value to return if the user just types RET.
2187 The value of DEFAULT is inserted into PROMPT."
2191 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2192 (replace-match (format " (default %s)" default) t t prompt 1)
2193 (replace-regexp-in-string "[ \t]*\\'"
2194 (format " (default %s) " default)
2198 (let ((str (read-from-minibuffer prompt nil nil nil nil
2200 (number-to-string default)))))
2203 ((zerop (length str)) default)
2204 ((stringp str) (read str))))
2207 (message "Please enter a number.")
2212 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2213 "Read and return one of CHARS, prompting for PROMPT.
2214 Any input that is not one of CHARS is ignored.
2216 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2217 keyboard-quit events while waiting for a valid input."
2218 (unless (consp chars)
2219 (error "Called `read-char-choice' without valid char choices"))
2220 (let (char done show-help (helpbuf " *Char Help*"))
2221 (let ((cursor-in-echo-area t)
2222 (executing-kbd-macro executing-kbd-macro))
2223 (save-window-excursion ; in case we call help-form-show
2225 (unless (get-text-property 0 'face prompt)
2226 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2227 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2229 (and show-help (buffer-live-p (get-buffer helpbuf))
2230 (kill-buffer helpbuf))
2232 ((not (numberp char)))
2233 ;; If caller has set help-form, that's enough.
2234 ;; They don't explicitly have to add help-char to chars.
2241 ((and executing-kbd-macro (= char -1))
2242 ;; read-event returns -1 if we are in a kbd macro and
2243 ;; there are no more events in the macro. Attempt to
2244 ;; get an event interactively.
2245 (setq executing-kbd-macro nil))
2246 ((and (not inhibit-keyboard-quit) (eq char ?\C-g))
2247 (keyboard-quit))))))
2248 ;; Display the question with the answer. But without cursor-in-echo-area.
2249 (message "%s%s" prompt (char-to-string char))
2252 (defun sit-for (seconds &optional nodisp obsolete)
2253 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2254 SECONDS may be a floating-point value.
2255 \(On operating systems that do not support waiting for fractions of a
2256 second, floating-point values are rounded down to the nearest integer.)
2258 If optional arg NODISP is t, don't redisplay, just wait for input.
2259 Redisplay does not happen if input is available before it starts.
2261 Value is t if waited the full time with no input arriving, and nil otherwise.
2263 An obsolete, but still supported form is
2264 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2265 where the optional arg MILLISECONDS specifies an additional wait period,
2266 in milliseconds; this was useful when Emacs was built without
2267 floating point support."
2268 (if (numberp nodisp)
2269 (setq seconds (+ seconds (* 1e-3 nodisp))
2271 (if obsolete (setq nodisp obsolete)))
2279 (or nodisp (redisplay)))
2281 (or nodisp (redisplay))
2282 (let ((read (read-event nil nil seconds)))
2285 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2286 ;; unread-command-events as (t . EVENT) so it will be added to
2287 ;; this-command-keys by read-key-sequence.
2288 (if (eq overriding-terminal-local-map universal-argument-map)
2289 (setq read (cons t read)))
2290 (push read unread-command-events)
2292 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2294 (defun y-or-n-p (prompt)
2295 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2296 PROMPT is the string to display to ask the question. It should
2297 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2299 No confirmation of the answer is requested; a single character is enough.
2300 Also accepts Space to mean yes, or Delete to mean no. \(Actually, it uses
2301 the bindings in `query-replace-map'; see the documentation of that variable
2302 for more information. In this case, the useful bindings are `act', `skip',
2303 `recenter', and `quit'.\)
2305 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2306 is nil and `use-dialog-box' is non-nil."
2307 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2308 ;; where all the keys were unbound (i.e. it somehow got triggered
2309 ;; within read-key, apparently). I had to kill it.
2310 (let ((answer 'recenter))
2313 (setq prompt (concat prompt
2314 (if (eq ?\s (aref prompt (1- (length prompt))))
2317 (let ((temp-prompt prompt))
2318 (while (not (memq answer '(act skip)))
2319 (let ((str (read-string temp-prompt)))
2320 (cond ((member str '("y" "Y")) (setq answer 'act))
2321 ((member str '("n" "N")) (setq answer 'skip))
2322 (t (setq temp-prompt (concat "Please answer y or n. "
2324 ((and (display-popup-menus-p)
2325 (listp last-nonmenu-event)
2328 (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2330 (setq prompt (concat prompt
2331 (if (eq ?\s (aref prompt (1- (length prompt))))
2336 (let ((cursor-in-echo-area t))
2337 (when minibuffer-auto-raise
2338 (raise-frame (window-frame (minibuffer-window))))
2339 (read-key (propertize (if (eq answer 'recenter)
2341 (concat "Please answer y or n. "
2343 'face 'minibuffer-prompt)))))
2344 (setq answer (lookup-key query-replace-map (vector key) t))
2346 ((memq answer '(skip act)) nil)
2347 ((eq answer 'recenter) (recenter) t)
2348 ((memq answer '(exit-prefix quit)) (signal 'quit nil) t)
2352 (let ((ret (eq answer 'act)))
2353 (unless noninteractive
2354 ;; FIXME this prints one too many spaces, since prompt
2355 ;; already ends in a space. Eg "... (y or n) y".
2356 (message "%s %s" prompt (if ret "y" "n")))
2360 ;;; Atomic change groups.
2362 (defmacro atomic-change-group (&rest body)
2363 "Perform BODY as an atomic change group.
2364 This means that if BODY exits abnormally,
2365 all of its changes to the current buffer are undone.
2366 This works regardless of whether undo is enabled in the buffer.
2368 This mechanism is transparent to ordinary use of undo;
2369 if undo is enabled in the buffer and BODY succeeds, the
2370 user can undo the change normally."
2371 (declare (indent 0) (debug t))
2372 (let ((handle (make-symbol "--change-group-handle--"))
2373 (success (make-symbol "--change-group-success--")))
2374 `(let ((,handle (prepare-change-group))
2375 ;; Don't truncate any undo data in the middle of this.
2376 (undo-outer-limit nil)
2377 (undo-limit most-positive-fixnum)
2378 (undo-strong-limit most-positive-fixnum)
2382 ;; This is inside the unwind-protect because
2383 ;; it enables undo if that was disabled; we need
2384 ;; to make sure that it gets disabled again.
2385 (activate-change-group ,handle)
2388 ;; Either of these functions will disable undo
2389 ;; if it was disabled before.
2391 (accept-change-group ,handle)
2392 (cancel-change-group ,handle))))))
2394 (defun prepare-change-group (&optional buffer)
2395 "Return a handle for the current buffer's state, for a change group.
2396 If you specify BUFFER, make a handle for BUFFER's state instead.
2398 Pass the handle to `activate-change-group' afterward to initiate
2399 the actual changes of the change group.
2401 To finish the change group, call either `accept-change-group' or
2402 `cancel-change-group' passing the same handle as argument. Call
2403 `accept-change-group' to accept the changes in the group as final;
2404 call `cancel-change-group' to undo them all. You should use
2405 `unwind-protect' to make sure the group is always finished. The call
2406 to `activate-change-group' should be inside the `unwind-protect'.
2407 Once you finish the group, don't use the handle again--don't try to
2408 finish the same group twice. For a simple example of correct use, see
2409 the source code of `atomic-change-group'.
2411 The handle records only the specified buffer. To make a multibuffer
2412 change group, call this function once for each buffer you want to
2413 cover, then use `nconc' to combine the returned values, like this:
2415 (nconc (prepare-change-group buffer-1)
2416 (prepare-change-group buffer-2))
2418 You can then activate that multibuffer change group with a single
2419 call to `activate-change-group' and finish it with a single call
2420 to `accept-change-group' or `cancel-change-group'."
2423 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2424 (list (cons (current-buffer) buffer-undo-list))))
2426 (defun activate-change-group (handle)
2427 "Activate a change group made with `prepare-change-group' (which see)."
2428 (dolist (elt handle)
2429 (with-current-buffer (car elt)
2430 (if (eq buffer-undo-list t)
2431 (setq buffer-undo-list nil)))))
2433 (defun accept-change-group (handle)
2434 "Finish a change group made with `prepare-change-group' (which see).
2435 This finishes the change group by accepting its changes as final."
2436 (dolist (elt handle)
2437 (with-current-buffer (car elt)
2438 (if (eq (cdr elt) t)
2439 (setq buffer-undo-list t)))))
2441 (defun cancel-change-group (handle)
2442 "Finish a change group made with `prepare-change-group' (which see).
2443 This finishes the change group by reverting all of its changes."
2444 (dolist (elt handle)
2445 (with-current-buffer (car elt)
2446 (setq elt (cdr elt))
2448 ;; Widen buffer temporarily so if the buffer was narrowed within
2449 ;; the body of `atomic-change-group' all changes can be undone.
2452 (if (consp elt) (car elt)))
2454 (if (consp elt) (cdr elt))))
2455 ;; Temporarily truncate the undo log at ELT.
2457 (setcar elt nil) (setcdr elt nil))
2458 (unless (eq last-command 'undo) (undo-start))
2459 ;; Make sure there's no confusion.
2460 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2461 (error "Undoing to some unrelated state"))
2464 (while (listp pending-undo-list) (undo-more 1)))
2465 ;; Reset the modified cons cell ELT to its original content.
2467 (setcar elt old-car)
2468 (setcdr elt old-cdr))
2469 ;; Revert the undo info to what it was when we grabbed the state.
2470 (setq buffer-undo-list elt))))))
2472 ;;;; Display-related functions.
2474 ;; For compatibility.
2475 (define-obsolete-function-alias 'redraw-modeline
2476 'force-mode-line-update "24.2")
2478 (defun force-mode-line-update (&optional all)
2479 "Force redisplay of the current buffer's mode line and header line.
2480 With optional non-nil ALL, force redisplay of all mode lines and
2481 header lines. This function also forces recomputation of the
2482 menu bar menus and the frame title."
2483 (if all (with-current-buffer (other-buffer)))
2484 (set-buffer-modified-p (buffer-modified-p)))
2486 (defun momentary-string-display (string pos &optional exit-char message)
2487 "Momentarily display STRING in the buffer at POS.
2488 Display remains until next event is input.
2489 If POS is a marker, only its position is used; its buffer is ignored.
2490 Optional third arg EXIT-CHAR can be a character, event or event
2491 description list. EXIT-CHAR defaults to SPC. If the input is
2492 EXIT-CHAR it is swallowed; otherwise it is then available as
2493 input (as a command if nothing else).
2494 Display MESSAGE (optional fourth arg) in the echo area.
2495 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2496 (or exit-char (setq exit-char ?\s))
2497 (let ((ol (make-overlay pos pos))
2498 (str (copy-sequence string)))
2502 (overlay-put ol 'after-string str)
2504 ;; To avoid trouble with out-of-bounds position
2506 ;; If the string end is off screen, recenter now.
2507 (if (<= (window-end nil t) pos)
2508 (recenter (/ (window-height) 2))))
2509 (message (or message "Type %s to continue editing.")
2510 (single-key-description exit-char))
2511 (let ((event (read-event)))
2512 ;; `exit-char' can be an event, or an event description list.
2513 (or (eq event exit-char)
2514 (eq event (event-convert-list exit-char))
2515 (setq unread-command-events (list event)))))
2516 (delete-overlay ol))))
2519 ;;;; Overlay operations
2521 (defun copy-overlay (o)
2522 "Return a copy of overlay O."
2523 (let ((o1 (if (overlay-buffer o)
2524 (make-overlay (overlay-start o) (overlay-end o)
2525 ;; FIXME: there's no easy way to find the
2526 ;; insertion-type of the two markers.
2528 (let ((o1 (make-overlay (point-min) (point-min))))
2531 (props (overlay-properties o)))
2533 (overlay-put o1 (pop props) (pop props)))
2536 (defun remove-overlays (&optional beg end name val)
2537 "Clear BEG and END of overlays whose property NAME has value VAL.
2538 Overlays might be moved and/or split.
2539 BEG and END default respectively to the beginning and end of buffer."
2540 ;; This speeds up the loops over overlays.
2541 (unless beg (setq beg (point-min)))
2542 (unless end (setq end (point-max)))
2543 (overlay-recenter end)
2545 (setq beg (prog1 end (setq end beg))))
2547 (dolist (o (overlays-in beg end))
2548 (when (eq (overlay-get o name) val)
2549 ;; Either push this overlay outside beg...end
2550 ;; or split it to exclude beg...end
2551 ;; or delete it entirely (if it is contained in beg...end).
2552 (if (< (overlay-start o) beg)
2553 (if (> (overlay-end o) end)
2555 (move-overlay (copy-overlay o)
2556 (overlay-start o) beg)
2557 (move-overlay o end (overlay-end o)))
2558 (move-overlay o (overlay-start o) beg))
2559 (if (> (overlay-end o) end)
2560 (move-overlay o end (overlay-end o))
2561 (delete-overlay o)))))))
2565 (defvar suspend-hook nil
2566 "Normal hook run by `suspend-emacs', before suspending.")
2568 (defvar suspend-resume-hook nil
2569 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2571 (defvar temp-buffer-show-hook nil
2572 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2573 When the hook runs, the temporary buffer is current, and the window it
2574 was displayed in is selected.")
2576 (defvar temp-buffer-setup-hook nil
2577 "Normal hook run by `with-output-to-temp-buffer' at the start.
2578 When the hook runs, the temporary buffer is current.
2579 This hook is normally set up with a function to put the buffer in Help
2582 ;; Avoid compiler warnings about this variable,
2583 ;; which has a special meaning on certain system types.
2584 (defvar buffer-file-type nil
2585 "Non-nil if the visited file is a binary file.
2586 This variable is meaningful on MS-DOG and Windows NT.
2587 On those systems, it is automatically local in every buffer.
2588 On other systems, this variable is normally always nil.")
2590 ;; The `assert' macro from the cl package signals
2591 ;; `cl-assertion-failed' at runtime so always define it.
2592 (put 'cl-assertion-failed 'error-conditions '(error))
2593 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2595 (defconst user-emacs-directory
2596 (if (eq system-type 'ms-dos)
2597 ;; MS-DOS cannot have initial dot.
2600 "Directory beneath which additional per-user Emacs-specific files are placed.
2601 Various programs in Emacs store information in this directory.
2602 Note that this should end with a directory separator.
2603 See also `locate-user-emacs-file'.")
2605 (defun locate-user-emacs-file (new-name &optional old-name)
2606 "Return an absolute per-user Emacs-specific file name.
2607 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2608 Else return NEW-NAME in `user-emacs-directory', creating the
2609 directory if it does not exist."
2610 (convert-standard-filename
2611 (let* ((home (concat "~" (or init-file-user "")))
2612 (at-home (and old-name (expand-file-name old-name home))))
2613 (if (and at-home (file-readable-p at-home))
2615 ;; Make sure `user-emacs-directory' exists,
2616 ;; unless we're in batch mode or dumping Emacs
2619 (file-accessible-directory-p
2620 (directory-file-name user-emacs-directory))
2621 (let ((umask (default-file-modes)))
2624 (set-default-file-modes ?\700)
2625 (make-directory user-emacs-directory))
2626 (set-default-file-modes umask))))
2627 (abbreviate-file-name
2628 (expand-file-name new-name user-emacs-directory))))))
2630 ;;;; Misc. useful functions.
2632 (defun find-tag-default ()
2633 "Determine default tag to search for, based on text at point.
2634 If there is no plausible default, return nil."
2635 (let (from to bound)
2637 ;; Look at text around `point'.
2639 (skip-syntax-backward "w_") (setq from (point)))
2641 (skip-syntax-forward "w_") (setq to (point)))
2643 ;; Look between `line-beginning-position' and `point'.
2645 (and (setq bound (line-beginning-position))
2646 (skip-syntax-backward "^w_" bound)
2647 (> (setq to (point)) bound)
2648 (skip-syntax-backward "w_")
2649 (setq from (point))))
2650 ;; Look between `point' and `line-end-position'.
2652 (and (setq bound (line-end-position))
2653 (skip-syntax-forward "^w_" bound)
2654 (< (setq from (point)) bound)
2655 (skip-syntax-forward "w_")
2656 (setq to (point)))))
2657 (buffer-substring-no-properties from to))))
2659 (defun play-sound (sound)
2660 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2661 The following keywords are recognized:
2663 :file FILE - read sound data from FILE. If FILE isn't an
2664 absolute file name, it is searched in `data-directory'.
2666 :data DATA - read sound data from string DATA.
2668 Exactly one of :file or :data must be present.
2670 :volume VOL - set volume to VOL. VOL must an integer in the
2671 range 0..100 or a float in the range 0..1.0. If not specified,
2672 don't change the volume setting of the sound device.
2674 :device DEVICE - play sound on DEVICE. If not specified,
2675 a system-dependent default device name is used.
2677 Note: :data and :device are currently not supported on Windows."
2678 (if (fboundp 'play-sound-internal)
2679 (play-sound-internal sound)
2680 (error "This Emacs binary lacks sound support")))
2682 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2684 (defun shell-quote-argument (argument)
2685 "Quote ARGUMENT for passing as argument to an inferior shell."
2687 ((eq system-type 'ms-dos)
2688 ;; Quote using double quotes, but escape any existing quotes in
2689 ;; the argument with backslashes.
2693 (if (or (null (string-match "[^\"]" argument))
2694 (< (match-end 0) (length argument)))
2695 (while (string-match "[\"]" argument start)
2696 (setq end (match-beginning 0)
2697 result (concat result (substring argument start end)
2698 "\\" (substring argument end (1+ end)))
2700 (concat "\"" result (substring argument start) "\"")))
2702 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2704 ;; First, quote argument so that CommandLineToArgvW will
2705 ;; understand it. See
2706 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2707 ;; After we perform that level of quoting, escape shell
2708 ;; metacharacters so that cmd won't mangle our argument. If the
2709 ;; argument contains no double quote characters, we can just
2710 ;; surround it with double quotes. Otherwise, we need to prefix
2711 ;; each shell metacharacter with a caret.
2714 ;; escape backslashes at end of string
2715 (replace-regexp-in-string
2718 ;; escape backslashes and quotes in string body
2719 (replace-regexp-in-string
2724 (if (string-match "[%!\"]" argument)
2727 (replace-regexp-in-string
2728 "\\([%!()\"<>&|^]\\)"
2732 (concat "\"" argument "\"")))
2735 (if (equal argument "")
2737 ;; Quote everything except POSIX filename characters.
2738 ;; This should be safe enough even for really weird shells.
2739 (replace-regexp-in-string
2741 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2744 (defun string-or-null-p (object)
2745 "Return t if OBJECT is a string or nil.
2746 Otherwise, return nil."
2747 (or (stringp object) (null object)))
2749 (defun booleanp (object)
2750 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2751 Otherwise, return nil."
2752 (and (memq object '(nil t)) t))
2754 (defun field-at-pos (pos)
2755 "Return the field at position POS, taking stickiness etc into account."
2756 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2757 (if (eq raw-field 'boundary)
2758 (get-char-property (1- (field-end pos)) 'field)
2761 (defun sha1 (object &optional start end binary)
2762 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2763 OBJECT is either a string or a buffer. Optional arguments START and
2764 END are character positions specifying which portion of OBJECT for
2765 computing the hash. If BINARY is non-nil, return a string in binary
2767 (secure-hash 'sha1 object start end binary))
2770 ;;;; Support for yanking and text properties.
2772 (defvar yank-excluded-properties)
2774 (defun remove-yank-excluded-properties (start end)
2775 "Remove `yank-excluded-properties' between START and END positions.
2776 Replaces `category' properties with their defined properties."
2777 (let ((inhibit-read-only t))
2778 ;; Replace any `category' property with the properties it stands
2779 ;; for. This is to remove `mouse-face' properties that are placed
2780 ;; on categories in *Help* buffers' buttons. See
2781 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2783 (unless (memq yank-excluded-properties '(t nil))
2786 (while (< (point) end)
2787 (let ((cat (get-text-property (point) 'category))
2790 (next-single-property-change (point) 'category nil end))
2792 (let (run-end2 original)
2793 (remove-list-of-text-properties (point) run-end '(category))
2794 (while (< (point) run-end)
2795 (setq run-end2 (next-property-change (point) nil run-end))
2796 (setq original (text-properties-at (point)))
2797 (set-text-properties (point) run-end2 (symbol-plist cat))
2798 (add-text-properties (point) run-end2 original)
2799 (goto-char run-end2))))
2800 (goto-char run-end)))))
2801 (if (eq yank-excluded-properties t)
2802 (set-text-properties start end nil)
2803 (remove-list-of-text-properties start end yank-excluded-properties))))
2805 (defvar yank-undo-function)
2807 (defun insert-for-yank (string)
2808 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2810 See `insert-for-yank-1' for more details."
2812 (while (setq to (next-single-property-change 0 'yank-handler string))
2813 (insert-for-yank-1 (substring string 0 to))
2814 (setq string (substring string to))))
2815 (insert-for-yank-1 string))
2817 (defun insert-for-yank-1 (string)
2818 "Insert STRING at point, stripping some text properties.
2820 Strip text properties from the inserted text according to
2821 `yank-excluded-properties'. Otherwise just like (insert STRING).
2823 If STRING has a non-nil `yank-handler' property on the first character,
2824 the normal insert behavior is modified in various ways. The value of
2825 the yank-handler property must be a list with one to four elements
2826 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2827 When FUNCTION is present and non-nil, it is called instead of `insert'
2828 to insert the string. FUNCTION takes one argument--the object to insert.
2829 If PARAM is present and non-nil, it replaces STRING as the object
2830 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2831 `yank-rectangle', PARAM may be a list of strings to insert as a
2833 If NOEXCLUDE is present and non-nil, the normal removal of the
2834 `yank-excluded-properties' is not performed; instead FUNCTION is
2835 responsible for removing those properties. This may be necessary
2836 if FUNCTION adjusts point before or after inserting the object.
2837 If UNDO is present and non-nil, it is a function that will be called
2838 by `yank-pop' to undo the insertion of the current object. It is
2839 called with two arguments, the start and end of the current region.
2840 FUNCTION may set `yank-undo-function' to override the UNDO value."
2841 (let* ((handler (and (stringp string)
2842 (get-text-property 0 'yank-handler string)))
2843 (param (or (nth 1 handler) string))
2845 (inhibit-read-only inhibit-read-only)
2848 (setq yank-undo-function t)
2849 (if (nth 0 handler) ;; FUNCTION
2850 (funcall (car handler) param)
2854 ;; Prevent read-only properties from interfering with the
2855 ;; following text property changes.
2856 (setq inhibit-read-only t)
2858 ;; What should we do with `font-lock-face' properties?
2859 (if font-lock-defaults
2860 ;; No, just wipe them.
2861 (remove-list-of-text-properties opoint end '(font-lock-face))
2862 ;; Convert them to `face'.
2865 (while (< (point) end)
2866 (let ((face (get-text-property (point) 'font-lock-face))
2869 (next-single-property-change (point) 'font-lock-face nil end))
2871 (remove-text-properties (point) run-end '(font-lock-face nil))
2872 (put-text-property (point) run-end 'face face))
2873 (goto-char run-end)))))
2875 (unless (nth 2 handler) ;; NOEXCLUDE
2876 (remove-yank-excluded-properties opoint (point)))
2878 ;; If last inserted char has properties, mark them as rear-nonsticky.
2879 (if (and (> end opoint)
2880 (text-properties-at (1- end)))
2881 (put-text-property (1- end) end 'rear-nonsticky t))
2883 (if (eq yank-undo-function t) ;; not set by FUNCTION
2884 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2885 (if (nth 4 handler) ;; COMMAND
2886 (setq this-command (nth 4 handler)))))
2888 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2889 "Insert before point a substring of BUFFER, without text properties.
2890 BUFFER may be a buffer or a buffer name.
2891 Arguments START and END are character positions specifying the substring.
2892 They default to the values of (point-min) and (point-max) in BUFFER."
2893 (let ((opoint (point)))
2894 (insert-buffer-substring buffer start end)
2895 (let ((inhibit-read-only t))
2896 (set-text-properties opoint (point) nil))))
2898 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2899 "Insert before point a part of BUFFER, stripping some text properties.
2900 BUFFER may be a buffer or a buffer name.
2901 Arguments START and END are character positions specifying the substring.
2902 They default to the values of (point-min) and (point-max) in BUFFER.
2903 Strip text properties from the inserted text according to
2904 `yank-excluded-properties'."
2905 ;; Since the buffer text should not normally have yank-handler properties,
2906 ;; there is no need to handle them here.
2907 (let ((opoint (point)))
2908 (insert-buffer-substring buffer start end)
2909 (remove-yank-excluded-properties opoint (point))))
2912 ;;;; Synchronous shell commands.
2914 (defun start-process-shell-command (name buffer &rest args)
2915 "Start a program in a subprocess. Return the process object for it.
2916 NAME is name for process. It is modified if necessary to make it unique.
2917 BUFFER is the buffer (or buffer name) to associate with the process.
2918 Process output goes at end of that buffer, unless you specify
2919 an output stream or filter function to handle the output.
2920 BUFFER may be also nil, meaning that this process is not associated
2922 COMMAND is the shell command to run.
2924 An old calling convention accepted any number of arguments after COMMAND,
2925 which were just concatenated to COMMAND. This is still supported but strongly
2927 ;; We used to use `exec' to replace the shell with the command,
2928 ;; but that failed to handle (...) and semicolon, etc.
2929 (start-process name buffer shell-file-name shell-command-switch
2930 (mapconcat 'identity args " ")))
2931 (set-advertised-calling-convention 'start-process-shell-command
2932 '(name buffer command) "23.1")
2934 (defun start-file-process-shell-command (name buffer &rest args)
2935 "Start a program in a subprocess. Return the process object for it.
2936 Similar to `start-process-shell-command', but calls `start-file-process'."
2939 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2940 (if (file-remote-p default-directory) "-c" shell-command-switch)
2941 (mapconcat 'identity args " ")))
2942 (set-advertised-calling-convention 'start-file-process-shell-command
2943 '(name buffer command) "23.1")
2945 (defun call-process-shell-command (command &optional infile buffer display
2947 "Execute the shell command COMMAND synchronously in separate process.
2948 The remaining arguments are optional.
2949 The program's input comes from file INFILE (nil means `/dev/null').
2950 Insert output in BUFFER before point; t means current buffer;
2951 nil for BUFFER means discard it; 0 means discard and don't wait.
2952 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2953 REAL-BUFFER says what to do with standard output, as above,
2954 while STDERR-FILE says what to do with standard error in the child.
2955 STDERR-FILE may be nil (discard standard error output),
2956 t (mix it with ordinary output), or a file name string.
2958 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2959 Remaining arguments are strings passed as additional arguments for COMMAND.
2960 Wildcards and redirection are handled as usual in the shell.
2962 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2963 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2964 status or a signal description string.
2965 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2966 ;; We used to use `exec' to replace the shell with the command,
2967 ;; but that failed to handle (...) and semicolon, etc.
2968 (call-process shell-file-name
2969 infile buffer display
2970 shell-command-switch
2971 (mapconcat 'identity (cons command args) " ")))
2973 (defun process-file-shell-command (command &optional infile buffer display
2975 "Process files synchronously in a separate process.
2976 Similar to `call-process-shell-command', but calls `process-file'."
2978 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2979 infile buffer display
2980 (if (file-remote-p default-directory) "-c" shell-command-switch)
2981 (mapconcat 'identity (cons command args) " ")))
2983 ;;;; Lisp macros to do various things temporarily.
2985 (defmacro with-current-buffer (buffer-or-name &rest body)
2986 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2987 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2988 The value returned is the value of the last form in BODY. See
2989 also `with-temp-buffer'."
2990 (declare (indent 1) (debug t))
2991 `(save-current-buffer
2992 (set-buffer ,buffer-or-name)
2995 (defmacro with-selected-window (window &rest body)
2996 "Execute the forms in BODY with WINDOW as the selected window.
2997 The value returned is the value of the last form in BODY.
2999 This macro saves and restores the selected window, as well as the
3000 selected window of each frame. It does not change the order of
3001 recently selected windows. If the previously selected window of
3002 some frame is no longer live at the end of BODY, that frame's
3003 selected window is left alone. If the selected window is no
3004 longer live, then whatever window is selected at the end of BODY
3007 This macro uses `save-current-buffer' to save and restore the
3008 current buffer, since otherwise its normal operation could
3009 potentially make a different buffer current. It does not alter
3010 the buffer list ordering."
3011 (declare (indent 1) (debug t))
3012 ;; Most of this code is a copy of save-selected-window.
3013 `(let* ((save-selected-window-destination ,window)
3014 (save-selected-window-frame
3015 (window-frame save-selected-window-destination))
3016 (save-selected-window-window (selected-window))
3017 ;; Selecting a window on another frame also changes that
3018 ;; frame's frame-selected-window. We must save&restore it.
3019 (save-selected-window-other-frame
3020 (unless (eq (selected-frame) save-selected-window-frame)
3021 (frame-selected-window save-selected-window-frame)))
3022 (save-selected-window-top-frame
3023 (unless (eq (selected-frame) save-selected-window-frame)
3024 (tty-top-frame save-selected-window-frame))))
3025 (save-current-buffer
3027 (progn (select-window save-selected-window-destination 'norecord)
3029 ;; First reset frame-selected-window.
3030 (when (window-live-p save-selected-window-other-frame)
3031 ;; We don't use set-frame-selected-window because it does not
3032 ;; pass the `norecord' argument to Fselect_window.
3033 (select-window save-selected-window-other-frame 'norecord)
3034 (and (frame-live-p save-selected-window-top-frame)
3035 (not (eq (tty-top-frame) save-selected-window-top-frame))
3036 (select-frame save-selected-window-top-frame 'norecord)))
3037 ;; Then reset the actual selected-window.
3038 (when (window-live-p save-selected-window-window)
3039 (select-window save-selected-window-window 'norecord))))))
3041 (defmacro with-selected-frame (frame &rest body)
3042 "Execute the forms in BODY with FRAME as the selected frame.
3043 The value returned is the value of the last form in BODY.
3045 This macro saves and restores the selected frame, and changes the
3046 order of neither the recently selected windows nor the buffers in
3048 (declare (indent 1) (debug t))
3049 (let ((old-frame (make-symbol "old-frame"))
3050 (old-buffer (make-symbol "old-buffer")))
3051 `(let ((,old-frame (selected-frame))
3052 (,old-buffer (current-buffer)))
3054 (progn (select-frame ,frame 'norecord)
3056 (when (frame-live-p ,old-frame)
3057 (select-frame ,old-frame 'norecord))
3058 (when (buffer-live-p ,old-buffer)
3059 (set-buffer ,old-buffer))))))
3061 (defmacro save-window-excursion (&rest body)
3062 "Execute BODY, then restore previous window configuration.
3063 This macro saves the window configuration on the selected frame,
3064 executes BODY, then calls `set-window-configuration' to restore
3065 the saved window configuration. The return value is the last
3066 form in BODY. The window configuration is also restored if BODY
3069 BEWARE: Most uses of this macro introduce bugs.
3070 E.g. it should not be used to try and prevent some code from opening
3071 a new window, since that window may sometimes appear in another frame,
3072 in which case `save-window-excursion' cannot help."
3073 (declare (indent 0) (debug t))
3074 (let ((c (make-symbol "wconfig")))
3075 `(let ((,c (current-window-configuration)))
3076 (unwind-protect (progn ,@body)
3077 (set-window-configuration ,c)))))
3079 (defmacro with-output-to-temp-buffer (bufname &rest body)
3080 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3082 This construct makes buffer BUFNAME empty before running BODY.
3083 It does not make the buffer current for BODY.
3084 Instead it binds `standard-output' to that buffer, so that output
3085 generated with `prin1' and similar functions in BODY goes into
3088 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3089 it in a window, but does not select it. The normal way to do this is
3090 by calling `display-buffer', then running `temp-buffer-show-hook'.
3091 However, if `temp-buffer-show-function' is non-nil, it calls that
3092 function instead (and does not run `temp-buffer-show-hook'). The
3093 function gets one argument, the buffer to display.
3095 The return value of `with-output-to-temp-buffer' is the value of the
3096 last form in BODY. If BODY does not finish normally, the buffer
3097 BUFNAME is not displayed.
3099 This runs the hook `temp-buffer-setup-hook' before BODY,
3100 with the buffer BUFNAME temporarily current. It runs the hook
3101 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3102 buffer temporarily current, and the window that was used to display it
3103 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3104 if it uses `temp-buffer-show-function'."
3106 (let ((old-dir (make-symbol "old-dir"))
3107 (buf (make-symbol "buf")))
3108 `(let* ((,old-dir default-directory)
3110 (with-current-buffer (get-buffer-create ,bufname)
3111 (prog1 (current-buffer)
3112 (kill-all-local-variables)
3113 ;; FIXME: delete_all_overlays
3114 (setq default-directory ,old-dir)
3115 (setq buffer-read-only nil)
3116 (setq buffer-file-name nil)
3117 (setq buffer-undo-list t)
3118 (let ((inhibit-read-only t)
3119 (inhibit-modification-hooks t))
3121 (run-hooks 'temp-buffer-setup-hook)))))
3122 (standard-output ,buf))
3123 (prog1 (progn ,@body)
3124 (internal-temp-output-buffer-show ,buf)))))
3126 (defmacro with-temp-file (file &rest body)
3127 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3128 The value returned is the value of the last form in BODY.
3129 See also `with-temp-buffer'."
3130 (declare (indent 1) (debug t))
3131 (let ((temp-file (make-symbol "temp-file"))
3132 (temp-buffer (make-symbol "temp-buffer")))
3133 `(let ((,temp-file ,file)
3135 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3138 (with-current-buffer ,temp-buffer
3140 (with-current-buffer ,temp-buffer
3141 (write-region nil nil ,temp-file nil 0)))
3142 (and (buffer-name ,temp-buffer)
3143 (kill-buffer ,temp-buffer))))))
3145 (defmacro with-temp-message (message &rest body)
3146 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3147 The original message is restored to the echo area after BODY has finished.
3148 The value returned is the value of the last form in BODY.
3149 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3150 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3151 Use a MESSAGE of \"\" to temporarily clear the echo area."
3152 (declare (debug t) (indent 1))
3153 (let ((current-message (make-symbol "current-message"))
3154 (temp-message (make-symbol "with-temp-message")))
3155 `(let ((,temp-message ,message)
3160 (setq ,current-message (current-message))
3161 (message "%s" ,temp-message))
3164 (if ,current-message
3165 (message "%s" ,current-message)
3168 (defmacro with-temp-buffer (&rest body)
3169 "Create a temporary buffer, and evaluate BODY there like `progn'.
3170 See also `with-temp-file' and `with-output-to-string'."
3171 (declare (indent 0) (debug t))
3172 (let ((temp-buffer (make-symbol "temp-buffer")))
3173 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3174 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3175 (with-current-buffer ,temp-buffer
3178 (and (buffer-name ,temp-buffer)
3179 (kill-buffer ,temp-buffer)))))))
3181 (defmacro with-silent-modifications (&rest body)
3182 "Execute BODY, pretending it does not modify the buffer.
3183 If BODY performs real modifications to the buffer's text, other
3184 than cosmetic ones, undo data may become corrupted.
3186 This macro will run BODY normally, but doesn't count its buffer
3187 modifications as being buffer modifications. This affects things
3188 like buffer-modified-p, checking whether the file is locked by
3189 someone else, running buffer modification hooks, and other things
3192 Typically used around modifications of text-properties which do
3193 not really affect the buffer's content."
3194 (declare (debug t) (indent 0))
3195 (let ((modified (make-symbol "modified")))
3196 `(let* ((,modified (buffer-modified-p))
3197 (buffer-undo-list t)
3198 (inhibit-read-only t)
3199 (inhibit-modification-hooks t)
3201 ;; Avoid setting and removing file locks and checking
3202 ;; buffer's uptodate-ness w.r.t the underlying file.
3204 buffer-file-truename)
3209 (restore-buffer-modified-p nil))))))
3211 (defmacro with-output-to-string (&rest body)
3212 "Execute BODY, return the text it sent to `standard-output', as a string."
3213 (declare (indent 0) (debug t))
3214 `(let ((standard-output
3215 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3218 (let ((standard-output standard-output))
3220 (with-current-buffer standard-output
3222 (kill-buffer standard-output))))
3224 (defmacro with-local-quit (&rest body)
3225 "Execute BODY, allowing quits to terminate BODY but not escape further.
3226 When a quit terminates BODY, `with-local-quit' returns nil but
3227 requests another quit. That quit will be processed as soon as quitting
3228 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3229 (declare (debug t) (indent 0))
3230 `(condition-case nil
3231 (let ((inhibit-quit nil))
3233 (quit (setq quit-flag t)
3234 ;; This call is to give a chance to handle quit-flag
3235 ;; in case inhibit-quit is nil.
3236 ;; Without this, it will not be handled until the next function
3237 ;; call, and that might allow it to exit thru a condition-case
3238 ;; that intends to handle the quit signal next time.
3239 (eval '(ignore nil)))))
3241 (defmacro while-no-input (&rest body)
3242 "Execute BODY only as long as there's no pending input.
3243 If input arrives, that ends the execution of BODY,
3244 and `while-no-input' returns t. Quitting makes it return nil.
3245 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3246 (declare (debug t) (indent 0))
3247 (let ((catch-sym (make-symbol "input")))
3250 (let ((throw-on-input ',catch-sym))
3251 (or (input-pending-p)
3252 (progn ,@body)))))))
3254 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3255 "Like `condition-case' except that it does not catch anything when debugging.
3256 More specifically if `debug-on-error' is set, then it does not catch any signal."
3257 (declare (debug condition-case) (indent 2))
3258 (let ((bodysym (make-symbol "body")))
3259 `(let ((,bodysym (lambda () ,bodyform)))
3262 (condition-case ,var
3266 (define-obsolete-function-alias 'condition-case-no-debug
3267 'condition-case-unless-debug "24.1")
3269 (defmacro with-demoted-errors (&rest body)
3270 "Run BODY and demote any errors to simple messages.
3271 If `debug-on-error' is non-nil, run BODY without catching its errors.
3272 This is to be used around code which is not expected to signal an error
3273 but which should be robust in the unexpected case that an error is signaled."
3274 (declare (debug t) (indent 0))
3275 (let ((err (make-symbol "err")))
3276 `(condition-case-unless-debug ,err
3278 (error (message "Error: %S" ,err) nil))))
3280 (defmacro combine-after-change-calls (&rest body)
3281 "Execute BODY, but don't call the after-change functions till the end.
3282 If BODY makes changes in the buffer, they are recorded
3283 and the functions on `after-change-functions' are called several times
3284 when BODY is finished.
3285 The return value is the value of the last form in BODY.
3287 If `before-change-functions' is non-nil, then calls to the after-change
3288 functions can't be deferred, so in that case this macro has no effect.
3290 Do not alter `after-change-functions' or `before-change-functions'
3292 (declare (indent 0) (debug t))
3294 (let ((combine-after-change-calls t))
3296 (combine-after-change-execute)))
3298 (defmacro with-case-table (table &rest body)
3299 "Execute the forms in BODY with TABLE as the current case table.
3300 The value returned is the value of the last form in BODY."
3301 (declare (indent 1) (debug t))
3302 (let ((old-case-table (make-symbol "table"))
3303 (old-buffer (make-symbol "buffer")))
3304 `(let ((,old-case-table (current-case-table))
3305 (,old-buffer (current-buffer)))
3307 (progn (set-case-table ,table)
3309 (with-current-buffer ,old-buffer
3310 (set-case-table ,old-case-table))))))
3312 ;;; Matching and match data.
3314 (defvar save-match-data-internal)
3316 ;; We use save-match-data-internal as the local variable because
3317 ;; that works ok in practice (people should not use that variable elsewhere).
3318 ;; We used to use an uninterned symbol; the compiler handles that properly
3319 ;; now, but it generates slower code.
3320 (defmacro save-match-data (&rest body)
3321 "Execute the BODY forms, restoring the global value of the match data.
3322 The value returned is the value of the last form in BODY."
3323 ;; It is better not to use backquote here,
3324 ;; because that makes a bootstrapping problem
3325 ;; if you need to recompile all the Lisp files using interpreted code.
3326 (declare (indent 0) (debug t))
3328 '((save-match-data-internal (match-data)))
3329 (list 'unwind-protect
3331 ;; It is safe to free (evaporate) markers immediately here,
3332 ;; as Lisp programs should not copy from save-match-data-internal.
3333 '(set-match-data save-match-data-internal 'evaporate))))
3335 (defun match-string (num &optional string)
3336 "Return string of text matched by last search.
3337 NUM specifies which parenthesized expression in the last regexp.
3338 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3339 Zero means the entire text matched by the whole regexp or whole string.
3340 STRING should be given if the last search was by `string-match' on STRING.
3341 If STRING is nil, the current buffer should be the same buffer
3342 the search/match was performed in."
3343 (if (match-beginning num)
3345 (substring string (match-beginning num) (match-end num))
3346 (buffer-substring (match-beginning num) (match-end num)))))
3348 (defun match-string-no-properties (num &optional string)
3349 "Return string of text matched by last search, without text properties.
3350 NUM specifies which parenthesized expression in the last regexp.
3351 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3352 Zero means the entire text matched by the whole regexp or whole string.
3353 STRING should be given if the last search was by `string-match' on STRING.
3354 If STRING is nil, the current buffer should be the same buffer
3355 the search/match was performed in."
3356 (if (match-beginning num)
3358 (substring-no-properties string (match-beginning num)
3360 (buffer-substring-no-properties (match-beginning num)
3364 (defun match-substitute-replacement (replacement
3365 &optional fixedcase literal string subexp)
3366 "Return REPLACEMENT as it will be inserted by `replace-match'.
3367 In other words, all back-references in the form `\\&' and `\\N'
3368 are substituted with actual strings matched by the last search.
3369 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3370 meaning as for `replace-match'."
3371 (let ((match (match-string 0 string)))
3373 (set-match-data (mapcar (lambda (x)
3375 (- x (match-beginning 0))
3378 (replace-match replacement fixedcase literal match subexp))))
3381 (defun looking-back (regexp &optional limit greedy)
3382 "Return non-nil if text before point matches regular expression REGEXP.
3383 Like `looking-at' except matches before point, and is slower.
3384 LIMIT if non-nil speeds up the search by specifying a minimum
3385 starting position, to avoid checking matches that would start
3388 If GREEDY is non-nil, extend the match backwards as far as
3389 possible, stopping when a single additional previous character
3390 cannot be part of a match for REGEXP. When the match is
3391 extended, its starting position is allowed to occur before
3393 (let ((start (point))
3396 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3398 (if (and greedy pos)
3400 (narrow-to-region (point-min) start)
3401 (while (and (> pos (point-min))
3405 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3406 (setq pos (1- pos)))
3409 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3412 (defsubst looking-at-p (regexp)
3414 Same as `looking-at' except this function does not change the match data."
3415 (let ((inhibit-changing-match-data t))
3416 (looking-at regexp)))
3418 (defsubst string-match-p (regexp string &optional start)
3420 Same as `string-match' except this function does not change the match data."
3421 (let ((inhibit-changing-match-data t))
3422 (string-match regexp string start)))
3424 (defun subregexp-context-p (regexp pos &optional start)
3425 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3426 A subregexp context is one where a sub-regexp can appear.
3427 A non-subregexp context is for example within brackets, or within a
3428 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3429 If START is non-nil, it should be a position in REGEXP, smaller
3430 than POS, and known to be in a subregexp context."
3431 ;; Here's one possible implementation, with the great benefit that it
3432 ;; reuses the regexp-matcher's own parser, so it understands all the
3433 ;; details of the syntax. A disadvantage is that it needs to match the
3437 (string-match (substring regexp (or start 0) pos) "")
3440 (not (member (cadr err) '("Unmatched [ or [^"
3442 "Trailing backslash")))))
3443 ;; An alternative implementation:
3444 ;; (defconst re-context-re
3445 ;; (let* ((harmless-ch "[^\\[]")
3446 ;; (harmless-esc "\\\\[^{]")
3447 ;; (class-harmless-ch "[^][]")
3448 ;; (class-lb-harmless "[^]:]")
3449 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3450 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3451 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3453 ;; (concat "\\[^?]?"
3454 ;; "\\(" class-harmless-ch
3455 ;; "\\|" class-lb "\\)*"
3456 ;; "\\[?]")) ; special handling for bare [ at end of re
3457 ;; (braces "\\\\{[0-9,]+\\\\}"))
3458 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3459 ;; "\\|" class "\\|" braces "\\)*\\'"))
3460 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3461 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3466 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3467 "The default value of separators for `split-string'.
3469 A regexp matching strings of whitespace. May be locale-dependent
3470 \(as yet unimplemented). Should not match non-breaking spaces.
3472 Warning: binding this to a different value and using it as default is
3473 likely to have undesired semantics.")
3475 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3476 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3477 ;; expression leads to the equivalent implementation that if SEPARATORS
3478 ;; is defaulted, OMIT-NULLS is treated as t.
3479 (defun split-string (string &optional separators omit-nulls)
3480 "Split STRING into substrings bounded by matches for SEPARATORS.
3482 The beginning and end of STRING, and each match for SEPARATORS, are
3483 splitting points. The substrings matching SEPARATORS are removed, and
3484 the substrings between the splitting points are collected as a list,
3487 If SEPARATORS is non-nil, it should be a regular expression matching text
3488 which separates, but is not part of, the substrings. If nil it defaults to
3489 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3490 OMIT-NULLS is forced to t.
3492 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3493 that for the default value of SEPARATORS leading and trailing whitespace
3494 are effectively trimmed). If nil, all zero-length substrings are retained,
3495 which correctly parses CSV format, for example.
3497 Note that the effect of `(split-string STRING)' is the same as
3498 `(split-string STRING split-string-default-separators t)'. In the rare
3499 case that you wish to retain zero-length substrings when splitting on
3500 whitespace, use `(split-string STRING split-string-default-separators)'.
3502 Modifies the match data; use `save-match-data' if necessary."
3503 (let ((keep-nulls (not (if separators omit-nulls t)))
3504 (rexp (or separators split-string-default-separators))
3508 (while (and (string-match rexp string
3510 (= start (match-beginning 0))
3511 (< start (length string)))
3513 (< start (length string)))
3515 (if (or keep-nulls (< start (match-beginning 0)))
3517 (cons (substring string start (match-beginning 0))
3519 (setq start (match-end 0)))
3520 (if (or keep-nulls (< start (length string)))
3522 (cons (substring string start)
3526 (defun combine-and-quote-strings (strings &optional separator)
3527 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3528 This tries to quote the strings to avoid ambiguity such that
3529 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3530 Only some SEPARATORs will work properly."
3531 (let* ((sep (or separator " "))
3532 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3535 (if (string-match re str)
3536 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3540 (defun split-string-and-unquote (string &optional separator)
3541 "Split the STRING into a list of strings.
3542 It understands Emacs Lisp quoting within STRING, such that
3543 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3544 The SEPARATOR regexp defaults to \"\\s-+\"."
3545 (let ((sep (or separator "\\s-+"))
3546 (i (string-match "\"" string)))
3548 (split-string string sep t) ; no quoting: easy
3549 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3550 (let ((rfs (read-from-string string i)))
3552 (split-string-and-unquote (substring string (cdr rfs))
3556 ;;;; Replacement in strings.
3558 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3559 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3560 Unless optional argument INPLACE is non-nil, return a new string."
3561 (let ((i (length string))
3562 (newstr (if inplace string (copy-sequence string))))
3565 (if (eq (aref newstr i) fromchar)
3566 (aset newstr i tochar)))
3569 (defun replace-regexp-in-string (regexp rep string &optional
3570 fixedcase literal subexp start)
3571 "Replace all matches for REGEXP with REP in STRING.
3573 Return a new string containing the replacements.
3575 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3576 arguments with the same names of function `replace-match'. If START
3577 is non-nil, start replacements at that index in STRING.
3579 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3580 function. If it is a function, it is called with the actual text of each
3581 match, and its value is used as the replacement text. When REP is called,
3582 the match data are the result of matching REGEXP against a substring
3585 To replace only the first match (if any), make REGEXP match up to \\'
3586 and replace a sub-expression, e.g.
3587 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3590 ;; To avoid excessive consing from multiple matches in long strings,
3591 ;; don't just call `replace-match' continually. Walk down the
3592 ;; string looking for matches of REGEXP and building up a (reversed)
3593 ;; list MATCHES. This comprises segments of STRING which weren't
3594 ;; matched interspersed with replacements for segments that were.
3595 ;; [For a `large' number of replacements it's more efficient to
3596 ;; operate in a temporary buffer; we can't tell from the function's
3597 ;; args whether to choose the buffer-based implementation, though it
3598 ;; might be reasonable to do so for long enough STRING.]
3599 (let ((l (length string))
3600 (start (or start 0))
3603 (while (and (< start l) (string-match regexp string start))
3604 (setq mb (match-beginning 0)
3606 ;; If we matched the empty string, make sure we advance by one char
3607 (when (= me mb) (setq me (min l (1+ mb))))
3608 ;; Generate a replacement for the matched substring.
3609 ;; Operate only on the substring to minimize string consing.
3610 ;; Set up match data for the substring for replacement;
3611 ;; presumably this is likely to be faster than munging the
3612 ;; match data directly in Lisp.
3613 (string-match regexp (setq str (substring string mb me)))
3615 (cons (replace-match (if (stringp rep)
3617 (funcall rep (match-string 0 str)))
3618 fixedcase literal str subexp)
3619 (cons (substring string start mb) ; unmatched prefix
3622 ;; Reconstruct a string from the pieces.
3623 (setq matches (cons (substring string start l) matches)) ; leftover
3624 (apply #'concat (nreverse matches)))))
3626 (defun string-prefix-p (str1 str2 &optional ignore-case)
3627 "Return non-nil if STR1 is a prefix of STR2.
3628 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3629 to case differences."
3630 (eq t (compare-strings str1 nil nil
3631 str2 0 (length str1) ignore-case)))
3633 (defun bidi-string-mark-left-to-right (str)
3634 "Return a string that can be safely inserted in left-to-right text.
3636 Normally, inserting a string with right-to-left (RTL) script into
3637 a buffer may cause some subsequent text to be displayed as part
3638 of the RTL segment (usually this affects punctuation characters).
3639 This function returns a string which displays as STR but forces
3640 subsequent text to be displayed as left-to-right.
3642 If STR contains any RTL character, this function returns a string
3643 consisting of STR followed by an invisible left-to-right mark
3644 \(LRM) character. Otherwise, it returns STR."
3645 (unless (stringp str)
3646 (signal 'wrong-type-argument (list 'stringp str)))
3647 (if (string-match "\\cR" str)
3648 (concat str (propertize (string ?\x200e) 'invisible t))
3651 ;;;; invisibility specs
3653 (defun add-to-invisibility-spec (element)
3654 "Add ELEMENT to `buffer-invisibility-spec'.
3655 See documentation for `buffer-invisibility-spec' for the kind of elements
3657 (if (eq buffer-invisibility-spec t)
3658 (setq buffer-invisibility-spec (list t)))
3659 (setq buffer-invisibility-spec
3660 (cons element buffer-invisibility-spec)))
3662 (defun remove-from-invisibility-spec (element)
3663 "Remove ELEMENT from `buffer-invisibility-spec'."
3664 (if (consp buffer-invisibility-spec)
3665 (setq buffer-invisibility-spec
3666 (delete element buffer-invisibility-spec))))
3670 (defmacro with-syntax-table (table &rest body)
3671 "Evaluate BODY with syntax table of current buffer set to TABLE.
3672 The syntax table of the current buffer is saved, BODY is evaluated, and the
3673 saved table is restored, even in case of an abnormal exit.
3674 Value is what BODY returns."
3675 (declare (debug t) (indent 1))
3676 (let ((old-table (make-symbol "table"))
3677 (old-buffer (make-symbol "buffer")))
3678 `(let ((,old-table (syntax-table))
3679 (,old-buffer (current-buffer)))
3682 (set-syntax-table ,table)
3684 (save-current-buffer
3685 (set-buffer ,old-buffer)
3686 (set-syntax-table ,old-table))))))
3688 (defun make-syntax-table (&optional oldtable)
3689 "Return a new syntax table.
3690 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3691 from `standard-syntax-table' otherwise."
3692 (let ((table (make-char-table 'syntax-table nil)))
3693 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3696 (defun syntax-after (pos)
3697 "Return the raw syntax of the char after POS.
3698 If POS is outside the buffer's accessible portion, return nil."
3699 (unless (or (< pos (point-min)) (>= pos (point-max)))
3700 (let ((st (if parse-sexp-lookup-properties
3701 (get-char-property pos 'syntax-table))))
3703 (aref (or st (syntax-table)) (char-after pos))))))
3705 (defun syntax-class (syntax)
3706 "Return the syntax class part of the syntax descriptor SYNTAX.
3707 If SYNTAX is nil, return nil."
3708 (and syntax (logand (car syntax) 65535)))
3712 (defun text-clone-maintain (ol1 after beg end &optional _len)
3713 "Propagate the changes made under the overlay OL1 to the other clones.
3714 This is used on the `modification-hooks' property of text clones."
3715 (when (and after (not undo-in-progress) (overlay-start ol1))
3716 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3717 (setq beg (max beg (+ (overlay-start ol1) margin)))
3718 (setq end (min end (- (overlay-end ol1) margin)))
3721 (when (overlay-get ol1 'text-clone-syntax)
3722 ;; Check content of the clone's text.
3723 (let ((cbeg (+ (overlay-start ol1) margin))
3724 (cend (- (overlay-end ol1) margin)))
3727 (if (not (re-search-forward
3728 (overlay-get ol1 'text-clone-syntax) cend t))
3729 ;; Mark the overlay for deletion.
3730 (overlay-put ol1 'text-clones nil)
3731 (when (< (match-end 0) cend)
3732 ;; Shrink the clone at its end.
3733 (setq end (min end (match-end 0)))
3734 (move-overlay ol1 (overlay-start ol1)
3735 (+ (match-end 0) margin)))
3736 (when (> (match-beginning 0) cbeg)
3737 ;; Shrink the clone at its beginning.
3738 (setq beg (max (match-beginning 0) beg))
3739 (move-overlay ol1 (- (match-beginning 0) margin)
3740 (overlay-end ol1)))))))
3741 ;; Now go ahead and update the clones.
3742 (let ((head (- beg (overlay-start ol1)))
3743 (tail (- (overlay-end ol1) end))
3744 (str (buffer-substring beg end))
3746 (inhibit-modification-hooks t))
3747 (dolist (ol2 (overlay-get ol1 'text-clones))
3748 (let ((oe (overlay-end ol2)))
3749 (unless (or (eq ol1 ol2) (null oe))
3750 (setq nothing-left nil)
3751 (let ((mod-beg (+ (overlay-start ol2) head)))
3752 ;;(overlay-put ol2 'modification-hooks nil)
3753 (goto-char (- (overlay-end ol2) tail))
3754 (unless (> mod-beg (point))
3755 (save-excursion (insert str))
3756 (delete-region mod-beg (point)))
3757 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3759 (if nothing-left (delete-overlay ol1))))))))
3761 (defun text-clone-create (start end &optional spreadp syntax)
3762 "Create a text clone of START...END at point.
3763 Text clones are chunks of text that are automatically kept identical:
3764 changes done to one of the clones will be immediately propagated to the other.
3766 The buffer's content at point is assumed to be already identical to
3767 the one between START and END.
3768 If SYNTAX is provided it's a regexp that describes the possible text of
3769 the clones; the clone will be shrunk or killed if necessary to ensure that
3770 its text matches the regexp.
3771 If SPREADP is non-nil it indicates that text inserted before/after the
3772 clone should be incorporated in the clone."
3773 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3774 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3775 ;; (with a one-char margin at each end) with `t nil'.
3776 ;; We opted for a larger overlay because it behaves better in the case
3777 ;; where the clone is reduced to the empty string (we want the overlay to
3778 ;; stay when the clone's content is the empty string and we want to use
3779 ;; `evaporate' to make sure those overlays get deleted when needed).
3781 (let* ((pt-end (+ (point) (- end start)))
3782 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3784 (end-margin (if (or (not spreadp)
3785 (>= pt-end (point-max))
3786 (>= start (point-max)))
3788 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3789 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3790 (dups (list ol1 ol2)))
3791 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3792 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3793 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3794 ;;(overlay-put ol1 'face 'underline)
3795 (overlay-put ol1 'evaporate t)
3796 (overlay-put ol1 'text-clones dups)
3798 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3799 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3800 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3801 ;;(overlay-put ol2 'face 'underline)
3802 (overlay-put ol2 'evaporate t)
3803 (overlay-put ol2 'text-clones dups)))
3805 ;;;; Mail user agents.
3807 ;; Here we include just enough for other packages to be able
3810 (defun define-mail-user-agent (symbol composefunc sendfunc
3811 &optional abortfunc hookvar)
3812 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3814 SYMBOL can be any Lisp symbol. Its function definition and/or
3815 value as a variable do not matter for this usage; we use only certain
3816 properties on its property list, to encode the rest of the arguments.
3818 COMPOSEFUNC is program callable function that composes an outgoing
3819 mail message buffer. This function should set up the basics of the
3820 buffer without requiring user interaction. It should populate the
3821 standard mail headers, leaving the `to:' and `subject:' headers blank
3824 COMPOSEFUNC should accept several optional arguments--the same
3825 arguments that `compose-mail' takes. See that function's documentation.
3827 SENDFUNC is the command a user would run to send the message.
3829 Optional ABORTFUNC is the command a user would run to abort the
3830 message. For mail packages that don't have a separate abort function,
3831 this can be `kill-buffer' (the equivalent of omitting this argument).
3833 Optional HOOKVAR is a hook variable that gets run before the message
3834 is actually sent. Callers that use the `mail-user-agent' may
3835 install a hook function temporarily on this hook variable.
3836 If HOOKVAR is nil, `mail-send-hook' is used.
3838 The properties used on SYMBOL are `composefunc', `sendfunc',
3839 `abortfunc', and `hookvar'."
3840 (put symbol 'composefunc composefunc)
3841 (put symbol 'sendfunc sendfunc)
3842 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3843 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3845 (defun set-temporary-overlay-map (map &optional keep-pred)
3846 (let* ((clearfunsym (make-symbol "clear-temporary-overlay-map"))
3847 (overlaysym (make-symbol "t"))
3848 (alist (list (cons overlaysym map)))
3850 ;; FIXME: Use lexical-binding.
3852 (unless ,(cond ((null keep-pred) nil)
3856 (this-command-keys-vector))))
3857 (t `(funcall ',keep-pred)))
3858 (remove-hook 'pre-command-hook ',clearfunsym)
3859 (setq emulation-mode-map-alists
3860 (delq ',alist emulation-mode-map-alists))))))
3861 (set overlaysym overlaysym)
3862 (fset clearfunsym clearfun)
3863 (add-hook 'pre-command-hook clearfunsym)
3864 ;; FIXME: That's the keymaps with highest precedence, except for
3865 ;; the `keymap' text-property ;-(
3866 (push alist emulation-mode-map-alists)))
3868 ;;;; Progress reporters.
3870 ;; Progress reporter has the following structure:
3872 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3879 ;; This weirdness is for optimization reasons: we want
3880 ;; `progress-reporter-update' to be as fast as possible, so
3881 ;; `(car reporter)' is better than `(aref reporter 0)'.
3883 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3884 ;; digits of precision, it doesn't really matter here. On the other
3885 ;; hand, it greatly simplifies the code.
3887 (defsubst progress-reporter-update (reporter &optional value)
3888 "Report progress of an operation in the echo area.
3889 REPORTER should be the result of a call to `make-progress-reporter'.
3891 If REPORTER is a numerical progress reporter---i.e. if it was
3892 made using non-nil MIN-VALUE and MAX-VALUE arguments to
3893 `make-progress-reporter'---then VALUE should be a number between
3894 MIN-VALUE and MAX-VALUE.
3896 If REPORTER is a non-numerical reporter, VALUE should be nil.
3898 This function is relatively inexpensive. If the change since
3899 last update is too small or insufficient time has passed, it does
3901 (when (or (not (numberp value)) ; For pulsing reporter
3902 (>= value (car reporter))) ; For numerical reporter
3903 (progress-reporter-do-update reporter value)))
3905 (defun make-progress-reporter (message &optional min-value max-value
3906 current-value min-change min-time)
3907 "Return progress reporter object for use with `progress-reporter-update'.
3909 MESSAGE is shown in the echo area, with a status indicator
3910 appended to the end. When you call `progress-reporter-done', the
3911 word \"done\" is printed after the MESSAGE. You can change the
3912 MESSAGE of an existing progress reporter by calling
3913 `progress-reporter-force-update'.
3915 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
3916 and final (100% complete) states of operation; the latter should
3917 be larger. In this case, the status message shows the percentage
3920 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
3921 message shows a \"spinning\", non-numeric indicator.
3923 Optional CURRENT-VALUE is the initial progress; the default is
3925 Optional MIN-CHANGE is the minimal change in percents to report;
3927 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
3928 and/or MAX-VALUE are nil.
3930 Optional MIN-TIME specifies the minimum interval time between
3931 echo area updates (default is 0.2 seconds.) If the function
3932 `float-time' is not present, time is not tracked at all. If the
3933 OS is not capable of measuring fractions of seconds, this
3934 parameter is effectively rounded up."
3935 (when (string-match "[[:alnum:]]\\'" message)
3936 (setq message (concat message "...")))
3938 (setq min-time 0.2))
3940 ;; Force a call to `message' now
3941 (cons (or min-value 0)
3942 (vector (if (and (fboundp 'float-time)
3948 (if min-change (max (min min-change 50) 1) 1)
3950 (progress-reporter-update reporter (or current-value min-value))
3953 (defun progress-reporter-force-update (reporter &optional value new-message)
3954 "Report progress of an operation in the echo area unconditionally.
3956 The first two arguments are the same as in `progress-reporter-update'.
3957 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
3958 (let ((parameters (cdr reporter)))
3960 (aset parameters 3 new-message))
3961 (when (aref parameters 0)
3962 (aset parameters 0 (float-time)))
3963 (progress-reporter-do-update reporter value)))
3965 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
3966 "Characters to use for pulsing progress reporters.")
3968 (defun progress-reporter-do-update (reporter value)
3969 (let* ((parameters (cdr reporter))
3970 (update-time (aref parameters 0))
3971 (min-value (aref parameters 1))
3972 (max-value (aref parameters 2))
3973 (text (aref parameters 3))
3974 (current-time (float-time))
3976 ;; See if enough time has passed since the last update.
3977 (or (not update-time)
3978 (when (>= current-time update-time)
3979 ;; Calculate time for the next update
3980 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3981 (cond ((and min-value max-value)
3982 ;; Numerical indicator
3983 (let* ((one-percent (/ (- max-value min-value) 100.0))
3984 (percentage (if (= max-value min-value)
3986 (truncate (/ (- value min-value)
3988 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
3989 ;; message because not enough time has passed, use 1
3990 ;; instead of MIN-CHANGE. This makes delays between echo
3991 ;; area updates closer to MIN-TIME.
3993 (min (+ min-value (* (+ percentage
3994 (if enough-time-passed
4000 (when (integerp value)
4001 (setcar reporter (ceiling (car reporter))))
4002 ;; Only print message if enough time has passed
4003 (when enough-time-passed
4004 (if (> percentage 0)
4005 (message "%s%d%%" text percentage)
4006 (message "%s" text)))))
4007 ;; Pulsing indicator
4009 (let ((index (mod (1+ (car reporter)) 4))
4010 (message-log-max nil))
4011 (setcar reporter index)
4014 (aref progress-reporter--pulse-characters
4017 (defun progress-reporter-done (reporter)
4018 "Print reporter's message followed by word \"done\" in echo area."
4019 (message "%sdone" (aref (cdr reporter) 3)))
4021 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4022 "Loop a certain number of times and report progress in the echo area.
4023 Evaluate BODY with VAR bound to successive integers running from
4024 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4025 the return value (nil if RESULT is omitted).
4027 At each iteration MESSAGE followed by progress percentage is
4028 printed in the echo area. After the loop is finished, MESSAGE
4029 followed by word \"done\" is printed. This macro is a
4030 convenience wrapper around `make-progress-reporter' and friends.
4032 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4033 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4034 (let ((temp (make-symbol "--dotimes-temp--"))
4035 (temp2 (make-symbol "--dotimes-temp2--"))
4039 (,(car spec) ,start)
4040 (,temp2 (make-progress-reporter ,message ,start ,end)))
4041 (while (< ,(car spec) ,temp)
4043 (progress-reporter-update ,temp2
4044 (setq ,(car spec) (1+ ,(car spec)))))
4045 (progress-reporter-done ,temp2)
4046 nil ,@(cdr (cdr spec)))))
4049 ;;;; Comparing version strings.
4051 (defconst version-separator "."
4052 "Specify the string used to separate the version elements.
4054 Usually the separator is \".\", but it can be any other string.")
4057 (defconst version-regexp-alist
4058 '(("^[-_+ ]?alpha$" . -3)
4059 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
4060 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
4061 ("^[-_+ ]?beta$" . -2)
4062 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
4063 "Specify association between non-numeric version and its priority.
4065 This association is used to handle version string like \"1.0pre2\",
4066 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4067 non-numeric part of a version string to an integer. For example:
4069 String Version Integer List Version
4070 \"1.0pre2\" (1 0 -1 2)
4071 \"1.0PRE2\" (1 0 -1 2)
4072 \"22.8beta3\" (22 8 -2 3)
4073 \"22.8 Beta3\" (22 8 -2 3)
4074 \"0.9alpha1\" (0 9 -3 1)
4075 \"0.9AlphA1\" (0 9 -3 1)
4076 \"0.9 alpha\" (0 9 -3)
4078 Each element has the following form:
4084 REGEXP regexp used to match non-numeric part of a version string.
4085 It should begin with the `^' anchor and end with a `$' to
4086 prevent false hits. Letter-case is ignored while matching
4089 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4092 (defun version-to-list (ver)
4093 "Convert version string VER into a list of integers.
4095 The version syntax is given by the following EBNF:
4097 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4099 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4101 SEPARATOR ::= `version-separator' (which see)
4102 | `version-regexp-alist' (which see).
4104 The NUMBER part is optional if SEPARATOR is a match for an element
4105 in `version-regexp-alist'.
4107 Examples of valid version syntax:
4109 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4111 Examples of invalid version syntax:
4113 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4115 Examples of version conversion:
4117 Version String Version as a List of Integers
4118 \"1.0.7.5\" (1 0 7 5)
4119 \"1.0pre2\" (1 0 -1 2)
4120 \"1.0PRE2\" (1 0 -1 2)
4121 \"22.8beta3\" (22 8 -2 3)
4122 \"22.8Beta3\" (22 8 -2 3)
4123 \"0.9alpha1\" (0 9 -3 1)
4124 \"0.9AlphA1\" (0 9 -3 1)
4125 \"0.9alpha\" (0 9 -3)
4127 See documentation for `version-separator' and `version-regexp-alist'."
4128 (or (and (stringp ver) (> (length ver) 0))
4129 (error "Invalid version string: '%s'" ver))
4130 ;; Change .x.y to 0.x.y
4131 (if (and (>= (length ver) (length version-separator))
4132 (string-equal (substring ver 0 (length version-separator))
4134 (setq ver (concat "0" ver)))
4137 (case-fold-search t) ; ignore case in matching
4139 (while (and (setq s (string-match "[0-9]+" ver i))
4141 ;; handle numeric part
4142 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4145 ;; handle non-numeric part
4146 (when (and (setq s (string-match "[^0-9]+" ver i))
4148 (setq s (substring ver i (match-end 0))
4150 ;; handle alpha, beta, pre, etc. separator
4151 (unless (string= s version-separator)
4152 (setq al version-regexp-alist)
4153 (while (and al (not (string-match (caar al) s)))
4156 (push (cdar al) lst))
4157 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4158 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4159 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4161 (t (error "Invalid version syntax: '%s'" ver))))))
4163 (error "Invalid version syntax: '%s'" ver)
4167 (defun version-list-< (l1 l2)
4168 "Return t if L1, a list specification of a version, is lower than L2.
4170 Note that a version specified by the list (1) is equal to (1 0),
4171 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4172 Also, a version given by the list (1) is higher than (1 -1), which in
4173 turn is higher than (1 -2), which is higher than (1 -3)."
4174 (while (and l1 l2 (= (car l1) (car l2)))
4178 ;; l1 not null and l2 not null
4179 ((and l1 l2) (< (car l1) (car l2)))
4180 ;; l1 null and l2 null ==> l1 length = l2 length
4181 ((and (null l1) (null l2)) nil)
4182 ;; l1 not null and l2 null ==> l1 length > l2 length
4183 (l1 (< (version-list-not-zero l1) 0))
4184 ;; l1 null and l2 not null ==> l2 length > l1 length
4185 (t (< 0 (version-list-not-zero l2)))))
4188 (defun version-list-= (l1 l2)
4189 "Return t if L1, a list specification of a version, is equal to L2.
4191 Note that a version specified by the list (1) is equal to (1 0),
4192 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4193 Also, a version given by the list (1) is higher than (1 -1), which in
4194 turn is higher than (1 -2), which is higher than (1 -3)."
4195 (while (and l1 l2 (= (car l1) (car l2)))
4199 ;; l1 not null and l2 not null
4201 ;; l1 null and l2 null ==> l1 length = l2 length
4202 ((and (null l1) (null l2)))
4203 ;; l1 not null and l2 null ==> l1 length > l2 length
4204 (l1 (zerop (version-list-not-zero l1)))
4205 ;; l1 null and l2 not null ==> l2 length > l1 length
4206 (t (zerop (version-list-not-zero l2)))))
4209 (defun version-list-<= (l1 l2)
4210 "Return t if L1, a list specification of a version, is lower or equal to L2.
4212 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4213 etc. That is, the trailing zeroes are insignificant. Also, integer
4214 list (1) is greater than (1 -1) which is greater than (1 -2)
4215 which is greater than (1 -3)."
4216 (while (and l1 l2 (= (car l1) (car l2)))
4220 ;; l1 not null and l2 not null
4221 ((and l1 l2) (< (car l1) (car l2)))
4222 ;; l1 null and l2 null ==> l1 length = l2 length
4223 ((and (null l1) (null l2)))
4224 ;; l1 not null and l2 null ==> l1 length > l2 length
4225 (l1 (<= (version-list-not-zero l1) 0))
4226 ;; l1 null and l2 not null ==> l2 length > l1 length
4227 (t (<= 0 (version-list-not-zero l2)))))
4229 (defun version-list-not-zero (lst)
4230 "Return the first non-zero element of LST, which is a list of integers.
4232 If all LST elements are zeros or LST is nil, return zero."
4233 (while (and lst (zerop (car lst)))
4234 (setq lst (cdr lst)))
4237 ;; there is no element different of zero
4241 (defun version< (v1 v2)
4242 "Return t if version V1 is lower (older) than V2.
4244 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4245 etc. That is, the trailing \".0\"s are insignificant. Also, version
4246 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4247 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4249 (version-list-< (version-to-list v1) (version-to-list v2)))
4252 (defun version<= (v1 v2)
4253 "Return t if version V1 is lower (older) than or equal to V2.
4255 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4256 etc. That is, the trailing \".0\"s are insignificant. Also, version
4257 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4258 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4260 (version-list-<= (version-to-list v1) (version-to-list v2)))
4262 (defun version= (v1 v2)
4263 "Return t if version V1 is equal to V2.
4265 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4266 etc. That is, the trailing \".0\"s are insignificant. Also, version
4267 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4268 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4270 (version-list-= (version-to-list v1) (version-to-list v2)))
4274 (defconst menu-bar-separator '("--")
4275 "Separator for menus.")
4277 ;; The following statement ought to be in print.c, but `provide' can't
4279 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4280 (when (hash-table-p (car (read-from-string
4281 (prin1-to-string (make-hash-table)))))
4282 (provide 'hashtable-print-readable))
4284 ;;; subr.el ends here