1 ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8; lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2015 Free Software
6 ;; Maintainer: emacs-devel@gnu.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; Beware: while this file has tag `utf-8', before it's compiled, it gets
30 ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
32 (defmacro declare-function
(_fn _file
&optional _arglist _fileonly
)
33 "Tell the byte-compiler that function FN is defined, in FILE.
34 Optional ARGLIST is the argument list used by the function.
35 The FILE argument is not used by the byte-compiler, but by the
36 `check-declare' package, which checks that FILE contains a
37 definition for FN. ARGLIST is used by both the byte-compiler
38 and `check-declare' to check for consistency.
40 FILE can be either a Lisp file (in which case the \".el\"
41 extension is optional), or a C file. C files are expanded
42 relative to the Emacs \"src/\" directory. Lisp files are
43 searched for using `locate-library', and if that fails they are
44 expanded relative to the location of the file containing the
45 declaration. A FILE with an \"ext:\" prefix is an external file.
46 `check-declare' will check such files if they are found, and skip
47 them without error if they are not.
49 FILEONLY non-nil means that `check-declare' will only check that
50 FILE exists, not that it defines FN. This is intended for
51 function-definitions that `check-declare' does not recognize, e.g.
54 To specify a value for FILEONLY without passing an argument list,
55 set ARGLIST to t. This is necessary because nil means an
56 empty argument list, rather than an unspecified one.
58 Note that for the purposes of `check-declare', this statement
59 must be the first non-whitespace on a line.
61 For more information, see Info node `(elisp)Declaring Functions'."
62 ;; Does nothing - byte-compile-declare-function does the work.
66 ;;;; Basic Lisp macros.
70 (defmacro noreturn
(form)
71 "Evaluate FORM, expecting it not to return.
72 If FORM does return, signal an error."
75 (error "Form marked with `noreturn' did return")))
77 (defmacro 1value
(form)
78 "Evaluate FORM, expecting a constant return value.
79 This is the global do-nothing version. There is also `testcover-1value'
80 that complains if FORM ever does return differing values."
84 (defmacro def-edebug-spec
(symbol spec
)
85 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
86 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
87 0 (instrument no arguments); t (instrument all arguments);
88 a symbol (naming a function with an Edebug specification); or a list.
89 The elements of the list describe the argument types; see
90 Info node `(elisp)Specification List' for details."
91 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
93 (defmacro lambda
(&rest cdr
)
94 "Return a lambda expression.
95 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
96 self-quoting; the result of evaluating the lambda expression is the
97 expression itself. The lambda expression may then be treated as a
98 function, i.e., stored as the function value of a symbol, passed to
99 `funcall' or `mapcar', etc.
101 ARGS should take the same form as an argument list for a `defun'.
102 DOCSTRING is an optional documentation string.
103 If present, it should describe how to call the function.
104 But documentation strings are usually not useful in nameless functions.
105 INTERACTIVE should be a call to the function `interactive', which see.
106 It may also be omitted.
107 BODY should be a list of Lisp expressions.
109 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
110 (declare (doc-string 2) (indent defun
)
111 (debug (&define lambda-list
113 [&optional
("interactive" interactive
)]
115 ;; Note that this definition should not use backquotes; subr.el should not
116 ;; depend on backquote.el.
117 (list 'function
(cons 'lambda cdr
)))
119 (defmacro setq-local
(var val
)
120 "Set variable VAR to value VAL in current buffer."
121 ;; Can't use backquote here, it's too early in the bootstrap.
122 (list 'set
(list 'make-local-variable
(list 'quote var
)) val
))
124 (defmacro defvar-local
(var val
&optional docstring
)
125 "Define VAR as a buffer-local variable with default value VAL.
126 Like `defvar' but additionally marks the variable as being automatically
127 buffer-local wherever it is set."
128 (declare (debug defvar
) (doc-string 3))
129 ;; Can't use backquote here, it's too early in the bootstrap.
130 (list 'progn
(list 'defvar var val docstring
)
131 (list 'make-variable-buffer-local
(list 'quote var
))))
133 (defun apply-partially (fun &rest args
)
134 "Return a function that is a partial application of FUN to ARGS.
135 ARGS is a list of the first N arguments to pass to FUN.
136 The result is a new function which does the same as FUN, except that
137 the first N arguments are fixed at the values with which this function
139 (lambda (&rest args2
)
140 (apply fun
(append args args2
))))
142 (defmacro push
(newelt place
)
143 "Add NEWELT to the list stored in the generalized variable PLACE.
144 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
145 except that PLACE is only evaluated once (after NEWELT)."
146 (declare (debug (form gv-place
)))
148 ;; Important special case, to avoid triggering GV too early in
151 (list 'cons newelt place
))
153 (macroexp-let2 macroexp-copyable-p v newelt
154 (gv-letplace (getter setter
) place
155 (funcall setter
`(cons ,v
,getter
))))))
157 (defmacro pop
(place)
158 "Return the first element of PLACE's value, and remove it from the list.
159 PLACE must be a generalized variable whose value is a list.
160 If the value is nil, `pop' returns nil but does not actually
162 (declare (debug (gv-place)))
163 ;; We use `car-safe' here instead of `car' because the behavior is the same
164 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
165 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
166 ;; result is not used.
169 ;; So we can use `pop' in the bootstrap before `gv' can be used.
170 (list 'prog1 place
(list 'setq place
(list 'cdr place
)))
171 (gv-letplace (getter setter
) place
172 (macroexp-let2 macroexp-copyable-p x getter
173 `(prog1 ,x
,(funcall setter
`(cdr ,x
))))))))
175 (defmacro when
(cond &rest body
)
176 "If COND yields non-nil, do BODY, else return nil.
177 When COND yields non-nil, eval BODY forms sequentially and return
178 value of last one, or nil if there are none.
181 (declare (indent 1) (debug t
))
182 (list 'if cond
(cons 'progn body
)))
184 (defmacro unless
(cond &rest body
)
185 "If COND yields nil, do BODY, else return nil.
186 When COND yields nil, eval BODY forms sequentially and return
187 value of last one, or nil if there are none.
190 (declare (indent 1) (debug t
))
191 (cons 'if
(cons cond
(cons nil body
))))
193 (defmacro dolist
(spec &rest body
)
195 Evaluate BODY with VAR bound to each car from LIST, in turn.
196 Then evaluate RESULT to get return value, default nil.
198 \(fn (VAR LIST [RESULT]) BODY...)"
199 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
200 ;; It would be cleaner to create an uninterned symbol,
201 ;; but that uses a lot more space when many functions in many files
203 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
204 (let ((temp '--dolist-tail--
))
205 ;; This is not a reliable test, but it does not matter because both
206 ;; semantics are acceptable, tho one is slightly faster with dynamic
207 ;; scoping and the other is slightly faster (and has cleaner semantics)
208 ;; with lexical scoping.
210 `(let ((,temp
,(nth 1 spec
)))
212 (let ((,(car spec
) (car ,temp
)))
214 (setq ,temp
(cdr ,temp
))))
216 `(let ((,temp
,(nth 1 spec
))
219 (setq ,(car spec
) (car ,temp
))
221 (setq ,temp
(cdr ,temp
)))
222 ,@(if (cdr (cdr spec
))
223 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
))))))))
225 (defmacro dotimes
(spec &rest body
)
226 "Loop a certain number of times.
227 Evaluate BODY with VAR bound to successive integers running from 0,
228 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
229 the return value (nil if RESULT is omitted).
231 \(fn (VAR COUNT [RESULT]) BODY...)"
232 (declare (indent 1) (debug dolist
))
233 ;; It would be cleaner to create an uninterned symbol,
234 ;; but that uses a lot more space when many functions in many files
236 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
237 (let ((temp '--dotimes-limit--
)
240 ;; This is not a reliable test, but it does not matter because both
241 ;; semantics are acceptable, tho one is slightly faster with dynamic
242 ;; scoping and the other has cleaner semantics.
244 (let ((counter '--dotimes-counter--
))
247 (while (< ,counter
,temp
)
248 (let ((,(car spec
) ,counter
))
250 (setq ,counter
(1+ ,counter
)))
252 ;; FIXME: This let often leads to "unused var" warnings.
253 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
255 (,(car spec
) ,start
))
256 (while (< ,(car spec
) ,temp
)
258 (setq ,(car spec
) (1+ ,(car spec
))))
259 ,@(cdr (cdr spec
))))))
261 (defmacro declare
(&rest _specs
)
262 "Do not evaluate any arguments, and return nil.
263 If a `declare' form appears as the first form in the body of a
264 `defun' or `defmacro' form, SPECS specifies various additional
265 information about the function or macro; these go into effect
266 during the evaluation of the `defun' or `defmacro' form.
268 The possible values of SPECS are specified by
269 `defun-declarations-alist' and `macro-declarations-alist'.
271 For more information, see info node `(elisp)Declare Form'."
272 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
275 (defmacro ignore-errors
(&rest body
)
276 "Execute BODY; if an error occurs, return nil.
277 Otherwise, return result of last form in BODY.
278 See also `with-demoted-errors' that does something similar
279 without silencing all errors."
280 (declare (debug t
) (indent 0))
281 `(condition-case nil
(progn ,@body
) (error nil
)))
283 ;;;; Basic Lisp functions.
285 (defun ignore (&rest _ignore
)
286 "Do nothing and return nil.
287 This function accepts any number of arguments, but ignores them."
291 ;; Signal a compile-error if the first arg is missing.
292 (defun error (&rest args
)
293 "Signal an error, making error message by passing all args to `format'.
294 In Emacs, the convention is that error messages start with a capital
295 letter but *do not* end with a period. Please follow this convention
296 for the sake of consistency."
297 (declare (advertised-calling-convention (string &rest args
) "23.1"))
298 (signal 'error
(list (apply 'format args
))))
300 (defun user-error (format &rest args
)
301 "Signal a pilot error, making error message by passing all args to `format'.
302 In Emacs, the convention is that error messages start with a capital
303 letter but *do not* end with a period. Please follow this convention
304 for the sake of consistency.
305 This is just like `error' except that `user-error's are expected to be the
306 result of an incorrect manipulation on the part of the user, rather than the
307 result of an actual problem."
308 (signal 'user-error
(list (apply #'format format args
))))
310 (defun define-error (name message
&optional parent
)
311 "Define NAME as a new error signal.
312 MESSAGE is a string that will be output to the echo area if such an error
313 is signaled without being caught by a `condition-case'.
314 PARENT is either a signal or a list of signals from which it inherits.
315 Defaults to `error'."
316 (unless parent
(setq parent
'error
))
320 (mapcar (lambda (parent)
322 (or (get parent
'error-conditions
)
323 (error "Unknown signal `%s'" parent
))))
325 (cons parent
(get parent
'error-conditions
)))))
326 (put name
'error-conditions
327 (delete-dups (copy-sequence (cons name conditions
))))
328 (when message
(put name
'error-message message
))))
330 ;; We put this here instead of in frame.el so that it's defined even on
331 ;; systems where frame.el isn't loaded.
332 (defun frame-configuration-p (object)
333 "Return non-nil if OBJECT seems to be a frame configuration.
334 Any list whose car is `frame-configuration' is assumed to be a frame
337 (eq (car object
) 'frame-configuration
)))
342 ;; Note: `internal--compiler-macro-cXXr' was copied from
343 ;; `cl--compiler-macro-cXXr' in cl-macs.el. If you amend either one,
344 ;; you may want to amend the other, too.
345 (defun internal--compiler-macro-cXXr (form x
)
346 (let* ((head (car form
))
347 (n (symbol-name (car form
)))
348 (i (- (length n
) 2)))
349 (if (not (string-match "c[ad]+r\\'" n
))
350 (if (and (fboundp head
) (symbolp (symbol-function head
)))
351 (internal--compiler-macro-cXXr (cons (symbol-function head
) (cdr form
))
353 (error "Compiler macro for cXXr applied to non-cXXr form"))
354 (while (> i
(match-beginning 0))
355 (setq x
(list (if (eq (aref n i
) ?a
) 'car
'cdr
) x
))
360 "Return the car of the car of X."
361 (declare (compiler-macro internal--compiler-macro-cXXr
))
365 "Return the car of the cdr of X."
366 (declare (compiler-macro internal--compiler-macro-cXXr
))
370 "Return the cdr of the car of X."
371 (declare (compiler-macro internal--compiler-macro-cXXr
))
375 "Return the cdr of the cdr of X."
376 (declare (compiler-macro internal--compiler-macro-cXXr
))
379 (defun last (list &optional n
)
380 "Return the last link of LIST. Its car is the last element.
381 If LIST is nil, return nil.
382 If N is non-nil, return the Nth-to-last link of LIST.
383 If N is bigger than the length of LIST, return LIST."
386 (let ((m (safe-length list
)))
387 (if (< n m
) (nthcdr (- m n
) list
) list
)))
389 (nthcdr (1- (safe-length list
)) list
))))
391 (defun butlast (list &optional n
)
392 "Return a copy of LIST with the last N elements removed.
393 If N is omitted or nil, the last element is removed from the
395 (if (and n
(<= n
0)) list
396 (nbutlast (copy-sequence list
) n
)))
398 (defun nbutlast (list &optional n
)
399 "Modifies LIST to remove the last N elements.
400 If N is omitted or nil, remove the last element."
401 (let ((m (length list
)))
405 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
408 (defun zerop (number)
409 "Return t if NUMBER is zero."
410 ;; Used to be in C, but it's pointless since (= 0 n) is faster anyway because
411 ;; = has a byte-code.
412 (declare (compiler-macro (lambda (_) `(= 0 ,number
))))
415 (defun delete-dups (list)
416 "Destructively remove `equal' duplicates from LIST.
417 Store the result in LIST and return it. LIST must be a proper list.
418 Of several `equal' occurrences of an element in LIST, the first
422 (setcdr tail
(delete (car tail
) (cdr tail
)))
423 (setq tail
(cdr tail
))))
426 ;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html
427 (defun delete-consecutive-dups (list &optional circular
)
428 "Destructively remove `equal' consecutive duplicates from LIST.
429 First and last elements are considered consecutive if CIRCULAR is
431 (let ((tail list
) last
)
433 (if (equal (car tail
) (cadr tail
))
434 (setcdr tail
(cddr tail
))
435 (setq last
(car tail
)
439 (equal last
(car list
)))
443 (defun number-sequence (from &optional to inc
)
444 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
445 INC is the increment used between numbers in the sequence and defaults to 1.
446 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
447 zero. TO is only included if there is an N for which TO = FROM + N * INC.
448 If TO is nil or numerically equal to FROM, return (FROM).
449 If INC is positive and TO is less than FROM, or INC is negative
450 and TO is larger than FROM, return nil.
451 If INC is zero and TO is neither nil nor numerically equal to
452 FROM, signal an error.
454 This function is primarily designed for integer arguments.
455 Nevertheless, FROM, TO and INC can be integer or float. However,
456 floating point arithmetic is inexact. For instance, depending on
457 the machine, it may quite well happen that
458 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
459 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
460 elements. Thus, if some of the arguments are floats and one wants
461 to make sure that TO is included, one may have to explicitly write
462 TO as (+ FROM (* N INC)) or use a variable whose value was
463 computed with this exact expression. Alternatively, you can,
464 of course, also replace TO with a slightly larger value
465 \(or a slightly more negative value if INC is negative)."
466 (if (or (not to
) (= from to
))
468 (or inc
(setq inc
1))
469 (when (zerop inc
) (error "The increment can not be zero"))
470 (let (seq (n 0) (next from
))
473 (setq seq
(cons next seq
)
475 next
(+ from
(* n inc
))))
477 (setq seq
(cons next seq
)
479 next
(+ from
(* n inc
)))))
482 (defun copy-tree (tree &optional vecp
)
483 "Make a copy of TREE.
484 If TREE is a cons cell, this recursively copies both its car and its cdr.
485 Contrast to `copy-sequence', which copies only along the cdrs. With second
486 argument VECP, this copies vectors as well as conses."
490 (let ((newcar (car tree
)))
491 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
492 (setq newcar
(copy-tree (car tree
) vecp
)))
493 (push newcar result
))
494 (setq tree
(cdr tree
)))
495 (nconc (nreverse result
) tree
))
496 (if (and vecp
(vectorp tree
))
497 (let ((i (length (setq tree
(copy-sequence tree
)))))
498 (while (>= (setq i
(1- i
)) 0)
499 (aset tree i
(copy-tree (aref tree i
) vecp
)))
503 ;;;; Various list-search functions.
505 (defun assoc-default (key alist
&optional test default
)
506 "Find object KEY in a pseudo-alist ALIST.
507 ALIST is a list of conses or objects. Each element
508 (or the element's car, if it is a cons) is compared with KEY by
509 calling TEST, with two arguments: (i) the element or its car,
511 If that is non-nil, the element matches; then `assoc-default'
512 returns the element's cdr, if it is a cons, or DEFAULT if the
513 element is not a cons.
515 If no element matches, the value is nil.
516 If TEST is omitted or nil, `equal' is used."
517 (let (found (tail alist
) value
)
518 (while (and tail
(not found
))
519 (let ((elt (car tail
)))
520 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
521 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
522 (setq tail
(cdr tail
)))
525 (defun assoc-ignore-case (key alist
)
526 "Like `assoc', but ignores differences in case and text representation.
527 KEY must be a string. Upper-case and lower-case letters are treated as equal.
528 Unibyte strings are converted to multibyte for comparison."
529 (declare (obsolete assoc-string
"22.1"))
530 (assoc-string key alist t
))
532 (defun assoc-ignore-representation (key alist
)
533 "Like `assoc', but ignores differences in text representation.
534 KEY must be a string.
535 Unibyte strings are converted to multibyte for comparison."
536 (declare (obsolete assoc-string
"22.1"))
537 (assoc-string key alist nil
))
539 (defun member-ignore-case (elt list
)
540 "Like `member', but ignore differences in case and text representation.
541 ELT must be a string. Upper-case and lower-case letters are treated as equal.
542 Unibyte strings are converted to multibyte for comparison.
543 Non-strings in LIST are ignored."
545 (not (and (stringp (car list
))
546 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
547 (setq list
(cdr list
)))
550 (defun assq-delete-all (key alist
)
551 "Delete from ALIST all elements whose car is `eq' to KEY.
552 Return the modified alist.
553 Elements of ALIST that are not conses are ignored."
554 (while (and (consp (car alist
))
555 (eq (car (car alist
)) key
))
556 (setq alist
(cdr alist
)))
557 (let ((tail alist
) tail-cdr
)
558 (while (setq tail-cdr
(cdr tail
))
559 (if (and (consp (car tail-cdr
))
560 (eq (car (car tail-cdr
)) key
))
561 (setcdr tail
(cdr tail-cdr
))
562 (setq tail tail-cdr
))))
565 (defun rassq-delete-all (value alist
)
566 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
567 Return the modified alist.
568 Elements of ALIST that are not conses are ignored."
569 (while (and (consp (car alist
))
570 (eq (cdr (car alist
)) value
))
571 (setq alist
(cdr alist
)))
572 (let ((tail alist
) tail-cdr
)
573 (while (setq tail-cdr
(cdr tail
))
574 (if (and (consp (car tail-cdr
))
575 (eq (cdr (car tail-cdr
)) value
))
576 (setcdr tail
(cdr tail-cdr
))
577 (setq tail tail-cdr
))))
580 (defun alist-get (key alist
&optional default remove
)
581 "Get the value associated to KEY in ALIST.
582 DEFAULT is the value to return if KEY is not found in ALIST.
583 REMOVE, if non-nil, means that when setting this element, we should
584 remove the entry if the new value is `eql' to DEFAULT."
585 (ignore remove
) ;;Silence byte-compiler.
586 (let ((x (assq key alist
)))
587 (if x
(cdr x
) default
)))
589 (defun remove (elt seq
)
590 "Return a copy of SEQ with all occurrences of ELT removed.
591 SEQ must be a list, vector, or string. The comparison is done with `equal'."
593 ;; If SEQ isn't a list, there's no need to copy SEQ because
594 ;; `delete' will return a new object.
596 (delete elt
(copy-sequence seq
))))
598 (defun remq (elt list
)
599 "Return LIST with all occurrences of ELT removed.
600 The comparison is done with `eq'. Contrary to `delq', this does not use
601 side-effects, and the argument LIST is not modified."
602 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
604 (delq elt
(copy-sequence list
))
610 "Convert KEYS to the internal Emacs key representation.
611 KEYS should be a string constant in the format used for
612 saving keyboard macros (see `edmacro-mode')."
613 ;; Don't use a defalias, since the `pure' property is only true for
614 ;; the calling convention of `kbd'.
615 (read-kbd-macro keys
))
619 "Beep to tell the user this binding is undefined."
622 (message "%s is undefined" (key-description (this-single-command-keys)))
623 (setq defining-kbd-macro nil
)
624 (force-mode-line-update)
625 ;; If this is a down-mouse event, don't reset prefix-arg;
626 ;; pass it to the command run by the up event.
628 (when (memq 'down
(event-modifiers last-command-event
))
629 current-prefix-arg
)))
631 ;; Prevent the \{...} documentation construct
632 ;; from mentioning keys that run this command.
633 (put 'undefined
'suppress-keymap t
)
635 (defun suppress-keymap (map &optional nodigits
)
636 "Make MAP override all normally self-inserting keys to be undefined.
637 Normally, as an exception, digits and minus-sign are set to make prefix args,
638 but optional second arg NODIGITS non-nil treats them like other chars."
639 (define-key map
[remap self-insert-command
] 'undefined
)
642 (define-key map
"-" 'negative-argument
)
643 ;; Make plain numbers do numeric args.
646 (define-key map
(char-to-string loop
) 'digit-argument
)
647 (setq loop
(1+ loop
))))))
649 (defun make-composed-keymap (maps &optional parent
)
650 "Construct a new keymap composed of MAPS and inheriting from PARENT.
651 When looking up a key in the returned map, the key is looked in each
652 keymap of MAPS in turn until a binding is found.
653 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
654 As always with keymap inheritance, a nil binding in MAPS overrides
655 any corresponding binding in PARENT, but it does not override corresponding
656 bindings in other keymaps of MAPS.
657 MAPS can be a list of keymaps or a single keymap.
658 PARENT if non-nil should be a keymap."
660 ,@(if (keymapp maps
) (list maps
) maps
)
663 (defun define-key-after (keymap key definition
&optional after
)
664 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
665 This is like `define-key' except that the binding for KEY is placed
666 just after the binding for the event AFTER, instead of at the beginning
667 of the map. Note that AFTER must be an event type (like KEY), NOT a command
670 If AFTER is t or omitted, the new binding goes at the end of the keymap.
671 AFTER should be a single event type--a symbol or a character, not a sequence.
673 Bindings are always added before any inherited map.
675 The order of bindings in a keymap only matters when it is used as
676 a menu, so this function is not useful for non-menu keymaps."
677 (unless after
(setq after t
))
679 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
681 (if (<= (length key
) 1) (aref key
0)
682 (setq keymap
(lookup-key keymap
684 (butlast (mapcar 'identity key
)))))
685 (aref key
(1- (length key
)))))
686 (let ((tail keymap
) done inserted
)
687 (while (and (not done
) tail
)
688 ;; Delete any earlier bindings for the same key.
689 (if (eq (car-safe (car (cdr tail
))) key
)
690 (setcdr tail
(cdr (cdr tail
))))
691 ;; If we hit an included map, go down that one.
692 (if (keymapp (car tail
)) (setq tail
(car tail
)))
693 ;; When we reach AFTER's binding, insert the new binding after.
694 ;; If we reach an inherited keymap, insert just before that.
695 ;; If we reach the end of this keymap, insert at the end.
696 (if (or (and (eq (car-safe (car tail
)) after
)
698 (eq (car (cdr tail
)) 'keymap
)
701 ;; Stop the scan only if we find a parent keymap.
702 ;; Keep going past the inserted element
703 ;; so we can delete any duplications that come later.
704 (if (eq (car (cdr tail
)) 'keymap
)
706 ;; Don't insert more than once.
708 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
710 (setq tail
(cdr tail
)))))
712 (defun map-keymap-sorted (function keymap
)
713 "Implement `map-keymap' with sorting.
714 Don't call this function; it is for internal use only."
716 (map-keymap (lambda (a b
) (push (cons a b
) list
))
718 (setq list
(sort list
720 (setq a
(car a
) b
(car b
))
722 (if (integerp b
) (< a b
)
725 ;; string< also accepts symbols.
728 (funcall function
(car p
) (cdr p
)))))
730 (defun keymap--menu-item-binding (val)
731 "Return the binding part of a menu-item."
733 ((not (consp val
)) val
) ;Not a menu-item.
734 ((eq 'menu-item
(car val
))
735 (let* ((binding (nth 2 val
))
736 (plist (nthcdr 3 val
))
737 (filter (plist-get plist
:filter
)))
738 (if filter
(funcall filter binding
)
740 ((and (consp (cdr val
)) (stringp (cadr val
)))
744 (t val
))) ;Not a menu-item either.
746 (defun keymap--menu-item-with-binding (item binding
)
747 "Build a menu-item like ITEM but with its binding changed to BINDING."
749 ((not (consp item
)) binding
) ;Not a menu-item.
750 ((eq 'menu-item
(car item
))
751 (setq item
(copy-sequence item
))
752 (let ((tail (nthcdr 2 item
)))
753 (setcar tail binding
)
754 ;; Remove any potential filter.
755 (if (plist-get (cdr tail
) :filter
)
756 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
758 ((and (consp (cdr item
)) (stringp (cadr item
)))
759 (cons (car item
) (cons (cadr item
) binding
)))
760 (t (cons (car item
) binding
))))
762 (defun keymap--merge-bindings (val1 val2
)
763 "Merge bindings VAL1 and VAL2."
764 (let ((map1 (keymap--menu-item-binding val1
))
765 (map2 (keymap--menu-item-binding val2
)))
766 (if (not (and (keymapp map1
) (keymapp map2
)))
767 ;; There's nothing to merge: val1 takes precedence.
769 (let ((map (list 'keymap map1 map2
))
770 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
771 (keymap--menu-item-with-binding item map
)))))
773 (defun keymap-canonicalize (map)
774 "Return a simpler equivalent keymap.
775 This resolves inheritance and redefinitions. The returned keymap
776 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
777 and use in active keymaps and menus.
778 Subkeymaps may be modified but are not canonicalized."
779 ;; FIXME: Problem with the difference between a nil binding
780 ;; that hides a binding in an inherited map and a nil binding that's ignored
781 ;; to let some further binding visible. Currently a nil binding hides all.
782 ;; FIXME: we may want to carefully (re)order elements in case they're
786 (prompt (keymap-prompt map
)))
788 (setq map
(map-keymap ;; -internal
791 ;; Treat char-ranges specially.
792 (push (cons key item
) ranges
)
793 (push (cons key item
) bindings
)))
795 ;; Create the new map.
796 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
797 (dolist (binding ranges
)
798 ;; Treat char-ranges specially. FIXME: need to merge as well.
799 (define-key map
(vector (car binding
)) (cdr binding
)))
800 ;; Process the bindings starting from the end.
801 (dolist (binding (prog1 bindings
(setq bindings
())))
802 (let* ((key (car binding
))
803 (oldbind (assq key bindings
)))
804 (push (if (not oldbind
)
805 ;; The normal case: no duplicate bindings.
807 ;; This is the second binding for this key.
808 (setq bindings
(delq oldbind bindings
))
809 (cons key
(keymap--merge-bindings (cdr binding
)
812 (nconc map bindings
)))
814 (put 'keyboard-translate-table
'char-table-extra-slots
0)
816 (defun keyboard-translate (from to
)
817 "Translate character FROM to TO on the current terminal.
818 This function creates a `keyboard-translate-table' if necessary
819 and then modifies one entry in it."
820 (or (char-table-p keyboard-translate-table
)
821 (setq keyboard-translate-table
822 (make-char-table 'keyboard-translate-table nil
)))
823 (aset keyboard-translate-table from to
))
825 ;;;; Key binding commands.
827 (defun global-set-key (key command
)
828 "Give KEY a global binding as COMMAND.
829 COMMAND is the command definition to use; usually it is
830 a symbol naming an interactively-callable function.
831 KEY is a key sequence; noninteractively, it is a string or vector
832 of characters or event types, and non-ASCII characters with codes
833 above 127 (such as ISO Latin-1) can be included if you use a vector.
835 Note that if KEY has a local binding in the current buffer,
836 that local binding will continue to shadow any global binding
837 that you make with this function."
838 (interactive "KSet key globally: \nCSet key %s to command: ")
839 (or (vectorp key
) (stringp key
)
840 (signal 'wrong-type-argument
(list 'arrayp key
)))
841 (define-key (current-global-map) key command
))
843 (defun local-set-key (key command
)
844 "Give KEY a local binding as COMMAND.
845 COMMAND is the command definition to use; usually it is
846 a symbol naming an interactively-callable function.
847 KEY is a key sequence; noninteractively, it is a string or vector
848 of characters or event types, and non-ASCII characters with codes
849 above 127 (such as ISO Latin-1) can be included if you use a vector.
851 The binding goes in the current buffer's local map, which in most
852 cases is shared with all other buffers in the same major mode."
853 (interactive "KSet key locally: \nCSet key %s locally to command: ")
854 (let ((map (current-local-map)))
856 (use-local-map (setq map
(make-sparse-keymap))))
857 (or (vectorp key
) (stringp key
)
858 (signal 'wrong-type-argument
(list 'arrayp key
)))
859 (define-key map key command
)))
861 (defun global-unset-key (key)
862 "Remove global binding of KEY.
863 KEY is a string or vector representing a sequence of keystrokes."
864 (interactive "kUnset key globally: ")
865 (global-set-key key nil
))
867 (defun local-unset-key (key)
868 "Remove local binding of KEY.
869 KEY is a string or vector representing a sequence of keystrokes."
870 (interactive "kUnset key locally: ")
871 (if (current-local-map)
872 (local-set-key key nil
))
875 ;;;; substitute-key-definition and its subroutines.
877 (defvar key-substitution-in-progress nil
878 "Used internally by `substitute-key-definition'.")
880 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
881 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
882 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
883 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
884 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
886 If you don't specify OLDMAP, you can usually get the same results
887 in a cleaner way with command remapping, like this:
888 (define-key KEYMAP [remap OLDDEF] NEWDEF)
889 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
890 ;; Don't document PREFIX in the doc string because we don't want to
891 ;; advertise it. It's meant for recursive calls only. Here's its
894 ;; If optional argument PREFIX is specified, it should be a key
895 ;; prefix, a string. Redefined bindings will then be bound to the
896 ;; original key, with PREFIX added at the front.
897 (or prefix
(setq prefix
""))
898 (let* ((scan (or oldmap keymap
))
899 (prefix1 (vconcat prefix
[nil]))
900 (key-substitution-in-progress
901 (cons scan key-substitution-in-progress)))
902 ;; Scan OLDMAP, finding each char or event-symbol that
903 ;; has any definition, and act on it with hack-key.
906 (aset prefix1 (length prefix) char)
907 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
910 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
911 (let (inner-def skipped menu-item)
912 ;; Find the actual command name within the binding.
913 (if (eq (car-safe defn) 'menu-item)
914 (setq menu-item defn defn (nth 2 defn))
915 ;; Skip past menu-prompt.
916 (while (stringp (car-safe defn))
917 (push (pop defn) skipped))
918 ;; Skip past cached key-equivalence data for menu items.
919 (if (consp (car-safe defn))
920 (setq defn (cdr defn))))
921 (if (or (eq defn olddef)
922 ;; Compare with equal if definition is a key sequence.
923 ;; That is useful for operating on function-key-map.
924 (and (or (stringp defn) (vectorp defn))
925 (equal defn olddef)))
926 (define-key keymap prefix
928 (let ((copy (copy-sequence menu-item)))
929 (setcar (nthcdr 2 copy) newdef)
931 (nconc (nreverse skipped) newdef)))
932 ;; Look past a symbol that names a keymap.
934 (or (indirect-function defn t) defn))
935 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
936 ;; avoid autoloading a keymap. This is mostly done to preserve the
937 ;; original non-autoloading behavior of pre-map-keymap times.
938 (if (and (keymapp inner-def)
939 ;; Avoid recursively scanning
940 ;; where KEYMAP does not have a submap.
941 (let ((elt (lookup-key keymap prefix)))
942 (or (null elt) (natnump elt) (keymapp elt)))
943 ;; Avoid recursively rescanning keymap being scanned.
944 (not (memq inner-def key-substitution-in-progress)))
945 ;; If this one isn't being scanned already, scan it now.
946 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
949 ;;;; The global keymap tree.
951 ;; global-map, esc-map, and ctl-x-map have their values set up in
952 ;; keymap.c; we just give them docstrings here.
954 (defvar global-map nil
955 "Default global keymap mapping Emacs keyboard input into commands.
956 The value is a keymap which is usually (but not necessarily) Emacs's
960 "Default keymap for ESC (meta) commands.
961 The normal global definition of the character ESC indirects to this keymap.")
963 (defvar ctl-x-map nil
964 "Default keymap for C-x commands.
965 The normal global definition of the character C-x indirects to this keymap.")
967 (defvar ctl-x-4-map (make-sparse-keymap)
968 "Keymap for subcommands of C-x 4.")
969 (defalias 'ctl-x-4-prefix ctl-x-4-map)
970 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
972 (defvar ctl-x-5-map (make-sparse-keymap)
973 "Keymap for frame commands.")
974 (defalias 'ctl-x-5-prefix ctl-x-5-map)
975 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
978 ;;;; Event manipulation functions.
980 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
982 (defun listify-key-sequence (key)
983 "Convert a key sequence to a list of events."
986 (mapcar (function (lambda (c)
988 (logxor c listify-key-sequence-1)
993 "True if the argument is an event object."
996 (and (symbolp obj) obj (not (keywordp obj)))
997 (and (consp obj) (symbolp (car obj))))))
999 (defun event-modifiers (event)
1000 "Return a list of symbols representing the modifier keys in event EVENT.
1001 The elements of the list may include `meta', `control',
1002 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
1004 EVENT may be an event or an event type. If EVENT is a symbol
1005 that has never been used in an event that has been read as input
1006 in the current Emacs session, then this function may fail to include
1007 the `click' modifier."
1010 (setq type (car type)))
1012 ;; Don't read event-symbol-elements directly since we're not
1013 ;; sure the symbol has already been parsed.
1014 (cdr (internal-event-symbol-parse-modifiers type))
1016 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
1017 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
1018 (if (not (zerop (logand type ?\M-\^@)))
1020 (if (or (not (zerop (logand type ?\C-\^@)))
1022 (push 'control list))
1023 (if (or (not (zerop (logand type ?\S-\^@)))
1024 (/= char (downcase char)))
1026 (or (zerop (logand type ?\H-\^@))
1028 (or (zerop (logand type ?\s-\^@))
1030 (or (zerop (logand type ?\A-\^@))
1034 (defun event-basic-type (event)
1035 "Return the basic type of the given event (all modifiers removed).
1036 The value is a printing character (not upper case) or a symbol.
1037 EVENT may be an event or an event type. If EVENT is a symbol
1038 that has never been used in an event that has been read as input
1039 in the current Emacs session, then this function may return nil."
1041 (setq event (car event)))
1043 (car (get event 'event-symbol-elements))
1044 (let* ((base (logand event (1- ?\A-\^@)))
1045 (uncontrolled (if (< base 32) (logior base 64) base)))
1046 ;; There are some numbers that are invalid characters and
1047 ;; cause `downcase' to get an error.
1049 (downcase uncontrolled)
1050 (error uncontrolled)))))
1052 (defsubst mouse-movement-p (object)
1053 "Return non-nil if OBJECT is a mouse movement event."
1054 (eq (car-safe object) 'mouse-movement))
1056 (defun mouse-event-p (object)
1057 "Return non-nil if OBJECT is a mouse click event."
1058 ;; is this really correct? maybe remove mouse-movement?
1059 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
1061 (defun event-start (event)
1062 "Return the starting position of EVENT.
1063 EVENT should be a mouse click, drag, or key press event. If
1064 EVENT is nil, the value of `posn-at-point' is used instead.
1066 The following accessor functions are used to access the elements
1069 `posn-window': The window the event is in.
1070 `posn-area': A symbol identifying the area the event occurred in,
1071 or nil if the event occurred in the text area.
1072 `posn-point': The buffer position of the event.
1073 `posn-x-y': The pixel-based coordinates of the event.
1074 `posn-col-row': The estimated column and row corresponding to the
1075 position of the event.
1076 `posn-actual-col-row': The actual column and row corresponding to the
1077 position of the event.
1078 `posn-string': The string object of the event, which is either
1079 nil or (STRING . POSITION)'.
1080 `posn-image': The image object of the event, if any.
1081 `posn-object': The image or string object of the event, if any.
1082 `posn-timestamp': The time the event occurred, in milliseconds.
1084 For more information, see Info node `(elisp)Click Events'."
1085 (if (consp event) (nth 1 event)
1087 (list (selected-window) (point) '(0 . 0) 0))))
1089 (defun event-end (event)
1090 "Return the ending position of EVENT.
1091 EVENT should be a click, drag, or key press event.
1093 See `event-start' for a description of the value returned."
1094 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1096 (list (selected-window) (point) '(0 . 0) 0))))
1098 (defsubst event-click-count (event)
1099 "Return the multi-click count of EVENT, a click or drag event.
1100 The return value is a positive integer."
1101 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1103 ;;;; Extracting fields of the positions in an event.
1106 "Return non-nil if OBJ appears to be a valid `posn' object specifying a window.
1107 If OBJ is a valid `posn' object, but specifies a frame rather
1108 than a window, return nil."
1109 ;; FIXME: Correct the behavior of this function so that all valid
1110 ;; `posn' objects are recognized, after updating other code that
1111 ;; depends on its present behavior.
1112 (and (windowp (car-safe obj))
1113 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1114 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1115 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1117 (defsubst posn-window (position)
1118 "Return the window in POSITION.
1119 POSITION should be a list of the form returned by the `event-start'
1120 and `event-end' functions."
1123 (defsubst posn-area (position)
1124 "Return the window area recorded in POSITION, or nil for the text area.
1125 POSITION should be a list of the form returned by the `event-start'
1126 and `event-end' functions."
1127 (let ((area (if (consp (nth 1 position))
1128 (car (nth 1 position))
1130 (and (symbolp area) area)))
1132 (defun posn-point (position)
1133 "Return the buffer location in POSITION.
1134 POSITION should be a list of the form returned by the `event-start'
1135 and `event-end' functions.
1136 Returns nil if POSITION does not correspond to any buffer location (e.g.
1137 a click on a scroll bar)."
1138 (or (nth 5 position)
1139 (let ((pt (nth 1 position)))
1141 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1142 (if (integerp pt) pt)))))
1144 (defun posn-set-point (position)
1145 "Move point to POSITION.
1146 Select the corresponding window as well."
1147 (if (not (windowp (posn-window position)))
1148 (error "Position not in text area of window"))
1149 (select-window (posn-window position))
1150 (if (numberp (posn-point position))
1151 (goto-char (posn-point position))))
1153 (defsubst posn-x-y (position)
1154 "Return the x and y coordinates in POSITION.
1155 The return value has the form (X . Y), where X and Y are given in
1156 pixels. POSITION should be a list of the form returned by
1157 `event-start' and `event-end'."
1160 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1162 (defun posn-col-row (position)
1163 "Return the nominal column and row in POSITION, measured in characters.
1164 The column and row values are approximations calculated from the x
1165 and y coordinates in POSITION and the frame's default character width
1166 and default line height, including spacing.
1167 For a scroll-bar event, the result column is 0, and the row
1168 corresponds to the vertical position of the click in the scroll bar.
1169 POSITION should be a list of the form returned by the `event-start'
1170 and `event-end' functions."
1171 (let* ((pair (posn-x-y position))
1172 (frame-or-window (posn-window position))
1173 (frame (if (framep frame-or-window)
1175 (window-frame frame-or-window)))
1176 (window (when (windowp frame-or-window) frame-or-window))
1177 (area (posn-area position)))
1179 ((null frame-or-window)
1181 ((eq area 'vertical-scroll-bar)
1182 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1183 ((eq area 'horizontal-scroll-bar)
1184 (cons (scroll-bar-scale pair (window-width window)) 0))
1186 ;; FIXME: This should take line-spacing properties on
1187 ;; newlines into account.
1188 (let* ((spacing (when (display-graphic-p frame)
1189 (or (with-current-buffer
1190 (window-buffer (frame-selected-window frame))
1192 (frame-parameter frame 'line-spacing)))))
1193 (cond ((floatp spacing)
1194 (setq spacing (truncate (* spacing
1195 (frame-char-height frame)))))
1198 (cons (/ (car pair) (frame-char-width frame))
1199 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
1201 (defun posn-actual-col-row (position)
1202 "Return the window row number in POSITION and character number in that row.
1204 Return nil if POSITION does not contain the actual position; in that case
1205 \`posn-col-row' can be used to get approximate values.
1206 POSITION should be a list of the form returned by the `event-start'
1207 and `event-end' functions.
1209 This function does not account for the width on display, like the
1210 number of visual columns taken by a TAB or image. If you need
1211 the coordinates of POSITION in character units, you should use
1212 \`posn-col-row', not this function."
1215 (defsubst posn-timestamp (position)
1216 "Return the timestamp of POSITION.
1217 POSITION should be a list of the form returned by the `event-start'
1218 and `event-end' functions."
1221 (defun posn-string (position)
1222 "Return the string object of POSITION.
1223 Value is a cons (STRING . STRING-POS), or nil if not a string.
1224 POSITION should be a list of the form returned by the `event-start'
1225 and `event-end' functions."
1226 (let ((x (nth 4 position)))
1227 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1228 (when (consp x) x)))
1230 (defsubst posn-image (position)
1231 "Return the image object of POSITION.
1232 Value is a list (image ...), or nil if not an image.
1233 POSITION should be a list of the form returned by the `event-start'
1234 and `event-end' functions."
1237 (defsubst posn-object (position)
1238 "Return the object (image or string) of POSITION.
1239 Value is a list (image ...) for an image object, a cons cell
1240 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1241 POSITION should be a list of the form returned by the `event-start'
1242 and `event-end' functions."
1243 (or (posn-image position) (posn-string position)))
1245 (defsubst posn-object-x-y (position)
1246 "Return the x and y coordinates relative to the object of POSITION.
1247 The return value has the form (DX . DY), where DX and DY are
1248 given in pixels. POSITION should be a list of the form returned
1249 by `event-start' and `event-end'."
1252 (defsubst posn-object-width-height (position)
1253 "Return the pixel width and height of the object of POSITION.
1254 The return value has the form (WIDTH . HEIGHT). POSITION should
1255 be a list of the form returned by `event-start' and `event-end'."
1259 ;;;; Obsolescent names for functions.
1261 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1262 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1263 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1264 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1265 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1266 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1268 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1269 (make-obsolete 'buffer-has-markers-at nil "24.3")
1271 (defun insert-string (&rest args)
1272 "Mocklisp-compatibility insert function.
1273 Like the function `insert' except that any argument that is a number
1274 is converted into a string by expressing it in decimal."
1275 (declare (obsolete insert "22.1"))
1277 (insert (if (integerp el) (number-to-string el) el))))
1279 (defun makehash (&optional test)
1280 (declare (obsolete make-hash-table "22.1"))
1281 (make-hash-table :test (or test 'eql)))
1284 "Return (log X 10), the log base 10 of X."
1285 (declare (obsolete log "24.4"))
1288 ;; These are used by VM and some old programs
1289 (defalias 'focus-frame 'ignore "")
1290 (make-obsolete 'focus-frame "it does nothing." "22.1")
1291 (defalias 'unfocus-frame 'ignore "")
1292 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1293 (make-obsolete 'make-variable-frame-local
1294 "explicitly check for a frame-parameter instead." "22.2")
1295 (set-advertised-calling-convention
1296 'all-completions '(string collection &optional predicate) "23.1")
1297 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1298 (set-advertised-calling-convention 'indirect-function '(object) "25.1")
1299 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1300 (set-advertised-calling-convention 'decode-char '(ch charset) "21.4")
1301 (set-advertised-calling-convention 'encode-char '(ch charset) "21.4")
1303 ;;;; Obsolescence declarations for variables, and aliases.
1305 ;; Special "default-FOO" variables which contain the default value of
1306 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1307 ;; slows down several unrelated variable operations; furthermore, they
1308 ;; can lead to really odd behavior if you decide to make them
1311 ;; Not used at all in Emacs, last time I checked:
1312 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1313 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1314 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1315 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1316 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1317 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1318 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1319 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1320 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1321 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1322 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1323 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1324 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1325 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1326 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1327 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1328 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1329 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1330 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1331 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1332 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1333 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1334 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1335 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1336 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1337 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1338 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1339 (make-obsolete-variable 'default-enable-multibyte-characters
1340 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1342 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1343 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1344 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1345 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1346 (make-obsolete-variable 'redisplay-dont-pause nil "24.5")
1347 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1348 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1350 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1351 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1353 ;; Lisp manual only updated in 22.1.
1354 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1357 (define-obsolete-variable-alias 'x-lost-selection-hooks
1358 'x-lost-selection-functions "22.1")
1359 (define-obsolete-variable-alias 'x-sent-selection-hooks
1360 'x-sent-selection-functions "22.1")
1362 ;; This was introduced in 21.4 for pre-unicode unification. That
1363 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1364 ;; Other uses are possible, so this variable is not _really_ obsolete,
1365 ;; but Stefan insists to mark it so.
1366 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1368 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1370 ;;;; Alternate names for functions - these are not being phased out.
1372 (defalias 'send-string 'process-send-string)
1373 (defalias 'send-region 'process-send-region)
1374 (defalias 'string= 'string-equal)
1375 (defalias 'string< 'string-lessp)
1376 (defalias 'move-marker 'set-marker)
1377 (defalias 'rplaca 'setcar)
1378 (defalias 'rplacd 'setcdr)
1379 (defalias 'beep 'ding) ;preserve lingual purity
1380 (defalias 'indent-to-column 'indent-to)
1381 (defalias 'backward-delete-char 'delete-backward-char)
1382 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1383 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1384 (defalias 'int-to-string 'number-to-string)
1385 (defalias 'store-match-data 'set-match-data)
1386 (defalias 'chmod 'set-file-modes)
1387 (defalias 'mkdir 'make-directory)
1388 ;; These are the XEmacs names:
1389 (defalias 'point-at-eol 'line-end-position)
1390 (defalias 'point-at-bol 'line-beginning-position)
1392 (defalias 'user-original-login-name 'user-login-name)
1395 ;;;; Hook manipulation functions.
1397 (defun add-hook (hook function &optional append local)
1398 "Add to the value of HOOK the function FUNCTION.
1399 FUNCTION is not added if already present.
1400 FUNCTION is added (if necessary) at the beginning of the hook list
1401 unless the optional argument APPEND is non-nil, in which case
1402 FUNCTION is added at the end.
1404 The optional fourth argument, LOCAL, if non-nil, says to modify
1405 the hook's buffer-local value rather than its global value.
1406 This makes the hook buffer-local, and it makes t a member of the
1407 buffer-local value. That acts as a flag to run the hook
1408 functions of the global value as well as in the local value.
1410 HOOK should be a symbol, and FUNCTION may be any valid function. If
1411 HOOK is void, it is first set to nil. If HOOK's value is a single
1412 function, it is changed to a list of functions."
1413 (or (boundp hook) (set hook nil))
1414 (or (default-boundp hook) (set-default hook nil))
1415 (if local (unless (local-variable-if-set-p hook)
1416 (set (make-local-variable hook) (list t)))
1417 ;; Detect the case where make-local-variable was used on a hook
1418 ;; and do what we used to do.
1419 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1421 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1422 ;; If the hook value is a single function, turn it into a list.
1423 (when (or (not (listp hook-value)) (functionp hook-value))
1424 (setq hook-value (list hook-value)))
1425 ;; Do the actual addition if necessary
1426 (unless (member function hook-value)
1427 (when (stringp function)
1428 (setq function (purecopy function)))
1431 (append hook-value (list function))
1432 (cons function hook-value))))
1433 ;; Set the actual variable
1436 ;; If HOOK isn't a permanent local,
1437 ;; but FUNCTION wants to survive a change of modes,
1438 ;; mark HOOK as partially permanent.
1439 (and (symbolp function)
1440 (get function 'permanent-local-hook)
1441 (not (get hook 'permanent-local))
1442 (put hook 'permanent-local 'permanent-local-hook))
1443 (set hook hook-value))
1444 (set-default hook hook-value))))
1446 (defun remove-hook (hook function &optional local)
1447 "Remove from the value of HOOK the function FUNCTION.
1448 HOOK should be a symbol, and FUNCTION may be any valid function. If
1449 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1450 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1452 The optional third argument, LOCAL, if non-nil, says to modify
1453 the hook's buffer-local value rather than its default value."
1454 (or (boundp hook) (set hook nil))
1455 (or (default-boundp hook) (set-default hook nil))
1456 ;; Do nothing if LOCAL is t but this hook has no local binding.
1457 (unless (and local (not (local-variable-p hook)))
1458 ;; Detect the case where make-local-variable was used on a hook
1459 ;; and do what we used to do.
1460 (when (and (local-variable-p hook)
1461 (not (and (consp (symbol-value hook))
1462 (memq t (symbol-value hook)))))
1464 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1465 ;; Remove the function, for both the list and the non-list cases.
1466 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1467 (if (equal hook-value function) (setq hook-value nil))
1468 (setq hook-value (delete function (copy-sequence hook-value))))
1469 ;; If the function is on the global hook, we need to shadow it locally
1470 ;;(when (and local (member function (default-value hook))
1471 ;; (not (member (cons 'not function) hook-value)))
1472 ;; (push (cons 'not function) hook-value))
1473 ;; Set the actual variable
1475 (set-default hook hook-value)
1476 (if (equal hook-value '(t))
1477 (kill-local-variable hook)
1478 (set hook hook-value))))))
1480 (defmacro letrec (binders &rest body)
1481 "Bind variables according to BINDERS then eval BODY.
1482 The value of the last form in BODY is returned.
1483 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1484 SYMBOL to the value of VALUEFORM.
1485 All symbols are bound before the VALUEFORMs are evalled."
1486 ;; Only useful in lexical-binding mode.
1487 ;; As a special-form, we could implement it more efficiently (and cleanly,
1488 ;; making the vars actually unbound during evaluation of the binders).
1489 (declare (debug let) (indent 1))
1490 `(let ,(mapcar #'car binders)
1491 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1494 (defmacro with-wrapper-hook (hook args &rest body)
1495 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1496 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1497 around the preceding ones, like a set of nested `around' advices.
1499 Each hook function should accept an argument list consisting of a
1500 function FUN, followed by the additional arguments in ARGS.
1502 The first hook function in HOOK is passed a FUN that, if it is called
1503 with arguments ARGS, performs BODY (i.e., the default operation).
1504 The FUN passed to each successive hook function is defined based
1505 on the preceding hook functions; if called with arguments ARGS,
1506 it does what the `with-wrapper-hook' call would do if the
1507 preceding hook functions were the only ones present in HOOK.
1509 Each hook function may call its FUN argument as many times as it wishes,
1510 including never. In that case, such a hook function acts to replace
1511 the default definition altogether, and any preceding hook functions.
1512 Of course, a subsequent hook function may do the same thing.
1514 Each hook function definition is used to construct the FUN passed
1515 to the next hook function, if any. The last (or \"outermost\")
1516 FUN is then called once."
1517 (declare (indent 2) (debug (form sexp body))
1518 (obsolete "use a <foo>-function variable modified by `add-function'."
1520 ;; We need those two gensyms because CL's lexical scoping is not available
1521 ;; for function arguments :-(
1522 (let ((funs (make-symbol "funs"))
1523 (global (make-symbol "global"))
1524 (argssym (make-symbol "args"))
1525 (runrestofhook (make-symbol "runrestofhook")))
1526 ;; Since the hook is a wrapper, the loop has to be done via
1527 ;; recursion: a given hook function will call its parameter in order to
1528 ;; continue looping.
1529 `(letrec ((,runrestofhook
1530 (lambda (,funs ,global ,argssym)
1531 ;; `funs' holds the functions left on the hook and `global'
1532 ;; holds the functions left on the global part of the hook
1533 ;; (in case the hook is local).
1535 (if (eq t (car ,funs))
1536 (funcall ,runrestofhook
1537 (append ,global (cdr ,funs)) nil ,argssym)
1540 (lambda (,funs ,global &rest ,argssym)
1541 (funcall ,runrestofhook ,funs ,global ,argssym))
1542 (cdr ,funs) ,global)
1544 ;; Once there are no more functions on the hook, run
1545 ;; the original body.
1546 (apply (lambda ,args ,@body) ,argssym)))))
1547 (funcall ,runrestofhook ,hook
1548 ;; The global part of the hook, if any.
1550 `(if (local-variable-p ',hook)
1551 (default-value ',hook)))
1554 (defun add-to-list (list-var element &optional append compare-fn)
1555 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1556 The test for presence of ELEMENT is done with `equal', or with
1557 COMPARE-FN if that's non-nil.
1558 If ELEMENT is added, it is added at the beginning of the list,
1559 unless the optional argument APPEND is non-nil, in which case
1560 ELEMENT is added at the end.
1562 The return value is the new value of LIST-VAR.
1564 This is handy to add some elements to configuration variables,
1565 but please do not abuse it in Elisp code, where you are usually
1566 better off using `push' or `cl-pushnew'.
1568 If you want to use `add-to-list' on a variable that is not
1569 defined until a certain package is loaded, you should put the
1570 call to `add-to-list' into a hook function that will be run only
1571 after loading the package. `eval-after-load' provides one way to
1572 do this. In some cases other hooks, such as major mode hooks,
1577 ;; FIXME: Something like this could be used for `set' as well.
1578 (if (or (not (eq 'quote (car-safe list-var)))
1579 (special-variable-p (cadr list-var))
1580 (not (macroexp-const-p append)))
1582 (let* ((sym (cadr list-var))
1583 (append (eval append))
1584 (msg (format "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1586 ;; Big ugly hack so we only output a warning during
1587 ;; byte-compilation, and so we can use
1588 ;; byte-compile-not-lexical-var-p to silence the warning
1589 ;; when a defvar has been seen but not yet executed.
1591 ;; FIXME: We should also emit a warning for let-bound
1592 ;; variables with dynamic binding.
1593 (when (assq sym byte-compile--lexical-environment)
1594 (byte-compile-log-warning msg t :error))))
1596 (macroexp-let2 macroexp-copyable-p x element
1597 `(if ,(if compare-fn
1600 `(cl-member ,x ,sym :test ,compare-fn))
1601 ;; For bootstrapping reasons, don't rely on
1602 ;; cl--compiler-macro-member for the base case.
1606 `(setq ,sym (append ,sym (list ,x)))
1607 `(push ,x ,sym))))))
1608 (if (not (macroexp--compiling-p))
1611 (macroexp--funcall-if-compiled ',warnfun)
1615 (member element (symbol-value list-var)))
1616 ((eq compare-fn 'eq)
1617 (memq element (symbol-value list-var)))
1618 ((eq compare-fn 'eql)
1619 (memql element (symbol-value list-var)))
1621 (let ((lst (symbol-value list-var)))
1623 (not (funcall compare-fn element (car lst))))
1624 (setq lst (cdr lst)))
1626 (symbol-value list-var)
1629 (append (symbol-value list-var) (list element))
1630 (cons element (symbol-value list-var))))))
1633 (defun add-to-ordered-list (list-var element &optional order)
1634 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1635 The test for presence of ELEMENT is done with `eq'.
1637 The resulting list is reordered so that the elements are in the
1638 order given by each element's numeric list order. Elements
1639 without a numeric list order are placed at the end of the list.
1641 If the third optional argument ORDER is a number (integer or
1642 float), set the element's list order to the given value. If
1643 ORDER is nil or omitted, do not change the numeric order of
1644 ELEMENT. If ORDER has any other value, remove the numeric order
1645 of ELEMENT if it has one.
1647 The list order for each element is stored in LIST-VAR's
1648 `list-order' property.
1650 The return value is the new value of LIST-VAR."
1651 (let ((ordering (get list-var 'list-order)))
1653 (put list-var 'list-order
1654 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1656 (puthash element (and (numberp order) order) ordering))
1657 (unless (memq element (symbol-value list-var))
1658 (set list-var (cons element (symbol-value list-var))))
1659 (set list-var (sort (symbol-value list-var)
1661 (let ((oa (gethash a ordering))
1662 (ob (gethash b ordering)))
1667 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1668 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1669 Return the new history list.
1670 If MAXELT is non-nil, it specifies the maximum length of the history.
1671 Otherwise, the maximum history length is the value of the `history-length'
1672 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1674 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1675 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1676 if it is empty or a duplicate."
1678 (setq maxelt (or (get history-var 'history-length)
1680 (let ((history (symbol-value history-var))
1682 (when (and (listp history)
1684 (not (stringp newelt))
1685 (> (length newelt) 0))
1687 (not (equal (car history) newelt))))
1688 (if history-delete-duplicates
1689 (setq history (delete newelt history)))
1690 (setq history (cons newelt history))
1691 (when (integerp maxelt)
1694 (setq tail (nthcdr (1- maxelt) history))
1696 (setcdr tail nil)))))
1697 (set history-var history)))
1702 (defvar delay-mode-hooks nil
1703 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1704 (defvar delayed-mode-hooks nil
1705 "List of delayed mode hooks waiting to be run.")
1706 (make-variable-buffer-local 'delayed-mode-hooks)
1707 (put 'delay-mode-hooks 'permanent-local t)
1709 (defvar change-major-mode-after-body-hook nil
1710 "Normal hook run in major mode functions, before the mode hooks.")
1712 (defvar after-change-major-mode-hook nil
1713 "Normal hook run at the very end of major mode functions.")
1715 (defun run-mode-hooks (&rest hooks)
1716 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1717 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1718 just adds the HOOKS to the list `delayed-mode-hooks'.
1719 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1720 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1721 `after-change-major-mode-hook'. Major mode functions should use
1722 this instead of `run-hooks' when running their FOO-mode-hook."
1723 (if delay-mode-hooks
1725 (dolist (hook hooks)
1726 (push hook delayed-mode-hooks))
1727 ;; Normal case, just run the hook as before plus any delayed hooks.
1728 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1729 (setq delayed-mode-hooks nil)
1730 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1731 (run-hooks 'after-change-major-mode-hook)))
1733 (defmacro delay-mode-hooks (&rest body)
1734 "Execute BODY, but delay any `run-mode-hooks'.
1735 These hooks will be executed by the first following call to
1736 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1737 Only affects hooks run in the current buffer."
1738 (declare (debug t) (indent 0))
1740 (make-local-variable 'delay-mode-hooks)
1741 (let ((delay-mode-hooks t))
1744 ;; PUBLIC: find if the current mode derives from another.
1746 (defun derived-mode-p (&rest modes)
1747 "Non-nil if the current major mode is derived from one of MODES.
1748 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1749 (let ((parent major-mode))
1750 (while (and (not (memq parent modes))
1751 (setq parent (get parent 'derived-mode-parent))))
1756 ;; If a minor mode is not defined with define-minor-mode,
1757 ;; add it here explicitly.
1758 ;; isearch-mode is deliberately excluded, since you should
1759 ;; not call it yourself.
1760 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1761 overwrite-mode view-mode
1763 "List of all minor mode functions.")
1765 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1766 "Register a new minor mode.
1768 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1770 TOGGLE is a symbol which is the name of a buffer-local variable that
1771 is toggled on or off to say whether the minor mode is active or not.
1773 NAME specifies what will appear in the mode line when the minor mode
1774 is active. NAME should be either a string starting with a space, or a
1775 symbol whose value is such a string.
1777 Optional KEYMAP is the keymap for the minor mode that will be added
1778 to `minor-mode-map-alist'.
1780 Optional AFTER specifies that TOGGLE should be added after AFTER
1781 in `minor-mode-alist'.
1783 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1784 It defaults to (and should by convention be) TOGGLE.
1786 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1787 included in the mode-line minor mode menu.
1788 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1789 (unless (memq toggle minor-mode-list)
1790 (push toggle minor-mode-list))
1792 (unless toggle-fun (setq toggle-fun toggle))
1793 (unless (eq toggle-fun toggle)
1794 (put toggle :minor-mode-function toggle-fun))
1795 ;; Add the name to the minor-mode-alist.
1797 (let ((existing (assq toggle minor-mode-alist)))
1799 (setcdr existing (list name))
1800 (let ((tail minor-mode-alist) found)
1801 (while (and tail (not found))
1802 (if (eq after (caar tail))
1804 (setq tail (cdr tail))))
1806 (let ((rest (cdr found)))
1808 (nconc found (list (list toggle name)) rest))
1809 (push (list toggle name) minor-mode-alist))))))
1810 ;; Add the toggle to the minor-modes menu if requested.
1811 (when (get toggle :included)
1812 (define-key mode-line-mode-menu
1816 (or (get toggle :menu-tag)
1817 (if (stringp name) name (symbol-name toggle)))
1818 (let ((mode-name (if (symbolp name) (symbol-value name))))
1819 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1820 (concat " (" (match-string 0 mode-name) ")"))))
1822 :button (cons :toggle toggle))))
1824 ;; Add the map to the minor-mode-map-alist.
1826 (let ((existing (assq toggle minor-mode-map-alist)))
1828 (setcdr existing keymap)
1829 (let ((tail minor-mode-map-alist) found)
1830 (while (and tail (not found))
1831 (if (eq after (caar tail))
1833 (setq tail (cdr tail))))
1835 (let ((rest (cdr found)))
1837 (nconc found (list (cons toggle keymap)) rest))
1838 (push (cons toggle keymap) minor-mode-map-alist)))))))
1842 (defsubst autoloadp (object)
1843 "Non-nil if OBJECT is an autoload."
1844 (eq 'autoload (car-safe object)))
1846 ;; (defun autoload-type (object)
1847 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1848 ;; OBJECT should be an autoload object."
1849 ;; (when (autoloadp object)
1850 ;; (let ((type (nth 3 object)))
1851 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1852 ;; ((eq 'keymap t) 'macro)
1855 ;; (defalias 'autoload-file #'cadr
1856 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1857 ;; \n\(fn AUTOLOAD)")
1859 (defun symbol-file (symbol &optional type)
1860 "Return the name of the file that defined SYMBOL.
1861 The value is normally an absolute file name. It can also be nil,
1862 if the definition is not associated with any file. If SYMBOL
1863 specifies an autoloaded function, the value can be a relative
1864 file name without extension.
1866 If TYPE is nil, then any kind of definition is acceptable. If
1867 TYPE is `defun', `defvar', or `defface', that specifies function
1868 definition, variable definition, or face definition only."
1869 (if (and (or (null type) (eq type 'defun))
1871 (autoloadp (symbol-function symbol)))
1872 (nth 1 (symbol-function symbol))
1873 (let ((files load-history)
1877 (if (eq type 'defvar)
1878 ;; Variables are present just as their names.
1879 (member symbol (cdr (car files)))
1880 ;; Other types are represented as (TYPE . NAME).
1881 (member (cons type symbol) (cdr (car files))))
1882 ;; We accept all types, so look for variable def
1883 ;; and then for any other kind.
1884 (or (member symbol (cdr (car files)))
1885 (rassq symbol (cdr (car files)))))
1886 (setq file (car (car files)) files nil))
1887 (setq files (cdr files)))
1890 (defun locate-library (library &optional nosuffix path interactive-call)
1891 "Show the precise file name of Emacs library LIBRARY.
1892 LIBRARY should be a relative file name of the library, a string.
1893 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1894 nil (which is the default, see below).
1895 This command searches the directories in `load-path' like `\\[load-library]'
1896 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1897 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1898 to the specified name LIBRARY.
1900 If the optional third arg PATH is specified, that list of directories
1901 is used instead of `load-path'.
1903 When called from a program, the file name is normally returned as a
1904 string. When run interactively, the argument INTERACTIVE-CALL is t,
1905 and the file name is displayed in the echo area."
1906 (interactive (list (completing-read "Locate library: "
1908 'locate-file-completion-table
1909 load-path (get-load-suffixes)))
1912 (let ((file (locate-file library
1914 (append (unless nosuffix (get-load-suffixes))
1915 load-file-rep-suffixes))))
1916 (if interactive-call
1918 (message "Library is file %s" (abbreviate-file-name file))
1919 (message "No library %s in search path" library)))
1925 (defun start-process (name buffer program &rest program-args)
1926 "Start a program in a subprocess. Return the process object for it.
1927 NAME is name for process. It is modified if necessary to make it unique.
1928 BUFFER is the buffer (or buffer name) to associate with the process.
1930 Process output (both standard output and standard error streams) goes
1931 at end of BUFFER, unless you specify an output stream or filter
1932 function to handle the output. BUFFER may also be nil, meaning that
1933 this process is not associated with any buffer.
1935 PROGRAM is the program file name. It is searched for in `exec-path'
1936 \(which see). If nil, just associate a pty with the buffer. Remaining
1937 arguments are strings to give program as arguments.
1939 If you want to separate standard output from standard error, invoke
1940 the command through a shell and redirect one of them using the shell
1942 (unless (fboundp 'make-process)
1943 (error "Emacs was compiled without subprocess support"))
1944 (apply #'make-process
1945 (append (list :name name :buffer buffer)
1947 (list :command (cons program program-args))))))
1949 (defun process-lines (program &rest args)
1950 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1951 Signal an error if the program returns with a non-zero exit status."
1953 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1954 (unless (eq status 0)
1955 (error "%s exited with status %s" program status))
1956 (goto-char (point-min))
1959 (setq lines (cons (buffer-substring-no-properties
1960 (line-beginning-position)
1961 (line-end-position))
1964 (nreverse lines)))))
1966 (defun process-live-p (process)
1967 "Returns non-nil if PROCESS is alive.
1968 A process is considered alive if its status is `run', `open',
1969 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
1971 (and (processp process)
1972 (memq (process-status process)
1973 '(run open listen connect stop))))
1978 'process-kill-without-query
1979 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1981 (defun process-kill-without-query (process &optional _flag)
1982 "Say no query needed if PROCESS is running when Emacs is exited.
1983 Optional second argument if non-nil says to require a query.
1984 Value is t if a query was formerly required."
1985 (let ((old (process-query-on-exit-flag process)))
1986 (set-process-query-on-exit-flag process nil)
1989 (defun process-kill-buffer-query-function ()
1990 "Ask before killing a buffer that has a running process."
1991 (let ((process (get-buffer-process (current-buffer))))
1993 (not (memq (process-status process) '(run stop open listen)))
1994 (not (process-query-on-exit-flag process))
1996 (format "Buffer %S has a running process; kill it? "
1997 (buffer-name (current-buffer)))))))
1999 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
2001 ;; process plist management
2003 (defun process-get (process propname)
2004 "Return the value of PROCESS' PROPNAME property.
2005 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
2006 (plist-get (process-plist process) propname))
2008 (defun process-put (process propname value)
2009 "Change PROCESS' PROPNAME property to VALUE.
2010 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2011 (set-process-plist process
2012 (plist-put (process-plist process) propname value)))
2015 ;;;; Input and display facilities.
2017 (defconst read-key-empty-map (make-sparse-keymap))
2019 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2021 (defun read-key (&optional prompt)
2022 "Read a key from the keyboard.
2023 Contrary to `read-event' this will not return a raw event but instead will
2024 obey the input decoding and translations usually done by `read-key-sequence'.
2025 So escape sequences and keyboard encoding are taken into account.
2026 When there's an ambiguity because the key looks like the prefix of
2027 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2028 ;; This overriding-terminal-local-map binding also happens to
2029 ;; disable quail's input methods, so although read-key-sequence
2030 ;; always inherits the input method, in practice read-key does not
2031 ;; inherit the input method (at least not if it's based on quail).
2032 (let ((overriding-terminal-local-map nil)
2033 (overriding-local-map read-key-empty-map)
2035 (old-global-map (current-global-map))
2036 (timer (run-with-idle-timer
2037 ;; Wait long enough that Emacs has the time to receive and
2038 ;; process all the raw events associated with the single-key.
2039 ;; But don't wait too long, or the user may find the delay
2040 ;; annoying (or keep hitting more keys which may then get
2041 ;; lost or misinterpreted).
2042 ;; This is only relevant for keys which Emacs perceives as
2043 ;; "prefixes", such as C-x (because of the C-x 8 map in
2044 ;; key-translate-table and the C-x @ map in function-key-map)
2045 ;; or ESC (because of terminal escape sequences in
2046 ;; input-decode-map).
2049 (let ((keys (this-command-keys-vector)))
2050 (unless (zerop (length keys))
2051 ;; `keys' is non-empty, so the user has hit at least
2052 ;; one key; there's no point waiting any longer, even
2053 ;; though read-key-sequence thinks we should wait
2054 ;; for more input to decide how to interpret the
2056 (throw 'read-key keys)))))))
2060 (let ((map (make-sparse-keymap)))
2061 ;; Don't hide the menu-bar and tool-bar entries.
2062 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2063 (define-key map [tool-bar]
2064 ;; This hack avoids evaluating the :filter (Bug#9922).
2065 (or (cdr (assq 'tool-bar global-map))
2066 (lookup-key global-map [tool-bar])))
2069 (catch 'read-key (read-key-sequence-vector prompt nil t)))
2070 (key (aref keys 0)))
2071 (if (and (> (length keys) 1)
2072 (memq key '(mode-line header-line
2073 left-fringe right-fringe)))
2076 (cancel-timer timer)
2077 (use-global-map old-global-map))))
2079 (defvar read-passwd-map
2080 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2081 ;; minibuffer-local-map along the way!
2082 (let ((map (make-sparse-keymap)))
2083 (set-keymap-parent map minibuffer-local-map)
2084 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2086 "Keymap used while reading passwords.")
2088 (defun read-passwd (prompt &optional confirm default)
2089 "Read a password, prompting with PROMPT, and return it.
2090 If optional CONFIRM is non-nil, read the password twice to make sure.
2091 Optional DEFAULT is a default password to use instead of empty input.
2093 This function echoes `.' for each character that the user types.
2094 You could let-bind `read-hide-char' to another hiding character, though.
2096 Once the caller uses the password, it can erase the password
2097 by doing (clear-string STRING)."
2100 (while (not success)
2101 (let ((first (read-passwd prompt nil default))
2102 (second (read-passwd "Confirm password: " nil default)))
2103 (if (equal first second)
2105 (and (arrayp second) (clear-string second))
2106 (setq success first))
2107 (and (arrayp first) (clear-string first))
2108 (and (arrayp second) (clear-string second))
2109 (message "Password not repeated accurately; please start over")
2112 (let ((hide-chars-fun
2113 (lambda (beg end _len)
2114 (clear-this-command-keys)
2115 (setq beg (min end (max (minibuffer-prompt-end)
2117 (dotimes (i (- end beg))
2118 (put-text-property (+ i beg) (+ 1 i beg)
2119 'display (string (or read-hide-char ?.))))))
2121 (minibuffer-with-setup-hook
2123 (setq minibuf (current-buffer))
2124 ;; Turn off electricity.
2125 (setq-local post-self-insert-hook nil)
2126 (setq-local buffer-undo-list t)
2127 (setq-local select-active-regions nil)
2128 (use-local-map read-passwd-map)
2129 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2130 (setq-local show-paren-mode nil) ;bug#16091.
2131 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2133 (let ((enable-recursive-minibuffers t)
2134 (read-hide-char (or read-hide-char ?.)))
2135 (read-string prompt nil t default)) ; t = "no history"
2136 (when (buffer-live-p minibuf)
2137 (with-current-buffer minibuf
2138 ;; Not sure why but it seems that there might be cases where the
2139 ;; minibuffer is not always properly reset later on, so undo
2140 ;; whatever we've done here (bug#11392).
2141 (remove-hook 'after-change-functions hide-chars-fun 'local)
2142 (kill-local-variable 'post-self-insert-hook)
2143 ;; And of course, don't keep the sensitive data around.
2144 (erase-buffer))))))))
2146 (defun read-number (prompt &optional default)
2147 "Read a numeric value in the minibuffer, prompting with PROMPT.
2148 DEFAULT specifies a default value to return if the user just types RET.
2149 The value of DEFAULT is inserted into PROMPT.
2150 This function is used by the `interactive' code letter `n'."
2152 (default1 (if (consp default) (car default) default)))
2155 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2156 (replace-match (format " (default %s)" default1) t t prompt 1)
2157 (replace-regexp-in-string "[ \t]*\\'"
2158 (format " (default %s) " default1)
2162 (let ((str (read-from-minibuffer
2163 prompt nil nil nil nil
2166 (mapcar 'number-to-string (delq nil default))
2167 (number-to-string default))))))
2170 ((zerop (length str)) default1)
2171 ((stringp str) (read str))))
2174 (message "Please enter a number.")
2179 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2180 "Read and return one of CHARS, prompting for PROMPT.
2181 Any input that is not one of CHARS is ignored.
2183 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2184 keyboard-quit events while waiting for a valid input."
2185 (unless (consp chars)
2186 (error "Called `read-char-choice' without valid char choices"))
2187 (let (char done show-help (helpbuf " *Char Help*"))
2188 (let ((cursor-in-echo-area t)
2189 (executing-kbd-macro executing-kbd-macro)
2191 (save-window-excursion ; in case we call help-form-show
2193 (unless (get-text-property 0 'face prompt)
2194 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2195 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2197 (and show-help (buffer-live-p (get-buffer helpbuf))
2198 (kill-buffer helpbuf))
2200 ((not (numberp char)))
2201 ;; If caller has set help-form, that's enough.
2202 ;; They don't explicitly have to add help-char to chars.
2209 ((and executing-kbd-macro (= char -1))
2210 ;; read-event returns -1 if we are in a kbd macro and
2211 ;; there are no more events in the macro. Attempt to
2212 ;; get an event interactively.
2213 (setq executing-kbd-macro nil))
2214 ((not inhibit-keyboard-quit)
2216 ((and (null esc-flag) (eq char ?\e))
2218 ((memq char '(?\C-g ?\e))
2219 (keyboard-quit))))))))
2220 ;; Display the question with the answer. But without cursor-in-echo-area.
2221 (message "%s%s" prompt (char-to-string char))
2224 (defun sit-for (seconds &optional nodisp obsolete)
2225 "Redisplay, then wait for SECONDS seconds. Stop when input is available.
2226 SECONDS may be a floating-point value.
2227 \(On operating systems that do not support waiting for fractions of a
2228 second, floating-point values are rounded down to the nearest integer.)
2230 If optional arg NODISP is t, don't redisplay, just wait for input.
2231 Redisplay does not happen if input is available before it starts.
2233 Value is t if waited the full time with no input arriving, and nil otherwise.
2235 An obsolete, but still supported form is
2236 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2237 where the optional arg MILLISECONDS specifies an additional wait period,
2238 in milliseconds; this was useful when Emacs was built without
2239 floating point support."
2240 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2241 ;; This used to be implemented in C until the following discussion:
2242 ;; http://lists.gnu.org/archive/html/emacs-devel/2006-07/msg00401.html
2243 ;; Then it was moved here using an implementation based on an idle timer,
2244 ;; which was then replaced by the use of read-event.
2245 (if (numberp nodisp)
2246 (setq seconds (+ seconds (* 1e-3 nodisp))
2248 (if obsolete (setq nodisp obsolete)))
2253 ((input-pending-p t)
2256 (or nodisp (redisplay)))
2258 (or nodisp (redisplay))
2259 ;; FIXME: we should not read-event here at all, because it's much too
2260 ;; difficult to reliably "undo" a read-event by pushing it onto
2261 ;; unread-command-events.
2262 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2263 ;; decoding (hence non-nil as second arg under POSIX ttys).
2264 ;; For bug#15614, we need read-event not to inherit-input-method.
2265 ;; So we temporarily suspend input-method-function.
2266 (let ((read (let ((input-method-function nil))
2267 (read-event nil t seconds))))
2270 ;; https://lists.gnu.org/archive/html/emacs-devel/2006-10/msg00394.html
2271 ;; We want `read' appear in the next command's this-command-event
2272 ;; but not in the current one.
2273 ;; By pushing (cons t read), we indicate that `read' has not
2274 ;; yet been recorded in this-command-keys, so it will be recorded
2275 ;; next time it's read.
2276 ;; And indeed the `seconds' argument to read-event correctly
2277 ;; prevented recording this event in the current command's
2278 ;; this-command-keys.
2279 (push (cons t read) unread-command-events)
2282 ;; Behind display-popup-menus-p test.
2283 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2285 (defun y-or-n-p (prompt)
2286 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2287 PROMPT is the string to display to ask the question. It should
2288 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2290 No confirmation of the answer is requested; a single character is
2291 enough. SPC also means yes, and DEL means no.
2293 To be precise, this function translates user input into responses
2294 by consulting the bindings in `query-replace-map'; see the
2295 documentation of that variable for more information. In this
2296 case, the useful bindings are `act', `skip', `recenter',
2297 `scroll-up', `scroll-down', and `quit'.
2298 An `act' response means yes, and a `skip' response means no.
2299 A `quit' response means to invoke `keyboard-quit'.
2300 If the user enters `recenter', `scroll-up', or `scroll-down'
2301 responses, perform the requested window recentering or scrolling
2304 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2305 is nil and `use-dialog-box' is non-nil."
2306 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2307 ;; where all the keys were unbound (i.e. it somehow got triggered
2308 ;; within read-key, apparently). I had to kill it.
2309 (let ((answer 'recenter)
2310 (padded (lambda (prompt &optional dialog)
2311 (let ((l (length prompt)))
2313 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2315 (if dialog "" "(y or n) "))))))
2318 (setq prompt (funcall padded prompt))
2319 (let ((temp-prompt prompt))
2320 (while (not (memq answer '(act skip)))
2321 (let ((str (read-string temp-prompt)))
2322 (cond ((member str '("y" "Y")) (setq answer 'act))
2323 ((member str '("n" "N")) (setq answer 'skip))
2324 (t (setq temp-prompt (concat "Please answer y or n. "
2326 ((and (display-popup-menus-p)
2327 (listp last-nonmenu-event)
2329 (setq prompt (funcall padded prompt t)
2330 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2332 (setq prompt (funcall padded prompt))
2334 (let* ((scroll-actions '(recenter scroll-up scroll-down
2335 scroll-other-window scroll-other-window-down))
2337 (let ((cursor-in-echo-area t))
2338 (when minibuffer-auto-raise
2339 (raise-frame (window-frame (minibuffer-window))))
2340 (read-key (propertize (if (memq answer scroll-actions)
2342 (concat "Please answer y or n. "
2344 'face 'minibuffer-prompt)))))
2345 (setq answer (lookup-key query-replace-map (vector key) t))
2347 ((memq answer '(skip act)) nil)
2348 ((eq answer 'recenter)
2350 ((eq answer 'scroll-up)
2351 (ignore-errors (scroll-up-command)) t)
2352 ((eq answer 'scroll-down)
2353 (ignore-errors (scroll-down-command)) t)
2354 ((eq answer 'scroll-other-window)
2355 (ignore-errors (scroll-other-window)) t)
2356 ((eq answer 'scroll-other-window-down)
2357 (ignore-errors (scroll-other-window-down)) t)
2358 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2359 (signal 'quit nil) t)
2363 (let ((ret (eq answer 'act)))
2364 (unless noninteractive
2365 (message "%s%c" prompt (if ret ?y ?n)))
2369 ;;; Atomic change groups.
2371 (defmacro atomic-change-group (&rest body)
2372 "Perform BODY as an atomic change group.
2373 This means that if BODY exits abnormally,
2374 all of its changes to the current buffer are undone.
2375 This works regardless of whether undo is enabled in the buffer.
2377 This mechanism is transparent to ordinary use of undo;
2378 if undo is enabled in the buffer and BODY succeeds, the
2379 user can undo the change normally."
2380 (declare (indent 0) (debug t))
2381 (let ((handle (make-symbol "--change-group-handle--"))
2382 (success (make-symbol "--change-group-success--")))
2383 `(let ((,handle (prepare-change-group))
2384 ;; Don't truncate any undo data in the middle of this.
2385 (undo-outer-limit nil)
2386 (undo-limit most-positive-fixnum)
2387 (undo-strong-limit most-positive-fixnum)
2391 ;; This is inside the unwind-protect because
2392 ;; it enables undo if that was disabled; we need
2393 ;; to make sure that it gets disabled again.
2394 (activate-change-group ,handle)
2397 ;; Either of these functions will disable undo
2398 ;; if it was disabled before.
2400 (accept-change-group ,handle)
2401 (cancel-change-group ,handle))))))
2403 (defun prepare-change-group (&optional buffer)
2404 "Return a handle for the current buffer's state, for a change group.
2405 If you specify BUFFER, make a handle for BUFFER's state instead.
2407 Pass the handle to `activate-change-group' afterward to initiate
2408 the actual changes of the change group.
2410 To finish the change group, call either `accept-change-group' or
2411 `cancel-change-group' passing the same handle as argument. Call
2412 `accept-change-group' to accept the changes in the group as final;
2413 call `cancel-change-group' to undo them all. You should use
2414 `unwind-protect' to make sure the group is always finished. The call
2415 to `activate-change-group' should be inside the `unwind-protect'.
2416 Once you finish the group, don't use the handle again--don't try to
2417 finish the same group twice. For a simple example of correct use, see
2418 the source code of `atomic-change-group'.
2420 The handle records only the specified buffer. To make a multibuffer
2421 change group, call this function once for each buffer you want to
2422 cover, then use `nconc' to combine the returned values, like this:
2424 (nconc (prepare-change-group buffer-1)
2425 (prepare-change-group buffer-2))
2427 You can then activate that multibuffer change group with a single
2428 call to `activate-change-group' and finish it with a single call
2429 to `accept-change-group' or `cancel-change-group'."
2432 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2433 (list (cons (current-buffer) buffer-undo-list))))
2435 (defun activate-change-group (handle)
2436 "Activate a change group made with `prepare-change-group' (which see)."
2437 (dolist (elt handle)
2438 (with-current-buffer (car elt)
2439 (if (eq buffer-undo-list t)
2440 (setq buffer-undo-list nil)))))
2442 (defun accept-change-group (handle)
2443 "Finish a change group made with `prepare-change-group' (which see).
2444 This finishes the change group by accepting its changes as final."
2445 (dolist (elt handle)
2446 (with-current-buffer (car elt)
2447 (if (eq (cdr elt) t)
2448 (setq buffer-undo-list t)))))
2450 (defun cancel-change-group (handle)
2451 "Finish a change group made with `prepare-change-group' (which see).
2452 This finishes the change group by reverting all of its changes."
2453 (dolist (elt handle)
2454 (with-current-buffer (car elt)
2455 (setq elt (cdr elt))
2457 ;; Widen buffer temporarily so if the buffer was narrowed within
2458 ;; the body of `atomic-change-group' all changes can be undone.
2461 (if (consp elt) (car elt)))
2463 (if (consp elt) (cdr elt))))
2464 ;; Temporarily truncate the undo log at ELT.
2466 (setcar elt nil) (setcdr elt nil))
2467 (unless (eq last-command 'undo) (undo-start))
2468 ;; Make sure there's no confusion.
2469 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2470 (error "Undoing to some unrelated state"))
2473 (while (listp pending-undo-list) (undo-more 1)))
2474 ;; Reset the modified cons cell ELT to its original content.
2476 (setcar elt old-car)
2477 (setcdr elt old-cdr))
2478 ;; Revert the undo info to what it was when we grabbed the state.
2479 (setq buffer-undo-list elt))))))
2481 ;;;; Display-related functions.
2483 ;; For compatibility.
2484 (define-obsolete-function-alias 'redraw-modeline
2485 'force-mode-line-update "24.3")
2487 (defun momentary-string-display (string pos &optional exit-char message)
2488 "Momentarily display STRING in the buffer at POS.
2489 Display remains until next event is input.
2490 If POS is a marker, only its position is used; its buffer is ignored.
2491 Optional third arg EXIT-CHAR can be a character, event or event
2492 description list. EXIT-CHAR defaults to SPC. If the input is
2493 EXIT-CHAR it is swallowed; otherwise it is then available as
2494 input (as a command if nothing else).
2495 Display MESSAGE (optional fourth arg) in the echo area.
2496 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2497 (or exit-char (setq exit-char ?\s))
2498 (let ((ol (make-overlay pos pos))
2499 (str (copy-sequence string)))
2503 (overlay-put ol 'after-string str)
2505 ;; To avoid trouble with out-of-bounds position
2507 ;; If the string end is off screen, recenter now.
2508 (if (<= (window-end nil t) pos)
2509 (recenter (/ (window-height) 2))))
2510 (message (or message "Type %s to continue editing.")
2511 (single-key-description exit-char))
2512 (let ((event (read-key)))
2513 ;; `exit-char' can be an event, or an event description list.
2514 (or (eq event exit-char)
2515 (eq event (event-convert-list exit-char))
2516 (setq unread-command-events
2517 (append (this-single-command-raw-keys))))))
2518 (delete-overlay ol))))
2521 ;;;; Overlay operations
2523 (defun copy-overlay (o)
2524 "Return a copy of overlay O."
2525 (let ((o1 (if (overlay-buffer o)
2526 (make-overlay (overlay-start o) (overlay-end o)
2527 ;; FIXME: there's no easy way to find the
2528 ;; insertion-type of the two markers.
2530 (let ((o1 (make-overlay (point-min) (point-min))))
2533 (props (overlay-properties o)))
2535 (overlay-put o1 (pop props) (pop props)))
2538 (defun remove-overlays (&optional beg end name val)
2539 "Clear BEG and END of overlays whose property NAME has value VAL.
2540 Overlays might be moved and/or split.
2541 BEG and END default respectively to the beginning and end of buffer."
2542 ;; This speeds up the loops over overlays.
2543 (unless beg (setq beg (point-min)))
2544 (unless end (setq end (point-max)))
2545 (overlay-recenter end)
2547 (setq beg (prog1 end (setq end beg))))
2549 (dolist (o (overlays-in beg end))
2550 (when (eq (overlay-get o name) val)
2551 ;; Either push this overlay outside beg...end
2552 ;; or split it to exclude beg...end
2553 ;; or delete it entirely (if it is contained in beg...end).
2554 (if (< (overlay-start o) beg)
2555 (if (> (overlay-end o) end)
2557 (move-overlay (copy-overlay o)
2558 (overlay-start o) beg)
2559 (move-overlay o end (overlay-end o)))
2560 (move-overlay o (overlay-start o) beg))
2561 (if (> (overlay-end o) end)
2562 (move-overlay o end (overlay-end o))
2563 (delete-overlay o)))))))
2567 (defvar suspend-hook nil
2568 "Normal hook run by `suspend-emacs', before suspending.")
2570 (defvar suspend-resume-hook nil
2571 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2573 (defvar temp-buffer-show-hook nil
2574 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2575 When the hook runs, the temporary buffer is current, and the window it
2576 was displayed in is selected.")
2578 (defvar temp-buffer-setup-hook nil
2579 "Normal hook run by `with-output-to-temp-buffer' at the start.
2580 When the hook runs, the temporary buffer is current.
2581 This hook is normally set up with a function to put the buffer in Help
2584 (defconst user-emacs-directory
2585 (if (eq system-type 'ms-dos)
2586 ;; MS-DOS cannot have initial dot.
2589 "Directory beneath which additional per-user Emacs-specific files are placed.
2590 Various programs in Emacs store information in this directory.
2591 Note that this should end with a directory separator.
2592 See also `locate-user-emacs-file'.")
2594 ;;;; Misc. useful functions.
2596 (defsubst buffer-narrowed-p ()
2597 "Return non-nil if the current buffer is narrowed."
2598 (/= (- (point-max) (point-min)) (buffer-size)))
2600 (defun find-tag-default-bounds ()
2601 "Determine the boundaries of the default tag, based on text at point.
2602 Return a cons cell with the beginning and end of the found tag.
2603 If there is no plausible default, return nil."
2604 (let (from to bound)
2606 ;; Look at text around `point'.
2608 (skip-syntax-backward "w_") (setq from (point)))
2610 (skip-syntax-forward "w_") (setq to (point)))
2612 ;; Look between `line-beginning-position' and `point'.
2614 (and (setq bound (line-beginning-position))
2615 (skip-syntax-backward "^w_" bound)
2616 (> (setq to (point)) bound)
2617 (skip-syntax-backward "w_")
2618 (setq from (point))))
2619 ;; Look between `point' and `line-end-position'.
2621 (and (setq bound (line-end-position))
2622 (skip-syntax-forward "^w_" bound)
2623 (< (setq from (point)) bound)
2624 (skip-syntax-forward "w_")
2625 (setq to (point)))))
2628 (defun find-tag-default ()
2629 "Determine default tag to search for, based on text at point.
2630 If there is no plausible default, return nil."
2631 (let ((bounds (find-tag-default-bounds)))
2633 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2635 (defun find-tag-default-as-regexp ()
2636 "Return regexp that matches the default tag at point.
2637 If there is no tag at point, return nil.
2639 When in a major mode that does not provide its own
2640 `find-tag-default-function', return a regexp that matches the
2641 symbol at point exactly."
2642 (let ((tag (funcall (or find-tag-default-function
2643 (get major-mode 'find-tag-default-function)
2644 'find-tag-default))))
2645 (if tag (regexp-quote tag))))
2647 (defun find-tag-default-as-symbol-regexp ()
2648 "Return regexp that matches the default tag at point as symbol.
2649 If there is no tag at point, return nil.
2651 When in a major mode that does not provide its own
2652 `find-tag-default-function', return a regexp that matches the
2653 symbol at point exactly."
2654 (let ((tag-regexp (find-tag-default-as-regexp)))
2656 (eq (or find-tag-default-function
2657 (get major-mode 'find-tag-default-function)
2660 (format "\\_<%s\\_>" tag-regexp)
2663 (defun play-sound (sound)
2664 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2665 The following keywords are recognized:
2667 :file FILE - read sound data from FILE. If FILE isn't an
2668 absolute file name, it is searched in `data-directory'.
2670 :data DATA - read sound data from string DATA.
2672 Exactly one of :file or :data must be present.
2674 :volume VOL - set volume to VOL. VOL must an integer in the
2675 range 0..100 or a float in the range 0..1.0. If not specified,
2676 don't change the volume setting of the sound device.
2678 :device DEVICE - play sound on DEVICE. If not specified,
2679 a system-dependent default device name is used.
2681 Note: :data and :device are currently not supported on Windows."
2682 (if (fboundp 'play-sound-internal)
2683 (play-sound-internal sound)
2684 (error "This Emacs binary lacks sound support")))
2686 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2688 (defun shell-quote-argument (argument)
2689 "Quote ARGUMENT for passing as argument to an inferior shell."
2691 ((eq system-type 'ms-dos)
2692 ;; Quote using double quotes, but escape any existing quotes in
2693 ;; the argument with backslashes.
2697 (if (or (null (string-match "[^\"]" argument))
2698 (< (match-end 0) (length argument)))
2699 (while (string-match "[\"]" argument start)
2700 (setq end (match-beginning 0)
2701 result (concat result (substring argument start end)
2702 "\\" (substring argument end (1+ end)))
2704 (concat "\"" result (substring argument start) "\"")))
2706 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2708 ;; First, quote argument so that CommandLineToArgvW will
2709 ;; understand it. See
2710 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2711 ;; After we perform that level of quoting, escape shell
2712 ;; metacharacters so that cmd won't mangle our argument. If the
2713 ;; argument contains no double quote characters, we can just
2714 ;; surround it with double quotes. Otherwise, we need to prefix
2715 ;; each shell metacharacter with a caret.
2718 ;; escape backslashes at end of string
2719 (replace-regexp-in-string
2722 ;; escape backslashes and quotes in string body
2723 (replace-regexp-in-string
2728 (if (string-match "[%!\"]" argument)
2731 (replace-regexp-in-string
2732 "\\([%!()\"<>&|^]\\)"
2736 (concat "\"" argument "\"")))
2739 (if (equal argument "")
2741 ;; Quote everything except POSIX filename characters.
2742 ;; This should be safe enough even for really weird shells.
2743 (replace-regexp-in-string
2745 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2748 (defun string-or-null-p (object)
2749 "Return t if OBJECT is a string or nil.
2750 Otherwise, return nil."
2751 (or (stringp object) (null object)))
2753 (defun booleanp (object)
2754 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2755 Otherwise, return nil."
2756 (and (memq object '(nil t)) t))
2758 (defun special-form-p (object)
2759 "Non-nil if and only if OBJECT is a special form."
2760 (if (and (symbolp object) (fboundp object))
2761 (setq object (indirect-function object t)))
2762 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2764 (defun macrop (object)
2765 "Non-nil if and only if OBJECT is a macro."
2766 (let ((def (indirect-function object t)))
2768 (or (eq 'macro (car def))
2769 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2771 (defun field-at-pos (pos)
2772 "Return the field at position POS, taking stickiness etc into account."
2773 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2774 (if (eq raw-field 'boundary)
2775 (get-char-property (1- (field-end pos)) 'field)
2778 (defun sha1 (object &optional start end binary)
2779 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2780 OBJECT is either a string or a buffer. Optional arguments START and
2781 END are character positions specifying which portion of OBJECT for
2782 computing the hash. If BINARY is non-nil, return a string in binary
2784 (secure-hash 'sha1 object start end binary))
2786 (defun function-get (f prop &optional autoload)
2787 "Return the value of property PROP of function F.
2788 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2789 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2790 if it's an autoloaded macro."
2792 (while (and (symbolp f)
2793 (null (setq val (get f prop)))
2795 (let ((fundef (symbol-function f)))
2796 (if (and autoload (autoloadp fundef)
2798 (autoload-do-load fundef f
2799 (if (eq autoload 'macro)
2801 nil ;Re-try `get' on the same `f'.
2805 ;;;; Support for yanking and text properties.
2806 ;; Why here in subr.el rather than in simple.el? --Stef
2808 (defvar yank-handled-properties)
2809 (defvar yank-excluded-properties)
2811 (defun remove-yank-excluded-properties (start end)
2812 "Process text properties between START and END, inserted for a `yank'.
2813 Perform the handling specified by `yank-handled-properties', then
2814 remove properties specified by `yank-excluded-properties'."
2815 (let ((inhibit-read-only t))
2816 (dolist (handler yank-handled-properties)
2817 (let ((prop (car handler))
2820 (while (< run-start end)
2821 (let ((value (get-text-property run-start prop))
2822 (run-end (next-single-property-change
2823 run-start prop nil end)))
2824 (funcall fun value run-start run-end)
2825 (setq run-start run-end)))))
2826 (if (eq yank-excluded-properties t)
2827 (set-text-properties start end nil)
2828 (remove-list-of-text-properties start end yank-excluded-properties))))
2830 (defvar yank-undo-function)
2832 (defun insert-for-yank (string)
2833 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2835 See `insert-for-yank-1' for more details."
2837 (while (setq to (next-single-property-change 0 'yank-handler string))
2838 (insert-for-yank-1 (substring string 0 to))
2839 (setq string (substring string to))))
2840 (insert-for-yank-1 string))
2842 (defun insert-for-yank-1 (string)
2843 "Insert STRING at point for the `yank' command.
2844 This function is like `insert', except it honors the variables
2845 `yank-handled-properties' and `yank-excluded-properties', and the
2846 `yank-handler' text property.
2848 Properties listed in `yank-handled-properties' are processed,
2849 then those listed in `yank-excluded-properties' are discarded.
2851 If STRING has a non-nil `yank-handler' property on its first
2852 character, the normal insert behavior is altered. The value of
2853 the `yank-handler' property must be a list of one to four
2854 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2855 FUNCTION, if non-nil, should be a function of one argument, an
2856 object to insert; it is called instead of `insert'.
2857 PARAM, if present and non-nil, replaces STRING as the argument to
2858 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2859 may be a list of strings to insert as a rectangle.
2860 If NOEXCLUDE is present and non-nil, the normal removal of
2861 `yank-excluded-properties' is not performed; instead FUNCTION is
2862 responsible for the removal. This may be necessary if FUNCTION
2863 adjusts point before or after inserting the object.
2864 UNDO, if present and non-nil, should be a function to be called
2865 by `yank-pop' to undo the insertion of the current object. It is
2866 given two arguments, the start and end of the region. FUNCTION
2867 may set `yank-undo-function' to override UNDO."
2868 (let* ((handler (and (stringp string)
2869 (get-text-property 0 'yank-handler string)))
2870 (param (or (nth 1 handler) string))
2872 (inhibit-read-only inhibit-read-only)
2875 (setq yank-undo-function t)
2876 (if (nth 0 handler) ; FUNCTION
2877 (funcall (car handler) param)
2881 ;; Prevent read-only properties from interfering with the
2882 ;; following text property changes.
2883 (setq inhibit-read-only t)
2885 (unless (nth 2 handler) ; NOEXCLUDE
2886 (remove-yank-excluded-properties opoint end))
2888 ;; If last inserted char has properties, mark them as rear-nonsticky.
2889 (if (and (> end opoint)
2890 (text-properties-at (1- end)))
2891 (put-text-property (1- end) end 'rear-nonsticky t))
2893 (if (eq yank-undo-function t) ; not set by FUNCTION
2894 (setq yank-undo-function (nth 3 handler))) ; UNDO
2895 (if (nth 4 handler) ; COMMAND
2896 (setq this-command (nth 4 handler)))))
2898 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2899 "Insert before point a substring of BUFFER, without 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 (let ((opoint (point)))
2904 (insert-buffer-substring buffer start end)
2905 (let ((inhibit-read-only t))
2906 (set-text-properties opoint (point) nil))))
2908 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2909 "Insert before point a part of BUFFER, stripping some text properties.
2910 BUFFER may be a buffer or a buffer name.
2911 Arguments START and END are character positions specifying the substring.
2912 They default to the values of (point-min) and (point-max) in BUFFER.
2913 Before insertion, process text properties according to
2914 `yank-handled-properties' and `yank-excluded-properties'."
2915 ;; Since the buffer text should not normally have yank-handler properties,
2916 ;; there is no need to handle them here.
2917 (let ((opoint (point)))
2918 (insert-buffer-substring buffer start end)
2919 (remove-yank-excluded-properties opoint (point))))
2921 (defun yank-handle-font-lock-face-property (face start end)
2922 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2923 START and END denote the start and end of the text to act on.
2924 Do nothing if FACE is nil."
2926 (null font-lock-defaults)
2927 (put-text-property start end 'face face)))
2929 ;; This removes `mouse-face' properties in *Help* buffer buttons:
2930 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2931 (defun yank-handle-category-property (category start end)
2932 "Apply property category CATEGORY's properties between START and END."
2934 (let ((start2 start))
2935 (while (< start2 end)
2936 (let ((end2 (next-property-change start2 nil end))
2937 (original (text-properties-at start2)))
2938 (set-text-properties start2 end2 (symbol-plist category))
2939 (add-text-properties start2 end2 original)
2940 (setq start2 end2))))))
2943 ;;;; Synchronous shell commands.
2945 (defun start-process-shell-command (name buffer &rest args)
2946 "Start a program in a subprocess. Return the process object for it.
2947 NAME is name for process. It is modified if necessary to make it unique.
2948 BUFFER is the buffer (or buffer name) to associate with the process.
2949 Process output goes at end of that buffer, unless you specify
2950 an output stream or filter function to handle the output.
2951 BUFFER may be also nil, meaning that this process is not associated
2953 COMMAND is the shell command to run.
2955 An old calling convention accepted any number of arguments after COMMAND,
2956 which were just concatenated to COMMAND. This is still supported but strongly
2958 (declare (advertised-calling-convention (name buffer command) "23.1"))
2959 ;; We used to use `exec' to replace the shell with the command,
2960 ;; but that failed to handle (...) and semicolon, etc.
2961 (start-process name buffer shell-file-name shell-command-switch
2962 (mapconcat 'identity args " ")))
2964 (defun start-file-process-shell-command (name buffer &rest args)
2965 "Start a program in a subprocess. Return the process object for it.
2966 Similar to `start-process-shell-command', but calls `start-file-process'."
2967 (declare (advertised-calling-convention (name buffer command) "23.1"))
2970 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2971 (if (file-remote-p default-directory) "-c" shell-command-switch)
2972 (mapconcat 'identity args " ")))
2974 (defun call-process-shell-command (command &optional infile buffer display
2976 "Execute the shell command COMMAND synchronously in separate process.
2977 The remaining arguments are optional.
2978 The program's input comes from file INFILE (nil means `/dev/null').
2979 Insert output in BUFFER before point; t means current buffer;
2980 nil for BUFFER means discard it; 0 means discard and don't wait.
2981 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2982 REAL-BUFFER says what to do with standard output, as above,
2983 while STDERR-FILE says what to do with standard error in the child.
2984 STDERR-FILE may be nil (discard standard error output),
2985 t (mix it with ordinary output), or a file name string.
2987 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2988 Wildcards and redirection are handled as usual in the shell.
2990 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2991 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2992 status or a signal description string.
2993 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
2995 An old calling convention accepted any number of arguments after DISPLAY,
2996 which were just concatenated to COMMAND. This is still supported but strongly
2998 (declare (advertised-calling-convention
2999 (command &optional infile buffer display) "24.5"))
3000 ;; We used to use `exec' to replace the shell with the command,
3001 ;; but that failed to handle (...) and semicolon, etc.
3002 (call-process shell-file-name
3003 infile buffer display
3004 shell-command-switch
3005 (mapconcat 'identity (cons command args) " ")))
3007 (defun process-file-shell-command (command &optional infile buffer display
3009 "Process files synchronously in a separate process.
3010 Similar to `call-process-shell-command', but calls `process-file'."
3011 (declare (advertised-calling-convention
3012 (command &optional infile buffer display) "24.5"))
3014 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3015 infile buffer display
3016 (if (file-remote-p default-directory) "-c" shell-command-switch)
3017 (mapconcat 'identity (cons command args) " ")))
3019 ;;;; Lisp macros to do various things temporarily.
3021 (defmacro track-mouse (&rest body)
3022 "Evaluate BODY with mouse movement events enabled.
3023 Within a `track-mouse' form, mouse motion generates input events that
3024 you can read with `read-event'.
3025 Normally, mouse motion is ignored."
3026 (declare (debug t) (indent 0))
3027 `(internal--track-mouse (lambda () ,@body)))
3029 (defmacro with-current-buffer (buffer-or-name &rest body)
3030 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3031 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3032 The value returned is the value of the last form in BODY. See
3033 also `with-temp-buffer'."
3034 (declare (indent 1) (debug t))
3035 `(save-current-buffer
3036 (set-buffer ,buffer-or-name)
3039 (defun internal--before-with-selected-window (window)
3040 (let ((other-frame (window-frame window)))
3041 (list window (selected-window)
3042 ;; Selecting a window on another frame also changes that
3043 ;; frame's frame-selected-window. We must save&restore it.
3044 (unless (eq (selected-frame) other-frame)
3045 (frame-selected-window other-frame))
3046 ;; Also remember the top-frame if on ttys.
3047 (unless (eq (selected-frame) other-frame)
3048 (tty-top-frame other-frame)))))
3050 (defun internal--after-with-selected-window (state)
3051 ;; First reset frame-selected-window.
3052 (when (window-live-p (nth 2 state))
3053 ;; We don't use set-frame-selected-window because it does not
3054 ;; pass the `norecord' argument to Fselect_window.
3055 (select-window (nth 2 state) 'norecord)
3056 (and (frame-live-p (nth 3 state))
3057 (not (eq (tty-top-frame) (nth 3 state)))
3058 (select-frame (nth 3 state) 'norecord)))
3059 ;; Then reset the actual selected-window.
3060 (when (window-live-p (nth 1 state))
3061 (select-window (nth 1 state) 'norecord)))
3063 (defmacro with-selected-window (window &rest body)
3064 "Execute the forms in BODY with WINDOW as the selected window.
3065 The value returned is the value of the last form in BODY.
3067 This macro saves and restores the selected window, as well as the
3068 selected window of each frame. It does not change the order of
3069 recently selected windows. If the previously selected window of
3070 some frame is no longer live at the end of BODY, that frame's
3071 selected window is left alone. If the selected window is no
3072 longer live, then whatever window is selected at the end of BODY
3075 This macro uses `save-current-buffer' to save and restore the
3076 current buffer, since otherwise its normal operation could
3077 potentially make a different buffer current. It does not alter
3078 the buffer list ordering."
3079 (declare (indent 1) (debug t))
3080 `(let ((save-selected-window--state
3081 (internal--before-with-selected-window ,window)))
3082 (save-current-buffer
3084 (progn (select-window (car save-selected-window--state) 'norecord)
3086 (internal--after-with-selected-window save-selected-window--state)))))
3088 (defmacro with-selected-frame (frame &rest body)
3089 "Execute the forms in BODY with FRAME as the selected frame.
3090 The value returned is the value of the last form in BODY.
3092 This macro saves and restores the selected frame, and changes the
3093 order of neither the recently selected windows nor the buffers in
3095 (declare (indent 1) (debug t))
3096 (let ((old-frame (make-symbol "old-frame"))
3097 (old-buffer (make-symbol "old-buffer")))
3098 `(let ((,old-frame (selected-frame))
3099 (,old-buffer (current-buffer)))
3101 (progn (select-frame ,frame 'norecord)
3103 (when (frame-live-p ,old-frame)
3104 (select-frame ,old-frame 'norecord))
3105 (when (buffer-live-p ,old-buffer)
3106 (set-buffer ,old-buffer))))))
3108 (defmacro save-window-excursion (&rest body)
3109 "Execute BODY, then restore previous window configuration.
3110 This macro saves the window configuration on the selected frame,
3111 executes BODY, then calls `set-window-configuration' to restore
3112 the saved window configuration. The return value is the last
3113 form in BODY. The window configuration is also restored if BODY
3116 BEWARE: Most uses of this macro introduce bugs.
3117 E.g. it should not be used to try and prevent some code from opening
3118 a new window, since that window may sometimes appear in another frame,
3119 in which case `save-window-excursion' cannot help."
3120 (declare (indent 0) (debug t))
3121 (let ((c (make-symbol "wconfig")))
3122 `(let ((,c (current-window-configuration)))
3123 (unwind-protect (progn ,@body)
3124 (set-window-configuration ,c)))))
3126 (defun internal-temp-output-buffer-show (buffer)
3127 "Internal function for `with-output-to-temp-buffer'."
3128 (with-current-buffer buffer
3129 (set-buffer-modified-p nil)
3130 (goto-char (point-min)))
3132 (if temp-buffer-show-function
3133 (funcall temp-buffer-show-function buffer)
3134 (with-current-buffer buffer
3136 (let ((window-combination-limit
3137 ;; When `window-combination-limit' equals
3138 ;; `temp-buffer' or `temp-buffer-resize' and
3139 ;; `temp-buffer-resize-mode' is enabled in this
3140 ;; buffer bind it to t so resizing steals space
3141 ;; preferably from the window that was split.
3142 (if (or (eq window-combination-limit 'temp-buffer)
3143 (and (eq window-combination-limit
3144 'temp-buffer-resize)
3145 temp-buffer-resize-mode))
3147 window-combination-limit)))
3148 (display-buffer buffer)))
3149 (frame (and window (window-frame window))))
3151 (unless (eq frame (selected-frame))
3152 (make-frame-visible frame))
3153 (setq minibuffer-scroll-window window)
3154 (set-window-hscroll window 0)
3155 ;; Don't try this with NOFORCE non-nil!
3156 (set-window-start window (point-min) t)
3157 ;; This should not be necessary.
3158 (set-window-point window (point-min))
3159 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3160 (with-selected-window window
3161 (run-hooks 'temp-buffer-show-hook))))))
3165 ;; Doc is very similar to with-temp-buffer-window.
3166 (defmacro with-output-to-temp-buffer (bufname &rest body)
3167 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3169 This construct makes buffer BUFNAME empty before running BODY.
3170 It does not make the buffer current for BODY.
3171 Instead it binds `standard-output' to that buffer, so that output
3172 generated with `prin1' and similar functions in BODY goes into
3175 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3176 it in a window, but does not select it. The normal way to do this is
3177 by calling `display-buffer', then running `temp-buffer-show-hook'.
3178 However, if `temp-buffer-show-function' is non-nil, it calls that
3179 function instead (and does not run `temp-buffer-show-hook'). The
3180 function gets one argument, the buffer to display.
3182 The return value of `with-output-to-temp-buffer' is the value of the
3183 last form in BODY. If BODY does not finish normally, the buffer
3184 BUFNAME is not displayed.
3186 This runs the hook `temp-buffer-setup-hook' before BODY,
3187 with the buffer BUFNAME temporarily current. It runs the hook
3188 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3189 buffer temporarily current, and the window that was used to display it
3190 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3191 if it uses `temp-buffer-show-function'.
3193 By default, the setup hook puts the buffer into Help mode before running BODY.
3194 If BODY does not change the major mode, the show hook makes the buffer
3195 read-only, and scans it for function and variable names to make them into
3196 clickable cross-references.
3198 See the related form `with-temp-buffer-window'."
3200 (let ((old-dir (make-symbol "old-dir"))
3201 (buf (make-symbol "buf")))
3202 `(let* ((,old-dir default-directory)
3204 (with-current-buffer (get-buffer-create ,bufname)
3205 (prog1 (current-buffer)
3206 (kill-all-local-variables)
3207 ;; FIXME: delete_all_overlays
3208 (setq default-directory ,old-dir)
3209 (setq buffer-read-only nil)
3210 (setq buffer-file-name nil)
3211 (setq buffer-undo-list t)
3212 (let ((inhibit-read-only t)
3213 (inhibit-modification-hooks t))
3215 (run-hooks 'temp-buffer-setup-hook)))))
3216 (standard-output ,buf))
3217 (prog1 (progn ,@body)
3218 (internal-temp-output-buffer-show ,buf)))))
3220 (defmacro with-temp-file (file &rest body)
3221 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3222 The value returned is the value of the last form in BODY.
3223 See also `with-temp-buffer'."
3224 (declare (indent 1) (debug t))
3225 (let ((temp-file (make-symbol "temp-file"))
3226 (temp-buffer (make-symbol "temp-buffer")))
3227 `(let ((,temp-file ,file)
3229 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3232 (with-current-buffer ,temp-buffer
3234 (with-current-buffer ,temp-buffer
3235 (write-region nil nil ,temp-file nil 0)))
3236 (and (buffer-name ,temp-buffer)
3237 (kill-buffer ,temp-buffer))))))
3239 (defmacro with-temp-message (message &rest body)
3240 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3241 The original message is restored to the echo area after BODY has finished.
3242 The value returned is the value of the last form in BODY.
3243 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3244 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3245 Use a MESSAGE of \"\" to temporarily clear the echo area."
3246 (declare (debug t) (indent 1))
3247 (let ((current-message (make-symbol "current-message"))
3248 (temp-message (make-symbol "with-temp-message")))
3249 `(let ((,temp-message ,message)
3254 (setq ,current-message (current-message))
3255 (message "%s" ,temp-message))
3258 (if ,current-message
3259 (message "%s" ,current-message)
3262 (defmacro with-temp-buffer (&rest body)
3263 "Create a temporary buffer, and evaluate BODY there like `progn'.
3264 See also `with-temp-file' and `with-output-to-string'."
3265 (declare (indent 0) (debug t))
3266 (let ((temp-buffer (make-symbol "temp-buffer")))
3267 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3268 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3269 (with-current-buffer ,temp-buffer
3272 (and (buffer-name ,temp-buffer)
3273 (kill-buffer ,temp-buffer)))))))
3275 (defmacro with-silent-modifications (&rest body)
3276 "Execute BODY, pretending it does not modify the buffer.
3277 If BODY performs real modifications to the buffer's text, other
3278 than cosmetic ones, undo data may become corrupted.
3280 This macro will run BODY normally, but doesn't count its buffer
3281 modifications as being buffer modifications. This affects things
3282 like `buffer-modified-p', checking whether the file is locked by
3283 someone else, running buffer modification hooks, and other things
3286 Typically used around modifications of text-properties which do
3287 not really affect the buffer's content."
3288 (declare (debug t) (indent 0))
3289 (let ((modified (make-symbol "modified")))
3290 `(let* ((,modified (buffer-modified-p))
3291 (buffer-undo-list t)
3292 (inhibit-read-only t)
3293 (inhibit-modification-hooks t))
3298 (restore-buffer-modified-p nil))))))
3300 (defmacro with-output-to-string (&rest body)
3301 "Execute BODY, return the text it sent to `standard-output', as a string."
3302 (declare (indent 0) (debug t))
3303 `(let ((standard-output
3304 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3307 (let ((standard-output standard-output))
3309 (with-current-buffer standard-output
3311 (kill-buffer standard-output))))
3313 (defmacro with-local-quit (&rest body)
3314 "Execute BODY, allowing quits to terminate BODY but not escape further.
3315 When a quit terminates BODY, `with-local-quit' returns nil but
3316 requests another quit. That quit will be processed as soon as quitting
3317 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3318 (declare (debug t) (indent 0))
3319 `(condition-case nil
3320 (let ((inhibit-quit nil))
3322 (quit (setq quit-flag t)
3323 ;; This call is to give a chance to handle quit-flag
3324 ;; in case inhibit-quit is nil.
3325 ;; Without this, it will not be handled until the next function
3326 ;; call, and that might allow it to exit thru a condition-case
3327 ;; that intends to handle the quit signal next time.
3328 (eval '(ignore nil)))))
3330 (defmacro while-no-input (&rest body)
3331 "Execute BODY only as long as there's no pending input.
3332 If input arrives, that ends the execution of BODY,
3333 and `while-no-input' returns t. Quitting makes it return nil.
3334 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3335 (declare (debug t) (indent 0))
3336 (let ((catch-sym (make-symbol "input")))
3339 (let ((throw-on-input ',catch-sym))
3340 (or (input-pending-p)
3341 (progn ,@body)))))))
3343 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3344 "Like `condition-case' except that it does not prevent debugging.
3345 More specifically if `debug-on-error' is set then the debugger will be invoked
3346 even if this catches the signal."
3347 (declare (debug condition-case) (indent 2))
3348 `(condition-case ,var
3350 ,@(mapcar (lambda (handler)
3351 `((debug ,@(if (listp (car handler)) (car handler)
3352 (list (car handler))))
3356 (define-obsolete-function-alias 'condition-case-no-debug
3357 'condition-case-unless-debug "24.1")
3359 (defmacro with-demoted-errors (format &rest body)
3360 "Run BODY and demote any errors to simple messages.
3361 FORMAT is a string passed to `message' to format any error message.
3362 It should contain a single %-sequence; e.g., \"Error: %S\".
3364 If `debug-on-error' is non-nil, run BODY without catching its errors.
3365 This is to be used around code which is not expected to signal an error
3366 but which should be robust in the unexpected case that an error is signaled.
3368 For backward compatibility, if FORMAT is not a constant string, it
3369 is assumed to be part of BODY, in which case the message format
3370 used is \"Error: %S\"."
3371 (declare (debug t) (indent 1))
3372 (let ((err (make-symbol "err"))
3373 (format (if (and (stringp format) body) format
3375 (if format (push format body))))))
3376 `(condition-case-unless-debug ,err
3377 ,(macroexp-progn body)
3378 (error (message ,format ,err) nil))))
3380 (defmacro combine-after-change-calls (&rest body)
3381 "Execute BODY, but don't call the after-change functions till the end.
3382 If BODY makes changes in the buffer, they are recorded
3383 and the functions on `after-change-functions' are called several times
3384 when BODY is finished.
3385 The return value is the value of the last form in BODY.
3387 If `before-change-functions' is non-nil, then calls to the after-change
3388 functions can't be deferred, so in that case this macro has no effect.
3390 Do not alter `after-change-functions' or `before-change-functions'
3392 (declare (indent 0) (debug t))
3394 (let ((combine-after-change-calls t))
3396 (combine-after-change-execute)))
3398 (defmacro with-case-table (table &rest body)
3399 "Execute the forms in BODY with TABLE as the current case table.
3400 The value returned is the value of the last form in BODY."
3401 (declare (indent 1) (debug t))
3402 (let ((old-case-table (make-symbol "table"))
3403 (old-buffer (make-symbol "buffer")))
3404 `(let ((,old-case-table (current-case-table))
3405 (,old-buffer (current-buffer)))
3407 (progn (set-case-table ,table)
3409 (with-current-buffer ,old-buffer
3410 (set-case-table ,old-case-table))))))
3412 (defmacro with-file-modes (modes &rest body)
3413 "Execute BODY with default file permissions temporarily set to MODES.
3414 MODES is as for `set-default-file-modes'."
3415 (declare (indent 1) (debug t))
3416 (let ((umask (make-symbol "umask")))
3417 `(let ((,umask (default-file-modes)))
3420 (set-default-file-modes ,modes)
3422 (set-default-file-modes ,umask)))))
3425 ;;; Matching and match data.
3427 (defvar save-match-data-internal)
3429 ;; We use save-match-data-internal as the local variable because
3430 ;; that works ok in practice (people should not use that variable elsewhere).
3431 ;; We used to use an uninterned symbol; the compiler handles that properly
3432 ;; now, but it generates slower code.
3433 (defmacro save-match-data (&rest body)
3434 "Execute the BODY forms, restoring the global value of the match data.
3435 The value returned is the value of the last form in BODY."
3436 ;; It is better not to use backquote here,
3437 ;; because that makes a bootstrapping problem
3438 ;; if you need to recompile all the Lisp files using interpreted code.
3439 (declare (indent 0) (debug t))
3441 '((save-match-data-internal (match-data)))
3442 (list 'unwind-protect
3444 ;; It is safe to free (evaporate) markers immediately here,
3445 ;; as Lisp programs should not copy from save-match-data-internal.
3446 '(set-match-data save-match-data-internal 'evaporate))))
3448 (defun match-string (num &optional string)
3449 "Return string of text matched by last search.
3450 NUM specifies which parenthesized expression in the last regexp.
3451 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3452 Zero means the entire text matched by the whole regexp or whole string.
3453 STRING should be given if the last search was by `string-match' on STRING.
3454 If STRING is nil, the current buffer should be the same buffer
3455 the search/match was performed in."
3456 (if (match-beginning num)
3458 (substring string (match-beginning num) (match-end num))
3459 (buffer-substring (match-beginning num) (match-end num)))))
3461 (defun match-string-no-properties (num &optional string)
3462 "Return string of text matched by last search, without text properties.
3463 NUM specifies which parenthesized expression in the last regexp.
3464 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3465 Zero means the entire text matched by the whole regexp or whole string.
3466 STRING should be given if the last search was by `string-match' on STRING.
3467 If STRING is nil, the current buffer should be the same buffer
3468 the search/match was performed in."
3469 (if (match-beginning num)
3471 (substring-no-properties string (match-beginning num)
3473 (buffer-substring-no-properties (match-beginning num)
3477 (defun match-substitute-replacement (replacement
3478 &optional fixedcase literal string subexp)
3479 "Return REPLACEMENT as it will be inserted by `replace-match'.
3480 In other words, all back-references in the form `\\&' and `\\N'
3481 are substituted with actual strings matched by the last search.
3482 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3483 meaning as for `replace-match'."
3484 (let ((match (match-string 0 string)))
3486 (set-match-data (mapcar (lambda (x)
3488 (- x (match-beginning 0))
3491 (replace-match replacement fixedcase literal match subexp))))
3494 (defun looking-back (regexp &optional limit greedy)
3495 "Return non-nil if text before point matches regular expression REGEXP.
3496 Like `looking-at' except matches before point, and is slower.
3497 LIMIT if non-nil speeds up the search by specifying a minimum
3498 starting position, to avoid checking matches that would start
3501 If GREEDY is non-nil, extend the match backwards as far as
3502 possible, stopping when a single additional previous character
3503 cannot be part of a match for REGEXP. When the match is
3504 extended, its starting position is allowed to occur before
3507 As a general recommendation, try to avoid using `looking-back'
3508 wherever possible, since it is slow."
3509 (let ((start (point))
3512 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3514 (if (and greedy pos)
3516 (narrow-to-region (point-min) start)
3517 (while (and (> pos (point-min))
3521 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3522 (setq pos (1- pos)))
3525 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3528 (defsubst looking-at-p (regexp)
3530 Same as `looking-at' except this function does not change the match data."
3531 (let ((inhibit-changing-match-data t))
3532 (looking-at regexp)))
3534 (defsubst string-match-p (regexp string &optional start)
3536 Same as `string-match' except this function does not change the match data."
3537 (let ((inhibit-changing-match-data t))
3538 (string-match regexp string start)))
3540 (defun subregexp-context-p (regexp pos &optional start)
3541 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3542 A subregexp context is one where a sub-regexp can appear.
3543 A non-subregexp context is for example within brackets, or within a
3544 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3545 If START is non-nil, it should be a position in REGEXP, smaller
3546 than POS, and known to be in a subregexp context."
3547 ;; Here's one possible implementation, with the great benefit that it
3548 ;; reuses the regexp-matcher's own parser, so it understands all the
3549 ;; details of the syntax. A disadvantage is that it needs to match the
3553 (string-match (substring regexp (or start 0) pos) "")
3556 (not (member (cadr err) '("Unmatched [ or [^"
3558 "Trailing backslash")))))
3559 ;; An alternative implementation:
3560 ;; (defconst re-context-re
3561 ;; (let* ((harmless-ch "[^\\[]")
3562 ;; (harmless-esc "\\\\[^{]")
3563 ;; (class-harmless-ch "[^][]")
3564 ;; (class-lb-harmless "[^]:]")
3565 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3566 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3567 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3569 ;; (concat "\\[^?]?"
3570 ;; "\\(" class-harmless-ch
3571 ;; "\\|" class-lb "\\)*"
3572 ;; "\\[?]")) ; special handling for bare [ at end of re
3573 ;; (braces "\\\\{[0-9,]+\\\\}"))
3574 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3575 ;; "\\|" class "\\|" braces "\\)*\\'"))
3576 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3577 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3582 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3583 "The default value of separators for `split-string'.
3585 A regexp matching strings of whitespace. May be locale-dependent
3586 \(as yet unimplemented). Should not match non-breaking spaces.
3588 Warning: binding this to a different value and using it as default is
3589 likely to have undesired semantics.")
3591 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3592 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3593 ;; expression leads to the equivalent implementation that if SEPARATORS
3594 ;; is defaulted, OMIT-NULLS is treated as t.
3595 (defun split-string (string &optional separators omit-nulls trim)
3596 "Split STRING into substrings bounded by matches for SEPARATORS.
3598 The beginning and end of STRING, and each match for SEPARATORS, are
3599 splitting points. The substrings matching SEPARATORS are removed, and
3600 the substrings between the splitting points are collected as a list,
3603 If SEPARATORS is non-nil, it should be a regular expression matching text
3604 which separates, but is not part of, the substrings. If nil it defaults to
3605 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3606 OMIT-NULLS is forced to t.
3608 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3609 that for the default value of SEPARATORS leading and trailing whitespace
3610 are effectively trimmed). If nil, all zero-length substrings are retained,
3611 which correctly parses CSV format, for example.
3613 If TRIM is non-nil, it should be a regular expression to match
3614 text to trim from the beginning and end of each substring. If trimming
3615 makes the substring empty, it is treated as null.
3617 If you want to trim whitespace from the substrings, the reliably correct
3618 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3619 results when there is whitespace at the start or end of STRING. If you
3620 see such calls to `split-string', please fix them.
3622 Note that the effect of `(split-string STRING)' is the same as
3623 `(split-string STRING split-string-default-separators t)'. In the rare
3624 case that you wish to retain zero-length substrings when splitting on
3625 whitespace, use `(split-string STRING split-string-default-separators)'.
3627 Modifies the match data; use `save-match-data' if necessary."
3628 (let* ((keep-nulls (not (if separators omit-nulls t)))
3629 (rexp (or separators split-string-default-separators))
3635 ;; Push the substring in range THIS-START to THIS-END
3636 ;; onto LIST, trimming it and perhaps discarding it.
3639 ;; Discard the trim from start of this substring.
3640 (let ((tem (string-match trim string this-start)))
3641 (and (eq tem this-start)
3642 (setq this-start (match-end 0)))))
3644 (when (or keep-nulls (< this-start this-end))
3645 (let ((this (substring string this-start this-end)))
3647 ;; Discard the trim from end of this substring.
3649 (let ((tem (string-match (concat trim "\\'") this 0)))
3650 (and tem (< tem (length this))
3651 (setq this (substring this 0 tem)))))
3653 ;; Trimming could make it empty; check again.
3654 (when (or keep-nulls (> (length this) 0))
3655 (push this list)))))))
3657 (while (and (string-match rexp string
3659 (= start (match-beginning 0))
3660 (< start (length string)))
3662 (< start (length string)))
3664 (setq this-start start this-end (match-beginning 0)
3665 start (match-end 0))
3669 ;; Handle the substring at the end of STRING.
3670 (setq this-start start this-end (length string))
3675 (defun combine-and-quote-strings (strings &optional separator)
3676 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3677 This tries to quote the strings to avoid ambiguity such that
3678 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3679 Only some SEPARATORs will work properly."
3680 (let* ((sep (or separator " "))
3681 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3684 (if (string-match re str)
3685 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3689 (defun split-string-and-unquote (string &optional separator)
3690 "Split the STRING into a list of strings.
3691 It understands Emacs Lisp quoting within STRING, such that
3692 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3693 The SEPARATOR regexp defaults to \"\\s-+\"."
3694 (let ((sep (or separator "\\s-+"))
3695 (i (string-match "\"" string)))
3697 (split-string string sep t) ; no quoting: easy
3698 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3699 (let ((rfs (read-from-string string i)))
3701 (split-string-and-unquote (substring string (cdr rfs))
3705 ;;;; Replacement in strings.
3707 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3708 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3709 Unless optional argument INPLACE is non-nil, return a new string."
3710 (let ((i (length string))
3711 (newstr (if inplace string (copy-sequence string))))
3714 (if (eq (aref newstr i) fromchar)
3715 (aset newstr i tochar)))
3718 (defun replace-regexp-in-string (regexp rep string &optional
3719 fixedcase literal subexp start)
3720 "Replace all matches for REGEXP with REP in STRING.
3722 Return a new string containing the replacements.
3724 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3725 arguments with the same names of function `replace-match'. If START
3726 is non-nil, start replacements at that index in STRING.
3728 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3729 function. If it is a function, it is called with the actual text of each
3730 match, and its value is used as the replacement text. When REP is called,
3731 the match data are the result of matching REGEXP against a substring
3734 To replace only the first match (if any), make REGEXP match up to \\'
3735 and replace a sub-expression, e.g.
3736 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3739 ;; To avoid excessive consing from multiple matches in long strings,
3740 ;; don't just call `replace-match' continually. Walk down the
3741 ;; string looking for matches of REGEXP and building up a (reversed)
3742 ;; list MATCHES. This comprises segments of STRING which weren't
3743 ;; matched interspersed with replacements for segments that were.
3744 ;; [For a `large' number of replacements it's more efficient to
3745 ;; operate in a temporary buffer; we can't tell from the function's
3746 ;; args whether to choose the buffer-based implementation, though it
3747 ;; might be reasonable to do so for long enough STRING.]
3748 (let ((l (length string))
3749 (start (or start 0))
3752 (while (and (< start l) (string-match regexp string start))
3753 (setq mb (match-beginning 0)
3755 ;; If we matched the empty string, make sure we advance by one char
3756 (when (= me mb) (setq me (min l (1+ mb))))
3757 ;; Generate a replacement for the matched substring.
3758 ;; Operate only on the substring to minimize string consing.
3759 ;; Set up match data for the substring for replacement;
3760 ;; presumably this is likely to be faster than munging the
3761 ;; match data directly in Lisp.
3762 (string-match regexp (setq str (substring string mb me)))
3764 (cons (replace-match (if (stringp rep)
3766 (funcall rep (match-string 0 str)))
3767 fixedcase literal str subexp)
3768 (cons (substring string start mb) ; unmatched prefix
3771 ;; Reconstruct a string from the pieces.
3772 (setq matches (cons (substring string start l) matches)) ; leftover
3773 (apply #'concat (nreverse matches)))))
3775 (defun string-prefix-p (prefix string &optional ignore-case)
3776 "Return non-nil if PREFIX is a prefix of STRING.
3777 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3778 to case differences."
3779 (let ((prefix-length (length prefix)))
3780 (if (> prefix-length (length string)) nil
3781 (eq t (compare-strings prefix 0 prefix-length string
3782 0 prefix-length ignore-case)))))
3784 (defun string-suffix-p (suffix string &optional ignore-case)
3785 "Return non-nil if SUFFIX is a suffix of STRING.
3786 If IGNORE-CASE is non-nil, the comparison is done without paying
3787 attention to case differences."
3788 (let ((start-pos (- (length string) (length suffix))))
3789 (and (>= start-pos 0)
3790 (eq t (compare-strings suffix nil nil
3791 string start-pos nil ignore-case)))))
3793 (defun bidi-string-mark-left-to-right (str)
3794 "Return a string that can be safely inserted in left-to-right text.
3796 Normally, inserting a string with right-to-left (RTL) script into
3797 a buffer may cause some subsequent text to be displayed as part
3798 of the RTL segment (usually this affects punctuation characters).
3799 This function returns a string which displays as STR but forces
3800 subsequent text to be displayed as left-to-right.
3802 If STR contains any RTL character, this function returns a string
3803 consisting of STR followed by an invisible left-to-right mark
3804 \(LRM) character. Otherwise, it returns STR."
3805 (unless (stringp str)
3806 (signal 'wrong-type-argument (list 'stringp str)))
3807 (if (string-match "\\cR" str)
3808 (concat str (propertize (string ?\x200e) 'invisible t))
3811 ;;;; Specifying things to do later.
3813 (defun load-history-regexp (file)
3814 "Form a regexp to find FILE in `load-history'.
3815 FILE, a string, is described in the function `eval-after-load'."
3816 (if (file-name-absolute-p file)
3817 (setq file (file-truename file)))
3818 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
3820 (if (file-name-extension file)
3822 ;; Note: regexp-opt can't be used here, since we need to call
3823 ;; this before Emacs has been fully started. 2006-05-21
3824 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
3825 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
3828 (defun load-history-filename-element (file-regexp)
3829 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
3830 Return nil if there isn't one."
3831 (let* ((loads load-history)
3832 (load-elt (and loads (car loads))))
3835 (or (null (car load-elt))
3836 (not (string-match file-regexp (car load-elt)))))
3837 (setq loads (cdr loads)
3838 load-elt (and loads (car loads)))))
3841 (put 'eval-after-load 'lisp-indent-function 1)
3842 (defun eval-after-load (file form)
3843 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
3844 If FILE is already loaded, evaluate FORM right now.
3845 FORM can be an Elisp expression (in which case it's passed to `eval'),
3846 or a function (in which case it's passed to `funcall' with no argument).
3848 If a matching file is loaded again, FORM will be evaluated again.
3850 If FILE is a string, it may be either an absolute or a relative file
3851 name, and may have an extension (e.g. \".el\") or may lack one, and
3852 additionally may or may not have an extension denoting a compressed
3853 format (e.g. \".gz\").
3855 When FILE is absolute, this first converts it to a true name by chasing
3856 symbolic links. Only a file of this name (see next paragraph regarding
3857 extensions) will trigger the evaluation of FORM. When FILE is relative,
3858 a file whose absolute true name ends in FILE will trigger evaluation.
3860 When FILE lacks an extension, a file name with any extension will trigger
3861 evaluation. Otherwise, its extension must match FILE's. A further
3862 extension for a compressed format (e.g. \".gz\") on FILE will not affect
3865 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
3866 is evaluated at the end of any file that `provide's this feature.
3867 If the feature is provided when evaluating code not associated with a
3868 file, FORM is evaluated immediately after the provide statement.
3870 Usually FILE is just a library name like \"font-lock\" or a feature name
3873 This function makes or adds to an entry on `after-load-alist'."
3874 (declare (compiler-macro
3876 (if (eq 'quote (car-safe form))
3877 ;; Quote with lambda so the compiler can look inside.
3878 `(eval-after-load ,file (lambda () ,(nth 1 form)))
3880 ;; Add this FORM into after-load-alist (regardless of whether we'll be
3881 ;; evaluating it now).
3882 (let* ((regexp-or-feature
3884 (setq file (purecopy (load-history-regexp file)))
3886 (elt (assoc regexp-or-feature after-load-alist))
3888 (if (functionp form) form
3889 ;; Try to use the "current" lexical/dynamic mode for `form'.
3890 (eval `(lambda () ,form) lexical-binding))))
3892 (setq elt (list regexp-or-feature))
3893 (push elt after-load-alist))
3894 ;; Is there an already loaded file whose name (or `provide' name)
3896 (prog1 (if (if (stringp file)
3897 (load-history-filename-element regexp-or-feature)
3901 (if (not (symbolp regexp-or-feature)) func
3902 ;; For features, the after-load-alist elements get run when
3903 ;; `provide' is called rather than at the end of the file.
3904 ;; So add an indirection to make sure that `func' is really run
3905 ;; "after-load" in case the provide call happens early.
3907 (if (not load-file-name)
3908 ;; Not being provided from a file, run func right now.
3910 (let ((lfn load-file-name)
3911 ;; Don't use letrec, because equal (in
3912 ;; add/remove-hook) would get trapped in a cycle.
3913 (fun (make-symbol "eval-after-load-helper")))
3914 (fset fun (lambda (file)
3915 (when (equal file lfn)
3916 (remove-hook 'after-load-functions fun)
3918 (add-hook 'after-load-functions fun 'append)))))))
3919 ;; Add FORM to the element unless it's already there.
3920 (unless (member delayed-func (cdr elt))
3921 (nconc elt (list delayed-func)))))))
3923 (defmacro with-eval-after-load (file &rest body)
3924 "Execute BODY after FILE is loaded.
3925 FILE is normally a feature name, but it can also be a file name,
3926 in case that file does not provide any feature."
3927 (declare (indent 1) (debug t))
3928 `(eval-after-load ,file (lambda () ,@body)))
3930 (defvar after-load-functions nil
3931 "Special hook run after loading a file.
3932 Each function there is called with a single argument, the absolute
3933 name of the file just loaded.")
3935 (defun do-after-load-evaluation (abs-file)
3936 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
3937 ABS-FILE, a string, should be the absolute true name of a file just loaded.
3938 This function is called directly from the C code."
3939 ;; Run the relevant eval-after-load forms.
3940 (dolist (a-l-element after-load-alist)
3941 (when (and (stringp (car a-l-element))
3942 (string-match-p (car a-l-element) abs-file))
3943 ;; discard the file name regexp
3944 (mapc #'funcall (cdr a-l-element))))
3945 ;; Complain when the user uses obsolete files.
3946 (when (save-match-data
3947 (and (string-match "/obsolete/\\([^/]*\\)\\'" abs-file)
3948 (not (equal "loaddefs.el" (match-string 1 abs-file)))))
3949 ;; Maybe we should just use display-warning? This seems yucky...
3950 (let* ((file (file-name-nondirectory abs-file))
3951 (msg (format "Package %s is obsolete!"
3953 (string-match "\\.elc?\\>" file)))))
3954 ;; Cribbed from cl--compiling-file.
3955 (if (and (boundp 'byte-compile--outbuffer)
3956 (bufferp (symbol-value 'byte-compile--outbuffer))
3957 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
3958 " *Compiler Output*"))
3959 ;; Don't warn about obsolete files using other obsolete files.
3960 (unless (and (stringp byte-compile-current-file)
3961 (string-match-p "/obsolete/[^/]*\\'"
3963 byte-compile-current-file
3964 byte-compile-root-dir)))
3965 (byte-compile-log-warning msg))
3966 (run-with-timer 0 nil
3971 ;; Finally, run any other hook.
3972 (run-hook-with-args 'after-load-functions abs-file))
3974 (defun eval-next-after-load (file)
3975 "Read the following input sexp, and run it whenever FILE is loaded.
3976 This makes or adds to an entry on `after-load-alist'.
3977 FILE should be the name of a library, with no directory name."
3978 (declare (obsolete eval-after-load "23.2"))
3979 (eval-after-load file (read)))
3982 (defun display-delayed-warnings ()
3983 "Display delayed warnings from `delayed-warnings-list'.
3984 Used from `delayed-warnings-hook' (which see)."
3985 (dolist (warning (nreverse delayed-warnings-list))
3986 (apply 'display-warning warning))
3987 (setq delayed-warnings-list nil))
3989 (defun collapse-delayed-warnings ()
3990 "Remove duplicates from `delayed-warnings-list'.
3991 Collapse identical adjacent warnings into one (plus count).
3992 Used from `delayed-warnings-hook' (which see)."
3995 (while delayed-warnings-list
3996 (setq warning (pop delayed-warnings-list))
3997 (if (equal warning (car delayed-warnings-list))
3998 (setq count (1+ count))
4000 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
4003 (push warning collapsed)))
4004 (setq delayed-warnings-list (nreverse collapsed))))
4006 ;; At present this is only used for Emacs internals.
4007 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
4008 (defvar delayed-warnings-hook '(collapse-delayed-warnings
4009 display-delayed-warnings)
4010 "Normal hook run to process and display delayed warnings.
4011 By default, this hook contains functions to consolidate the
4012 warnings listed in `delayed-warnings-list', display them, and set
4013 `delayed-warnings-list' back to nil.")
4015 (defun delay-warning (type message &optional level buffer-name)
4016 "Display a delayed warning.
4017 Aside from going through `delayed-warnings-list', this is equivalent
4018 to `display-warning'."
4019 (push (list type message level buffer-name) delayed-warnings-list))
4022 ;;;; invisibility specs
4024 (defun add-to-invisibility-spec (element)
4025 "Add ELEMENT to `buffer-invisibility-spec'.
4026 See documentation for `buffer-invisibility-spec' for the kind of elements
4028 (if (eq buffer-invisibility-spec t)
4029 (setq buffer-invisibility-spec (list t)))
4030 (setq buffer-invisibility-spec
4031 (cons element buffer-invisibility-spec)))
4033 (defun remove-from-invisibility-spec (element)
4034 "Remove ELEMENT from `buffer-invisibility-spec'."
4035 (if (consp buffer-invisibility-spec)
4036 (setq buffer-invisibility-spec
4037 (delete element buffer-invisibility-spec))))
4041 (defmacro with-syntax-table (table &rest body)
4042 "Evaluate BODY with syntax table of current buffer set to TABLE.
4043 The syntax table of the current buffer is saved, BODY is evaluated, and the
4044 saved table is restored, even in case of an abnormal exit.
4045 Value is what BODY returns."
4046 (declare (debug t) (indent 1))
4047 (let ((old-table (make-symbol "table"))
4048 (old-buffer (make-symbol "buffer")))
4049 `(let ((,old-table (syntax-table))
4050 (,old-buffer (current-buffer)))
4053 (set-syntax-table ,table)
4055 (save-current-buffer
4056 (set-buffer ,old-buffer)
4057 (set-syntax-table ,old-table))))))
4059 (defun make-syntax-table (&optional oldtable)
4060 "Return a new syntax table.
4061 Create a syntax table which inherits from OLDTABLE (if non-nil) or
4062 from `standard-syntax-table' otherwise."
4063 (let ((table (make-char-table 'syntax-table nil)))
4064 (set-char-table-parent table (or oldtable (standard-syntax-table)))
4067 (defun syntax-after (pos)
4068 "Return the raw syntax descriptor for the char after POS.
4069 If POS is outside the buffer's accessible portion, return nil."
4070 (unless (or (< pos (point-min)) (>= pos (point-max)))
4071 (let ((st (if parse-sexp-lookup-properties
4072 (get-char-property pos 'syntax-table))))
4074 (aref (or st (syntax-table)) (char-after pos))))))
4076 (defun syntax-class (syntax)
4077 "Return the code for the syntax class described by SYNTAX.
4079 SYNTAX should be a raw syntax descriptor; the return value is a
4080 integer which encodes the corresponding syntax class. See Info
4081 node `(elisp)Syntax Table Internals' for a list of codes.
4083 If SYNTAX is nil, return nil."
4084 (and syntax (logand (car syntax) 65535)))
4086 ;; Utility motion commands
4090 (defun forward-whitespace (arg)
4091 "Move point to the end of the next sequence of whitespace chars.
4092 Each such sequence may be a single newline, or a sequence of
4093 consecutive space and/or tab characters.
4094 With prefix argument ARG, do it ARG times if positive, or move
4095 backwards ARG times if negative."
4098 (re-search-forward "[ \t]+\\|\n" nil 'move arg)
4100 (if (re-search-backward "[ \t]+\\|\n" nil 'move)
4101 (or (eq (char-after (match-beginning 0)) ?\n)
4102 (skip-chars-backward " \t")))
4103 (setq arg (1+ arg)))))
4107 (defun forward-symbol (arg)
4108 "Move point to the next position that is the end of a symbol.
4109 A symbol is any sequence of characters that are in either the
4110 word constituent or symbol constituent syntax class.
4111 With prefix argument ARG, do it ARG times if positive, or move
4112 backwards ARG times if negative."
4115 (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
4117 (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
4118 (skip-syntax-backward "w_"))
4119 (setq arg (1+ arg)))))
4123 (defun forward-same-syntax (&optional arg)
4124 "Move point past all characters with the same syntax class.
4125 With prefix argument ARG, do it ARG times if positive, or move
4126 backwards ARG times if negative."
4128 (or arg (setq arg 1))
4130 (skip-syntax-backward
4131 (char-to-string (char-syntax (char-before))))
4132 (setq arg (1+ arg)))
4134 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4135 (setq arg (1- arg))))
4140 (defvar text-clone--maintaining nil)
4142 (defun text-clone--maintain (ol1 after beg end &optional _len)
4143 "Propagate the changes made under the overlay OL1 to the other clones.
4144 This is used on the `modification-hooks' property of text clones."
4145 (when (and after (not undo-in-progress)
4146 (not text-clone--maintaining)
4147 (overlay-start ol1))
4148 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4149 (setq beg (max beg (+ (overlay-start ol1) margin)))
4150 (setq end (min end (- (overlay-end ol1) margin)))
4153 (when (overlay-get ol1 'text-clone-syntax)
4154 ;; Check content of the clone's text.
4155 (let ((cbeg (+ (overlay-start ol1) margin))
4156 (cend (- (overlay-end ol1) margin)))
4159 (if (not (re-search-forward
4160 (overlay-get ol1 'text-clone-syntax) cend t))
4161 ;; Mark the overlay for deletion.
4163 (when (< (match-end 0) cend)
4164 ;; Shrink the clone at its end.
4165 (setq end (min end (match-end 0)))
4166 (move-overlay ol1 (overlay-start ol1)
4167 (+ (match-end 0) margin)))
4168 (when (> (match-beginning 0) cbeg)
4169 ;; Shrink the clone at its beginning.
4170 (setq beg (max (match-beginning 0) beg))
4171 (move-overlay ol1 (- (match-beginning 0) margin)
4172 (overlay-end ol1)))))))
4173 ;; Now go ahead and update the clones.
4174 (let ((head (- beg (overlay-start ol1)))
4175 (tail (- (overlay-end ol1) end))
4176 (str (buffer-substring beg end))
4178 (text-clone--maintaining t))
4179 (dolist (ol2 (overlay-get ol1 'text-clones))
4180 (let ((oe (overlay-end ol2)))
4181 (unless (or (eq ol1 ol2) (null oe))
4182 (setq nothing-left nil)
4183 (let ((mod-beg (+ (overlay-start ol2) head)))
4184 ;;(overlay-put ol2 'modification-hooks nil)
4185 (goto-char (- (overlay-end ol2) tail))
4186 (unless (> mod-beg (point))
4187 (save-excursion (insert str))
4188 (delete-region mod-beg (point)))
4189 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4191 (if nothing-left (delete-overlay ol1))))))))
4193 (defun text-clone-create (start end &optional spreadp syntax)
4194 "Create a text clone of START...END at point.
4195 Text clones are chunks of text that are automatically kept identical:
4196 changes done to one of the clones will be immediately propagated to the other.
4198 The buffer's content at point is assumed to be already identical to
4199 the one between START and END.
4200 If SYNTAX is provided it's a regexp that describes the possible text of
4201 the clones; the clone will be shrunk or killed if necessary to ensure that
4202 its text matches the regexp.
4203 If SPREADP is non-nil it indicates that text inserted before/after the
4204 clone should be incorporated in the clone."
4205 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4206 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4207 ;; (with a one-char margin at each end) with `t nil'.
4208 ;; We opted for a larger overlay because it behaves better in the case
4209 ;; where the clone is reduced to the empty string (we want the overlay to
4210 ;; stay when the clone's content is the empty string and we want to use
4211 ;; `evaporate' to make sure those overlays get deleted when needed).
4213 (let* ((pt-end (+ (point) (- end start)))
4214 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4216 (end-margin (if (or (not spreadp)
4217 (>= pt-end (point-max))
4218 (>= start (point-max)))
4220 ;; FIXME: Reuse overlays at point to extend dups!
4221 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4222 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4223 (dups (list ol1 ol2)))
4224 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4225 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4226 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4227 ;;(overlay-put ol1 'face 'underline)
4228 (overlay-put ol1 'evaporate t)
4229 (overlay-put ol1 'text-clones dups)
4231 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4232 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4233 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4234 ;;(overlay-put ol2 'face 'underline)
4235 (overlay-put ol2 'evaporate t)
4236 (overlay-put ol2 'text-clones dups)))
4238 ;;;; Mail user agents.
4240 ;; Here we include just enough for other packages to be able
4243 (defun define-mail-user-agent (symbol composefunc sendfunc
4244 &optional abortfunc hookvar)
4245 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4247 SYMBOL can be any Lisp symbol. Its function definition and/or
4248 value as a variable do not matter for this usage; we use only certain
4249 properties on its property list, to encode the rest of the arguments.
4251 COMPOSEFUNC is program callable function that composes an outgoing
4252 mail message buffer. This function should set up the basics of the
4253 buffer without requiring user interaction. It should populate the
4254 standard mail headers, leaving the `to:' and `subject:' headers blank
4257 COMPOSEFUNC should accept several optional arguments--the same
4258 arguments that `compose-mail' takes. See that function's documentation.
4260 SENDFUNC is the command a user would run to send the message.
4262 Optional ABORTFUNC is the command a user would run to abort the
4263 message. For mail packages that don't have a separate abort function,
4264 this can be `kill-buffer' (the equivalent of omitting this argument).
4266 Optional HOOKVAR is a hook variable that gets run before the message
4267 is actually sent. Callers that use the `mail-user-agent' may
4268 install a hook function temporarily on this hook variable.
4269 If HOOKVAR is nil, `mail-send-hook' is used.
4271 The properties used on SYMBOL are `composefunc', `sendfunc',
4272 `abortfunc', and `hookvar'."
4273 (put symbol 'composefunc composefunc)
4274 (put symbol 'sendfunc sendfunc)
4275 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4276 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4278 (defvar called-interactively-p-functions nil
4279 "Special hook called to skip special frames in `called-interactively-p'.
4280 The functions are called with 3 arguments: (I FRAME1 FRAME2),
4281 where FRAME1 is a \"current frame\", FRAME2 is the next frame,
4282 I is the index of the frame after FRAME2. It should return nil
4283 if those frames don't seem special and otherwise, it should return
4284 the number of frames to skip (minus 1).")
4286 (defconst internal--funcall-interactively
4287 (symbol-function 'funcall-interactively))
4289 (defun called-interactively-p (&optional kind)
4290 "Return t if the containing function was called by `call-interactively'.
4291 If KIND is `interactive', then only return t if the call was made
4292 interactively by the user, i.e. not in `noninteractive' mode nor
4293 when `executing-kbd-macro'.
4294 If KIND is `any', on the other hand, it will return t for any kind of
4295 interactive call, including being called as the binding of a key or
4296 from a keyboard macro, even in `noninteractive' mode.
4298 This function is very brittle, it may fail to return the intended result when
4299 the code is debugged, advised, or instrumented in some form. Some macros and
4300 special forms (such as `condition-case') may also sometimes wrap their bodies
4301 in a `lambda', so any call to `called-interactively-p' from those bodies will
4302 indicate whether that lambda (rather than the surrounding function) was called
4305 Instead of using this function, it is cleaner and more reliable to give your
4306 function an extra optional argument whose `interactive' spec specifies
4307 non-nil unconditionally (\"p\" is a good way to do this), or via
4308 \(not (or executing-kbd-macro noninteractive)).
4310 The only known proper use of `interactive' for KIND is in deciding
4311 whether to display a helpful message, or how to display it. If you're
4312 thinking of using it for any other purpose, it is quite likely that
4313 you're making a mistake. Think: what do you want to do when the
4314 command is called from a keyboard macro?"
4315 (declare (advertised-calling-convention (kind) "23.1"))
4316 (when (not (and (eq kind 'interactive)
4317 (or executing-kbd-macro noninteractive)))
4318 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4322 (setq frame nextframe)
4323 (setq nextframe (backtrace-frame i 'called-interactively-p))
4324 ;; (message "Frame %d = %S" i nextframe)
4326 (funcall get-next-frame) ;; Get the first frame.
4328 ;; FIXME: The edebug and advice handling should be made modular and
4329 ;; provided directly by edebug.el and nadvice.el.
4331 ;; frame =(backtrace-frame i-2)
4332 ;; nextframe=(backtrace-frame i-1)
4333 (funcall get-next-frame)
4334 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4335 ;; branches within local functions, which then messes up the
4336 ;; `backtrace-frame' data we get,
4338 ;; Skip special forms (from non-compiled code).
4339 (and frame (null (car frame)))
4340 ;; Skip also `interactive-p' (because we don't want to know if
4341 ;; interactive-p was called interactively but if it's caller was)
4342 ;; and `byte-code' (idem; this appears in subexpressions of things
4343 ;; like condition-case, which are wrapped in a separate bytecode
4345 ;; FIXME: For lexical-binding code, this is much worse,
4346 ;; because the frames look like "byte-code -> funcall -> #[...]",
4347 ;; which is not a reliable signature.
4348 (memq (nth 1 frame) '(interactive-p 'byte-code))
4349 ;; Skip package-specific stack-frames.
4350 (let ((skip (run-hook-with-args-until-success
4351 'called-interactively-p-functions
4352 i frame nextframe)))
4356 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4357 ;; Now `frame' should be "the function from which we were called".
4358 (pcase (cons frame nextframe)
4359 ;; No subr calls `interactive-p', so we can rule that out.
4360 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
4361 ;; In case #<subr funcall-interactively> without going through the
4362 ;; `funcall-interactively' symbol (bug#3984).
4363 (`(,_ . (t ,(pred (lambda (f)
4364 (eq internal--funcall-interactively
4365 (indirect-function f))))
4369 (defun interactive-p ()
4370 "Return t if the containing function was run directly by user input.
4371 This means that the function was called with `call-interactively'
4372 \(which includes being called as the binding of a key)
4373 and input is currently coming from the keyboard (not a keyboard macro),
4374 and Emacs is not running in batch mode (`noninteractive' is nil).
4376 The only known proper use of `interactive-p' is in deciding whether to
4377 display a helpful message, or how to display it. If you're thinking
4378 of using it for any other purpose, it is quite likely that you're
4379 making a mistake. Think: what do you want to do when the command is
4380 called from a keyboard macro or in batch mode?
4382 To test whether your function was called with `call-interactively',
4383 either (i) add an extra optional argument and give it an `interactive'
4384 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
4385 use `called-interactively-p'."
4386 (declare (obsolete called-interactively-p "23.2"))
4387 (called-interactively-p 'interactive))
4389 (defun internal-push-keymap (keymap symbol)
4390 (let ((map (symbol-value symbol)))
4391 (unless (memq keymap map)
4392 (unless (memq 'add-keymap-witness (symbol-value symbol))
4393 (setq map (make-composed-keymap nil (symbol-value symbol)))
4394 (push 'add-keymap-witness (cdr map))
4396 (push keymap (cdr map)))))
4398 (defun internal-pop-keymap (keymap symbol)
4399 (let ((map (symbol-value symbol)))
4400 (when (memq keymap map)
4401 (setf (cdr map) (delq keymap (cdr map))))
4402 (let ((tail (cddr map)))
4403 (and (or (null tail) (keymapp tail))
4404 (eq 'add-keymap-witness (nth 1 map))
4405 (set symbol tail)))))
4407 (define-obsolete-function-alias
4408 'set-temporary-overlay-map 'set-transient-map "24.4")
4410 (defun set-transient-map (map &optional keep-pred on-exit)
4411 "Set MAP as a temporary keymap taking precedence over other keymaps.
4412 Normally, MAP is used only once, to look up the very next key.
4413 However, if the optional argument KEEP-PRED is t, MAP stays
4414 active if a key from MAP is used. KEEP-PRED can also be a
4415 function of no arguments: it is called from `pre-command-hook' and
4416 if it returns non-nil, then MAP stays active.
4418 Optional arg ON-EXIT, if non-nil, specifies a function that is
4419 called, with no arguments, after MAP is deactivated.
4421 This uses `overriding-terminal-local-map' which takes precedence over all other
4422 keymaps. As usual, if no match for a key is found in MAP, the normal key
4423 lookup sequence then continues.
4425 This returns an \"exit function\", which can be called with no argument
4426 to deactivate this transient map, regardless of KEEP-PRED."
4427 (let* ((clearfun (make-symbol "clear-transient-map"))
4430 (internal-pop-keymap map 'overriding-terminal-local-map)
4431 (remove-hook 'pre-command-hook clearfun)
4432 (when on-exit (funcall on-exit)))))
4433 ;; Don't use letrec, because equal (in add/remove-hook) would get trapped
4437 (with-demoted-errors "set-transient-map PCH: %S"
4439 ((null keep-pred) nil)
4440 ((not (eq map (cadr overriding-terminal-local-map)))
4441 ;; There's presumably some other transient-map in
4442 ;; effect. Wait for that one to terminate before we
4443 ;; remove ourselves.
4444 ;; For example, if isearch and C-u both use transient
4445 ;; maps, then the lifetime of the C-u should be nested
4446 ;; within isearch's, so the pre-command-hook of
4447 ;; isearch should be suspended during the C-u one so
4448 ;; we don't exit isearch just because we hit 1 after
4449 ;; C-u and that 1 exits isearch whereas it doesn't
4454 (lookup-key map (this-command-keys-vector))))
4455 (t (funcall keep-pred)))
4456 (funcall exitfun)))))
4457 (add-hook 'pre-command-hook clearfun)
4458 (internal-push-keymap map 'overriding-terminal-local-map)
4461 ;;;; Progress reporters.
4463 ;; Progress reporter has the following structure:
4465 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4472 ;; This weirdness is for optimization reasons: we want
4473 ;; `progress-reporter-update' to be as fast as possible, so
4474 ;; `(car reporter)' is better than `(aref reporter 0)'.
4476 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4477 ;; digits of precision, it doesn't really matter here. On the other
4478 ;; hand, it greatly simplifies the code.
4480 (defsubst progress-reporter-update (reporter &optional value)
4481 "Report progress of an operation in the echo area.
4482 REPORTER should be the result of a call to `make-progress-reporter'.
4484 If REPORTER is a numerical progress reporter---i.e. if it was
4485 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4486 `make-progress-reporter'---then VALUE should be a number between
4487 MIN-VALUE and MAX-VALUE.
4489 If REPORTER is a non-numerical reporter, VALUE should be nil.
4491 This function is relatively inexpensive. If the change since
4492 last update is too small or insufficient time has passed, it does
4494 (when (or (not (numberp value)) ; For pulsing reporter
4495 (>= value (car reporter))) ; For numerical reporter
4496 (progress-reporter-do-update reporter value)))
4498 (defun make-progress-reporter (message &optional min-value max-value
4499 current-value min-change min-time)
4500 "Return progress reporter object for use with `progress-reporter-update'.
4502 MESSAGE is shown in the echo area, with a status indicator
4503 appended to the end. When you call `progress-reporter-done', the
4504 word \"done\" is printed after the MESSAGE. You can change the
4505 MESSAGE of an existing progress reporter by calling
4506 `progress-reporter-force-update'.
4508 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4509 and final (100% complete) states of operation; the latter should
4510 be larger. In this case, the status message shows the percentage
4513 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4514 message shows a \"spinning\", non-numeric indicator.
4516 Optional CURRENT-VALUE is the initial progress; the default is
4518 Optional MIN-CHANGE is the minimal change in percents to report;
4520 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4521 and/or MAX-VALUE are nil.
4523 Optional MIN-TIME specifies the minimum interval time between
4524 echo area updates (default is 0.2 seconds.) If the function
4525 `float-time' is not present, time is not tracked at all. If the
4526 OS is not capable of measuring fractions of seconds, this
4527 parameter is effectively rounded up."
4528 (when (string-match "[[:alnum:]]\\'" message)
4529 (setq message (concat message "...")))
4531 (setq min-time 0.2))
4533 ;; Force a call to `message' now
4534 (cons (or min-value 0)
4535 (vector (if (and (fboundp 'float-time)
4541 (if min-change (max (min min-change 50) 1) 1)
4543 (progress-reporter-update reporter (or current-value min-value))
4546 (defun progress-reporter-force-update (reporter &optional value new-message)
4547 "Report progress of an operation in the echo area unconditionally.
4549 The first two arguments are the same as in `progress-reporter-update'.
4550 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4551 (let ((parameters (cdr reporter)))
4553 (aset parameters 3 new-message))
4554 (when (aref parameters 0)
4555 (aset parameters 0 (float-time)))
4556 (progress-reporter-do-update reporter value)))
4558 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4559 "Characters to use for pulsing progress reporters.")
4561 (defun progress-reporter-do-update (reporter value)
4562 (let* ((parameters (cdr reporter))
4563 (update-time (aref parameters 0))
4564 (min-value (aref parameters 1))
4565 (max-value (aref parameters 2))
4566 (text (aref parameters 3))
4568 ;; See if enough time has passed since the last update.
4569 (or (not update-time)
4570 (when (>= (float-time) update-time)
4571 ;; Calculate time for the next update
4572 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4573 (cond ((and min-value max-value)
4574 ;; Numerical indicator
4575 (let* ((one-percent (/ (- max-value min-value) 100.0))
4576 (percentage (if (= max-value min-value)
4578 (truncate (/ (- value min-value)
4580 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4581 ;; message because not enough time has passed, use 1
4582 ;; instead of MIN-CHANGE. This makes delays between echo
4583 ;; area updates closer to MIN-TIME.
4585 (min (+ min-value (* (+ percentage
4586 (if enough-time-passed
4592 (when (integerp value)
4593 (setcar reporter (ceiling (car reporter))))
4594 ;; Only print message if enough time has passed
4595 (when enough-time-passed
4596 (if (> percentage 0)
4597 (message "%s%d%%" text percentage)
4598 (message "%s" text)))))
4599 ;; Pulsing indicator
4601 (let ((index (mod (1+ (car reporter)) 4))
4602 (message-log-max nil))
4603 (setcar reporter index)
4606 (aref progress-reporter--pulse-characters
4609 (defun progress-reporter-done (reporter)
4610 "Print reporter's message followed by word \"done\" in echo area."
4611 (message "%sdone" (aref (cdr reporter) 3)))
4613 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4614 "Loop a certain number of times and report progress in the echo area.
4615 Evaluate BODY with VAR bound to successive integers running from
4616 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4617 the return value (nil if RESULT is omitted).
4619 At each iteration MESSAGE followed by progress percentage is
4620 printed in the echo area. After the loop is finished, MESSAGE
4621 followed by word \"done\" is printed. This macro is a
4622 convenience wrapper around `make-progress-reporter' and friends.
4624 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4625 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4626 (let ((temp (make-symbol "--dotimes-temp--"))
4627 (temp2 (make-symbol "--dotimes-temp2--"))
4631 (,(car spec) ,start)
4632 (,temp2 (make-progress-reporter ,message ,start ,end)))
4633 (while (< ,(car spec) ,temp)
4635 (progress-reporter-update ,temp2
4636 (setq ,(car spec) (1+ ,(car spec)))))
4637 (progress-reporter-done ,temp2)
4638 nil ,@(cdr (cdr spec)))))
4641 ;;;; Comparing version strings.
4643 (defconst version-separator "."
4644 "Specify the string used to separate the version elements.
4646 Usually the separator is \".\", but it can be any other string.")
4649 (defconst version-regexp-alist
4650 '(("^[-_+ ]?snapshot$" . -4)
4651 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4653 ;; treat "1.2.3-CVS" as snapshot release
4654 ("^[-_+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4)
4655 ("^[-_+ ]?alpha$" . -3)
4656 ("^[-_+ ]?beta$" . -2)
4657 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
4658 "Specify association between non-numeric version and its priority.
4660 This association is used to handle version string like \"1.0pre2\",
4661 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4662 non-numeric part of a version string to an integer. For example:
4664 String Version Integer List Version
4665 \"0.9snapshot\" (0 9 -4)
4666 \"1.0-git\" (1 0 -4)
4667 \"1.0pre2\" (1 0 -1 2)
4668 \"1.0PRE2\" (1 0 -1 2)
4669 \"22.8beta3\" (22 8 -2 3)
4670 \"22.8 Beta3\" (22 8 -2 3)
4671 \"0.9alpha1\" (0 9 -3 1)
4672 \"0.9AlphA1\" (0 9 -3 1)
4673 \"0.9 alpha\" (0 9 -3)
4675 Each element has the following form:
4681 REGEXP regexp used to match non-numeric part of a version string.
4682 It should begin with the `^' anchor and end with a `$' to
4683 prevent false hits. Letter-case is ignored while matching
4686 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4689 (defun version-to-list (ver)
4690 "Convert version string VER into a list of integers.
4692 The version syntax is given by the following EBNF:
4694 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4696 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4698 SEPARATOR ::= `version-separator' (which see)
4699 | `version-regexp-alist' (which see).
4701 The NUMBER part is optional if SEPARATOR is a match for an element
4702 in `version-regexp-alist'.
4704 Examples of valid version syntax:
4706 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4708 Examples of invalid version syntax:
4710 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4712 Examples of version conversion:
4714 Version String Version as a List of Integers
4715 \"1.0.7.5\" (1 0 7 5)
4716 \"1.0pre2\" (1 0 -1 2)
4717 \"1.0PRE2\" (1 0 -1 2)
4718 \"22.8beta3\" (22 8 -2 3)
4719 \"22.8Beta3\" (22 8 -2 3)
4720 \"0.9alpha1\" (0 9 -3 1)
4721 \"0.9AlphA1\" (0 9 -3 1)
4722 \"0.9alpha\" (0 9 -3)
4723 \"0.9snapshot\" (0 9 -4)
4724 \"1.0-git\" (1 0 -4)
4726 See documentation for `version-separator' and `version-regexp-alist'."
4727 (or (and (stringp ver) (> (length ver) 0))
4728 (error "Invalid version string: '%s'" ver))
4729 ;; Change .x.y to 0.x.y
4730 (if (and (>= (length ver) (length version-separator))
4731 (string-equal (substring ver 0 (length version-separator))
4733 (setq ver (concat "0" ver)))
4736 (case-fold-search t) ; ignore case in matching
4738 (while (and (setq s (string-match "[0-9]+" ver i))
4740 ;; handle numeric part
4741 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4744 ;; handle non-numeric part
4745 (when (and (setq s (string-match "[^0-9]+" ver i))
4747 (setq s (substring ver i (match-end 0))
4749 ;; handle alpha, beta, pre, etc. separator
4750 (unless (string= s version-separator)
4751 (setq al version-regexp-alist)
4752 (while (and al (not (string-match (caar al) s)))
4755 (push (cdar al) lst))
4756 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4757 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4758 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4760 (t (error "Invalid version syntax: '%s'" ver))))))
4762 (error "Invalid version syntax: '%s'" ver)
4766 (defun version-list-< (l1 l2)
4767 "Return t if L1, a list specification of a version, is lower than L2.
4769 Note that a version specified by the list (1) is equal to (1 0),
4770 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4771 Also, a version given by the list (1) is higher than (1 -1), which in
4772 turn is higher than (1 -2), which is higher than (1 -3)."
4773 (while (and l1 l2 (= (car l1) (car l2)))
4777 ;; l1 not null and l2 not null
4778 ((and l1 l2) (< (car l1) (car l2)))
4779 ;; l1 null and l2 null ==> l1 length = l2 length
4780 ((and (null l1) (null l2)) nil)
4781 ;; l1 not null and l2 null ==> l1 length > l2 length
4782 (l1 (< (version-list-not-zero l1) 0))
4783 ;; l1 null and l2 not null ==> l2 length > l1 length
4784 (t (< 0 (version-list-not-zero l2)))))
4787 (defun version-list-= (l1 l2)
4788 "Return t if L1, a list specification of a version, is equal to L2.
4790 Note that a version specified by the list (1) is equal to (1 0),
4791 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4792 Also, a version given by the list (1) is higher than (1 -1), which in
4793 turn is higher than (1 -2), which is higher than (1 -3)."
4794 (while (and l1 l2 (= (car l1) (car l2)))
4798 ;; l1 not null and l2 not null
4800 ;; l1 null and l2 null ==> l1 length = l2 length
4801 ((and (null l1) (null l2)))
4802 ;; l1 not null and l2 null ==> l1 length > l2 length
4803 (l1 (zerop (version-list-not-zero l1)))
4804 ;; l1 null and l2 not null ==> l2 length > l1 length
4805 (t (zerop (version-list-not-zero l2)))))
4808 (defun version-list-<= (l1 l2)
4809 "Return t if L1, a list specification of a version, is lower or equal to L2.
4811 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4812 etc. That is, the trailing zeroes are insignificant. Also, integer
4813 list (1) is greater than (1 -1) which is greater than (1 -2)
4814 which is greater than (1 -3)."
4815 (while (and l1 l2 (= (car l1) (car l2)))
4819 ;; l1 not null and l2 not null
4820 ((and l1 l2) (< (car l1) (car l2)))
4821 ;; l1 null and l2 null ==> l1 length = l2 length
4822 ((and (null l1) (null l2)))
4823 ;; l1 not null and l2 null ==> l1 length > l2 length
4824 (l1 (<= (version-list-not-zero l1) 0))
4825 ;; l1 null and l2 not null ==> l2 length > l1 length
4826 (t (<= 0 (version-list-not-zero l2)))))
4828 (defun version-list-not-zero (lst)
4829 "Return the first non-zero element of LST, which is a list of integers.
4831 If all LST elements are zeros or LST is nil, return zero."
4832 (while (and lst (zerop (car lst)))
4833 (setq lst (cdr lst)))
4836 ;; there is no element different of zero
4840 (defun version< (v1 v2)
4841 "Return t if version V1 is lower (older) than V2.
4843 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4844 etc. That is, the trailing \".0\"s are insignificant. Also, version
4845 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4846 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4847 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4848 (version-list-< (version-to-list v1) (version-to-list v2)))
4850 (defun version<= (v1 v2)
4851 "Return t if version V1 is lower (older) than or equal to V2.
4853 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4854 etc. That is, the trailing \".0\"s are insignificant. Also, version
4855 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4856 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4857 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4858 (version-list-<= (version-to-list v1) (version-to-list v2)))
4860 (defun version= (v1 v2)
4861 "Return t if version V1 is equal to V2.
4863 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4864 etc. That is, the trailing \".0\"s are insignificant. Also, version
4865 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4866 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4867 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4868 (version-list-= (version-to-list v1) (version-to-list v2)))
4870 (defvar package--builtin-versions
4871 ;; Mostly populated by loaddefs.el via autoload-builtin-package-versions.
4872 (purecopy `((emacs . ,(version-to-list emacs-version))))
4873 "Alist giving the version of each versioned builtin package.
4874 I.e. each element of the list is of the form (NAME . VERSION) where
4875 NAME is the package name as a symbol, and VERSION is its version
4878 (defun package--description-file (dir)
4879 (concat (let ((subdir (file-name-nondirectory
4880 (directory-file-name dir))))
4881 (if (string-match "\\([^.].*?\\)-\\([0-9]+\\(?:[.][0-9]+\\|\\(?:pre\\|beta\\|alpha\\)[0-9]+\\)*\\)" subdir)
4882 (match-string 1 subdir) subdir))
4887 (defconst menu-bar-separator '("--")
4888 "Separator for menus.")
4890 ;; The following statement ought to be in print.c, but `provide' can't
4892 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4893 (when (hash-table-p (car (read-from-string
4894 (prin1-to-string (make-hash-table)))))
4895 (provide 'hashtable-print-readable))
4897 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
4898 ;; generate file names for autoloads, custom-deps, and finder-data.
4899 (defun unmsys--file-name (file)
4900 "Produce the canonical file name for FILE from its MSYS form.
4902 On systems other than MS-Windows, just returns FILE.
4903 On MS-Windows, converts /d/foo/bar form of file names
4904 passed by MSYS Make into d:/foo/bar that Emacs can grok.
4906 This function is called from lisp/Makefile and leim/Makefile."
4907 (when (and (eq system-type 'windows-nt)
4908 (string-match "\\`/[a-zA-Z]/" file))
4909 (setq file (concat (substring file 1 2) ":" (substring file 2))))
4913 ;;; subr.el ends here