1 ;;; subr.el --- basic lisp subroutines for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2018 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 <https://www.gnu.org/licenses/>.
25 ;; Beware: while this file has tag `utf-8', before it's compiled, it gets
26 ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
29 ;; declare-function's args use &rest, not &optional, for compatibility
30 ;; with byte-compile-macroexpand-declare-function.
32 (defmacro declare-function
(_fn _file
&rest _args
)
33 "Tell the byte-compiler that function FN is defined, in FILE.
34 The FILE argument is not used by the byte-compiler, but by the
35 `check-declare' package, which checks that FILE contains a
38 FILE can be either a Lisp file (in which case the \".el\"
39 extension is optional), or a C file. C files are expanded
40 relative to the Emacs \"src/\" directory. Lisp files are
41 searched for using `locate-library', and if that fails they are
42 expanded relative to the location of the file containing the
43 declaration. A FILE with an \"ext:\" prefix is an external file.
44 `check-declare' will check such files if they are found, and skip
45 them without error if they are not.
47 Optional ARGLIST specifies FN's arguments, or is t to not specify
48 FN's arguments. An omitted ARGLIST defaults to t, not nil: a nil
49 ARGLIST specifies an empty argument list, and an explicit t
50 ARGLIST is a placeholder that allows supplying a later arg.
52 Optional FILEONLY non-nil means that `check-declare' will check
53 only that FILE exists, not that it defines FN. This is intended
54 for function definitions that `check-declare' does not recognize,
57 Note that for the purposes of `check-declare', this statement
58 must be the first non-whitespace on a line.
60 For more information, see Info node `(elisp)Declaring Functions'."
61 (declare (advertised-calling-convention
62 (fn file
&optional arglist fileonly
) nil
))
63 ;; Does nothing - byte-compile-declare-function does the work.
67 ;;;; Basic Lisp macros.
70 (defalias 'sxhash
'sxhash-equal
)
72 (defmacro noreturn
(form)
73 "Evaluate FORM, expecting it not to return.
74 If FORM does return, signal an error."
77 (error "Form marked with `noreturn' did return")))
79 (defmacro 1value
(form)
80 "Evaluate FORM, expecting a constant return value.
81 This is the global do-nothing version. There is also `testcover-1value'
82 that complains if FORM ever does return differing values."
86 (defmacro def-edebug-spec
(symbol spec
)
87 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
88 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
89 0 (instrument no arguments); t (instrument all arguments);
90 a symbol (naming a function with an Edebug specification); or a list.
91 The elements of the list describe the argument types; see
92 Info node `(elisp)Specification List' for details."
93 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
95 (defmacro lambda
(&rest cdr
)
96 "Return a lambda expression.
97 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
98 self-quoting; the result of evaluating the lambda expression is the
99 expression itself. The lambda expression may then be treated as a
100 function, i.e., stored as the function value of a symbol, passed to
101 `funcall' or `mapcar', etc.
103 ARGS should take the same form as an argument list for a `defun'.
104 DOCSTRING is an optional documentation string.
105 If present, it should describe how to call the function.
106 But documentation strings are usually not useful in nameless functions.
107 INTERACTIVE should be a call to the function `interactive', which see.
108 It may also be omitted.
109 BODY should be a list of Lisp expressions.
111 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
112 (declare (doc-string 2) (indent defun
)
113 (debug (&define lambda-list lambda-doc
114 [&optional
("interactive" interactive
)]
116 ;; Note that this definition should not use backquotes; subr.el should not
117 ;; depend on backquote.el.
118 (list 'function
(cons 'lambda cdr
)))
120 (defmacro setq-local
(var val
)
121 "Set variable VAR to value VAL in current buffer."
122 ;; Can't use backquote here, it's too early in the bootstrap.
123 (declare (debug (symbolp form
)))
124 (list 'set
(list 'make-local-variable
(list 'quote var
)) val
))
126 (defmacro defvar-local
(var val
&optional docstring
)
127 "Define VAR as a buffer-local variable with default value VAL.
128 Like `defvar' but additionally marks the variable as being automatically
129 buffer-local wherever it is set."
130 (declare (debug defvar
) (doc-string 3))
131 ;; Can't use backquote here, it's too early in the bootstrap.
132 (list 'progn
(list 'defvar var val docstring
)
133 (list 'make-variable-buffer-local
(list 'quote var
))))
135 (defmacro push
(newelt place
)
136 "Add NEWELT to the list stored in the generalized variable PLACE.
137 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
138 except that PLACE is only evaluated once (after NEWELT)."
139 (declare (debug (form gv-place
)))
141 ;; Important special case, to avoid triggering GV too early in
144 (list 'cons newelt place
))
146 (macroexp-let2 macroexp-copyable-p v newelt
147 (gv-letplace (getter setter
) place
148 (funcall setter
`(cons ,v
,getter
))))))
150 (defmacro pop
(place)
151 "Return the first element of PLACE's value, and remove it from the list.
152 PLACE must be a generalized variable whose value is a list.
153 If the value is nil, `pop' returns nil but does not actually
155 (declare (debug (gv-place)))
156 ;; We use `car-safe' here instead of `car' because the behavior is the same
157 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
158 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
159 ;; result is not used.
162 ;; So we can use `pop' in the bootstrap before `gv' can be used.
163 (list 'prog1 place
(list 'setq place
(list 'cdr place
)))
164 (gv-letplace (getter setter
) place
165 (macroexp-let2 macroexp-copyable-p x getter
166 `(prog1 ,x
,(funcall setter
`(cdr ,x
))))))))
168 (defmacro when
(cond &rest body
)
169 "If COND yields non-nil, do BODY, else return nil.
170 When COND yields non-nil, eval BODY forms sequentially and return
171 value of last one, or nil if there are none.
174 (declare (indent 1) (debug t
))
175 (list 'if cond
(cons 'progn body
)))
177 (defmacro unless
(cond &rest body
)
178 "If COND yields nil, do BODY, else return nil.
179 When COND yields nil, eval BODY forms sequentially and return
180 value of last one, or nil if there are none.
183 (declare (indent 1) (debug t
))
184 (cons 'if
(cons cond
(cons nil body
))))
186 (defmacro dolist
(spec &rest body
)
188 Evaluate BODY with VAR bound to each car from LIST, in turn.
189 Then evaluate RESULT to get return value, default nil.
191 \(fn (VAR LIST [RESULT]) BODY...)"
192 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
194 (signal 'wrong-type-argument
(list 'consp spec
)))
195 (unless (<= 2 (length spec
) 3)
196 (signal 'wrong-number-of-arguments
(list '(2 .
3) (length spec
))))
197 ;; It would be cleaner to create an uninterned symbol,
198 ;; but that uses a lot more space when many functions in many files
200 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
201 (let ((temp '--dolist-tail--
))
202 ;; This is not a reliable test, but it does not matter because both
203 ;; semantics are acceptable, tho one is slightly faster with dynamic
204 ;; scoping and the other is slightly faster (and has cleaner semantics)
205 ;; with lexical scoping.
207 `(let ((,temp
,(nth 1 spec
)))
209 (let ((,(car spec
) (car ,temp
)))
211 (setq ,temp
(cdr ,temp
))))
213 `(let ((,temp
,(nth 1 spec
))
216 (setq ,(car spec
) (car ,temp
))
218 (setq ,temp
(cdr ,temp
)))
219 ,@(if (cdr (cdr spec
))
220 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
))))))))
222 (defmacro dotimes
(spec &rest body
)
223 "Loop a certain number of times.
224 Evaluate BODY with VAR bound to successive integers running from 0,
225 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
226 the return value (nil if RESULT is omitted).
228 \(fn (VAR COUNT [RESULT]) BODY...)"
229 (declare (indent 1) (debug dolist
))
230 ;; It would be cleaner to create an uninterned symbol,
231 ;; but that uses a lot more space when many functions in many files
233 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
234 (let ((temp '--dotimes-limit--
)
237 ;; This is not a reliable test, but it does not matter because both
238 ;; semantics are acceptable, tho one is slightly faster with dynamic
239 ;; scoping and the other has cleaner semantics.
241 (let ((counter '--dotimes-counter--
))
244 (while (< ,counter
,temp
)
245 (let ((,(car spec
) ,counter
))
247 (setq ,counter
(1+ ,counter
)))
249 ;; FIXME: This let often leads to "unused var" warnings.
250 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
252 (,(car spec
) ,start
))
253 (while (< ,(car spec
) ,temp
)
255 (setq ,(car spec
) (1+ ,(car spec
))))
256 ,@(cdr (cdr spec
))))))
258 (defmacro declare
(&rest _specs
)
259 "Do not evaluate any arguments, and return nil.
260 If a `declare' form appears as the first form in the body of a
261 `defun' or `defmacro' form, SPECS specifies various additional
262 information about the function or macro; these go into effect
263 during the evaluation of the `defun' or `defmacro' form.
265 The possible values of SPECS are specified by
266 `defun-declarations-alist' and `macro-declarations-alist'.
268 For more information, see info node `(elisp)Declare Form'."
269 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
272 (defmacro ignore-errors
(&rest body
)
273 "Execute BODY; if an error occurs, return nil.
274 Otherwise, return result of last form in BODY.
275 See also `with-demoted-errors' that does something similar
276 without silencing all errors."
277 (declare (debug t
) (indent 0))
278 `(condition-case nil
(progn ,@body
) (error nil
)))
280 ;;;; Basic Lisp functions.
282 (defvar gensym-counter
0
283 "Number used to construct the name of the next symbol created by `gensym'.")
285 (defun gensym (&optional prefix
)
286 "Return a new uninterned symbol.
287 The name is made by appending `gensym-counter' to PREFIX.
288 PREFIX is a string, and defaults to \"g\"."
289 (let ((num (prog1 gensym-counter
290 (setq gensym-counter
(1+ gensym-counter
)))))
291 (make-symbol (format "%s%d" (or prefix
"g") num
))))
293 (defun ignore (&rest _ignore
)
294 "Do nothing and return nil.
295 This function accepts any number of arguments, but ignores them."
299 ;; Signal a compile-error if the first arg is missing.
300 (defun error (&rest args
)
301 "Signal an error, making a message by passing args to `format-message'.
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.
306 Note: (error \"%s\" VALUE) makes the message VALUE without
307 interpreting format characters like `%', `\\=`', and `\\=''."
308 (declare (advertised-calling-convention (string &rest args
) "23.1"))
309 (signal 'error
(list (apply #'format-message args
))))
311 (defun user-error (format &rest args
)
312 "Signal a pilot error, making a message by passing args to `format-message'.
313 In Emacs, the convention is that error messages start with a capital
314 letter but *do not* end with a period. Please follow this convention
315 for the sake of consistency.
316 This is just like `error' except that `user-error's are expected to be the
317 result of an incorrect manipulation on the part of the user, rather than the
318 result of an actual problem.
320 Note: (user-error \"%s\" VALUE) makes the message VALUE without
321 interpreting format characters like `%', `\\=`', and `\\=''."
322 (signal 'user-error
(list (apply #'format-message format args
))))
324 (defun define-error (name message
&optional parent
)
325 "Define NAME as a new error signal.
326 MESSAGE is a string that will be output to the echo area if such an error
327 is signaled without being caught by a `condition-case'.
328 PARENT is either a signal or a list of signals from which it inherits.
329 Defaults to `error'."
330 (unless parent
(setq parent
'error
))
334 (mapcar (lambda (parent)
336 (or (get parent
'error-conditions
)
337 (error "Unknown signal `%s'" parent
))))
339 (cons parent
(get parent
'error-conditions
)))))
340 (put name
'error-conditions
341 (delete-dups (copy-sequence (cons name conditions
))))
342 (when message
(put name
'error-message message
))))
344 ;; We put this here instead of in frame.el so that it's defined even on
345 ;; systems where frame.el isn't loaded.
346 (defun frame-configuration-p (object)
347 "Return non-nil if OBJECT seems to be a frame configuration.
348 Any list whose car is `frame-configuration' is assumed to be a frame
351 (eq (car object
) 'frame-configuration
)))
353 (defun apply-partially (fun &rest args
)
354 "Return a function that is a partial application of FUN to ARGS.
355 ARGS is a list of the first N arguments to pass to FUN.
356 The result is a new function which does the same as FUN, except that
357 the first N arguments are fixed at the values with which this function
359 (lambda (&rest args2
)
360 (apply fun
(append args args2
))))
365 ;; Note: `internal--compiler-macro-cXXr' was copied from
366 ;; `cl--compiler-macro-cXXr' in cl-macs.el. If you amend either one,
367 ;; you may want to amend the other, too.
368 (defun internal--compiler-macro-cXXr (form x
)
369 (let* ((head (car form
))
370 (n (symbol-name (car form
)))
371 (i (- (length n
) 2)))
372 (if (not (string-match "c[ad]+r\\'" n
))
373 (if (and (fboundp head
) (symbolp (symbol-function head
)))
374 (internal--compiler-macro-cXXr (cons (symbol-function head
) (cdr form
))
376 (error "Compiler macro for cXXr applied to non-cXXr form"))
377 (while (> i
(match-beginning 0))
378 (setq x
(list (if (eq (aref n i
) ?a
) 'car
'cdr
) x
))
383 "Return the car of the car of X."
384 (declare (compiler-macro internal--compiler-macro-cXXr
))
388 "Return the car of the cdr of X."
389 (declare (compiler-macro internal--compiler-macro-cXXr
))
393 "Return the cdr of the car of X."
394 (declare (compiler-macro internal--compiler-macro-cXXr
))
398 "Return the cdr of the cdr of X."
399 (declare (compiler-macro internal--compiler-macro-cXXr
))
403 "Return the `car' of the `car' of the `car' of X."
404 (declare (compiler-macro internal--compiler-macro-cXXr
))
408 "Return the `car' of the `car' of the `cdr' of X."
409 (declare (compiler-macro internal--compiler-macro-cXXr
))
413 "Return the `car' of the `cdr' of the `car' of X."
414 (declare (compiler-macro internal--compiler-macro-cXXr
))
418 "Return the `car' of the `cdr' of the `cdr' of X."
419 (declare (compiler-macro internal--compiler-macro-cXXr
))
423 "Return the `cdr' of the `car' of the `car' of X."
424 (declare (compiler-macro internal--compiler-macro-cXXr
))
428 "Return the `cdr' of the `car' of the `cdr' of X."
429 (declare (compiler-macro internal--compiler-macro-cXXr
))
433 "Return the `cdr' of the `cdr' of the `car' of X."
434 (declare (compiler-macro internal--compiler-macro-cXXr
))
438 "Return the `cdr' of the `cdr' of the `cdr' of X."
439 (declare (compiler-macro internal--compiler-macro-cXXr
))
443 "Return the `car' of the `car' of the `car' of the `car' of X."
444 (declare (compiler-macro internal--compiler-macro-cXXr
))
445 (car (car (car (car x
)))))
448 "Return the `car' of the `car' of the `car' of the `cdr' of X."
449 (declare (compiler-macro internal--compiler-macro-cXXr
))
450 (car (car (car (cdr x
)))))
453 "Return the `car' of the `car' of the `cdr' of the `car' of X."
454 (declare (compiler-macro internal--compiler-macro-cXXr
))
455 (car (car (cdr (car x
)))))
458 "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
459 (declare (compiler-macro internal--compiler-macro-cXXr
))
460 (car (car (cdr (cdr x
)))))
463 "Return the `car' of the `cdr' of the `car' of the `car' of X."
464 (declare (compiler-macro internal--compiler-macro-cXXr
))
465 (car (cdr (car (car x
)))))
468 "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
469 (declare (compiler-macro internal--compiler-macro-cXXr
))
470 (car (cdr (car (cdr x
)))))
473 "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
474 (declare (compiler-macro internal--compiler-macro-cXXr
))
475 (car (cdr (cdr (car x
)))))
478 "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
479 (declare (compiler-macro internal--compiler-macro-cXXr
))
480 (car (cdr (cdr (cdr x
)))))
483 "Return the `cdr' of the `car' of the `car' of the `car' of X."
484 (declare (compiler-macro internal--compiler-macro-cXXr
))
485 (cdr (car (car (car x
)))))
488 "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
489 (declare (compiler-macro internal--compiler-macro-cXXr
))
490 (cdr (car (car (cdr x
)))))
493 "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
494 (declare (compiler-macro internal--compiler-macro-cXXr
))
495 (cdr (car (cdr (car x
)))))
498 "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
499 (declare (compiler-macro internal--compiler-macro-cXXr
))
500 (cdr (car (cdr (cdr x
)))))
503 "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
504 (declare (compiler-macro internal--compiler-macro-cXXr
))
505 (cdr (cdr (car (car x
)))))
508 "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
509 (declare (compiler-macro internal--compiler-macro-cXXr
))
510 (cdr (cdr (car (cdr x
)))))
513 "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
514 (declare (compiler-macro internal--compiler-macro-cXXr
))
515 (cdr (cdr (cdr (car x
)))))
518 "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
519 (declare (compiler-macro internal--compiler-macro-cXXr
))
520 (cdr (cdr (cdr (cdr x
)))))
522 (defun last (list &optional n
)
523 "Return the last link of LIST. Its car is the last element.
524 If LIST is nil, return nil.
525 If N is non-nil, return the Nth-to-last link of LIST.
526 If N is bigger than the length of LIST, return LIST."
529 (let ((m (safe-length list
)))
530 (if (< n m
) (nthcdr (- m n
) list
) list
)))
532 (nthcdr (1- (safe-length list
)) list
))))
534 (defun butlast (list &optional n
)
535 "Return a copy of LIST with the last N elements removed.
536 If N is omitted or nil, the last element is removed from the
538 (if (and n
(<= n
0)) list
539 (nbutlast (copy-sequence list
) n
)))
541 (defun nbutlast (list &optional n
)
542 "Modifies LIST to remove the last N elements.
543 If N is omitted or nil, remove the last element."
544 (let ((m (length list
)))
548 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
551 (defun zerop (number)
552 "Return t if NUMBER is zero."
553 ;; Used to be in C, but it's pointless since (= 0 n) is faster anyway because
554 ;; = has a byte-code.
555 (declare (compiler-macro (lambda (_) `(= 0 ,number
))))
558 (defun delete-dups (list)
559 "Destructively remove `equal' duplicates from LIST.
560 Store the result in LIST and return it. LIST must be a proper list.
561 Of several `equal' occurrences of an element in LIST, the first
563 (let ((l (length list
)))
565 (let ((hash (make-hash-table :test
#'equal
:size l
))
567 (puthash (car list
) t hash
)
568 (while (setq retail
(cdr tail
))
569 (let ((elt (car retail
)))
570 (if (gethash elt hash
)
571 (setcdr tail
(cdr retail
))
573 (setq tail retail
)))))
576 (setcdr tail
(delete (car tail
) (cdr tail
)))
577 (setq tail
(cdr tail
))))))
580 ;; See https://lists.gnu.org/r/emacs-devel/2013-05/msg00204.html
581 (defun delete-consecutive-dups (list &optional circular
)
582 "Destructively remove `equal' consecutive duplicates from LIST.
583 First and last elements are considered consecutive if CIRCULAR is
585 (let ((tail list
) last
)
587 (if (equal (car tail
) (cadr tail
))
588 (setcdr tail
(cddr tail
))
593 (equal (car tail
) (car list
)))
597 (defun number-sequence (from &optional to inc
)
598 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
599 INC is the increment used between numbers in the sequence and defaults to 1.
600 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
601 zero. TO is only included if there is an N for which TO = FROM + N * INC.
602 If TO is nil or numerically equal to FROM, return (FROM).
603 If INC is positive and TO is less than FROM, or INC is negative
604 and TO is larger than FROM, return nil.
605 If INC is zero and TO is neither nil nor numerically equal to
606 FROM, signal an error.
608 This function is primarily designed for integer arguments.
609 Nevertheless, FROM, TO and INC can be integer or float. However,
610 floating point arithmetic is inexact. For instance, depending on
611 the machine, it may quite well happen that
612 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
613 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
614 elements. Thus, if some of the arguments are floats and one wants
615 to make sure that TO is included, one may have to explicitly write
616 TO as (+ FROM (* N INC)) or use a variable whose value was
617 computed with this exact expression. Alternatively, you can,
618 of course, also replace TO with a slightly larger value
619 \(or a slightly more negative value if INC is negative)."
620 (if (or (not to
) (= from to
))
622 (or inc
(setq inc
1))
623 (when (zerop inc
) (error "The increment can not be zero"))
624 (let (seq (n 0) (next from
) (last from
))
626 ;; The (>= next last) condition protects against integer
627 ;; overflow in computing NEXT.
628 (while (and (>= next last
) (<= next to
))
629 (setq seq
(cons next seq
)
632 next
(+ from
(* n inc
))))
633 (while (and (<= next last
) (>= next to
))
634 (setq seq
(cons next seq
)
636 next
(+ from
(* n inc
)))))
639 (defun copy-tree (tree &optional vecp
)
640 "Make a copy of TREE.
641 If TREE is a cons cell, this recursively copies both its car and its cdr.
642 Contrast to `copy-sequence', which copies only along the cdrs. With second
643 argument VECP, this copies vectors as well as conses."
647 (let ((newcar (car tree
)))
648 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
649 (setq newcar
(copy-tree (car tree
) vecp
)))
650 (push newcar result
))
651 (setq tree
(cdr tree
)))
652 (nconc (nreverse result
)
653 (if (and vecp
(vectorp tree
)) (copy-tree tree vecp
) tree
)))
654 (if (and vecp
(vectorp tree
))
655 (let ((i (length (setq tree
(copy-sequence tree
)))))
656 (while (>= (setq i
(1- i
)) 0)
657 (aset tree i
(copy-tree (aref tree i
) vecp
)))
661 ;;;; Various list-search functions.
663 (defun assoc-default (key alist
&optional test default
)
664 "Find object KEY in a pseudo-alist ALIST.
665 ALIST is a list of conses or objects. Each element
666 (or the element's car, if it is a cons) is compared with KEY by
667 calling TEST, with two arguments: (i) the element or its car,
669 If that is non-nil, the element matches; then `assoc-default'
670 returns the element's cdr, if it is a cons, or DEFAULT if the
671 element is not a cons.
673 If no element matches, the value is nil.
674 If TEST is omitted or nil, `equal' is used."
675 (let (found (tail alist
) value
)
676 (while (and tail
(not found
))
677 (let ((elt (car tail
)))
678 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
679 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
680 (setq tail
(cdr tail
)))
683 (defun assoc-ignore-case (key alist
)
684 "Like `assoc', but ignores differences in case and text representation.
685 KEY must be a string. Upper-case and lower-case letters are treated as equal.
686 Unibyte strings are converted to multibyte for comparison."
687 (declare (obsolete assoc-string
"22.1"))
688 (assoc-string key alist t
))
690 (defun assoc-ignore-representation (key alist
)
691 "Like `assoc', but ignores differences in text representation.
692 KEY must be a string.
693 Unibyte strings are converted to multibyte for comparison."
694 (declare (obsolete assoc-string
"22.1"))
695 (assoc-string key alist nil
))
697 (defun member-ignore-case (elt list
)
698 "Like `member', but ignore differences in case and text representation.
699 ELT must be a string. Upper-case and lower-case letters are treated as equal.
700 Unibyte strings are converted to multibyte for comparison.
701 Non-strings in LIST are ignored."
703 (not (and (stringp (car list
))
704 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
705 (setq list
(cdr list
)))
708 (defun assq-delete-all (key alist
)
709 "Delete from ALIST all elements whose car is `eq' to KEY.
710 Return the modified alist.
711 Elements of ALIST that are not conses are ignored."
712 (while (and (consp (car alist
))
713 (eq (car (car alist
)) key
))
714 (setq alist
(cdr alist
)))
715 (let ((tail alist
) tail-cdr
)
716 (while (setq tail-cdr
(cdr tail
))
717 (if (and (consp (car tail-cdr
))
718 (eq (car (car tail-cdr
)) key
))
719 (setcdr tail
(cdr tail-cdr
))
720 (setq tail tail-cdr
))))
723 (defun rassq-delete-all (value alist
)
724 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
725 Return the modified alist.
726 Elements of ALIST that are not conses are ignored."
727 (while (and (consp (car alist
))
728 (eq (cdr (car alist
)) value
))
729 (setq alist
(cdr alist
)))
730 (let ((tail alist
) tail-cdr
)
731 (while (setq tail-cdr
(cdr tail
))
732 (if (and (consp (car tail-cdr
))
733 (eq (cdr (car tail-cdr
)) value
))
734 (setcdr tail
(cdr tail-cdr
))
735 (setq tail tail-cdr
))))
738 (defun alist-get (key alist
&optional default remove testfn
)
739 "Return the value associated with KEY in ALIST.
740 If KEY is not found in ALIST, return DEFAULT.
741 Use TESTFN to lookup in the alist if non-nil. Otherwise, use `assq'.
743 This is a generalized variable suitable for use with `setf'.
744 When using it to set a value, optional argument REMOVE non-nil
745 means to remove KEY from ALIST if the new value is `eql' to DEFAULT."
746 (ignore remove
) ;;Silence byte-compiler.
747 (let ((x (if (not testfn
)
749 (assoc key alist testfn
))))
750 (if x
(cdr x
) default
)))
752 (defun remove (elt seq
)
753 "Return a copy of SEQ with all occurrences of ELT removed.
754 SEQ must be a list, vector, or string. The comparison is done with `equal'."
756 ;; If SEQ isn't a list, there's no need to copy SEQ because
757 ;; `delete' will return a new object.
759 (delete elt
(copy-sequence seq
))))
761 (defun remq (elt list
)
762 "Return LIST with all occurrences of ELT removed.
763 The comparison is done with `eq'. Contrary to `delq', this does not use
764 side-effects, and the argument LIST is not modified."
765 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
767 (delq elt
(copy-sequence list
))
773 "Convert KEYS to the internal Emacs key representation.
774 KEYS should be a string in the format returned by commands such
775 as `C-h k' (`describe-key').
776 This is the same format used for saving keyboard macros (see
779 For an approximate inverse of this, see `key-description'."
780 ;; Don't use a defalias, since the `pure' property is only true for
781 ;; the calling convention of `kbd'.
782 (read-kbd-macro keys
))
786 "Beep to tell the user this binding is undefined."
789 (if defining-kbd-macro
790 (error "%s is undefined" (key-description (this-single-command-keys)))
791 (message "%s is undefined" (key-description (this-single-command-keys))))
792 (force-mode-line-update)
793 ;; If this is a down-mouse event, don't reset prefix-arg;
794 ;; pass it to the command run by the up event.
796 (when (memq 'down
(event-modifiers last-command-event
))
797 current-prefix-arg
)))
799 ;; Prevent the \{...} documentation construct
800 ;; from mentioning keys that run this command.
801 (put 'undefined
'suppress-keymap t
)
803 (defun suppress-keymap (map &optional nodigits
)
804 "Make MAP override all normally self-inserting keys to be undefined.
805 Normally, as an exception, digits and minus-sign are set to make prefix args,
806 but optional second arg NODIGITS non-nil treats them like other chars."
807 (define-key map
[remap self-insert-command
] 'undefined
)
810 (define-key map
"-" 'negative-argument
)
811 ;; Make plain numbers do numeric args.
814 (define-key map
(char-to-string loop
) 'digit-argument
)
815 (setq loop
(1+ loop
))))))
817 (defun make-composed-keymap (maps &optional parent
)
818 "Construct a new keymap composed of MAPS and inheriting from PARENT.
819 When looking up a key in the returned map, the key is looked in each
820 keymap of MAPS in turn until a binding is found.
821 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
822 As always with keymap inheritance, a nil binding in MAPS overrides
823 any corresponding binding in PARENT, but it does not override corresponding
824 bindings in other keymaps of MAPS.
825 MAPS can be a list of keymaps or a single keymap.
826 PARENT if non-nil should be a keymap."
828 ,@(if (keymapp maps
) (list maps
) maps
)
831 (defun define-key-after (keymap key definition
&optional after
)
832 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
833 This is like `define-key' except that the binding for KEY is placed
834 just after the binding for the event AFTER, instead of at the beginning
835 of the map. Note that AFTER must be an event type (like KEY), NOT a command
838 If AFTER is t or omitted, the new binding goes at the end of the keymap.
839 AFTER should be a single event type--a symbol or a character, not a sequence.
841 Bindings are always added before any inherited map.
843 The order of bindings in a keymap only matters when it is used as
844 a menu, so this function is not useful for non-menu keymaps."
845 (unless after
(setq after t
))
847 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
849 (if (<= (length key
) 1) (aref key
0)
850 (setq keymap
(lookup-key keymap
852 (butlast (mapcar 'identity key
)))))
853 (aref key
(1- (length key
)))))
854 (let ((tail keymap
) done inserted
)
855 (while (and (not done
) tail
)
856 ;; Delete any earlier bindings for the same key.
857 (if (eq (car-safe (car (cdr tail
))) key
)
858 (setcdr tail
(cdr (cdr tail
))))
859 ;; If we hit an included map, go down that one.
860 (if (keymapp (car tail
)) (setq tail
(car tail
)))
861 ;; When we reach AFTER's binding, insert the new binding after.
862 ;; If we reach an inherited keymap, insert just before that.
863 ;; If we reach the end of this keymap, insert at the end.
864 (if (or (and (eq (car-safe (car tail
)) after
)
866 (eq (car (cdr tail
)) 'keymap
)
869 ;; Stop the scan only if we find a parent keymap.
870 ;; Keep going past the inserted element
871 ;; so we can delete any duplications that come later.
872 (if (eq (car (cdr tail
)) 'keymap
)
874 ;; Don't insert more than once.
876 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
878 (setq tail
(cdr tail
)))))
880 (defun map-keymap-sorted (function keymap
)
881 "Implement `map-keymap' with sorting.
882 Don't call this function; it is for internal use only."
884 (map-keymap (lambda (a b
) (push (cons a b
) list
))
886 (setq list
(sort list
888 (setq a
(car a
) b
(car b
))
890 (if (integerp b
) (< a b
)
893 ;; string< also accepts symbols.
896 (funcall function
(car p
) (cdr p
)))))
898 (defun keymap--menu-item-binding (val)
899 "Return the binding part of a menu-item."
901 ((not (consp val
)) val
) ;Not a menu-item.
902 ((eq 'menu-item
(car val
))
903 (let* ((binding (nth 2 val
))
904 (plist (nthcdr 3 val
))
905 (filter (plist-get plist
:filter
)))
906 (if filter
(funcall filter binding
)
908 ((and (consp (cdr val
)) (stringp (cadr val
)))
912 (t val
))) ;Not a menu-item either.
914 (defun keymap--menu-item-with-binding (item binding
)
915 "Build a menu-item like ITEM but with its binding changed to BINDING."
917 ((not (consp item
)) binding
) ;Not a menu-item.
918 ((eq 'menu-item
(car item
))
919 (setq item
(copy-sequence item
))
920 (let ((tail (nthcdr 2 item
)))
921 (setcar tail binding
)
922 ;; Remove any potential filter.
923 (if (plist-get (cdr tail
) :filter
)
924 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
926 ((and (consp (cdr item
)) (stringp (cadr item
)))
927 (cons (car item
) (cons (cadr item
) binding
)))
928 (t (cons (car item
) binding
))))
930 (defun keymap--merge-bindings (val1 val2
)
931 "Merge bindings VAL1 and VAL2."
932 (let ((map1 (keymap--menu-item-binding val1
))
933 (map2 (keymap--menu-item-binding val2
)))
934 (if (not (and (keymapp map1
) (keymapp map2
)))
935 ;; There's nothing to merge: val1 takes precedence.
937 (let ((map (list 'keymap map1 map2
))
938 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
939 (keymap--menu-item-with-binding item map
)))))
941 (defun keymap-canonicalize (map)
942 "Return a simpler equivalent keymap.
943 This resolves inheritance and redefinitions. The returned keymap
944 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
945 and use in active keymaps and menus.
946 Subkeymaps may be modified but are not canonicalized."
947 ;; FIXME: Problem with the difference between a nil binding
948 ;; that hides a binding in an inherited map and a nil binding that's ignored
949 ;; to let some further binding visible. Currently a nil binding hides all.
950 ;; FIXME: we may want to carefully (re)order elements in case they're
954 (prompt (keymap-prompt map
)))
956 (setq map
(map-keymap ;; -internal
959 ;; Treat char-ranges specially.
960 (push (cons key item
) ranges
)
961 (push (cons key item
) bindings
)))
963 ;; Create the new map.
964 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
965 (dolist (binding ranges
)
966 ;; Treat char-ranges specially. FIXME: need to merge as well.
967 (define-key map
(vector (car binding
)) (cdr binding
)))
968 ;; Process the bindings starting from the end.
969 (dolist (binding (prog1 bindings
(setq bindings
())))
970 (let* ((key (car binding
))
971 (oldbind (assq key bindings
)))
972 (push (if (not oldbind
)
973 ;; The normal case: no duplicate bindings.
975 ;; This is the second binding for this key.
976 (setq bindings
(delq oldbind bindings
))
977 (cons key
(keymap--merge-bindings (cdr binding
)
980 (nconc map bindings
)))
982 (put 'keyboard-translate-table
'char-table-extra-slots
0)
984 (defun keyboard-translate (from to
)
985 "Translate character FROM to TO on the current terminal.
986 This function creates a `keyboard-translate-table' if necessary
987 and then modifies one entry in it."
988 (or (char-table-p keyboard-translate-table
)
989 (setq keyboard-translate-table
990 (make-char-table 'keyboard-translate-table nil
)))
991 (aset keyboard-translate-table from to
))
993 ;;;; Key binding commands.
995 (defun global-set-key (key command
)
996 "Give KEY a global binding as COMMAND.
997 COMMAND is the command definition to use; usually it is
998 a symbol naming an interactively-callable function.
999 KEY is a key sequence; noninteractively, it is a string or vector
1000 of characters or event types, and non-ASCII characters with codes
1001 above 127 (such as ISO Latin-1) can be included if you use a vector.
1003 Note that if KEY has a local binding in the current buffer,
1004 that local binding will continue to shadow any global binding
1005 that you make with this function."
1007 (let* ((menu-prompting nil
)
1008 (key (read-key-sequence "Set key globally: ")))
1010 (read-command (format "Set key %s to command: "
1011 (key-description key
))))))
1012 (or (vectorp key
) (stringp key
)
1013 (signal 'wrong-type-argument
(list 'arrayp key
)))
1014 (define-key (current-global-map) key command
))
1016 (defun local-set-key (key command
)
1017 "Give KEY a local binding as COMMAND.
1018 COMMAND is the command definition to use; usually it is
1019 a symbol naming an interactively-callable function.
1020 KEY is a key sequence; noninteractively, it is a string or vector
1021 of characters or event types, and non-ASCII characters with codes
1022 above 127 (such as ISO Latin-1) can be included if you use a vector.
1024 The binding goes in the current buffer's local map, which in most
1025 cases is shared with all other buffers in the same major mode."
1026 (interactive "KSet key locally: \nCSet key %s locally to command: ")
1027 (let ((map (current-local-map)))
1029 (use-local-map (setq map
(make-sparse-keymap))))
1030 (or (vectorp key
) (stringp key
)
1031 (signal 'wrong-type-argument
(list 'arrayp key
)))
1032 (define-key map key command
)))
1034 (defun global-unset-key (key)
1035 "Remove global binding of KEY.
1036 KEY is a string or vector representing a sequence of keystrokes."
1037 (interactive "kUnset key globally: ")
1038 (global-set-key key nil
))
1040 (defun local-unset-key (key)
1041 "Remove local binding of KEY.
1042 KEY is a string or vector representing a sequence of keystrokes."
1043 (interactive "kUnset key locally: ")
1044 (if (current-local-map)
1045 (local-set-key key nil
))
1048 ;;;; substitute-key-definition and its subroutines.
1050 (defvar key-substitution-in-progress nil
1051 "Used internally by `substitute-key-definition'.")
1053 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
1054 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
1055 In other words, OLDDEF is replaced with NEWDEF wherever it appears.
1056 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
1057 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
1059 If you don't specify OLDMAP, you can usually get the same results
1060 in a cleaner way with command remapping, like this:
1061 (define-key KEYMAP [remap OLDDEF] NEWDEF)
1062 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
1063 ;; Don't document PREFIX in the doc string because we don't want to
1064 ;; advertise it. It's meant for recursive calls only. Here's its
1067 ;; If optional argument PREFIX is specified, it should be a key
1068 ;; prefix, a string. Redefined bindings will then be bound to the
1069 ;; original key, with PREFIX added at the front.
1070 (or prefix
(setq prefix
""))
1071 (let* ((scan (or oldmap keymap
))
1072 (prefix1 (vconcat prefix
[nil]))
1073 (key-substitution-in-progress
1074 (cons scan key-substitution-in-progress)))
1075 ;; Scan OLDMAP, finding each char or event-symbol that
1076 ;; has any definition, and act on it with hack-key.
1079 (aset prefix1 (length prefix) char)
1080 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
1083 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
1084 (let (inner-def skipped menu-item)
1085 ;; Find the actual command name within the binding.
1086 (if (eq (car-safe defn) 'menu-item)
1087 (setq menu-item defn defn (nth 2 defn))
1088 ;; Skip past menu-prompt.
1089 (while (stringp (car-safe defn))
1090 (push (pop defn) skipped))
1091 ;; Skip past cached key-equivalence data for menu items.
1092 (if (consp (car-safe defn))
1093 (setq defn (cdr defn))))
1094 (if (or (eq defn olddef)
1095 ;; Compare with equal if definition is a key sequence.
1096 ;; That is useful for operating on function-key-map.
1097 (and (or (stringp defn) (vectorp defn))
1098 (equal defn olddef)))
1099 (define-key keymap prefix
1101 (let ((copy (copy-sequence menu-item)))
1102 (setcar (nthcdr 2 copy) newdef)
1104 (nconc (nreverse skipped) newdef)))
1105 ;; Look past a symbol that names a keymap.
1107 (or (indirect-function defn) defn))
1108 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
1109 ;; avoid autoloading a keymap. This is mostly done to preserve the
1110 ;; original non-autoloading behavior of pre-map-keymap times.
1111 (if (and (keymapp inner-def)
1112 ;; Avoid recursively scanning
1113 ;; where KEYMAP does not have a submap.
1114 (let ((elt (lookup-key keymap prefix)))
1115 (or (null elt) (natnump elt) (keymapp elt)))
1116 ;; Avoid recursively rescanning keymap being scanned.
1117 (not (memq inner-def key-substitution-in-progress)))
1118 ;; If this one isn't being scanned already, scan it now.
1119 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
1122 ;;;; The global keymap tree.
1124 ;; global-map, esc-map, and ctl-x-map have their values set up in
1125 ;; keymap.c; we just give them docstrings here.
1127 (defvar global-map nil
1128 "Default global keymap mapping Emacs keyboard input into commands.
1129 The value is a keymap which is usually (but not necessarily) Emacs's
1133 "Default keymap for ESC (meta) commands.
1134 The normal global definition of the character ESC indirects to this keymap.")
1136 (defvar ctl-x-map nil
1137 "Default keymap for C-x commands.
1138 The normal global definition of the character C-x indirects to this keymap.")
1140 (defvar ctl-x-4-map (make-sparse-keymap)
1141 "Keymap for subcommands of C-x 4.")
1142 (defalias 'ctl-x-4-prefix ctl-x-4-map)
1143 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
1145 (defvar ctl-x-5-map (make-sparse-keymap)
1146 "Keymap for frame commands.")
1147 (defalias 'ctl-x-5-prefix ctl-x-5-map)
1148 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
1151 ;;;; Event manipulation functions.
1153 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
1155 (defun listify-key-sequence (key)
1156 "Convert a key sequence to a list of events."
1159 (mapcar (function (lambda (c)
1161 (logxor c listify-key-sequence-1)
1166 "True if the argument is an event object."
1169 (and (symbolp obj) obj (not (keywordp obj)))
1170 (and (consp obj) (symbolp (car obj))))))
1172 (defun event-modifiers (event)
1173 "Return a list of symbols representing the modifier keys in event EVENT.
1174 The elements of the list may include `meta', `control',
1175 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
1177 EVENT may be an event or an event type. If EVENT is a symbol
1178 that has never been used in an event that has been read as input
1179 in the current Emacs session, then this function may fail to include
1180 the `click' modifier."
1183 (setq type (car type)))
1185 ;; Don't read event-symbol-elements directly since we're not
1186 ;; sure the symbol has already been parsed.
1187 (cdr (internal-event-symbol-parse-modifiers type))
1189 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
1190 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
1191 (if (not (zerop (logand type ?\M-\^@)))
1193 (if (or (not (zerop (logand type ?\C-\^@)))
1195 (push 'control list))
1196 (if (or (not (zerop (logand type ?\S-\^@)))
1197 (/= char (downcase char)))
1199 (or (zerop (logand type ?\H-\^@))
1201 (or (zerop (logand type ?\s-\^@))
1203 (or (zerop (logand type ?\A-\^@))
1207 (defun event-basic-type (event)
1208 "Return the basic type of the given event (all modifiers removed).
1209 The value is a printing character (not upper case) or a symbol.
1210 EVENT may be an event or an event type. If EVENT is a symbol
1211 that has never been used in an event that has been read as input
1212 in the current Emacs session, then this function may return nil."
1214 (setq event (car event)))
1216 (car (get event 'event-symbol-elements))
1217 (let* ((base (logand event (1- ?\A-\^@)))
1218 (uncontrolled (if (< base 32) (logior base 64) base)))
1219 ;; There are some numbers that are invalid characters and
1220 ;; cause `downcase' to get an error.
1222 (downcase uncontrolled)
1223 (error uncontrolled)))))
1225 (defsubst mouse-movement-p (object)
1226 "Return non-nil if OBJECT is a mouse movement event."
1227 (eq (car-safe object) 'mouse-movement))
1229 (defun mouse-event-p (object)
1230 "Return non-nil if OBJECT is a mouse click event."
1231 ;; is this really correct? maybe remove mouse-movement?
1232 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
1234 (defun event-start (event)
1235 "Return the starting position of EVENT.
1236 EVENT should be a mouse click, drag, or key press event. If
1237 EVENT is nil, the value of `posn-at-point' is used instead.
1239 The following accessor functions are used to access the elements
1242 `posn-window': The window the event is in.
1243 `posn-area': A symbol identifying the area the event occurred in,
1244 or nil if the event occurred in the text area.
1245 `posn-point': The buffer position of the event.
1246 `posn-x-y': The pixel-based coordinates of the event.
1247 `posn-col-row': The estimated column and row corresponding to the
1248 position of the event.
1249 `posn-actual-col-row': The actual column and row corresponding to the
1250 position of the event.
1251 `posn-string': The string object of the event, which is either
1252 nil or (STRING . POSITION)'.
1253 `posn-image': The image object of the event, if any.
1254 `posn-object': The image or string object of the event, if any.
1255 `posn-timestamp': The time the event occurred, in milliseconds.
1257 For more information, see Info node `(elisp)Click Events'."
1258 (if (consp event) (nth 1 event)
1260 (list (selected-window) (point) '(0 . 0) 0))))
1262 (defun event-end (event)
1263 "Return the ending position of EVENT.
1264 EVENT should be a click, drag, or key press event.
1266 See `event-start' for a description of the value returned."
1267 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1269 (list (selected-window) (point) '(0 . 0) 0))))
1271 (defsubst event-click-count (event)
1272 "Return the multi-click count of EVENT, a click or drag event.
1273 The return value is a positive integer."
1274 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1276 (defsubst event-line-count (event)
1277 "Return the line count of EVENT, a mousewheel event.
1278 The return value is a positive integer."
1279 (if (and (consp event) (integerp (nth 3 event))) (nth 3 event) 1))
1281 ;;;; Extracting fields of the positions in an event.
1284 "Return non-nil if OBJ appears to be a valid `posn' object specifying a window.
1285 A `posn' object is returned from functions such as `event-start'.
1286 If OBJ is a valid `posn' object, but specifies a frame rather
1287 than a window, return nil."
1288 ;; FIXME: Correct the behavior of this function so that all valid
1289 ;; `posn' objects are recognized, after updating other code that
1290 ;; depends on its present behavior.
1291 (and (windowp (car-safe obj))
1292 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1293 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1294 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1296 (defsubst posn-window (position)
1297 "Return the window in POSITION.
1298 POSITION should be a list of the form returned by the `event-start'
1299 and `event-end' functions."
1302 (defsubst posn-area (position)
1303 "Return the window area recorded in POSITION, or nil for the text area.
1304 POSITION should be a list of the form returned by the `event-start'
1305 and `event-end' functions."
1306 (let ((area (if (consp (nth 1 position))
1307 (car (nth 1 position))
1309 (and (symbolp area) area)))
1311 (defun posn-point (position)
1312 "Return the buffer location in POSITION.
1313 POSITION should be a list of the form returned by the `event-start'
1314 and `event-end' functions.
1315 Returns nil if POSITION does not correspond to any buffer location (e.g.
1316 a click on a scroll bar)."
1317 (or (nth 5 position)
1318 (let ((pt (nth 1 position)))
1320 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1321 (if (integerp pt) pt)))))
1323 (defun posn-set-point (position)
1324 "Move point to POSITION.
1325 Select the corresponding window as well."
1326 (if (not (windowp (posn-window position)))
1327 (error "Position not in text area of window"))
1328 (select-window (posn-window position))
1329 (if (numberp (posn-point position))
1330 (goto-char (posn-point position))))
1332 (defsubst posn-x-y (position)
1333 "Return the x and y coordinates in POSITION.
1334 The return value has the form (X . Y), where X and Y are given in
1335 pixels. POSITION should be a list of the form returned by
1336 `event-start' and `event-end'."
1339 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1341 (defun posn-col-row (position)
1342 "Return the nominal column and row in POSITION, measured in characters.
1343 The column and row values are approximations calculated from the x
1344 and y coordinates in POSITION and the frame's default character width
1345 and default line height, including spacing.
1346 For a scroll-bar event, the result column is 0, and the row
1347 corresponds to the vertical position of the click in the scroll bar.
1348 POSITION should be a list of the form returned by the `event-start'
1349 and `event-end' functions."
1350 (let* ((pair (posn-x-y position))
1351 (frame-or-window (posn-window position))
1352 (frame (if (framep frame-or-window)
1354 (window-frame frame-or-window)))
1355 (window (when (windowp frame-or-window) frame-or-window))
1356 (area (posn-area position)))
1358 ((null frame-or-window)
1360 ((eq area 'vertical-scroll-bar)
1361 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1362 ((eq area 'horizontal-scroll-bar)
1363 (cons (scroll-bar-scale pair (window-width window)) 0))
1365 ;; FIXME: This should take line-spacing properties on
1366 ;; newlines into account.
1367 (let* ((spacing (when (display-graphic-p frame)
1368 (or (with-current-buffer
1369 (window-buffer (frame-selected-window frame))
1371 (frame-parameter frame 'line-spacing)))))
1372 (cond ((floatp spacing)
1373 (setq spacing (truncate (* spacing
1374 (frame-char-height frame)))))
1377 (cons (/ (car pair) (frame-char-width frame))
1378 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
1380 (defun posn-actual-col-row (position)
1381 "Return the window row number in POSITION and character number in that row.
1383 Return nil if POSITION does not contain the actual position; in that case
1384 `posn-col-row' can be used to get approximate values.
1385 POSITION should be a list of the form returned by the `event-start'
1386 and `event-end' functions.
1388 This function does not account for the width on display, like the
1389 number of visual columns taken by a TAB or image. If you need
1390 the coordinates of POSITION in character units, you should use
1391 `posn-col-row', not this function."
1394 (defsubst posn-timestamp (position)
1395 "Return the timestamp of POSITION.
1396 POSITION should be a list of the form returned by the `event-start'
1397 and `event-end' functions."
1400 (defun posn-string (position)
1401 "Return the string object of POSITION.
1402 Value is a cons (STRING . STRING-POS), or nil if not a string.
1403 POSITION should be a list of the form returned by the `event-start'
1404 and `event-end' functions."
1405 (let ((x (nth 4 position)))
1406 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1407 (when (consp x) x)))
1409 (defsubst posn-image (position)
1410 "Return the image object of POSITION.
1411 Value is a list (image ...), or nil if not an image.
1412 POSITION should be a list of the form returned by the `event-start'
1413 and `event-end' functions."
1416 (defsubst posn-object (position)
1417 "Return the object (image or string) of POSITION.
1418 Value is a list (image ...) for an image object, a cons cell
1419 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1420 POSITION should be a list of the form returned by the `event-start'
1421 and `event-end' functions."
1422 (or (posn-image position) (posn-string position)))
1424 (defsubst posn-object-x-y (position)
1425 "Return the x and y coordinates relative to the object of POSITION.
1426 The return value has the form (DX . DY), where DX and DY are
1427 given in pixels. POSITION should be a list of the form returned
1428 by `event-start' and `event-end'."
1431 (defsubst posn-object-width-height (position)
1432 "Return the pixel width and height of the object of POSITION.
1433 The return value has the form (WIDTH . HEIGHT). POSITION should
1434 be a list of the form returned by `event-start' and `event-end'."
1438 ;;;; Obsolescent names for functions.
1440 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1441 (make-obsolete 'buffer-has-markers-at nil "24.3")
1444 (make-obsolete 'string-to-unibyte "use `encode-coding-string'." "26.1")
1445 (make-obsolete 'string-as-unibyte "use `encode-coding-string'." "26.1")
1446 (make-obsolete 'string-make-unibyte "use `encode-coding-string'." "26.1")
1447 (make-obsolete 'string-to-multibyte "use `decode-coding-string'." "26.1")
1448 (make-obsolete 'string-as-multibyte "use `decode-coding-string'." "26.1")
1449 (make-obsolete 'string-make-multibyte "use `decode-coding-string'." "26.1")
1452 "Return (log X 10), the log base 10 of X."
1453 (declare (obsolete log "24.4"))
1456 ;; These are used by VM and some old programs
1457 (defalias 'focus-frame 'ignore "")
1458 (make-obsolete 'focus-frame "it does nothing." "22.1")
1459 (defalias 'unfocus-frame 'ignore "")
1460 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1462 (set-advertised-calling-convention
1463 'all-completions '(string collection &optional predicate) "23.1")
1464 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1465 (set-advertised-calling-convention 'indirect-function '(object) "25.1")
1466 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1468 ;;;; Obsolescence declarations for variables, and aliases.
1470 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1471 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1472 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1473 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1474 (make-obsolete-variable 'redisplay-dont-pause nil "24.5")
1475 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1476 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1478 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1479 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1481 (make-obsolete-variable 'command-debug-status
1482 "expect it to be removed in a future version." "25.2")
1484 ;; Lisp manual only updated in 22.1.
1485 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1488 (define-obsolete-variable-alias 'x-lost-selection-hooks
1489 'x-lost-selection-functions "22.1")
1490 (define-obsolete-variable-alias 'x-sent-selection-hooks
1491 'x-sent-selection-functions "22.1")
1493 ;; This was introduced in 21.4 for pre-unicode unification. That
1494 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1495 ;; Other uses are possible, so this variable is not _really_ obsolete,
1496 ;; but Stefan insists to mark it so.
1497 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1499 (make-obsolete-variable 'x-gtk-use-window-move nil "26.1")
1501 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1503 ;;;; Alternate names for functions - these are not being phased out.
1505 (defalias 'send-string 'process-send-string)
1506 (defalias 'send-region 'process-send-region)
1507 (defalias 'string= 'string-equal)
1508 (defalias 'string< 'string-lessp)
1509 (defalias 'string> 'string-greaterp)
1510 (defalias 'move-marker 'set-marker)
1511 (defalias 'rplaca 'setcar)
1512 (defalias 'rplacd 'setcdr)
1513 (defalias 'beep 'ding) ;preserve lingual purity
1514 (defalias 'indent-to-column 'indent-to)
1515 (defalias 'backward-delete-char 'delete-backward-char)
1516 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1517 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1518 (defalias 'int-to-string 'number-to-string)
1519 (defalias 'store-match-data 'set-match-data)
1520 (defalias 'chmod 'set-file-modes)
1521 (defalias 'mkdir 'make-directory)
1522 ;; These are the XEmacs names:
1523 (defalias 'point-at-eol 'line-end-position)
1524 (defalias 'point-at-bol 'line-beginning-position)
1526 (defalias 'user-original-login-name 'user-login-name)
1529 ;;;; Hook manipulation functions.
1531 (defun add-hook (hook function &optional append local)
1532 "Add to the value of HOOK the function FUNCTION.
1533 FUNCTION is not added if already present.
1534 FUNCTION is added (if necessary) at the beginning of the hook list
1535 unless the optional argument APPEND is non-nil, in which case
1536 FUNCTION is added at the end.
1538 The optional fourth argument, LOCAL, if non-nil, says to modify
1539 the hook's buffer-local value rather than its global value.
1540 This makes the hook buffer-local, and it makes t a member of the
1541 buffer-local value. That acts as a flag to run the hook
1542 functions of the global value as well as in the local value.
1544 HOOK should be a symbol, and FUNCTION may be any valid function. If
1545 HOOK is void, it is first set to nil. If HOOK's value is a single
1546 function, it is changed to a list of functions."
1547 (or (boundp hook) (set hook nil))
1548 (or (default-boundp hook) (set-default hook nil))
1549 (if local (unless (local-variable-if-set-p hook)
1550 (set (make-local-variable hook) (list t)))
1551 ;; Detect the case where make-local-variable was used on a hook
1552 ;; and do what we used to do.
1553 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1555 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1556 ;; If the hook value is a single function, turn it into a list.
1557 (when (or (not (listp hook-value)) (functionp hook-value))
1558 (setq hook-value (list hook-value)))
1559 ;; Do the actual addition if necessary
1560 (unless (member function hook-value)
1561 (when (stringp function)
1562 (setq function (purecopy function)))
1565 (append hook-value (list function))
1566 (cons function hook-value))))
1567 ;; Set the actual variable
1570 ;; If HOOK isn't a permanent local,
1571 ;; but FUNCTION wants to survive a change of modes,
1572 ;; mark HOOK as partially permanent.
1573 (and (symbolp function)
1574 (get function 'permanent-local-hook)
1575 (not (get hook 'permanent-local))
1576 (put hook 'permanent-local 'permanent-local-hook))
1577 (set hook hook-value))
1578 (set-default hook hook-value))))
1580 (defun remove-hook (hook function &optional local)
1581 "Remove from the value of HOOK the function FUNCTION.
1582 HOOK should be a symbol, and FUNCTION may be any valid function. If
1583 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1584 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1586 The optional third argument, LOCAL, if non-nil, says to modify
1587 the hook's buffer-local value rather than its default value."
1588 (or (boundp hook) (set hook nil))
1589 (or (default-boundp hook) (set-default hook nil))
1590 ;; Do nothing if LOCAL is t but this hook has no local binding.
1591 (unless (and local (not (local-variable-p hook)))
1592 ;; Detect the case where make-local-variable was used on a hook
1593 ;; and do what we used to do.
1594 (when (and (local-variable-p hook)
1595 (not (and (consp (symbol-value hook))
1596 (memq t (symbol-value hook)))))
1598 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1599 ;; Remove the function, for both the list and the non-list cases.
1600 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1601 (if (equal hook-value function) (setq hook-value nil))
1602 (setq hook-value (delete function (copy-sequence hook-value))))
1603 ;; If the function is on the global hook, we need to shadow it locally
1604 ;;(when (and local (member function (default-value hook))
1605 ;; (not (member (cons 'not function) hook-value)))
1606 ;; (push (cons 'not function) hook-value))
1607 ;; Set the actual variable
1609 (set-default hook hook-value)
1610 (if (equal hook-value '(t))
1611 (kill-local-variable hook)
1612 (set hook hook-value))))))
1614 (defmacro letrec (binders &rest body)
1615 "Bind variables according to BINDERS then eval BODY.
1616 The value of the last form in BODY is returned.
1617 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1618 SYMBOL to the value of VALUEFORM.
1619 All symbols are bound before the VALUEFORMs are evalled."
1620 ;; Only useful in lexical-binding mode.
1621 ;; As a special-form, we could implement it more efficiently (and cleanly,
1622 ;; making the vars actually unbound during evaluation of the binders).
1623 (declare (debug let) (indent 1))
1624 `(let ,(mapcar #'car binders)
1625 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1628 (defmacro with-wrapper-hook (hook args &rest body)
1629 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1630 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1631 around the preceding ones, like a set of nested `around' advices.
1633 Each hook function should accept an argument list consisting of a
1634 function FUN, followed by the additional arguments in ARGS.
1636 The first hook function in HOOK is passed a FUN that, if it is called
1637 with arguments ARGS, performs BODY (i.e., the default operation).
1638 The FUN passed to each successive hook function is defined based
1639 on the preceding hook functions; if called with arguments ARGS,
1640 it does what the `with-wrapper-hook' call would do if the
1641 preceding hook functions were the only ones present in HOOK.
1643 Each hook function may call its FUN argument as many times as it wishes,
1644 including never. In that case, such a hook function acts to replace
1645 the default definition altogether, and any preceding hook functions.
1646 Of course, a subsequent hook function may do the same thing.
1648 Each hook function definition is used to construct the FUN passed
1649 to the next hook function, if any. The last (or \"outermost\")
1650 FUN is then called once."
1651 (declare (indent 2) (debug (form sexp body))
1652 (obsolete "use a <foo>-function variable modified by `add-function'."
1654 `(subr--with-wrapper-hook-no-warnings ,hook ,args ,@body))
1656 (defmacro subr--with-wrapper-hook-no-warnings (hook args &rest body)
1657 "Like (with-wrapper-hook HOOK ARGS BODY), but without warnings."
1658 ;; We need those two gensyms because CL's lexical scoping is not available
1659 ;; for function arguments :-(
1660 (let ((funs (make-symbol "funs"))
1661 (global (make-symbol "global"))
1662 (argssym (make-symbol "args"))
1663 (runrestofhook (make-symbol "runrestofhook")))
1664 ;; Since the hook is a wrapper, the loop has to be done via
1665 ;; recursion: a given hook function will call its parameter in order to
1666 ;; continue looping.
1667 `(letrec ((,runrestofhook
1668 (lambda (,funs ,global ,argssym)
1669 ;; `funs' holds the functions left on the hook and `global'
1670 ;; holds the functions left on the global part of the hook
1671 ;; (in case the hook is local).
1673 (if (eq t (car ,funs))
1674 (funcall ,runrestofhook
1675 (append ,global (cdr ,funs)) nil ,argssym)
1678 (lambda (,funs ,global &rest ,argssym)
1679 (funcall ,runrestofhook ,funs ,global ,argssym))
1680 (cdr ,funs) ,global)
1682 ;; Once there are no more functions on the hook, run
1683 ;; the original body.
1684 (apply (lambda ,args ,@body) ,argssym)))))
1685 (funcall ,runrestofhook ,hook
1686 ;; The global part of the hook, if any.
1688 `(if (local-variable-p ',hook)
1689 (default-value ',hook)))
1692 (defun add-to-list (list-var element &optional append compare-fn)
1693 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1694 The test for presence of ELEMENT is done with `equal', or with
1695 COMPARE-FN if that's non-nil.
1696 If ELEMENT is added, it is added at the beginning of the list,
1697 unless the optional argument APPEND is non-nil, in which case
1698 ELEMENT is added at the end.
1700 The return value is the new value of LIST-VAR.
1702 This is handy to add some elements to configuration variables,
1703 but please do not abuse it in Elisp code, where you are usually
1704 better off using `push' or `cl-pushnew'.
1706 If you want to use `add-to-list' on a variable that is not
1707 defined until a certain package is loaded, you should put the
1708 call to `add-to-list' into a hook function that will be run only
1709 after loading the package. `eval-after-load' provides one way to
1710 do this. In some cases other hooks, such as major mode hooks,
1715 ;; FIXME: Something like this could be used for `set' as well.
1716 (if (or (not (eq 'quote (car-safe list-var)))
1717 (special-variable-p (cadr list-var))
1718 (not (macroexp-const-p append)))
1720 (let* ((sym (cadr list-var))
1721 (append (eval append))
1722 (msg (format-message
1723 "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1725 ;; Big ugly hack so we only output a warning during
1726 ;; byte-compilation, and so we can use
1727 ;; byte-compile-not-lexical-var-p to silence the warning
1728 ;; when a defvar has been seen but not yet executed.
1730 ;; FIXME: We should also emit a warning for let-bound
1731 ;; variables with dynamic binding.
1732 (when (assq sym byte-compile--lexical-environment)
1733 (byte-compile-report-error msg :fill))))
1735 (macroexp-let2 macroexp-copyable-p x element
1736 `(if ,(if compare-fn
1739 `(cl-member ,x ,sym :test ,compare-fn))
1740 ;; For bootstrapping reasons, don't rely on
1741 ;; cl--compiler-macro-member for the base case.
1745 `(setq ,sym (append ,sym (list ,x)))
1746 `(push ,x ,sym))))))
1747 (if (not (macroexp--compiling-p))
1750 (macroexp--funcall-if-compiled ',warnfun)
1754 (member element (symbol-value list-var)))
1755 ((eq compare-fn 'eq)
1756 (memq element (symbol-value list-var)))
1757 ((eq compare-fn 'eql)
1758 (memql element (symbol-value list-var)))
1760 (let ((lst (symbol-value list-var)))
1762 (not (funcall compare-fn element (car lst))))
1763 (setq lst (cdr lst)))
1765 (symbol-value list-var)
1768 (append (symbol-value list-var) (list element))
1769 (cons element (symbol-value list-var))))))
1772 (defun add-to-ordered-list (list-var element &optional order)
1773 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1774 The test for presence of ELEMENT is done with `eq'.
1776 The resulting list is reordered so that the elements are in the
1777 order given by each element's numeric list order. Elements
1778 without a numeric list order are placed at the end of the list.
1780 If the third optional argument ORDER is a number (integer or
1781 float), set the element's list order to the given value. If
1782 ORDER is nil or omitted, do not change the numeric order of
1783 ELEMENT. If ORDER has any other value, remove the numeric order
1784 of ELEMENT if it has one.
1786 The list order for each element is stored in LIST-VAR's
1787 `list-order' property.
1789 The return value is the new value of LIST-VAR."
1790 (let ((ordering (get list-var 'list-order)))
1792 (put list-var 'list-order
1793 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1795 (puthash element (and (numberp order) order) ordering))
1796 (unless (memq element (symbol-value list-var))
1797 (set list-var (cons element (symbol-value list-var))))
1798 (set list-var (sort (symbol-value list-var)
1800 (let ((oa (gethash a ordering))
1801 (ob (gethash b ordering)))
1806 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1807 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1808 Return the new history list.
1809 If MAXELT is non-nil, it specifies the maximum length of the history.
1810 Otherwise, the maximum history length is the value of the `history-length'
1811 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1812 variable. The possible values of maximum length have the same meaning as
1813 the values of `history-length'.
1814 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1815 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1816 if it is empty or a duplicate."
1818 (setq maxelt (or (get history-var 'history-length)
1820 (let ((history (symbol-value history-var))
1822 (when (and (listp history)
1824 (not (stringp newelt))
1825 (> (length newelt) 0))
1827 (not (equal (car history) newelt))))
1828 (if history-delete-duplicates
1829 (setq history (delete newelt history)))
1830 (setq history (cons newelt history))
1831 (when (integerp maxelt)
1834 (setq tail (nthcdr (1- maxelt) history))
1836 (setcdr tail nil)))))
1837 (set history-var history)))
1842 (defvar delay-mode-hooks nil
1843 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1844 (defvar delayed-mode-hooks nil
1845 "List of delayed mode hooks waiting to be run.")
1846 (make-variable-buffer-local 'delayed-mode-hooks)
1847 (put 'delay-mode-hooks 'permanent-local t)
1849 (defvar delayed-after-hook-functions nil
1850 "List of delayed :after-hook forms waiting to be run.
1851 These forms come from `define-derived-mode'.")
1852 (make-variable-buffer-local 'delayed-after-hook-functions)
1854 (defvar change-major-mode-after-body-hook nil
1855 "Normal hook run in major mode functions, before the mode hooks.")
1857 (defvar after-change-major-mode-hook nil
1858 "Normal hook run at the very end of major mode functions.")
1860 (defun run-mode-hooks (&rest hooks)
1861 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1862 Call `hack-local-variables' to set up file local and directory local
1865 If the variable `delay-mode-hooks' is non-nil, does not do anything,
1866 just adds the HOOKS to the list `delayed-mode-hooks'.
1867 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1868 `delayed-mode-hooks' (in reverse order), HOOKS, then runs
1869 `hack-local-variables', runs the hook `after-change-major-mode-hook', and
1870 finally evaluates the functions in `delayed-after-hook-functions' (see
1871 `define-derived-mode').
1873 Major mode functions should use this instead of `run-hooks' when
1874 running their FOO-mode-hook."
1875 (if delay-mode-hooks
1877 (dolist (hook hooks)
1878 (push hook delayed-mode-hooks))
1879 ;; Normal case, just run the hook as before plus any delayed hooks.
1880 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1881 (setq delayed-mode-hooks nil)
1882 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1883 (if (buffer-file-name)
1884 (with-demoted-errors "File local-variables error: %s"
1885 (hack-local-variables 'no-mode)))
1886 (run-hooks 'after-change-major-mode-hook)
1887 (dolist (fun (nreverse delayed-after-hook-functions))
1889 (setq delayed-after-hook-functions nil)))
1891 (defmacro delay-mode-hooks (&rest body)
1892 "Execute BODY, but delay any `run-mode-hooks'.
1893 These hooks will be executed by the first following call to
1894 `run-mode-hooks' that occurs outside any `delay-mode-hooks' form.
1895 Only affects hooks run in the current buffer."
1896 (declare (debug t) (indent 0))
1898 (make-local-variable 'delay-mode-hooks)
1899 (let ((delay-mode-hooks t))
1902 ;; PUBLIC: find if the current mode derives from another.
1904 (defun provided-mode-derived-p (mode &rest modes)
1905 "Non-nil if MODE is derived from one of MODES.
1906 Uses the `derived-mode-parent' property of the symbol to trace backwards.
1907 If you just want to check `major-mode', use `derived-mode-p'."
1908 (while (and (not (memq mode modes))
1909 (setq mode (get mode 'derived-mode-parent))))
1912 (defun derived-mode-p (&rest modes)
1913 "Non-nil if the current major mode is derived from one of MODES.
1914 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1915 (apply #'provided-mode-derived-p major-mode modes))
1919 ;; If a minor mode is not defined with define-minor-mode,
1920 ;; add it here explicitly.
1921 ;; isearch-mode is deliberately excluded, since you should
1922 ;; not call it yourself.
1923 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1924 overwrite-mode view-mode
1926 "List of all minor mode functions.")
1928 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1929 "Register a new minor mode.
1931 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1933 TOGGLE is a symbol which is the name of a buffer-local variable that
1934 is toggled on or off to say whether the minor mode is active or not.
1936 NAME specifies what will appear in the mode line when the minor mode
1937 is active. NAME should be either a string starting with a space, or a
1938 symbol whose value is such a string.
1940 Optional KEYMAP is the keymap for the minor mode that will be added
1941 to `minor-mode-map-alist'.
1943 Optional AFTER specifies that TOGGLE should be added after AFTER
1944 in `minor-mode-alist'.
1946 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1947 It defaults to (and should by convention be) TOGGLE.
1949 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1950 included in the mode-line minor mode menu.
1951 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1952 (unless (memq toggle minor-mode-list)
1953 (push toggle minor-mode-list))
1955 (unless toggle-fun (setq toggle-fun toggle))
1956 (unless (eq toggle-fun toggle)
1957 (put toggle :minor-mode-function toggle-fun))
1958 ;; Add the name to the minor-mode-alist.
1960 (let ((existing (assq toggle minor-mode-alist)))
1962 (setcdr existing (list name))
1963 (let ((tail minor-mode-alist) found)
1964 (while (and tail (not found))
1965 (if (eq after (caar tail))
1967 (setq tail (cdr tail))))
1969 (let ((rest (cdr found)))
1971 (nconc found (list (list toggle name)) rest))
1972 (push (list toggle name) minor-mode-alist))))))
1973 ;; Add the toggle to the minor-modes menu if requested.
1974 (when (get toggle :included)
1975 (define-key mode-line-mode-menu
1979 (or (get toggle :menu-tag)
1980 (if (stringp name) name (symbol-name toggle)))
1981 (let ((mode-name (if (symbolp name) (symbol-value name))))
1982 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1983 (concat " (" (match-string 0 mode-name) ")"))))
1985 :button (cons :toggle toggle))))
1987 ;; Add the map to the minor-mode-map-alist.
1989 (let ((existing (assq toggle minor-mode-map-alist)))
1991 (setcdr existing keymap)
1992 (let ((tail minor-mode-map-alist) found)
1993 (while (and tail (not found))
1994 (if (eq after (caar tail))
1996 (setq tail (cdr tail))))
1998 (let ((rest (cdr found)))
2000 (nconc found (list (cons toggle keymap)) rest))
2001 (push (cons toggle keymap) minor-mode-map-alist)))))))
2005 (defsubst autoloadp (object)
2006 "Non-nil if OBJECT is an autoload."
2007 (eq 'autoload (car-safe object)))
2009 ;; (defun autoload-type (object)
2010 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
2011 ;; OBJECT should be an autoload object."
2012 ;; (when (autoloadp object)
2013 ;; (let ((type (nth 3 object)))
2014 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
2015 ;; ((eq 'keymap t) 'macro)
2018 ;; (defalias 'autoload-file #'cadr
2019 ;; "Return the name of the file from which AUTOLOAD will be loaded.
2020 ;; \n\(fn AUTOLOAD)")
2022 (defun define-symbol-prop (symbol prop val)
2023 "Define the property PROP of SYMBOL to be VAL.
2024 This is to `put' what `defalias' is to `fset'."
2025 ;; Can't use `cl-pushnew' here (nor `push' on (cdr foo)).
2026 ;; (cl-pushnew symbol (alist-get prop
2027 ;; (alist-get 'define-symbol-props
2028 ;; current-load-list)))
2029 (let ((sps (assq 'define-symbol-props current-load-list)))
2031 (setq sps (list 'define-symbol-props))
2032 (push sps current-load-list))
2033 (let ((ps (assq prop sps)))
2035 (setq ps (list prop))
2036 (setcdr sps (cons ps (cdr sps))))
2037 (unless (member symbol (cdr ps))
2038 (setcdr ps (cons symbol (cdr ps))))))
2039 (put symbol prop val))
2041 (defun symbol-file (symbol &optional type)
2042 "Return the name of the file that defined SYMBOL.
2043 The value is normally an absolute file name. It can also be nil,
2044 if the definition is not associated with any file. If SYMBOL
2045 specifies an autoloaded function, the value can be a relative
2046 file name without extension.
2048 If TYPE is nil, then any kind of definition is acceptable. If
2049 TYPE is `defun', `defvar', or `defface', that specifies function
2050 definition, variable definition, or face definition only.
2051 Otherwise TYPE is assumed to be a symbol property."
2052 (if (and (or (null type) (eq type 'defun))
2054 (autoloadp (symbol-function symbol)))
2055 (nth 1 (symbol-function symbol))
2057 (pcase-dolist (`(,file . ,elems) load-history)
2059 (if (eq type 'defvar)
2060 ;; Variables are present just as their names.
2061 (member symbol elems)
2062 ;; Many other types are represented as (TYPE . NAME).
2063 (or (member (cons type symbol) elems)
2064 (memq symbol (alist-get type
2065 (alist-get 'define-symbol-props
2067 ;; We accept all types, so look for variable def
2068 ;; and then for any other kind.
2069 (or (member symbol elems)
2070 (let ((match (rassq symbol elems)))
2072 (not (eq 'require (car match)))))))
2073 (throw 'found file))))))
2075 (defun locate-library (library &optional nosuffix path interactive-call)
2076 "Show the precise file name of Emacs library LIBRARY.
2077 LIBRARY should be a relative file name of the library, a string.
2078 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
2079 nil (which is the default, see below).
2080 This command searches the directories in `load-path' like `\\[load-library]'
2081 to find the file that `\\[load-library] RET LIBRARY RET' would load.
2082 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
2083 to the specified name LIBRARY.
2085 If the optional third arg PATH is specified, that list of directories
2086 is used instead of `load-path'.
2088 When called from a program, the file name is normally returned as a
2089 string. When run interactively, the argument INTERACTIVE-CALL is t,
2090 and the file name is displayed in the echo area."
2091 (interactive (list (completing-read "Locate library: "
2093 'locate-file-completion-table
2094 load-path (get-load-suffixes)))
2097 (let ((file (locate-file library
2099 (append (unless nosuffix (get-load-suffixes))
2100 load-file-rep-suffixes))))
2101 (if interactive-call
2103 (message "Library is file %s" (abbreviate-file-name file))
2104 (message "No library %s in search path" library)))
2110 (defun start-process (name buffer program &rest program-args)
2111 "Start a program in a subprocess. Return the process object for it.
2112 NAME is name for process. It is modified if necessary to make it unique.
2113 BUFFER is the buffer (or buffer name) to associate with the process.
2115 Process output (both standard output and standard error streams)
2116 goes at end of BUFFER, unless you specify a filter function to
2117 handle the output. BUFFER may also be nil, meaning that this
2118 process is not associated with any buffer.
2120 PROGRAM is the program file name. It is searched for in `exec-path'
2121 \(which see). If nil, just associate a pty with the buffer. Remaining
2122 arguments PROGRAM-ARGS are strings to give program as arguments.
2124 If you want to separate standard output from standard error, use
2125 `make-process' or invoke the command through a shell and redirect
2126 one of them using the shell syntax.
2128 The process runs in `default-directory' if that is local (as
2129 determined by `unhandled-file-name-directory'), or \"~\"
2130 otherwise. If you want to run a process in a remote directory
2131 use `start-file-process'."
2132 (unless (fboundp 'make-process)
2133 (error "Emacs was compiled without subprocess support"))
2134 (apply #'make-process
2135 (append (list :name name :buffer buffer)
2137 (list :command (cons program program-args))))))
2139 (defun process-lines (program &rest args)
2140 "Execute PROGRAM with ARGS, returning its output as a list of lines.
2141 Signal an error if the program returns with a non-zero exit status."
2143 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
2144 (unless (eq status 0)
2145 (error "%s exited with status %s" program status))
2146 (goto-char (point-min))
2149 (setq lines (cons (buffer-substring-no-properties
2150 (line-beginning-position)
2151 (line-end-position))
2154 (nreverse lines)))))
2156 (defun process-live-p (process)
2157 "Returns non-nil if PROCESS is alive.
2158 A process is considered alive if its status is `run', `open',
2159 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
2161 (and (processp process)
2162 (memq (process-status process)
2163 '(run open listen connect stop))))
2167 (defun process-kill-without-query (process &optional _flag)
2168 "Say no query needed if PROCESS is running when Emacs is exited.
2169 Optional second argument if non-nil says to require a query.
2170 Value is t if a query was formerly required."
2172 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
2174 (let ((old (process-query-on-exit-flag process)))
2175 (set-process-query-on-exit-flag process nil)
2178 (defun process-kill-buffer-query-function ()
2179 "Ask before killing a buffer that has a running process."
2180 (let ((process (get-buffer-process (current-buffer))))
2182 (not (memq (process-status process) '(run stop open listen)))
2183 (not (process-query-on-exit-flag process))
2185 (format "Buffer %S has a running process; kill it? "
2186 (buffer-name (current-buffer)))))))
2188 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
2190 ;; process plist management
2192 (defun process-get (process propname)
2193 "Return the value of PROCESS' PROPNAME property.
2194 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
2195 (plist-get (process-plist process) propname))
2197 (defun process-put (process propname value)
2198 "Change PROCESS' PROPNAME property to VALUE.
2199 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2200 (set-process-plist process
2201 (plist-put (process-plist process) propname value)))
2204 ;;;; Input and display facilities.
2206 (defconst read-key-empty-map (make-sparse-keymap))
2208 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2210 (defun read-key (&optional prompt)
2211 "Read a key from the keyboard.
2212 Contrary to `read-event' this will not return a raw event but instead will
2213 obey the input decoding and translations usually done by `read-key-sequence'.
2214 So escape sequences and keyboard encoding are taken into account.
2215 When there's an ambiguity because the key looks like the prefix of
2216 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2217 ;; This overriding-terminal-local-map binding also happens to
2218 ;; disable quail's input methods, so although read-key-sequence
2219 ;; always inherits the input method, in practice read-key does not
2220 ;; inherit the input method (at least not if it's based on quail).
2221 (let ((overriding-terminal-local-map nil)
2222 (overriding-local-map read-key-empty-map)
2224 (old-global-map (current-global-map))
2225 (timer (run-with-idle-timer
2226 ;; Wait long enough that Emacs has the time to receive and
2227 ;; process all the raw events associated with the single-key.
2228 ;; But don't wait too long, or the user may find the delay
2229 ;; annoying (or keep hitting more keys which may then get
2230 ;; lost or misinterpreted).
2231 ;; This is only relevant for keys which Emacs perceives as
2232 ;; "prefixes", such as C-x (because of the C-x 8 map in
2233 ;; key-translate-table and the C-x @ map in function-key-map)
2234 ;; or ESC (because of terminal escape sequences in
2235 ;; input-decode-map).
2238 (let ((keys (this-command-keys-vector)))
2239 (unless (zerop (length keys))
2240 ;; `keys' is non-empty, so the user has hit at least
2241 ;; one key; there's no point waiting any longer, even
2242 ;; though read-key-sequence thinks we should wait
2243 ;; for more input to decide how to interpret the
2245 (throw 'read-key keys)))))))
2249 (let ((map (make-sparse-keymap)))
2250 ;; Don't hide the menu-bar and tool-bar entries.
2251 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2252 (define-key map [tool-bar]
2253 ;; This hack avoids evaluating the :filter (Bug#9922).
2254 (or (cdr (assq 'tool-bar global-map))
2255 (lookup-key global-map [tool-bar])))
2258 (catch 'read-key (read-key-sequence-vector prompt nil t)))
2259 (key (aref keys 0)))
2260 (if (and (> (length keys) 1)
2261 (memq key '(mode-line header-line
2262 left-fringe right-fringe)))
2265 (cancel-timer timer)
2266 ;; For some reason, `read-key(-sequence)' leaves the prompt in the echo
2267 ;; area, whereas `read-event' seems to empty it just before returning
2268 ;; (bug#22714). So, let's mimic the behavior of `read-event'.
2270 (use-global-map old-global-map))))
2272 (defvar read-passwd-map
2273 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2274 ;; minibuffer-local-map along the way!
2275 (let ((map (make-sparse-keymap)))
2276 (set-keymap-parent map minibuffer-local-map)
2277 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2279 "Keymap used while reading passwords.")
2281 (defun read-passwd (prompt &optional confirm default)
2282 "Read a password, prompting with PROMPT, and return it.
2283 If optional CONFIRM is non-nil, read the password twice to make sure.
2284 Optional DEFAULT is a default password to use instead of empty input.
2286 This function echoes `.' for each character that the user types.
2287 You could let-bind `read-hide-char' to another hiding character, though.
2289 Once the caller uses the password, it can erase the password
2290 by doing (clear-string STRING)."
2293 (while (not success)
2294 (let ((first (read-passwd prompt nil default))
2295 (second (read-passwd "Confirm password: " nil default)))
2296 (if (equal first second)
2298 (and (arrayp second) (not (eq first second)) (clear-string second))
2299 (setq success first))
2300 (and (arrayp first) (clear-string first))
2301 (and (arrayp second) (clear-string second))
2302 (message "Password not repeated accurately; please start over")
2305 (let ((hide-chars-fun
2306 (lambda (beg end _len)
2307 (clear-this-command-keys)
2308 (setq beg (min end (max (minibuffer-prompt-end)
2310 (dotimes (i (- end beg))
2311 (put-text-property (+ i beg) (+ 1 i beg)
2312 'display (string (or read-hide-char ?.))))))
2314 (minibuffer-with-setup-hook
2316 (setq minibuf (current-buffer))
2317 ;; Turn off electricity.
2318 (setq-local post-self-insert-hook nil)
2319 (setq-local buffer-undo-list t)
2320 (setq-local select-active-regions nil)
2321 (use-local-map read-passwd-map)
2322 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2323 (setq-local show-paren-mode nil) ;bug#16091.
2324 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2326 (let ((enable-recursive-minibuffers t)
2327 (read-hide-char (or read-hide-char ?.)))
2328 (read-string prompt nil t default)) ; t = "no history"
2329 (when (buffer-live-p minibuf)
2330 (with-current-buffer minibuf
2331 ;; Not sure why but it seems that there might be cases where the
2332 ;; minibuffer is not always properly reset later on, so undo
2333 ;; whatever we've done here (bug#11392).
2334 (remove-hook 'after-change-functions hide-chars-fun 'local)
2335 (kill-local-variable 'post-self-insert-hook)
2336 ;; And of course, don't keep the sensitive data around.
2337 (erase-buffer))))))))
2339 (defun read-number (prompt &optional default)
2340 "Read a numeric value in the minibuffer, prompting with PROMPT.
2341 DEFAULT specifies a default value to return if the user just types RET.
2342 The value of DEFAULT is inserted into PROMPT.
2343 This function is used by the `interactive' code letter `n'."
2345 (default1 (if (consp default) (car default) default)))
2348 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2349 (replace-match (format " (default %s)" default1) t t prompt 1)
2350 (replace-regexp-in-string "[ \t]*\\'"
2351 (format " (default %s) " default1)
2355 (let ((str (read-from-minibuffer
2356 prompt nil nil nil nil
2359 (mapcar 'number-to-string (delq nil default))
2360 (number-to-string default))))))
2363 ((zerop (length str)) default1)
2364 ((stringp str) (read str))))
2367 (message "Please enter a number.")
2372 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2373 "Read and return one of CHARS, prompting for PROMPT.
2374 Any input that is not one of CHARS is ignored.
2376 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2377 keyboard-quit events while waiting for a valid input."
2378 (unless (consp chars)
2379 (error "Called `read-char-choice' without valid char choices"))
2380 (let (char done show-help (helpbuf " *Char Help*"))
2381 (let ((cursor-in-echo-area t)
2382 (executing-kbd-macro executing-kbd-macro)
2384 (save-window-excursion ; in case we call help-form-show
2386 (unless (get-text-property 0 'face prompt)
2387 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2388 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2390 (and show-help (buffer-live-p (get-buffer helpbuf))
2391 (kill-buffer helpbuf))
2393 ((not (numberp char)))
2394 ;; If caller has set help-form, that's enough.
2395 ;; They don't explicitly have to add help-char to chars.
2402 ((and executing-kbd-macro (= char -1))
2403 ;; read-event returns -1 if we are in a kbd macro and
2404 ;; there are no more events in the macro. Attempt to
2405 ;; get an event interactively.
2406 (setq executing-kbd-macro nil))
2407 ((not inhibit-keyboard-quit)
2409 ((and (null esc-flag) (eq char ?\e))
2411 ((memq char '(?\C-g ?\e))
2412 (keyboard-quit))))))))
2413 ;; Display the question with the answer. But without cursor-in-echo-area.
2414 (message "%s%s" prompt (char-to-string char))
2417 (defun sit-for (seconds &optional nodisp obsolete)
2418 "Redisplay, then wait for SECONDS seconds. Stop when input is available.
2419 SECONDS may be a floating-point value.
2420 \(On operating systems that do not support waiting for fractions of a
2421 second, floating-point values are rounded down to the nearest integer.)
2423 If optional arg NODISP is t, don't redisplay, just wait for input.
2424 Redisplay does not happen if input is available before it starts.
2426 Value is t if waited the full time with no input arriving, and nil otherwise.
2428 An obsolete, but still supported form is
2429 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2430 where the optional arg MILLISECONDS specifies an additional wait period,
2431 in milliseconds; this was useful when Emacs was built without
2432 floating point support."
2433 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2434 ;; This used to be implemented in C until the following discussion:
2435 ;; https://lists.gnu.org/r/emacs-devel/2006-07/msg00401.html
2436 ;; Then it was moved here using an implementation based on an idle timer,
2437 ;; which was then replaced by the use of read-event.
2438 (if (numberp nodisp)
2439 (setq seconds (+ seconds (* 1e-3 nodisp))
2441 (if obsolete (setq nodisp obsolete)))
2446 ((input-pending-p t)
2449 ;; We are going to call read-event below, which will record
2450 ;; the next key as part of the macro, even if that key
2451 ;; invokes kmacro-end-macro, so if we are recording a macro,
2452 ;; the macro will recursively call itself. In addition, when
2453 ;; that key is removed from unread-command-events, it will be
2454 ;; recorded the second time, so the macro will have each key
2455 ;; doubled. This used to happen if a macro was defined with
2456 ;; Flyspell mode active (because Flyspell calls sit-for in its
2457 ;; post-command-hook, see bug #21329.) To avoid all that, we
2458 ;; simply disable the wait when we are recording a macro.
2460 (or nodisp (redisplay)))
2462 (or nodisp (redisplay))
2463 ;; FIXME: we should not read-event here at all, because it's much too
2464 ;; difficult to reliably "undo" a read-event by pushing it onto
2465 ;; unread-command-events.
2466 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2467 ;; decoding (hence non-nil as second arg under POSIX ttys).
2468 ;; For bug#15614, we need read-event not to inherit-input-method.
2469 ;; So we temporarily suspend input-method-function.
2470 (let ((read (let ((input-method-function nil))
2471 (read-event nil t seconds))))
2474 ;; https://lists.gnu.org/r/emacs-devel/2006-10/msg00394.html
2475 ;; We want `read' appear in the next command's this-command-event
2476 ;; but not in the current one.
2477 ;; By pushing (cons t read), we indicate that `read' has not
2478 ;; yet been recorded in this-command-keys, so it will be recorded
2479 ;; next time it's read.
2480 ;; And indeed the `seconds' argument to read-event correctly
2481 ;; prevented recording this event in the current command's
2482 ;; this-command-keys.
2483 (push (cons t read) unread-command-events)
2486 ;; Behind display-popup-menus-p test.
2487 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2489 (defun y-or-n-p (prompt)
2490 "Ask user a \"y or n\" question.
2491 Return t if answer is \"y\" and nil if it is \"n\".
2492 PROMPT is the string to display to ask the question. It should
2493 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2495 No confirmation of the answer is requested; a single character is
2496 enough. SPC also means yes, and DEL means no.
2498 To be precise, this function translates user input into responses
2499 by consulting the bindings in `query-replace-map'; see the
2500 documentation of that variable for more information. In this
2501 case, the useful bindings are `act', `skip', `recenter',
2502 `scroll-up', `scroll-down', and `quit'.
2503 An `act' response means yes, and a `skip' response means no.
2504 A `quit' response means to invoke `keyboard-quit'.
2505 If the user enters `recenter', `scroll-up', or `scroll-down'
2506 responses, perform the requested window recentering or scrolling
2509 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2510 is nil and `use-dialog-box' is non-nil."
2511 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2512 ;; where all the keys were unbound (i.e. it somehow got triggered
2513 ;; within read-key, apparently). I had to kill it.
2514 (let ((answer 'recenter)
2515 (padded (lambda (prompt &optional dialog)
2516 (let ((l (length prompt)))
2518 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2520 (if dialog "" "(y or n) "))))))
2523 (setq prompt (funcall padded prompt))
2524 (let ((temp-prompt prompt))
2525 (while (not (memq answer '(act skip)))
2526 (let ((str (read-string temp-prompt)))
2527 (cond ((member str '("y" "Y")) (setq answer 'act))
2528 ((member str '("n" "N")) (setq answer 'skip))
2529 (t (setq temp-prompt (concat "Please answer y or n. "
2531 ((and (display-popup-menus-p)
2532 last-input-event ; not during startup
2533 (listp last-nonmenu-event)
2535 (setq prompt (funcall padded prompt t)
2536 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2538 (setq prompt (funcall padded prompt))
2540 (let* ((scroll-actions '(recenter scroll-up scroll-down
2541 scroll-other-window scroll-other-window-down))
2543 (let ((cursor-in-echo-area t))
2544 (when minibuffer-auto-raise
2545 (raise-frame (window-frame (minibuffer-window))))
2546 (read-key (propertize (if (memq answer scroll-actions)
2548 (concat "Please answer y or n. "
2550 'face 'minibuffer-prompt)))))
2551 (setq answer (lookup-key query-replace-map (vector key) t))
2553 ((memq answer '(skip act)) nil)
2554 ((eq answer 'recenter)
2556 ((eq answer 'scroll-up)
2557 (ignore-errors (scroll-up-command)) t)
2558 ((eq answer 'scroll-down)
2559 (ignore-errors (scroll-down-command)) t)
2560 ((eq answer 'scroll-other-window)
2561 (ignore-errors (scroll-other-window)) t)
2562 ((eq answer 'scroll-other-window-down)
2563 (ignore-errors (scroll-other-window-down)) t)
2564 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2565 (signal 'quit nil) t)
2569 (let ((ret (eq answer 'act)))
2570 (unless noninteractive
2571 (message "%s%c" prompt (if ret ?y ?n)))
2575 ;;; Atomic change groups.
2577 (defmacro atomic-change-group (&rest body)
2578 "Perform BODY as an atomic change group.
2579 This means that if BODY exits abnormally,
2580 all of its changes to the current buffer are undone.
2581 This works regardless of whether undo is enabled in the buffer.
2583 This mechanism is transparent to ordinary use of undo;
2584 if undo is enabled in the buffer and BODY succeeds, the
2585 user can undo the change normally."
2586 (declare (indent 0) (debug t))
2587 (let ((handle (make-symbol "--change-group-handle--"))
2588 (success (make-symbol "--change-group-success--")))
2589 `(let ((,handle (prepare-change-group))
2590 ;; Don't truncate any undo data in the middle of this.
2591 (undo-outer-limit nil)
2592 (undo-limit most-positive-fixnum)
2593 (undo-strong-limit most-positive-fixnum)
2597 ;; This is inside the unwind-protect because
2598 ;; it enables undo if that was disabled; we need
2599 ;; to make sure that it gets disabled again.
2600 (activate-change-group ,handle)
2603 ;; Either of these functions will disable undo
2604 ;; if it was disabled before.
2606 (accept-change-group ,handle)
2607 (cancel-change-group ,handle))))))
2609 (defun prepare-change-group (&optional buffer)
2610 "Return a handle for the current buffer's state, for a change group.
2611 If you specify BUFFER, make a handle for BUFFER's state instead.
2613 Pass the handle to `activate-change-group' afterward to initiate
2614 the actual changes of the change group.
2616 To finish the change group, call either `accept-change-group' or
2617 `cancel-change-group' passing the same handle as argument. Call
2618 `accept-change-group' to accept the changes in the group as final;
2619 call `cancel-change-group' to undo them all. You should use
2620 `unwind-protect' to make sure the group is always finished. The call
2621 to `activate-change-group' should be inside the `unwind-protect'.
2622 Once you finish the group, don't use the handle again--don't try to
2623 finish the same group twice. For a simple example of correct use, see
2624 the source code of `atomic-change-group'.
2626 The handle records only the specified buffer. To make a multibuffer
2627 change group, call this function once for each buffer you want to
2628 cover, then use `nconc' to combine the returned values, like this:
2630 (nconc (prepare-change-group buffer-1)
2631 (prepare-change-group buffer-2))
2633 You can then activate that multibuffer change group with a single
2634 call to `activate-change-group' and finish it with a single call
2635 to `accept-change-group' or `cancel-change-group'."
2638 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2639 (list (cons (current-buffer) buffer-undo-list))))
2641 (defun activate-change-group (handle)
2642 "Activate a change group made with `prepare-change-group' (which see)."
2643 (dolist (elt handle)
2644 (with-current-buffer (car elt)
2645 (if (eq buffer-undo-list t)
2646 (setq buffer-undo-list nil)))))
2648 (defun accept-change-group (handle)
2649 "Finish a change group made with `prepare-change-group' (which see).
2650 This finishes the change group by accepting its changes as final."
2651 (dolist (elt handle)
2652 (with-current-buffer (car elt)
2653 (if (eq (cdr elt) t)
2654 (setq buffer-undo-list t)))))
2656 (defun cancel-change-group (handle)
2657 "Finish a change group made with `prepare-change-group' (which see).
2658 This finishes the change group by reverting all of its changes."
2659 (dolist (elt handle)
2660 (with-current-buffer (car elt)
2661 (setq elt (cdr elt))
2663 ;; Widen buffer temporarily so if the buffer was narrowed within
2664 ;; the body of `atomic-change-group' all changes can be undone.
2666 (let ((old-car (car-safe elt))
2667 (old-cdr (cdr-safe elt)))
2670 ;; Temporarily truncate the undo log at ELT.
2672 (setcar elt nil) (setcdr elt nil))
2673 (unless (eq last-command 'undo) (undo-start))
2674 ;; Make sure there's no confusion.
2675 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2676 (error "Undoing to some unrelated state"))
2679 (while (listp pending-undo-list) (undo-more 1)))
2680 ;; Revert the undo info to what it was when we grabbed
2682 (setq buffer-undo-list elt))
2683 ;; Reset the modified cons cell ELT to its original content.
2685 (setcar elt old-car)
2686 (setcdr elt old-cdr))))))))
2688 ;;;; Display-related functions.
2690 ;; For compatibility.
2691 (define-obsolete-function-alias 'redraw-modeline
2692 'force-mode-line-update "24.3")
2694 (defun momentary-string-display (string pos &optional exit-char message)
2695 "Momentarily display STRING in the buffer at POS.
2696 Display remains until next event is input.
2697 If POS is a marker, only its position is used; its buffer is ignored.
2698 Optional third arg EXIT-CHAR can be a character, event or event
2699 description list. EXIT-CHAR defaults to SPC. If the input is
2700 EXIT-CHAR it is swallowed; otherwise it is then available as
2701 input (as a command if nothing else).
2702 Display MESSAGE (optional fourth arg) in the echo area.
2703 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2704 (or exit-char (setq exit-char ?\s))
2705 (let ((ol (make-overlay pos pos))
2706 (str (copy-sequence string)))
2710 (overlay-put ol 'after-string str)
2712 ;; To avoid trouble with out-of-bounds position
2714 ;; If the string end is off screen, recenter now.
2715 (if (<= (window-end nil t) pos)
2716 (recenter (/ (window-height) 2))))
2717 (message (or message "Type %s to continue editing.")
2718 (single-key-description exit-char))
2719 (let ((event (read-key)))
2720 ;; `exit-char' can be an event, or an event description list.
2721 (or (eq event exit-char)
2722 (eq event (event-convert-list exit-char))
2723 (setq unread-command-events
2724 (append (this-single-command-raw-keys)
2725 unread-command-events)))))
2726 (delete-overlay ol))))
2729 ;;;; Overlay operations
2731 (defun copy-overlay (o)
2732 "Return a copy of overlay O."
2733 (let ((o1 (if (overlay-buffer o)
2734 (make-overlay (overlay-start o) (overlay-end o)
2735 ;; FIXME: there's no easy way to find the
2736 ;; insertion-type of the two markers.
2738 (let ((o1 (make-overlay (point-min) (point-min))))
2741 (props (overlay-properties o)))
2743 (overlay-put o1 (pop props) (pop props)))
2746 (defun remove-overlays (&optional beg end name val)
2747 "Clear BEG and END of overlays whose property NAME has value VAL.
2748 Overlays might be moved and/or split.
2749 BEG and END default respectively to the beginning and end of buffer."
2750 ;; This speeds up the loops over overlays.
2751 (unless beg (setq beg (point-min)))
2752 (unless end (setq end (point-max)))
2753 (overlay-recenter end)
2755 (setq beg (prog1 end (setq end beg))))
2757 (dolist (o (overlays-in beg end))
2758 (when (eq (overlay-get o name) val)
2759 ;; Either push this overlay outside beg...end
2760 ;; or split it to exclude beg...end
2761 ;; or delete it entirely (if it is contained in beg...end).
2762 (if (< (overlay-start o) beg)
2763 (if (> (overlay-end o) end)
2765 (move-overlay (copy-overlay o)
2766 (overlay-start o) beg)
2767 (move-overlay o end (overlay-end o)))
2768 (move-overlay o (overlay-start o) beg))
2769 (if (> (overlay-end o) end)
2770 (move-overlay o end (overlay-end o))
2771 (delete-overlay o)))))))
2775 (defvar suspend-hook nil
2776 "Normal hook run by `suspend-emacs', before suspending.")
2778 (defvar suspend-resume-hook nil
2779 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2781 (defvar temp-buffer-show-hook nil
2782 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2783 When the hook runs, the temporary buffer is current, and the window it
2784 was displayed in is selected.")
2786 (defvar temp-buffer-setup-hook nil
2787 "Normal hook run by `with-output-to-temp-buffer' at the start.
2788 When the hook runs, the temporary buffer is current.
2789 This hook is normally set up with a function to put the buffer in Help
2792 (defconst user-emacs-directory
2793 (if (eq system-type 'ms-dos)
2794 ;; MS-DOS cannot have initial dot.
2797 "Directory beneath which additional per-user Emacs-specific files are placed.
2798 Various programs in Emacs store information in this directory.
2799 Note that this should end with a directory separator.
2800 See also `locate-user-emacs-file'.")
2802 ;;;; Misc. useful functions.
2804 (defsubst buffer-narrowed-p ()
2805 "Return non-nil if the current buffer is narrowed."
2806 (/= (- (point-max) (point-min)) (buffer-size)))
2808 (defun find-tag-default-bounds ()
2809 "Determine the boundaries of the default tag, based on text at point.
2810 Return a cons cell with the beginning and end of the found tag.
2811 If there is no plausible default, return nil."
2812 (bounds-of-thing-at-point 'symbol))
2814 (defun find-tag-default ()
2815 "Determine default tag to search for, based on text at point.
2816 If there is no plausible default, return nil."
2817 (let ((bounds (find-tag-default-bounds)))
2819 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2821 (defun find-tag-default-as-regexp ()
2822 "Return regexp that matches the default tag at point.
2823 If there is no tag at point, return nil.
2825 When in a major mode that does not provide its own
2826 `find-tag-default-function', return a regexp that matches the
2827 symbol at point exactly."
2828 (let ((tag (funcall (or find-tag-default-function
2829 (get major-mode 'find-tag-default-function)
2830 'find-tag-default))))
2831 (if tag (regexp-quote tag))))
2833 (defun find-tag-default-as-symbol-regexp ()
2834 "Return regexp that matches the default tag at point as symbol.
2835 If there is no tag at point, return nil.
2837 When in a major mode that does not provide its own
2838 `find-tag-default-function', return a regexp that matches the
2839 symbol at point exactly."
2840 (let ((tag-regexp (find-tag-default-as-regexp)))
2842 (eq (or find-tag-default-function
2843 (get major-mode 'find-tag-default-function)
2846 (format "\\_<%s\\_>" tag-regexp)
2849 (defun play-sound (sound)
2850 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2851 The following keywords are recognized:
2853 :file FILE - read sound data from FILE. If FILE isn't an
2854 absolute file name, it is searched in `data-directory'.
2856 :data DATA - read sound data from string DATA.
2858 Exactly one of :file or :data must be present.
2860 :volume VOL - set volume to VOL. VOL must an integer in the
2861 range 0..100 or a float in the range 0..1.0. If not specified,
2862 don't change the volume setting of the sound device.
2864 :device DEVICE - play sound on DEVICE. If not specified,
2865 a system-dependent default device name is used.
2867 Note: :data and :device are currently not supported on Windows."
2868 (if (fboundp 'play-sound-internal)
2869 (play-sound-internal sound)
2870 (error "This Emacs binary lacks sound support")))
2872 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2874 (defun shell-quote-argument (argument)
2875 "Quote ARGUMENT for passing as argument to an inferior shell.
2877 This function is designed to work with the syntax of your system's
2878 standard shell, and might produce incorrect results with unusual shells.
2879 See Info node `(elisp)Security Considerations'."
2881 ((eq system-type 'ms-dos)
2882 ;; Quote using double quotes, but escape any existing quotes in
2883 ;; the argument with backslashes.
2887 (if (or (null (string-match "[^\"]" argument))
2888 (< (match-end 0) (length argument)))
2889 (while (string-match "[\"]" argument start)
2890 (setq end (match-beginning 0)
2891 result (concat result (substring argument start end)
2892 "\\" (substring argument end (1+ end)))
2894 (concat "\"" result (substring argument start) "\"")))
2896 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2898 ;; First, quote argument so that CommandLineToArgvW will
2899 ;; understand it. See
2900 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2901 ;; After we perform that level of quoting, escape shell
2902 ;; metacharacters so that cmd won't mangle our argument. If the
2903 ;; argument contains no double quote characters, we can just
2904 ;; surround it with double quotes. Otherwise, we need to prefix
2905 ;; each shell metacharacter with a caret.
2908 ;; escape backslashes at end of string
2909 (replace-regexp-in-string
2912 ;; escape backslashes and quotes in string body
2913 (replace-regexp-in-string
2918 (if (string-match "[%!\"]" argument)
2921 (replace-regexp-in-string
2922 "\\([%!()\"<>&|^]\\)"
2926 (concat "\"" argument "\"")))
2929 (if (equal argument "")
2931 ;; Quote everything except POSIX filename characters.
2932 ;; This should be safe enough even for really weird shells.
2933 (replace-regexp-in-string
2935 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2938 (defsubst string-to-list (string)
2939 "Return a list of characters in STRING."
2940 (append string nil))
2942 (defsubst string-to-vector (string)
2943 "Return a vector of characters in STRING."
2946 (defun string-or-null-p (object)
2947 "Return t if OBJECT is a string or nil.
2948 Otherwise, return nil."
2949 (or (stringp object) (null object)))
2951 (defun booleanp (object)
2952 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2953 Otherwise, return nil."
2954 (and (memq object '(nil t)) t))
2956 (defun special-form-p (object)
2957 "Non-nil if and only if OBJECT is a special form."
2958 (if (and (symbolp object) (fboundp object))
2959 (setq object (indirect-function object)))
2960 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2962 (defun macrop (object)
2963 "Non-nil if and only if OBJECT is a macro."
2964 (let ((def (indirect-function object)))
2966 (or (eq 'macro (car def))
2967 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2969 (defun field-at-pos (pos)
2970 "Return the field at position POS, taking stickiness etc into account."
2971 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2972 (if (eq raw-field 'boundary)
2973 (get-char-property (1- (field-end pos)) 'field)
2976 (defun sha1 (object &optional start end binary)
2977 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2978 OBJECT is either a string or a buffer. Optional arguments START and
2979 END are character positions specifying which portion of OBJECT for
2980 computing the hash. If BINARY is non-nil, return a string in binary
2982 (secure-hash 'sha1 object start end binary))
2984 (defun function-get (f prop &optional autoload)
2985 "Return the value of property PROP of function F.
2986 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2987 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2988 if it's an autoloaded macro."
2990 (while (and (symbolp f)
2991 (null (setq val (get f prop)))
2993 (let ((fundef (symbol-function f)))
2994 (if (and autoload (autoloadp fundef)
2996 (autoload-do-load fundef f
2997 (if (eq autoload 'macro)
2999 nil ;Re-try `get' on the same `f'.
3003 ;;;; Support for yanking and text properties.
3004 ;; Why here in subr.el rather than in simple.el? --Stef
3006 (defvar yank-handled-properties)
3007 (defvar yank-excluded-properties)
3009 (defun remove-yank-excluded-properties (start end)
3010 "Process text properties between START and END, inserted for a `yank'.
3011 Perform the handling specified by `yank-handled-properties', then
3012 remove properties specified by `yank-excluded-properties'."
3013 (let ((inhibit-read-only t))
3014 (dolist (handler yank-handled-properties)
3015 (let ((prop (car handler))
3018 (while (< run-start end)
3019 (let ((value (get-text-property run-start prop))
3020 (run-end (next-single-property-change
3021 run-start prop nil end)))
3022 (funcall fun value run-start run-end)
3023 (setq run-start run-end)))))
3024 (if (eq yank-excluded-properties t)
3025 (set-text-properties start end nil)
3026 (remove-list-of-text-properties start end yank-excluded-properties))))
3028 (defvar yank-undo-function)
3030 (defun insert-for-yank (string)
3031 "Insert STRING at point for the `yank' command.
3033 This function is like `insert', except it honors the variables
3034 `yank-handled-properties' and `yank-excluded-properties', and the
3035 `yank-handler' text property, in the way that `yank' does."
3037 (while (setq to (next-single-property-change 0 'yank-handler string))
3038 (insert-for-yank-1 (substring string 0 to))
3039 (setq string (substring string to))))
3040 (insert-for-yank-1 string))
3042 (defun insert-for-yank-1 (string)
3043 "Helper for `insert-for-yank', which see."
3044 (let* ((handler (and (stringp string)
3045 (get-text-property 0 'yank-handler string)))
3046 (param (or (nth 1 handler) string))
3048 (inhibit-read-only inhibit-read-only)
3051 (setq yank-undo-function t)
3052 (if (nth 0 handler) ; FUNCTION
3053 (funcall (car handler) param)
3057 ;; Prevent read-only properties from interfering with the
3058 ;; following text property changes.
3059 (setq inhibit-read-only t)
3061 (unless (nth 2 handler) ; NOEXCLUDE
3062 (remove-yank-excluded-properties opoint end))
3064 ;; If last inserted char has properties, mark them as rear-nonsticky.
3065 (if (and (> end opoint)
3066 (text-properties-at (1- end)))
3067 (put-text-property (1- end) end 'rear-nonsticky t))
3069 (if (eq yank-undo-function t) ; not set by FUNCTION
3070 (setq yank-undo-function (nth 3 handler))) ; UNDO
3071 (if (nth 4 handler) ; COMMAND
3072 (setq this-command (nth 4 handler)))))
3074 (defun insert-buffer-substring-no-properties (buffer &optional start end)
3075 "Insert before point a substring of BUFFER, without text properties.
3076 BUFFER may be a buffer or a buffer name.
3077 Arguments START and END are character positions specifying the substring.
3078 They default to the values of (point-min) and (point-max) in BUFFER."
3079 (let ((opoint (point)))
3080 (insert-buffer-substring buffer start end)
3081 (let ((inhibit-read-only t))
3082 (set-text-properties opoint (point) nil))))
3084 (defun insert-buffer-substring-as-yank (buffer &optional start end)
3085 "Insert before point a part of BUFFER, stripping some text properties.
3086 BUFFER may be a buffer or a buffer name.
3087 Arguments START and END are character positions specifying the substring.
3088 They default to the values of (point-min) and (point-max) in BUFFER.
3089 Before insertion, process text properties according to
3090 `yank-handled-properties' and `yank-excluded-properties'."
3091 ;; Since the buffer text should not normally have yank-handler properties,
3092 ;; there is no need to handle them here.
3093 (let ((opoint (point)))
3094 (insert-buffer-substring buffer start end)
3095 (remove-yank-excluded-properties opoint (point))))
3097 (defun yank-handle-font-lock-face-property (face start end)
3098 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
3099 START and END denote the start and end of the text to act on.
3100 Do nothing if FACE is nil."
3102 (null font-lock-defaults)
3103 (put-text-property start end 'face face)))
3105 ;; This removes `mouse-face' properties in *Help* buffer buttons:
3106 ;; https://lists.gnu.org/r/emacs-devel/2002-04/msg00648.html
3107 (defun yank-handle-category-property (category start end)
3108 "Apply property category CATEGORY's properties between START and END."
3110 (let ((start2 start))
3111 (while (< start2 end)
3112 (let ((end2 (next-property-change start2 nil end))
3113 (original (text-properties-at start2)))
3114 (set-text-properties start2 end2 (symbol-plist category))
3115 (add-text-properties start2 end2 original)
3116 (setq start2 end2))))))
3119 ;;;; Synchronous shell commands.
3121 (defun start-process-shell-command (name buffer &rest args)
3122 "Start a program in a subprocess. Return the process object for it.
3123 NAME is name for process. It is modified if necessary to make it unique.
3124 BUFFER is the buffer (or buffer name) to associate with the process.
3125 Process output goes at end of that buffer, unless you specify
3126 an output stream or filter function to handle the output.
3127 BUFFER may be also nil, meaning that this process is not associated
3129 COMMAND is the shell command to run.
3131 An old calling convention accepted any number of arguments after COMMAND,
3132 which were just concatenated to COMMAND. This is still supported but strongly
3134 (declare (advertised-calling-convention (name buffer command) "23.1"))
3135 ;; We used to use `exec' to replace the shell with the command,
3136 ;; but that failed to handle (...) and semicolon, etc.
3137 (start-process name buffer shell-file-name shell-command-switch
3138 (mapconcat 'identity args " ")))
3140 (defun start-file-process-shell-command (name buffer &rest args)
3141 "Start a program in a subprocess. Return the process object for it.
3142 Similar to `start-process-shell-command', but calls `start-file-process'."
3143 (declare (advertised-calling-convention (name buffer command) "23.1"))
3146 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3147 (if (file-remote-p default-directory) "-c" shell-command-switch)
3148 (mapconcat 'identity args " ")))
3150 (defun call-process-shell-command (command &optional infile buffer display
3152 "Execute the shell command COMMAND synchronously in separate process.
3153 The remaining arguments are optional.
3154 The program's input comes from file INFILE (nil means `/dev/null').
3155 Insert output in BUFFER before point; t means current buffer;
3156 nil for BUFFER means discard it; 0 means discard and don't wait.
3157 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3158 REAL-BUFFER says what to do with standard output, as above,
3159 while STDERR-FILE says what to do with standard error in the child.
3160 STDERR-FILE may be nil (discard standard error output),
3161 t (mix it with ordinary output), or a file name string.
3163 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
3164 Wildcards and redirection are handled as usual in the shell.
3166 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
3167 Otherwise it waits for COMMAND to terminate and returns a numeric exit
3168 status or a signal description string.
3169 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
3171 An old calling convention accepted any number of arguments after DISPLAY,
3172 which were just concatenated to COMMAND. This is still supported but strongly
3174 (declare (advertised-calling-convention
3175 (command &optional infile buffer display) "24.5"))
3176 ;; We used to use `exec' to replace the shell with the command,
3177 ;; but that failed to handle (...) and semicolon, etc.
3178 (call-process shell-file-name
3179 infile buffer display
3180 shell-command-switch
3181 (mapconcat 'identity (cons command args) " ")))
3183 (defun process-file-shell-command (command &optional infile buffer display
3185 "Process files synchronously in a separate process.
3186 Similar to `call-process-shell-command', but calls `process-file'."
3187 (declare (advertised-calling-convention
3188 (command &optional infile buffer display) "24.5"))
3190 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3191 infile buffer display
3192 (if (file-remote-p default-directory) "-c" shell-command-switch)
3193 (mapconcat 'identity (cons command args) " ")))
3195 (defun call-shell-region (start end command &optional delete buffer)
3196 "Send text from START to END as input to an inferior shell running COMMAND.
3197 Delete the text if fourth arg DELETE is non-nil.
3199 Insert output in BUFFER before point; t means current buffer; nil for
3200 BUFFER means discard it; 0 means discard and don't wait; and `(:file
3201 FILE)', where FILE is a file name string, means that it should be
3202 written to that file (if the file already exists it is overwritten).
3203 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3204 REAL-BUFFER says what to do with standard output, as above,
3205 while STDERR-FILE says what to do with standard error in the child.
3206 STDERR-FILE may be nil (discard standard error output),
3207 t (mix it with ordinary output), or a file name string.
3209 If BUFFER is 0, `call-shell-region' returns immediately with value nil.
3210 Otherwise it waits for COMMAND to terminate
3211 and returns a numeric exit status or a signal description string.
3212 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
3213 (call-process-region start end
3214 shell-file-name delete buffer nil
3215 shell-command-switch command))
3217 ;;;; Lisp macros to do various things temporarily.
3219 (defmacro track-mouse (&rest body)
3220 "Evaluate BODY with mouse movement events enabled.
3221 Within a `track-mouse' form, mouse motion generates input events that
3222 you can read with `read-event'.
3223 Normally, mouse motion is ignored."
3224 (declare (debug t) (indent 0))
3225 `(internal--track-mouse (lambda () ,@body)))
3227 (defmacro with-current-buffer (buffer-or-name &rest body)
3228 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3229 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3230 The value returned is the value of the last form in BODY. See
3231 also `with-temp-buffer'."
3232 (declare (indent 1) (debug t))
3233 `(save-current-buffer
3234 (set-buffer ,buffer-or-name)
3237 (defun internal--before-with-selected-window (window)
3238 (let ((other-frame (window-frame window)))
3239 (list window (selected-window)
3240 ;; Selecting a window on another frame also changes that
3241 ;; frame's frame-selected-window. We must save&restore it.
3242 (unless (eq (selected-frame) other-frame)
3243 (frame-selected-window other-frame))
3244 ;; Also remember the top-frame if on ttys.
3245 (unless (eq (selected-frame) other-frame)
3246 (tty-top-frame other-frame)))))
3248 (defun internal--after-with-selected-window (state)
3249 ;; First reset frame-selected-window.
3250 (when (window-live-p (nth 2 state))
3251 ;; We don't use set-frame-selected-window because it does not
3252 ;; pass the `norecord' argument to Fselect_window.
3253 (select-window (nth 2 state) 'norecord)
3254 (and (frame-live-p (nth 3 state))
3255 (not (eq (tty-top-frame) (nth 3 state)))
3256 (select-frame (nth 3 state) 'norecord)))
3257 ;; Then reset the actual selected-window.
3258 (when (window-live-p (nth 1 state))
3259 (select-window (nth 1 state) 'norecord)))
3261 (defmacro with-selected-window (window &rest body)
3262 "Execute the forms in BODY with WINDOW as the selected window.
3263 The value returned is the value of the last form in BODY.
3265 This macro saves and restores the selected window, as well as the
3266 selected window of each frame. It does not change the order of
3267 recently selected windows. If the previously selected window of
3268 some frame is no longer live at the end of BODY, that frame's
3269 selected window is left alone. If the selected window is no
3270 longer live, then whatever window is selected at the end of BODY
3273 This macro uses `save-current-buffer' to save and restore the
3274 current buffer, since otherwise its normal operation could
3275 potentially make a different buffer current. It does not alter
3276 the buffer list ordering."
3277 (declare (indent 1) (debug t))
3278 `(let ((save-selected-window--state
3279 (internal--before-with-selected-window ,window)))
3280 (save-current-buffer
3282 (progn (select-window (car save-selected-window--state) 'norecord)
3284 (internal--after-with-selected-window save-selected-window--state)))))
3286 (defmacro with-selected-frame (frame &rest body)
3287 "Execute the forms in BODY with FRAME as the selected frame.
3288 The value returned is the value of the last form in BODY.
3290 This macro saves and restores the selected frame, and changes the
3291 order of neither the recently selected windows nor the buffers in
3293 (declare (indent 1) (debug t))
3294 (let ((old-frame (make-symbol "old-frame"))
3295 (old-buffer (make-symbol "old-buffer")))
3296 `(let ((,old-frame (selected-frame))
3297 (,old-buffer (current-buffer)))
3299 (progn (select-frame ,frame 'norecord)
3301 (when (frame-live-p ,old-frame)
3302 (select-frame ,old-frame 'norecord))
3303 (when (buffer-live-p ,old-buffer)
3304 (set-buffer ,old-buffer))))))
3306 (defmacro save-window-excursion (&rest body)
3307 "Execute BODY, then restore previous window configuration.
3308 This macro saves the window configuration on the selected frame,
3309 executes BODY, then calls `set-window-configuration' to restore
3310 the saved window configuration. The return value is the last
3311 form in BODY. The window configuration is also restored if BODY
3314 BEWARE: Most uses of this macro introduce bugs.
3315 E.g. it should not be used to try and prevent some code from opening
3316 a new window, since that window may sometimes appear in another frame,
3317 in which case `save-window-excursion' cannot help."
3318 (declare (indent 0) (debug t))
3319 (let ((c (make-symbol "wconfig")))
3320 `(let ((,c (current-window-configuration)))
3321 (unwind-protect (progn ,@body)
3322 (set-window-configuration ,c)))))
3324 (defun internal-temp-output-buffer-show (buffer)
3325 "Internal function for `with-output-to-temp-buffer'."
3326 (with-current-buffer buffer
3327 (set-buffer-modified-p nil)
3328 (goto-char (point-min)))
3330 (if temp-buffer-show-function
3331 (funcall temp-buffer-show-function buffer)
3332 (with-current-buffer buffer
3334 (let ((window-combination-limit
3335 ;; When `window-combination-limit' equals
3336 ;; `temp-buffer' or `temp-buffer-resize' and
3337 ;; `temp-buffer-resize-mode' is enabled in this
3338 ;; buffer bind it to t so resizing steals space
3339 ;; preferably from the window that was split.
3340 (if (or (eq window-combination-limit 'temp-buffer)
3341 (and (eq window-combination-limit
3342 'temp-buffer-resize)
3343 temp-buffer-resize-mode))
3345 window-combination-limit)))
3346 (display-buffer buffer)))
3347 (frame (and window (window-frame window))))
3349 (unless (eq frame (selected-frame))
3350 (make-frame-visible frame))
3351 (setq minibuffer-scroll-window window)
3352 (set-window-hscroll window 0)
3353 ;; Don't try this with NOFORCE non-nil!
3354 (set-window-start window (point-min) t)
3355 ;; This should not be necessary.
3356 (set-window-point window (point-min))
3357 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3358 (with-selected-window window
3359 (run-hooks 'temp-buffer-show-hook))))))
3363 ;; Doc is very similar to with-temp-buffer-window.
3364 (defmacro with-output-to-temp-buffer (bufname &rest body)
3365 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3367 This construct makes buffer BUFNAME empty before running BODY.
3368 It does not make the buffer current for BODY.
3369 Instead it binds `standard-output' to that buffer, so that output
3370 generated with `prin1' and similar functions in BODY goes into
3373 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3374 it in a window, but does not select it. The normal way to do this is
3375 by calling `display-buffer', then running `temp-buffer-show-hook'.
3376 However, if `temp-buffer-show-function' is non-nil, it calls that
3377 function instead (and does not run `temp-buffer-show-hook'). The
3378 function gets one argument, the buffer to display.
3380 The return value of `with-output-to-temp-buffer' is the value of the
3381 last form in BODY. If BODY does not finish normally, the buffer
3382 BUFNAME is not displayed.
3384 This runs the hook `temp-buffer-setup-hook' before BODY,
3385 with the buffer BUFNAME temporarily current. It runs the hook
3386 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3387 buffer temporarily current, and the window that was used to display it
3388 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3389 if it uses `temp-buffer-show-function'.
3391 By default, the setup hook puts the buffer into Help mode before running BODY.
3392 If BODY does not change the major mode, the show hook makes the buffer
3393 read-only, and scans it for function and variable names to make them into
3394 clickable cross-references.
3396 See the related form `with-temp-buffer-window'."
3398 (let ((old-dir (make-symbol "old-dir"))
3399 (buf (make-symbol "buf")))
3400 `(let* ((,old-dir default-directory)
3402 (with-current-buffer (get-buffer-create ,bufname)
3403 (prog1 (current-buffer)
3404 (kill-all-local-variables)
3405 ;; FIXME: delete_all_overlays
3406 (setq default-directory ,old-dir)
3407 (setq buffer-read-only nil)
3408 (setq buffer-file-name nil)
3409 (setq buffer-undo-list t)
3410 (let ((inhibit-read-only t)
3411 (inhibit-modification-hooks t))
3413 (run-hooks 'temp-buffer-setup-hook)))))
3414 (standard-output ,buf))
3415 (prog1 (progn ,@body)
3416 (internal-temp-output-buffer-show ,buf)))))
3418 (defmacro with-temp-file (file &rest body)
3419 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3420 The value returned is the value of the last form in BODY.
3421 See also `with-temp-buffer'."
3422 (declare (indent 1) (debug t))
3423 (let ((temp-file (make-symbol "temp-file"))
3424 (temp-buffer (make-symbol "temp-buffer")))
3425 `(let ((,temp-file ,file)
3427 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3430 (with-current-buffer ,temp-buffer
3432 (with-current-buffer ,temp-buffer
3433 (write-region nil nil ,temp-file nil 0)))
3434 (and (buffer-name ,temp-buffer)
3435 (kill-buffer ,temp-buffer))))))
3437 (defmacro with-temp-message (message &rest body)
3438 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3439 The original message is restored to the echo area after BODY has finished.
3440 The value returned is the value of the last form in BODY.
3441 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3442 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3443 Use a MESSAGE of \"\" to temporarily clear the echo area."
3444 (declare (debug t) (indent 1))
3445 (let ((current-message (make-symbol "current-message"))
3446 (temp-message (make-symbol "with-temp-message")))
3447 `(let ((,temp-message ,message)
3452 (setq ,current-message (current-message))
3453 (message "%s" ,temp-message))
3456 (if ,current-message
3457 (message "%s" ,current-message)
3460 (defmacro with-temp-buffer (&rest body)
3461 "Create a temporary buffer, and evaluate BODY there like `progn'.
3462 See also `with-temp-file' and `with-output-to-string'."
3463 (declare (indent 0) (debug t))
3464 (let ((temp-buffer (make-symbol "temp-buffer")))
3465 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3466 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3467 (with-current-buffer ,temp-buffer
3470 (and (buffer-name ,temp-buffer)
3471 (kill-buffer ,temp-buffer)))))))
3473 (defmacro with-silent-modifications (&rest body)
3474 "Execute BODY, pretending it does not modify the buffer.
3475 This macro is typically used around modifications of
3476 text properties which do not really affect the buffer's content.
3477 If BODY performs real modifications to the buffer's text, other
3478 than cosmetic ones, undo data may become corrupted.
3480 This macro will run BODY normally, but doesn't count its buffer
3481 modifications as being buffer modifications. This affects things
3482 like `buffer-modified-p', checking whether the file is locked by
3483 someone else, running buffer modification hooks, and other things
3485 (declare (debug t) (indent 0))
3486 (let ((modified (make-symbol "modified")))
3487 `(let* ((,modified (buffer-modified-p))
3488 (buffer-undo-list t)
3489 (inhibit-read-only t)
3490 (inhibit-modification-hooks t))
3495 (restore-buffer-modified-p nil))))))
3497 (defmacro with-output-to-string (&rest body)
3498 "Execute BODY, return the text it sent to `standard-output', as a string."
3499 (declare (indent 0) (debug t))
3500 `(let ((standard-output
3501 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3504 (let ((standard-output standard-output))
3506 (with-current-buffer standard-output
3508 (kill-buffer standard-output))))
3510 (defmacro with-local-quit (&rest body)
3511 "Execute BODY, allowing quits to terminate BODY but not escape further.
3512 When a quit terminates BODY, `with-local-quit' returns nil but
3513 requests another quit. That quit will be processed as soon as quitting
3514 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3515 (declare (debug t) (indent 0))
3516 `(condition-case nil
3517 (let ((inhibit-quit nil))
3519 (quit (setq quit-flag t)
3520 ;; This call is to give a chance to handle quit-flag
3521 ;; in case inhibit-quit is nil.
3522 ;; Without this, it will not be handled until the next function
3523 ;; call, and that might allow it to exit thru a condition-case
3524 ;; that intends to handle the quit signal next time.
3525 (eval '(ignore nil)))))
3527 ;; Don't throw `throw-on-input' on those events by default.
3528 (setq while-no-input-ignore-events
3529 '(focus-in focus-out help-echo iconify-frame
3530 make-frame-visible selection-request))
3532 (defmacro while-no-input (&rest body)
3533 "Execute BODY only as long as there's no pending input.
3534 If input arrives, that ends the execution of BODY,
3535 and `while-no-input' returns t. Quitting makes it return nil.
3536 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3537 (declare (debug t) (indent 0))
3538 (let ((catch-sym (make-symbol "input")))
3541 (let ((throw-on-input ',catch-sym))
3542 (or (input-pending-p)
3543 (progn ,@body)))))))
3545 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3546 "Like `condition-case' except that it does not prevent debugging.
3547 More specifically if `debug-on-error' is set then the debugger will be invoked
3548 even if this catches the signal."
3549 (declare (debug condition-case) (indent 2))
3550 `(condition-case ,var
3552 ,@(mapcar (lambda (handler)
3553 `((debug ,@(if (listp (car handler)) (car handler)
3554 (list (car handler))))
3558 (define-obsolete-function-alias 'condition-case-no-debug
3559 'condition-case-unless-debug "24.1")
3561 (defmacro with-demoted-errors (format &rest body)
3562 "Run BODY and demote any errors to simple messages.
3563 FORMAT is a string passed to `message' to format any error message.
3564 It should contain a single %-sequence; e.g., \"Error: %S\".
3566 If `debug-on-error' is non-nil, run BODY without catching its errors.
3567 This is to be used around code which is not expected to signal an error
3568 but which should be robust in the unexpected case that an error is signaled.
3570 For backward compatibility, if FORMAT is not a constant string, it
3571 is assumed to be part of BODY, in which case the message format
3572 used is \"Error: %S\"."
3573 (declare (debug t) (indent 1))
3574 (let ((err (make-symbol "err"))
3575 (format (if (and (stringp format) body) format
3577 (if format (push format body))))))
3578 `(condition-case-unless-debug ,err
3579 ,(macroexp-progn body)
3580 (error (message ,format ,err) nil))))
3582 (defmacro combine-after-change-calls (&rest body)
3583 "Execute BODY, but don't call the after-change functions till the end.
3584 If BODY makes changes in the buffer, they are recorded
3585 and the functions on `after-change-functions' are called several times
3586 when BODY is finished.
3587 The return value is the value of the last form in BODY.
3589 If `before-change-functions' is non-nil, then calls to the after-change
3590 functions can't be deferred, so in that case this macro has no effect.
3592 Do not alter `after-change-functions' or `before-change-functions'
3594 (declare (indent 0) (debug t))
3596 (let ((combine-after-change-calls t))
3598 (combine-after-change-execute)))
3600 (defmacro with-case-table (table &rest body)
3601 "Execute the forms in BODY with TABLE as the current case table.
3602 The value returned is the value of the last form in BODY."
3603 (declare (indent 1) (debug t))
3604 (let ((old-case-table (make-symbol "table"))
3605 (old-buffer (make-symbol "buffer")))
3606 `(let ((,old-case-table (current-case-table))
3607 (,old-buffer (current-buffer)))
3609 (progn (set-case-table ,table)
3611 (with-current-buffer ,old-buffer
3612 (set-case-table ,old-case-table))))))
3614 (defmacro with-file-modes (modes &rest body)
3615 "Execute BODY with default file permissions temporarily set to MODES.
3616 MODES is as for `set-default-file-modes'."
3617 (declare (indent 1) (debug t))
3618 (let ((umask (make-symbol "umask")))
3619 `(let ((,umask (default-file-modes)))
3622 (set-default-file-modes ,modes)
3624 (set-default-file-modes ,umask)))))
3627 ;;; Matching and match data.
3629 (defvar save-match-data-internal)
3631 ;; We use save-match-data-internal as the local variable because
3632 ;; that works ok in practice (people should not use that variable elsewhere).
3633 ;; We used to use an uninterned symbol; the compiler handles that properly
3634 ;; now, but it generates slower code.
3635 (defmacro save-match-data (&rest body)
3636 "Execute the BODY forms, restoring the global value of the match data.
3637 The value returned is the value of the last form in BODY."
3638 ;; It is better not to use backquote here,
3639 ;; because that makes a bootstrapping problem
3640 ;; if you need to recompile all the Lisp files using interpreted code.
3641 (declare (indent 0) (debug t))
3643 '((save-match-data-internal (match-data)))
3644 (list 'unwind-protect
3646 ;; It is safe to free (evaporate) markers immediately here,
3647 ;; as Lisp programs should not copy from save-match-data-internal.
3648 '(set-match-data save-match-data-internal 'evaporate))))
3650 (defun match-string (num &optional string)
3651 "Return string of text matched by last search.
3652 NUM specifies which parenthesized expression in the last regexp.
3653 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3654 Zero means the entire text matched by the whole regexp or whole string.
3655 STRING should be given if the last search was by `string-match' on STRING.
3656 If STRING is nil, the current buffer should be the same buffer
3657 the search/match was performed in."
3658 (if (match-beginning num)
3660 (substring string (match-beginning num) (match-end num))
3661 (buffer-substring (match-beginning num) (match-end num)))))
3663 (defun match-string-no-properties (num &optional string)
3664 "Return string of text matched by last search, without text properties.
3665 NUM specifies which parenthesized expression in the last regexp.
3666 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3667 Zero means the entire text matched by the whole regexp or whole string.
3668 STRING should be given if the last search was by `string-match' on STRING.
3669 If STRING is nil, the current buffer should be the same buffer
3670 the search/match was performed in."
3671 (if (match-beginning num)
3673 (substring-no-properties string (match-beginning num)
3675 (buffer-substring-no-properties (match-beginning num)
3679 (defun match-substitute-replacement (replacement
3680 &optional fixedcase literal string subexp)
3681 "Return REPLACEMENT as it will be inserted by `replace-match'.
3682 In other words, all back-references in the form `\\&' and `\\N'
3683 are substituted with actual strings matched by the last search.
3684 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3685 meaning as for `replace-match'."
3686 (let ((match (match-string 0 string)))
3688 (set-match-data (mapcar (lambda (x)
3690 (- x (match-beginning 0))
3693 (replace-match replacement fixedcase literal match subexp))))
3696 (defun looking-back (regexp &optional limit greedy)
3697 "Return non-nil if text before point matches regular expression REGEXP.
3698 Like `looking-at' except matches before point, and is slower.
3699 LIMIT if non-nil speeds up the search by specifying a minimum
3700 starting position, to avoid checking matches that would start
3703 If GREEDY is non-nil, extend the match backwards as far as
3704 possible, stopping when a single additional previous character
3705 cannot be part of a match for REGEXP. When the match is
3706 extended, its starting position is allowed to occur before
3709 As a general recommendation, try to avoid using `looking-back'
3710 wherever possible, since it is slow."
3712 (advertised-calling-convention (regexp limit &optional greedy) "25.1"))
3713 (let ((start (point))
3716 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3718 (if (and greedy pos)
3720 (narrow-to-region (point-min) start)
3721 (while (and (> pos (point-min))
3725 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3726 (setq pos (1- pos)))
3729 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3732 (defsubst looking-at-p (regexp)
3734 Same as `looking-at' except this function does not change the match data."
3735 (let ((inhibit-changing-match-data t))
3736 (looking-at regexp)))
3738 (defsubst string-match-p (regexp string &optional start)
3740 Same as `string-match' except this function does not change the match data."
3741 (let ((inhibit-changing-match-data t))
3742 (string-match regexp string start)))
3744 (defun subregexp-context-p (regexp pos &optional start)
3745 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3746 A subregexp context is one where a sub-regexp can appear.
3747 A non-subregexp context is for example within brackets, or within a
3748 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3749 If START is non-nil, it should be a position in REGEXP, smaller
3750 than POS, and known to be in a subregexp context."
3751 ;; Here's one possible implementation, with the great benefit that it
3752 ;; reuses the regexp-matcher's own parser, so it understands all the
3753 ;; details of the syntax. A disadvantage is that it needs to match the
3757 (string-match (substring regexp (or start 0) pos) "")
3760 (not (member (cadr err) '("Unmatched [ or [^"
3762 "Trailing backslash")))))
3763 ;; An alternative implementation:
3764 ;; (defconst re-context-re
3765 ;; (let* ((harmless-ch "[^\\[]")
3766 ;; (harmless-esc "\\\\[^{]")
3767 ;; (class-harmless-ch "[^][]")
3768 ;; (class-lb-harmless "[^]:]")
3769 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3770 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3771 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3773 ;; (concat "\\[^?]?"
3774 ;; "\\(" class-harmless-ch
3775 ;; "\\|" class-lb "\\)*"
3776 ;; "\\[?]")) ; special handling for bare [ at end of re
3777 ;; (braces "\\\\{[0-9,]+\\\\}"))
3778 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3779 ;; "\\|" class "\\|" braces "\\)*\\'"))
3780 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3781 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3786 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3787 "The default value of separators for `split-string'.
3789 A regexp matching strings of whitespace. May be locale-dependent
3790 \(as yet unimplemented). Should not match non-breaking spaces.
3792 Warning: binding this to a different value and using it as default is
3793 likely to have undesired semantics.")
3795 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3796 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3797 ;; expression leads to the equivalent implementation that if SEPARATORS
3798 ;; is defaulted, OMIT-NULLS is treated as t.
3799 (defun split-string (string &optional separators omit-nulls trim)
3800 "Split STRING into substrings bounded by matches for SEPARATORS.
3802 The beginning and end of STRING, and each match for SEPARATORS, are
3803 splitting points. The substrings matching SEPARATORS are removed, and
3804 the substrings between the splitting points are collected as a list,
3807 If SEPARATORS is non-nil, it should be a regular expression matching text
3808 which separates, but is not part of, the substrings. If nil it defaults to
3809 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3810 OMIT-NULLS is forced to t.
3812 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3813 that for the default value of SEPARATORS leading and trailing whitespace
3814 are effectively trimmed). If nil, all zero-length substrings are retained,
3815 which correctly parses CSV format, for example.
3817 If TRIM is non-nil, it should be a regular expression to match
3818 text to trim from the beginning and end of each substring. If trimming
3819 makes the substring empty, it is treated as null.
3821 If you want to trim whitespace from the substrings, the reliably correct
3822 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3823 results when there is whitespace at the start or end of STRING. If you
3824 see such calls to `split-string', please fix them.
3826 Note that the effect of `(split-string STRING)' is the same as
3827 `(split-string STRING split-string-default-separators t)'. In the rare
3828 case that you wish to retain zero-length substrings when splitting on
3829 whitespace, use `(split-string STRING split-string-default-separators)'.
3831 Modifies the match data; use `save-match-data' if necessary."
3832 (let* ((keep-nulls (not (if separators omit-nulls t)))
3833 (rexp (or separators split-string-default-separators))
3839 ;; Push the substring in range THIS-START to THIS-END
3840 ;; onto LIST, trimming it and perhaps discarding it.
3843 ;; Discard the trim from start of this substring.
3844 (let ((tem (string-match trim string this-start)))
3845 (and (eq tem this-start)
3846 (setq this-start (match-end 0)))))
3848 (when (or keep-nulls (< this-start this-end))
3849 (let ((this (substring string this-start this-end)))
3851 ;; Discard the trim from end of this substring.
3853 (let ((tem (string-match (concat trim "\\'") this 0)))
3854 (and tem (< tem (length this))
3855 (setq this (substring this 0 tem)))))
3857 ;; Trimming could make it empty; check again.
3858 (when (or keep-nulls (> (length this) 0))
3859 (push this list)))))))
3861 (while (and (string-match rexp string
3863 (= start (match-beginning 0))
3864 (< start (length string)))
3866 (< start (length string)))
3868 (setq this-start start this-end (match-beginning 0)
3869 start (match-end 0))
3873 ;; Handle the substring at the end of STRING.
3874 (setq this-start start this-end (length string))
3879 (defun combine-and-quote-strings (strings &optional separator)
3880 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3881 This tries to quote the strings to avoid ambiguity such that
3882 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3883 Only some SEPARATORs will work properly.
3885 Note that this is not intended to protect STRINGS from
3886 interpretation by shells, use `shell-quote-argument' for that."
3887 (let* ((sep (or separator " "))
3888 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3891 (if (string-match re str)
3892 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3896 (defun split-string-and-unquote (string &optional separator)
3897 "Split the STRING into a list of strings.
3898 It understands Emacs Lisp quoting within STRING, such that
3899 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3900 The SEPARATOR regexp defaults to \"\\s-+\"."
3901 (let ((sep (or separator "\\s-+"))
3902 (i (string-match "\"" string)))
3904 (split-string string sep t) ; no quoting: easy
3905 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3906 (let ((rfs (read-from-string string i)))
3908 (split-string-and-unquote (substring string (cdr rfs))
3912 ;;;; Replacement in strings.
3914 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3915 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3916 Unless optional argument INPLACE is non-nil, return a new string."
3917 (let ((i (length string))
3918 (newstr (if inplace string (copy-sequence string))))
3921 (if (eq (aref newstr i) fromchar)
3922 (aset newstr i tochar)))
3925 (defun replace-regexp-in-string (regexp rep string &optional
3926 fixedcase literal subexp start)
3927 "Replace all matches for REGEXP with REP in STRING.
3929 Return a new string containing the replacements.
3931 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3932 arguments with the same names of function `replace-match'. If START
3933 is non-nil, start replacements at that index in STRING.
3935 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3936 function. If it is a function, it is called with the actual text of each
3937 match, and its value is used as the replacement text. When REP is called,
3938 the match data are the result of matching REGEXP against a substring
3939 of STRING, the same substring that is the actual text of the match which
3940 is passed to REP as its argument.
3942 To replace only the first match (if any), make REGEXP match up to \\\\='
3943 and replace a sub-expression, e.g.
3944 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\\\='\" \"bar\" \" foo foo\" nil nil 1)
3947 ;; To avoid excessive consing from multiple matches in long strings,
3948 ;; don't just call `replace-match' continually. Walk down the
3949 ;; string looking for matches of REGEXP and building up a (reversed)
3950 ;; list MATCHES. This comprises segments of STRING which weren't
3951 ;; matched interspersed with replacements for segments that were.
3952 ;; [For a `large' number of replacements it's more efficient to
3953 ;; operate in a temporary buffer; we can't tell from the function's
3954 ;; args whether to choose the buffer-based implementation, though it
3955 ;; might be reasonable to do so for long enough STRING.]
3956 (let ((l (length string))
3957 (start (or start 0))
3960 (while (and (< start l) (string-match regexp string start))
3961 (setq mb (match-beginning 0)
3963 ;; If we matched the empty string, make sure we advance by one char
3964 (when (= me mb) (setq me (min l (1+ mb))))
3965 ;; Generate a replacement for the matched substring.
3966 ;; Operate only on the substring to minimize string consing.
3967 ;; Set up match data for the substring for replacement;
3968 ;; presumably this is likely to be faster than munging the
3969 ;; match data directly in Lisp.
3970 (string-match regexp (setq str (substring string mb me)))
3972 (cons (replace-match (if (stringp rep)
3974 (funcall rep (match-string 0 str)))
3975 fixedcase literal str subexp)
3976 (cons (substring string start mb) ; unmatched prefix
3979 ;; Reconstruct a string from the pieces.
3980 (setq matches (cons (substring string start l) matches)) ; leftover
3981 (apply #'concat (nreverse matches)))))
3983 (defun string-prefix-p (prefix string &optional ignore-case)
3984 "Return non-nil if PREFIX is a prefix of STRING.
3985 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3986 to case differences."
3987 (let ((prefix-length (length prefix)))
3988 (if (> prefix-length (length string)) nil
3989 (eq t (compare-strings prefix 0 prefix-length string
3990 0 prefix-length ignore-case)))))
3992 (defun string-suffix-p (suffix string &optional ignore-case)
3993 "Return non-nil if SUFFIX is a suffix of STRING.
3994 If IGNORE-CASE is non-nil, the comparison is done without paying
3995 attention to case differences."
3996 (let ((start-pos (- (length string) (length suffix))))
3997 (and (>= start-pos 0)
3998 (eq t (compare-strings suffix nil nil
3999 string start-pos nil ignore-case)))))
4001 (defun bidi-string-mark-left-to-right (str)
4002 "Return a string that can be safely inserted in left-to-right text.
4004 Normally, inserting a string with right-to-left (RTL) script into
4005 a buffer may cause some subsequent text to be displayed as part
4006 of the RTL segment (usually this affects punctuation characters).
4007 This function returns a string which displays as STR but forces
4008 subsequent text to be displayed as left-to-right.
4010 If STR contains any RTL character, this function returns a string
4011 consisting of STR followed by an invisible left-to-right mark
4012 \(LRM) character. Otherwise, it returns STR."
4013 (unless (stringp str)
4014 (signal 'wrong-type-argument (list 'stringp str)))
4015 (if (string-match "\\cR" str)
4016 (concat str (propertize (string ?\x200e) 'invisible t))
4019 (defun string-greaterp (string1 string2)
4020 "Return non-nil if STRING1 is greater than STRING2 in lexicographic order.
4021 Case is significant.
4022 Symbols are also allowed; their print names are used instead."
4023 (string-lessp string2 string1))
4026 ;;;; Specifying things to do later.
4028 (defun load-history-regexp (file)
4029 "Form a regexp to find FILE in `load-history'.
4030 FILE, a string, is described in the function `eval-after-load'."
4031 (if (file-name-absolute-p file)
4032 (setq file (file-truename file)))
4033 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
4035 (if (file-name-extension file)
4037 ;; Note: regexp-opt can't be used here, since we need to call
4038 ;; this before Emacs has been fully started. 2006-05-21
4039 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
4040 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
4043 (defun load-history-filename-element (file-regexp)
4044 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
4045 Return nil if there isn't one."
4046 (let* ((loads load-history)
4047 (load-elt (and loads (car loads))))
4050 (or (null (car load-elt))
4051 (not (string-match file-regexp (car load-elt)))))
4052 (setq loads (cdr loads)
4053 load-elt (and loads (car loads)))))
4056 (put 'eval-after-load 'lisp-indent-function 1)
4057 (defun eval-after-load (file form)
4058 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
4059 If FILE is already loaded, evaluate FORM right now.
4060 FORM can be an Elisp expression (in which case it's passed to `eval'),
4061 or a function (in which case it's passed to `funcall' with no argument).
4063 If a matching file is loaded again, FORM will be evaluated again.
4065 If FILE is a string, it may be either an absolute or a relative file
4066 name, and may have an extension (e.g. \".el\") or may lack one, and
4067 additionally may or may not have an extension denoting a compressed
4068 format (e.g. \".gz\").
4070 When FILE is absolute, this first converts it to a true name by chasing
4071 symbolic links. Only a file of this name (see next paragraph regarding
4072 extensions) will trigger the evaluation of FORM. When FILE is relative,
4073 a file whose absolute true name ends in FILE will trigger evaluation.
4075 When FILE lacks an extension, a file name with any extension will trigger
4076 evaluation. Otherwise, its extension must match FILE's. A further
4077 extension for a compressed format (e.g. \".gz\") on FILE will not affect
4080 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
4081 is evaluated at the end of any file that `provide's this feature.
4082 If the feature is provided when evaluating code not associated with a
4083 file, FORM is evaluated immediately after the provide statement.
4085 Usually FILE is just a library name like \"font-lock\" or a feature name
4088 This function makes or adds to an entry on `after-load-alist'."
4089 (declare (compiler-macro
4091 (if (eq 'quote (car-safe form))
4092 ;; Quote with lambda so the compiler can look inside.
4093 `(eval-after-load ,file (lambda () ,(nth 1 form)))
4095 ;; Add this FORM into after-load-alist (regardless of whether we'll be
4096 ;; evaluating it now).
4097 (let* ((regexp-or-feature
4099 (setq file (purecopy (load-history-regexp file)))
4101 (elt (assoc regexp-or-feature after-load-alist))
4103 (if (functionp form) form
4104 ;; Try to use the "current" lexical/dynamic mode for `form'.
4105 (eval `(lambda () ,form) lexical-binding))))
4107 (setq elt (list regexp-or-feature))
4108 (push elt after-load-alist))
4109 ;; Is there an already loaded file whose name (or `provide' name)
4111 (prog1 (if (if (stringp file)
4112 (load-history-filename-element regexp-or-feature)
4116 (if (not (symbolp regexp-or-feature)) func
4117 ;; For features, the after-load-alist elements get run when
4118 ;; `provide' is called rather than at the end of the file.
4119 ;; So add an indirection to make sure that `func' is really run
4120 ;; "after-load" in case the provide call happens early.
4122 (if (not load-file-name)
4123 ;; Not being provided from a file, run func right now.
4125 (let ((lfn load-file-name)
4126 ;; Don't use letrec, because equal (in
4127 ;; add/remove-hook) would get trapped in a cycle.
4128 (fun (make-symbol "eval-after-load-helper")))
4129 (fset fun (lambda (file)
4130 (when (equal file lfn)
4131 (remove-hook 'after-load-functions fun)
4133 (add-hook 'after-load-functions fun 'append)))))))
4134 ;; Add FORM to the element unless it's already there.
4135 (unless (member delayed-func (cdr elt))
4136 (nconc elt (list delayed-func)))))))
4138 (defmacro with-eval-after-load (file &rest body)
4139 "Execute BODY after FILE is loaded.
4140 FILE is normally a feature name, but it can also be a file name,
4141 in case that file does not provide any feature. See `eval-after-load'
4142 for more details about the different forms of FILE and their semantics."
4143 (declare (indent 1) (debug t))
4144 `(eval-after-load ,file (lambda () ,@body)))
4146 (defvar after-load-functions nil
4147 "Special hook run after loading a file.
4148 Each function there is called with a single argument, the absolute
4149 name of the file just loaded.")
4151 (defun do-after-load-evaluation (abs-file)
4152 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
4153 ABS-FILE, a string, should be the absolute true name of a file just loaded.
4154 This function is called directly from the C code."
4155 ;; Run the relevant eval-after-load forms.
4156 (dolist (a-l-element after-load-alist)
4157 (when (and (stringp (car a-l-element))
4158 (string-match-p (car a-l-element) abs-file))
4159 ;; discard the file name regexp
4160 (mapc #'funcall (cdr a-l-element))))
4161 ;; Complain when the user uses obsolete files.
4162 (when (string-match-p "/obsolete/\\([^/]*\\)\\'" abs-file)
4163 ;; Maybe we should just use display-warning? This seems yucky...
4164 (let* ((file (file-name-nondirectory abs-file))
4165 (msg (format "Package %s is obsolete!"
4167 (string-match "\\.elc?\\>" file)))))
4168 ;; Cribbed from cl--compiling-file.
4169 (if (and (boundp 'byte-compile--outbuffer)
4170 (bufferp (symbol-value 'byte-compile--outbuffer))
4171 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
4172 " *Compiler Output*"))
4173 ;; Don't warn about obsolete files using other obsolete files.
4174 (unless (and (stringp byte-compile-current-file)
4175 (string-match-p "/obsolete/[^/]*\\'"
4177 byte-compile-current-file
4178 byte-compile-root-dir)))
4179 (byte-compile-warn "%s" msg))
4180 (run-with-timer 0 nil
4185 ;; Finally, run any other hook.
4186 (run-hook-with-args 'after-load-functions abs-file))
4188 (defun eval-next-after-load (file)
4189 "Read the following input sexp, and run it whenever FILE is loaded.
4190 This makes or adds to an entry on `after-load-alist'.
4191 FILE should be the name of a library, with no directory name."
4192 (declare (obsolete eval-after-load "23.2"))
4193 (eval-after-load file (read)))
4196 (defun display-delayed-warnings ()
4197 "Display delayed warnings from `delayed-warnings-list'.
4198 Used from `delayed-warnings-hook' (which see)."
4199 (dolist (warning (nreverse delayed-warnings-list))
4200 (apply 'display-warning warning))
4201 (setq delayed-warnings-list nil))
4203 (defun collapse-delayed-warnings ()
4204 "Remove duplicates from `delayed-warnings-list'.
4205 Collapse identical adjacent warnings into one (plus count).
4206 Used from `delayed-warnings-hook' (which see)."
4209 (while delayed-warnings-list
4210 (setq warning (pop delayed-warnings-list))
4211 (if (equal warning (car delayed-warnings-list))
4212 (setq count (1+ count))
4214 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
4217 (push warning collapsed)))
4218 (setq delayed-warnings-list (nreverse collapsed))))
4220 ;; At present this is only used for Emacs internals.
4221 ;; Ref https://lists.gnu.org/r/emacs-devel/2012-02/msg00085.html
4222 (defvar delayed-warnings-hook '(collapse-delayed-warnings
4223 display-delayed-warnings)
4224 "Normal hook run to process and display delayed warnings.
4225 By default, this hook contains functions to consolidate the
4226 warnings listed in `delayed-warnings-list', display them, and set
4227 `delayed-warnings-list' back to nil.")
4229 (defun delay-warning (type message &optional level buffer-name)
4230 "Display a delayed warning.
4231 Aside from going through `delayed-warnings-list', this is equivalent
4232 to `display-warning'."
4233 (push (list type message level buffer-name) delayed-warnings-list))
4236 ;;;; invisibility specs
4238 (defun add-to-invisibility-spec (element)
4239 "Add ELEMENT to `buffer-invisibility-spec'.
4240 See documentation for `buffer-invisibility-spec' for the kind of elements
4242 (if (eq buffer-invisibility-spec t)
4243 (setq buffer-invisibility-spec (list t)))
4244 (setq buffer-invisibility-spec
4245 (cons element buffer-invisibility-spec)))
4247 (defun remove-from-invisibility-spec (element)
4248 "Remove ELEMENT from `buffer-invisibility-spec'."
4249 (setq buffer-invisibility-spec
4250 (if (consp buffer-invisibility-spec)
4251 (delete element buffer-invisibility-spec)
4256 (defmacro with-syntax-table (table &rest body)
4257 "Evaluate BODY with syntax table of current buffer set to TABLE.
4258 The syntax table of the current buffer is saved, BODY is evaluated, and the
4259 saved table is restored, even in case of an abnormal exit.
4260 Value is what BODY returns."
4261 (declare (debug t) (indent 1))
4262 (let ((old-table (make-symbol "table"))
4263 (old-buffer (make-symbol "buffer")))
4264 `(let ((,old-table (syntax-table))
4265 (,old-buffer (current-buffer)))
4268 (set-syntax-table ,table)
4270 (save-current-buffer
4271 (set-buffer ,old-buffer)
4272 (set-syntax-table ,old-table))))))
4274 (defun make-syntax-table (&optional oldtable)
4275 "Return a new syntax table.
4276 Create a syntax table which inherits from OLDTABLE (if non-nil) or
4277 from `standard-syntax-table' otherwise."
4278 (let ((table (make-char-table 'syntax-table nil)))
4279 (set-char-table-parent table (or oldtable (standard-syntax-table)))
4282 (defun syntax-after (pos)
4283 "Return the raw syntax descriptor for the char after POS.
4284 If POS is outside the buffer's accessible portion, return nil."
4285 (unless (or (< pos (point-min)) (>= pos (point-max)))
4286 (let ((st (if parse-sexp-lookup-properties
4287 (get-char-property pos 'syntax-table))))
4289 (aref (or st (syntax-table)) (char-after pos))))))
4291 (defun syntax-class (syntax)
4292 "Return the code for the syntax class described by SYNTAX.
4294 SYNTAX should be a raw syntax descriptor; the return value is a
4295 integer which encodes the corresponding syntax class. See Info
4296 node `(elisp)Syntax Table Internals' for a list of codes.
4298 If SYNTAX is nil, return nil."
4299 (and syntax (logand (car syntax) 65535)))
4301 ;; Utility motion commands
4303 (defvar word-move-empty-char-table nil
4304 "Used in `forward-word-strictly' and `backward-word-strictly'
4305 to countermand the effect of `find-word-boundary-function-table'.")
4307 (defun forward-word-strictly (&optional arg)
4308 "Move point forward ARG words (backward if ARG is negative).
4309 If ARG is omitted or nil, move point forward one word.
4311 If an edge of the buffer or a field boundary is reached, point is left there
4312 and the function returns nil. Field boundaries are not noticed if
4313 `inhibit-field-text-motion' is non-nil.
4315 This function is like `forward-word', but it is not affected
4316 by `find-word-boundary-function-table'. It is also not interactive."
4317 (let ((find-word-boundary-function-table
4318 (if (char-table-p word-move-empty-char-table)
4319 word-move-empty-char-table
4320 (setq word-move-empty-char-table (make-char-table nil)))))
4321 (forward-word (or arg 1))))
4323 (defun backward-word-strictly (&optional arg)
4324 "Move backward until encountering the beginning of a word.
4325 With argument ARG, do this that many times.
4326 If ARG is omitted or nil, move point backward one word.
4328 This function is like `forward-word', but it is not affected
4329 by `find-word-boundary-function-table'. It is also not interactive."
4330 (let ((find-word-boundary-function-table
4331 (if (char-table-p word-move-empty-char-table)
4332 word-move-empty-char-table
4333 (setq word-move-empty-char-table (make-char-table nil)))))
4334 (forward-word (- (or arg 1)))))
4338 (defun forward-whitespace (arg)
4339 "Move point to the end of the next sequence of whitespace chars.
4340 Each such sequence may be a single newline, or a sequence of
4341 consecutive space and/or tab characters.
4342 With prefix argument ARG, do it ARG times if positive, or move
4343 backwards ARG times if negative."
4346 (re-search-forward "[ \t]+\\|\n" nil 'move arg)
4348 (if (re-search-backward "[ \t]+\\|\n" nil 'move)
4349 (or (eq (char-after (match-beginning 0)) ?\n)
4350 (skip-chars-backward " \t")))
4351 (setq arg (1+ arg)))))
4355 (defun forward-symbol (arg)
4356 "Move point to the next position that is the end of a symbol.
4357 A symbol is any sequence of characters that are in either the
4358 word constituent or symbol constituent syntax class.
4359 With prefix argument ARG, do it ARG times if positive, or move
4360 backwards ARG times if negative."
4363 (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
4365 (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
4366 (skip-syntax-backward "w_"))
4367 (setq arg (1+ arg)))))
4371 (defun forward-same-syntax (&optional arg)
4372 "Move point past all characters with the same syntax class.
4373 With prefix argument ARG, do it ARG times if positive, or move
4374 backwards ARG times if negative."
4376 (or arg (setq arg 1))
4378 (skip-syntax-backward
4379 (char-to-string (char-syntax (char-before))))
4380 (setq arg (1+ arg)))
4382 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4383 (setq arg (1- arg))))
4388 (defvar text-clone--maintaining nil)
4390 (defun text-clone--maintain (ol1 after beg end &optional _len)
4391 "Propagate the changes made under the overlay OL1 to the other clones.
4392 This is used on the `modification-hooks' property of text clones."
4393 (when (and after (not undo-in-progress)
4394 (not text-clone--maintaining)
4395 (overlay-start ol1))
4396 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4397 (setq beg (max beg (+ (overlay-start ol1) margin)))
4398 (setq end (min end (- (overlay-end ol1) margin)))
4401 (when (overlay-get ol1 'text-clone-syntax)
4402 ;; Check content of the clone's text.
4403 (let ((cbeg (+ (overlay-start ol1) margin))
4404 (cend (- (overlay-end ol1) margin)))
4407 (if (not (re-search-forward
4408 (overlay-get ol1 'text-clone-syntax) cend t))
4409 ;; Mark the overlay for deletion.
4411 (when (< (match-end 0) cend)
4412 ;; Shrink the clone at its end.
4413 (setq end (min end (match-end 0)))
4414 (move-overlay ol1 (overlay-start ol1)
4415 (+ (match-end 0) margin)))
4416 (when (> (match-beginning 0) cbeg)
4417 ;; Shrink the clone at its beginning.
4418 (setq beg (max (match-beginning 0) beg))
4419 (move-overlay ol1 (- (match-beginning 0) margin)
4420 (overlay-end ol1)))))))
4421 ;; Now go ahead and update the clones.
4422 (let ((head (- beg (overlay-start ol1)))
4423 (tail (- (overlay-end ol1) end))
4424 (str (buffer-substring beg end))
4426 (text-clone--maintaining t))
4427 (dolist (ol2 (overlay-get ol1 'text-clones))
4428 (let ((oe (overlay-end ol2)))
4429 (unless (or (eq ol1 ol2) (null oe))
4430 (setq nothing-left nil)
4431 (let ((mod-beg (+ (overlay-start ol2) head)))
4432 ;;(overlay-put ol2 'modification-hooks nil)
4433 (goto-char (- (overlay-end ol2) tail))
4434 (unless (> mod-beg (point))
4435 (save-excursion (insert str))
4436 (delete-region mod-beg (point)))
4437 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4439 (if nothing-left (delete-overlay ol1))))))))
4441 (defun text-clone-create (start end &optional spreadp syntax)
4442 "Create a text clone of START...END at point.
4443 Text clones are chunks of text that are automatically kept identical:
4444 changes done to one of the clones will be immediately propagated to the other.
4446 The buffer's content at point is assumed to be already identical to
4447 the one between START and END.
4448 If SYNTAX is provided it's a regexp that describes the possible text of
4449 the clones; the clone will be shrunk or killed if necessary to ensure that
4450 its text matches the regexp.
4451 If SPREADP is non-nil it indicates that text inserted before/after the
4452 clone should be incorporated in the clone."
4453 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4454 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4455 ;; (with a one-char margin at each end) with `t nil'.
4456 ;; We opted for a larger overlay because it behaves better in the case
4457 ;; where the clone is reduced to the empty string (we want the overlay to
4458 ;; stay when the clone's content is the empty string and we want to use
4459 ;; `evaporate' to make sure those overlays get deleted when needed).
4461 (let* ((pt-end (+ (point) (- end start)))
4462 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4464 (end-margin (if (or (not spreadp)
4465 (>= pt-end (point-max))
4466 (>= start (point-max)))
4468 ;; FIXME: Reuse overlays at point to extend dups!
4469 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4470 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4471 (dups (list ol1 ol2)))
4472 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4473 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4474 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4475 ;;(overlay-put ol1 'face 'underline)
4476 (overlay-put ol1 'evaporate t)
4477 (overlay-put ol1 'text-clones dups)
4479 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4480 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4481 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4482 ;;(overlay-put ol2 'face 'underline)
4483 (overlay-put ol2 'evaporate t)
4484 (overlay-put ol2 'text-clones dups)))
4486 ;;;; Mail user agents.
4488 ;; Here we include just enough for other packages to be able
4491 (defun define-mail-user-agent (symbol composefunc sendfunc
4492 &optional abortfunc hookvar)
4493 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4495 SYMBOL can be any Lisp symbol. Its function definition and/or
4496 value as a variable do not matter for this usage; we use only certain
4497 properties on its property list, to encode the rest of the arguments.
4499 COMPOSEFUNC is program callable function that composes an outgoing
4500 mail message buffer. This function should set up the basics of the
4501 buffer without requiring user interaction. It should populate the
4502 standard mail headers, leaving the `to:' and `subject:' headers blank
4505 COMPOSEFUNC should accept several optional arguments--the same
4506 arguments that `compose-mail' takes. See that function's documentation.
4508 SENDFUNC is the command a user would run to send the message.
4510 Optional ABORTFUNC is the command a user would run to abort the
4511 message. For mail packages that don't have a separate abort function,
4512 this can be `kill-buffer' (the equivalent of omitting this argument).
4514 Optional HOOKVAR is a hook variable that gets run before the message
4515 is actually sent. Callers that use the `mail-user-agent' may
4516 install a hook function temporarily on this hook variable.
4517 If HOOKVAR is nil, `mail-send-hook' is used.
4519 The properties used on SYMBOL are `composefunc', `sendfunc',
4520 `abortfunc', and `hookvar'."
4521 (put symbol 'composefunc composefunc)
4522 (put symbol 'sendfunc sendfunc)
4523 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4524 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4527 (defun backtrace--print-frame (evald func args flags)
4528 "Print a trace of a single stack frame to `standard-output'.
4529 EVALD, FUNC, ARGS, FLAGS are as in `mapbacktrace'."
4530 (princ (if (plist-get flags :debug-on-exit) "* " " "))
4532 ((and evald (not debugger-stack-frame-as-list))
4534 (if args (prin1 args) (princ "()")))
4536 (prin1 (cons func args))))
4540 "Print a trace of Lisp function calls currently active.
4541 Output stream used is value of `standard-output'."
4542 (let ((print-level (or print-level 8))
4543 (print-escape-control-characters t))
4544 (mapbacktrace #'backtrace--print-frame 'backtrace)))
4546 (defun backtrace-frames (&optional base)
4547 "Collect all frames of current backtrace into a list.
4548 If non-nil, BASE should be a function, and frames before its
4549 nearest activation frames are discarded."
4551 (mapbacktrace (lambda (&rest frame) (push frame frames))
4552 (or base 'backtrace-frames))
4555 (defun backtrace-frame (nframes &optional base)
4556 "Return the function and arguments NFRAMES up from current execution point.
4557 If non-nil, BASE should be a function, and NFRAMES counts from its
4558 nearest activation frame.
4559 If the frame has not evaluated the arguments yet (or is a special form),
4560 the value is (nil FUNCTION ARG-FORMS...).
4561 If the frame has evaluated its arguments and called its function already,
4562 the value is (t FUNCTION ARG-VALUES...).
4563 A &rest arg is represented as the tail of the list ARG-VALUES.
4564 FUNCTION is whatever was supplied as car of evaluated list,
4565 or a lambda expression for macro calls.
4566 If NFRAMES is more than the number of frames, the value is nil."
4567 (backtrace-frame--internal
4568 (lambda (evald func args _) `(,evald ,func ,@args))
4569 nframes (or base 'backtrace-frame)))
4572 (defvar called-interactively-p-functions nil
4573 "Special hook called to skip special frames in `called-interactively-p'.
4574 The functions are called with 3 arguments: (I FRAME1 FRAME2),
4575 where FRAME1 is a \"current frame\", FRAME2 is the next frame,
4576 I is the index of the frame after FRAME2. It should return nil
4577 if those frames don't seem special and otherwise, it should return
4578 the number of frames to skip (minus 1).")
4580 (defconst internal--funcall-interactively
4581 (symbol-function 'funcall-interactively))
4583 (defun called-interactively-p (&optional kind)
4584 "Return t if the containing function was called by `call-interactively'.
4585 If KIND is `interactive', then only return t if the call was made
4586 interactively by the user, i.e. not in `noninteractive' mode nor
4587 when `executing-kbd-macro'.
4588 If KIND is `any', on the other hand, it will return t for any kind of
4589 interactive call, including being called as the binding of a key or
4590 from a keyboard macro, even in `noninteractive' mode.
4592 This function is very brittle, it may fail to return the intended result when
4593 the code is debugged, advised, or instrumented in some form. Some macros and
4594 special forms (such as `condition-case') may also sometimes wrap their bodies
4595 in a `lambda', so any call to `called-interactively-p' from those bodies will
4596 indicate whether that lambda (rather than the surrounding function) was called
4599 Instead of using this function, it is cleaner and more reliable to give your
4600 function an extra optional argument whose `interactive' spec specifies
4601 non-nil unconditionally (\"p\" is a good way to do this), or via
4602 \(not (or executing-kbd-macro noninteractive)).
4604 The only known proper use of `interactive' for KIND is in deciding
4605 whether to display a helpful message, or how to display it. If you're
4606 thinking of using it for any other purpose, it is quite likely that
4607 you're making a mistake. Think: what do you want to do when the
4608 command is called from a keyboard macro?"
4609 (declare (advertised-calling-convention (kind) "23.1"))
4610 (when (not (and (eq kind 'interactive)
4611 (or executing-kbd-macro noninteractive)))
4612 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4616 (setq frame nextframe)
4617 (setq nextframe (backtrace-frame i 'called-interactively-p))
4618 ;; (message "Frame %d = %S" i nextframe)
4620 (funcall get-next-frame) ;; Get the first frame.
4622 ;; FIXME: The edebug and advice handling should be made modular and
4623 ;; provided directly by edebug.el and nadvice.el.
4625 ;; frame =(backtrace-frame i-2)
4626 ;; nextframe=(backtrace-frame i-1)
4627 (funcall get-next-frame)
4628 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4629 ;; branches within local functions, which then messes up the
4630 ;; `backtrace-frame' data we get,
4632 ;; Skip special forms (from non-compiled code).
4633 (and frame (null (car frame)))
4634 ;; Skip also `interactive-p' (because we don't want to know if
4635 ;; interactive-p was called interactively but if it's caller was)
4636 ;; and `byte-code' (idem; this appears in subexpressions of things
4637 ;; like condition-case, which are wrapped in a separate bytecode
4639 ;; FIXME: For lexical-binding code, this is much worse,
4640 ;; because the frames look like "byte-code -> funcall -> #[...]",
4641 ;; which is not a reliable signature.
4642 (memq (nth 1 frame) '(interactive-p 'byte-code))
4643 ;; Skip package-specific stack-frames.
4644 (let ((skip (run-hook-with-args-until-success
4645 'called-interactively-p-functions
4646 i frame nextframe)))
4650 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4651 ;; Now `frame' should be "the function from which we were called".
4652 (pcase (cons frame nextframe)
4653 ;; No subr calls `interactive-p', so we can rule that out.
4654 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
4655 ;; In case #<subr funcall-interactively> without going through the
4656 ;; `funcall-interactively' symbol (bug#3984).
4657 (`(,_ . (t ,(pred (lambda (f)
4658 (eq internal--funcall-interactively
4659 (indirect-function f))))
4663 (defun interactive-p ()
4664 "Return t if the containing function was run directly by user input.
4665 This means that the function was called with `call-interactively'
4666 \(which includes being called as the binding of a key)
4667 and input is currently coming from the keyboard (not a keyboard macro),
4668 and Emacs is not running in batch mode (`noninteractive' is nil).
4670 The only known proper use of `interactive-p' is in deciding whether to
4671 display a helpful message, or how to display it. If you're thinking
4672 of using it for any other purpose, it is quite likely that you're
4673 making a mistake. Think: what do you want to do when the command is
4674 called from a keyboard macro or in batch mode?
4676 To test whether your function was called with `call-interactively',
4677 either (i) add an extra optional argument and give it an `interactive'
4678 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
4679 use `called-interactively-p'.
4681 To test whether a function can be called interactively, use
4683 (declare (obsolete called-interactively-p "23.2"))
4684 (called-interactively-p 'interactive))
4686 (defun internal-push-keymap (keymap symbol)
4687 (let ((map (symbol-value symbol)))
4688 (unless (memq keymap map)
4689 (unless (memq 'add-keymap-witness (symbol-value symbol))
4690 (setq map (make-composed-keymap nil (symbol-value symbol)))
4691 (push 'add-keymap-witness (cdr map))
4693 (push keymap (cdr map)))))
4695 (defun internal-pop-keymap (keymap symbol)
4696 (let ((map (symbol-value symbol)))
4697 (when (memq keymap map)
4698 (setf (cdr map) (delq keymap (cdr map))))
4699 (let ((tail (cddr map)))
4700 (and (or (null tail) (keymapp tail))
4701 (eq 'add-keymap-witness (nth 1 map))
4702 (set symbol tail)))))
4704 (define-obsolete-function-alias
4705 'set-temporary-overlay-map 'set-transient-map "24.4")
4707 (defun set-transient-map (map &optional keep-pred on-exit)
4708 "Set MAP as a temporary keymap taking precedence over other keymaps.
4709 Normally, MAP is used only once, to look up the very next key.
4710 However, if the optional argument KEEP-PRED is t, MAP stays
4711 active if a key from MAP is used. KEEP-PRED can also be a
4712 function of no arguments: it is called from `pre-command-hook' and
4713 if it returns non-nil, then MAP stays active.
4715 Optional arg ON-EXIT, if non-nil, specifies a function that is
4716 called, with no arguments, after MAP is deactivated.
4718 This uses `overriding-terminal-local-map' which takes precedence over all other
4719 keymaps. As usual, if no match for a key is found in MAP, the normal key
4720 lookup sequence then continues.
4722 This returns an \"exit function\", which can be called with no argument
4723 to deactivate this transient map, regardless of KEEP-PRED."
4724 (let* ((clearfun (make-symbol "clear-transient-map"))
4727 (internal-pop-keymap map 'overriding-terminal-local-map)
4728 (remove-hook 'pre-command-hook clearfun)
4729 (when on-exit (funcall on-exit)))))
4730 ;; Don't use letrec, because equal (in add/remove-hook) would get trapped
4734 (with-demoted-errors "set-transient-map PCH: %S"
4736 ((null keep-pred) nil)
4737 ((and (not (eq map (cadr overriding-terminal-local-map)))
4738 (memq map (cddr overriding-terminal-local-map)))
4739 ;; There's presumably some other transient-map in
4740 ;; effect. Wait for that one to terminate before we
4741 ;; remove ourselves.
4742 ;; For example, if isearch and C-u both use transient
4743 ;; maps, then the lifetime of the C-u should be nested
4744 ;; within isearch's, so the pre-command-hook of
4745 ;; isearch should be suspended during the C-u one so
4746 ;; we don't exit isearch just because we hit 1 after
4747 ;; C-u and that 1 exits isearch whereas it doesn't
4751 (let ((mc (lookup-key map (this-command-keys-vector))))
4752 ;; If the key is unbound `this-command` is
4753 ;; nil and so is `mc`.
4754 (and mc (eq this-command mc))))
4755 (t (funcall keep-pred)))
4756 (funcall exitfun)))))
4757 (add-hook 'pre-command-hook clearfun)
4758 (internal-push-keymap map 'overriding-terminal-local-map)
4761 ;;;; Progress reporters.
4763 ;; Progress reporter has the following structure:
4765 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4772 ;; This weirdness is for optimization reasons: we want
4773 ;; `progress-reporter-update' to be as fast as possible, so
4774 ;; `(car reporter)' is better than `(aref reporter 0)'.
4776 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4777 ;; digits of precision, it doesn't really matter here. On the other
4778 ;; hand, it greatly simplifies the code.
4780 (defsubst progress-reporter-update (reporter &optional value)
4781 "Report progress of an operation in the echo area.
4782 REPORTER should be the result of a call to `make-progress-reporter'.
4784 If REPORTER is a numerical progress reporter---i.e. if it was
4785 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4786 `make-progress-reporter'---then VALUE should be a number between
4787 MIN-VALUE and MAX-VALUE.
4789 If REPORTER is a non-numerical reporter, VALUE should be nil.
4791 This function is relatively inexpensive. If the change since
4792 last update is too small or insufficient time has passed, it does
4794 (when (or (not (numberp value)) ; For pulsing reporter
4795 (>= value (car reporter))) ; For numerical reporter
4796 (progress-reporter-do-update reporter value)))
4798 (defun make-progress-reporter (message &optional min-value max-value
4799 current-value min-change min-time)
4800 "Return progress reporter object for use with `progress-reporter-update'.
4802 MESSAGE is shown in the echo area, with a status indicator
4803 appended to the end. When you call `progress-reporter-done', the
4804 word \"done\" is printed after the MESSAGE. You can change the
4805 MESSAGE of an existing progress reporter by calling
4806 `progress-reporter-force-update'.
4808 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4809 and final (100% complete) states of operation; the latter should
4810 be larger. In this case, the status message shows the percentage
4813 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4814 message shows a \"spinning\", non-numeric indicator.
4816 Optional CURRENT-VALUE is the initial progress; the default is
4818 Optional MIN-CHANGE is the minimal change in percents to report;
4820 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4821 and/or MAX-VALUE are nil.
4823 Optional MIN-TIME specifies the minimum interval time between
4824 echo area updates (default is 0.2 seconds.) If the OS is not
4825 capable of measuring fractions of seconds, this parameter is
4826 effectively rounded up."
4827 (when (string-match "[[:alnum:]]\\'" message)
4828 (setq message (concat message "...")))
4830 (setq min-time 0.2))
4832 ;; Force a call to `message' now
4833 (cons (or min-value 0)
4834 (vector (if (>= min-time 0.02)
4839 (if min-change (max (min min-change 50) 1) 1)
4841 (progress-reporter-update reporter (or current-value min-value))
4844 (defun progress-reporter-force-update (reporter &optional value new-message)
4845 "Report progress of an operation in the echo area unconditionally.
4847 The first two arguments are the same as in `progress-reporter-update'.
4848 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4849 (let ((parameters (cdr reporter)))
4851 (aset parameters 3 new-message))
4852 (when (aref parameters 0)
4853 (aset parameters 0 (float-time)))
4854 (progress-reporter-do-update reporter value)))
4856 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4857 "Characters to use for pulsing progress reporters.")
4859 (defun progress-reporter-do-update (reporter value)
4860 (let* ((parameters (cdr reporter))
4861 (update-time (aref parameters 0))
4862 (min-value (aref parameters 1))
4863 (max-value (aref parameters 2))
4864 (text (aref parameters 3))
4866 ;; See if enough time has passed since the last update.
4867 (or (not update-time)
4868 (when (>= (float-time) update-time)
4869 ;; Calculate time for the next update
4870 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4871 (cond ((and min-value max-value)
4872 ;; Numerical indicator
4873 (let* ((one-percent (/ (- max-value min-value) 100.0))
4874 (percentage (if (= max-value min-value)
4876 (truncate (/ (- value min-value)
4878 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4879 ;; message because not enough time has passed, use 1
4880 ;; instead of MIN-CHANGE. This makes delays between echo
4881 ;; area updates closer to MIN-TIME.
4883 (min (+ min-value (* (+ percentage
4884 (if enough-time-passed
4890 (when (integerp value)
4891 (setcar reporter (ceiling (car reporter))))
4892 ;; Only print message if enough time has passed
4893 (when enough-time-passed
4894 (if (> percentage 0)
4895 (message "%s%d%%" text percentage)
4896 (message "%s" text)))))
4897 ;; Pulsing indicator
4899 (let ((index (mod (1+ (car reporter)) 4))
4900 (message-log-max nil))
4901 (setcar reporter index)
4904 (aref progress-reporter--pulse-characters
4907 (defun progress-reporter-done (reporter)
4908 "Print reporter's message followed by word \"done\" in echo area."
4909 (message "%sdone" (aref (cdr reporter) 3)))
4911 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4912 "Loop a certain number of times and report progress in the echo area.
4913 Evaluate BODY with VAR bound to successive integers running from
4914 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4915 the return value (nil if RESULT is omitted).
4917 At each iteration MESSAGE followed by progress percentage is
4918 printed in the echo area. After the loop is finished, MESSAGE
4919 followed by word \"done\" is printed. This macro is a
4920 convenience wrapper around `make-progress-reporter' and friends.
4922 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4923 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4924 (let ((temp (make-symbol "--dotimes-temp--"))
4925 (temp2 (make-symbol "--dotimes-temp2--"))
4929 (,(car spec) ,start)
4930 (,temp2 (make-progress-reporter ,message ,start ,end)))
4931 (while (< ,(car spec) ,temp)
4933 (progress-reporter-update ,temp2
4934 (setq ,(car spec) (1+ ,(car spec)))))
4935 (progress-reporter-done ,temp2)
4936 nil ,@(cdr (cdr spec)))))
4939 ;;;; Comparing version strings.
4941 (defconst version-separator "."
4942 "Specify the string used to separate the version elements.
4944 Usually the separator is \".\", but it can be any other string.")
4947 (defconst version-regexp-alist
4948 '(("^[-._+ ]?snapshot$" . -4)
4949 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4951 ;; treat "1.2.3-CVS" as snapshot release
4952 ("^[-._+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4)
4953 ("^[-._+ ]?alpha$" . -3)
4954 ("^[-._+ ]?beta$" . -2)
4955 ("^[-._+ ]?\\(pre\\|rc\\)$" . -1))
4956 "Specify association between non-numeric version and its priority.
4958 This association is used to handle version string like \"1.0pre2\",
4959 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4960 non-numeric part of a version string to an integer. For example:
4962 String Version Integer List Version
4963 \"0.9snapshot\" (0 9 -4)
4964 \"1.0-git\" (1 0 -4)
4965 \"1.0.cvs\" (1 0 -4)
4966 \"1.0pre2\" (1 0 -1 2)
4967 \"1.0PRE2\" (1 0 -1 2)
4968 \"22.8beta3\" (22 8 -2 3)
4969 \"22.8 Beta3\" (22 8 -2 3)
4970 \"0.9alpha1\" (0 9 -3 1)
4971 \"0.9AlphA1\" (0 9 -3 1)
4972 \"0.9 alpha\" (0 9 -3)
4974 Each element has the following form:
4980 REGEXP regexp used to match non-numeric part of a version string.
4981 It should begin with the `^' anchor and end with a `$' to
4982 prevent false hits. Letter-case is ignored while matching
4985 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4988 (defun version-to-list (ver)
4989 "Convert version string VER into a list of integers.
4991 The version syntax is given by the following EBNF:
4993 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4995 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4997 SEPARATOR ::= `version-separator' (which see)
4998 | `version-regexp-alist' (which see).
5000 The NUMBER part is optional if SEPARATOR is a match for an element
5001 in `version-regexp-alist'.
5003 Examples of valid version syntax:
5005 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta 2.4.snapshot .5
5007 Examples of invalid version syntax:
5009 1.0prepre2 1.0..7.5 22.8X3 alpha3.2
5011 Examples of version conversion:
5013 Version String Version as a List of Integers
5015 \"0.9 alpha\" (0 9 -3)
5016 \"0.9AlphA1\" (0 9 -3 1)
5017 \"0.9snapshot\" (0 9 -4)
5018 \"1.0-git\" (1 0 -4)
5019 \"1.0.7.5\" (1 0 7 5)
5020 \"1.0.cvs\" (1 0 -4)
5021 \"1.0PRE2\" (1 0 -1 2)
5022 \"1.0pre2\" (1 0 -1 2)
5023 \"22.8 Beta3\" (22 8 -2 3)
5024 \"22.8beta3\" (22 8 -2 3)
5026 See documentation for `version-separator' and `version-regexp-alist'."
5027 (unless (stringp ver)
5028 (error "Version must be a string"))
5029 ;; Change .x.y to 0.x.y
5030 (if (and (>= (length ver) (length version-separator))
5031 (string-equal (substring ver 0 (length version-separator))
5033 (setq ver (concat "0" ver)))
5034 (unless (string-match-p "^[0-9]" ver)
5035 (error "Invalid version syntax: `%s' (must start with a number)" ver))
5039 (case-fold-search t) ; ignore case in matching
5041 ;; Parse the version-string up to a separator until there are none left
5042 (while (and (setq s (string-match "[0-9]+" ver i))
5044 ;; Add the numeric part to the beginning of the version list;
5045 ;; lst gets reversed at the end
5046 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
5049 ;; handle non-numeric part
5050 (when (and (setq s (string-match "[^0-9]+" ver i))
5052 (setq s (substring ver i (match-end 0))
5054 ;; handle alpha, beta, pre, etc. separator
5055 (unless (string= s version-separator)
5056 (setq al version-regexp-alist)
5057 (while (and al (not (string-match (caar al) s)))
5060 (push (cdar al) lst))
5061 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc., but only if
5062 ;; the letter is the end of the version-string, to avoid
5063 ;; 22.8X3 being valid
5064 ((and (string-match "^[-._+ ]?\\([a-zA-Z]\\)$" s)
5066 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
5068 (t (error "Invalid version syntax: `%s'" ver))))))
5071 (defun version-list-< (l1 l2)
5072 "Return t if L1, a list specification of a version, is lower than L2.
5074 Note that a version specified by the list (1) is equal to (1 0),
5075 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5076 Also, a version given by the list (1) is higher than (1 -1), which in
5077 turn is higher than (1 -2), which is higher than (1 -3)."
5078 (while (and l1 l2 (= (car l1) (car l2)))
5082 ;; l1 not null and l2 not null
5083 ((and l1 l2) (< (car l1) (car l2)))
5084 ;; l1 null and l2 null ==> l1 length = l2 length
5085 ((and (null l1) (null l2)) nil)
5086 ;; l1 not null and l2 null ==> l1 length > l2 length
5087 (l1 (< (version-list-not-zero l1) 0))
5088 ;; l1 null and l2 not null ==> l2 length > l1 length
5089 (t (< 0 (version-list-not-zero l2)))))
5092 (defun version-list-= (l1 l2)
5093 "Return t if L1, a list specification of a version, is equal to L2.
5095 Note that a version specified by the list (1) is equal to (1 0),
5096 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5097 Also, a version given by the list (1) is higher than (1 -1), which in
5098 turn is higher than (1 -2), which is higher than (1 -3)."
5099 (while (and l1 l2 (= (car l1) (car l2)))
5103 ;; l1 not null and l2 not null
5105 ;; l1 null and l2 null ==> l1 length = l2 length
5106 ((and (null l1) (null l2)))
5107 ;; l1 not null and l2 null ==> l1 length > l2 length
5108 (l1 (zerop (version-list-not-zero l1)))
5109 ;; l1 null and l2 not null ==> l2 length > l1 length
5110 (t (zerop (version-list-not-zero l2)))))
5113 (defun version-list-<= (l1 l2)
5114 "Return t if L1, a list specification of a version, is lower or equal to L2.
5116 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
5117 etc. That is, the trailing zeroes are insignificant. Also, integer
5118 list (1) is greater than (1 -1) which is greater than (1 -2)
5119 which is greater than (1 -3)."
5120 (while (and l1 l2 (= (car l1) (car l2)))
5124 ;; l1 not null and l2 not null
5125 ((and l1 l2) (< (car l1) (car l2)))
5126 ;; l1 null and l2 null ==> l1 length = l2 length
5127 ((and (null l1) (null l2)))
5128 ;; l1 not null and l2 null ==> l1 length > l2 length
5129 (l1 (<= (version-list-not-zero l1) 0))
5130 ;; l1 null and l2 not null ==> l2 length > l1 length
5131 (t (<= 0 (version-list-not-zero l2)))))
5133 (defun version-list-not-zero (lst)
5134 "Return the first non-zero element of LST, which is a list of integers.
5136 If all LST elements are zeros or LST is nil, return zero."
5137 (while (and lst (zerop (car lst)))
5138 (setq lst (cdr lst)))
5141 ;; there is no element different of zero
5145 (defun version< (v1 v2)
5146 "Return t if version V1 is lower (older) than V2.
5148 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
5149 etc. That is, the trailing \".0\"s are insignificant. Also, version
5150 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
5151 which is higher than \"1alpha\", which is higher than \"1snapshot\".
5152 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
5153 (version-list-< (version-to-list v1) (version-to-list v2)))
5155 (defun version<= (v1 v2)
5156 "Return t if version V1 is lower (older) than or equal to V2.
5158 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
5159 etc. That is, the trailing \".0\"s are insignificant. Also, version
5160 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
5161 which is higher than \"1alpha\", which is higher than \"1snapshot\".
5162 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
5163 (version-list-<= (version-to-list v1) (version-to-list v2)))
5165 (defun version= (v1 v2)
5166 "Return t if version V1 is equal to V2.
5168 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
5169 etc. That is, the trailing \".0\"s are insignificant. Also, version
5170 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
5171 which is higher than \"1alpha\", which is higher than \"1snapshot\".
5172 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
5173 (version-list-= (version-to-list v1) (version-to-list v2)))
5175 (defvar package--builtin-versions
5176 ;; Mostly populated by loaddefs.el via autoload-builtin-package-versions.
5177 (purecopy `((emacs . ,(version-to-list emacs-version))))
5178 "Alist giving the version of each versioned builtin package.
5179 I.e. each element of the list is of the form (NAME . VERSION) where
5180 NAME is the package name as a symbol, and VERSION is its version
5183 (defun package--description-file (dir)
5184 (concat (let ((subdir (file-name-nondirectory
5185 (directory-file-name dir))))
5186 (if (string-match "\\([^.].*?\\)-\\([0-9]+\\(?:[.][0-9]+\\|\\(?:pre\\|beta\\|alpha\\)[0-9]+\\)*\\)" subdir)
5187 (match-string 1 subdir) subdir))
5193 (defmacro with-mutex (mutex &rest body)
5194 "Invoke BODY with MUTEX held, releasing MUTEX when done.
5195 This is the simplest safe way to acquire and release a mutex."
5196 (declare (indent 1) (debug t))
5197 (let ((sym (make-symbol "mutex")))
5198 `(let ((,sym ,mutex))
5202 (mutex-unlock ,sym)))))
5207 (defvar definition-prefixes (make-hash-table :test 'equal)
5208 "Hash table mapping prefixes to the files in which they're used.
5209 This can be used to automatically fetch not-yet-loaded definitions.
5210 More specifically, if there is a value of the form (FILES...) for a string PREFIX
5211 it means that the FILES define variables or functions with names that start
5214 Note that it does not imply that all definitions starting with PREFIX can
5215 be found in those files. E.g. if prefix is \"gnus-article-\" there might
5216 still be definitions of the form \"gnus-article-toto-titi\" in other files, which would
5217 presumably appear in this table under another prefix such as \"gnus-\"
5218 or \"gnus-article-toto-\".")
5220 (defun register-definition-prefixes (file prefixes)
5221 "Register that FILE uses PREFIXES."
5222 (dolist (prefix prefixes)
5223 (puthash prefix (cons file (gethash prefix definition-prefixes))
5224 definition-prefixes)))
5226 (defconst menu-bar-separator '("--")
5227 "Separator for menus.")
5229 ;; The following statement ought to be in print.c, but `provide' can't
5231 ;; https://lists.gnu.org/r/emacs-devel/2009-08/msg00236.html
5232 (when (hash-table-p (car (read-from-string
5233 (prin1-to-string (make-hash-table)))))
5234 (provide 'hashtable-print-readable))
5236 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
5237 ;; generate file names for autoloads, custom-deps, and finder-data.
5238 (defun unmsys--file-name (file)
5239 "Produce the canonical file name for FILE from its MSYS form.
5241 On systems other than MS-Windows, just returns FILE.
5242 On MS-Windows, converts /d/foo/bar form of file names
5243 passed by MSYS Make into d:/foo/bar that Emacs can grok.
5245 This function is called from lisp/Makefile and leim/Makefile."
5246 (when (and (eq system-type 'windows-nt)
5247 (string-match "\\`/[a-zA-Z]/" file))
5248 (setq file (concat (substring file 1 2) ":" (substring file 2))))
5252 ;;; subr.el ends here