1 ;;; subr.el --- basic lisp subroutines for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2016 Free Software
6 ;; Maintainer: emacs-devel@gnu.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
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
115 [&optional ("interactive" interactive)]
117 ;; Note that this definition should not use backquotes; subr.el should not
118 ;; depend on backquote.el.
119 (list 'function (cons 'lambda cdr)))
121 (defmacro setq-local (var val)
122 "Set variable VAR to value VAL in current buffer."
123 ;; Can't use backquote here, it's too early in the bootstrap.
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 (defun apply-partially (fun &rest args)
136 "Return a function that is a partial application of FUN to ARGS.
137 ARGS is a list of the first N arguments to pass to FUN.
138 The result is a new function which does the same as FUN, except that
139 the first N arguments are fixed at the values with which this function
141 (lambda (&rest args2)
142 (apply fun (append args args2))))
144 (defmacro push (newelt place)
145 "Add NEWELT to the list stored in the generalized variable PLACE.
146 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
147 except that PLACE is only evaluated once (after NEWELT)."
148 (declare (debug (form gv-place)))
150 ;; Important special case, to avoid triggering GV too early in
153 (list 'cons newelt place))
155 (macroexp-let2 macroexp-copyable-p v newelt
156 (gv-letplace (getter setter) place
157 (funcall setter `(cons ,v ,getter))))))
159 (defmacro pop (place)
160 "Return the first element of PLACE's value, and remove it from the list.
161 PLACE must be a generalized variable whose value is a list.
162 If the value is nil, `pop' returns nil but does not actually
164 (declare (debug (gv-place)))
165 ;; We use `car-safe' here instead of `car' because the behavior is the same
166 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
167 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
168 ;; result is not used.
171 ;; So we can use `pop' in the bootstrap before `gv' can be used.
172 (list 'prog1 place (list 'setq place (list 'cdr place)))
173 (gv-letplace (getter setter) place
174 (macroexp-let2 macroexp-copyable-p x getter
175 `(prog1 ,x ,(funcall setter `(cdr ,x))))))))
177 (defmacro when (cond &rest body)
178 "If COND yields non-nil, do BODY, else return nil.
179 When COND yields non-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 (list 'if cond (cons 'progn body)))
186 (defmacro unless (cond &rest body)
187 "If COND yields nil, do BODY, else return nil.
188 When COND yields nil, eval BODY forms sequentially and return
189 value of last one, or nil if there are none.
192 (declare (indent 1) (debug t))
193 (cons 'if (cons cond (cons nil body))))
195 (defmacro dolist (spec &rest body)
197 Evaluate BODY with VAR bound to each car from LIST, in turn.
198 Then evaluate RESULT to get return value, default nil.
200 \(fn (VAR LIST [RESULT]) BODY...)"
201 (declare (indent 1) (debug ((symbolp form &optional form) body)))
202 ;; It would be cleaner to create an uninterned symbol,
203 ;; but that uses a lot more space when many functions in many files
205 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
206 (let ((temp '--dolist-tail--))
207 ;; This is not a reliable test, but it does not matter because both
208 ;; semantics are acceptable, tho one is slightly faster with dynamic
209 ;; scoping and the other is slightly faster (and has cleaner semantics)
210 ;; with lexical scoping.
212 `(let ((,temp ,(nth 1 spec)))
214 (let ((,(car spec) (car ,temp)))
216 (setq ,temp (cdr ,temp))))
218 `(let ((,temp ,(nth 1 spec))
221 (setq ,(car spec) (car ,temp))
223 (setq ,temp (cdr ,temp)))
224 ,@(if (cdr (cdr spec))
225 `((setq ,(car spec) nil) ,@(cdr (cdr spec))))))))
227 (defmacro dotimes (spec &rest body)
228 "Loop a certain number of times.
229 Evaluate BODY with VAR bound to successive integers running from 0,
230 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
231 the return value (nil if RESULT is omitted).
233 \(fn (VAR COUNT [RESULT]) BODY...)"
234 (declare (indent 1) (debug dolist))
235 ;; It would be cleaner to create an uninterned symbol,
236 ;; but that uses a lot more space when many functions in many files
238 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
239 (let ((temp '--dotimes-limit--)
242 ;; This is not a reliable test, but it does not matter because both
243 ;; semantics are acceptable, tho one is slightly faster with dynamic
244 ;; scoping and the other has cleaner semantics.
246 (let ((counter '--dotimes-counter--))
249 (while (< ,counter ,temp)
250 (let ((,(car spec) ,counter))
252 (setq ,counter (1+ ,counter)))
254 ;; FIXME: This let often leads to "unused var" warnings.
255 `((let ((,(car spec) ,counter)) ,@(cddr spec))))))
257 (,(car spec) ,start))
258 (while (< ,(car spec) ,temp)
260 (setq ,(car spec) (1+ ,(car spec))))
261 ,@(cdr (cdr spec))))))
263 (defmacro declare (&rest _specs)
264 "Do not evaluate any arguments, and return nil.
265 If a `declare' form appears as the first form in the body of a
266 `defun' or `defmacro' form, SPECS specifies various additional
267 information about the function or macro; these go into effect
268 during the evaluation of the `defun' or `defmacro' form.
270 The possible values of SPECS are specified by
271 `defun-declarations-alist' and `macro-declarations-alist'.
273 For more information, see info node `(elisp)Declare Form'."
274 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
277 (defmacro ignore-errors (&rest body)
278 "Execute BODY; if an error occurs, return nil.
279 Otherwise, return result of last form in BODY.
280 See also `with-demoted-errors' that does something similar
281 without silencing all errors."
282 (declare (debug t) (indent 0))
283 `(condition-case nil (progn ,@body) (error nil)))
285 ;;;; Basic Lisp functions.
287 (defun ignore (&rest _ignore)
288 "Do nothing and return nil.
289 This function accepts any number of arguments, but ignores them."
293 ;; Signal a compile-error if the first arg is missing.
294 (defun error (&rest args)
295 "Signal an error, making a message by passing args to `format-message'.
296 In Emacs, the convention is that error messages start with a capital
297 letter but *do not* end with a period. Please follow this convention
298 for the sake of consistency.
300 Note: (error \"%s\" VALUE) makes the message VALUE without
301 interpreting format characters like `%', `\\=`', and `\\=''."
302 (declare (advertised-calling-convention (string &rest args) "23.1"))
303 (signal 'error (list (apply #'format-message args))))
305 (defun user-error (format &rest args)
306 "Signal a pilot error, making a message by passing args to `format-message'.
307 In Emacs, the convention is that error messages start with a capital
308 letter but *do not* end with a period. Please follow this convention
309 for the sake of consistency.
310 This is just like `error' except that `user-error's are expected to be the
311 result of an incorrect manipulation on the part of the user, rather than the
312 result of an actual problem.
314 Note: (user-error \"%s\" VALUE) makes the message VALUE without
315 interpreting format characters like `%', `\\=`', and `\\=''."
316 (signal 'user-error (list (apply #'format-message format args))))
318 (defun define-error (name message &optional parent)
319 "Define NAME as a new error signal.
320 MESSAGE is a string that will be output to the echo area if such an error
321 is signaled without being caught by a `condition-case'.
322 PARENT is either a signal or a list of signals from which it inherits.
323 Defaults to `error'."
324 (unless parent (setq parent 'error))
328 (mapcar (lambda (parent)
330 (or (get parent 'error-conditions)
331 (error "Unknown signal `%s'" parent))))
333 (cons parent (get parent 'error-conditions)))))
334 (put name 'error-conditions
335 (delete-dups (copy-sequence (cons name conditions))))
336 (when message (put name 'error-message message))))
338 ;; We put this here instead of in frame.el so that it's defined even on
339 ;; systems where frame.el isn't loaded.
340 (defun frame-configuration-p (object)
341 "Return non-nil if OBJECT seems to be a frame configuration.
342 Any list whose car is `frame-configuration' is assumed to be a frame
345 (eq (car object) 'frame-configuration)))
350 ;; Note: `internal--compiler-macro-cXXr' was copied from
351 ;; `cl--compiler-macro-cXXr' in cl-macs.el. If you amend either one,
352 ;; you may want to amend the other, too.
353 (defun internal--compiler-macro-cXXr (form x)
354 (let* ((head (car form))
355 (n (symbol-name (car form)))
356 (i (- (length n) 2)))
357 (if (not (string-match "c[ad]+r\\'" n))
358 (if (and (fboundp head) (symbolp (symbol-function head)))
359 (internal--compiler-macro-cXXr (cons (symbol-function head) (cdr form))
361 (error "Compiler macro for cXXr applied to non-cXXr form"))
362 (while (> i (match-beginning 0))
363 (setq x (list (if (eq (aref n i) ?a) 'car 'cdr) x))
368 "Return the car of the car of X."
369 (declare (compiler-macro internal--compiler-macro-cXXr))
373 "Return the car of the cdr of X."
374 (declare (compiler-macro internal--compiler-macro-cXXr))
378 "Return the cdr of the car of X."
379 (declare (compiler-macro internal--compiler-macro-cXXr))
383 "Return the cdr of the cdr of X."
384 (declare (compiler-macro internal--compiler-macro-cXXr))
387 (defun last (list &optional n)
388 "Return the last link of LIST. Its car is the last element.
389 If LIST is nil, return nil.
390 If N is non-nil, return the Nth-to-last link of LIST.
391 If N is bigger than the length of LIST, return LIST."
394 (let ((m (safe-length list)))
395 (if (< n m) (nthcdr (- m n) list) list)))
397 (nthcdr (1- (safe-length list)) list))))
399 (defun butlast (list &optional n)
400 "Return a copy of LIST with the last N elements removed.
401 If N is omitted or nil, the last element is removed from the
403 (if (and n (<= n 0)) list
404 (nbutlast (copy-sequence list) n)))
406 (defun nbutlast (list &optional n)
407 "Modifies LIST to remove the last N elements.
408 If N is omitted or nil, remove the last element."
409 (let ((m (length list)))
413 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
416 (defun zerop (number)
417 "Return t if NUMBER is zero."
418 ;; Used to be in C, but it's pointless since (= 0 n) is faster anyway because
419 ;; = has a byte-code.
420 (declare (compiler-macro (lambda (_) `(= 0 ,number))))
423 (defun delete-dups (list)
424 "Destructively remove `equal' duplicates from LIST.
425 Store the result in LIST and return it. LIST must be a proper list.
426 Of several `equal' occurrences of an element in LIST, the first
428 (let ((l (length list)))
430 (let ((hash (make-hash-table :test #'equal :size l))
432 (puthash (car list) t hash)
433 (while (setq retail (cdr tail))
434 (let ((elt (car retail)))
435 (if (gethash elt hash)
436 (setcdr tail (cdr retail))
438 (setq tail retail)))))
441 (setcdr tail (delete (car tail) (cdr tail)))
442 (setq tail (cdr tail))))))
445 ;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html
446 (defun delete-consecutive-dups (list &optional circular)
447 "Destructively remove `equal' consecutive duplicates from LIST.
448 First and last elements are considered consecutive if CIRCULAR is
450 (let ((tail list) last)
452 (if (equal (car tail) (cadr tail))
453 (setcdr tail (cddr tail))
458 (equal (car tail) (car list)))
462 (defun number-sequence (from &optional to inc)
463 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
464 INC is the increment used between numbers in the sequence and defaults to 1.
465 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
466 zero. TO is only included if there is an N for which TO = FROM + N * INC.
467 If TO is nil or numerically equal to FROM, return (FROM).
468 If INC is positive and TO is less than FROM, or INC is negative
469 and TO is larger than FROM, return nil.
470 If INC is zero and TO is neither nil nor numerically equal to
471 FROM, signal an error.
473 This function is primarily designed for integer arguments.
474 Nevertheless, FROM, TO and INC can be integer or float. However,
475 floating point arithmetic is inexact. For instance, depending on
476 the machine, it may quite well happen that
477 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
478 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
479 elements. Thus, if some of the arguments are floats and one wants
480 to make sure that TO is included, one may have to explicitly write
481 TO as (+ FROM (* N INC)) or use a variable whose value was
482 computed with this exact expression. Alternatively, you can,
483 of course, also replace TO with a slightly larger value
484 \(or a slightly more negative value if INC is negative)."
485 (if (or (not to) (= from to))
487 (or inc (setq inc 1))
488 (when (zerop inc) (error "The increment can not be zero"))
489 (let (seq (n 0) (next from) (last from))
491 ;; The (>= next last) condition protects against integer
492 ;; overflow in computing NEXT.
493 (while (and (>= next last) (<= next to))
494 (setq seq (cons next seq)
497 next (+ from (* n inc))))
498 (while (and (<= next last) (>= next to))
499 (setq seq (cons next seq)
501 next (+ from (* n inc)))))
504 (defun copy-tree (tree &optional vecp)
505 "Make a copy of TREE.
506 If TREE is a cons cell, this recursively copies both its car and its cdr.
507 Contrast to `copy-sequence', which copies only along the cdrs. With second
508 argument VECP, this copies vectors as well as conses."
512 (let ((newcar (car tree)))
513 (if (or (consp (car tree)) (and vecp (vectorp (car tree))))
514 (setq newcar (copy-tree (car tree) vecp)))
515 (push newcar result))
516 (setq tree (cdr tree)))
517 (nconc (nreverse result) tree))
518 (if (and vecp (vectorp tree))
519 (let ((i (length (setq tree (copy-sequence tree)))))
520 (while (>= (setq i (1- i)) 0)
521 (aset tree i (copy-tree (aref tree i) vecp)))
525 ;;;; Various list-search functions.
527 (defun assoc-default (key alist &optional test default)
528 "Find object KEY in a pseudo-alist ALIST.
529 ALIST is a list of conses or objects. Each element
530 (or the element's car, if it is a cons) is compared with KEY by
531 calling TEST, with two arguments: (i) the element or its car,
533 If that is non-nil, the element matches; then `assoc-default'
534 returns the element's cdr, if it is a cons, or DEFAULT if the
535 element is not a cons.
537 If no element matches, the value is nil.
538 If TEST is omitted or nil, `equal' is used."
539 (let (found (tail alist) value)
540 (while (and tail (not found))
541 (let ((elt (car tail)))
542 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
543 (setq found t value (if (consp elt) (cdr elt) default))))
544 (setq tail (cdr tail)))
547 (defun assoc-ignore-case (key alist)
548 "Like `assoc', but ignores differences in case and text representation.
549 KEY must be a string. Upper-case and lower-case letters are treated as equal.
550 Unibyte strings are converted to multibyte for comparison."
551 (declare (obsolete assoc-string "22.1"))
552 (assoc-string key alist t))
554 (defun assoc-ignore-representation (key alist)
555 "Like `assoc', but ignores differences in text representation.
556 KEY must be a string.
557 Unibyte strings are converted to multibyte for comparison."
558 (declare (obsolete assoc-string "22.1"))
559 (assoc-string key alist nil))
561 (defun member-ignore-case (elt list)
562 "Like `member', but ignore differences in case and text representation.
563 ELT must be a string. Upper-case and lower-case letters are treated as equal.
564 Unibyte strings are converted to multibyte for comparison.
565 Non-strings in LIST are ignored."
567 (not (and (stringp (car list))
568 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
569 (setq list (cdr list)))
572 (defun assq-delete-all (key alist)
573 "Delete from ALIST all elements whose car is `eq' to KEY.
574 Return the modified alist.
575 Elements of ALIST that are not conses are ignored."
576 (while (and (consp (car alist))
577 (eq (car (car alist)) key))
578 (setq alist (cdr alist)))
579 (let ((tail alist) tail-cdr)
580 (while (setq tail-cdr (cdr tail))
581 (if (and (consp (car tail-cdr))
582 (eq (car (car tail-cdr)) key))
583 (setcdr tail (cdr tail-cdr))
584 (setq tail tail-cdr))))
587 (defun rassq-delete-all (value alist)
588 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
589 Return the modified alist.
590 Elements of ALIST that are not conses are ignored."
591 (while (and (consp (car alist))
592 (eq (cdr (car alist)) value))
593 (setq alist (cdr alist)))
594 (let ((tail alist) tail-cdr)
595 (while (setq tail-cdr (cdr tail))
596 (if (and (consp (car tail-cdr))
597 (eq (cdr (car tail-cdr)) value))
598 (setcdr tail (cdr tail-cdr))
599 (setq tail tail-cdr))))
602 (defun alist-get (key alist &optional default remove)
603 "Return the value associated with KEY in ALIST, using `assq'.
604 If KEY is not found in ALIST, return DEFAULT.
606 This is a generalized variable suitable for use with `setf'.
607 When using it to set a value, optional argument REMOVE non-nil
608 means to remove KEY from ALIST if the new value is `eql' to DEFAULT."
609 (ignore remove) ;;Silence byte-compiler.
610 (let ((x (assq key alist)))
611 (if x (cdr x) default)))
613 (defun remove (elt seq)
614 "Return a copy of SEQ with all occurrences of ELT removed.
615 SEQ must be a list, vector, or string. The comparison is done with `equal'."
617 ;; If SEQ isn't a list, there's no need to copy SEQ because
618 ;; `delete' will return a new object.
620 (delete elt (copy-sequence seq))))
622 (defun remq (elt list)
623 "Return LIST with all occurrences of ELT removed.
624 The comparison is done with `eq'. Contrary to `delq', this does not use
625 side-effects, and the argument LIST is not modified."
626 (while (and (eq elt (car list)) (setq list (cdr list))))
628 (delq elt (copy-sequence list))
634 "Convert KEYS to the internal Emacs key representation.
635 KEYS should be a string in the format returned by commands such
636 as `C-h k' (`describe-key').
637 This is the same format used for saving keyboard macros (see
639 ;; Don't use a defalias, since the `pure' property is only true for
640 ;; the calling convention of `kbd'.
641 (read-kbd-macro keys))
645 "Beep to tell the user this binding is undefined."
648 (message "%s is undefined" (key-description (this-single-command-keys)))
649 (setq defining-kbd-macro nil)
650 (force-mode-line-update)
651 ;; If this is a down-mouse event, don't reset prefix-arg;
652 ;; pass it to the command run by the up event.
654 (when (memq 'down (event-modifiers last-command-event))
655 current-prefix-arg)))
657 ;; Prevent the \{...} documentation construct
658 ;; from mentioning keys that run this command.
659 (put 'undefined 'suppress-keymap t)
661 (defun suppress-keymap (map &optional nodigits)
662 "Make MAP override all normally self-inserting keys to be undefined.
663 Normally, as an exception, digits and minus-sign are set to make prefix args,
664 but optional second arg NODIGITS non-nil treats them like other chars."
665 (define-key map [remap self-insert-command] 'undefined)
668 (define-key map "-" 'negative-argument)
669 ;; Make plain numbers do numeric args.
672 (define-key map (char-to-string loop) 'digit-argument)
673 (setq loop (1+ loop))))))
675 (defun make-composed-keymap (maps &optional parent)
676 "Construct a new keymap composed of MAPS and inheriting from PARENT.
677 When looking up a key in the returned map, the key is looked in each
678 keymap of MAPS in turn until a binding is found.
679 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
680 As always with keymap inheritance, a nil binding in MAPS overrides
681 any corresponding binding in PARENT, but it does not override corresponding
682 bindings in other keymaps of MAPS.
683 MAPS can be a list of keymaps or a single keymap.
684 PARENT if non-nil should be a keymap."
686 ,@(if (keymapp maps) (list maps) maps)
689 (defun define-key-after (keymap key definition &optional after)
690 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
691 This is like `define-key' except that the binding for KEY is placed
692 just after the binding for the event AFTER, instead of at the beginning
693 of the map. Note that AFTER must be an event type (like KEY), NOT a command
696 If AFTER is t or omitted, the new binding goes at the end of the keymap.
697 AFTER should be a single event type--a symbol or a character, not a sequence.
699 Bindings are always added before any inherited map.
701 The order of bindings in a keymap only matters when it is used as
702 a menu, so this function is not useful for non-menu keymaps."
703 (unless after (setq after t))
705 (signal 'wrong-type-argument (list 'keymapp keymap)))
707 (if (<= (length key) 1) (aref key 0)
708 (setq keymap (lookup-key keymap
710 (butlast (mapcar 'identity key)))))
711 (aref key (1- (length key)))))
712 (let ((tail keymap) done inserted)
713 (while (and (not done) tail)
714 ;; Delete any earlier bindings for the same key.
715 (if (eq (car-safe (car (cdr tail))) key)
716 (setcdr tail (cdr (cdr tail))))
717 ;; If we hit an included map, go down that one.
718 (if (keymapp (car tail)) (setq tail (car tail)))
719 ;; When we reach AFTER's binding, insert the new binding after.
720 ;; If we reach an inherited keymap, insert just before that.
721 ;; If we reach the end of this keymap, insert at the end.
722 (if (or (and (eq (car-safe (car tail)) after)
724 (eq (car (cdr tail)) 'keymap)
727 ;; Stop the scan only if we find a parent keymap.
728 ;; Keep going past the inserted element
729 ;; so we can delete any duplications that come later.
730 (if (eq (car (cdr tail)) 'keymap)
732 ;; Don't insert more than once.
734 (setcdr tail (cons (cons key definition) (cdr tail))))
736 (setq tail (cdr tail)))))
738 (defun map-keymap-sorted (function keymap)
739 "Implement `map-keymap' with sorting.
740 Don't call this function; it is for internal use only."
742 (map-keymap (lambda (a b) (push (cons a b) list))
744 (setq list (sort list
746 (setq a (car a) b (car b))
748 (if (integerp b) (< a b)
751 ;; string< also accepts symbols.
754 (funcall function (car p) (cdr p)))))
756 (defun keymap--menu-item-binding (val)
757 "Return the binding part of a menu-item."
759 ((not (consp val)) val) ;Not a menu-item.
760 ((eq 'menu-item (car val))
761 (let* ((binding (nth 2 val))
762 (plist (nthcdr 3 val))
763 (filter (plist-get plist :filter)))
764 (if filter (funcall filter binding)
766 ((and (consp (cdr val)) (stringp (cadr val)))
770 (t val))) ;Not a menu-item either.
772 (defun keymap--menu-item-with-binding (item binding)
773 "Build a menu-item like ITEM but with its binding changed to BINDING."
775 ((not (consp item)) binding) ;Not a menu-item.
776 ((eq 'menu-item (car item))
777 (setq item (copy-sequence item))
778 (let ((tail (nthcdr 2 item)))
779 (setcar tail binding)
780 ;; Remove any potential filter.
781 (if (plist-get (cdr tail) :filter)
782 (setcdr tail (plist-put (cdr tail) :filter nil))))
784 ((and (consp (cdr item)) (stringp (cadr item)))
785 (cons (car item) (cons (cadr item) binding)))
786 (t (cons (car item) binding))))
788 (defun keymap--merge-bindings (val1 val2)
789 "Merge bindings VAL1 and VAL2."
790 (let ((map1 (keymap--menu-item-binding val1))
791 (map2 (keymap--menu-item-binding val2)))
792 (if (not (and (keymapp map1) (keymapp map2)))
793 ;; There's nothing to merge: val1 takes precedence.
795 (let ((map (list 'keymap map1 map2))
796 (item (if (keymapp val1) (if (keymapp val2) nil val2) val1)))
797 (keymap--menu-item-with-binding item map)))))
799 (defun keymap-canonicalize (map)
800 "Return a simpler equivalent keymap.
801 This resolves inheritance and redefinitions. The returned keymap
802 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
803 and use in active keymaps and menus.
804 Subkeymaps may be modified but are not canonicalized."
805 ;; FIXME: Problem with the difference between a nil binding
806 ;; that hides a binding in an inherited map and a nil binding that's ignored
807 ;; to let some further binding visible. Currently a nil binding hides all.
808 ;; FIXME: we may want to carefully (re)order elements in case they're
812 (prompt (keymap-prompt map)))
814 (setq map (map-keymap ;; -internal
817 ;; Treat char-ranges specially.
818 (push (cons key item) ranges)
819 (push (cons key item) bindings)))
821 ;; Create the new map.
822 (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt))
823 (dolist (binding ranges)
824 ;; Treat char-ranges specially. FIXME: need to merge as well.
825 (define-key map (vector (car binding)) (cdr binding)))
826 ;; Process the bindings starting from the end.
827 (dolist (binding (prog1 bindings (setq bindings ())))
828 (let* ((key (car binding))
829 (oldbind (assq key bindings)))
830 (push (if (not oldbind)
831 ;; The normal case: no duplicate bindings.
833 ;; This is the second binding for this key.
834 (setq bindings (delq oldbind bindings))
835 (cons key (keymap--merge-bindings (cdr binding)
838 (nconc map bindings)))
840 (put 'keyboard-translate-table 'char-table-extra-slots 0)
842 (defun keyboard-translate (from to)
843 "Translate character FROM to TO on the current terminal.
844 This function creates a `keyboard-translate-table' if necessary
845 and then modifies one entry in it."
846 (or (char-table-p keyboard-translate-table)
847 (setq keyboard-translate-table
848 (make-char-table 'keyboard-translate-table nil)))
849 (aset keyboard-translate-table from to))
851 ;;;; Key binding commands.
853 (defun global-set-key (key command)
854 "Give KEY a global binding as COMMAND.
855 COMMAND is the command definition to use; usually it is
856 a symbol naming an interactively-callable function.
857 KEY is a key sequence; noninteractively, it is a string or vector
858 of characters or event types, and non-ASCII characters with codes
859 above 127 (such as ISO Latin-1) can be included if you use a vector.
861 Note that if KEY has a local binding in the current buffer,
862 that local binding will continue to shadow any global binding
863 that you make with this function."
865 (let* ((menu-prompting nil)
866 (key (read-key-sequence "Set key globally: ")))
868 (read-command (format "Set key %s to command: "
869 (key-description key))))))
870 (or (vectorp key) (stringp key)
871 (signal 'wrong-type-argument (list 'arrayp key)))
872 (define-key (current-global-map) key command))
874 (defun local-set-key (key command)
875 "Give KEY a local binding as COMMAND.
876 COMMAND is the command definition to use; usually it is
877 a symbol naming an interactively-callable function.
878 KEY is a key sequence; noninteractively, it is a string or vector
879 of characters or event types, and non-ASCII characters with codes
880 above 127 (such as ISO Latin-1) can be included if you use a vector.
882 The binding goes in the current buffer's local map, which in most
883 cases is shared with all other buffers in the same major mode."
884 (interactive "KSet key locally: \nCSet key %s locally to command: ")
885 (let ((map (current-local-map)))
887 (use-local-map (setq map (make-sparse-keymap))))
888 (or (vectorp key) (stringp key)
889 (signal 'wrong-type-argument (list 'arrayp key)))
890 (define-key map key command)))
892 (defun global-unset-key (key)
893 "Remove global binding of KEY.
894 KEY is a string or vector representing a sequence of keystrokes."
895 (interactive "kUnset key globally: ")
896 (global-set-key key nil))
898 (defun local-unset-key (key)
899 "Remove local binding of KEY.
900 KEY is a string or vector representing a sequence of keystrokes."
901 (interactive "kUnset key locally: ")
902 (if (current-local-map)
903 (local-set-key key nil))
906 ;;;; substitute-key-definition and its subroutines.
908 (defvar key-substitution-in-progress nil
909 "Used internally by `substitute-key-definition'.")
911 (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
912 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
913 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
914 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
915 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
917 If you don't specify OLDMAP, you can usually get the same results
918 in a cleaner way with command remapping, like this:
919 (define-key KEYMAP [remap OLDDEF] NEWDEF)
920 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
921 ;; Don't document PREFIX in the doc string because we don't want to
922 ;; advertise it. It's meant for recursive calls only. Here's its
925 ;; If optional argument PREFIX is specified, it should be a key
926 ;; prefix, a string. Redefined bindings will then be bound to the
927 ;; original key, with PREFIX added at the front.
928 (or prefix (setq prefix ""))
929 (let* ((scan (or oldmap keymap))
930 (prefix1 (vconcat prefix [nil]))
931 (key-substitution-in-progress
932 (cons scan key-substitution-in-progress)))
933 ;; Scan OLDMAP, finding each char or event-symbol that
934 ;; has any definition, and act on it with hack-key.
937 (aset prefix1 (length prefix) char)
938 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
941 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
942 (let (inner-def skipped menu-item)
943 ;; Find the actual command name within the binding.
944 (if (eq (car-safe defn) 'menu-item)
945 (setq menu-item defn defn (nth 2 defn))
946 ;; Skip past menu-prompt.
947 (while (stringp (car-safe defn))
948 (push (pop defn) skipped))
949 ;; Skip past cached key-equivalence data for menu items.
950 (if (consp (car-safe defn))
951 (setq defn (cdr defn))))
952 (if (or (eq defn olddef)
953 ;; Compare with equal if definition is a key sequence.
954 ;; That is useful for operating on function-key-map.
955 (and (or (stringp defn) (vectorp defn))
956 (equal defn olddef)))
957 (define-key keymap prefix
959 (let ((copy (copy-sequence menu-item)))
960 (setcar (nthcdr 2 copy) newdef)
962 (nconc (nreverse skipped) newdef)))
963 ;; Look past a symbol that names a keymap.
965 (or (indirect-function defn) defn))
966 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
967 ;; avoid autoloading a keymap. This is mostly done to preserve the
968 ;; original non-autoloading behavior of pre-map-keymap times.
969 (if (and (keymapp inner-def)
970 ;; Avoid recursively scanning
971 ;; where KEYMAP does not have a submap.
972 (let ((elt (lookup-key keymap prefix)))
973 (or (null elt) (natnump elt) (keymapp elt)))
974 ;; Avoid recursively rescanning keymap being scanned.
975 (not (memq inner-def key-substitution-in-progress)))
976 ;; If this one isn't being scanned already, scan it now.
977 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
980 ;;;; The global keymap tree.
982 ;; global-map, esc-map, and ctl-x-map have their values set up in
983 ;; keymap.c; we just give them docstrings here.
985 (defvar global-map nil
986 "Default global keymap mapping Emacs keyboard input into commands.
987 The value is a keymap which is usually (but not necessarily) Emacs's
991 "Default keymap for ESC (meta) commands.
992 The normal global definition of the character ESC indirects to this keymap.")
994 (defvar ctl-x-map nil
995 "Default keymap for C-x commands.
996 The normal global definition of the character C-x indirects to this keymap.")
998 (defvar ctl-x-4-map (make-sparse-keymap)
999 "Keymap for subcommands of C-x 4.")
1000 (defalias 'ctl-x-4-prefix ctl-x-4-map)
1001 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
1003 (defvar ctl-x-5-map (make-sparse-keymap)
1004 "Keymap for frame commands.")
1005 (defalias 'ctl-x-5-prefix ctl-x-5-map)
1006 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
1009 ;;;; Event manipulation functions.
1011 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
1013 (defun listify-key-sequence (key)
1014 "Convert a key sequence to a list of events."
1017 (mapcar (function (lambda (c)
1019 (logxor c listify-key-sequence-1)
1024 "True if the argument is an event object."
1027 (and (symbolp obj) obj (not (keywordp obj)))
1028 (and (consp obj) (symbolp (car obj))))))
1030 (defun event-modifiers (event)
1031 "Return a list of symbols representing the modifier keys in event EVENT.
1032 The elements of the list may include `meta', `control',
1033 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
1035 EVENT may be an event or an event type. If EVENT is a symbol
1036 that has never been used in an event that has been read as input
1037 in the current Emacs session, then this function may fail to include
1038 the `click' modifier."
1041 (setq type (car type)))
1043 ;; Don't read event-symbol-elements directly since we're not
1044 ;; sure the symbol has already been parsed.
1045 (cdr (internal-event-symbol-parse-modifiers type))
1047 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
1048 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
1049 (if (not (zerop (logand type ?\M-\^@)))
1051 (if (or (not (zerop (logand type ?\C-\^@)))
1053 (push 'control list))
1054 (if (or (not (zerop (logand type ?\S-\^@)))
1055 (/= char (downcase char)))
1057 (or (zerop (logand type ?\H-\^@))
1059 (or (zerop (logand type ?\s-\^@))
1061 (or (zerop (logand type ?\A-\^@))
1065 (defun event-basic-type (event)
1066 "Return the basic type of the given event (all modifiers removed).
1067 The value is a printing character (not upper case) or a symbol.
1068 EVENT may be an event or an event type. If EVENT is a symbol
1069 that has never been used in an event that has been read as input
1070 in the current Emacs session, then this function may return nil."
1072 (setq event (car event)))
1074 (car (get event 'event-symbol-elements))
1075 (let* ((base (logand event (1- ?\A-\^@)))
1076 (uncontrolled (if (< base 32) (logior base 64) base)))
1077 ;; There are some numbers that are invalid characters and
1078 ;; cause `downcase' to get an error.
1080 (downcase uncontrolled)
1081 (error uncontrolled)))))
1083 (defsubst mouse-movement-p (object)
1084 "Return non-nil if OBJECT is a mouse movement event."
1085 (eq (car-safe object) 'mouse-movement))
1087 (defun mouse-event-p (object)
1088 "Return non-nil if OBJECT is a mouse click event."
1089 ;; is this really correct? maybe remove mouse-movement?
1090 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
1092 (defun event-start (event)
1093 "Return the starting position of EVENT.
1094 EVENT should be a mouse click, drag, or key press event. If
1095 EVENT is nil, the value of `posn-at-point' is used instead.
1097 The following accessor functions are used to access the elements
1100 `posn-window': The window the event is in.
1101 `posn-area': A symbol identifying the area the event occurred in,
1102 or nil if the event occurred in the text area.
1103 `posn-point': The buffer position of the event.
1104 `posn-x-y': The pixel-based coordinates of the event.
1105 `posn-col-row': The estimated column and row corresponding to the
1106 position of the event.
1107 `posn-actual-col-row': The actual column and row corresponding to the
1108 position of the event.
1109 `posn-string': The string object of the event, which is either
1110 nil or (STRING . POSITION)'.
1111 `posn-image': The image object of the event, if any.
1112 `posn-object': The image or string object of the event, if any.
1113 `posn-timestamp': The time the event occurred, in milliseconds.
1115 For more information, see Info node `(elisp)Click Events'."
1116 (if (consp event) (nth 1 event)
1118 (list (selected-window) (point) '(0 . 0) 0))))
1120 (defun event-end (event)
1121 "Return the ending position of EVENT.
1122 EVENT should be a click, drag, or key press event.
1124 See `event-start' for a description of the value returned."
1125 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1127 (list (selected-window) (point) '(0 . 0) 0))))
1129 (defsubst event-click-count (event)
1130 "Return the multi-click count of EVENT, a click or drag event.
1131 The return value is a positive integer."
1132 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1134 ;;;; Extracting fields of the positions in an event.
1137 "Return non-nil if OBJ appears to be a valid `posn' object specifying a window.
1138 A `posn' object is returned from functions such as `event-start'.
1139 If OBJ is a valid `posn' object, but specifies a frame rather
1140 than a window, return nil."
1141 ;; FIXME: Correct the behavior of this function so that all valid
1142 ;; `posn' objects are recognized, after updating other code that
1143 ;; depends on its present behavior.
1144 (and (windowp (car-safe obj))
1145 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1146 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1147 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1149 (defsubst posn-window (position)
1150 "Return the window in POSITION.
1151 POSITION should be a list of the form returned by the `event-start'
1152 and `event-end' functions."
1155 (defsubst posn-area (position)
1156 "Return the window area recorded in POSITION, or nil for the text area.
1157 POSITION should be a list of the form returned by the `event-start'
1158 and `event-end' functions."
1159 (let ((area (if (consp (nth 1 position))
1160 (car (nth 1 position))
1162 (and (symbolp area) area)))
1164 (defun posn-point (position)
1165 "Return the buffer location in POSITION.
1166 POSITION should be a list of the form returned by the `event-start'
1167 and `event-end' functions.
1168 Returns nil if POSITION does not correspond to any buffer location (e.g.
1169 a click on a scroll bar)."
1170 (or (nth 5 position)
1171 (let ((pt (nth 1 position)))
1173 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1174 (if (integerp pt) pt)))))
1176 (defun posn-set-point (position)
1177 "Move point to POSITION.
1178 Select the corresponding window as well."
1179 (if (not (windowp (posn-window position)))
1180 (error "Position not in text area of window"))
1181 (select-window (posn-window position))
1182 (if (numberp (posn-point position))
1183 (goto-char (posn-point position))))
1185 (defsubst posn-x-y (position)
1186 "Return the x and y coordinates in POSITION.
1187 The return value has the form (X . Y), where X and Y are given in
1188 pixels. POSITION should be a list of the form returned by
1189 `event-start' and `event-end'."
1192 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1194 (defun posn-col-row (position)
1195 "Return the nominal column and row in POSITION, measured in characters.
1196 The column and row values are approximations calculated from the x
1197 and y coordinates in POSITION and the frame's default character width
1198 and default line height, including spacing.
1199 For a scroll-bar event, the result column is 0, and the row
1200 corresponds to the vertical position of the click in the scroll bar.
1201 POSITION should be a list of the form returned by the `event-start'
1202 and `event-end' functions."
1203 (let* ((pair (posn-x-y position))
1204 (frame-or-window (posn-window position))
1205 (frame (if (framep frame-or-window)
1207 (window-frame frame-or-window)))
1208 (window (when (windowp frame-or-window) frame-or-window))
1209 (area (posn-area position)))
1211 ((null frame-or-window)
1213 ((eq area 'vertical-scroll-bar)
1214 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1215 ((eq area 'horizontal-scroll-bar)
1216 (cons (scroll-bar-scale pair (window-width window)) 0))
1218 ;; FIXME: This should take line-spacing properties on
1219 ;; newlines into account.
1220 (let* ((spacing (when (display-graphic-p frame)
1221 (or (with-current-buffer
1222 (window-buffer (frame-selected-window frame))
1224 (frame-parameter frame 'line-spacing)))))
1225 (cond ((floatp spacing)
1226 (setq spacing (truncate (* spacing
1227 (frame-char-height frame)))))
1230 (cons (/ (car pair) (frame-char-width frame))
1231 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
1233 (defun posn-actual-col-row (position)
1234 "Return the window row number in POSITION and character number in that row.
1236 Return nil if POSITION does not contain the actual position; in that case
1237 `posn-col-row' can be used to get approximate values.
1238 POSITION should be a list of the form returned by the `event-start'
1239 and `event-end' functions.
1241 This function does not account for the width on display, like the
1242 number of visual columns taken by a TAB or image. If you need
1243 the coordinates of POSITION in character units, you should use
1244 `posn-col-row', not this function."
1247 (defsubst posn-timestamp (position)
1248 "Return the timestamp of POSITION.
1249 POSITION should be a list of the form returned by the `event-start'
1250 and `event-end' functions."
1253 (defun posn-string (position)
1254 "Return the string object of POSITION.
1255 Value is a cons (STRING . STRING-POS), or nil if not a string.
1256 POSITION should be a list of the form returned by the `event-start'
1257 and `event-end' functions."
1258 (let ((x (nth 4 position)))
1259 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1260 (when (consp x) x)))
1262 (defsubst posn-image (position)
1263 "Return the image object of POSITION.
1264 Value is a list (image ...), or nil if not an image.
1265 POSITION should be a list of the form returned by the `event-start'
1266 and `event-end' functions."
1269 (defsubst posn-object (position)
1270 "Return the object (image or string) of POSITION.
1271 Value is a list (image ...) for an image object, a cons cell
1272 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1273 POSITION should be a list of the form returned by the `event-start'
1274 and `event-end' functions."
1275 (or (posn-image position) (posn-string position)))
1277 (defsubst posn-object-x-y (position)
1278 "Return the x and y coordinates relative to the object of POSITION.
1279 The return value has the form (DX . DY), where DX and DY are
1280 given in pixels. POSITION should be a list of the form returned
1281 by `event-start' and `event-end'."
1284 (defsubst posn-object-width-height (position)
1285 "Return the pixel width and height of the object of POSITION.
1286 The return value has the form (WIDTH . HEIGHT). POSITION should
1287 be a list of the form returned by `event-start' and `event-end'."
1291 ;;;; Obsolescent names for functions.
1293 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1294 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1295 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1296 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1297 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1298 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1300 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1301 (make-obsolete 'buffer-has-markers-at nil "24.3")
1304 (make-obsolete 'string-to-unibyte "use `encode-coding-string'." "25.2")
1305 (make-obsolete 'string-as-unibyte "use `encode-coding-string'." "25.2")
1306 (make-obsolete 'string-to-multibyte "use `decode-coding-string'." "25.2")
1307 (make-obsolete 'string-as-multibyte "use `decode-coding-string'." "25.2")
1309 (defun insert-string (&rest args)
1310 "Mocklisp-compatibility insert function.
1311 Like the function `insert' except that any argument that is a number
1312 is converted into a string by expressing it in decimal."
1313 (declare (obsolete insert "22.1"))
1315 (insert (if (integerp el) (number-to-string el) el))))
1317 (defun makehash (&optional test)
1318 (declare (obsolete make-hash-table "22.1"))
1319 (make-hash-table :test (or test 'eql)))
1322 "Return (log X 10), the log base 10 of X."
1323 (declare (obsolete log "24.4"))
1326 ;; These are used by VM and some old programs
1327 (defalias 'focus-frame 'ignore "")
1328 (make-obsolete 'focus-frame "it does nothing." "22.1")
1329 (defalias 'unfocus-frame 'ignore "")
1330 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1331 (make-obsolete 'make-variable-frame-local
1332 "explicitly check for a frame-parameter instead." "22.2")
1333 (set-advertised-calling-convention
1334 'all-completions '(string collection &optional predicate) "23.1")
1335 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1336 (set-advertised-calling-convention 'indirect-function '(object) "25.1")
1337 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1338 (set-advertised-calling-convention 'decode-char '(ch charset) "21.4")
1339 (set-advertised-calling-convention 'encode-char '(ch charset) "21.4")
1341 ;;;; Obsolescence declarations for variables, and aliases.
1343 ;; Special "default-FOO" variables which contain the default value of
1344 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1345 ;; slows down several unrelated variable operations; furthermore, they
1346 ;; can lead to really odd behavior if you decide to make them
1349 ;; Not used at all in Emacs, last time I checked:
1350 (make-obsolete-variable 'default-mode-line-format
1351 "use (setq-default mode-line-format) or (default-value mode-line-format) instead"
1353 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1354 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1355 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1356 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1357 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1358 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1359 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1360 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1361 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1362 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1363 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1364 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1365 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1366 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1367 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1368 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1369 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1370 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1371 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1372 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1373 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1374 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1375 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1376 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1377 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1378 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1379 (make-obsolete-variable 'default-enable-multibyte-characters
1380 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1382 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1383 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1384 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1385 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1386 (make-obsolete-variable 'redisplay-dont-pause nil "24.5")
1387 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1388 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1390 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1391 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1393 ;; Lisp manual only updated in 22.1.
1394 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1397 (define-obsolete-variable-alias 'x-lost-selection-hooks
1398 'x-lost-selection-functions "22.1")
1399 (define-obsolete-variable-alias 'x-sent-selection-hooks
1400 'x-sent-selection-functions "22.1")
1402 ;; This was introduced in 21.4 for pre-unicode unification. That
1403 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1404 ;; Other uses are possible, so this variable is not _really_ obsolete,
1405 ;; but Stefan insists to mark it so.
1406 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1408 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1410 ;;;; Alternate names for functions - these are not being phased out.
1412 (defalias 'send-string 'process-send-string)
1413 (defalias 'send-region 'process-send-region)
1414 (defalias 'string= 'string-equal)
1415 (defalias 'string< 'string-lessp)
1416 (defalias 'string> 'string-greaterp)
1417 (defalias 'move-marker 'set-marker)
1418 (defalias 'rplaca 'setcar)
1419 (defalias 'rplacd 'setcdr)
1420 (defalias 'beep 'ding) ;preserve lingual purity
1421 (defalias 'indent-to-column 'indent-to)
1422 (defalias 'backward-delete-char 'delete-backward-char)
1423 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1424 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1425 (defalias 'int-to-string 'number-to-string)
1426 (defalias 'store-match-data 'set-match-data)
1427 (defalias 'chmod 'set-file-modes)
1428 (defalias 'mkdir 'make-directory)
1429 ;; These are the XEmacs names:
1430 (defalias 'point-at-eol 'line-end-position)
1431 (defalias 'point-at-bol 'line-beginning-position)
1433 (defalias 'user-original-login-name 'user-login-name)
1436 ;;;; Hook manipulation functions.
1438 (defun add-hook (hook function &optional append local)
1439 "Add to the value of HOOK the function FUNCTION.
1440 FUNCTION is not added if already present.
1441 FUNCTION is added (if necessary) at the beginning of the hook list
1442 unless the optional argument APPEND is non-nil, in which case
1443 FUNCTION is added at the end.
1445 The optional fourth argument, LOCAL, if non-nil, says to modify
1446 the hook's buffer-local value rather than its global value.
1447 This makes the hook buffer-local, and it makes t a member of the
1448 buffer-local value. That acts as a flag to run the hook
1449 functions of the global value as well as in the local value.
1451 HOOK should be a symbol, and FUNCTION may be any valid function. If
1452 HOOK is void, it is first set to nil. If HOOK's value is a single
1453 function, it is changed to a list of functions."
1454 (or (boundp hook) (set hook nil))
1455 (or (default-boundp hook) (set-default hook nil))
1456 (if local (unless (local-variable-if-set-p hook)
1457 (set (make-local-variable hook) (list t)))
1458 ;; Detect the case where make-local-variable was used on a hook
1459 ;; and do what we used to do.
1460 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1462 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1463 ;; If the hook value is a single function, turn it into a list.
1464 (when (or (not (listp hook-value)) (functionp hook-value))
1465 (setq hook-value (list hook-value)))
1466 ;; Do the actual addition if necessary
1467 (unless (member function hook-value)
1468 (when (stringp function)
1469 (setq function (purecopy function)))
1472 (append hook-value (list function))
1473 (cons function hook-value))))
1474 ;; Set the actual variable
1477 ;; If HOOK isn't a permanent local,
1478 ;; but FUNCTION wants to survive a change of modes,
1479 ;; mark HOOK as partially permanent.
1480 (and (symbolp function)
1481 (get function 'permanent-local-hook)
1482 (not (get hook 'permanent-local))
1483 (put hook 'permanent-local 'permanent-local-hook))
1484 (set hook hook-value))
1485 (set-default hook hook-value))))
1487 (defun remove-hook (hook function &optional local)
1488 "Remove from the value of HOOK the function FUNCTION.
1489 HOOK should be a symbol, and FUNCTION may be any valid function. If
1490 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1491 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1493 The optional third argument, LOCAL, if non-nil, says to modify
1494 the hook's buffer-local value rather than its default value."
1495 (or (boundp hook) (set hook nil))
1496 (or (default-boundp hook) (set-default hook nil))
1497 ;; Do nothing if LOCAL is t but this hook has no local binding.
1498 (unless (and local (not (local-variable-p hook)))
1499 ;; Detect the case where make-local-variable was used on a hook
1500 ;; and do what we used to do.
1501 (when (and (local-variable-p hook)
1502 (not (and (consp (symbol-value hook))
1503 (memq t (symbol-value hook)))))
1505 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1506 ;; Remove the function, for both the list and the non-list cases.
1507 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1508 (if (equal hook-value function) (setq hook-value nil))
1509 (setq hook-value (delete function (copy-sequence hook-value))))
1510 ;; If the function is on the global hook, we need to shadow it locally
1511 ;;(when (and local (member function (default-value hook))
1512 ;; (not (member (cons 'not function) hook-value)))
1513 ;; (push (cons 'not function) hook-value))
1514 ;; Set the actual variable
1516 (set-default hook hook-value)
1517 (if (equal hook-value '(t))
1518 (kill-local-variable hook)
1519 (set hook hook-value))))))
1521 (defmacro letrec (binders &rest body)
1522 "Bind variables according to BINDERS then eval BODY.
1523 The value of the last form in BODY is returned.
1524 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1525 SYMBOL to the value of VALUEFORM.
1526 All symbols are bound before the VALUEFORMs are evalled."
1527 ;; Only useful in lexical-binding mode.
1528 ;; As a special-form, we could implement it more efficiently (and cleanly,
1529 ;; making the vars actually unbound during evaluation of the binders).
1530 (declare (debug let) (indent 1))
1531 `(let ,(mapcar #'car binders)
1532 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1535 (defmacro with-wrapper-hook (hook args &rest body)
1536 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1537 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1538 around the preceding ones, like a set of nested `around' advices.
1540 Each hook function should accept an argument list consisting of a
1541 function FUN, followed by the additional arguments in ARGS.
1543 The first hook function in HOOK is passed a FUN that, if it is called
1544 with arguments ARGS, performs BODY (i.e., the default operation).
1545 The FUN passed to each successive hook function is defined based
1546 on the preceding hook functions; if called with arguments ARGS,
1547 it does what the `with-wrapper-hook' call would do if the
1548 preceding hook functions were the only ones present in HOOK.
1550 Each hook function may call its FUN argument as many times as it wishes,
1551 including never. In that case, such a hook function acts to replace
1552 the default definition altogether, and any preceding hook functions.
1553 Of course, a subsequent hook function may do the same thing.
1555 Each hook function definition is used to construct the FUN passed
1556 to the next hook function, if any. The last (or \"outermost\")
1557 FUN is then called once."
1558 (declare (indent 2) (debug (form sexp body))
1559 (obsolete "use a <foo>-function variable modified by `add-function'."
1561 `(subr--with-wrapper-hook-no-warnings ,hook ,args ,@body))
1563 (defmacro subr--with-wrapper-hook-no-warnings (hook args &rest body)
1564 "Like (with-wrapper-hook HOOK ARGS BODY), but without warnings."
1565 ;; We need those two gensyms because CL's lexical scoping is not available
1566 ;; for function arguments :-(
1567 (let ((funs (make-symbol "funs"))
1568 (global (make-symbol "global"))
1569 (argssym (make-symbol "args"))
1570 (runrestofhook (make-symbol "runrestofhook")))
1571 ;; Since the hook is a wrapper, the loop has to be done via
1572 ;; recursion: a given hook function will call its parameter in order to
1573 ;; continue looping.
1574 `(letrec ((,runrestofhook
1575 (lambda (,funs ,global ,argssym)
1576 ;; `funs' holds the functions left on the hook and `global'
1577 ;; holds the functions left on the global part of the hook
1578 ;; (in case the hook is local).
1580 (if (eq t (car ,funs))
1581 (funcall ,runrestofhook
1582 (append ,global (cdr ,funs)) nil ,argssym)
1585 (lambda (,funs ,global &rest ,argssym)
1586 (funcall ,runrestofhook ,funs ,global ,argssym))
1587 (cdr ,funs) ,global)
1589 ;; Once there are no more functions on the hook, run
1590 ;; the original body.
1591 (apply (lambda ,args ,@body) ,argssym)))))
1592 (funcall ,runrestofhook ,hook
1593 ;; The global part of the hook, if any.
1595 `(if (local-variable-p ',hook)
1596 (default-value ',hook)))
1599 (defun add-to-list (list-var element &optional append compare-fn)
1600 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1601 The test for presence of ELEMENT is done with `equal', or with
1602 COMPARE-FN if that's non-nil.
1603 If ELEMENT is added, it is added at the beginning of the list,
1604 unless the optional argument APPEND is non-nil, in which case
1605 ELEMENT is added at the end.
1607 The return value is the new value of LIST-VAR.
1609 This is handy to add some elements to configuration variables,
1610 but please do not abuse it in Elisp code, where you are usually
1611 better off using `push' or `cl-pushnew'.
1613 If you want to use `add-to-list' on a variable that is not
1614 defined until a certain package is loaded, you should put the
1615 call to `add-to-list' into a hook function that will be run only
1616 after loading the package. `eval-after-load' provides one way to
1617 do this. In some cases other hooks, such as major mode hooks,
1622 ;; FIXME: Something like this could be used for `set' as well.
1623 (if (or (not (eq 'quote (car-safe list-var)))
1624 (special-variable-p (cadr list-var))
1625 (not (macroexp-const-p append)))
1627 (let* ((sym (cadr list-var))
1628 (append (eval append))
1629 (msg (format-message
1630 "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1632 ;; Big ugly hack so we only output a warning during
1633 ;; byte-compilation, and so we can use
1634 ;; byte-compile-not-lexical-var-p to silence the warning
1635 ;; when a defvar has been seen but not yet executed.
1637 ;; FIXME: We should also emit a warning for let-bound
1638 ;; variables with dynamic binding.
1639 (when (assq sym byte-compile--lexical-environment)
1640 (byte-compile-log-warning msg t :error))))
1642 (macroexp-let2 macroexp-copyable-p x element
1643 `(if ,(if compare-fn
1646 `(cl-member ,x ,sym :test ,compare-fn))
1647 ;; For bootstrapping reasons, don't rely on
1648 ;; cl--compiler-macro-member for the base case.
1652 `(setq ,sym (append ,sym (list ,x)))
1653 `(push ,x ,sym))))))
1654 (if (not (macroexp--compiling-p))
1657 (macroexp--funcall-if-compiled ',warnfun)
1661 (member element (symbol-value list-var)))
1662 ((eq compare-fn 'eq)
1663 (memq element (symbol-value list-var)))
1664 ((eq compare-fn 'eql)
1665 (memql element (symbol-value list-var)))
1667 (let ((lst (symbol-value list-var)))
1669 (not (funcall compare-fn element (car lst))))
1670 (setq lst (cdr lst)))
1672 (symbol-value list-var)
1675 (append (symbol-value list-var) (list element))
1676 (cons element (symbol-value list-var))))))
1679 (defun add-to-ordered-list (list-var element &optional order)
1680 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1681 The test for presence of ELEMENT is done with `eq'.
1683 The resulting list is reordered so that the elements are in the
1684 order given by each element's numeric list order. Elements
1685 without a numeric list order are placed at the end of the list.
1687 If the third optional argument ORDER is a number (integer or
1688 float), set the element's list order to the given value. If
1689 ORDER is nil or omitted, do not change the numeric order of
1690 ELEMENT. If ORDER has any other value, remove the numeric order
1691 of ELEMENT if it has one.
1693 The list order for each element is stored in LIST-VAR's
1694 `list-order' property.
1696 The return value is the new value of LIST-VAR."
1697 (let ((ordering (get list-var 'list-order)))
1699 (put list-var 'list-order
1700 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1702 (puthash element (and (numberp order) order) ordering))
1703 (unless (memq element (symbol-value list-var))
1704 (set list-var (cons element (symbol-value list-var))))
1705 (set list-var (sort (symbol-value list-var)
1707 (let ((oa (gethash a ordering))
1708 (ob (gethash b ordering)))
1713 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1714 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1715 Return the new history list.
1716 If MAXELT is non-nil, it specifies the maximum length of the history.
1717 Otherwise, the maximum history length is the value of the `history-length'
1718 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1720 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1721 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1722 if it is empty or a duplicate."
1724 (setq maxelt (or (get history-var 'history-length)
1726 (let ((history (symbol-value history-var))
1728 (when (and (listp history)
1730 (not (stringp newelt))
1731 (> (length newelt) 0))
1733 (not (equal (car history) newelt))))
1734 (if history-delete-duplicates
1735 (setq history (delete newelt history)))
1736 (setq history (cons newelt history))
1737 (when (integerp maxelt)
1740 (setq tail (nthcdr (1- maxelt) history))
1742 (setcdr tail nil)))))
1743 (set history-var history)))
1748 (defvar delay-mode-hooks nil
1749 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1750 (defvar delayed-mode-hooks nil
1751 "List of delayed mode hooks waiting to be run.")
1752 (make-variable-buffer-local 'delayed-mode-hooks)
1753 (put 'delay-mode-hooks 'permanent-local t)
1755 (defvar delayed-after-hook-forms nil
1756 "List of delayed :after-hook forms waiting to be run.
1757 These forms come from `define-derived-mode'.")
1758 (make-variable-buffer-local 'delayed-after-hook-forms)
1760 (defvar change-major-mode-after-body-hook nil
1761 "Normal hook run in major mode functions, before the mode hooks.")
1763 (defvar after-change-major-mode-hook nil
1764 "Normal hook run at the very end of major mode functions.")
1766 (defun run-mode-hooks (&rest hooks)
1767 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1768 Call `hack-local-variables' to set up file local and directory local
1771 If the variable `delay-mode-hooks' is non-nil, does not do anything,
1772 just adds the HOOKS to the list `delayed-mode-hooks'.
1773 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1774 `delayed-mode-hooks' (in reverse order), HOOKS, then runs
1775 `hack-local-variables', runs the hook `after-change-major-mode-hook', and
1776 finally evaluates the forms in `delayed-after-hook-forms' (see
1777 `define-derived-mode').
1779 Major mode functions should use this instead of `run-hooks' when
1780 running their FOO-mode-hook."
1781 (if delay-mode-hooks
1783 (dolist (hook hooks)
1784 (push hook delayed-mode-hooks))
1785 ;; Normal case, just run the hook as before plus any delayed hooks.
1786 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1787 (setq delayed-mode-hooks nil)
1788 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1789 (if (buffer-file-name)
1790 (with-demoted-errors "File local-variables error: %s"
1791 (hack-local-variables 'no-mode)))
1792 (run-hooks 'after-change-major-mode-hook)
1793 (dolist (form (nreverse delayed-after-hook-forms))
1795 (setq delayed-after-hook-forms nil)))
1797 (defmacro delay-mode-hooks (&rest body)
1798 "Execute BODY, but delay any `run-mode-hooks'.
1799 These hooks will be executed by the first following call to
1800 `run-mode-hooks' that occurs outside any `delay-mode-hooks' form.
1801 Only affects hooks run in the current buffer."
1802 (declare (debug t) (indent 0))
1804 (make-local-variable 'delay-mode-hooks)
1805 (let ((delay-mode-hooks t))
1808 ;; PUBLIC: find if the current mode derives from another.
1810 (defun derived-mode-p (&rest modes)
1811 "Non-nil if the current major mode is derived from one of MODES.
1812 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1813 (let ((parent major-mode))
1814 (while (and (not (memq parent modes))
1815 (setq parent (get parent 'derived-mode-parent))))
1820 ;; If a minor mode is not defined with define-minor-mode,
1821 ;; add it here explicitly.
1822 ;; isearch-mode is deliberately excluded, since you should
1823 ;; not call it yourself.
1824 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1825 overwrite-mode view-mode
1827 "List of all minor mode functions.")
1829 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1830 "Register a new minor mode.
1832 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1834 TOGGLE is a symbol which is the name of a buffer-local variable that
1835 is toggled on or off to say whether the minor mode is active or not.
1837 NAME specifies what will appear in the mode line when the minor mode
1838 is active. NAME should be either a string starting with a space, or a
1839 symbol whose value is such a string.
1841 Optional KEYMAP is the keymap for the minor mode that will be added
1842 to `minor-mode-map-alist'.
1844 Optional AFTER specifies that TOGGLE should be added after AFTER
1845 in `minor-mode-alist'.
1847 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1848 It defaults to (and should by convention be) TOGGLE.
1850 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1851 included in the mode-line minor mode menu.
1852 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1853 (unless (memq toggle minor-mode-list)
1854 (push toggle minor-mode-list))
1856 (unless toggle-fun (setq toggle-fun toggle))
1857 (unless (eq toggle-fun toggle)
1858 (put toggle :minor-mode-function toggle-fun))
1859 ;; Add the name to the minor-mode-alist.
1861 (let ((existing (assq toggle minor-mode-alist)))
1863 (setcdr existing (list name))
1864 (let ((tail minor-mode-alist) found)
1865 (while (and tail (not found))
1866 (if (eq after (caar tail))
1868 (setq tail (cdr tail))))
1870 (let ((rest (cdr found)))
1872 (nconc found (list (list toggle name)) rest))
1873 (push (list toggle name) minor-mode-alist))))))
1874 ;; Add the toggle to the minor-modes menu if requested.
1875 (when (get toggle :included)
1876 (define-key mode-line-mode-menu
1880 (or (get toggle :menu-tag)
1881 (if (stringp name) name (symbol-name toggle)))
1882 (let ((mode-name (if (symbolp name) (symbol-value name))))
1883 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1884 (concat " (" (match-string 0 mode-name) ")"))))
1886 :button (cons :toggle toggle))))
1888 ;; Add the map to the minor-mode-map-alist.
1890 (let ((existing (assq toggle minor-mode-map-alist)))
1892 (setcdr existing keymap)
1893 (let ((tail minor-mode-map-alist) found)
1894 (while (and tail (not found))
1895 (if (eq after (caar tail))
1897 (setq tail (cdr tail))))
1899 (let ((rest (cdr found)))
1901 (nconc found (list (cons toggle keymap)) rest))
1902 (push (cons toggle keymap) minor-mode-map-alist)))))))
1906 (defsubst autoloadp (object)
1907 "Non-nil if OBJECT is an autoload."
1908 (eq 'autoload (car-safe object)))
1910 ;; (defun autoload-type (object)
1911 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1912 ;; OBJECT should be an autoload object."
1913 ;; (when (autoloadp object)
1914 ;; (let ((type (nth 3 object)))
1915 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1916 ;; ((eq 'keymap t) 'macro)
1919 ;; (defalias 'autoload-file #'cadr
1920 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1921 ;; \n\(fn AUTOLOAD)")
1923 (defun symbol-file (symbol &optional type)
1924 "Return the name of the file that defined SYMBOL.
1925 The value is normally an absolute file name. It can also be nil,
1926 if the definition is not associated with any file. If SYMBOL
1927 specifies an autoloaded function, the value can be a relative
1928 file name without extension.
1930 If TYPE is nil, then any kind of definition is acceptable. If
1931 TYPE is `defun', `defvar', or `defface', that specifies function
1932 definition, variable definition, or face definition only."
1933 (if (and (or (null type) (eq type 'defun))
1935 (autoloadp (symbol-function symbol)))
1936 (nth 1 (symbol-function symbol))
1937 (let ((files load-history)
1941 (if (eq type 'defvar)
1942 ;; Variables are present just as their names.
1943 (member symbol (cdr (car files)))
1944 ;; Other types are represented as (TYPE . NAME).
1945 (member (cons type symbol) (cdr (car files))))
1946 ;; We accept all types, so look for variable def
1947 ;; and then for any other kind.
1948 (or (member symbol (cdr (car files)))
1949 (rassq symbol (cdr (car files)))))
1950 (setq file (car (car files)) files nil))
1951 (setq files (cdr files)))
1954 (defun locate-library (library &optional nosuffix path interactive-call)
1955 "Show the precise file name of Emacs library LIBRARY.
1956 LIBRARY should be a relative file name of the library, a string.
1957 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1958 nil (which is the default, see below).
1959 This command searches the directories in `load-path' like `\\[load-library]'
1960 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1961 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1962 to the specified name LIBRARY.
1964 If the optional third arg PATH is specified, that list of directories
1965 is used instead of `load-path'.
1967 When called from a program, the file name is normally returned as a
1968 string. When run interactively, the argument INTERACTIVE-CALL is t,
1969 and the file name is displayed in the echo area."
1970 (interactive (list (completing-read "Locate library: "
1972 'locate-file-completion-table
1973 load-path (get-load-suffixes)))
1976 (let ((file (locate-file library
1978 (append (unless nosuffix (get-load-suffixes))
1979 load-file-rep-suffixes))))
1980 (if interactive-call
1982 (message "Library is file %s" (abbreviate-file-name file))
1983 (message "No library %s in search path" library)))
1989 (defun start-process (name buffer program &rest program-args)
1990 "Start a program in a subprocess. Return the process object for it.
1991 NAME is name for process. It is modified if necessary to make it unique.
1992 BUFFER is the buffer (or buffer name) to associate with the process.
1994 Process output (both standard output and standard error streams) goes
1995 at end of BUFFER, unless you specify an output stream or filter
1996 function to handle the output. BUFFER may also be nil, meaning that
1997 this process is not associated with any buffer.
1999 PROGRAM is the program file name. It is searched for in `exec-path'
2000 \(which see). If nil, just associate a pty with the buffer. Remaining
2001 arguments are strings to give program as arguments.
2003 If you want to separate standard output from standard error, use
2004 `make-process' or invoke the command through a shell and redirect
2005 one of them using the shell syntax."
2006 (unless (fboundp 'make-process)
2007 (error "Emacs was compiled without subprocess support"))
2008 (apply #'make-process
2009 (append (list :name name :buffer buffer)
2011 (list :command (cons program program-args))))))
2013 (defun process-lines (program &rest args)
2014 "Execute PROGRAM with ARGS, returning its output as a list of lines.
2015 Signal an error if the program returns with a non-zero exit status."
2017 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
2018 (unless (eq status 0)
2019 (error "%s exited with status %s" program status))
2020 (goto-char (point-min))
2023 (setq lines (cons (buffer-substring-no-properties
2024 (line-beginning-position)
2025 (line-end-position))
2028 (nreverse lines)))))
2030 (defun process-live-p (process)
2031 "Returns non-nil if PROCESS is alive.
2032 A process is considered alive if its status is `run', `open',
2033 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
2035 (and (processp process)
2036 (memq (process-status process)
2037 '(run open listen connect stop))))
2041 (defun process-kill-without-query (process &optional _flag)
2042 "Say no query needed if PROCESS is running when Emacs is exited.
2043 Optional second argument if non-nil says to require a query.
2044 Value is t if a query was formerly required."
2046 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
2048 (let ((old (process-query-on-exit-flag process)))
2049 (set-process-query-on-exit-flag process nil)
2052 (defun process-kill-buffer-query-function ()
2053 "Ask before killing a buffer that has a running process."
2054 (let ((process (get-buffer-process (current-buffer))))
2056 (not (memq (process-status process) '(run stop open listen)))
2057 (not (process-query-on-exit-flag process))
2059 (format "Buffer %S has a running process; kill it? "
2060 (buffer-name (current-buffer)))))))
2062 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
2064 ;; process plist management
2066 (defun process-get (process propname)
2067 "Return the value of PROCESS' PROPNAME property.
2068 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
2069 (plist-get (process-plist process) propname))
2071 (defun process-put (process propname value)
2072 "Change PROCESS' PROPNAME property to VALUE.
2073 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2074 (set-process-plist process
2075 (plist-put (process-plist process) propname value)))
2078 ;;;; Input and display facilities.
2080 (defconst read-key-empty-map (make-sparse-keymap))
2082 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2084 (defun read-key (&optional prompt)
2085 "Read a key from the keyboard.
2086 Contrary to `read-event' this will not return a raw event but instead will
2087 obey the input decoding and translations usually done by `read-key-sequence'.
2088 So escape sequences and keyboard encoding are taken into account.
2089 When there's an ambiguity because the key looks like the prefix of
2090 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2091 ;; This overriding-terminal-local-map binding also happens to
2092 ;; disable quail's input methods, so although read-key-sequence
2093 ;; always inherits the input method, in practice read-key does not
2094 ;; inherit the input method (at least not if it's based on quail).
2095 (let ((overriding-terminal-local-map nil)
2096 (overriding-local-map read-key-empty-map)
2098 (old-global-map (current-global-map))
2099 (timer (run-with-idle-timer
2100 ;; Wait long enough that Emacs has the time to receive and
2101 ;; process all the raw events associated with the single-key.
2102 ;; But don't wait too long, or the user may find the delay
2103 ;; annoying (or keep hitting more keys which may then get
2104 ;; lost or misinterpreted).
2105 ;; This is only relevant for keys which Emacs perceives as
2106 ;; "prefixes", such as C-x (because of the C-x 8 map in
2107 ;; key-translate-table and the C-x @ map in function-key-map)
2108 ;; or ESC (because of terminal escape sequences in
2109 ;; input-decode-map).
2112 (let ((keys (this-command-keys-vector)))
2113 (unless (zerop (length keys))
2114 ;; `keys' is non-empty, so the user has hit at least
2115 ;; one key; there's no point waiting any longer, even
2116 ;; though read-key-sequence thinks we should wait
2117 ;; for more input to decide how to interpret the
2119 (throw 'read-key keys)))))))
2123 (let ((map (make-sparse-keymap)))
2124 ;; Don't hide the menu-bar and tool-bar entries.
2125 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2126 (define-key map [tool-bar]
2127 ;; This hack avoids evaluating the :filter (Bug#9922).
2128 (or (cdr (assq 'tool-bar global-map))
2129 (lookup-key global-map [tool-bar])))
2132 (catch 'read-key (read-key-sequence-vector prompt nil t)))
2133 (key (aref keys 0)))
2134 (if (and (> (length keys) 1)
2135 (memq key '(mode-line header-line
2136 left-fringe right-fringe)))
2139 (cancel-timer timer)
2140 ;; For some reason, `read-key(-sequence)' leaves the prompt in the echo
2141 ;; area, whereas `read-event' seems to empty it just before returning
2142 ;; (bug#22714). So, let's mimic the behavior of `read-event'.
2144 (use-global-map old-global-map))))
2146 (defvar read-passwd-map
2147 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2148 ;; minibuffer-local-map along the way!
2149 (let ((map (make-sparse-keymap)))
2150 (set-keymap-parent map minibuffer-local-map)
2151 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2153 "Keymap used while reading passwords.")
2155 (defun read-passwd (prompt &optional confirm default)
2156 "Read a password, prompting with PROMPT, and return it.
2157 If optional CONFIRM is non-nil, read the password twice to make sure.
2158 Optional DEFAULT is a default password to use instead of empty input.
2160 This function echoes `.' for each character that the user types.
2161 You could let-bind `read-hide-char' to another hiding character, though.
2163 Once the caller uses the password, it can erase the password
2164 by doing (clear-string STRING)."
2167 (while (not success)
2168 (let ((first (read-passwd prompt nil default))
2169 (second (read-passwd "Confirm password: " nil default)))
2170 (if (equal first second)
2172 (and (arrayp second) (clear-string second))
2173 (setq success first))
2174 (and (arrayp first) (clear-string first))
2175 (and (arrayp second) (clear-string second))
2176 (message "Password not repeated accurately; please start over")
2179 (let ((hide-chars-fun
2180 (lambda (beg end _len)
2181 (clear-this-command-keys)
2182 (setq beg (min end (max (minibuffer-prompt-end)
2184 (dotimes (i (- end beg))
2185 (put-text-property (+ i beg) (+ 1 i beg)
2186 'display (string (or read-hide-char ?.))))))
2188 (minibuffer-with-setup-hook
2190 (setq minibuf (current-buffer))
2191 ;; Turn off electricity.
2192 (setq-local post-self-insert-hook nil)
2193 (setq-local buffer-undo-list t)
2194 (setq-local select-active-regions nil)
2195 (use-local-map read-passwd-map)
2196 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2197 (setq-local show-paren-mode nil) ;bug#16091.
2198 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2200 (let ((enable-recursive-minibuffers t)
2201 (read-hide-char (or read-hide-char ?.)))
2202 (read-string prompt nil t default)) ; t = "no history"
2203 (when (buffer-live-p minibuf)
2204 (with-current-buffer minibuf
2205 ;; Not sure why but it seems that there might be cases where the
2206 ;; minibuffer is not always properly reset later on, so undo
2207 ;; whatever we've done here (bug#11392).
2208 (remove-hook 'after-change-functions hide-chars-fun 'local)
2209 (kill-local-variable 'post-self-insert-hook)
2210 ;; And of course, don't keep the sensitive data around.
2211 (erase-buffer))))))))
2213 (defun read-number (prompt &optional default)
2214 "Read a numeric value in the minibuffer, prompting with PROMPT.
2215 DEFAULT specifies a default value to return if the user just types RET.
2216 The value of DEFAULT is inserted into PROMPT.
2217 This function is used by the `interactive' code letter `n'."
2219 (default1 (if (consp default) (car default) default)))
2222 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2223 (replace-match (format " (default %s)" default1) t t prompt 1)
2224 (replace-regexp-in-string "[ \t]*\\'"
2225 (format " (default %s) " default1)
2229 (let ((str (read-from-minibuffer
2230 prompt nil nil nil nil
2233 (mapcar 'number-to-string (delq nil default))
2234 (number-to-string default))))))
2237 ((zerop (length str)) default1)
2238 ((stringp str) (read str))))
2241 (message "Please enter a number.")
2246 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2247 "Read and return one of CHARS, prompting for PROMPT.
2248 Any input that is not one of CHARS is ignored.
2250 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2251 keyboard-quit events while waiting for a valid input."
2252 (unless (consp chars)
2253 (error "Called `read-char-choice' without valid char choices"))
2254 (let (char done show-help (helpbuf " *Char Help*"))
2255 (let ((cursor-in-echo-area t)
2256 (executing-kbd-macro executing-kbd-macro)
2258 (save-window-excursion ; in case we call help-form-show
2260 (unless (get-text-property 0 'face prompt)
2261 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2262 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2264 (and show-help (buffer-live-p (get-buffer helpbuf))
2265 (kill-buffer helpbuf))
2267 ((not (numberp char)))
2268 ;; If caller has set help-form, that's enough.
2269 ;; They don't explicitly have to add help-char to chars.
2276 ((and executing-kbd-macro (= char -1))
2277 ;; read-event returns -1 if we are in a kbd macro and
2278 ;; there are no more events in the macro. Attempt to
2279 ;; get an event interactively.
2280 (setq executing-kbd-macro nil))
2281 ((not inhibit-keyboard-quit)
2283 ((and (null esc-flag) (eq char ?\e))
2285 ((memq char '(?\C-g ?\e))
2286 (keyboard-quit))))))))
2287 ;; Display the question with the answer. But without cursor-in-echo-area.
2288 (message "%s%s" prompt (char-to-string char))
2291 (defun read-multiple-choice (prompt choices)
2292 "Ask user a multiple choice question.
2293 PROMPT should be a string that will be displayed as the prompt.
2295 CHOICES is an alist where the first element in each entry is a
2296 character to be entered, the second element is a short name for
2297 the entry to be displayed while prompting (if there's room, it
2298 might be shortened), and the third, optional entry is a longer
2299 explanation that will be displayed in a help buffer if the user
2302 This function translates user input into responses by consulting
2303 the bindings in `query-replace-map'; see the documentation of
2304 that variable for more information. In this case, the useful
2305 bindings are `recenter', `scroll-up', and `scroll-down'. If the
2306 user enters `recenter', `scroll-up', or `scroll-down' responses,
2307 perform the requested window recentering or scrolling and ask
2310 The return value is the matching entry from the CHOICES list.
2314 \(read-multiple-choice \"Continue connecting?\"
2316 (?s \"session only\")
2318 (let* ((altered-names nil)
2325 (let* ((name (cadr elem))
2326 (pos (seq-position name (car elem)))
2329 ;; Not in the name string.
2331 (format "[%c] %s" (car elem) name))
2332 ;; The prompt character is in the name, so highlight
2333 ;; it on graphical terminals...
2334 ((display-supports-face-attributes-p
2335 '(:underline t) (window-frame))
2336 (setq name (copy-sequence name))
2337 (put-text-property pos (1+ pos)
2338 'face 'read-multiple-choice-face
2341 ;; And put it in [bracket] on non-graphical terminals.
2344 (substring name 0 pos)
2346 (upcase (substring name pos (1+ pos)))
2348 (substring name (1+ pos)))))))
2349 (push (cons (car elem) altered-name)
2352 (append choices '((?? "?")))
2354 tchar buf wrong-char answer)
2355 (save-window-excursion
2364 (if (and (display-popup-menus-p)
2365 last-input-event ; not during startup
2366 (listp last-nonmenu-event)
2373 (cons (capitalize (cadr elem))
2377 (let ((cursor-in-echo-area t))
2380 (setq answer (lookup-key query-replace-map (vector tchar) t))
2383 ((eq answer 'recenter)
2385 ((eq answer 'scroll-up)
2386 (ignore-errors (scroll-up-command)) t)
2387 ((eq answer 'scroll-down)
2388 (ignore-errors (scroll-down-command)) t)
2389 ((eq answer 'scroll-other-window)
2390 (ignore-errors (scroll-other-window)) t)
2391 ((eq answer 'scroll-other-window-down)
2392 (ignore-errors (scroll-other-window-down)) t)
2395 (setq wrong-char nil
2397 ;; The user has entered an invalid choice, so display the
2399 (when (and (not (eq tchar nil))
2400 (not (assq tchar choices)))
2401 (setq wrong-char (not (memq tchar '(?? ?\C-h)))
2405 (with-help-window (setq buf (get-buffer-create
2406 "*Multiple Choice Help*"))
2407 (with-current-buffer buf
2410 (insert prompt "\n\n")
2411 (let* ((columns (/ (window-width) 25))
2415 (dolist (elem choices)
2417 (unless (zerop times)
2418 (if (zerop (mod times columns))
2419 ;; Go to the next "line".
2420 (goto-char (setq start (point-max)))
2424 (insert (make-string (max (- (* (mod times columns)
2430 (setq times (1+ times))
2436 (cdr (assq (car elem) altered-names))))
2437 (fill-region (point-min) (point-max))
2439 (let ((start (point)))
2440 (insert (nth 2 elem))
2443 (fill-region start (point-max))))
2446 (dolist (line (split-string text "\n"))
2451 (forward-line 1)))))))))))
2452 (when (buffer-live-p buf)
2454 (assq tchar choices)))
2456 (defun sit-for (seconds &optional nodisp obsolete)
2457 "Redisplay, then wait for SECONDS seconds. Stop when input is available.
2458 SECONDS may be a floating-point value.
2459 \(On operating systems that do not support waiting for fractions of a
2460 second, floating-point values are rounded down to the nearest integer.)
2462 If optional arg NODISP is t, don't redisplay, just wait for input.
2463 Redisplay does not happen if input is available before it starts.
2465 Value is t if waited the full time with no input arriving, and nil otherwise.
2467 An obsolete, but still supported form is
2468 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2469 where the optional arg MILLISECONDS specifies an additional wait period,
2470 in milliseconds; this was useful when Emacs was built without
2471 floating point support."
2472 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2473 ;; This used to be implemented in C until the following discussion:
2474 ;; http://lists.gnu.org/archive/html/emacs-devel/2006-07/msg00401.html
2475 ;; Then it was moved here using an implementation based on an idle timer,
2476 ;; which was then replaced by the use of read-event.
2477 (if (numberp nodisp)
2478 (setq seconds (+ seconds (* 1e-3 nodisp))
2480 (if obsolete (setq nodisp obsolete)))
2485 ((input-pending-p t)
2488 ;; We are going to call read-event below, which will record
2489 ;; the the next key as part of the macro, even if that key
2490 ;; invokes kmacro-end-macro, so if we are recording a macro,
2491 ;; the macro will recursively call itself. In addition, when
2492 ;; that key is removed from unread-command-events, it will be
2493 ;; recorded the second time, so the macro will have each key
2494 ;; doubled. This used to happen if a macro was defined with
2495 ;; Flyspell mode active (because Flyspell calls sit-for in its
2496 ;; post-command-hook, see bug #21329.) To avoid all that, we
2497 ;; simply disable the wait when we are recording a macro.
2499 (or nodisp (redisplay)))
2501 (or nodisp (redisplay))
2502 ;; FIXME: we should not read-event here at all, because it's much too
2503 ;; difficult to reliably "undo" a read-event by pushing it onto
2504 ;; unread-command-events.
2505 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2506 ;; decoding (hence non-nil as second arg under POSIX ttys).
2507 ;; For bug#15614, we need read-event not to inherit-input-method.
2508 ;; So we temporarily suspend input-method-function.
2509 (let ((read (let ((input-method-function nil))
2510 (read-event nil t seconds))))
2513 ;; https://lists.gnu.org/archive/html/emacs-devel/2006-10/msg00394.html
2514 ;; We want `read' appear in the next command's this-command-event
2515 ;; but not in the current one.
2516 ;; By pushing (cons t read), we indicate that `read' has not
2517 ;; yet been recorded in this-command-keys, so it will be recorded
2518 ;; next time it's read.
2519 ;; And indeed the `seconds' argument to read-event correctly
2520 ;; prevented recording this event in the current command's
2521 ;; this-command-keys.
2522 (push (cons t read) unread-command-events)
2525 ;; Behind display-popup-menus-p test.
2526 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2528 (defun y-or-n-p (prompt)
2529 "Ask user a \"y or n\" question.
2530 Return t if answer is \"y\" and nil if it is \"n\".
2531 PROMPT is the string to display to ask the question. It should
2532 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2534 No confirmation of the answer is requested; a single character is
2535 enough. SPC also means yes, and DEL means no.
2537 To be precise, this function translates user input into responses
2538 by consulting the bindings in `query-replace-map'; see the
2539 documentation of that variable for more information. In this
2540 case, the useful bindings are `act', `skip', `recenter',
2541 `scroll-up', `scroll-down', and `quit'.
2542 An `act' response means yes, and a `skip' response means no.
2543 A `quit' response means to invoke `keyboard-quit'.
2544 If the user enters `recenter', `scroll-up', or `scroll-down'
2545 responses, perform the requested window recentering or scrolling
2548 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2549 is nil and `use-dialog-box' is non-nil."
2550 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2551 ;; where all the keys were unbound (i.e. it somehow got triggered
2552 ;; within read-key, apparently). I had to kill it.
2553 (let ((answer 'recenter)
2554 (padded (lambda (prompt &optional dialog)
2555 (let ((l (length prompt)))
2557 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2559 (if dialog "" "(y or n) "))))))
2562 (setq prompt (funcall padded prompt))
2563 (let ((temp-prompt prompt))
2564 (while (not (memq answer '(act skip)))
2565 (let ((str (read-string temp-prompt)))
2566 (cond ((member str '("y" "Y")) (setq answer 'act))
2567 ((member str '("n" "N")) (setq answer 'skip))
2568 (t (setq temp-prompt (concat "Please answer y or n. "
2570 ((and (display-popup-menus-p)
2571 last-input-event ; not during startup
2572 (listp last-nonmenu-event)
2574 (setq prompt (funcall padded prompt t)
2575 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2577 (setq prompt (funcall padded prompt))
2579 (let* ((scroll-actions '(recenter scroll-up scroll-down
2580 scroll-other-window scroll-other-window-down))
2582 (let ((cursor-in-echo-area t))
2583 (when minibuffer-auto-raise
2584 (raise-frame (window-frame (minibuffer-window))))
2585 (read-key (propertize (if (memq answer scroll-actions)
2587 (concat "Please answer y or n. "
2589 'face 'minibuffer-prompt)))))
2590 (setq answer (lookup-key query-replace-map (vector key) t))
2592 ((memq answer '(skip act)) nil)
2593 ((eq answer 'recenter)
2595 ((eq answer 'scroll-up)
2596 (ignore-errors (scroll-up-command)) t)
2597 ((eq answer 'scroll-down)
2598 (ignore-errors (scroll-down-command)) t)
2599 ((eq answer 'scroll-other-window)
2600 (ignore-errors (scroll-other-window)) t)
2601 ((eq answer 'scroll-other-window-down)
2602 (ignore-errors (scroll-other-window-down)) t)
2603 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2604 (signal 'quit nil) t)
2608 (let ((ret (eq answer 'act)))
2609 (unless noninteractive
2610 (message "%s%c" prompt (if ret ?y ?n)))
2614 ;;; Atomic change groups.
2616 (defmacro atomic-change-group (&rest body)
2617 "Perform BODY as an atomic change group.
2618 This means that if BODY exits abnormally,
2619 all of its changes to the current buffer are undone.
2620 This works regardless of whether undo is enabled in the buffer.
2622 This mechanism is transparent to ordinary use of undo;
2623 if undo is enabled in the buffer and BODY succeeds, the
2624 user can undo the change normally."
2625 (declare (indent 0) (debug t))
2626 (let ((handle (make-symbol "--change-group-handle--"))
2627 (success (make-symbol "--change-group-success--")))
2628 `(let ((,handle (prepare-change-group))
2629 ;; Don't truncate any undo data in the middle of this.
2630 (undo-outer-limit nil)
2631 (undo-limit most-positive-fixnum)
2632 (undo-strong-limit most-positive-fixnum)
2636 ;; This is inside the unwind-protect because
2637 ;; it enables undo if that was disabled; we need
2638 ;; to make sure that it gets disabled again.
2639 (activate-change-group ,handle)
2642 ;; Either of these functions will disable undo
2643 ;; if it was disabled before.
2645 (accept-change-group ,handle)
2646 (cancel-change-group ,handle))))))
2648 (defun prepare-change-group (&optional buffer)
2649 "Return a handle for the current buffer's state, for a change group.
2650 If you specify BUFFER, make a handle for BUFFER's state instead.
2652 Pass the handle to `activate-change-group' afterward to initiate
2653 the actual changes of the change group.
2655 To finish the change group, call either `accept-change-group' or
2656 `cancel-change-group' passing the same handle as argument. Call
2657 `accept-change-group' to accept the changes in the group as final;
2658 call `cancel-change-group' to undo them all. You should use
2659 `unwind-protect' to make sure the group is always finished. The call
2660 to `activate-change-group' should be inside the `unwind-protect'.
2661 Once you finish the group, don't use the handle again--don't try to
2662 finish the same group twice. For a simple example of correct use, see
2663 the source code of `atomic-change-group'.
2665 The handle records only the specified buffer. To make a multibuffer
2666 change group, call this function once for each buffer you want to
2667 cover, then use `nconc' to combine the returned values, like this:
2669 (nconc (prepare-change-group buffer-1)
2670 (prepare-change-group buffer-2))
2672 You can then activate that multibuffer change group with a single
2673 call to `activate-change-group' and finish it with a single call
2674 to `accept-change-group' or `cancel-change-group'."
2677 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2678 (list (cons (current-buffer) buffer-undo-list))))
2680 (defun activate-change-group (handle)
2681 "Activate a change group made with `prepare-change-group' (which see)."
2682 (dolist (elt handle)
2683 (with-current-buffer (car elt)
2684 (if (eq buffer-undo-list t)
2685 (setq buffer-undo-list nil)))))
2687 (defun accept-change-group (handle)
2688 "Finish a change group made with `prepare-change-group' (which see).
2689 This finishes the change group by accepting its changes as final."
2690 (dolist (elt handle)
2691 (with-current-buffer (car elt)
2692 (if (eq (cdr elt) t)
2693 (setq buffer-undo-list t)))))
2695 (defun cancel-change-group (handle)
2696 "Finish a change group made with `prepare-change-group' (which see).
2697 This finishes the change group by reverting all of its changes."
2698 (dolist (elt handle)
2699 (with-current-buffer (car elt)
2700 (setq elt (cdr elt))
2702 ;; Widen buffer temporarily so if the buffer was narrowed within
2703 ;; the body of `atomic-change-group' all changes can be undone.
2706 (if (consp elt) (car elt)))
2708 (if (consp elt) (cdr elt))))
2709 ;; Temporarily truncate the undo log at ELT.
2711 (setcar elt nil) (setcdr elt nil))
2712 (unless (eq last-command 'undo) (undo-start))
2713 ;; Make sure there's no confusion.
2714 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2715 (error "Undoing to some unrelated state"))
2718 (while (listp pending-undo-list) (undo-more 1)))
2719 ;; Reset the modified cons cell ELT to its original content.
2721 (setcar elt old-car)
2722 (setcdr elt old-cdr))
2723 ;; Revert the undo info to what it was when we grabbed the state.
2724 (setq buffer-undo-list elt))))))
2726 ;;;; Display-related functions.
2728 ;; For compatibility.
2729 (define-obsolete-function-alias 'redraw-modeline
2730 'force-mode-line-update "24.3")
2732 (defun momentary-string-display (string pos &optional exit-char message)
2733 "Momentarily display STRING in the buffer at POS.
2734 Display remains until next event is input.
2735 If POS is a marker, only its position is used; its buffer is ignored.
2736 Optional third arg EXIT-CHAR can be a character, event or event
2737 description list. EXIT-CHAR defaults to SPC. If the input is
2738 EXIT-CHAR it is swallowed; otherwise it is then available as
2739 input (as a command if nothing else).
2740 Display MESSAGE (optional fourth arg) in the echo area.
2741 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2742 (or exit-char (setq exit-char ?\s))
2743 (let ((ol (make-overlay pos pos))
2744 (str (copy-sequence string)))
2748 (overlay-put ol 'after-string str)
2750 ;; To avoid trouble with out-of-bounds position
2752 ;; If the string end is off screen, recenter now.
2753 (if (<= (window-end nil t) pos)
2754 (recenter (/ (window-height) 2))))
2755 (message (or message "Type %s to continue editing.")
2756 (single-key-description exit-char))
2757 (let ((event (read-key)))
2758 ;; `exit-char' can be an event, or an event description list.
2759 (or (eq event exit-char)
2760 (eq event (event-convert-list exit-char))
2761 (setq unread-command-events
2762 (append (this-single-command-raw-keys)
2763 unread-command-events)))))
2764 (delete-overlay ol))))
2767 ;;;; Overlay operations
2769 (defun copy-overlay (o)
2770 "Return a copy of overlay O."
2771 (let ((o1 (if (overlay-buffer o)
2772 (make-overlay (overlay-start o) (overlay-end o)
2773 ;; FIXME: there's no easy way to find the
2774 ;; insertion-type of the two markers.
2776 (let ((o1 (make-overlay (point-min) (point-min))))
2779 (props (overlay-properties o)))
2781 (overlay-put o1 (pop props) (pop props)))
2784 (defun remove-overlays (&optional beg end name val)
2785 "Clear BEG and END of overlays whose property NAME has value VAL.
2786 Overlays might be moved and/or split.
2787 BEG and END default respectively to the beginning and end of buffer."
2788 ;; This speeds up the loops over overlays.
2789 (unless beg (setq beg (point-min)))
2790 (unless end (setq end (point-max)))
2791 (overlay-recenter end)
2793 (setq beg (prog1 end (setq end beg))))
2795 (dolist (o (overlays-in beg end))
2796 (when (eq (overlay-get o name) val)
2797 ;; Either push this overlay outside beg...end
2798 ;; or split it to exclude beg...end
2799 ;; or delete it entirely (if it is contained in beg...end).
2800 (if (< (overlay-start o) beg)
2801 (if (> (overlay-end o) end)
2803 (move-overlay (copy-overlay o)
2804 (overlay-start o) beg)
2805 (move-overlay o end (overlay-end o)))
2806 (move-overlay o (overlay-start o) beg))
2807 (if (> (overlay-end o) end)
2808 (move-overlay o end (overlay-end o))
2809 (delete-overlay o)))))))
2813 (defvar suspend-hook nil
2814 "Normal hook run by `suspend-emacs', before suspending.")
2816 (defvar suspend-resume-hook nil
2817 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2819 (defvar temp-buffer-show-hook nil
2820 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2821 When the hook runs, the temporary buffer is current, and the window it
2822 was displayed in is selected.")
2824 (defvar temp-buffer-setup-hook nil
2825 "Normal hook run by `with-output-to-temp-buffer' at the start.
2826 When the hook runs, the temporary buffer is current.
2827 This hook is normally set up with a function to put the buffer in Help
2830 (defconst user-emacs-directory
2831 (if (eq system-type 'ms-dos)
2832 ;; MS-DOS cannot have initial dot.
2835 "Directory beneath which additional per-user Emacs-specific files are placed.
2836 Various programs in Emacs store information in this directory.
2837 Note that this should end with a directory separator.
2838 See also `locate-user-emacs-file'.")
2840 ;;;; Misc. useful functions.
2842 (defsubst buffer-narrowed-p ()
2843 "Return non-nil if the current buffer is narrowed."
2844 (/= (- (point-max) (point-min)) (buffer-size)))
2846 (defun find-tag-default-bounds ()
2847 "Determine the boundaries of the default tag, based on text at point.
2848 Return a cons cell with the beginning and end of the found tag.
2849 If there is no plausible default, return nil."
2850 (bounds-of-thing-at-point 'symbol))
2852 (defun find-tag-default ()
2853 "Determine default tag to search for, based on text at point.
2854 If there is no plausible default, return nil."
2855 (let ((bounds (find-tag-default-bounds)))
2857 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2859 (defun find-tag-default-as-regexp ()
2860 "Return regexp that matches the default tag at point.
2861 If there is no tag at point, return nil.
2863 When in a major mode that does not provide its own
2864 `find-tag-default-function', return a regexp that matches the
2865 symbol at point exactly."
2866 (let ((tag (funcall (or find-tag-default-function
2867 (get major-mode 'find-tag-default-function)
2868 'find-tag-default))))
2869 (if tag (regexp-quote tag))))
2871 (defun find-tag-default-as-symbol-regexp ()
2872 "Return regexp that matches the default tag at point as symbol.
2873 If there is no tag at point, return nil.
2875 When in a major mode that does not provide its own
2876 `find-tag-default-function', return a regexp that matches the
2877 symbol at point exactly."
2878 (let ((tag-regexp (find-tag-default-as-regexp)))
2880 (eq (or find-tag-default-function
2881 (get major-mode 'find-tag-default-function)
2884 (format "\\_<%s\\_>" tag-regexp)
2887 (defun play-sound (sound)
2888 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2889 The following keywords are recognized:
2891 :file FILE - read sound data from FILE. If FILE isn't an
2892 absolute file name, it is searched in `data-directory'.
2894 :data DATA - read sound data from string DATA.
2896 Exactly one of :file or :data must be present.
2898 :volume VOL - set volume to VOL. VOL must an integer in the
2899 range 0..100 or a float in the range 0..1.0. If not specified,
2900 don't change the volume setting of the sound device.
2902 :device DEVICE - play sound on DEVICE. If not specified,
2903 a system-dependent default device name is used.
2905 Note: :data and :device are currently not supported on Windows."
2906 (if (fboundp 'play-sound-internal)
2907 (play-sound-internal sound)
2908 (error "This Emacs binary lacks sound support")))
2910 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2912 (defun shell-quote-argument (argument)
2913 "Quote ARGUMENT for passing as argument to an inferior shell.
2915 This function is designed to work with the syntax of your system's
2916 standard shell, and might produce incorrect results with unusual shells.
2917 See Info node `(elisp)Security Considerations'."
2919 ((eq system-type 'ms-dos)
2920 ;; Quote using double quotes, but escape any existing quotes in
2921 ;; the argument with backslashes.
2925 (if (or (null (string-match "[^\"]" argument))
2926 (< (match-end 0) (length argument)))
2927 (while (string-match "[\"]" argument start)
2928 (setq end (match-beginning 0)
2929 result (concat result (substring argument start end)
2930 "\\" (substring argument end (1+ end)))
2932 (concat "\"" result (substring argument start) "\"")))
2934 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2936 ;; First, quote argument so that CommandLineToArgvW will
2937 ;; understand it. See
2938 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2939 ;; After we perform that level of quoting, escape shell
2940 ;; metacharacters so that cmd won't mangle our argument. If the
2941 ;; argument contains no double quote characters, we can just
2942 ;; surround it with double quotes. Otherwise, we need to prefix
2943 ;; each shell metacharacter with a caret.
2946 ;; escape backslashes at end of string
2947 (replace-regexp-in-string
2950 ;; escape backslashes and quotes in string body
2951 (replace-regexp-in-string
2956 (if (string-match "[%!\"]" argument)
2959 (replace-regexp-in-string
2960 "\\([%!()\"<>&|^]\\)"
2964 (concat "\"" argument "\"")))
2967 (if (equal argument "")
2969 ;; Quote everything except POSIX filename characters.
2970 ;; This should be safe enough even for really weird shells.
2971 (replace-regexp-in-string
2973 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2976 (defun string-or-null-p (object)
2977 "Return t if OBJECT is a string or nil.
2978 Otherwise, return nil."
2979 (or (stringp object) (null object)))
2981 (defun booleanp (object)
2982 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2983 Otherwise, return nil."
2984 (and (memq object '(nil t)) t))
2986 (defun special-form-p (object)
2987 "Non-nil if and only if OBJECT is a special form."
2988 (if (and (symbolp object) (fboundp object))
2989 (setq object (indirect-function object)))
2990 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2992 (defun macrop (object)
2993 "Non-nil if and only if OBJECT is a macro."
2994 (let ((def (indirect-function object)))
2996 (or (eq 'macro (car def))
2997 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2999 (defun field-at-pos (pos)
3000 "Return the field at position POS, taking stickiness etc into account."
3001 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
3002 (if (eq raw-field 'boundary)
3003 (get-char-property (1- (field-end pos)) 'field)
3006 (defun sha1 (object &optional start end binary)
3007 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
3008 OBJECT is either a string or a buffer. Optional arguments START and
3009 END are character positions specifying which portion of OBJECT for
3010 computing the hash. If BINARY is non-nil, return a string in binary
3012 (secure-hash 'sha1 object start end binary))
3014 (defun function-get (f prop &optional autoload)
3015 "Return the value of property PROP of function F.
3016 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
3017 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
3018 if it's an autoloaded macro."
3020 (while (and (symbolp f)
3021 (null (setq val (get f prop)))
3023 (let ((fundef (symbol-function f)))
3024 (if (and autoload (autoloadp fundef)
3026 (autoload-do-load fundef f
3027 (if (eq autoload 'macro)
3029 nil ;Re-try `get' on the same `f'.
3033 ;;;; Support for yanking and text properties.
3034 ;; Why here in subr.el rather than in simple.el? --Stef
3036 (defvar yank-handled-properties)
3037 (defvar yank-excluded-properties)
3039 (defun remove-yank-excluded-properties (start end)
3040 "Process text properties between START and END, inserted for a `yank'.
3041 Perform the handling specified by `yank-handled-properties', then
3042 remove properties specified by `yank-excluded-properties'."
3043 (let ((inhibit-read-only t))
3044 (dolist (handler yank-handled-properties)
3045 (let ((prop (car handler))
3048 (while (< run-start end)
3049 (let ((value (get-text-property run-start prop))
3050 (run-end (next-single-property-change
3051 run-start prop nil end)))
3052 (funcall fun value run-start run-end)
3053 (setq run-start run-end)))))
3054 (with-silent-modifications
3055 (if (eq yank-excluded-properties t)
3056 (set-text-properties start end nil)
3057 (remove-list-of-text-properties start end yank-excluded-properties)))))
3059 (defvar yank-undo-function)
3061 (defun insert-for-yank (string)
3062 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
3064 See `insert-for-yank-1' for more details."
3066 (while (setq to (next-single-property-change 0 'yank-handler string))
3067 (insert-for-yank-1 (substring string 0 to))
3068 (setq string (substring string to))))
3069 (insert-for-yank-1 string))
3071 (defun insert-for-yank-1 (string)
3072 "Insert STRING at point for the `yank' command.
3073 This function is like `insert', except it honors the variables
3074 `yank-handled-properties' and `yank-excluded-properties', and the
3075 `yank-handler' text property.
3077 Properties listed in `yank-handled-properties' are processed,
3078 then those listed in `yank-excluded-properties' are discarded.
3080 If STRING has a non-nil `yank-handler' property on its first
3081 character, the normal insert behavior is altered. The value of
3082 the `yank-handler' property must be a list of one to four
3083 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
3084 FUNCTION, if non-nil, should be a function of one argument, an
3085 object to insert; it is called instead of `insert'.
3086 PARAM, if present and non-nil, replaces STRING as the argument to
3087 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
3088 may be a list of strings to insert as a rectangle.
3089 If NOEXCLUDE is present and non-nil, the normal removal of
3090 `yank-excluded-properties' is not performed; instead FUNCTION is
3091 responsible for the removal. This may be necessary if FUNCTION
3092 adjusts point before or after inserting the object.
3093 UNDO, if present and non-nil, should be a function to be called
3094 by `yank-pop' to undo the insertion of the current object. It is
3095 given two arguments, the start and end of the region. FUNCTION
3096 may set `yank-undo-function' to override UNDO."
3097 (let* ((handler (and (stringp string)
3098 (get-text-property 0 'yank-handler string)))
3099 (param (or (nth 1 handler) string))
3101 (inhibit-read-only inhibit-read-only)
3104 (setq yank-undo-function t)
3105 (if (nth 0 handler) ; FUNCTION
3106 (funcall (car handler) param)
3110 ;; Prevent read-only properties from interfering with the
3111 ;; following text property changes.
3112 (setq inhibit-read-only t)
3114 (unless (nth 2 handler) ; NOEXCLUDE
3115 (remove-yank-excluded-properties opoint end))
3117 ;; If last inserted char has properties, mark them as rear-nonsticky.
3118 (if (and (> end opoint)
3119 (text-properties-at (1- end)))
3120 (put-text-property (1- end) end 'rear-nonsticky t))
3122 (if (eq yank-undo-function t) ; not set by FUNCTION
3123 (setq yank-undo-function (nth 3 handler))) ; UNDO
3124 (if (nth 4 handler) ; COMMAND
3125 (setq this-command (nth 4 handler)))))
3127 (defun insert-buffer-substring-no-properties (buffer &optional start end)
3128 "Insert before point a substring of BUFFER, without text properties.
3129 BUFFER may be a buffer or a buffer name.
3130 Arguments START and END are character positions specifying the substring.
3131 They default to the values of (point-min) and (point-max) in BUFFER."
3132 (let ((opoint (point)))
3133 (insert-buffer-substring buffer start end)
3134 (let ((inhibit-read-only t))
3135 (set-text-properties opoint (point) nil))))
3137 (defun insert-buffer-substring-as-yank (buffer &optional start end)
3138 "Insert before point a part of BUFFER, stripping some text properties.
3139 BUFFER may be a buffer or a buffer name.
3140 Arguments START and END are character positions specifying the substring.
3141 They default to the values of (point-min) and (point-max) in BUFFER.
3142 Before insertion, process text properties according to
3143 `yank-handled-properties' and `yank-excluded-properties'."
3144 ;; Since the buffer text should not normally have yank-handler properties,
3145 ;; there is no need to handle them here.
3146 (let ((opoint (point)))
3147 (insert-buffer-substring buffer start end)
3148 (remove-yank-excluded-properties opoint (point))))
3150 (defun yank-handle-font-lock-face-property (face start end)
3151 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
3152 START and END denote the start and end of the text to act on.
3153 Do nothing if FACE is nil."
3155 (null font-lock-defaults)
3156 (put-text-property start end 'face face)))
3158 ;; This removes `mouse-face' properties in *Help* buffer buttons:
3159 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
3160 (defun yank-handle-category-property (category start end)
3161 "Apply property category CATEGORY's properties between START and END."
3163 (let ((start2 start))
3164 (while (< start2 end)
3165 (let ((end2 (next-property-change start2 nil end))
3166 (original (text-properties-at start2)))
3167 (set-text-properties start2 end2 (symbol-plist category))
3168 (add-text-properties start2 end2 original)
3169 (setq start2 end2))))))
3172 ;;;; Synchronous shell commands.
3174 (defun start-process-shell-command (name buffer &rest args)
3175 "Start a program in a subprocess. Return the process object for it.
3176 NAME is name for process. It is modified if necessary to make it unique.
3177 BUFFER is the buffer (or buffer name) to associate with the process.
3178 Process output goes at end of that buffer, unless you specify
3179 an output stream or filter function to handle the output.
3180 BUFFER may be also nil, meaning that this process is not associated
3182 COMMAND is the shell command to run.
3184 An old calling convention accepted any number of arguments after COMMAND,
3185 which were just concatenated to COMMAND. This is still supported but strongly
3187 (declare (advertised-calling-convention (name buffer command) "23.1"))
3188 ;; We used to use `exec' to replace the shell with the command,
3189 ;; but that failed to handle (...) and semicolon, etc.
3190 (start-process name buffer shell-file-name shell-command-switch
3191 (mapconcat 'identity args " ")))
3193 (defun start-file-process-shell-command (name buffer &rest args)
3194 "Start a program in a subprocess. Return the process object for it.
3195 Similar to `start-process-shell-command', but calls `start-file-process'."
3196 (declare (advertised-calling-convention (name buffer command) "23.1"))
3199 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3200 (if (file-remote-p default-directory) "-c" shell-command-switch)
3201 (mapconcat 'identity args " ")))
3203 (defun call-process-shell-command (command &optional infile buffer display
3205 "Execute the shell command COMMAND synchronously in separate process.
3206 The remaining arguments are optional.
3207 The program's input comes from file INFILE (nil means `/dev/null').
3208 Insert output in BUFFER before point; t means current buffer;
3209 nil for BUFFER means discard it; 0 means discard and don't wait.
3210 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3211 REAL-BUFFER says what to do with standard output, as above,
3212 while STDERR-FILE says what to do with standard error in the child.
3213 STDERR-FILE may be nil (discard standard error output),
3214 t (mix it with ordinary output), or a file name string.
3216 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
3217 Wildcards and redirection are handled as usual in the shell.
3219 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
3220 Otherwise it waits for COMMAND to terminate and returns a numeric exit
3221 status or a signal description string.
3222 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
3224 An old calling convention accepted any number of arguments after DISPLAY,
3225 which were just concatenated to COMMAND. This is still supported but strongly
3227 (declare (advertised-calling-convention
3228 (command &optional infile buffer display) "24.5"))
3229 ;; We used to use `exec' to replace the shell with the command,
3230 ;; but that failed to handle (...) and semicolon, etc.
3231 (call-process shell-file-name
3232 infile buffer display
3233 shell-command-switch
3234 (mapconcat 'identity (cons command args) " ")))
3236 (defun process-file-shell-command (command &optional infile buffer display
3238 "Process files synchronously in a separate process.
3239 Similar to `call-process-shell-command', but calls `process-file'."
3240 (declare (advertised-calling-convention
3241 (command &optional infile buffer display) "24.5"))
3243 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3244 infile buffer display
3245 (if (file-remote-p default-directory) "-c" shell-command-switch)
3246 (mapconcat 'identity (cons command args) " ")))
3248 ;;;; Lisp macros to do various things temporarily.
3250 (defmacro track-mouse (&rest body)
3251 "Evaluate BODY with mouse movement events enabled.
3252 Within a `track-mouse' form, mouse motion generates input events that
3253 you can read with `read-event'.
3254 Normally, mouse motion is ignored."
3255 (declare (debug t) (indent 0))
3256 `(internal--track-mouse (lambda () ,@body)))
3258 (defmacro with-current-buffer (buffer-or-name &rest body)
3259 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3260 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3261 The value returned is the value of the last form in BODY. See
3262 also `with-temp-buffer'."
3263 (declare (indent 1) (debug t))
3264 `(save-current-buffer
3265 (set-buffer ,buffer-or-name)
3268 (defun internal--before-with-selected-window (window)
3269 (let ((other-frame (window-frame window)))
3270 (list window (selected-window)
3271 ;; Selecting a window on another frame also changes that
3272 ;; frame's frame-selected-window. We must save&restore it.
3273 (unless (eq (selected-frame) other-frame)
3274 (frame-selected-window other-frame))
3275 ;; Also remember the top-frame if on ttys.
3276 (unless (eq (selected-frame) other-frame)
3277 (tty-top-frame other-frame)))))
3279 (defun internal--after-with-selected-window (state)
3280 ;; First reset frame-selected-window.
3281 (when (window-live-p (nth 2 state))
3282 ;; We don't use set-frame-selected-window because it does not
3283 ;; pass the `norecord' argument to Fselect_window.
3284 (select-window (nth 2 state) 'norecord)
3285 (and (frame-live-p (nth 3 state))
3286 (not (eq (tty-top-frame) (nth 3 state)))
3287 (select-frame (nth 3 state) 'norecord)))
3288 ;; Then reset the actual selected-window.
3289 (when (window-live-p (nth 1 state))
3290 (select-window (nth 1 state) 'norecord)))
3292 (defmacro with-selected-window (window &rest body)
3293 "Execute the forms in BODY with WINDOW as the selected window.
3294 The value returned is the value of the last form in BODY.
3296 This macro saves and restores the selected window, as well as the
3297 selected window of each frame. It does not change the order of
3298 recently selected windows. If the previously selected window of
3299 some frame is no longer live at the end of BODY, that frame's
3300 selected window is left alone. If the selected window is no
3301 longer live, then whatever window is selected at the end of BODY
3304 This macro uses `save-current-buffer' to save and restore the
3305 current buffer, since otherwise its normal operation could
3306 potentially make a different buffer current. It does not alter
3307 the buffer list ordering."
3308 (declare (indent 1) (debug t))
3309 `(let ((save-selected-window--state
3310 (internal--before-with-selected-window ,window)))
3311 (save-current-buffer
3313 (progn (select-window (car save-selected-window--state) 'norecord)
3315 (internal--after-with-selected-window save-selected-window--state)))))
3317 (defmacro with-selected-frame (frame &rest body)
3318 "Execute the forms in BODY with FRAME as the selected frame.
3319 The value returned is the value of the last form in BODY.
3321 This macro saves and restores the selected frame, and changes the
3322 order of neither the recently selected windows nor the buffers in
3324 (declare (indent 1) (debug t))
3325 (let ((old-frame (make-symbol "old-frame"))
3326 (old-buffer (make-symbol "old-buffer")))
3327 `(let ((,old-frame (selected-frame))
3328 (,old-buffer (current-buffer)))
3330 (progn (select-frame ,frame 'norecord)
3332 (when (frame-live-p ,old-frame)
3333 (select-frame ,old-frame 'norecord))
3334 (when (buffer-live-p ,old-buffer)
3335 (set-buffer ,old-buffer))))))
3337 (defmacro save-window-excursion (&rest body)
3338 "Execute BODY, then restore previous window configuration.
3339 This macro saves the window configuration on the selected frame,
3340 executes BODY, then calls `set-window-configuration' to restore
3341 the saved window configuration. The return value is the last
3342 form in BODY. The window configuration is also restored if BODY
3345 BEWARE: Most uses of this macro introduce bugs.
3346 E.g. it should not be used to try and prevent some code from opening
3347 a new window, since that window may sometimes appear in another frame,
3348 in which case `save-window-excursion' cannot help."
3349 (declare (indent 0) (debug t))
3350 (let ((c (make-symbol "wconfig")))
3351 `(let ((,c (current-window-configuration)))
3352 (unwind-protect (progn ,@body)
3353 (set-window-configuration ,c)))))
3355 (defun internal-temp-output-buffer-show (buffer)
3356 "Internal function for `with-output-to-temp-buffer'."
3357 (with-current-buffer buffer
3358 (set-buffer-modified-p nil)
3359 (goto-char (point-min)))
3361 (if temp-buffer-show-function
3362 (funcall temp-buffer-show-function buffer)
3363 (with-current-buffer buffer
3365 (let ((window-combination-limit
3366 ;; When `window-combination-limit' equals
3367 ;; `temp-buffer' or `temp-buffer-resize' and
3368 ;; `temp-buffer-resize-mode' is enabled in this
3369 ;; buffer bind it to t so resizing steals space
3370 ;; preferably from the window that was split.
3371 (if (or (eq window-combination-limit 'temp-buffer)
3372 (and (eq window-combination-limit
3373 'temp-buffer-resize)
3374 temp-buffer-resize-mode))
3376 window-combination-limit)))
3377 (display-buffer buffer)))
3378 (frame (and window (window-frame window))))
3380 (unless (eq frame (selected-frame))
3381 (make-frame-visible frame))
3382 (setq minibuffer-scroll-window window)
3383 (set-window-hscroll window 0)
3384 ;; Don't try this with NOFORCE non-nil!
3385 (set-window-start window (point-min) t)
3386 ;; This should not be necessary.
3387 (set-window-point window (point-min))
3388 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3389 (with-selected-window window
3390 (run-hooks 'temp-buffer-show-hook))))))
3394 ;; Doc is very similar to with-temp-buffer-window.
3395 (defmacro with-output-to-temp-buffer (bufname &rest body)
3396 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3398 This construct makes buffer BUFNAME empty before running BODY.
3399 It does not make the buffer current for BODY.
3400 Instead it binds `standard-output' to that buffer, so that output
3401 generated with `prin1' and similar functions in BODY goes into
3404 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3405 it in a window, but does not select it. The normal way to do this is
3406 by calling `display-buffer', then running `temp-buffer-show-hook'.
3407 However, if `temp-buffer-show-function' is non-nil, it calls that
3408 function instead (and does not run `temp-buffer-show-hook'). The
3409 function gets one argument, the buffer to display.
3411 The return value of `with-output-to-temp-buffer' is the value of the
3412 last form in BODY. If BODY does not finish normally, the buffer
3413 BUFNAME is not displayed.
3415 This runs the hook `temp-buffer-setup-hook' before BODY,
3416 with the buffer BUFNAME temporarily current. It runs the hook
3417 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3418 buffer temporarily current, and the window that was used to display it
3419 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3420 if it uses `temp-buffer-show-function'.
3422 By default, the setup hook puts the buffer into Help mode before running BODY.
3423 If BODY does not change the major mode, the show hook makes the buffer
3424 read-only, and scans it for function and variable names to make them into
3425 clickable cross-references.
3427 See the related form `with-temp-buffer-window'."
3429 (let ((old-dir (make-symbol "old-dir"))
3430 (buf (make-symbol "buf")))
3431 `(let* ((,old-dir default-directory)
3433 (with-current-buffer (get-buffer-create ,bufname)
3434 (prog1 (current-buffer)
3435 (kill-all-local-variables)
3436 ;; FIXME: delete_all_overlays
3437 (setq default-directory ,old-dir)
3438 (setq buffer-read-only nil)
3439 (setq buffer-file-name nil)
3440 (setq buffer-undo-list t)
3441 (let ((inhibit-read-only t)
3442 (inhibit-modification-hooks t))
3444 (run-hooks 'temp-buffer-setup-hook)))))
3445 (standard-output ,buf))
3446 (prog1 (progn ,@body)
3447 (internal-temp-output-buffer-show ,buf)))))
3449 (defmacro with-temp-file (file &rest body)
3450 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3451 The value returned is the value of the last form in BODY.
3452 See also `with-temp-buffer'."
3453 (declare (indent 1) (debug t))
3454 (let ((temp-file (make-symbol "temp-file"))
3455 (temp-buffer (make-symbol "temp-buffer")))
3456 `(let ((,temp-file ,file)
3458 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3461 (with-current-buffer ,temp-buffer
3463 (with-current-buffer ,temp-buffer
3464 (write-region nil nil ,temp-file nil 0)))
3465 (and (buffer-name ,temp-buffer)
3466 (kill-buffer ,temp-buffer))))))
3468 (defmacro with-temp-message (message &rest body)
3469 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3470 The original message is restored to the echo area after BODY has finished.
3471 The value returned is the value of the last form in BODY.
3472 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3473 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3474 Use a MESSAGE of \"\" to temporarily clear the echo area."
3475 (declare (debug t) (indent 1))
3476 (let ((current-message (make-symbol "current-message"))
3477 (temp-message (make-symbol "with-temp-message")))
3478 `(let ((,temp-message ,message)
3483 (setq ,current-message (current-message))
3484 (message "%s" ,temp-message))
3487 (if ,current-message
3488 (message "%s" ,current-message)
3491 (defmacro with-temp-buffer (&rest body)
3492 "Create a temporary buffer, and evaluate BODY there like `progn'.
3493 See also `with-temp-file' and `with-output-to-string'."
3494 (declare (indent 0) (debug t))
3495 (let ((temp-buffer (make-symbol "temp-buffer")))
3496 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3497 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3498 (with-current-buffer ,temp-buffer
3501 (and (buffer-name ,temp-buffer)
3502 (kill-buffer ,temp-buffer)))))))
3504 (defmacro with-silent-modifications (&rest body)
3505 "Execute BODY, pretending it does not modify the buffer.
3506 This macro is Typically used around modifications of
3507 text-properties which do not really affect the buffer's content.
3508 If BODY performs real modifications to the buffer's text, other
3509 than cosmetic ones, undo data may become corrupted.
3511 This macro will run BODY normally, but doesn't count its buffer
3512 modifications as being buffer modifications. This affects things
3513 like `buffer-modified-p', checking whether the file is locked by
3514 someone else, running buffer modification hooks, and other things
3516 (declare (debug t) (indent 0))
3517 (let ((modified (make-symbol "modified")))
3518 `(let* ((,modified (buffer-modified-p))
3519 (buffer-undo-list t)
3520 (inhibit-read-only t)
3521 (inhibit-modification-hooks t))
3526 (restore-buffer-modified-p nil))))))
3528 (defmacro with-output-to-string (&rest body)
3529 "Execute BODY, return the text it sent to `standard-output', as a string."
3530 (declare (indent 0) (debug t))
3531 `(let ((standard-output
3532 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3535 (let ((standard-output standard-output))
3537 (with-current-buffer standard-output
3539 (kill-buffer standard-output))))
3541 (defmacro with-local-quit (&rest body)
3542 "Execute BODY, allowing quits to terminate BODY but not escape further.
3543 When a quit terminates BODY, `with-local-quit' returns nil but
3544 requests another quit. That quit will be processed as soon as quitting
3545 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3546 (declare (debug t) (indent 0))
3547 `(condition-case nil
3548 (let ((inhibit-quit nil))
3550 (quit (setq quit-flag t)
3551 ;; This call is to give a chance to handle quit-flag
3552 ;; in case inhibit-quit is nil.
3553 ;; Without this, it will not be handled until the next function
3554 ;; call, and that might allow it to exit thru a condition-case
3555 ;; that intends to handle the quit signal next time.
3556 (eval '(ignore nil)))))
3558 (defmacro while-no-input (&rest body)
3559 "Execute BODY only as long as there's no pending input.
3560 If input arrives, that ends the execution of BODY,
3561 and `while-no-input' returns t. Quitting makes it return nil.
3562 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3563 (declare (debug t) (indent 0))
3564 (let ((catch-sym (make-symbol "input")))
3567 (let ((throw-on-input ',catch-sym))
3568 (or (input-pending-p)
3569 (progn ,@body)))))))
3571 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3572 "Like `condition-case' except that it does not prevent debugging.
3573 More specifically if `debug-on-error' is set then the debugger will be invoked
3574 even if this catches the signal."
3575 (declare (debug condition-case) (indent 2))
3576 `(condition-case ,var
3578 ,@(mapcar (lambda (handler)
3579 `((debug ,@(if (listp (car handler)) (car handler)
3580 (list (car handler))))
3584 (define-obsolete-function-alias 'condition-case-no-debug
3585 'condition-case-unless-debug "24.1")
3587 (defmacro with-demoted-errors (format &rest body)
3588 "Run BODY and demote any errors to simple messages.
3589 FORMAT is a string passed to `message' to format any error message.
3590 It should contain a single %-sequence; e.g., \"Error: %S\".
3592 If `debug-on-error' is non-nil, run BODY without catching its errors.
3593 This is to be used around code which is not expected to signal an error
3594 but which should be robust in the unexpected case that an error is signaled.
3596 For backward compatibility, if FORMAT is not a constant string, it
3597 is assumed to be part of BODY, in which case the message format
3598 used is \"Error: %S\"."
3599 (declare (debug t) (indent 1))
3600 (let ((err (make-symbol "err"))
3601 (format (if (and (stringp format) body) format
3603 (if format (push format body))))))
3604 `(condition-case-unless-debug ,err
3605 ,(macroexp-progn body)
3606 (error (message ,format ,err) nil))))
3608 (defmacro combine-after-change-calls (&rest body)
3609 "Execute BODY, but don't call the after-change functions till the end.
3610 If BODY makes changes in the buffer, they are recorded
3611 and the functions on `after-change-functions' are called several times
3612 when BODY is finished.
3613 The return value is the value of the last form in BODY.
3615 If `before-change-functions' is non-nil, then calls to the after-change
3616 functions can't be deferred, so in that case this macro has no effect.
3618 Do not alter `after-change-functions' or `before-change-functions'
3620 (declare (indent 0) (debug t))
3622 (let ((combine-after-change-calls t))
3624 (combine-after-change-execute)))
3626 (defmacro with-case-table (table &rest body)
3627 "Execute the forms in BODY with TABLE as the current case table.
3628 The value returned is the value of the last form in BODY."
3629 (declare (indent 1) (debug t))
3630 (let ((old-case-table (make-symbol "table"))
3631 (old-buffer (make-symbol "buffer")))
3632 `(let ((,old-case-table (current-case-table))
3633 (,old-buffer (current-buffer)))
3635 (progn (set-case-table ,table)
3637 (with-current-buffer ,old-buffer
3638 (set-case-table ,old-case-table))))))
3640 (defmacro with-file-modes (modes &rest body)
3641 "Execute BODY with default file permissions temporarily set to MODES.
3642 MODES is as for `set-default-file-modes'."
3643 (declare (indent 1) (debug t))
3644 (let ((umask (make-symbol "umask")))
3645 `(let ((,umask (default-file-modes)))
3648 (set-default-file-modes ,modes)
3650 (set-default-file-modes ,umask)))))
3653 ;;; Matching and match data.
3655 (defvar save-match-data-internal)
3657 ;; We use save-match-data-internal as the local variable because
3658 ;; that works ok in practice (people should not use that variable elsewhere).
3659 ;; We used to use an uninterned symbol; the compiler handles that properly
3660 ;; now, but it generates slower code.
3661 (defmacro save-match-data (&rest body)
3662 "Execute the BODY forms, restoring the global value of the match data.
3663 The value returned is the value of the last form in BODY."
3664 ;; It is better not to use backquote here,
3665 ;; because that makes a bootstrapping problem
3666 ;; if you need to recompile all the Lisp files using interpreted code.
3667 (declare (indent 0) (debug t))
3669 '((save-match-data-internal (match-data)))
3670 (list 'unwind-protect
3672 ;; It is safe to free (evaporate) markers immediately here,
3673 ;; as Lisp programs should not copy from save-match-data-internal.
3674 '(set-match-data save-match-data-internal 'evaporate))))
3676 (defun match-string (num &optional string)
3677 "Return string of text matched by last search.
3678 NUM specifies which parenthesized expression in the last regexp.
3679 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3680 Zero means the entire text matched by the whole regexp or whole string.
3681 STRING should be given if the last search was by `string-match' on STRING.
3682 If STRING is nil, the current buffer should be the same buffer
3683 the search/match was performed in."
3684 (if (match-beginning num)
3686 (substring string (match-beginning num) (match-end num))
3687 (buffer-substring (match-beginning num) (match-end num)))))
3689 (defun match-string-no-properties (num &optional string)
3690 "Return string of text matched by last search, without text properties.
3691 NUM specifies which parenthesized expression in the last regexp.
3692 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3693 Zero means the entire text matched by the whole regexp or whole string.
3694 STRING should be given if the last search was by `string-match' on STRING.
3695 If STRING is nil, the current buffer should be the same buffer
3696 the search/match was performed in."
3697 (if (match-beginning num)
3699 (substring-no-properties string (match-beginning num)
3701 (buffer-substring-no-properties (match-beginning num)
3705 (defun match-substitute-replacement (replacement
3706 &optional fixedcase literal string subexp)
3707 "Return REPLACEMENT as it will be inserted by `replace-match'.
3708 In other words, all back-references in the form `\\&' and `\\N'
3709 are substituted with actual strings matched by the last search.
3710 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3711 meaning as for `replace-match'."
3712 (let ((match (match-string 0 string)))
3714 (set-match-data (mapcar (lambda (x)
3716 (- x (match-beginning 0))
3719 (replace-match replacement fixedcase literal match subexp))))
3722 (defun looking-back (regexp &optional limit greedy)
3723 "Return non-nil if text before point matches regular expression REGEXP.
3724 Like `looking-at' except matches before point, and is slower.
3725 LIMIT if non-nil speeds up the search by specifying a minimum
3726 starting position, to avoid checking matches that would start
3729 If GREEDY is non-nil, extend the match backwards as far as
3730 possible, stopping when a single additional previous character
3731 cannot be part of a match for REGEXP. When the match is
3732 extended, its starting position is allowed to occur before
3735 As a general recommendation, try to avoid using `looking-back'
3736 wherever possible, since it is slow."
3738 (advertised-calling-convention (regexp limit &optional greedy) "25.1"))
3739 (let ((start (point))
3742 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3744 (if (and greedy pos)
3746 (narrow-to-region (point-min) start)
3747 (while (and (> pos (point-min))
3751 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3752 (setq pos (1- pos)))
3755 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3758 (defsubst looking-at-p (regexp)
3760 Same as `looking-at' except this function does not change the match data."
3761 (let ((inhibit-changing-match-data t))
3762 (looking-at regexp)))
3764 (defsubst string-match-p (regexp string &optional start)
3766 Same as `string-match' except this function does not change the match data."
3767 (let ((inhibit-changing-match-data t))
3768 (string-match regexp string start)))
3770 (defun subregexp-context-p (regexp pos &optional start)
3771 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3772 A subregexp context is one where a sub-regexp can appear.
3773 A non-subregexp context is for example within brackets, or within a
3774 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3775 If START is non-nil, it should be a position in REGEXP, smaller
3776 than POS, and known to be in a subregexp context."
3777 ;; Here's one possible implementation, with the great benefit that it
3778 ;; reuses the regexp-matcher's own parser, so it understands all the
3779 ;; details of the syntax. A disadvantage is that it needs to match the
3783 (string-match (substring regexp (or start 0) pos) "")
3786 (not (member (cadr err) '("Unmatched [ or [^"
3788 "Trailing backslash")))))
3789 ;; An alternative implementation:
3790 ;; (defconst re-context-re
3791 ;; (let* ((harmless-ch "[^\\[]")
3792 ;; (harmless-esc "\\\\[^{]")
3793 ;; (class-harmless-ch "[^][]")
3794 ;; (class-lb-harmless "[^]:]")
3795 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3796 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3797 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3799 ;; (concat "\\[^?]?"
3800 ;; "\\(" class-harmless-ch
3801 ;; "\\|" class-lb "\\)*"
3802 ;; "\\[?]")) ; special handling for bare [ at end of re
3803 ;; (braces "\\\\{[0-9,]+\\\\}"))
3804 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3805 ;; "\\|" class "\\|" braces "\\)*\\'"))
3806 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3807 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3812 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3813 "The default value of separators for `split-string'.
3815 A regexp matching strings of whitespace. May be locale-dependent
3816 \(as yet unimplemented). Should not match non-breaking spaces.
3818 Warning: binding this to a different value and using it as default is
3819 likely to have undesired semantics.")
3821 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3822 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3823 ;; expression leads to the equivalent implementation that if SEPARATORS
3824 ;; is defaulted, OMIT-NULLS is treated as t.
3825 (defun split-string (string &optional separators omit-nulls trim)
3826 "Split STRING into substrings bounded by matches for SEPARATORS.
3828 The beginning and end of STRING, and each match for SEPARATORS, are
3829 splitting points. The substrings matching SEPARATORS are removed, and
3830 the substrings between the splitting points are collected as a list,
3833 If SEPARATORS is non-nil, it should be a regular expression matching text
3834 which separates, but is not part of, the substrings. If nil it defaults to
3835 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3836 OMIT-NULLS is forced to t.
3838 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3839 that for the default value of SEPARATORS leading and trailing whitespace
3840 are effectively trimmed). If nil, all zero-length substrings are retained,
3841 which correctly parses CSV format, for example.
3843 If TRIM is non-nil, it should be a regular expression to match
3844 text to trim from the beginning and end of each substring. If trimming
3845 makes the substring empty, it is treated as null.
3847 If you want to trim whitespace from the substrings, the reliably correct
3848 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3849 results when there is whitespace at the start or end of STRING. If you
3850 see such calls to `split-string', please fix them.
3852 Note that the effect of `(split-string STRING)' is the same as
3853 `(split-string STRING split-string-default-separators t)'. In the rare
3854 case that you wish to retain zero-length substrings when splitting on
3855 whitespace, use `(split-string STRING split-string-default-separators)'.
3857 Modifies the match data; use `save-match-data' if necessary."
3858 (let* ((keep-nulls (not (if separators omit-nulls t)))
3859 (rexp (or separators split-string-default-separators))
3865 ;; Push the substring in range THIS-START to THIS-END
3866 ;; onto LIST, trimming it and perhaps discarding it.
3869 ;; Discard the trim from start of this substring.
3870 (let ((tem (string-match trim string this-start)))
3871 (and (eq tem this-start)
3872 (setq this-start (match-end 0)))))
3874 (when (or keep-nulls (< this-start this-end))
3875 (let ((this (substring string this-start this-end)))
3877 ;; Discard the trim from end of this substring.
3879 (let ((tem (string-match (concat trim "\\'") this 0)))
3880 (and tem (< tem (length this))
3881 (setq this (substring this 0 tem)))))
3883 ;; Trimming could make it empty; check again.
3884 (when (or keep-nulls (> (length this) 0))
3885 (push this list)))))))
3887 (while (and (string-match rexp string
3889 (= start (match-beginning 0))
3890 (< start (length string)))
3892 (< start (length string)))
3894 (setq this-start start this-end (match-beginning 0)
3895 start (match-end 0))
3899 ;; Handle the substring at the end of STRING.
3900 (setq this-start start this-end (length string))
3905 (defun combine-and-quote-strings (strings &optional separator)
3906 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3907 This tries to quote the strings to avoid ambiguity such that
3908 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3909 Only some SEPARATORs will work properly."
3910 (let* ((sep (or separator " "))
3911 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3914 (if (string-match re str)
3915 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3919 (defun split-string-and-unquote (string &optional separator)
3920 "Split the STRING into a list of strings.
3921 It understands Emacs Lisp quoting within STRING, such that
3922 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3923 The SEPARATOR regexp defaults to \"\\s-+\"."
3924 (let ((sep (or separator "\\s-+"))
3925 (i (string-match "\"" string)))
3927 (split-string string sep t) ; no quoting: easy
3928 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3929 (let ((rfs (read-from-string string i)))
3931 (split-string-and-unquote (substring string (cdr rfs))
3935 ;;;; Replacement in strings.
3937 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3938 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3939 Unless optional argument INPLACE is non-nil, return a new string."
3940 (let ((i (length string))
3941 (newstr (if inplace string (copy-sequence string))))
3944 (if (eq (aref newstr i) fromchar)
3945 (aset newstr i tochar)))
3948 (defun replace-regexp-in-string (regexp rep string &optional
3949 fixedcase literal subexp start)
3950 "Replace all matches for REGEXP with REP in STRING.
3952 Return a new string containing the replacements.
3954 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3955 arguments with the same names of function `replace-match'. If START
3956 is non-nil, start replacements at that index in STRING.
3958 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3959 function. If it is a function, it is called with the actual text of each
3960 match, and its value is used as the replacement text. When REP is called,
3961 the match data are the result of matching REGEXP against a substring
3962 of STRING, the same substring that is the actual text of the match which
3963 is passed to REP as its argument.
3965 To replace only the first match (if any), make REGEXP match up to \\\\='
3966 and replace a sub-expression, e.g.
3967 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\\\='\" \"bar\" \" foo foo\" nil nil 1)
3970 ;; To avoid excessive consing from multiple matches in long strings,
3971 ;; don't just call `replace-match' continually. Walk down the
3972 ;; string looking for matches of REGEXP and building up a (reversed)
3973 ;; list MATCHES. This comprises segments of STRING which weren't
3974 ;; matched interspersed with replacements for segments that were.
3975 ;; [For a `large' number of replacements it's more efficient to
3976 ;; operate in a temporary buffer; we can't tell from the function's
3977 ;; args whether to choose the buffer-based implementation, though it
3978 ;; might be reasonable to do so for long enough STRING.]
3979 (let ((l (length string))
3980 (start (or start 0))
3983 (while (and (< start l) (string-match regexp string start))
3984 (setq mb (match-beginning 0)
3986 ;; If we matched the empty string, make sure we advance by one char
3987 (when (= me mb) (setq me (min l (1+ mb))))
3988 ;; Generate a replacement for the matched substring.
3989 ;; Operate only on the substring to minimize string consing.
3990 ;; Set up match data for the substring for replacement;
3991 ;; presumably this is likely to be faster than munging the
3992 ;; match data directly in Lisp.
3993 (string-match regexp (setq str (substring string mb me)))
3995 (cons (replace-match (if (stringp rep)
3997 (funcall rep (match-string 0 str)))
3998 fixedcase literal str subexp)
3999 (cons (substring string start mb) ; unmatched prefix
4002 ;; Reconstruct a string from the pieces.
4003 (setq matches (cons (substring string start l) matches)) ; leftover
4004 (apply #'concat (nreverse matches)))))
4006 (defun string-prefix-p (prefix string &optional ignore-case)
4007 "Return non-nil if PREFIX is a prefix of STRING.
4008 If IGNORE-CASE is non-nil, the comparison is done without paying attention
4009 to case differences."
4010 (let ((prefix-length (length prefix)))
4011 (if (> prefix-length (length string)) nil
4012 (eq t (compare-strings prefix 0 prefix-length string
4013 0 prefix-length ignore-case)))))
4015 (defun string-suffix-p (suffix string &optional ignore-case)
4016 "Return non-nil if SUFFIX is a suffix of STRING.
4017 If IGNORE-CASE is non-nil, the comparison is done without paying
4018 attention to case differences."
4019 (let ((start-pos (- (length string) (length suffix))))
4020 (and (>= start-pos 0)
4021 (eq t (compare-strings suffix nil nil
4022 string start-pos nil ignore-case)))))
4024 (defun bidi-string-mark-left-to-right (str)
4025 "Return a string that can be safely inserted in left-to-right text.
4027 Normally, inserting a string with right-to-left (RTL) script into
4028 a buffer may cause some subsequent text to be displayed as part
4029 of the RTL segment (usually this affects punctuation characters).
4030 This function returns a string which displays as STR but forces
4031 subsequent text to be displayed as left-to-right.
4033 If STR contains any RTL character, this function returns a string
4034 consisting of STR followed by an invisible left-to-right mark
4035 \(LRM) character. Otherwise, it returns STR."
4036 (unless (stringp str)
4037 (signal 'wrong-type-argument (list 'stringp str)))
4038 (if (string-match "\\cR" str)
4039 (concat str (propertize (string ?\x200e) 'invisible t))
4042 (defun string-greaterp (string1 string2)
4043 "Return non-nil if STRING1 is greater than STRING2 in lexicographic order.
4044 Case is significant.
4045 Symbols are also allowed; their print names are used instead."
4046 (string-lessp string2 string1))
4049 ;;;; Specifying things to do later.
4051 (defun load-history-regexp (file)
4052 "Form a regexp to find FILE in `load-history'.
4053 FILE, a string, is described in the function `eval-after-load'."
4054 (if (file-name-absolute-p file)
4055 (setq file (file-truename file)))
4056 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
4058 (if (file-name-extension file)
4060 ;; Note: regexp-opt can't be used here, since we need to call
4061 ;; this before Emacs has been fully started. 2006-05-21
4062 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
4063 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
4066 (defun load-history-filename-element (file-regexp)
4067 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
4068 Return nil if there isn't one."
4069 (let* ((loads load-history)
4070 (load-elt (and loads (car loads))))
4073 (or (null (car load-elt))
4074 (not (string-match file-regexp (car load-elt)))))
4075 (setq loads (cdr loads)
4076 load-elt (and loads (car loads)))))
4079 (put 'eval-after-load 'lisp-indent-function 1)
4080 (defun eval-after-load (file form)
4081 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
4082 If FILE is already loaded, evaluate FORM right now.
4083 FORM can be an Elisp expression (in which case it's passed to `eval'),
4084 or a function (in which case it's passed to `funcall' with no argument).
4086 If a matching file is loaded again, FORM will be evaluated again.
4088 If FILE is a string, it may be either an absolute or a relative file
4089 name, and may have an extension (e.g. \".el\") or may lack one, and
4090 additionally may or may not have an extension denoting a compressed
4091 format (e.g. \".gz\").
4093 When FILE is absolute, this first converts it to a true name by chasing
4094 symbolic links. Only a file of this name (see next paragraph regarding
4095 extensions) will trigger the evaluation of FORM. When FILE is relative,
4096 a file whose absolute true name ends in FILE will trigger evaluation.
4098 When FILE lacks an extension, a file name with any extension will trigger
4099 evaluation. Otherwise, its extension must match FILE's. A further
4100 extension for a compressed format (e.g. \".gz\") on FILE will not affect
4103 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
4104 is evaluated at the end of any file that `provide's this feature.
4105 If the feature is provided when evaluating code not associated with a
4106 file, FORM is evaluated immediately after the provide statement.
4108 Usually FILE is just a library name like \"font-lock\" or a feature name
4111 This function makes or adds to an entry on `after-load-alist'."
4112 (declare (compiler-macro
4114 (if (eq 'quote (car-safe form))
4115 ;; Quote with lambda so the compiler can look inside.
4116 `(eval-after-load ,file (lambda () ,(nth 1 form)))
4118 ;; Add this FORM into after-load-alist (regardless of whether we'll be
4119 ;; evaluating it now).
4120 (let* ((regexp-or-feature
4122 (setq file (purecopy (load-history-regexp file)))
4124 (elt (assoc regexp-or-feature after-load-alist))
4126 (if (functionp form) form
4127 ;; Try to use the "current" lexical/dynamic mode for `form'.
4128 (eval `(lambda () ,form) lexical-binding))))
4130 (setq elt (list regexp-or-feature))
4131 (push elt after-load-alist))
4132 ;; Is there an already loaded file whose name (or `provide' name)
4134 (prog1 (if (if (stringp file)
4135 (load-history-filename-element regexp-or-feature)
4139 (if (not (symbolp regexp-or-feature)) func
4140 ;; For features, the after-load-alist elements get run when
4141 ;; `provide' is called rather than at the end of the file.
4142 ;; So add an indirection to make sure that `func' is really run
4143 ;; "after-load" in case the provide call happens early.
4145 (if (not load-file-name)
4146 ;; Not being provided from a file, run func right now.
4148 (let ((lfn load-file-name)
4149 ;; Don't use letrec, because equal (in
4150 ;; add/remove-hook) would get trapped in a cycle.
4151 (fun (make-symbol "eval-after-load-helper")))
4152 (fset fun (lambda (file)
4153 (when (equal file lfn)
4154 (remove-hook 'after-load-functions fun)
4156 (add-hook 'after-load-functions fun 'append)))))))
4157 ;; Add FORM to the element unless it's already there.
4158 (unless (member delayed-func (cdr elt))
4159 (nconc elt (list delayed-func)))))))
4161 (defmacro with-eval-after-load (file &rest body)
4162 "Execute BODY after FILE is loaded.
4163 FILE is normally a feature name, but it can also be a file name,
4164 in case that file does not provide any feature. See `eval-after-load'
4165 for more details about the different forms of FILE and their semantics."
4166 (declare (indent 1) (debug t))
4167 `(eval-after-load ,file (lambda () ,@body)))
4169 (defvar after-load-functions nil
4170 "Special hook run after loading a file.
4171 Each function there is called with a single argument, the absolute
4172 name of the file just loaded.")
4174 (defun do-after-load-evaluation (abs-file)
4175 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
4176 ABS-FILE, a string, should be the absolute true name of a file just loaded.
4177 This function is called directly from the C code."
4178 ;; Run the relevant eval-after-load forms.
4179 (dolist (a-l-element after-load-alist)
4180 (when (and (stringp (car a-l-element))
4181 (string-match-p (car a-l-element) abs-file))
4182 ;; discard the file name regexp
4183 (mapc #'funcall (cdr a-l-element))))
4184 ;; Complain when the user uses obsolete files.
4185 (when (string-match-p "/obsolete/\\([^/]*\\)\\'" abs-file)
4186 ;; Maybe we should just use display-warning? This seems yucky...
4187 (let* ((file (file-name-nondirectory abs-file))
4188 (msg (format "Package %s is obsolete!"
4190 (string-match "\\.elc?\\>" file)))))
4191 ;; Cribbed from cl--compiling-file.
4192 (if (and (boundp 'byte-compile--outbuffer)
4193 (bufferp (symbol-value 'byte-compile--outbuffer))
4194 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
4195 " *Compiler Output*"))
4196 ;; Don't warn about obsolete files using other obsolete files.
4197 (unless (and (stringp byte-compile-current-file)
4198 (string-match-p "/obsolete/[^/]*\\'"
4200 byte-compile-current-file
4201 byte-compile-root-dir)))
4202 (byte-compile-log-warning msg))
4203 (run-with-timer 0 nil
4208 ;; Finally, run any other hook.
4209 (run-hook-with-args 'after-load-functions abs-file))
4211 (defun eval-next-after-load (file)
4212 "Read the following input sexp, and run it whenever FILE is loaded.
4213 This makes or adds to an entry on `after-load-alist'.
4214 FILE should be the name of a library, with no directory name."
4215 (declare (obsolete eval-after-load "23.2"))
4216 (eval-after-load file (read)))
4219 (defun display-delayed-warnings ()
4220 "Display delayed warnings from `delayed-warnings-list'.
4221 Used from `delayed-warnings-hook' (which see)."
4222 (dolist (warning (nreverse delayed-warnings-list))
4223 (apply 'display-warning warning))
4224 (setq delayed-warnings-list nil))
4226 (defun collapse-delayed-warnings ()
4227 "Remove duplicates from `delayed-warnings-list'.
4228 Collapse identical adjacent warnings into one (plus count).
4229 Used from `delayed-warnings-hook' (which see)."
4232 (while delayed-warnings-list
4233 (setq warning (pop delayed-warnings-list))
4234 (if (equal warning (car delayed-warnings-list))
4235 (setq count (1+ count))
4237 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
4240 (push warning collapsed)))
4241 (setq delayed-warnings-list (nreverse collapsed))))
4243 ;; At present this is only used for Emacs internals.
4244 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
4245 (defvar delayed-warnings-hook '(collapse-delayed-warnings
4246 display-delayed-warnings)
4247 "Normal hook run to process and display delayed warnings.
4248 By default, this hook contains functions to consolidate the
4249 warnings listed in `delayed-warnings-list', display them, and set
4250 `delayed-warnings-list' back to nil.")
4252 (defun delay-warning (type message &optional level buffer-name)
4253 "Display a delayed warning.
4254 Aside from going through `delayed-warnings-list', this is equivalent
4255 to `display-warning'."
4256 (push (list type message level buffer-name) delayed-warnings-list))
4259 ;;;; invisibility specs
4261 (defun add-to-invisibility-spec (element)
4262 "Add ELEMENT to `buffer-invisibility-spec'.
4263 See documentation for `buffer-invisibility-spec' for the kind of elements
4265 (if (eq buffer-invisibility-spec t)
4266 (setq buffer-invisibility-spec (list t)))
4267 (setq buffer-invisibility-spec
4268 (cons element buffer-invisibility-spec)))
4270 (defun remove-from-invisibility-spec (element)
4271 "Remove ELEMENT from `buffer-invisibility-spec'."
4272 (setq buffer-invisibility-spec
4273 (if (consp buffer-invisibility-spec)
4274 (delete element buffer-invisibility-spec)
4279 (defmacro with-syntax-table (table &rest body)
4280 "Evaluate BODY with syntax table of current buffer set to TABLE.
4281 The syntax table of the current buffer is saved, BODY is evaluated, and the
4282 saved table is restored, even in case of an abnormal exit.
4283 Value is what BODY returns."
4284 (declare (debug t) (indent 1))
4285 (let ((old-table (make-symbol "table"))
4286 (old-buffer (make-symbol "buffer")))
4287 `(let ((,old-table (syntax-table))
4288 (,old-buffer (current-buffer)))
4291 (set-syntax-table ,table)
4293 (save-current-buffer
4294 (set-buffer ,old-buffer)
4295 (set-syntax-table ,old-table))))))
4297 (defun make-syntax-table (&optional oldtable)
4298 "Return a new syntax table.
4299 Create a syntax table which inherits from OLDTABLE (if non-nil) or
4300 from `standard-syntax-table' otherwise."
4301 (let ((table (make-char-table 'syntax-table nil)))
4302 (set-char-table-parent table (or oldtable (standard-syntax-table)))
4305 (defun syntax-after (pos)
4306 "Return the raw syntax descriptor for the char after POS.
4307 If POS is outside the buffer's accessible portion, return nil."
4308 (unless (or (< pos (point-min)) (>= pos (point-max)))
4309 (let ((st (if parse-sexp-lookup-properties
4310 (get-char-property pos 'syntax-table))))
4312 (aref (or st (syntax-table)) (char-after pos))))))
4314 (defun syntax-class (syntax)
4315 "Return the code for the syntax class described by SYNTAX.
4317 SYNTAX should be a raw syntax descriptor; the return value is a
4318 integer which encodes the corresponding syntax class. See Info
4319 node `(elisp)Syntax Table Internals' for a list of codes.
4321 If SYNTAX is nil, return nil."
4322 (and syntax (logand (car syntax) 65535)))
4324 ;; Utility motion commands
4326 (defvar word-move-empty-char-table nil
4327 "Used in `forward-word-strictly' and `backward-word-strictly'
4328 to countermand the effect of `find-word-boundary-function-table'.")
4330 (defun forward-word-strictly (&optional arg)
4331 "Move point forward ARG words (backward if ARG is negative).
4332 If ARG is omitted or nil, move point forward one word.
4334 If an edge of the buffer or a field boundary is reached, point is left there
4335 and the function returns nil. Field boundaries are not noticed if
4336 `inhibit-field-text-motion' is non-nil.
4338 This function is like `forward-word', but it is not affected
4339 by `find-word-boundary-function-table'. It is also not interactive."
4340 (let ((find-word-boundary-function-table
4341 (if (char-table-p word-move-empty-char-table)
4342 word-move-empty-char-table
4343 (setq word-move-empty-char-table (make-char-table nil)))))
4344 (forward-word (or arg 1))))
4346 (defun backward-word-strictly (&optional arg)
4347 "Move backward until encountering the beginning of a word.
4348 With argument ARG, do this that many times.
4349 If ARG is omitted or nil, move point backward one word.
4351 This function is like `forward-word', but it is not affected
4352 by `find-word-boundary-function-table'. It is also not interactive."
4353 (let ((find-word-boundary-function-table
4354 (if (char-table-p word-move-empty-char-table)
4355 word-move-empty-char-table
4356 (setq word-move-empty-char-table (make-char-table nil)))))
4357 (forward-word (- (or arg 1)))))
4361 (defun forward-whitespace (arg)
4362 "Move point to the end of the next sequence of whitespace chars.
4363 Each such sequence may be a single newline, or a sequence of
4364 consecutive space and/or tab characters.
4365 With prefix argument ARG, do it ARG times if positive, or move
4366 backwards ARG times if negative."
4369 (re-search-forward "[ \t]+\\|\n" nil 'move arg)
4371 (if (re-search-backward "[ \t]+\\|\n" nil 'move)
4372 (or (eq (char-after (match-beginning 0)) ?\n)
4373 (skip-chars-backward " \t")))
4374 (setq arg (1+ arg)))))
4378 (defun forward-symbol (arg)
4379 "Move point to the next position that is the end of a symbol.
4380 A symbol is any sequence of characters that are in either the
4381 word constituent or symbol constituent syntax class.
4382 With prefix argument ARG, do it ARG times if positive, or move
4383 backwards ARG times if negative."
4386 (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
4388 (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
4389 (skip-syntax-backward "w_"))
4390 (setq arg (1+ arg)))))
4394 (defun forward-same-syntax (&optional arg)
4395 "Move point past all characters with the same syntax class.
4396 With prefix argument ARG, do it ARG times if positive, or move
4397 backwards ARG times if negative."
4399 (or arg (setq arg 1))
4401 (skip-syntax-backward
4402 (char-to-string (char-syntax (char-before))))
4403 (setq arg (1+ arg)))
4405 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4406 (setq arg (1- arg))))
4411 (defvar text-clone--maintaining nil)
4413 (defun text-clone--maintain (ol1 after beg end &optional _len)
4414 "Propagate the changes made under the overlay OL1 to the other clones.
4415 This is used on the `modification-hooks' property of text clones."
4416 (when (and after (not undo-in-progress)
4417 (not text-clone--maintaining)
4418 (overlay-start ol1))
4419 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4420 (setq beg (max beg (+ (overlay-start ol1) margin)))
4421 (setq end (min end (- (overlay-end ol1) margin)))
4424 (when (overlay-get ol1 'text-clone-syntax)
4425 ;; Check content of the clone's text.
4426 (let ((cbeg (+ (overlay-start ol1) margin))
4427 (cend (- (overlay-end ol1) margin)))
4430 (if (not (re-search-forward
4431 (overlay-get ol1 'text-clone-syntax) cend t))
4432 ;; Mark the overlay for deletion.
4434 (when (< (match-end 0) cend)
4435 ;; Shrink the clone at its end.
4436 (setq end (min end (match-end 0)))
4437 (move-overlay ol1 (overlay-start ol1)
4438 (+ (match-end 0) margin)))
4439 (when (> (match-beginning 0) cbeg)
4440 ;; Shrink the clone at its beginning.
4441 (setq beg (max (match-beginning 0) beg))
4442 (move-overlay ol1 (- (match-beginning 0) margin)
4443 (overlay-end ol1)))))))
4444 ;; Now go ahead and update the clones.
4445 (let ((head (- beg (overlay-start ol1)))
4446 (tail (- (overlay-end ol1) end))
4447 (str (buffer-substring beg end))
4449 (text-clone--maintaining t))
4450 (dolist (ol2 (overlay-get ol1 'text-clones))
4451 (let ((oe (overlay-end ol2)))
4452 (unless (or (eq ol1 ol2) (null oe))
4453 (setq nothing-left nil)
4454 (let ((mod-beg (+ (overlay-start ol2) head)))
4455 ;;(overlay-put ol2 'modification-hooks nil)
4456 (goto-char (- (overlay-end ol2) tail))
4457 (unless (> mod-beg (point))
4458 (save-excursion (insert str))
4459 (delete-region mod-beg (point)))
4460 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4462 (if nothing-left (delete-overlay ol1))))))))
4464 (defun text-clone-create (start end &optional spreadp syntax)
4465 "Create a text clone of START...END at point.
4466 Text clones are chunks of text that are automatically kept identical:
4467 changes done to one of the clones will be immediately propagated to the other.
4469 The buffer's content at point is assumed to be already identical to
4470 the one between START and END.
4471 If SYNTAX is provided it's a regexp that describes the possible text of
4472 the clones; the clone will be shrunk or killed if necessary to ensure that
4473 its text matches the regexp.
4474 If SPREADP is non-nil it indicates that text inserted before/after the
4475 clone should be incorporated in the clone."
4476 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4477 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4478 ;; (with a one-char margin at each end) with `t nil'.
4479 ;; We opted for a larger overlay because it behaves better in the case
4480 ;; where the clone is reduced to the empty string (we want the overlay to
4481 ;; stay when the clone's content is the empty string and we want to use
4482 ;; `evaporate' to make sure those overlays get deleted when needed).
4484 (let* ((pt-end (+ (point) (- end start)))
4485 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4487 (end-margin (if (or (not spreadp)
4488 (>= pt-end (point-max))
4489 (>= start (point-max)))
4491 ;; FIXME: Reuse overlays at point to extend dups!
4492 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4493 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4494 (dups (list ol1 ol2)))
4495 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4496 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4497 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4498 ;;(overlay-put ol1 'face 'underline)
4499 (overlay-put ol1 'evaporate t)
4500 (overlay-put ol1 'text-clones dups)
4502 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4503 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4504 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4505 ;;(overlay-put ol2 'face 'underline)
4506 (overlay-put ol2 'evaporate t)
4507 (overlay-put ol2 'text-clones dups)))
4509 ;;;; Mail user agents.
4511 ;; Here we include just enough for other packages to be able
4514 (defun define-mail-user-agent (symbol composefunc sendfunc
4515 &optional abortfunc hookvar)
4516 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4518 SYMBOL can be any Lisp symbol. Its function definition and/or
4519 value as a variable do not matter for this usage; we use only certain
4520 properties on its property list, to encode the rest of the arguments.
4522 COMPOSEFUNC is program callable function that composes an outgoing
4523 mail message buffer. This function should set up the basics of the
4524 buffer without requiring user interaction. It should populate the
4525 standard mail headers, leaving the `to:' and `subject:' headers blank
4528 COMPOSEFUNC should accept several optional arguments--the same
4529 arguments that `compose-mail' takes. See that function's documentation.
4531 SENDFUNC is the command a user would run to send the message.
4533 Optional ABORTFUNC is the command a user would run to abort the
4534 message. For mail packages that don't have a separate abort function,
4535 this can be `kill-buffer' (the equivalent of omitting this argument).
4537 Optional HOOKVAR is a hook variable that gets run before the message
4538 is actually sent. Callers that use the `mail-user-agent' may
4539 install a hook function temporarily on this hook variable.
4540 If HOOKVAR is nil, `mail-send-hook' is used.
4542 The properties used on SYMBOL are `composefunc', `sendfunc',
4543 `abortfunc', and `hookvar'."
4544 (put symbol 'composefunc composefunc)
4545 (put symbol 'sendfunc sendfunc)
4546 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4547 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4549 (defvar called-interactively-p-functions nil
4550 "Special hook called to skip special frames in `called-interactively-p'.
4551 The functions are called with 3 arguments: (I FRAME1 FRAME2),
4552 where FRAME1 is a \"current frame\", FRAME2 is the next frame,
4553 I is the index of the frame after FRAME2. It should return nil
4554 if those frames don't seem special and otherwise, it should return
4555 the number of frames to skip (minus 1).")
4557 (defconst internal--funcall-interactively
4558 (symbol-function 'funcall-interactively))
4560 (defun called-interactively-p (&optional kind)
4561 "Return t if the containing function was called by `call-interactively'.
4562 If KIND is `interactive', then only return t if the call was made
4563 interactively by the user, i.e. not in `noninteractive' mode nor
4564 when `executing-kbd-macro'.
4565 If KIND is `any', on the other hand, it will return t for any kind of
4566 interactive call, including being called as the binding of a key or
4567 from a keyboard macro, even in `noninteractive' mode.
4569 This function is very brittle, it may fail to return the intended result when
4570 the code is debugged, advised, or instrumented in some form. Some macros and
4571 special forms (such as `condition-case') may also sometimes wrap their bodies
4572 in a `lambda', so any call to `called-interactively-p' from those bodies will
4573 indicate whether that lambda (rather than the surrounding function) was called
4576 Instead of using this function, it is cleaner and more reliable to give your
4577 function an extra optional argument whose `interactive' spec specifies
4578 non-nil unconditionally (\"p\" is a good way to do this), or via
4579 \(not (or executing-kbd-macro noninteractive)).
4581 The only known proper use of `interactive' for KIND is in deciding
4582 whether to display a helpful message, or how to display it. If you're
4583 thinking of using it for any other purpose, it is quite likely that
4584 you're making a mistake. Think: what do you want to do when the
4585 command is called from a keyboard macro?"
4586 (declare (advertised-calling-convention (kind) "23.1"))
4587 (when (not (and (eq kind 'interactive)
4588 (or executing-kbd-macro noninteractive)))
4589 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4593 (setq frame nextframe)
4594 (setq nextframe (backtrace-frame i 'called-interactively-p))
4595 ;; (message "Frame %d = %S" i nextframe)
4597 (funcall get-next-frame) ;; Get the first frame.
4599 ;; FIXME: The edebug and advice handling should be made modular and
4600 ;; provided directly by edebug.el and nadvice.el.
4602 ;; frame =(backtrace-frame i-2)
4603 ;; nextframe=(backtrace-frame i-1)
4604 (funcall get-next-frame)
4605 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4606 ;; branches within local functions, which then messes up the
4607 ;; `backtrace-frame' data we get,
4609 ;; Skip special forms (from non-compiled code).
4610 (and frame (null (car frame)))
4611 ;; Skip also `interactive-p' (because we don't want to know if
4612 ;; interactive-p was called interactively but if it's caller was)
4613 ;; and `byte-code' (idem; this appears in subexpressions of things
4614 ;; like condition-case, which are wrapped in a separate bytecode
4616 ;; FIXME: For lexical-binding code, this is much worse,
4617 ;; because the frames look like "byte-code -> funcall -> #[...]",
4618 ;; which is not a reliable signature.
4619 (memq (nth 1 frame) '(interactive-p 'byte-code))
4620 ;; Skip package-specific stack-frames.
4621 (let ((skip (run-hook-with-args-until-success
4622 'called-interactively-p-functions
4623 i frame nextframe)))
4627 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4628 ;; Now `frame' should be "the function from which we were called".
4629 (pcase (cons frame nextframe)
4630 ;; No subr calls `interactive-p', so we can rule that out.
4631 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
4632 ;; In case #<subr funcall-interactively> without going through the
4633 ;; `funcall-interactively' symbol (bug#3984).
4634 (`(,_ . (t ,(pred (lambda (f)
4635 (eq internal--funcall-interactively
4636 (indirect-function f))))
4640 (defun interactive-p ()
4641 "Return t if the containing function was run directly by user input.
4642 This means that the function was called with `call-interactively'
4643 \(which includes being called as the binding of a key)
4644 and input is currently coming from the keyboard (not a keyboard macro),
4645 and Emacs is not running in batch mode (`noninteractive' is nil).
4647 The only known proper use of `interactive-p' is in deciding whether to
4648 display a helpful message, or how to display it. If you're thinking
4649 of using it for any other purpose, it is quite likely that you're
4650 making a mistake. Think: what do you want to do when the command is
4651 called from a keyboard macro or in batch mode?
4653 To test whether your function was called with `call-interactively',
4654 either (i) add an extra optional argument and give it an `interactive'
4655 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
4656 use `called-interactively-p'."
4657 (declare (obsolete called-interactively-p "23.2"))
4658 (called-interactively-p 'interactive))
4660 (defun internal-push-keymap (keymap symbol)
4661 (let ((map (symbol-value symbol)))
4662 (unless (memq keymap map)
4663 (unless (memq 'add-keymap-witness (symbol-value symbol))
4664 (setq map (make-composed-keymap nil (symbol-value symbol)))
4665 (push 'add-keymap-witness (cdr map))
4667 (push keymap (cdr map)))))
4669 (defun internal-pop-keymap (keymap symbol)
4670 (let ((map (symbol-value symbol)))
4671 (when (memq keymap map)
4672 (setf (cdr map) (delq keymap (cdr map))))
4673 (let ((tail (cddr map)))
4674 (and (or (null tail) (keymapp tail))
4675 (eq 'add-keymap-witness (nth 1 map))
4676 (set symbol tail)))))
4678 (define-obsolete-function-alias
4679 'set-temporary-overlay-map 'set-transient-map "24.4")
4681 (defun set-transient-map (map &optional keep-pred on-exit)
4682 "Set MAP as a temporary keymap taking precedence over other keymaps.
4683 Normally, MAP is used only once, to look up the very next key.
4684 However, if the optional argument KEEP-PRED is t, MAP stays
4685 active if a key from MAP is used. KEEP-PRED can also be a
4686 function of no arguments: it is called from `pre-command-hook' and
4687 if it returns non-nil, then MAP stays active.
4689 Optional arg ON-EXIT, if non-nil, specifies a function that is
4690 called, with no arguments, after MAP is deactivated.
4692 This uses `overriding-terminal-local-map' which takes precedence over all other
4693 keymaps. As usual, if no match for a key is found in MAP, the normal key
4694 lookup sequence then continues.
4696 This returns an \"exit function\", which can be called with no argument
4697 to deactivate this transient map, regardless of KEEP-PRED."
4698 (let* ((clearfun (make-symbol "clear-transient-map"))
4701 (internal-pop-keymap map 'overriding-terminal-local-map)
4702 (remove-hook 'pre-command-hook clearfun)
4703 (when on-exit (funcall on-exit)))))
4704 ;; Don't use letrec, because equal (in add/remove-hook) would get trapped
4708 (with-demoted-errors "set-transient-map PCH: %S"
4710 ((null keep-pred) nil)
4711 ((not (eq map (cadr overriding-terminal-local-map)))
4712 ;; There's presumably some other transient-map in
4713 ;; effect. Wait for that one to terminate before we
4714 ;; remove ourselves.
4715 ;; For example, if isearch and C-u both use transient
4716 ;; maps, then the lifetime of the C-u should be nested
4717 ;; within isearch's, so the pre-command-hook of
4718 ;; isearch should be suspended during the C-u one so
4719 ;; we don't exit isearch just because we hit 1 after
4720 ;; C-u and that 1 exits isearch whereas it doesn't
4725 (lookup-key map (this-command-keys-vector))))
4726 (t (funcall keep-pred)))
4727 (funcall exitfun)))))
4728 (add-hook 'pre-command-hook clearfun)
4729 (internal-push-keymap map 'overriding-terminal-local-map)
4732 ;;;; Progress reporters.
4734 ;; Progress reporter has the following structure:
4736 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4743 ;; This weirdness is for optimization reasons: we want
4744 ;; `progress-reporter-update' to be as fast as possible, so
4745 ;; `(car reporter)' is better than `(aref reporter 0)'.
4747 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4748 ;; digits of precision, it doesn't really matter here. On the other
4749 ;; hand, it greatly simplifies the code.
4751 (defsubst progress-reporter-update (reporter &optional value)
4752 "Report progress of an operation in the echo area.
4753 REPORTER should be the result of a call to `make-progress-reporter'.
4755 If REPORTER is a numerical progress reporter---i.e. if it was
4756 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4757 `make-progress-reporter'---then VALUE should be a number between
4758 MIN-VALUE and MAX-VALUE.
4760 If REPORTER is a non-numerical reporter, VALUE should be nil.
4762 This function is relatively inexpensive. If the change since
4763 last update is too small or insufficient time has passed, it does
4765 (when (or (not (numberp value)) ; For pulsing reporter
4766 (>= value (car reporter))) ; For numerical reporter
4767 (progress-reporter-do-update reporter value)))
4769 (defun make-progress-reporter (message &optional min-value max-value
4770 current-value min-change min-time)
4771 "Return progress reporter object for use with `progress-reporter-update'.
4773 MESSAGE is shown in the echo area, with a status indicator
4774 appended to the end. When you call `progress-reporter-done', the
4775 word \"done\" is printed after the MESSAGE. You can change the
4776 MESSAGE of an existing progress reporter by calling
4777 `progress-reporter-force-update'.
4779 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4780 and final (100% complete) states of operation; the latter should
4781 be larger. In this case, the status message shows the percentage
4784 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4785 message shows a \"spinning\", non-numeric indicator.
4787 Optional CURRENT-VALUE is the initial progress; the default is
4789 Optional MIN-CHANGE is the minimal change in percents to report;
4791 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4792 and/or MAX-VALUE are nil.
4794 Optional MIN-TIME specifies the minimum interval time between
4795 echo area updates (default is 0.2 seconds.) If the function
4796 `float-time' is not present, time is not tracked at all. If the
4797 OS is not capable of measuring fractions of seconds, this
4798 parameter is effectively rounded up."
4799 (when (string-match "[[:alnum:]]\\'" message)
4800 (setq message (concat message "...")))
4802 (setq min-time 0.2))
4804 ;; Force a call to `message' now
4805 (cons (or min-value 0)
4806 (vector (if (and (fboundp 'float-time)
4812 (if min-change (max (min min-change 50) 1) 1)
4814 (progress-reporter-update reporter (or current-value min-value))
4817 (defun progress-reporter-force-update (reporter &optional value new-message)
4818 "Report progress of an operation in the echo area unconditionally.
4820 The first two arguments are the same as in `progress-reporter-update'.
4821 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4822 (let ((parameters (cdr reporter)))
4824 (aset parameters 3 new-message))
4825 (when (aref parameters 0)
4826 (aset parameters 0 (float-time)))
4827 (progress-reporter-do-update reporter value)))
4829 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4830 "Characters to use for pulsing progress reporters.")
4832 (defun progress-reporter-do-update (reporter value)
4833 (let* ((parameters (cdr reporter))
4834 (update-time (aref parameters 0))
4835 (min-value (aref parameters 1))
4836 (max-value (aref parameters 2))
4837 (text (aref parameters 3))
4839 ;; See if enough time has passed since the last update.
4840 (or (not update-time)
4841 (when (>= (float-time) update-time)
4842 ;; Calculate time for the next update
4843 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4844 (cond ((and min-value max-value)
4845 ;; Numerical indicator
4846 (let* ((one-percent (/ (- max-value min-value) 100.0))
4847 (percentage (if (= max-value min-value)
4849 (truncate (/ (- value min-value)
4851 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4852 ;; message because not enough time has passed, use 1
4853 ;; instead of MIN-CHANGE. This makes delays between echo
4854 ;; area updates closer to MIN-TIME.
4856 (min (+ min-value (* (+ percentage
4857 (if enough-time-passed
4863 (when (integerp value)
4864 (setcar reporter (ceiling (car reporter))))
4865 ;; Only print message if enough time has passed
4866 (when enough-time-passed
4867 (if (> percentage 0)
4868 (message "%s%d%%" text percentage)
4869 (message "%s" text)))))
4870 ;; Pulsing indicator
4872 (let ((index (mod (1+ (car reporter)) 4))
4873 (message-log-max nil))
4874 (setcar reporter index)
4877 (aref progress-reporter--pulse-characters
4880 (defun progress-reporter-done (reporter)
4881 "Print reporter's message followed by word \"done\" in echo area."
4882 (message "%sdone" (aref (cdr reporter) 3)))
4884 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4885 "Loop a certain number of times and report progress in the echo area.
4886 Evaluate BODY with VAR bound to successive integers running from
4887 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4888 the return value (nil if RESULT is omitted).
4890 At each iteration MESSAGE followed by progress percentage is
4891 printed in the echo area. After the loop is finished, MESSAGE
4892 followed by word \"done\" is printed. This macro is a
4893 convenience wrapper around `make-progress-reporter' and friends.
4895 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4896 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4897 (let ((temp (make-symbol "--dotimes-temp--"))
4898 (temp2 (make-symbol "--dotimes-temp2--"))
4902 (,(car spec) ,start)
4903 (,temp2 (make-progress-reporter ,message ,start ,end)))
4904 (while (< ,(car spec) ,temp)
4906 (progress-reporter-update ,temp2
4907 (setq ,(car spec) (1+ ,(car spec)))))
4908 (progress-reporter-done ,temp2)
4909 nil ,@(cdr (cdr spec)))))
4912 ;;;; Comparing version strings.
4914 (defconst version-separator "."
4915 "Specify the string used to separate the version elements.
4917 Usually the separator is \".\", but it can be any other string.")
4920 (defconst version-regexp-alist
4921 '(("^[-._+ ]?snapshot$" . -4)
4922 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4924 ;; treat "1.2.3-CVS" as snapshot release
4925 ("^[-._+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4)
4926 ("^[-._+ ]?alpha$" . -3)
4927 ("^[-._+ ]?beta$" . -2)
4928 ("^[-._+ ]?\\(pre\\|rc\\)$" . -1))
4929 "Specify association between non-numeric version and its priority.
4931 This association is used to handle version string like \"1.0pre2\",
4932 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4933 non-numeric part of a version string to an integer. For example:
4935 String Version Integer List Version
4936 \"0.9snapshot\" (0 9 -4)
4937 \"1.0-git\" (1 0 -4)
4938 \"1.0.cvs\" (1 0 -4)
4939 \"1.0pre2\" (1 0 -1 2)
4940 \"1.0PRE2\" (1 0 -1 2)
4941 \"22.8beta3\" (22 8 -2 3)
4942 \"22.8 Beta3\" (22 8 -2 3)
4943 \"0.9alpha1\" (0 9 -3 1)
4944 \"0.9AlphA1\" (0 9 -3 1)
4945 \"0.9 alpha\" (0 9 -3)
4947 Each element has the following form:
4953 REGEXP regexp used to match non-numeric part of a version string.
4954 It should begin with the `^' anchor and end with a `$' to
4955 prevent false hits. Letter-case is ignored while matching
4958 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4961 (defun version-to-list (ver)
4962 "Convert version string VER into a list of integers.
4964 The version syntax is given by the following EBNF:
4966 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4968 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4970 SEPARATOR ::= `version-separator' (which see)
4971 | `version-regexp-alist' (which see).
4973 The NUMBER part is optional if SEPARATOR is a match for an element
4974 in `version-regexp-alist'.
4976 Examples of valid version syntax:
4978 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta 2.4.snapshot .5
4980 Examples of invalid version syntax:
4982 1.0prepre2 1.0..7.5 22.8X3 alpha3.2
4984 Examples of version conversion:
4986 Version String Version as a List of Integers
4988 \"0.9 alpha\" (0 9 -3)
4989 \"0.9AlphA1\" (0 9 -3 1)
4990 \"0.9snapshot\" (0 9 -4)
4991 \"1.0-git\" (1 0 -4)
4992 \"1.0.7.5\" (1 0 7 5)
4993 \"1.0.cvs\" (1 0 -4)
4994 \"1.0PRE2\" (1 0 -1 2)
4995 \"1.0pre2\" (1 0 -1 2)
4996 \"22.8 Beta3\" (22 8 -2 3)
4997 \"22.8beta3\" (22 8 -2 3)
4999 See documentation for `version-separator' and `version-regexp-alist'."
5000 (unless (stringp ver)
5001 (error "Version must be a string"))
5002 ;; Change .x.y to 0.x.y
5003 (if (and (>= (length ver) (length version-separator))
5004 (string-equal (substring ver 0 (length version-separator))
5006 (setq ver (concat "0" ver)))
5007 (unless (string-match-p "^[0-9]" ver)
5008 (error "Invalid version syntax: `%s' (must start with a number)" ver))
5012 (case-fold-search t) ; ignore case in matching
5014 ;; Parse the version-string up to a separator until there are none left
5015 (while (and (setq s (string-match "[0-9]+" ver i))
5017 ;; Add the numeric part to the beginning of the version list;
5018 ;; lst gets reversed at the end
5019 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
5022 ;; handle non-numeric part
5023 (when (and (setq s (string-match "[^0-9]+" ver i))
5025 (setq s (substring ver i (match-end 0))
5027 ;; handle alpha, beta, pre, etc. separator
5028 (unless (string= s version-separator)
5029 (setq al version-regexp-alist)
5030 (while (and al (not (string-match (caar al) s)))
5033 (push (cdar al) lst))
5034 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc., but only if
5035 ;; the letter is the end of the version-string, to avoid
5036 ;; 22.8X3 being valid
5037 ((and (string-match "^[-._+ ]?\\([a-zA-Z]\\)$" s)
5039 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
5041 (t (error "Invalid version syntax: `%s'" ver))))))
5044 (defun version-list-< (l1 l2)
5045 "Return t if L1, a list specification of a version, is lower than L2.
5047 Note that a version specified by the list (1) is equal to (1 0),
5048 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5049 Also, a version given by the list (1) is higher than (1 -1), which in
5050 turn is higher than (1 -2), which is higher than (1 -3)."
5051 (while (and l1 l2 (= (car l1) (car l2)))
5055 ;; l1 not null and l2 not null
5056 ((and l1 l2) (< (car l1) (car l2)))
5057 ;; l1 null and l2 null ==> l1 length = l2 length
5058 ((and (null l1) (null l2)) nil)
5059 ;; l1 not null and l2 null ==> l1 length > l2 length
5060 (l1 (< (version-list-not-zero l1) 0))
5061 ;; l1 null and l2 not null ==> l2 length > l1 length
5062 (t (< 0 (version-list-not-zero l2)))))
5065 (defun version-list-= (l1 l2)
5066 "Return t if L1, a list specification of a version, is equal to L2.
5068 Note that a version specified by the list (1) is equal to (1 0),
5069 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5070 Also, a version given by the list (1) is higher than (1 -1), which in
5071 turn is higher than (1 -2), which is higher than (1 -3)."
5072 (while (and l1 l2 (= (car l1) (car l2)))
5076 ;; l1 not null and l2 not null
5078 ;; l1 null and l2 null ==> l1 length = l2 length
5079 ((and (null l1) (null l2)))
5080 ;; l1 not null and l2 null ==> l1 length > l2 length
5081 (l1 (zerop (version-list-not-zero l1)))
5082 ;; l1 null and l2 not null ==> l2 length > l1 length
5083 (t (zerop (version-list-not-zero l2)))))
5086 (defun version-list-<= (l1 l2)
5087 "Return t if L1, a list specification of a version, is lower or equal to L2.
5089 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
5090 etc. That is, the trailing zeroes are insignificant. Also, integer
5091 list (1) is greater than (1 -1) which is greater than (1 -2)
5092 which is greater than (1 -3)."
5093 (while (and l1 l2 (= (car l1) (car l2)))
5097 ;; l1 not null and l2 not null
5098 ((and l1 l2) (< (car l1) (car l2)))
5099 ;; l1 null and l2 null ==> l1 length = l2 length
5100 ((and (null l1) (null l2)))
5101 ;; l1 not null and l2 null ==> l1 length > l2 length
5102 (l1 (<= (version-list-not-zero l1) 0))
5103 ;; l1 null and l2 not null ==> l2 length > l1 length
5104 (t (<= 0 (version-list-not-zero l2)))))
5106 (defun version-list-not-zero (lst)
5107 "Return the first non-zero element of LST, which is a list of integers.
5109 If all LST elements are zeros or LST is nil, return zero."
5110 (while (and lst (zerop (car lst)))
5111 (setq lst (cdr lst)))
5114 ;; there is no element different of zero
5118 (defun version< (v1 v2)
5119 "Return t if version V1 is lower (older) than V2.
5121 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
5122 etc. That is, the trailing \".0\"s are insignificant. Also, version
5123 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
5124 which is higher than \"1alpha\", which is higher than \"1snapshot\".
5125 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
5126 (version-list-< (version-to-list v1) (version-to-list v2)))
5128 (defun version<= (v1 v2)
5129 "Return t if version V1 is lower (older) than or equal to V2.
5131 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
5132 etc. That is, the trailing \".0\"s are insignificant. Also, version
5133 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
5134 which is higher than \"1alpha\", which is higher than \"1snapshot\".
5135 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
5136 (version-list-<= (version-to-list v1) (version-to-list v2)))
5138 (defun version= (v1 v2)
5139 "Return t if version V1 is equal to V2.
5141 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
5142 etc. That is, the trailing \".0\"s are insignificant. Also, version
5143 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
5144 which is higher than \"1alpha\", which is higher than \"1snapshot\".
5145 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
5146 (version-list-= (version-to-list v1) (version-to-list v2)))
5148 (defvar package--builtin-versions
5149 ;; Mostly populated by loaddefs.el via autoload-builtin-package-versions.
5150 (purecopy `((emacs . ,(version-to-list emacs-version))))
5151 "Alist giving the version of each versioned builtin package.
5152 I.e. each element of the list is of the form (NAME . VERSION) where
5153 NAME is the package name as a symbol, and VERSION is its version
5156 (defun package--description-file (dir)
5157 (concat (let ((subdir (file-name-nondirectory
5158 (directory-file-name dir))))
5159 (if (string-match "\\([^.].*?\\)-\\([0-9]+\\(?:[.][0-9]+\\|\\(?:pre\\|beta\\|alpha\\)[0-9]+\\)*\\)" subdir)
5160 (match-string 1 subdir) subdir))
5166 (defvar definition-prefixes (make-hash-table :test 'equal)
5167 "Hash table mapping prefixes to the files in which they're used.
5168 This can be used to automatically fetch not-yet-loaded definitions.
5169 More specifically, if there is a value of the form (FILES...) for a string PREFIX
5170 it means that the FILES define variables or functions with names that start
5173 Note that it does not imply that all definitions starting with PREFIX can
5174 be found in those files. E.g. if prefix is \"gnus-article-\" there might
5175 still be definitions of the form \"gnus-article-toto-titi\" in other files, which would
5176 presumably appear in this table under another prefix such as \"gnus-\"
5177 or \"gnus-article-toto-\".")
5179 (defun register-definition-prefixes (file prefixes)
5180 "Register that FILE uses PREFIXES."
5181 (dolist (prefix prefixes)
5182 (puthash prefix (cons file (gethash prefix definition-prefixes))
5183 definition-prefixes)))
5185 (defconst menu-bar-separator '("--")
5186 "Separator for menus.")
5188 ;; The following statement ought to be in print.c, but `provide' can't
5190 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
5191 (when (hash-table-p (car (read-from-string
5192 (prin1-to-string (make-hash-table)))))
5193 (provide 'hashtable-print-readable))
5195 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
5196 ;; generate file names for autoloads, custom-deps, and finder-data.
5197 (defun unmsys--file-name (file)
5198 "Produce the canonical file name for FILE from its MSYS form.
5200 On systems other than MS-Windows, just returns FILE.
5201 On MS-Windows, converts /d/foo/bar form of file names
5202 passed by MSYS Make into d:/foo/bar that Emacs can grok.
5204 This function is called from lisp/Makefile and leim/Makefile."
5205 (when (and (eq system-type 'windows-nt)
5206 (string-match "\\`/[a-zA-Z]/" file))
5207 (setq file (concat (substring file 1 2) ":" (substring file 2))))
5211 ;;; subr.el ends here