1 ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8; lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2015 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Beware: while this file has tag `utf-8', before it's compiled, it gets
29 ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
31 (defmacro declare-function (_fn _file &optional _arglist _fileonly)
32 "Tell the byte-compiler that function FN is defined, in FILE.
33 Optional ARGLIST is the argument list used by the function.
34 The FILE argument is not used by the byte-compiler, but by the
35 `check-declare' package, which checks that FILE contains a
36 definition for FN. ARGLIST is used by both the byte-compiler
37 and `check-declare' to check for consistency.
39 FILE can be either a Lisp file (in which case the \".el\"
40 extension is optional), or a C file. C files are expanded
41 relative to the Emacs \"src/\" directory. Lisp files are
42 searched for using `locate-library', and if that fails they are
43 expanded relative to the location of the file containing the
44 declaration. A FILE with an \"ext:\" prefix is an external file.
45 `check-declare' will check such files if they are found, and skip
46 them without error if they are not.
48 FILEONLY non-nil means that `check-declare' will only check that
49 FILE exists, not that it defines FN. This is intended for
50 function-definitions that `check-declare' does not recognize, e.g.
53 To specify a value for FILEONLY without passing an argument list,
54 set ARGLIST to t. This is necessary because nil means an
55 empty argument list, rather than an unspecified one.
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 ;; Does nothing - byte-compile-declare-function does the work.
65 ;;;; Basic Lisp macros.
69 (defmacro noreturn (form)
70 "Evaluate FORM, expecting it not to return.
71 If FORM does return, signal an error."
74 (error "Form marked with `noreturn' did return")))
76 (defmacro 1value (form)
77 "Evaluate FORM, expecting a constant return value.
78 This is the global do-nothing version. There is also `testcover-1value'
79 that complains if FORM ever does return differing values."
83 (defmacro def-edebug-spec (symbol spec)
84 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
85 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
86 0 (instrument no arguments); t (instrument all arguments);
87 a symbol (naming a function with an Edebug specification); or a list.
88 The elements of the list describe the argument types; see
89 Info node `(elisp)Specification List' for details."
90 `(put (quote ,symbol) 'edebug-form-spec (quote ,spec)))
92 (defmacro lambda (&rest cdr)
93 "Return a lambda expression.
94 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
95 self-quoting; the result of evaluating the lambda expression is the
96 expression itself. The lambda expression may then be treated as a
97 function, i.e., stored as the function value of a symbol, passed to
98 `funcall' or `mapcar', etc.
100 ARGS should take the same form as an argument list for a `defun'.
101 DOCSTRING is an optional documentation string.
102 If present, it should describe how to call the function.
103 But documentation strings are usually not useful in nameless functions.
104 INTERACTIVE should be a call to the function `interactive', which see.
105 It may also be omitted.
106 BODY should be a list of Lisp expressions.
108 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
109 (declare (doc-string 2) (indent defun)
110 (debug (&define lambda-list
112 [&optional ("interactive" interactive)]
114 ;; Note that this definition should not use backquotes; subr.el should not
115 ;; depend on backquote.el.
116 (list 'function (cons 'lambda cdr)))
118 (defmacro setq-local (var val)
119 "Set variable VAR to value VAL in current buffer."
120 ;; Can't use backquote here, it's too early in the bootstrap.
121 (list 'set (list 'make-local-variable (list 'quote var)) val))
123 (defmacro defvar-local (var val &optional docstring)
124 "Define VAR as a buffer-local variable with default value VAL.
125 Like `defvar' but additionally marks the variable as being automatically
126 buffer-local wherever it is set."
127 (declare (debug defvar) (doc-string 3))
128 ;; Can't use backquote here, it's too early in the bootstrap.
129 (list 'progn (list 'defvar var val docstring)
130 (list 'make-variable-buffer-local (list 'quote var))))
132 (defun apply-partially (fun &rest args)
133 "Return a function that is a partial application of FUN to ARGS.
134 ARGS is a list of the first N arguments to pass to FUN.
135 The result is a new function which does the same as FUN, except that
136 the first N arguments are fixed at the values with which this function
138 `(closure (t) (&rest args)
139 (apply ',fun ,@(mapcar (lambda (arg) `',arg) args) args)))
141 (defmacro push (newelt place)
142 "Add NEWELT to the list stored in the generalized variable PLACE.
143 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
144 except that PLACE is only evaluated once (after NEWELT)."
145 (declare (debug (form gv-place)))
147 ;; Important special case, to avoid triggering GV too early in
150 (list 'cons newelt place))
152 (macroexp-let2 macroexp-copyable-p v newelt
153 (gv-letplace (getter setter) place
154 (funcall setter `(cons ,v ,getter))))))
156 (defmacro pop (place)
157 "Return the first element of PLACE's value, and remove it from the list.
158 PLACE must be a generalized variable whose value is a list.
159 If the value is nil, `pop' returns nil but does not actually
161 (declare (debug (gv-place)))
162 ;; We use `car-safe' here instead of `car' because the behavior is the same
163 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
164 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
165 ;; result is not used.
168 ;; So we can use `pop' in the bootstrap before `gv' can be used.
169 (list 'prog1 place (list 'setq place (list 'cdr place)))
170 (gv-letplace (getter setter) place
171 `(prog1 ,getter ,(funcall setter `(cdr ,getter)))))))
173 (defmacro when (cond &rest body)
174 "If COND yields non-nil, do BODY, else return nil.
175 When COND yields non-nil, eval BODY forms sequentially and return
176 value of last one, or nil if there are none.
179 (declare (indent 1) (debug t))
180 (list 'if cond (cons 'progn body)))
182 (defmacro unless (cond &rest body)
183 "If COND yields nil, do BODY, else return nil.
184 When COND yields nil, eval BODY forms sequentially and return
185 value of last one, or nil if there are none.
188 (declare (indent 1) (debug t))
189 (cons 'if (cons cond (cons nil body))))
191 (defmacro dolist (spec &rest body)
193 Evaluate BODY with VAR bound to each car from LIST, in turn.
194 Then evaluate RESULT to get return value, default nil.
196 \(fn (VAR LIST [RESULT]) BODY...)"
197 (declare (indent 1) (debug ((symbolp form &optional form) body)))
198 ;; It would be cleaner to create an uninterned symbol,
199 ;; but that uses a lot more space when many functions in many files
201 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
202 (let ((temp '--dolist-tail--))
203 ;; This is not a reliable test, but it does not matter because both
204 ;; semantics are acceptable, tho one is slightly faster with dynamic
205 ;; scoping and the other is slightly faster (and has cleaner semantics)
206 ;; with lexical scoping.
208 `(let ((,temp ,(nth 1 spec)))
210 (let ((,(car spec) (car ,temp)))
212 (setq ,temp (cdr ,temp))))
214 `(let ((,temp ,(nth 1 spec))
217 (setq ,(car spec) (car ,temp))
219 (setq ,temp (cdr ,temp)))
220 ,@(if (cdr (cdr spec))
221 `((setq ,(car spec) nil) ,@(cdr (cdr spec))))))))
223 (defmacro dotimes (spec &rest body)
224 "Loop a certain number of times.
225 Evaluate BODY with VAR bound to successive integers running from 0,
226 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
227 the return value (nil if RESULT is omitted).
229 \(fn (VAR COUNT [RESULT]) BODY...)"
230 (declare (indent 1) (debug dolist))
231 ;; It would be cleaner to create an uninterned symbol,
232 ;; but that uses a lot more space when many functions in many files
234 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
235 (let ((temp '--dotimes-limit--)
238 ;; This is not a reliable test, but it does not matter because both
239 ;; semantics are acceptable, tho one is slightly faster with dynamic
240 ;; scoping and the other has cleaner semantics.
242 (let ((counter '--dotimes-counter--))
245 (while (< ,counter ,temp)
246 (let ((,(car spec) ,counter))
248 (setq ,counter (1+ ,counter)))
250 ;; FIXME: This let often leads to "unused var" warnings.
251 `((let ((,(car spec) ,counter)) ,@(cddr spec))))))
253 (,(car spec) ,start))
254 (while (< ,(car spec) ,temp)
256 (setq ,(car spec) (1+ ,(car spec))))
257 ,@(cdr (cdr spec))))))
259 (defmacro declare (&rest _specs)
260 "Do not evaluate any arguments, and return nil.
261 If a `declare' form appears as the first form in the body of a
262 `defun' or `defmacro' form, SPECS specifies various additional
263 information about the function or macro; these go into effect
264 during the evaluation of the `defun' or `defmacro' form.
266 The possible values of SPECS are specified by
267 `defun-declarations-alist' and `macro-declarations-alist'."
268 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
271 (defmacro ignore-errors (&rest body)
272 "Execute BODY; if an error occurs, return nil.
273 Otherwise, return result of last form in BODY.
274 See also `with-demoted-errors' that does something similar
275 without silencing all errors."
276 (declare (debug t) (indent 0))
277 `(condition-case nil (progn ,@body) (error nil)))
279 ;;;; Basic Lisp functions.
281 (defun ignore (&rest _ignore)
282 "Do nothing and return nil.
283 This function accepts any number of arguments, but ignores them."
287 ;; Signal a compile-error if the first arg is missing.
288 (defun error (&rest args)
289 "Signal an error, making error message by passing all args to `format'.
290 In Emacs, the convention is that error messages start with a capital
291 letter but *do not* end with a period. Please follow this convention
292 for the sake of consistency."
293 (declare (advertised-calling-convention (string &rest args) "23.1"))
294 (signal 'error (list (apply 'format args))))
296 (defun user-error (format &rest args)
297 "Signal a pilot error, making error message by passing all args to `format'.
298 In Emacs, the convention is that error messages start with a capital
299 letter but *do not* end with a period. Please follow this convention
300 for the sake of consistency.
301 This is just like `error' except that `user-error's are expected to be the
302 result of an incorrect manipulation on the part of the user, rather than the
303 result of an actual problem."
304 (signal 'user-error (list (apply #'format format args))))
306 (defun define-error (name message &optional parent)
307 "Define NAME as a new error signal.
308 MESSAGE is a string that will be output to the echo area if such an error
309 is signaled without being caught by a `condition-case'.
310 PARENT is either a signal or a list of signals from which it inherits.
311 Defaults to `error'."
312 (unless parent (setq parent 'error))
316 (mapcar (lambda (parent)
318 (or (get parent 'error-conditions)
319 (error "Unknown signal `%s'" parent))))
321 (cons parent (get parent 'error-conditions)))))
322 (put name 'error-conditions
323 (delete-dups (copy-sequence (cons name conditions))))
324 (when message (put name 'error-message message))))
326 ;; We put this here instead of in frame.el so that it's defined even on
327 ;; systems where frame.el isn't loaded.
328 (defun frame-configuration-p (object)
329 "Return non-nil if OBJECT seems to be a frame configuration.
330 Any list whose car is `frame-configuration' is assumed to be a frame
333 (eq (car object) 'frame-configuration)))
338 "Return the car of the car of X."
342 "Return the car of the cdr of X."
346 "Return the cdr of the car of X."
350 "Return the cdr of the cdr of X."
353 (defun last (list &optional n)
354 "Return the last link of LIST. Its car is the last element.
355 If LIST is nil, return nil.
356 If N is non-nil, return the Nth-to-last link of LIST.
357 If N is bigger than the length of LIST, return LIST."
360 (let ((m (safe-length list)))
361 (if (< n m) (nthcdr (- m n) list) list)))
363 (nthcdr (1- (safe-length list)) list))))
365 (defun butlast (list &optional n)
366 "Return a copy of LIST with the last N elements removed.
367 If N is omitted or nil, the last element is removed from the
369 (if (and n (<= n 0)) list
370 (nbutlast (copy-sequence list) n)))
372 (defun nbutlast (list &optional n)
373 "Modifies LIST to remove the last N elements.
374 If N is omitted or nil, remove the last element."
375 (let ((m (length list)))
379 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
382 (defun delete-dups (list)
383 "Destructively remove `equal' duplicates from LIST.
384 Store the result in LIST and return it. LIST must be a proper list.
385 Of several `equal' occurrences of an element in LIST, the first
389 (setcdr tail (delete (car tail) (cdr tail)))
390 (setq tail (cdr tail))))
393 ;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html
394 (defun delete-consecutive-dups (list &optional circular)
395 "Destructively remove `equal' consecutive duplicates from LIST.
396 First and last elements are considered consecutive if CIRCULAR is
398 (let ((tail list) last)
400 (if (equal (car tail) (cadr tail))
401 (setcdr tail (cddr tail))
402 (setq last (car tail)
406 (equal last (car list)))
410 (defun number-sequence (from &optional to inc)
411 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
412 INC is the increment used between numbers in the sequence and defaults to 1.
413 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
414 zero. TO is only included if there is an N for which TO = FROM + N * INC.
415 If TO is nil or numerically equal to FROM, return (FROM).
416 If INC is positive and TO is less than FROM, or INC is negative
417 and TO is larger than FROM, return nil.
418 If INC is zero and TO is neither nil nor numerically equal to
419 FROM, signal an error.
421 This function is primarily designed for integer arguments.
422 Nevertheless, FROM, TO and INC can be integer or float. However,
423 floating point arithmetic is inexact. For instance, depending on
424 the machine, it may quite well happen that
425 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
426 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
427 elements. Thus, if some of the arguments are floats and one wants
428 to make sure that TO is included, one may have to explicitly write
429 TO as (+ FROM (* N INC)) or use a variable whose value was
430 computed with this exact expression. Alternatively, you can,
431 of course, also replace TO with a slightly larger value
432 \(or a slightly more negative value if INC is negative)."
433 (if (or (not to) (= from to))
435 (or inc (setq inc 1))
436 (when (zerop inc) (error "The increment can not be zero"))
437 (let (seq (n 0) (next from))
440 (setq seq (cons next seq)
442 next (+ from (* n inc))))
444 (setq seq (cons next seq)
446 next (+ from (* n inc)))))
449 (defun copy-tree (tree &optional vecp)
450 "Make a copy of TREE.
451 If TREE is a cons cell, this recursively copies both its car and its cdr.
452 Contrast to `copy-sequence', which copies only along the cdrs. With second
453 argument VECP, this copies vectors as well as conses."
457 (let ((newcar (car tree)))
458 (if (or (consp (car tree)) (and vecp (vectorp (car tree))))
459 (setq newcar (copy-tree (car tree) vecp)))
460 (push newcar result))
461 (setq tree (cdr tree)))
462 (nconc (nreverse result) tree))
463 (if (and vecp (vectorp tree))
464 (let ((i (length (setq tree (copy-sequence tree)))))
465 (while (>= (setq i (1- i)) 0)
466 (aset tree i (copy-tree (aref tree i) vecp)))
470 ;;;; Various list-search functions.
472 (defun assoc-default (key alist &optional test default)
473 "Find object KEY in a pseudo-alist ALIST.
474 ALIST is a list of conses or objects. Each element
475 (or the element's car, if it is a cons) is compared with KEY by
476 calling TEST, with two arguments: (i) the element or its car,
478 If that is non-nil, the element matches; then `assoc-default'
479 returns the element's cdr, if it is a cons, or DEFAULT if the
480 element is not a cons.
482 If no element matches, the value is nil.
483 If TEST is omitted or nil, `equal' is used."
484 (let (found (tail alist) value)
485 (while (and tail (not found))
486 (let ((elt (car tail)))
487 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
488 (setq found t value (if (consp elt) (cdr elt) default))))
489 (setq tail (cdr tail)))
492 (defun assoc-ignore-case (key alist)
493 "Like `assoc', but ignores differences in case and text representation.
494 KEY must be a string. Upper-case and lower-case letters are treated as equal.
495 Unibyte strings are converted to multibyte for comparison."
496 (declare (obsolete assoc-string "22.1"))
497 (assoc-string key alist t))
499 (defun assoc-ignore-representation (key alist)
500 "Like `assoc', but ignores differences in text representation.
501 KEY must be a string.
502 Unibyte strings are converted to multibyte for comparison."
503 (declare (obsolete assoc-string "22.1"))
504 (assoc-string key alist nil))
506 (defun member-ignore-case (elt list)
507 "Like `member', but ignore differences in case and text representation.
508 ELT must be a string. Upper-case and lower-case letters are treated as equal.
509 Unibyte strings are converted to multibyte for comparison.
510 Non-strings in LIST are ignored."
512 (not (and (stringp (car list))
513 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
514 (setq list (cdr list)))
517 (defun assq-delete-all (key alist)
518 "Delete from ALIST all elements whose car is `eq' to KEY.
519 Return the modified alist.
520 Elements of ALIST that are not conses are ignored."
521 (while (and (consp (car alist))
522 (eq (car (car alist)) key))
523 (setq alist (cdr alist)))
524 (let ((tail alist) tail-cdr)
525 (while (setq tail-cdr (cdr tail))
526 (if (and (consp (car tail-cdr))
527 (eq (car (car tail-cdr)) key))
528 (setcdr tail (cdr tail-cdr))
529 (setq tail tail-cdr))))
532 (defun rassq-delete-all (value alist)
533 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
534 Return the modified alist.
535 Elements of ALIST that are not conses are ignored."
536 (while (and (consp (car alist))
537 (eq (cdr (car alist)) value))
538 (setq alist (cdr alist)))
539 (let ((tail alist) tail-cdr)
540 (while (setq tail-cdr (cdr tail))
541 (if (and (consp (car tail-cdr))
542 (eq (cdr (car tail-cdr)) value))
543 (setcdr tail (cdr tail-cdr))
544 (setq tail tail-cdr))))
547 (defun remove (elt seq)
548 "Return a copy of SEQ with all occurrences of ELT removed.
549 SEQ must be a list, vector, or string. The comparison is done with `equal'."
551 ;; If SEQ isn't a list, there's no need to copy SEQ because
552 ;; `delete' will return a new object.
554 (delete elt (copy-sequence seq))))
556 (defun remq (elt list)
557 "Return LIST with all occurrences of ELT removed.
558 The comparison is done with `eq'. Contrary to `delq', this does not use
559 side-effects, and the argument LIST is not modified."
560 (while (and (eq elt (car list)) (setq list (cdr list))))
562 (delq elt (copy-sequence list))
568 "Convert KEYS to the internal Emacs key representation.
569 KEYS should be a string constant in the format used for
570 saving keyboard macros (see `edmacro-mode')."
571 ;; Don't use a defalias, since the `pure' property is only true for
572 ;; the calling convention of `kbd'.
573 (read-kbd-macro keys))
577 "Beep to tell the user this binding is undefined."
580 (message "%s is undefined" (key-description (this-single-command-keys)))
581 (setq defining-kbd-macro nil)
582 (force-mode-line-update)
583 ;; If this is a down-mouse event, don't reset prefix-arg;
584 ;; pass it to the command run by the up event.
586 (when (memq 'down (event-modifiers last-command-event))
587 current-prefix-arg)))
589 ;; Prevent the \{...} documentation construct
590 ;; from mentioning keys that run this command.
591 (put 'undefined 'suppress-keymap t)
593 (defun suppress-keymap (map &optional nodigits)
594 "Make MAP override all normally self-inserting keys to be undefined.
595 Normally, as an exception, digits and minus-sign are set to make prefix args,
596 but optional second arg NODIGITS non-nil treats them like other chars."
597 (define-key map [remap self-insert-command] 'undefined)
600 (define-key map "-" 'negative-argument)
601 ;; Make plain numbers do numeric args.
604 (define-key map (char-to-string loop) 'digit-argument)
605 (setq loop (1+ loop))))))
607 (defun make-composed-keymap (maps &optional parent)
608 "Construct a new keymap composed of MAPS and inheriting from PARENT.
609 When looking up a key in the returned map, the key is looked in each
610 keymap of MAPS in turn until a binding is found.
611 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
612 As always with keymap inheritance, a nil binding in MAPS overrides
613 any corresponding binding in PARENT, but it does not override corresponding
614 bindings in other keymaps of MAPS.
615 MAPS can be a list of keymaps or a single keymap.
616 PARENT if non-nil should be a keymap."
618 ,@(if (keymapp maps) (list maps) maps)
621 (defun define-key-after (keymap key definition &optional after)
622 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
623 This is like `define-key' except that the binding for KEY is placed
624 just after the binding for the event AFTER, instead of at the beginning
625 of the map. Note that AFTER must be an event type (like KEY), NOT a command
628 If AFTER is t or omitted, the new binding goes at the end of the keymap.
629 AFTER should be a single event type--a symbol or a character, not a sequence.
631 Bindings are always added before any inherited map.
633 The order of bindings in a keymap only matters when it is used as
634 a menu, so this function is not useful for non-menu keymaps."
635 (unless after (setq after t))
637 (signal 'wrong-type-argument (list 'keymapp keymap)))
639 (if (<= (length key) 1) (aref key 0)
640 (setq keymap (lookup-key keymap
642 (butlast (mapcar 'identity key)))))
643 (aref key (1- (length key)))))
644 (let ((tail keymap) done inserted)
645 (while (and (not done) tail)
646 ;; Delete any earlier bindings for the same key.
647 (if (eq (car-safe (car (cdr tail))) key)
648 (setcdr tail (cdr (cdr tail))))
649 ;; If we hit an included map, go down that one.
650 (if (keymapp (car tail)) (setq tail (car tail)))
651 ;; When we reach AFTER's binding, insert the new binding after.
652 ;; If we reach an inherited keymap, insert just before that.
653 ;; If we reach the end of this keymap, insert at the end.
654 (if (or (and (eq (car-safe (car tail)) after)
656 (eq (car (cdr tail)) 'keymap)
659 ;; Stop the scan only if we find a parent keymap.
660 ;; Keep going past the inserted element
661 ;; so we can delete any duplications that come later.
662 (if (eq (car (cdr tail)) 'keymap)
664 ;; Don't insert more than once.
666 (setcdr tail (cons (cons key definition) (cdr tail))))
668 (setq tail (cdr tail)))))
670 (defun map-keymap-sorted (function keymap)
671 "Implement `map-keymap' with sorting.
672 Don't call this function; it is for internal use only."
674 (map-keymap (lambda (a b) (push (cons a b) list))
676 (setq list (sort list
678 (setq a (car a) b (car b))
680 (if (integerp b) (< a b)
683 ;; string< also accepts symbols.
686 (funcall function (car p) (cdr p)))))
688 (defun keymap--menu-item-binding (val)
689 "Return the binding part of a menu-item."
691 ((not (consp val)) val) ;Not a menu-item.
692 ((eq 'menu-item (car val))
693 (let* ((binding (nth 2 val))
694 (plist (nthcdr 3 val))
695 (filter (plist-get plist :filter)))
696 (if filter (funcall filter binding)
698 ((and (consp (cdr val)) (stringp (cadr val)))
702 (t val))) ;Not a menu-item either.
704 (defun keymap--menu-item-with-binding (item binding)
705 "Build a menu-item like ITEM but with its binding changed to BINDING."
707 ((not (consp item)) binding) ;Not a menu-item.
708 ((eq 'menu-item (car item))
709 (setq item (copy-sequence item))
710 (let ((tail (nthcdr 2 item)))
711 (setcar tail binding)
712 ;; Remove any potential filter.
713 (if (plist-get (cdr tail) :filter)
714 (setcdr tail (plist-put (cdr tail) :filter nil))))
716 ((and (consp (cdr item)) (stringp (cadr item)))
717 (cons (car item) (cons (cadr item) binding)))
718 (t (cons (car item) binding))))
720 (defun keymap--merge-bindings (val1 val2)
721 "Merge bindings VAL1 and VAL2."
722 (let ((map1 (keymap--menu-item-binding val1))
723 (map2 (keymap--menu-item-binding val2)))
724 (if (not (and (keymapp map1) (keymapp map2)))
725 ;; There's nothing to merge: val1 takes precedence.
727 (let ((map (list 'keymap map1 map2))
728 (item (if (keymapp val1) (if (keymapp val2) nil val2) val1)))
729 (keymap--menu-item-with-binding item map)))))
731 (defun keymap-canonicalize (map)
732 "Return a simpler equivalent keymap.
733 This resolves inheritance and redefinitions. The returned keymap
734 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
735 and use in active keymaps and menus.
736 Subkeymaps may be modified but are not canonicalized."
737 ;; FIXME: Problem with the difference between a nil binding
738 ;; that hides a binding in an inherited map and a nil binding that's ignored
739 ;; to let some further binding visible. Currently a nil binding hides all.
740 ;; FIXME: we may want to carefully (re)order elements in case they're
744 (prompt (keymap-prompt map)))
746 (setq map (map-keymap ;; -internal
749 ;; Treat char-ranges specially.
750 (push (cons key item) ranges)
751 (push (cons key item) bindings)))
753 ;; Create the new map.
754 (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt))
755 (dolist (binding ranges)
756 ;; Treat char-ranges specially. FIXME: need to merge as well.
757 (define-key map (vector (car binding)) (cdr binding)))
758 ;; Process the bindings starting from the end.
759 (dolist (binding (prog1 bindings (setq bindings ())))
760 (let* ((key (car binding))
761 (oldbind (assq key bindings)))
762 (push (if (not oldbind)
763 ;; The normal case: no duplicate bindings.
765 ;; This is the second binding for this key.
766 (setq bindings (delq oldbind bindings))
767 (cons key (keymap--merge-bindings (cdr binding)
770 (nconc map bindings)))
772 (put 'keyboard-translate-table 'char-table-extra-slots 0)
774 (defun keyboard-translate (from to)
775 "Translate character FROM to TO on the current terminal.
776 This function creates a `keyboard-translate-table' if necessary
777 and then modifies one entry in it."
778 (or (char-table-p keyboard-translate-table)
779 (setq keyboard-translate-table
780 (make-char-table 'keyboard-translate-table nil)))
781 (aset keyboard-translate-table from to))
783 ;;;; Key binding commands.
785 (defun global-set-key (key command)
786 "Give KEY a global binding as COMMAND.
787 COMMAND is the command definition to use; usually it is
788 a symbol naming an interactively-callable function.
789 KEY is a key sequence; noninteractively, it is a string or vector
790 of characters or event types, and non-ASCII characters with codes
791 above 127 (such as ISO Latin-1) can be included if you use a vector.
793 Note that if KEY has a local binding in the current buffer,
794 that local binding will continue to shadow any global binding
795 that you make with this function."
796 (interactive "KSet key globally: \nCSet key %s to command: ")
797 (or (vectorp key) (stringp key)
798 (signal 'wrong-type-argument (list 'arrayp key)))
799 (define-key (current-global-map) key command))
801 (defun local-set-key (key command)
802 "Give KEY a local binding as COMMAND.
803 COMMAND is the command definition to use; usually it is
804 a symbol naming an interactively-callable function.
805 KEY is a key sequence; noninteractively, it is a string or vector
806 of characters or event types, and non-ASCII characters with codes
807 above 127 (such as ISO Latin-1) can be included if you use a vector.
809 The binding goes in the current buffer's local map, which in most
810 cases is shared with all other buffers in the same major mode."
811 (interactive "KSet key locally: \nCSet key %s locally to command: ")
812 (let ((map (current-local-map)))
814 (use-local-map (setq map (make-sparse-keymap))))
815 (or (vectorp key) (stringp key)
816 (signal 'wrong-type-argument (list 'arrayp key)))
817 (define-key map key command)))
819 (defun global-unset-key (key)
820 "Remove global binding of KEY.
821 KEY is a string or vector representing a sequence of keystrokes."
822 (interactive "kUnset key globally: ")
823 (global-set-key key nil))
825 (defun local-unset-key (key)
826 "Remove local binding of KEY.
827 KEY is a string or vector representing a sequence of keystrokes."
828 (interactive "kUnset key locally: ")
829 (if (current-local-map)
830 (local-set-key key nil))
833 ;;;; substitute-key-definition and its subroutines.
835 (defvar key-substitution-in-progress nil
836 "Used internally by `substitute-key-definition'.")
838 (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
839 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
840 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
841 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
842 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
844 If you don't specify OLDMAP, you can usually get the same results
845 in a cleaner way with command remapping, like this:
846 (define-key KEYMAP [remap OLDDEF] NEWDEF)
847 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
848 ;; Don't document PREFIX in the doc string because we don't want to
849 ;; advertise it. It's meant for recursive calls only. Here's its
852 ;; If optional argument PREFIX is specified, it should be a key
853 ;; prefix, a string. Redefined bindings will then be bound to the
854 ;; original key, with PREFIX added at the front.
855 (or prefix (setq prefix ""))
856 (let* ((scan (or oldmap keymap))
857 (prefix1 (vconcat prefix [nil]))
858 (key-substitution-in-progress
859 (cons scan key-substitution-in-progress)))
860 ;; Scan OLDMAP, finding each char or event-symbol that
861 ;; has any definition, and act on it with hack-key.
864 (aset prefix1 (length prefix) char)
865 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
868 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
869 (let (inner-def skipped menu-item)
870 ;; Find the actual command name within the binding.
871 (if (eq (car-safe defn) 'menu-item)
872 (setq menu-item defn defn (nth 2 defn))
873 ;; Skip past menu-prompt.
874 (while (stringp (car-safe defn))
875 (push (pop defn) skipped))
876 ;; Skip past cached key-equivalence data for menu items.
877 (if (consp (car-safe defn))
878 (setq defn (cdr defn))))
879 (if (or (eq defn olddef)
880 ;; Compare with equal if definition is a key sequence.
881 ;; That is useful for operating on function-key-map.
882 (and (or (stringp defn) (vectorp defn))
883 (equal defn olddef)))
884 (define-key keymap prefix
886 (let ((copy (copy-sequence menu-item)))
887 (setcar (nthcdr 2 copy) newdef)
889 (nconc (nreverse skipped) newdef)))
890 ;; Look past a symbol that names a keymap.
892 (or (indirect-function defn t) defn))
893 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
894 ;; avoid autoloading a keymap. This is mostly done to preserve the
895 ;; original non-autoloading behavior of pre-map-keymap times.
896 (if (and (keymapp inner-def)
897 ;; Avoid recursively scanning
898 ;; where KEYMAP does not have a submap.
899 (let ((elt (lookup-key keymap prefix)))
900 (or (null elt) (natnump elt) (keymapp elt)))
901 ;; Avoid recursively rescanning keymap being scanned.
902 (not (memq inner-def key-substitution-in-progress)))
903 ;; If this one isn't being scanned already, scan it now.
904 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
907 ;;;; The global keymap tree.
909 ;; global-map, esc-map, and ctl-x-map have their values set up in
910 ;; keymap.c; we just give them docstrings here.
912 (defvar global-map nil
913 "Default global keymap mapping Emacs keyboard input into commands.
914 The value is a keymap which is usually (but not necessarily) Emacs's
918 "Default keymap for ESC (meta) commands.
919 The normal global definition of the character ESC indirects to this keymap.")
921 (defvar ctl-x-map nil
922 "Default keymap for C-x commands.
923 The normal global definition of the character C-x indirects to this keymap.")
925 (defvar ctl-x-4-map (make-sparse-keymap)
926 "Keymap for subcommands of C-x 4.")
927 (defalias 'ctl-x-4-prefix ctl-x-4-map)
928 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
930 (defvar ctl-x-5-map (make-sparse-keymap)
931 "Keymap for frame commands.")
932 (defalias 'ctl-x-5-prefix ctl-x-5-map)
933 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
936 ;;;; Event manipulation functions.
938 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
940 (defun listify-key-sequence (key)
941 "Convert a key sequence to a list of events."
944 (mapcar (function (lambda (c)
946 (logxor c listify-key-sequence-1)
951 "True if the argument is an event object."
954 (and (symbolp obj) obj (not (keywordp obj)))
955 (and (consp obj) (symbolp (car obj))))))
957 (defun event-modifiers (event)
958 "Return a list of symbols representing the modifier keys in event EVENT.
959 The elements of the list may include `meta', `control',
960 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
962 EVENT may be an event or an event type. If EVENT is a symbol
963 that has never been used in an event that has been read as input
964 in the current Emacs session, then this function may fail to include
965 the `click' modifier."
968 (setq type (car type)))
970 ;; Don't read event-symbol-elements directly since we're not
971 ;; sure the symbol has already been parsed.
972 (cdr (internal-event-symbol-parse-modifiers type))
974 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
975 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
976 (if (not (zerop (logand type ?\M-\^@)))
978 (if (or (not (zerop (logand type ?\C-\^@)))
980 (push 'control list))
981 (if (or (not (zerop (logand type ?\S-\^@)))
982 (/= char (downcase char)))
984 (or (zerop (logand type ?\H-\^@))
986 (or (zerop (logand type ?\s-\^@))
988 (or (zerop (logand type ?\A-\^@))
992 (defun event-basic-type (event)
993 "Return the basic type of the given event (all modifiers removed).
994 The value is a printing character (not upper case) or a symbol.
995 EVENT may be an event or an event type. If EVENT is a symbol
996 that has never been used in an event that has been read as input
997 in the current Emacs session, then this function may return nil."
999 (setq event (car event)))
1001 (car (get event 'event-symbol-elements))
1002 (let* ((base (logand event (1- ?\A-\^@)))
1003 (uncontrolled (if (< base 32) (logior base 64) base)))
1004 ;; There are some numbers that are invalid characters and
1005 ;; cause `downcase' to get an error.
1007 (downcase uncontrolled)
1008 (error uncontrolled)))))
1010 (defsubst mouse-movement-p (object)
1011 "Return non-nil if OBJECT is a mouse movement event."
1012 (eq (car-safe object) 'mouse-movement))
1014 (defun mouse-event-p (object)
1015 "Return non-nil if OBJECT is a mouse click event."
1016 ;; is this really correct? maybe remove mouse-movement?
1017 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
1019 (defun event-start (event)
1020 "Return the starting position of EVENT.
1021 EVENT should be a mouse click, drag, or key press event. If
1022 EVENT is nil, the value of `posn-at-point' is used instead.
1024 The following accessor functions are used to access the elements
1027 `posn-window': The window the event is in.
1028 `posn-area': A symbol identifying the area the event occurred in,
1029 or nil if the event occurred in the text area.
1030 `posn-point': The buffer position of the event.
1031 `posn-x-y': The pixel-based coordinates of the event.
1032 `posn-col-row': The estimated column and row corresponding to the
1033 position of the event.
1034 `posn-actual-col-row': The actual column and row corresponding to the
1035 position of the event.
1036 `posn-string': The string object of the event, which is either
1037 nil or (STRING . POSITION)'.
1038 `posn-image': The image object of the event, if any.
1039 `posn-object': The image or string object of the event, if any.
1040 `posn-timestamp': The time the event occurred, in milliseconds.
1042 For more information, see Info node `(elisp)Click Events'."
1043 (if (consp event) (nth 1 event)
1045 (list (selected-window) (point) '(0 . 0) 0))))
1047 (defun event-end (event)
1048 "Return the ending position of EVENT.
1049 EVENT should be a click, drag, or key press event.
1051 See `event-start' for a description of the value returned."
1052 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1054 (list (selected-window) (point) '(0 . 0) 0))))
1056 (defsubst event-click-count (event)
1057 "Return the multi-click count of EVENT, a click or drag event.
1058 The return value is a positive integer."
1059 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1061 ;;;; Extracting fields of the positions in an event.
1064 "Return non-nil if OBJ appears to be a valid `posn' object specifying a window.
1065 If OBJ is a valid `posn' object, but specifies a frame rather
1066 than a window, return nil."
1067 ;; FIXME: Correct the behavior of this function so that all valid
1068 ;; `posn' objects are recognized, after updating other code that
1069 ;; depends on its present behavior.
1070 (and (windowp (car-safe obj))
1071 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1072 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1073 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1075 (defsubst posn-window (position)
1076 "Return the window in POSITION.
1077 POSITION should be a list of the form returned by the `event-start'
1078 and `event-end' functions."
1081 (defsubst posn-area (position)
1082 "Return the window area recorded in POSITION, or nil for the text area.
1083 POSITION should be a list of the form returned by the `event-start'
1084 and `event-end' functions."
1085 (let ((area (if (consp (nth 1 position))
1086 (car (nth 1 position))
1088 (and (symbolp area) area)))
1090 (defun posn-point (position)
1091 "Return the buffer location in POSITION.
1092 POSITION should be a list of the form returned by the `event-start'
1093 and `event-end' functions.
1094 Returns nil if POSITION does not correspond to any buffer location (e.g.
1095 a click on a scroll bar)."
1096 (or (nth 5 position)
1097 (let ((pt (nth 1 position)))
1099 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1100 (if (integerp pt) pt)))))
1102 (defun posn-set-point (position)
1103 "Move point to POSITION.
1104 Select the corresponding window as well."
1105 (if (not (windowp (posn-window position)))
1106 (error "Position not in text area of window"))
1107 (select-window (posn-window position))
1108 (if (numberp (posn-point position))
1109 (goto-char (posn-point position))))
1111 (defsubst posn-x-y (position)
1112 "Return the x and y coordinates in POSITION.
1113 The return value has the form (X . Y), where X and Y are given in
1114 pixels. POSITION should be a list of the form returned by
1115 `event-start' and `event-end'."
1118 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1120 (defun posn-col-row (position)
1121 "Return the nominal column and row in POSITION, measured in characters.
1122 The column and row values are approximations calculated from the x
1123 and y coordinates in POSITION and the frame's default character width
1124 and default line height, including spacing.
1125 For a scroll-bar event, the result column is 0, and the row
1126 corresponds to the vertical position of the click in the scroll bar.
1127 POSITION should be a list of the form returned by the `event-start'
1128 and `event-end' functions."
1129 (let* ((pair (posn-x-y position))
1130 (frame-or-window (posn-window position))
1131 (frame (if (framep frame-or-window)
1133 (window-frame frame-or-window)))
1134 (window (when (windowp frame-or-window) frame-or-window))
1135 (area (posn-area position)))
1137 ((null frame-or-window)
1139 ((eq area 'vertical-scroll-bar)
1140 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1141 ((eq area 'horizontal-scroll-bar)
1142 (cons (scroll-bar-scale pair (window-width window)) 0))
1144 ;; FIXME: This should take line-spacing properties on
1145 ;; newlines into account.
1146 (let* ((spacing (when (display-graphic-p frame)
1147 (or (with-current-buffer
1148 (window-buffer (frame-selected-window frame))
1150 (frame-parameter frame 'line-spacing)))))
1151 (cond ((floatp spacing)
1152 (setq spacing (truncate (* spacing
1153 (frame-char-height frame)))))
1156 (cons (/ (car pair) (frame-char-width frame))
1157 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
1159 (defun posn-actual-col-row (position)
1160 "Return the window row number in POSITION and character number in that row.
1162 Return nil if POSITION does not contain the actual position; in that case
1163 \`posn-col-row' can be used to get approximate values.
1164 POSITION should be a list of the form returned by the `event-start'
1165 and `event-end' functions.
1167 This function does not account for the width on display, like the
1168 number of visual columns taken by a TAB or image. If you need
1169 the coordinates of POSITION in character units, you should use
1170 \`posn-col-row', not this function."
1173 (defsubst posn-timestamp (position)
1174 "Return the timestamp of POSITION.
1175 POSITION should be a list of the form returned by the `event-start'
1176 and `event-end' functions."
1179 (defun posn-string (position)
1180 "Return the string object of POSITION.
1181 Value is a cons (STRING . STRING-POS), or nil if not a string.
1182 POSITION should be a list of the form returned by the `event-start'
1183 and `event-end' functions."
1184 (let ((x (nth 4 position)))
1185 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1186 (when (consp x) x)))
1188 (defsubst posn-image (position)
1189 "Return the image object of POSITION.
1190 Value is a list (image ...), or nil if not an image.
1191 POSITION should be a list of the form returned by the `event-start'
1192 and `event-end' functions."
1195 (defsubst posn-object (position)
1196 "Return the object (image or string) of POSITION.
1197 Value is a list (image ...) for an image object, a cons cell
1198 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1199 POSITION should be a list of the form returned by the `event-start'
1200 and `event-end' functions."
1201 (or (posn-image position) (posn-string position)))
1203 (defsubst posn-object-x-y (position)
1204 "Return the x and y coordinates relative to the object of POSITION.
1205 The return value has the form (DX . DY), where DX and DY are
1206 given in pixels. POSITION should be a list of the form returned
1207 by `event-start' and `event-end'."
1210 (defsubst posn-object-width-height (position)
1211 "Return the pixel width and height of the object of POSITION.
1212 The return value has the form (WIDTH . HEIGHT). POSITION should
1213 be a list of the form returned by `event-start' and `event-end'."
1217 ;;;; Obsolescent names for functions.
1219 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1220 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1221 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1222 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1223 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1224 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1226 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1227 (make-obsolete 'buffer-has-markers-at nil "24.3")
1229 (defun insert-string (&rest args)
1230 "Mocklisp-compatibility insert function.
1231 Like the function `insert' except that any argument that is a number
1232 is converted into a string by expressing it in decimal."
1233 (declare (obsolete insert "22.1"))
1235 (insert (if (integerp el) (number-to-string el) el))))
1237 (defun makehash (&optional test)
1238 (declare (obsolete make-hash-table "22.1"))
1239 (make-hash-table :test (or test 'eql)))
1242 "Return (log X 10), the log base 10 of X."
1243 (declare (obsolete log "24.4"))
1246 ;; These are used by VM and some old programs
1247 (defalias 'focus-frame 'ignore "")
1248 (make-obsolete 'focus-frame "it does nothing." "22.1")
1249 (defalias 'unfocus-frame 'ignore "")
1250 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1251 (make-obsolete 'make-variable-frame-local
1252 "explicitly check for a frame-parameter instead." "22.2")
1253 (set-advertised-calling-convention
1254 'all-completions '(string collection &optional predicate) "23.1")
1255 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1256 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1257 (set-advertised-calling-convention 'decode-char '(ch charset) "21.4")
1258 (set-advertised-calling-convention 'encode-char '(ch charset) "21.4")
1260 ;;;; Obsolescence declarations for variables, and aliases.
1262 ;; Special "default-FOO" variables which contain the default value of
1263 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1264 ;; slows down several unrelated variable operations; furthermore, they
1265 ;; can lead to really odd behavior if you decide to make them
1268 ;; Not used at all in Emacs, last time I checked:
1269 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1270 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1271 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1272 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1273 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1274 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1275 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1276 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1277 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1278 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1279 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1280 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1281 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1282 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1283 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1284 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1285 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1286 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1287 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1288 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1289 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1290 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1291 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1292 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1293 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1294 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1295 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1296 (make-obsolete-variable 'default-enable-multibyte-characters
1297 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1299 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1300 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1301 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1302 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1303 (make-obsolete-variable 'redisplay-dont-pause nil "24.5")
1304 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1305 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1307 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1308 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1310 ;; Lisp manual only updated in 22.1.
1311 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1314 (define-obsolete-variable-alias 'x-lost-selection-hooks
1315 'x-lost-selection-functions "22.1")
1316 (define-obsolete-variable-alias 'x-sent-selection-hooks
1317 'x-sent-selection-functions "22.1")
1319 ;; This was introduced in 21.4 for pre-unicode unification. That
1320 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1321 ;; Other uses are possible, so this variable is not _really_ obsolete,
1322 ;; but Stefan insists to mark it so.
1323 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1325 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1327 ;;;; Alternate names for functions - these are not being phased out.
1329 (defalias 'send-string 'process-send-string)
1330 (defalias 'send-region 'process-send-region)
1331 (defalias 'string= 'string-equal)
1332 (defalias 'string< 'string-lessp)
1333 (defalias 'move-marker 'set-marker)
1334 (defalias 'rplaca 'setcar)
1335 (defalias 'rplacd 'setcdr)
1336 (defalias 'beep 'ding) ;preserve lingual purity
1337 (defalias 'indent-to-column 'indent-to)
1338 (defalias 'backward-delete-char 'delete-backward-char)
1339 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1340 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1341 (defalias 'int-to-string 'number-to-string)
1342 (defalias 'store-match-data 'set-match-data)
1343 (defalias 'chmod 'set-file-modes)
1344 (defalias 'mkdir 'make-directory)
1345 ;; These are the XEmacs names:
1346 (defalias 'point-at-eol 'line-end-position)
1347 (defalias 'point-at-bol 'line-beginning-position)
1349 (defalias 'user-original-login-name 'user-login-name)
1352 ;;;; Hook manipulation functions.
1354 (defun add-hook (hook function &optional append local)
1355 "Add to the value of HOOK the function FUNCTION.
1356 FUNCTION is not added if already present.
1357 FUNCTION is added (if necessary) at the beginning of the hook list
1358 unless the optional argument APPEND is non-nil, in which case
1359 FUNCTION is added at the end.
1361 The optional fourth argument, LOCAL, if non-nil, says to modify
1362 the hook's buffer-local value rather than its global value.
1363 This makes the hook buffer-local, and it makes t a member of the
1364 buffer-local value. That acts as a flag to run the hook
1365 functions of the global value as well as in the local value.
1367 HOOK should be a symbol, and FUNCTION may be any valid function. If
1368 HOOK is void, it is first set to nil. If HOOK's value is a single
1369 function, it is changed to a list of functions."
1370 (or (boundp hook) (set hook nil))
1371 (or (default-boundp hook) (set-default hook nil))
1372 (if local (unless (local-variable-if-set-p hook)
1373 (set (make-local-variable hook) (list t)))
1374 ;; Detect the case where make-local-variable was used on a hook
1375 ;; and do what we used to do.
1376 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1378 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1379 ;; If the hook value is a single function, turn it into a list.
1380 (when (or (not (listp hook-value)) (functionp hook-value))
1381 (setq hook-value (list hook-value)))
1382 ;; Do the actual addition if necessary
1383 (unless (member function hook-value)
1384 (when (stringp function)
1385 (setq function (purecopy function)))
1388 (append hook-value (list function))
1389 (cons function hook-value))))
1390 ;; Set the actual variable
1393 ;; If HOOK isn't a permanent local,
1394 ;; but FUNCTION wants to survive a change of modes,
1395 ;; mark HOOK as partially permanent.
1396 (and (symbolp function)
1397 (get function 'permanent-local-hook)
1398 (not (get hook 'permanent-local))
1399 (put hook 'permanent-local 'permanent-local-hook))
1400 (set hook hook-value))
1401 (set-default hook hook-value))))
1403 (defun remove-hook (hook function &optional local)
1404 "Remove from the value of HOOK the function FUNCTION.
1405 HOOK should be a symbol, and FUNCTION may be any valid function. If
1406 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1407 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1409 The optional third argument, LOCAL, if non-nil, says to modify
1410 the hook's buffer-local value rather than its default value."
1411 (or (boundp hook) (set hook nil))
1412 (or (default-boundp hook) (set-default hook nil))
1413 ;; Do nothing if LOCAL is t but this hook has no local binding.
1414 (unless (and local (not (local-variable-p hook)))
1415 ;; Detect the case where make-local-variable was used on a hook
1416 ;; and do what we used to do.
1417 (when (and (local-variable-p hook)
1418 (not (and (consp (symbol-value hook))
1419 (memq t (symbol-value hook)))))
1421 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1422 ;; Remove the function, for both the list and the non-list cases.
1423 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1424 (if (equal hook-value function) (setq hook-value nil))
1425 (setq hook-value (delete function (copy-sequence hook-value))))
1426 ;; If the function is on the global hook, we need to shadow it locally
1427 ;;(when (and local (member function (default-value hook))
1428 ;; (not (member (cons 'not function) hook-value)))
1429 ;; (push (cons 'not function) hook-value))
1430 ;; Set the actual variable
1432 (set-default hook hook-value)
1433 (if (equal hook-value '(t))
1434 (kill-local-variable hook)
1435 (set hook hook-value))))))
1437 (defmacro letrec (binders &rest body)
1438 "Bind variables according to BINDERS then eval BODY.
1439 The value of the last form in BODY is returned.
1440 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1441 SYMBOL to the value of VALUEFORM.
1442 All symbols are bound before the VALUEFORMs are evalled."
1443 ;; Only useful in lexical-binding mode.
1444 ;; As a special-form, we could implement it more efficiently (and cleanly,
1445 ;; making the vars actually unbound during evaluation of the binders).
1446 (declare (debug let) (indent 1))
1447 `(let ,(mapcar #'car binders)
1448 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1451 (defmacro with-wrapper-hook (hook args &rest body)
1452 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1453 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1454 around the preceding ones, like a set of nested `around' advices.
1456 Each hook function should accept an argument list consisting of a
1457 function FUN, followed by the additional arguments in ARGS.
1459 The first hook function in HOOK is passed a FUN that, if it is called
1460 with arguments ARGS, performs BODY (i.e., the default operation).
1461 The FUN passed to each successive hook function is defined based
1462 on the preceding hook functions; if called with arguments ARGS,
1463 it does what the `with-wrapper-hook' call would do if the
1464 preceding hook functions were the only ones present in HOOK.
1466 Each hook function may call its FUN argument as many times as it wishes,
1467 including never. In that case, such a hook function acts to replace
1468 the default definition altogether, and any preceding hook functions.
1469 Of course, a subsequent hook function may do the same thing.
1471 Each hook function definition is used to construct the FUN passed
1472 to the next hook function, if any. The last (or \"outermost\")
1473 FUN is then called once."
1474 (declare (indent 2) (debug (form sexp body))
1475 (obsolete "use a <foo>-function variable modified by `add-function'."
1477 ;; We need those two gensyms because CL's lexical scoping is not available
1478 ;; for function arguments :-(
1479 (let ((funs (make-symbol "funs"))
1480 (global (make-symbol "global"))
1481 (argssym (make-symbol "args"))
1482 (runrestofhook (make-symbol "runrestofhook")))
1483 ;; Since the hook is a wrapper, the loop has to be done via
1484 ;; recursion: a given hook function will call its parameter in order to
1485 ;; continue looping.
1486 `(letrec ((,runrestofhook
1487 (lambda (,funs ,global ,argssym)
1488 ;; `funs' holds the functions left on the hook and `global'
1489 ;; holds the functions left on the global part of the hook
1490 ;; (in case the hook is local).
1492 (if (eq t (car ,funs))
1493 (funcall ,runrestofhook
1494 (append ,global (cdr ,funs)) nil ,argssym)
1497 (lambda (,funs ,global &rest ,argssym)
1498 (funcall ,runrestofhook ,funs ,global ,argssym))
1499 (cdr ,funs) ,global)
1501 ;; Once there are no more functions on the hook, run
1502 ;; the original body.
1503 (apply (lambda ,args ,@body) ,argssym)))))
1504 (funcall ,runrestofhook ,hook
1505 ;; The global part of the hook, if any.
1507 `(if (local-variable-p ',hook)
1508 (default-value ',hook)))
1511 (defun add-to-list (list-var element &optional append compare-fn)
1512 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1513 The test for presence of ELEMENT is done with `equal', or with
1514 COMPARE-FN if that's non-nil.
1515 If ELEMENT is added, it is added at the beginning of the list,
1516 unless the optional argument APPEND is non-nil, in which case
1517 ELEMENT is added at the end.
1519 The return value is the new value of LIST-VAR.
1521 This is handy to add some elements to configuration variables,
1522 but please do not abuse it in Elisp code, where you are usually
1523 better off using `push' or `cl-pushnew'.
1525 If you want to use `add-to-list' on a variable that is not
1526 defined until a certain package is loaded, you should put the
1527 call to `add-to-list' into a hook function that will be run only
1528 after loading the package. `eval-after-load' provides one way to
1529 do this. In some cases other hooks, such as major mode hooks,
1534 ;; FIXME: Something like this could be used for `set' as well.
1535 (if (or (not (eq 'quote (car-safe list-var)))
1536 (special-variable-p (cadr list-var))
1537 (not (macroexp-const-p append)))
1539 (let* ((sym (cadr list-var))
1540 (append (eval append))
1541 (msg (format "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1543 ;; Big ugly hack so we only output a warning during
1544 ;; byte-compilation, and so we can use
1545 ;; byte-compile-not-lexical-var-p to silence the warning
1546 ;; when a defvar has been seen but not yet executed.
1548 ;; FIXME: We should also emit a warning for let-bound
1549 ;; variables with dynamic binding.
1550 (when (assq sym byte-compile--lexical-environment)
1551 (byte-compile-log-warning msg t :error))))
1553 (macroexp-let2 macroexp-copyable-p x element
1554 `(if ,(if compare-fn
1557 `(cl-member ,x ,sym :test ,compare-fn))
1558 ;; For bootstrapping reasons, don't rely on
1559 ;; cl--compiler-macro-member for the base case.
1563 `(setq ,sym (append ,sym (list ,x)))
1564 `(push ,x ,sym))))))
1565 (if (not (macroexp--compiling-p))
1568 (macroexp--funcall-if-compiled ',warnfun)
1572 (member element (symbol-value list-var)))
1573 ((eq compare-fn 'eq)
1574 (memq element (symbol-value list-var)))
1575 ((eq compare-fn 'eql)
1576 (memql element (symbol-value list-var)))
1578 (let ((lst (symbol-value list-var)))
1580 (not (funcall compare-fn element (car lst))))
1581 (setq lst (cdr lst)))
1583 (symbol-value list-var)
1586 (append (symbol-value list-var) (list element))
1587 (cons element (symbol-value list-var))))))
1590 (defun add-to-ordered-list (list-var element &optional order)
1591 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1592 The test for presence of ELEMENT is done with `eq'.
1594 The resulting list is reordered so that the elements are in the
1595 order given by each element's numeric list order. Elements
1596 without a numeric list order are placed at the end of the list.
1598 If the third optional argument ORDER is a number (integer or
1599 float), set the element's list order to the given value. If
1600 ORDER is nil or omitted, do not change the numeric order of
1601 ELEMENT. If ORDER has any other value, remove the numeric order
1602 of ELEMENT if it has one.
1604 The list order for each element is stored in LIST-VAR's
1605 `list-order' property.
1607 The return value is the new value of LIST-VAR."
1608 (let ((ordering (get list-var 'list-order)))
1610 (put list-var 'list-order
1611 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1613 (puthash element (and (numberp order) order) ordering))
1614 (unless (memq element (symbol-value list-var))
1615 (set list-var (cons element (symbol-value list-var))))
1616 (set list-var (sort (symbol-value list-var)
1618 (let ((oa (gethash a ordering))
1619 (ob (gethash b ordering)))
1624 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1625 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1626 Return the new history list.
1627 If MAXELT is non-nil, it specifies the maximum length of the history.
1628 Otherwise, the maximum history length is the value of the `history-length'
1629 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1631 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1632 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1633 if it is empty or a duplicate."
1635 (setq maxelt (or (get history-var 'history-length)
1637 (let ((history (symbol-value history-var))
1639 (when (and (listp history)
1641 (not (stringp newelt))
1642 (> (length newelt) 0))
1644 (not (equal (car history) newelt))))
1645 (if history-delete-duplicates
1646 (setq history (delete newelt history)))
1647 (setq history (cons newelt history))
1648 (when (integerp maxelt)
1651 (setq tail (nthcdr (1- maxelt) history))
1653 (setcdr tail nil)))))
1654 (set history-var history)))
1659 (defvar delay-mode-hooks nil
1660 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1661 (defvar delayed-mode-hooks nil
1662 "List of delayed mode hooks waiting to be run.")
1663 (make-variable-buffer-local 'delayed-mode-hooks)
1664 (put 'delay-mode-hooks 'permanent-local t)
1666 (defvar change-major-mode-after-body-hook nil
1667 "Normal hook run in major mode functions, before the mode hooks.")
1669 (defvar after-change-major-mode-hook nil
1670 "Normal hook run at the very end of major mode functions.")
1672 (defun run-mode-hooks (&rest hooks)
1673 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1674 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1675 just adds the HOOKS to the list `delayed-mode-hooks'.
1676 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1677 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1678 `after-change-major-mode-hook'. Major mode functions should use
1679 this instead of `run-hooks' when running their FOO-mode-hook."
1680 (if delay-mode-hooks
1682 (dolist (hook hooks)
1683 (push hook delayed-mode-hooks))
1684 ;; Normal case, just run the hook as before plus any delayed hooks.
1685 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1686 (setq delayed-mode-hooks nil)
1687 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1688 (run-hooks 'after-change-major-mode-hook)))
1690 (defmacro delay-mode-hooks (&rest body)
1691 "Execute BODY, but delay any `run-mode-hooks'.
1692 These hooks will be executed by the first following call to
1693 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1694 Only affects hooks run in the current buffer."
1695 (declare (debug t) (indent 0))
1697 (make-local-variable 'delay-mode-hooks)
1698 (let ((delay-mode-hooks t))
1701 ;; PUBLIC: find if the current mode derives from another.
1703 (defun derived-mode-p (&rest modes)
1704 "Non-nil if the current major mode is derived from one of MODES.
1705 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1706 (let ((parent major-mode))
1707 (while (and (not (memq parent modes))
1708 (setq parent (get parent 'derived-mode-parent))))
1713 ;; If a minor mode is not defined with define-minor-mode,
1714 ;; add it here explicitly.
1715 ;; isearch-mode is deliberately excluded, since you should
1716 ;; not call it yourself.
1717 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1718 overwrite-mode view-mode
1720 "List of all minor mode functions.")
1722 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1723 "Register a new minor mode.
1725 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1727 TOGGLE is a symbol which is the name of a buffer-local variable that
1728 is toggled on or off to say whether the minor mode is active or not.
1730 NAME specifies what will appear in the mode line when the minor mode
1731 is active. NAME should be either a string starting with a space, or a
1732 symbol whose value is such a string.
1734 Optional KEYMAP is the keymap for the minor mode that will be added
1735 to `minor-mode-map-alist'.
1737 Optional AFTER specifies that TOGGLE should be added after AFTER
1738 in `minor-mode-alist'.
1740 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1741 It defaults to (and should by convention be) TOGGLE.
1743 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1744 included in the mode-line minor mode menu.
1745 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1746 (unless (memq toggle minor-mode-list)
1747 (push toggle minor-mode-list))
1749 (unless toggle-fun (setq toggle-fun toggle))
1750 (unless (eq toggle-fun toggle)
1751 (put toggle :minor-mode-function toggle-fun))
1752 ;; Add the name to the minor-mode-alist.
1754 (let ((existing (assq toggle minor-mode-alist)))
1756 (setcdr existing (list name))
1757 (let ((tail minor-mode-alist) found)
1758 (while (and tail (not found))
1759 (if (eq after (caar tail))
1761 (setq tail (cdr tail))))
1763 (let ((rest (cdr found)))
1765 (nconc found (list (list toggle name)) rest))
1766 (push (list toggle name) minor-mode-alist))))))
1767 ;; Add the toggle to the minor-modes menu if requested.
1768 (when (get toggle :included)
1769 (define-key mode-line-mode-menu
1773 (or (get toggle :menu-tag)
1774 (if (stringp name) name (symbol-name toggle)))
1775 (let ((mode-name (if (symbolp name) (symbol-value name))))
1776 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1777 (concat " (" (match-string 0 mode-name) ")"))))
1779 :button (cons :toggle toggle))))
1781 ;; Add the map to the minor-mode-map-alist.
1783 (let ((existing (assq toggle minor-mode-map-alist)))
1785 (setcdr existing keymap)
1786 (let ((tail minor-mode-map-alist) found)
1787 (while (and tail (not found))
1788 (if (eq after (caar tail))
1790 (setq tail (cdr tail))))
1792 (let ((rest (cdr found)))
1794 (nconc found (list (cons toggle keymap)) rest))
1795 (push (cons toggle keymap) minor-mode-map-alist)))))))
1799 (defsubst autoloadp (object)
1800 "Non-nil if OBJECT is an autoload."
1801 (eq 'autoload (car-safe object)))
1803 ;; (defun autoload-type (object)
1804 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1805 ;; OBJECT should be an autoload object."
1806 ;; (when (autoloadp object)
1807 ;; (let ((type (nth 3 object)))
1808 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1809 ;; ((eq 'keymap t) 'macro)
1812 ;; (defalias 'autoload-file #'cadr
1813 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1814 ;; \n\(fn AUTOLOAD)")
1816 (defun symbol-file (symbol &optional type)
1817 "Return the name of the file that defined SYMBOL.
1818 The value is normally an absolute file name. It can also be nil,
1819 if the definition is not associated with any file. If SYMBOL
1820 specifies an autoloaded function, the value can be a relative
1821 file name without extension.
1823 If TYPE is nil, then any kind of definition is acceptable. If
1824 TYPE is `defun', `defvar', or `defface', that specifies function
1825 definition, variable definition, or face definition only."
1826 (if (and (or (null type) (eq type 'defun))
1828 (autoloadp (symbol-function symbol)))
1829 (nth 1 (symbol-function symbol))
1830 (let ((files load-history)
1834 (if (eq type 'defvar)
1835 ;; Variables are present just as their names.
1836 (member symbol (cdr (car files)))
1837 ;; Other types are represented as (TYPE . NAME).
1838 (member (cons type symbol) (cdr (car files))))
1839 ;; We accept all types, so look for variable def
1840 ;; and then for any other kind.
1841 (or (member symbol (cdr (car files)))
1842 (rassq symbol (cdr (car files)))))
1843 (setq file (car (car files)) files nil))
1844 (setq files (cdr files)))
1847 (defun locate-library (library &optional nosuffix path interactive-call)
1848 "Show the precise file name of Emacs library LIBRARY.
1849 LIBRARY should be a relative file name of the library, a string.
1850 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1851 nil (which is the default, see below).
1852 This command searches the directories in `load-path' like `\\[load-library]'
1853 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1854 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1855 to the specified name LIBRARY.
1857 If the optional third arg PATH is specified, that list of directories
1858 is used instead of `load-path'.
1860 When called from a program, the file name is normally returned as a
1861 string. When run interactively, the argument INTERACTIVE-CALL is t,
1862 and the file name is displayed in the echo area."
1863 (interactive (list (completing-read "Locate library: "
1865 'locate-file-completion-table
1866 load-path (get-load-suffixes)))
1869 (let ((file (locate-file library
1871 (append (unless nosuffix (get-load-suffixes))
1872 load-file-rep-suffixes))))
1873 (if interactive-call
1875 (message "Library is file %s" (abbreviate-file-name file))
1876 (message "No library %s in search path" library)))
1882 (defun process-lines (program &rest args)
1883 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1884 Signal an error if the program returns with a non-zero exit status."
1886 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1887 (unless (eq status 0)
1888 (error "%s exited with status %s" program status))
1889 (goto-char (point-min))
1892 (setq lines (cons (buffer-substring-no-properties
1893 (line-beginning-position)
1894 (line-end-position))
1897 (nreverse lines)))))
1899 (defun process-live-p (process)
1900 "Returns non-nil if PROCESS is alive.
1901 A process is considered alive if its status is `run', `open',
1902 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
1904 (and (processp process)
1905 (memq (process-status process)
1906 '(run open listen connect stop))))
1911 'process-kill-without-query
1912 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1914 (defun process-kill-without-query (process &optional _flag)
1915 "Say no query needed if PROCESS is running when Emacs is exited.
1916 Optional second argument if non-nil says to require a query.
1917 Value is t if a query was formerly required."
1918 (let ((old (process-query-on-exit-flag process)))
1919 (set-process-query-on-exit-flag process nil)
1922 (defun process-kill-buffer-query-function ()
1923 "Ask before killing a buffer that has a running process."
1924 (let ((process (get-buffer-process (current-buffer))))
1926 (not (memq (process-status process) '(run stop open listen)))
1927 (not (process-query-on-exit-flag process))
1929 (format "Buffer %S has a running process; kill it? "
1930 (buffer-name (current-buffer)))))))
1932 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1934 ;; process plist management
1936 (defun process-get (process propname)
1937 "Return the value of PROCESS' PROPNAME property.
1938 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1939 (plist-get (process-plist process) propname))
1941 (defun process-put (process propname value)
1942 "Change PROCESS' PROPNAME property to VALUE.
1943 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1944 (set-process-plist process
1945 (plist-put (process-plist process) propname value)))
1948 ;;;; Input and display facilities.
1950 (defconst read-key-empty-map (make-sparse-keymap))
1952 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
1954 (defun read-key (&optional prompt)
1955 "Read a key from the keyboard.
1956 Contrary to `read-event' this will not return a raw event but instead will
1957 obey the input decoding and translations usually done by `read-key-sequence'.
1958 So escape sequences and keyboard encoding are taken into account.
1959 When there's an ambiguity because the key looks like the prefix of
1960 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1961 ;; This overriding-terminal-local-map binding also happens to
1962 ;; disable quail's input methods, so although read-key-sequence
1963 ;; always inherits the input method, in practice read-key does not
1964 ;; inherit the input method (at least not if it's based on quail).
1965 (let ((overriding-terminal-local-map nil)
1966 (overriding-local-map read-key-empty-map)
1968 (old-global-map (current-global-map))
1969 (timer (run-with-idle-timer
1970 ;; Wait long enough that Emacs has the time to receive and
1971 ;; process all the raw events associated with the single-key.
1972 ;; But don't wait too long, or the user may find the delay
1973 ;; annoying (or keep hitting more keys which may then get
1974 ;; lost or misinterpreted).
1975 ;; This is only relevant for keys which Emacs perceives as
1976 ;; "prefixes", such as C-x (because of the C-x 8 map in
1977 ;; key-translate-table and the C-x @ map in function-key-map)
1978 ;; or ESC (because of terminal escape sequences in
1979 ;; input-decode-map).
1982 (let ((keys (this-command-keys-vector)))
1983 (unless (zerop (length keys))
1984 ;; `keys' is non-empty, so the user has hit at least
1985 ;; one key; there's no point waiting any longer, even
1986 ;; though read-key-sequence thinks we should wait
1987 ;; for more input to decide how to interpret the
1989 (throw 'read-key keys)))))))
1993 (let ((map (make-sparse-keymap)))
1994 ;; Don't hide the menu-bar and tool-bar entries.
1995 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
1996 (define-key map [tool-bar]
1997 ;; This hack avoids evaluating the :filter (Bug#9922).
1998 (or (cdr (assq 'tool-bar global-map))
1999 (lookup-key global-map [tool-bar])))
2001 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
2002 (cancel-timer timer)
2003 (use-global-map old-global-map))))
2005 (defvar read-passwd-map
2006 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2007 ;; minibuffer-local-map along the way!
2008 (let ((map (make-sparse-keymap)))
2009 (set-keymap-parent map minibuffer-local-map)
2010 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2012 "Keymap used while reading passwords.")
2014 (defun read-passwd (prompt &optional confirm default)
2015 "Read a password, prompting with PROMPT, and return it.
2016 If optional CONFIRM is non-nil, read the password twice to make sure.
2017 Optional DEFAULT is a default password to use instead of empty input.
2019 This function echoes `.' for each character that the user types.
2020 Note that in batch mode, the input is not hidden!
2022 Once the caller uses the password, it can erase the password
2023 by doing (clear-string STRING)."
2026 (while (not success)
2027 (let ((first (read-passwd prompt nil default))
2028 (second (read-passwd "Confirm password: " nil default)))
2029 (if (equal first second)
2031 (and (arrayp second) (clear-string second))
2032 (setq success first))
2033 (and (arrayp first) (clear-string first))
2034 (and (arrayp second) (clear-string second))
2035 (message "Password not repeated accurately; please start over")
2038 (let ((hide-chars-fun
2039 (lambda (beg end _len)
2040 (clear-this-command-keys)
2041 (setq beg (min end (max (minibuffer-prompt-end)
2043 (dotimes (i (- end beg))
2044 (put-text-property (+ i beg) (+ 1 i beg)
2045 'display (string ?.)))))
2047 (minibuffer-with-setup-hook
2049 (setq minibuf (current-buffer))
2050 ;; Turn off electricity.
2051 (setq-local post-self-insert-hook nil)
2052 (setq-local buffer-undo-list t)
2053 (setq-local select-active-regions nil)
2054 (use-local-map read-passwd-map)
2055 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2056 (setq-local show-paren-mode nil) ;bug#16091.
2057 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2059 (let ((enable-recursive-minibuffers t))
2062 (format "%s[INPUT WILL NOT BE HIDDEN!] " prompt) ; bug#17839
2064 nil t default)) ; t = "no history"
2065 (when (buffer-live-p minibuf)
2066 (with-current-buffer minibuf
2067 ;; Not sure why but it seems that there might be cases where the
2068 ;; minibuffer is not always properly reset later on, so undo
2069 ;; whatever we've done here (bug#11392).
2070 (remove-hook 'after-change-functions hide-chars-fun 'local)
2071 (kill-local-variable 'post-self-insert-hook)
2072 ;; And of course, don't keep the sensitive data around.
2073 (erase-buffer))))))))
2075 (defun read-number (prompt &optional default)
2076 "Read a numeric value in the minibuffer, prompting with PROMPT.
2077 DEFAULT specifies a default value to return if the user just types RET.
2078 The value of DEFAULT is inserted into PROMPT.
2079 This function is used by the `interactive' code letter `n'."
2081 (default1 (if (consp default) (car default) default)))
2084 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2085 (replace-match (format " (default %s)" default1) t t prompt 1)
2086 (replace-regexp-in-string "[ \t]*\\'"
2087 (format " (default %s) " default1)
2091 (let ((str (read-from-minibuffer
2092 prompt nil nil nil nil
2095 (mapcar 'number-to-string (delq nil default))
2096 (number-to-string default))))))
2099 ((zerop (length str)) default1)
2100 ((stringp str) (read str))))
2103 (message "Please enter a number.")
2108 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2109 "Read and return one of CHARS, prompting for PROMPT.
2110 Any input that is not one of CHARS is ignored.
2112 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2113 keyboard-quit events while waiting for a valid input."
2114 (unless (consp chars)
2115 (error "Called `read-char-choice' without valid char choices"))
2116 (let (char done show-help (helpbuf " *Char Help*"))
2117 (let ((cursor-in-echo-area t)
2118 (executing-kbd-macro executing-kbd-macro)
2120 (save-window-excursion ; in case we call help-form-show
2122 (unless (get-text-property 0 'face prompt)
2123 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2124 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2126 (and show-help (buffer-live-p (get-buffer helpbuf))
2127 (kill-buffer helpbuf))
2129 ((not (numberp char)))
2130 ;; If caller has set help-form, that's enough.
2131 ;; They don't explicitly have to add help-char to chars.
2138 ((and executing-kbd-macro (= char -1))
2139 ;; read-event returns -1 if we are in a kbd macro and
2140 ;; there are no more events in the macro. Attempt to
2141 ;; get an event interactively.
2142 (setq executing-kbd-macro nil))
2143 ((not inhibit-keyboard-quit)
2145 ((and (null esc-flag) (eq char ?\e))
2147 ((memq char '(?\C-g ?\e))
2148 (keyboard-quit))))))))
2149 ;; Display the question with the answer. But without cursor-in-echo-area.
2150 (message "%s%s" prompt (char-to-string char))
2153 (defun sit-for (seconds &optional nodisp obsolete)
2154 "Redisplay, then wait for SECONDS seconds. Stop when input is available.
2155 SECONDS may be a floating-point value.
2156 \(On operating systems that do not support waiting for fractions of a
2157 second, floating-point values are rounded down to the nearest integer.)
2159 If optional arg NODISP is t, don't redisplay, just wait for input.
2160 Redisplay does not happen if input is available before it starts.
2162 Value is t if waited the full time with no input arriving, and nil otherwise.
2164 An obsolete, but still supported form is
2165 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2166 where the optional arg MILLISECONDS specifies an additional wait period,
2167 in milliseconds; this was useful when Emacs was built without
2168 floating point support."
2169 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2170 ;; This used to be implemented in C until the following discussion:
2171 ;; http://lists.gnu.org/archive/html/emacs-devel/2006-07/msg00401.html
2172 ;; Then it was moved here using an implementation based on an idle timer,
2173 ;; which was then replaced by the use of read-event.
2174 (if (numberp nodisp)
2175 (setq seconds (+ seconds (* 1e-3 nodisp))
2177 (if obsolete (setq nodisp obsolete)))
2182 ((input-pending-p t)
2185 (or nodisp (redisplay)))
2187 (or nodisp (redisplay))
2188 ;; FIXME: we should not read-event here at all, because it's much too
2189 ;; difficult to reliably "undo" a read-event by pushing it onto
2190 ;; unread-command-events.
2191 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2192 ;; decoding (hence non-nil as second arg under POSIX ttys).
2193 ;; For bug#15614, we need read-event not to inherit-input-method.
2194 ;; So we temporarily suspend input-method-function.
2195 (let ((read (let ((input-method-function nil))
2196 (read-event nil t seconds))))
2199 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2200 ;; unread-command-events as (t . EVENT) so it will be added to
2201 ;; this-command-keys by read-key-sequence.
2202 (if (eq overriding-terminal-local-map universal-argument-map)
2203 (setq read (cons t read)))
2204 (push read unread-command-events)
2207 ;; Behind display-popup-menus-p test.
2208 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2210 (defun y-or-n-p (prompt)
2211 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2212 PROMPT is the string to display to ask the question. It should
2213 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2215 No confirmation of the answer is requested; a single character is
2216 enough. SPC also means yes, and DEL means no.
2218 To be precise, this function translates user input into responses
2219 by consulting the bindings in `query-replace-map'; see the
2220 documentation of that variable for more information. In this
2221 case, the useful bindings are `act', `skip', `recenter',
2222 `scroll-up', `scroll-down', and `quit'.
2223 An `act' response means yes, and a `skip' response means no.
2224 A `quit' response means to invoke `keyboard-quit'.
2225 If the user enters `recenter', `scroll-up', or `scroll-down'
2226 responses, perform the requested window recentering or scrolling
2229 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2230 is nil and `use-dialog-box' is non-nil."
2231 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2232 ;; where all the keys were unbound (i.e. it somehow got triggered
2233 ;; within read-key, apparently). I had to kill it.
2234 (let ((answer 'recenter)
2235 (padded (lambda (prompt &optional dialog)
2236 (let ((l (length prompt)))
2238 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2240 (if dialog "" "(y or n) "))))))
2243 (setq prompt (funcall padded prompt))
2244 (let ((temp-prompt prompt))
2245 (while (not (memq answer '(act skip)))
2246 (let ((str (read-string temp-prompt)))
2247 (cond ((member str '("y" "Y")) (setq answer 'act))
2248 ((member str '("n" "N")) (setq answer 'skip))
2249 (t (setq temp-prompt (concat "Please answer y or n. "
2251 ((and (display-popup-menus-p)
2252 (listp last-nonmenu-event)
2254 (setq prompt (funcall padded prompt t)
2255 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2257 (setq prompt (funcall padded prompt))
2259 (let* ((scroll-actions '(recenter scroll-up scroll-down
2260 scroll-other-window scroll-other-window-down))
2262 (let ((cursor-in-echo-area t))
2263 (when minibuffer-auto-raise
2264 (raise-frame (window-frame (minibuffer-window))))
2265 (read-key (propertize (if (memq answer scroll-actions)
2267 (concat "Please answer y or n. "
2269 'face 'minibuffer-prompt)))))
2270 (setq answer (lookup-key query-replace-map (vector key) t))
2272 ((memq answer '(skip act)) nil)
2273 ((eq answer 'recenter)
2275 ((eq answer 'scroll-up)
2276 (ignore-errors (scroll-up-command)) t)
2277 ((eq answer 'scroll-down)
2278 (ignore-errors (scroll-down-command)) t)
2279 ((eq answer 'scroll-other-window)
2280 (ignore-errors (scroll-other-window)) t)
2281 ((eq answer 'scroll-other-window-down)
2282 (ignore-errors (scroll-other-window-down)) t)
2283 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2284 (signal 'quit nil) t)
2288 (let ((ret (eq answer 'act)))
2289 (unless noninteractive
2290 (message "%s%c" prompt (if ret ?y ?n)))
2294 ;;; Atomic change groups.
2296 (defmacro atomic-change-group (&rest body)
2297 "Perform BODY as an atomic change group.
2298 This means that if BODY exits abnormally,
2299 all of its changes to the current buffer are undone.
2300 This works regardless of whether undo is enabled in the buffer.
2302 This mechanism is transparent to ordinary use of undo;
2303 if undo is enabled in the buffer and BODY succeeds, the
2304 user can undo the change normally."
2305 (declare (indent 0) (debug t))
2306 (let ((handle (make-symbol "--change-group-handle--"))
2307 (success (make-symbol "--change-group-success--")))
2308 `(let ((,handle (prepare-change-group))
2309 ;; Don't truncate any undo data in the middle of this.
2310 (undo-outer-limit nil)
2311 (undo-limit most-positive-fixnum)
2312 (undo-strong-limit most-positive-fixnum)
2316 ;; This is inside the unwind-protect because
2317 ;; it enables undo if that was disabled; we need
2318 ;; to make sure that it gets disabled again.
2319 (activate-change-group ,handle)
2322 ;; Either of these functions will disable undo
2323 ;; if it was disabled before.
2325 (accept-change-group ,handle)
2326 (cancel-change-group ,handle))))))
2328 (defun prepare-change-group (&optional buffer)
2329 "Return a handle for the current buffer's state, for a change group.
2330 If you specify BUFFER, make a handle for BUFFER's state instead.
2332 Pass the handle to `activate-change-group' afterward to initiate
2333 the actual changes of the change group.
2335 To finish the change group, call either `accept-change-group' or
2336 `cancel-change-group' passing the same handle as argument. Call
2337 `accept-change-group' to accept the changes in the group as final;
2338 call `cancel-change-group' to undo them all. You should use
2339 `unwind-protect' to make sure the group is always finished. The call
2340 to `activate-change-group' should be inside the `unwind-protect'.
2341 Once you finish the group, don't use the handle again--don't try to
2342 finish the same group twice. For a simple example of correct use, see
2343 the source code of `atomic-change-group'.
2345 The handle records only the specified buffer. To make a multibuffer
2346 change group, call this function once for each buffer you want to
2347 cover, then use `nconc' to combine the returned values, like this:
2349 (nconc (prepare-change-group buffer-1)
2350 (prepare-change-group buffer-2))
2352 You can then activate that multibuffer change group with a single
2353 call to `activate-change-group' and finish it with a single call
2354 to `accept-change-group' or `cancel-change-group'."
2357 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2358 (list (cons (current-buffer) buffer-undo-list))))
2360 (defun activate-change-group (handle)
2361 "Activate a change group made with `prepare-change-group' (which see)."
2362 (dolist (elt handle)
2363 (with-current-buffer (car elt)
2364 (if (eq buffer-undo-list t)
2365 (setq buffer-undo-list nil)))))
2367 (defun accept-change-group (handle)
2368 "Finish a change group made with `prepare-change-group' (which see).
2369 This finishes the change group by accepting its changes as final."
2370 (dolist (elt handle)
2371 (with-current-buffer (car elt)
2372 (if (eq (cdr elt) t)
2373 (setq buffer-undo-list t)))))
2375 (defun cancel-change-group (handle)
2376 "Finish a change group made with `prepare-change-group' (which see).
2377 This finishes the change group by reverting all of its changes."
2378 (dolist (elt handle)
2379 (with-current-buffer (car elt)
2380 (setq elt (cdr elt))
2382 ;; Widen buffer temporarily so if the buffer was narrowed within
2383 ;; the body of `atomic-change-group' all changes can be undone.
2386 (if (consp elt) (car elt)))
2388 (if (consp elt) (cdr elt))))
2389 ;; Temporarily truncate the undo log at ELT.
2391 (setcar elt nil) (setcdr elt nil))
2392 (unless (eq last-command 'undo) (undo-start))
2393 ;; Make sure there's no confusion.
2394 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2395 (error "Undoing to some unrelated state"))
2398 (while (listp pending-undo-list) (undo-more 1)))
2399 ;; Reset the modified cons cell ELT to its original content.
2401 (setcar elt old-car)
2402 (setcdr elt old-cdr))
2403 ;; Revert the undo info to what it was when we grabbed the state.
2404 (setq buffer-undo-list elt))))))
2406 ;;;; Display-related functions.
2408 ;; For compatibility.
2409 (define-obsolete-function-alias 'redraw-modeline
2410 'force-mode-line-update "24.3")
2412 (defun momentary-string-display (string pos &optional exit-char message)
2413 "Momentarily display STRING in the buffer at POS.
2414 Display remains until next event is input.
2415 If POS is a marker, only its position is used; its buffer is ignored.
2416 Optional third arg EXIT-CHAR can be a character, event or event
2417 description list. EXIT-CHAR defaults to SPC. If the input is
2418 EXIT-CHAR it is swallowed; otherwise it is then available as
2419 input (as a command if nothing else).
2420 Display MESSAGE (optional fourth arg) in the echo area.
2421 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2422 (or exit-char (setq exit-char ?\s))
2423 (let ((ol (make-overlay pos pos))
2424 (str (copy-sequence string)))
2428 (overlay-put ol 'after-string str)
2430 ;; To avoid trouble with out-of-bounds position
2432 ;; If the string end is off screen, recenter now.
2433 (if (<= (window-end nil t) pos)
2434 (recenter (/ (window-height) 2))))
2435 (message (or message "Type %s to continue editing.")
2436 (single-key-description exit-char))
2437 (let ((event (read-key)))
2438 ;; `exit-char' can be an event, or an event description list.
2439 (or (eq event exit-char)
2440 (eq event (event-convert-list exit-char))
2441 (setq unread-command-events
2442 (append (this-single-command-raw-keys))))))
2443 (delete-overlay ol))))
2446 ;;;; Overlay operations
2448 (defun copy-overlay (o)
2449 "Return a copy of overlay O."
2450 (let ((o1 (if (overlay-buffer o)
2451 (make-overlay (overlay-start o) (overlay-end o)
2452 ;; FIXME: there's no easy way to find the
2453 ;; insertion-type of the two markers.
2455 (let ((o1 (make-overlay (point-min) (point-min))))
2458 (props (overlay-properties o)))
2460 (overlay-put o1 (pop props) (pop props)))
2463 (defun remove-overlays (&optional beg end name val)
2464 "Clear BEG and END of overlays whose property NAME has value VAL.
2465 Overlays might be moved and/or split.
2466 BEG and END default respectively to the beginning and end of buffer."
2467 ;; This speeds up the loops over overlays.
2468 (unless beg (setq beg (point-min)))
2469 (unless end (setq end (point-max)))
2470 (overlay-recenter end)
2472 (setq beg (prog1 end (setq end beg))))
2474 (dolist (o (overlays-in beg end))
2475 (when (eq (overlay-get o name) val)
2476 ;; Either push this overlay outside beg...end
2477 ;; or split it to exclude beg...end
2478 ;; or delete it entirely (if it is contained in beg...end).
2479 (if (< (overlay-start o) beg)
2480 (if (> (overlay-end o) end)
2482 (move-overlay (copy-overlay o)
2483 (overlay-start o) beg)
2484 (move-overlay o end (overlay-end o)))
2485 (move-overlay o (overlay-start o) beg))
2486 (if (> (overlay-end o) end)
2487 (move-overlay o end (overlay-end o))
2488 (delete-overlay o)))))))
2492 (defvar suspend-hook nil
2493 "Normal hook run by `suspend-emacs', before suspending.")
2495 (defvar suspend-resume-hook nil
2496 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2498 (defvar temp-buffer-show-hook nil
2499 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2500 When the hook runs, the temporary buffer is current, and the window it
2501 was displayed in is selected.")
2503 (defvar temp-buffer-setup-hook nil
2504 "Normal hook run by `with-output-to-temp-buffer' at the start.
2505 When the hook runs, the temporary buffer is current.
2506 This hook is normally set up with a function to put the buffer in Help
2509 (defconst user-emacs-directory
2510 (if (eq system-type 'ms-dos)
2511 ;; MS-DOS cannot have initial dot.
2514 "Directory beneath which additional per-user Emacs-specific files are placed.
2515 Various programs in Emacs store information in this directory.
2516 Note that this should end with a directory separator.
2517 See also `locate-user-emacs-file'.")
2519 ;;;; Misc. useful functions.
2521 (defsubst buffer-narrowed-p ()
2522 "Return non-nil if the current buffer is narrowed."
2523 (/= (- (point-max) (point-min)) (buffer-size)))
2525 (defun find-tag-default-bounds ()
2526 "Determine the boundaries of the default tag, based on text at point.
2527 Return a cons cell with the beginning and end of the found tag.
2528 If there is no plausible default, return nil."
2529 (let (from to bound)
2531 ;; Look at text around `point'.
2533 (skip-syntax-backward "w_") (setq from (point)))
2535 (skip-syntax-forward "w_") (setq to (point)))
2537 ;; Look between `line-beginning-position' and `point'.
2539 (and (setq bound (line-beginning-position))
2540 (skip-syntax-backward "^w_" bound)
2541 (> (setq to (point)) bound)
2542 (skip-syntax-backward "w_")
2543 (setq from (point))))
2544 ;; Look between `point' and `line-end-position'.
2546 (and (setq bound (line-end-position))
2547 (skip-syntax-forward "^w_" bound)
2548 (< (setq from (point)) bound)
2549 (skip-syntax-forward "w_")
2550 (setq to (point)))))
2553 (defun find-tag-default ()
2554 "Determine default tag to search for, based on text at point.
2555 If there is no plausible default, return nil."
2556 (let ((bounds (find-tag-default-bounds)))
2558 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2560 (defun find-tag-default-as-regexp ()
2561 "Return regexp that matches the default tag at point.
2562 If there is no tag at point, return nil.
2564 When in a major mode that does not provide its own
2565 `find-tag-default-function', return a regexp that matches the
2566 symbol at point exactly."
2567 (let ((tag (funcall (or find-tag-default-function
2568 (get major-mode 'find-tag-default-function)
2569 'find-tag-default))))
2570 (if tag (regexp-quote tag))))
2572 (defun find-tag-default-as-symbol-regexp ()
2573 "Return regexp that matches the default tag at point as symbol.
2574 If there is no tag at point, return nil.
2576 When in a major mode that does not provide its own
2577 `find-tag-default-function', return a regexp that matches the
2578 symbol at point exactly."
2579 (let ((tag-regexp (find-tag-default-as-regexp)))
2581 (eq (or find-tag-default-function
2582 (get major-mode 'find-tag-default-function)
2585 (format "\\_<%s\\_>" tag-regexp)
2588 (defun play-sound (sound)
2589 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2590 The following keywords are recognized:
2592 :file FILE - read sound data from FILE. If FILE isn't an
2593 absolute file name, it is searched in `data-directory'.
2595 :data DATA - read sound data from string DATA.
2597 Exactly one of :file or :data must be present.
2599 :volume VOL - set volume to VOL. VOL must an integer in the
2600 range 0..100 or a float in the range 0..1.0. If not specified,
2601 don't change the volume setting of the sound device.
2603 :device DEVICE - play sound on DEVICE. If not specified,
2604 a system-dependent default device name is used.
2606 Note: :data and :device are currently not supported on Windows."
2607 (if (fboundp 'play-sound-internal)
2608 (play-sound-internal sound)
2609 (error "This Emacs binary lacks sound support")))
2611 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2613 (defun shell-quote-argument (argument)
2614 "Quote ARGUMENT for passing as argument to an inferior shell."
2616 ((eq system-type 'ms-dos)
2617 ;; Quote using double quotes, but escape any existing quotes in
2618 ;; the argument with backslashes.
2622 (if (or (null (string-match "[^\"]" argument))
2623 (< (match-end 0) (length argument)))
2624 (while (string-match "[\"]" argument start)
2625 (setq end (match-beginning 0)
2626 result (concat result (substring argument start end)
2627 "\\" (substring argument end (1+ end)))
2629 (concat "\"" result (substring argument start) "\"")))
2631 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2633 ;; First, quote argument so that CommandLineToArgvW will
2634 ;; understand it. See
2635 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2636 ;; After we perform that level of quoting, escape shell
2637 ;; metacharacters so that cmd won't mangle our argument. If the
2638 ;; argument contains no double quote characters, we can just
2639 ;; surround it with double quotes. Otherwise, we need to prefix
2640 ;; each shell metacharacter with a caret.
2643 ;; escape backslashes at end of string
2644 (replace-regexp-in-string
2647 ;; escape backslashes and quotes in string body
2648 (replace-regexp-in-string
2653 (if (string-match "[%!\"]" argument)
2656 (replace-regexp-in-string
2657 "\\([%!()\"<>&|^]\\)"
2661 (concat "\"" argument "\"")))
2664 (if (equal argument "")
2666 ;; Quote everything except POSIX filename characters.
2667 ;; This should be safe enough even for really weird shells.
2668 (replace-regexp-in-string
2670 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2673 (defun string-or-null-p (object)
2674 "Return t if OBJECT is a string or nil.
2675 Otherwise, return nil."
2676 (or (stringp object) (null object)))
2678 (defun booleanp (object)
2679 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2680 Otherwise, return nil."
2681 (and (memq object '(nil t)) t))
2683 (defun special-form-p (object)
2684 "Non-nil if and only if OBJECT is a special form."
2685 (if (and (symbolp object) (fboundp object))
2686 (setq object (indirect-function object t)))
2687 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2689 (defun macrop (object)
2690 "Non-nil if and only if OBJECT is a macro."
2691 (let ((def (indirect-function object t)))
2693 (or (eq 'macro (car def))
2694 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2696 (defun field-at-pos (pos)
2697 "Return the field at position POS, taking stickiness etc into account."
2698 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2699 (if (eq raw-field 'boundary)
2700 (get-char-property (1- (field-end pos)) 'field)
2703 (defun sha1 (object &optional start end binary)
2704 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2705 OBJECT is either a string or a buffer. Optional arguments START and
2706 END are character positions specifying which portion of OBJECT for
2707 computing the hash. If BINARY is non-nil, return a string in binary
2709 (secure-hash 'sha1 object start end binary))
2711 (defalias 'function-put #'put
2712 ;; This is only really used in Emacs>24.4, but we add it to 24.4 already, so
2713 ;; as to ease the pain when people use future autoload files that contain
2715 "Set function F's property PROP to VALUE.
2716 The namespace for PROP is shared with symbols.
2717 So far, F can only be a symbol, not a lambda expression.")
2719 (defun function-get (f prop &optional autoload)
2720 "Return the value of property PROP of function F.
2721 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2722 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2723 if it's an autoloaded macro."
2725 (while (and (symbolp f)
2726 (null (setq val (get f prop)))
2728 (let ((fundef (symbol-function f)))
2729 (if (and autoload (autoloadp fundef)
2731 (autoload-do-load fundef f
2732 (if (eq autoload 'macro)
2734 nil ;Re-try `get' on the same `f'.
2738 ;;;; Support for yanking and text properties.
2739 ;; Why here in subr.el rather than in simple.el? --Stef
2741 (defvar yank-handled-properties)
2742 (defvar yank-excluded-properties)
2744 (defun remove-yank-excluded-properties (start end)
2745 "Process text properties between START and END, inserted for a `yank'.
2746 Perform the handling specified by `yank-handled-properties', then
2747 remove properties specified by `yank-excluded-properties'."
2748 (let ((inhibit-read-only t))
2749 (dolist (handler yank-handled-properties)
2750 (let ((prop (car handler))
2753 (while (< run-start end)
2754 (let ((value (get-text-property run-start prop))
2755 (run-end (next-single-property-change
2756 run-start prop nil end)))
2757 (funcall fun value run-start run-end)
2758 (setq run-start run-end)))))
2759 (if (eq yank-excluded-properties t)
2760 (set-text-properties start end nil)
2761 (remove-list-of-text-properties start end yank-excluded-properties))))
2763 (defvar yank-undo-function)
2765 (defun insert-for-yank (string)
2766 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2768 See `insert-for-yank-1' for more details."
2770 (while (setq to (next-single-property-change 0 'yank-handler string))
2771 (insert-for-yank-1 (substring string 0 to))
2772 (setq string (substring string to))))
2773 (insert-for-yank-1 string))
2775 (defun insert-for-yank-1 (string)
2776 "Insert STRING at point for the `yank' command.
2777 This function is like `insert', except it honors the variables
2778 `yank-handled-properties' and `yank-excluded-properties', and the
2779 `yank-handler' text property.
2781 Properties listed in `yank-handled-properties' are processed,
2782 then those listed in `yank-excluded-properties' are discarded.
2784 If STRING has a non-nil `yank-handler' property on its first
2785 character, the normal insert behavior is altered. The value of
2786 the `yank-handler' property must be a list of one to four
2787 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2788 FUNCTION, if non-nil, should be a function of one argument, an
2789 object to insert; it is called instead of `insert'.
2790 PARAM, if present and non-nil, replaces STRING as the argument to
2791 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2792 may be a list of strings to insert as a rectangle.
2793 If NOEXCLUDE is present and non-nil, the normal removal of
2794 `yank-excluded-properties' is not performed; instead FUNCTION is
2795 responsible for the removal. This may be necessary if FUNCTION
2796 adjusts point before or after inserting the object.
2797 UNDO, if present and non-nil, should be a function to be called
2798 by `yank-pop' to undo the insertion of the current object. It is
2799 given two arguments, the start and end of the region. FUNCTION
2800 may set `yank-undo-function' to override UNDO."
2801 (let* ((handler (and (stringp string)
2802 (get-text-property 0 'yank-handler string)))
2803 (param (or (nth 1 handler) string))
2805 (inhibit-read-only inhibit-read-only)
2808 (setq yank-undo-function t)
2809 (if (nth 0 handler) ; FUNCTION
2810 (funcall (car handler) param)
2814 ;; Prevent read-only properties from interfering with the
2815 ;; following text property changes.
2816 (setq inhibit-read-only t)
2818 (unless (nth 2 handler) ; NOEXCLUDE
2819 (remove-yank-excluded-properties opoint end))
2821 ;; If last inserted char has properties, mark them as rear-nonsticky.
2822 (if (and (> end opoint)
2823 (text-properties-at (1- end)))
2824 (put-text-property (1- end) end 'rear-nonsticky t))
2826 (if (eq yank-undo-function t) ; not set by FUNCTION
2827 (setq yank-undo-function (nth 3 handler))) ; UNDO
2828 (if (nth 4 handler) ; COMMAND
2829 (setq this-command (nth 4 handler)))))
2831 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2832 "Insert before point a substring of BUFFER, without text properties.
2833 BUFFER may be a buffer or a buffer name.
2834 Arguments START and END are character positions specifying the substring.
2835 They default to the values of (point-min) and (point-max) in BUFFER."
2836 (let ((opoint (point)))
2837 (insert-buffer-substring buffer start end)
2838 (let ((inhibit-read-only t))
2839 (set-text-properties opoint (point) nil))))
2841 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2842 "Insert before point a part of BUFFER, stripping some text properties.
2843 BUFFER may be a buffer or a buffer name.
2844 Arguments START and END are character positions specifying the substring.
2845 They default to the values of (point-min) and (point-max) in BUFFER.
2846 Before insertion, process text properties according to
2847 `yank-handled-properties' and `yank-excluded-properties'."
2848 ;; Since the buffer text should not normally have yank-handler properties,
2849 ;; there is no need to handle them here.
2850 (let ((opoint (point)))
2851 (insert-buffer-substring buffer start end)
2852 (remove-yank-excluded-properties opoint (point))))
2854 (defun yank-handle-font-lock-face-property (face start end)
2855 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2856 START and END denote the start and end of the text to act on.
2857 Do nothing if FACE is nil."
2859 (null font-lock-defaults)
2860 (put-text-property start end 'face face)))
2862 ;; This removes `mouse-face' properties in *Help* buffer buttons:
2863 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2864 (defun yank-handle-category-property (category start end)
2865 "Apply property category CATEGORY's properties between START and END."
2867 (let ((start2 start))
2868 (while (< start2 end)
2869 (let ((end2 (next-property-change start2 nil end))
2870 (original (text-properties-at start2)))
2871 (set-text-properties start2 end2 (symbol-plist category))
2872 (add-text-properties start2 end2 original)
2873 (setq start2 end2))))))
2876 ;;;; Synchronous shell commands.
2878 (defun start-process-shell-command (name buffer &rest args)
2879 "Start a program in a subprocess. Return the process object for it.
2880 NAME is name for process. It is modified if necessary to make it unique.
2881 BUFFER is the buffer (or buffer name) to associate with the process.
2882 Process output goes at end of that buffer, unless you specify
2883 an output stream or filter function to handle the output.
2884 BUFFER may be also nil, meaning that this process is not associated
2886 COMMAND is the shell command to run.
2888 An old calling convention accepted any number of arguments after COMMAND,
2889 which were just concatenated to COMMAND. This is still supported but strongly
2891 (declare (advertised-calling-convention (name buffer command) "23.1"))
2892 ;; We used to use `exec' to replace the shell with the command,
2893 ;; but that failed to handle (...) and semicolon, etc.
2894 (start-process name buffer shell-file-name shell-command-switch
2895 (mapconcat 'identity args " ")))
2897 (defun start-file-process-shell-command (name buffer &rest args)
2898 "Start a program in a subprocess. Return the process object for it.
2899 Similar to `start-process-shell-command', but calls `start-file-process'."
2900 (declare (advertised-calling-convention (name buffer command) "23.1"))
2903 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2904 (if (file-remote-p default-directory) "-c" shell-command-switch)
2905 (mapconcat 'identity args " ")))
2907 (defun call-process-shell-command (command &optional infile buffer display
2909 "Execute the shell command COMMAND synchronously in separate process.
2910 The remaining arguments are optional.
2911 The program's input comes from file INFILE (nil means `/dev/null').
2912 Insert output in BUFFER before point; t means current buffer;
2913 nil for BUFFER means discard it; 0 means discard and don't wait.
2914 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2915 REAL-BUFFER says what to do with standard output, as above,
2916 while STDERR-FILE says what to do with standard error in the child.
2917 STDERR-FILE may be nil (discard standard error output),
2918 t (mix it with ordinary output), or a file name string.
2920 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2921 Wildcards and redirection are handled as usual in the shell.
2923 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2924 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2925 status or a signal description string.
2926 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
2928 An old calling convention accepted any number of arguments after DISPLAY,
2929 which were just concatenated to COMMAND. This is still supported but strongly
2931 (declare (advertised-calling-convention
2932 (command &optional infile buffer display) "24.5"))
2933 ;; We used to use `exec' to replace the shell with the command,
2934 ;; but that failed to handle (...) and semicolon, etc.
2935 (call-process shell-file-name
2936 infile buffer display
2937 shell-command-switch
2938 (mapconcat 'identity (cons command args) " ")))
2940 (defun process-file-shell-command (command &optional infile buffer display
2942 "Process files synchronously in a separate process.
2943 Similar to `call-process-shell-command', but calls `process-file'."
2944 (declare (advertised-calling-convention
2945 (command &optional infile buffer display) "24.5"))
2947 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2948 infile buffer display
2949 (if (file-remote-p default-directory) "-c" shell-command-switch)
2950 (mapconcat 'identity (cons command args) " ")))
2952 ;;;; Lisp macros to do various things temporarily.
2954 (defmacro with-current-buffer (buffer-or-name &rest body)
2955 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2956 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2957 The value returned is the value of the last form in BODY. See
2958 also `with-temp-buffer'."
2959 (declare (indent 1) (debug t))
2960 `(save-current-buffer
2961 (set-buffer ,buffer-or-name)
2964 (defun internal--before-with-selected-window (window)
2965 (let ((other-frame (window-frame window)))
2966 (list window (selected-window)
2967 ;; Selecting a window on another frame also changes that
2968 ;; frame's frame-selected-window. We must save&restore it.
2969 (unless (eq (selected-frame) other-frame)
2970 (frame-selected-window other-frame))
2971 ;; Also remember the top-frame if on ttys.
2972 (unless (eq (selected-frame) other-frame)
2973 (tty-top-frame other-frame)))))
2975 (defun internal--after-with-selected-window (state)
2976 ;; First reset frame-selected-window.
2977 (when (window-live-p (nth 2 state))
2978 ;; We don't use set-frame-selected-window because it does not
2979 ;; pass the `norecord' argument to Fselect_window.
2980 (select-window (nth 2 state) 'norecord)
2981 (and (frame-live-p (nth 3 state))
2982 (not (eq (tty-top-frame) (nth 3 state)))
2983 (select-frame (nth 3 state) 'norecord)))
2984 ;; Then reset the actual selected-window.
2985 (when (window-live-p (nth 1 state))
2986 (select-window (nth 1 state) 'norecord)))
2988 (defmacro with-selected-window (window &rest body)
2989 "Execute the forms in BODY with WINDOW as the selected window.
2990 The value returned is the value of the last form in BODY.
2992 This macro saves and restores the selected window, as well as the
2993 selected window of each frame. It does not change the order of
2994 recently selected windows. If the previously selected window of
2995 some frame is no longer live at the end of BODY, that frame's
2996 selected window is left alone. If the selected window is no
2997 longer live, then whatever window is selected at the end of BODY
3000 This macro uses `save-current-buffer' to save and restore the
3001 current buffer, since otherwise its normal operation could
3002 potentially make a different buffer current. It does not alter
3003 the buffer list ordering."
3004 (declare (indent 1) (debug t))
3005 `(let ((save-selected-window--state
3006 (internal--before-with-selected-window ,window)))
3007 (save-current-buffer
3009 (progn (select-window (car save-selected-window--state) 'norecord)
3011 (internal--after-with-selected-window save-selected-window--state)))))
3013 (defmacro with-selected-frame (frame &rest body)
3014 "Execute the forms in BODY with FRAME as the selected frame.
3015 The value returned is the value of the last form in BODY.
3017 This macro saves and restores the selected frame, and changes the
3018 order of neither the recently selected windows nor the buffers in
3020 (declare (indent 1) (debug t))
3021 (let ((old-frame (make-symbol "old-frame"))
3022 (old-buffer (make-symbol "old-buffer")))
3023 `(let ((,old-frame (selected-frame))
3024 (,old-buffer (current-buffer)))
3026 (progn (select-frame ,frame 'norecord)
3028 (when (frame-live-p ,old-frame)
3029 (select-frame ,old-frame 'norecord))
3030 (when (buffer-live-p ,old-buffer)
3031 (set-buffer ,old-buffer))))))
3033 (defmacro save-window-excursion (&rest body)
3034 "Execute BODY, then restore previous window configuration.
3035 This macro saves the window configuration on the selected frame,
3036 executes BODY, then calls `set-window-configuration' to restore
3037 the saved window configuration. The return value is the last
3038 form in BODY. The window configuration is also restored if BODY
3041 BEWARE: Most uses of this macro introduce bugs.
3042 E.g. it should not be used to try and prevent some code from opening
3043 a new window, since that window may sometimes appear in another frame,
3044 in which case `save-window-excursion' cannot help."
3045 (declare (indent 0) (debug t))
3046 (let ((c (make-symbol "wconfig")))
3047 `(let ((,c (current-window-configuration)))
3048 (unwind-protect (progn ,@body)
3049 (set-window-configuration ,c)))))
3051 (defun internal-temp-output-buffer-show (buffer)
3052 "Internal function for `with-output-to-temp-buffer'."
3053 (with-current-buffer buffer
3054 (set-buffer-modified-p nil)
3055 (goto-char (point-min)))
3057 (if temp-buffer-show-function
3058 (funcall temp-buffer-show-function buffer)
3059 (with-current-buffer buffer
3061 (let ((window-combination-limit
3062 ;; When `window-combination-limit' equals
3063 ;; `temp-buffer' or `temp-buffer-resize' and
3064 ;; `temp-buffer-resize-mode' is enabled in this
3065 ;; buffer bind it to t so resizing steals space
3066 ;; preferably from the window that was split.
3067 (if (or (eq window-combination-limit 'temp-buffer)
3068 (and (eq window-combination-limit
3069 'temp-buffer-resize)
3070 temp-buffer-resize-mode))
3072 window-combination-limit)))
3073 (display-buffer buffer)))
3074 (frame (and window (window-frame window))))
3076 (unless (eq frame (selected-frame))
3077 (make-frame-visible frame))
3078 (setq minibuffer-scroll-window window)
3079 (set-window-hscroll window 0)
3080 ;; Don't try this with NOFORCE non-nil!
3081 (set-window-start window (point-min) t)
3082 ;; This should not be necessary.
3083 (set-window-point window (point-min))
3084 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3085 (with-selected-window window
3086 (run-hooks 'temp-buffer-show-hook))))))
3090 ;; Doc is very similar to with-temp-buffer-window.
3091 (defmacro with-output-to-temp-buffer (bufname &rest body)
3092 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3094 This construct makes buffer BUFNAME empty before running BODY.
3095 It does not make the buffer current for BODY.
3096 Instead it binds `standard-output' to that buffer, so that output
3097 generated with `prin1' and similar functions in BODY goes into
3100 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3101 it in a window, but does not select it. The normal way to do this is
3102 by calling `display-buffer', then running `temp-buffer-show-hook'.
3103 However, if `temp-buffer-show-function' is non-nil, it calls that
3104 function instead (and does not run `temp-buffer-show-hook'). The
3105 function gets one argument, the buffer to display.
3107 The return value of `with-output-to-temp-buffer' is the value of the
3108 last form in BODY. If BODY does not finish normally, the buffer
3109 BUFNAME is not displayed.
3111 This runs the hook `temp-buffer-setup-hook' before BODY,
3112 with the buffer BUFNAME temporarily current. It runs the hook
3113 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3114 buffer temporarily current, and the window that was used to display it
3115 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3116 if it uses `temp-buffer-show-function'.
3118 By default, the setup hook puts the buffer into Help mode before running BODY.
3119 If BODY does not change the major mode, the show hook makes the buffer
3120 read-only, and scans it for function and variable names to make them into
3121 clickable cross-references.
3123 See the related form `with-temp-buffer-window'."
3125 (let ((old-dir (make-symbol "old-dir"))
3126 (buf (make-symbol "buf")))
3127 `(let* ((,old-dir default-directory)
3129 (with-current-buffer (get-buffer-create ,bufname)
3130 (prog1 (current-buffer)
3131 (kill-all-local-variables)
3132 ;; FIXME: delete_all_overlays
3133 (setq default-directory ,old-dir)
3134 (setq buffer-read-only nil)
3135 (setq buffer-file-name nil)
3136 (setq buffer-undo-list t)
3137 (let ((inhibit-read-only t)
3138 (inhibit-modification-hooks t))
3140 (run-hooks 'temp-buffer-setup-hook)))))
3141 (standard-output ,buf))
3142 (prog1 (progn ,@body)
3143 (internal-temp-output-buffer-show ,buf)))))
3145 (defmacro with-temp-file (file &rest body)
3146 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3147 The value returned is the value of the last form in BODY.
3148 See also `with-temp-buffer'."
3149 (declare (indent 1) (debug t))
3150 (let ((temp-file (make-symbol "temp-file"))
3151 (temp-buffer (make-symbol "temp-buffer")))
3152 `(let ((,temp-file ,file)
3154 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3157 (with-current-buffer ,temp-buffer
3159 (with-current-buffer ,temp-buffer
3160 (write-region nil nil ,temp-file nil 0)))
3161 (and (buffer-name ,temp-buffer)
3162 (kill-buffer ,temp-buffer))))))
3164 (defmacro with-temp-message (message &rest body)
3165 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3166 The original message is restored to the echo area after BODY has finished.
3167 The value returned is the value of the last form in BODY.
3168 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3169 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3170 Use a MESSAGE of \"\" to temporarily clear the echo area."
3171 (declare (debug t) (indent 1))
3172 (let ((current-message (make-symbol "current-message"))
3173 (temp-message (make-symbol "with-temp-message")))
3174 `(let ((,temp-message ,message)
3179 (setq ,current-message (current-message))
3180 (message "%s" ,temp-message))
3183 (if ,current-message
3184 (message "%s" ,current-message)
3187 (defmacro with-temp-buffer (&rest body)
3188 "Create a temporary buffer, and evaluate BODY there like `progn'.
3189 See also `with-temp-file' and `with-output-to-string'."
3190 (declare (indent 0) (debug t))
3191 (let ((temp-buffer (make-symbol "temp-buffer")))
3192 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3193 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3194 (with-current-buffer ,temp-buffer
3197 (and (buffer-name ,temp-buffer)
3198 (kill-buffer ,temp-buffer)))))))
3200 (defmacro with-silent-modifications (&rest body)
3201 "Execute BODY, pretending it does not modify the buffer.
3202 If BODY performs real modifications to the buffer's text, other
3203 than cosmetic ones, undo data may become corrupted.
3205 This macro will run BODY normally, but doesn't count its buffer
3206 modifications as being buffer modifications. This affects things
3207 like `buffer-modified-p', checking whether the file is locked by
3208 someone else, running buffer modification hooks, and other things
3211 Typically used around modifications of text-properties which do
3212 not really affect the buffer's content."
3213 (declare (debug t) (indent 0))
3214 (let ((modified (make-symbol "modified")))
3215 `(let* ((,modified (buffer-modified-p))
3216 (buffer-undo-list t)
3217 (inhibit-read-only t)
3218 (inhibit-modification-hooks t)
3220 ;; Avoid setting and removing file locks and checking
3221 ;; buffer's uptodate-ness w.r.t the underlying file.
3223 buffer-file-truename)
3228 (restore-buffer-modified-p nil))))))
3230 (defmacro with-output-to-string (&rest body)
3231 "Execute BODY, return the text it sent to `standard-output', as a string."
3232 (declare (indent 0) (debug t))
3233 `(let ((standard-output
3234 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3237 (let ((standard-output standard-output))
3239 (with-current-buffer standard-output
3241 (kill-buffer standard-output))))
3243 (defmacro with-local-quit (&rest body)
3244 "Execute BODY, allowing quits to terminate BODY but not escape further.
3245 When a quit terminates BODY, `with-local-quit' returns nil but
3246 requests another quit. That quit will be processed as soon as quitting
3247 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3248 (declare (debug t) (indent 0))
3249 `(condition-case nil
3250 (let ((inhibit-quit nil))
3252 (quit (setq quit-flag t)
3253 ;; This call is to give a chance to handle quit-flag
3254 ;; in case inhibit-quit is nil.
3255 ;; Without this, it will not be handled until the next function
3256 ;; call, and that might allow it to exit thru a condition-case
3257 ;; that intends to handle the quit signal next time.
3258 (eval '(ignore nil)))))
3260 (defmacro while-no-input (&rest body)
3261 "Execute BODY only as long as there's no pending input.
3262 If input arrives, that ends the execution of BODY,
3263 and `while-no-input' returns t. Quitting makes it return nil.
3264 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3265 (declare (debug t) (indent 0))
3266 (let ((catch-sym (make-symbol "input")))
3269 (let ((throw-on-input ',catch-sym))
3270 (or (input-pending-p)
3271 (progn ,@body)))))))
3273 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3274 "Like `condition-case' except that it does not prevent debugging.
3275 More specifically if `debug-on-error' is set then the debugger will be invoked
3276 even if this catches the signal."
3277 (declare (debug condition-case) (indent 2))
3278 `(condition-case ,var
3280 ,@(mapcar (lambda (handler)
3281 `((debug ,@(if (listp (car handler)) (car handler)
3282 (list (car handler))))
3286 (define-obsolete-function-alias 'condition-case-no-debug
3287 'condition-case-unless-debug "24.1")
3289 (defmacro with-demoted-errors (format &rest body)
3290 "Run BODY and demote any errors to simple messages.
3291 FORMAT is a string passed to `message' to format any error message.
3292 It should contain a single %-sequence; e.g., \"Error: %S\".
3294 If `debug-on-error' is non-nil, run BODY without catching its errors.
3295 This is to be used around code which is not expected to signal an error
3296 but which should be robust in the unexpected case that an error is signaled.
3298 For backward compatibility, if FORMAT is not a constant string, it
3299 is assumed to be part of BODY, in which case the message format
3300 used is \"Error: %S\"."
3301 (declare (debug t) (indent 1))
3302 (let ((err (make-symbol "err"))
3303 (format (if (and (stringp format) body) format
3305 (if format (push format body))))))
3306 `(condition-case-unless-debug ,err
3307 ,(macroexp-progn body)
3308 (error (message ,format ,err) nil))))
3310 (defmacro combine-after-change-calls (&rest body)
3311 "Execute BODY, but don't call the after-change functions till the end.
3312 If BODY makes changes in the buffer, they are recorded
3313 and the functions on `after-change-functions' are called several times
3314 when BODY is finished.
3315 The return value is the value of the last form in BODY.
3317 If `before-change-functions' is non-nil, then calls to the after-change
3318 functions can't be deferred, so in that case this macro has no effect.
3320 Do not alter `after-change-functions' or `before-change-functions'
3322 (declare (indent 0) (debug t))
3324 (let ((combine-after-change-calls t))
3326 (combine-after-change-execute)))
3328 (defmacro with-case-table (table &rest body)
3329 "Execute the forms in BODY with TABLE as the current case table.
3330 The value returned is the value of the last form in BODY."
3331 (declare (indent 1) (debug t))
3332 (let ((old-case-table (make-symbol "table"))
3333 (old-buffer (make-symbol "buffer")))
3334 `(let ((,old-case-table (current-case-table))
3335 (,old-buffer (current-buffer)))
3337 (progn (set-case-table ,table)
3339 (with-current-buffer ,old-buffer
3340 (set-case-table ,old-case-table))))))
3342 ;;; Matching and match data.
3344 (defvar save-match-data-internal)
3346 ;; We use save-match-data-internal as the local variable because
3347 ;; that works ok in practice (people should not use that variable elsewhere).
3348 ;; We used to use an uninterned symbol; the compiler handles that properly
3349 ;; now, but it generates slower code.
3350 (defmacro save-match-data (&rest body)
3351 "Execute the BODY forms, restoring the global value of the match data.
3352 The value returned is the value of the last form in BODY."
3353 ;; It is better not to use backquote here,
3354 ;; because that makes a bootstrapping problem
3355 ;; if you need to recompile all the Lisp files using interpreted code.
3356 (declare (indent 0) (debug t))
3358 '((save-match-data-internal (match-data)))
3359 (list 'unwind-protect
3361 ;; It is safe to free (evaporate) markers immediately here,
3362 ;; as Lisp programs should not copy from save-match-data-internal.
3363 '(set-match-data save-match-data-internal 'evaporate))))
3365 (defun match-string (num &optional string)
3366 "Return string of text matched by last search.
3367 NUM specifies which parenthesized expression in the last regexp.
3368 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3369 Zero means the entire text matched by the whole regexp or whole string.
3370 STRING should be given if the last search was by `string-match' on STRING.
3371 If STRING is nil, the current buffer should be the same buffer
3372 the search/match was performed in."
3373 (if (match-beginning num)
3375 (substring string (match-beginning num) (match-end num))
3376 (buffer-substring (match-beginning num) (match-end num)))))
3378 (defun match-string-no-properties (num &optional string)
3379 "Return string of text matched by last search, without text properties.
3380 NUM specifies which parenthesized expression in the last regexp.
3381 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3382 Zero means the entire text matched by the whole regexp or whole string.
3383 STRING should be given if the last search was by `string-match' on STRING.
3384 If STRING is nil, the current buffer should be the same buffer
3385 the search/match was performed in."
3386 (if (match-beginning num)
3388 (substring-no-properties string (match-beginning num)
3390 (buffer-substring-no-properties (match-beginning num)
3394 (defun match-substitute-replacement (replacement
3395 &optional fixedcase literal string subexp)
3396 "Return REPLACEMENT as it will be inserted by `replace-match'.
3397 In other words, all back-references in the form `\\&' and `\\N'
3398 are substituted with actual strings matched by the last search.
3399 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3400 meaning as for `replace-match'."
3401 (let ((match (match-string 0 string)))
3403 (set-match-data (mapcar (lambda (x)
3405 (- x (match-beginning 0))
3408 (replace-match replacement fixedcase literal match subexp))))
3411 (defun looking-back (regexp &optional limit greedy)
3412 "Return non-nil if text before point matches regular expression REGEXP.
3413 Like `looking-at' except matches before point, and is slower.
3414 LIMIT if non-nil speeds up the search by specifying a minimum
3415 starting position, to avoid checking matches that would start
3418 If GREEDY is non-nil, extend the match backwards as far as
3419 possible, stopping when a single additional previous character
3420 cannot be part of a match for REGEXP. When the match is
3421 extended, its starting position is allowed to occur before
3424 As a general recommendation, try to avoid using `looking-back'
3425 wherever possible, since it is slow."
3426 (let ((start (point))
3429 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3431 (if (and greedy pos)
3433 (narrow-to-region (point-min) start)
3434 (while (and (> pos (point-min))
3438 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3439 (setq pos (1- pos)))
3442 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3445 (defsubst looking-at-p (regexp)
3447 Same as `looking-at' except this function does not change the match data."
3448 (let ((inhibit-changing-match-data t))
3449 (looking-at regexp)))
3451 (defsubst string-match-p (regexp string &optional start)
3453 Same as `string-match' except this function does not change the match data."
3454 (let ((inhibit-changing-match-data t))
3455 (string-match regexp string start)))
3457 (defun subregexp-context-p (regexp pos &optional start)
3458 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3459 A subregexp context is one where a sub-regexp can appear.
3460 A non-subregexp context is for example within brackets, or within a
3461 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3462 If START is non-nil, it should be a position in REGEXP, smaller
3463 than POS, and known to be in a subregexp context."
3464 ;; Here's one possible implementation, with the great benefit that it
3465 ;; reuses the regexp-matcher's own parser, so it understands all the
3466 ;; details of the syntax. A disadvantage is that it needs to match the
3470 (string-match (substring regexp (or start 0) pos) "")
3473 (not (member (cadr err) '("Unmatched [ or [^"
3475 "Trailing backslash")))))
3476 ;; An alternative implementation:
3477 ;; (defconst re-context-re
3478 ;; (let* ((harmless-ch "[^\\[]")
3479 ;; (harmless-esc "\\\\[^{]")
3480 ;; (class-harmless-ch "[^][]")
3481 ;; (class-lb-harmless "[^]:]")
3482 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3483 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3484 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3486 ;; (concat "\\[^?]?"
3487 ;; "\\(" class-harmless-ch
3488 ;; "\\|" class-lb "\\)*"
3489 ;; "\\[?]")) ; special handling for bare [ at end of re
3490 ;; (braces "\\\\{[0-9,]+\\\\}"))
3491 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3492 ;; "\\|" class "\\|" braces "\\)*\\'"))
3493 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3494 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3499 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3500 "The default value of separators for `split-string'.
3502 A regexp matching strings of whitespace. May be locale-dependent
3503 \(as yet unimplemented). Should not match non-breaking spaces.
3505 Warning: binding this to a different value and using it as default is
3506 likely to have undesired semantics.")
3508 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3509 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3510 ;; expression leads to the equivalent implementation that if SEPARATORS
3511 ;; is defaulted, OMIT-NULLS is treated as t.
3512 (defun split-string (string &optional separators omit-nulls trim)
3513 "Split STRING into substrings bounded by matches for SEPARATORS.
3515 The beginning and end of STRING, and each match for SEPARATORS, are
3516 splitting points. The substrings matching SEPARATORS are removed, and
3517 the substrings between the splitting points are collected as a list,
3520 If SEPARATORS is non-nil, it should be a regular expression matching text
3521 which separates, but is not part of, the substrings. If nil it defaults to
3522 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3523 OMIT-NULLS is forced to t.
3525 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3526 that for the default value of SEPARATORS leading and trailing whitespace
3527 are effectively trimmed). If nil, all zero-length substrings are retained,
3528 which correctly parses CSV format, for example.
3530 If TRIM is non-nil, it should be a regular expression to match
3531 text to trim from the beginning and end of each substring. If trimming
3532 makes the substring empty, it is treated as null.
3534 If you want to trim whitespace from the substrings, the reliably correct
3535 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3536 results when there is whitespace at the start or end of STRING. If you
3537 see such calls to `split-string', please fix them.
3539 Note that the effect of `(split-string STRING)' is the same as
3540 `(split-string STRING split-string-default-separators t)'. In the rare
3541 case that you wish to retain zero-length substrings when splitting on
3542 whitespace, use `(split-string STRING split-string-default-separators)'.
3544 Modifies the match data; use `save-match-data' if necessary."
3545 (let* ((keep-nulls (not (if separators omit-nulls t)))
3546 (rexp (or separators split-string-default-separators))
3552 ;; Push the substring in range THIS-START to THIS-END
3553 ;; onto LIST, trimming it and perhaps discarding it.
3556 ;; Discard the trim from start of this substring.
3557 (let ((tem (string-match trim string this-start)))
3558 (and (eq tem this-start)
3559 (setq this-start (match-end 0)))))
3561 (when (or keep-nulls (< this-start this-end))
3562 (let ((this (substring string this-start this-end)))
3564 ;; Discard the trim from end of this substring.
3566 (let ((tem (string-match (concat trim "\\'") this 0)))
3567 (and tem (< tem (length this))
3568 (setq this (substring this 0 tem)))))
3570 ;; Trimming could make it empty; check again.
3571 (when (or keep-nulls (> (length this) 0))
3572 (push this list)))))))
3574 (while (and (string-match rexp string
3576 (= start (match-beginning 0))
3577 (< start (length string)))
3579 (< start (length string)))
3581 (setq this-start start this-end (match-beginning 0)
3582 start (match-end 0))
3586 ;; Handle the substring at the end of STRING.
3587 (setq this-start start this-end (length string))
3592 (defun combine-and-quote-strings (strings &optional separator)
3593 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3594 This tries to quote the strings to avoid ambiguity such that
3595 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3596 Only some SEPARATORs will work properly."
3597 (let* ((sep (or separator " "))
3598 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3601 (if (string-match re str)
3602 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3606 (defun split-string-and-unquote (string &optional separator)
3607 "Split the STRING into a list of strings.
3608 It understands Emacs Lisp quoting within STRING, such that
3609 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3610 The SEPARATOR regexp defaults to \"\\s-+\"."
3611 (let ((sep (or separator "\\s-+"))
3612 (i (string-match "\"" string)))
3614 (split-string string sep t) ; no quoting: easy
3615 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3616 (let ((rfs (read-from-string string i)))
3618 (split-string-and-unquote (substring string (cdr rfs))
3622 ;;;; Replacement in strings.
3624 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3625 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3626 Unless optional argument INPLACE is non-nil, return a new string."
3627 (let ((i (length string))
3628 (newstr (if inplace string (copy-sequence string))))
3631 (if (eq (aref newstr i) fromchar)
3632 (aset newstr i tochar)))
3635 (defun replace-regexp-in-string (regexp rep string &optional
3636 fixedcase literal subexp start)
3637 "Replace all matches for REGEXP with REP in STRING.
3639 Return a new string containing the replacements.
3641 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3642 arguments with the same names of function `replace-match'. If START
3643 is non-nil, start replacements at that index in STRING.
3645 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3646 function. If it is a function, it is called with the actual text of each
3647 match, and its value is used as the replacement text. When REP is called,
3648 the match data are the result of matching REGEXP against a substring
3651 To replace only the first match (if any), make REGEXP match up to \\'
3652 and replace a sub-expression, e.g.
3653 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3656 ;; To avoid excessive consing from multiple matches in long strings,
3657 ;; don't just call `replace-match' continually. Walk down the
3658 ;; string looking for matches of REGEXP and building up a (reversed)
3659 ;; list MATCHES. This comprises segments of STRING which weren't
3660 ;; matched interspersed with replacements for segments that were.
3661 ;; [For a `large' number of replacements it's more efficient to
3662 ;; operate in a temporary buffer; we can't tell from the function's
3663 ;; args whether to choose the buffer-based implementation, though it
3664 ;; might be reasonable to do so for long enough STRING.]
3665 (let ((l (length string))
3666 (start (or start 0))
3669 (while (and (< start l) (string-match regexp string start))
3670 (setq mb (match-beginning 0)
3672 ;; If we matched the empty string, make sure we advance by one char
3673 (when (= me mb) (setq me (min l (1+ mb))))
3674 ;; Generate a replacement for the matched substring.
3675 ;; Operate only on the substring to minimize string consing.
3676 ;; Set up match data for the substring for replacement;
3677 ;; presumably this is likely to be faster than munging the
3678 ;; match data directly in Lisp.
3679 (string-match regexp (setq str (substring string mb me)))
3681 (cons (replace-match (if (stringp rep)
3683 (funcall rep (match-string 0 str)))
3684 fixedcase literal str subexp)
3685 (cons (substring string start mb) ; unmatched prefix
3688 ;; Reconstruct a string from the pieces.
3689 (setq matches (cons (substring string start l) matches)) ; leftover
3690 (apply #'concat (nreverse matches)))))
3692 (defun string-prefix-p (str1 str2 &optional ignore-case)
3693 "Return non-nil if STR1 is a prefix of STR2.
3694 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3695 to case differences."
3696 (eq t (compare-strings str1 nil nil
3697 str2 0 (length str1) ignore-case)))
3699 (defun string-suffix-p (suffix string &optional ignore-case)
3700 "Return non-nil if SUFFIX is a suffix of STRING.
3701 If IGNORE-CASE is non-nil, the comparison is done without paying
3702 attention to case differences."
3703 (let ((start-pos (- (length string) (length suffix))))
3704 (and (>= start-pos 0)
3705 (eq t (compare-strings suffix nil nil
3706 string start-pos nil ignore-case)))))
3708 (defun bidi-string-mark-left-to-right (str)
3709 "Return a string that can be safely inserted in left-to-right text.
3711 Normally, inserting a string with right-to-left (RTL) script into
3712 a buffer may cause some subsequent text to be displayed as part
3713 of the RTL segment (usually this affects punctuation characters).
3714 This function returns a string which displays as STR but forces
3715 subsequent text to be displayed as left-to-right.
3717 If STR contains any RTL character, this function returns a string
3718 consisting of STR followed by an invisible left-to-right mark
3719 \(LRM) character. Otherwise, it returns STR."
3720 (unless (stringp str)
3721 (signal 'wrong-type-argument (list 'stringp str)))
3722 (if (string-match "\\cR" str)
3723 (concat str (propertize (string ?\x200e) 'invisible t))
3726 ;;;; Specifying things to do later.
3728 (defun load-history-regexp (file)
3729 "Form a regexp to find FILE in `load-history'.
3730 FILE, a string, is described in the function `eval-after-load'."
3731 (if (file-name-absolute-p file)
3732 (setq file (file-truename file)))
3733 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
3735 (if (file-name-extension file)
3737 ;; Note: regexp-opt can't be used here, since we need to call
3738 ;; this before Emacs has been fully started. 2006-05-21
3739 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
3740 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
3743 (defun load-history-filename-element (file-regexp)
3744 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
3745 Return nil if there isn't one."
3746 (let* ((loads load-history)
3747 (load-elt (and loads (car loads))))
3750 (or (null (car load-elt))
3751 (not (string-match file-regexp (car load-elt)))))
3752 (setq loads (cdr loads)
3753 load-elt (and loads (car loads)))))
3756 (put 'eval-after-load 'lisp-indent-function 1)
3757 (defun eval-after-load (file form)
3758 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
3759 If FILE is already loaded, evaluate FORM right now.
3760 FORM can be an Elisp expression (in which case it's passed to `eval'),
3761 or a function (in which case it's passed to `funcall' with no argument).
3763 If a matching file is loaded again, FORM will be evaluated again.
3765 If FILE is a string, it may be either an absolute or a relative file
3766 name, and may have an extension (e.g. \".el\") or may lack one, and
3767 additionally may or may not have an extension denoting a compressed
3768 format (e.g. \".gz\").
3770 When FILE is absolute, this first converts it to a true name by chasing
3771 symbolic links. Only a file of this name (see next paragraph regarding
3772 extensions) will trigger the evaluation of FORM. When FILE is relative,
3773 a file whose absolute true name ends in FILE will trigger evaluation.
3775 When FILE lacks an extension, a file name with any extension will trigger
3776 evaluation. Otherwise, its extension must match FILE's. A further
3777 extension for a compressed format (e.g. \".gz\") on FILE will not affect
3780 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
3781 is evaluated at the end of any file that `provide's this feature.
3782 If the feature is provided when evaluating code not associated with a
3783 file, FORM is evaluated immediately after the provide statement.
3785 Usually FILE is just a library name like \"font-lock\" or a feature name
3788 This function makes or adds to an entry on `after-load-alist'."
3789 (declare (compiler-macro
3791 (if (eq 'quote (car-safe form))
3792 ;; Quote with lambda so the compiler can look inside.
3793 `(eval-after-load ,file (lambda () ,(nth 1 form)))
3795 ;; Add this FORM into after-load-alist (regardless of whether we'll be
3796 ;; evaluating it now).
3797 (let* ((regexp-or-feature
3799 (setq file (purecopy (load-history-regexp file)))
3801 (elt (assoc regexp-or-feature after-load-alist))
3803 (if (functionp form) form
3804 ;; Try to use the "current" lexical/dynamic mode for `form'.
3805 (eval `(lambda () ,form) lexical-binding))))
3807 (setq elt (list regexp-or-feature))
3808 (push elt after-load-alist))
3809 ;; Is there an already loaded file whose name (or `provide' name)
3811 (prog1 (if (if (stringp file)
3812 (load-history-filename-element regexp-or-feature)
3816 (if (not (symbolp regexp-or-feature)) func
3817 ;; For features, the after-load-alist elements get run when
3818 ;; `provide' is called rather than at the end of the file.
3819 ;; So add an indirection to make sure that `func' is really run
3820 ;; "after-load" in case the provide call happens early.
3822 (if (not load-file-name)
3823 ;; Not being provided from a file, run func right now.
3825 (let ((lfn load-file-name)
3826 ;; Don't use letrec, because equal (in
3827 ;; add/remove-hook) would get trapped in a cycle.
3828 (fun (make-symbol "eval-after-load-helper")))
3829 (fset fun (lambda (file)
3830 (when (equal file lfn)
3831 (remove-hook 'after-load-functions fun)
3833 (add-hook 'after-load-functions fun 'append)))))))
3834 ;; Add FORM to the element unless it's already there.
3835 (unless (member delayed-func (cdr elt))
3836 (nconc elt (list delayed-func)))))))
3838 (defmacro with-eval-after-load (file &rest body)
3839 "Execute BODY after FILE is loaded.
3840 FILE is normally a feature name, but it can also be a file name,
3841 in case that file does not provide any feature."
3842 (declare (indent 1) (debug t))
3843 `(eval-after-load ,file (lambda () ,@body)))
3845 (defvar after-load-functions nil
3846 "Special hook run after loading a file.
3847 Each function there is called with a single argument, the absolute
3848 name of the file just loaded.")
3850 (defun do-after-load-evaluation (abs-file)
3851 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
3852 ABS-FILE, a string, should be the absolute true name of a file just loaded.
3853 This function is called directly from the C code."
3854 ;; Run the relevant eval-after-load forms.
3855 (dolist (a-l-element after-load-alist)
3856 (when (and (stringp (car a-l-element))
3857 (string-match-p (car a-l-element) abs-file))
3858 ;; discard the file name regexp
3859 (mapc #'funcall (cdr a-l-element))))
3860 ;; Complain when the user uses obsolete files.
3861 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
3862 ;; Maybe we should just use display-warning? This seems yucky...
3863 (let* ((file (file-name-nondirectory abs-file))
3864 (msg (format "Package %s is obsolete!"
3866 (string-match "\\.elc?\\>" file)))))
3867 ;; Cribbed from cl--compiling-file.
3868 (if (and (boundp 'byte-compile--outbuffer)
3869 (bufferp (symbol-value 'byte-compile--outbuffer))
3870 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
3871 " *Compiler Output*"))
3872 ;; Don't warn about obsolete files using other obsolete files.
3873 (unless (and (stringp byte-compile-current-file)
3874 (string-match-p "/obsolete/[^/]*\\'"
3876 byte-compile-current-file
3877 byte-compile-root-dir)))
3878 (byte-compile-log-warning msg))
3879 (run-with-timer 0 nil
3881 (message "%s" msg)) msg))))
3883 ;; Finally, run any other hook.
3884 (run-hook-with-args 'after-load-functions abs-file))
3886 (defun eval-next-after-load (file)
3887 "Read the following input sexp, and run it whenever FILE is loaded.
3888 This makes or adds to an entry on `after-load-alist'.
3889 FILE should be the name of a library, with no directory name."
3890 (declare (obsolete eval-after-load "23.2"))
3891 (eval-after-load file (read)))
3894 (defun display-delayed-warnings ()
3895 "Display delayed warnings from `delayed-warnings-list'.
3896 Used from `delayed-warnings-hook' (which see)."
3897 (dolist (warning (nreverse delayed-warnings-list))
3898 (apply 'display-warning warning))
3899 (setq delayed-warnings-list nil))
3901 (defun collapse-delayed-warnings ()
3902 "Remove duplicates from `delayed-warnings-list'.
3903 Collapse identical adjacent warnings into one (plus count).
3904 Used from `delayed-warnings-hook' (which see)."
3907 (while delayed-warnings-list
3908 (setq warning (pop delayed-warnings-list))
3909 (if (equal warning (car delayed-warnings-list))
3910 (setq count (1+ count))
3912 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
3915 (push warning collapsed)))
3916 (setq delayed-warnings-list (nreverse collapsed))))
3918 ;; At present this is only used for Emacs internals.
3919 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
3920 (defvar delayed-warnings-hook '(collapse-delayed-warnings
3921 display-delayed-warnings)
3922 "Normal hook run to process and display delayed warnings.
3923 By default, this hook contains functions to consolidate the
3924 warnings listed in `delayed-warnings-list', display them, and set
3925 `delayed-warnings-list' back to nil.")
3927 (defun delay-warning (type message &optional level buffer-name)
3928 "Display a delayed warning.
3929 Aside from going through `delayed-warnings-list', this is equivalent
3930 to `display-warning'."
3931 (push (list type message level buffer-name) delayed-warnings-list))
3934 ;;;; invisibility specs
3936 (defun add-to-invisibility-spec (element)
3937 "Add ELEMENT to `buffer-invisibility-spec'.
3938 See documentation for `buffer-invisibility-spec' for the kind of elements
3940 (if (eq buffer-invisibility-spec t)
3941 (setq buffer-invisibility-spec (list t)))
3942 (setq buffer-invisibility-spec
3943 (cons element buffer-invisibility-spec)))
3945 (defun remove-from-invisibility-spec (element)
3946 "Remove ELEMENT from `buffer-invisibility-spec'."
3947 (if (consp buffer-invisibility-spec)
3948 (setq buffer-invisibility-spec
3949 (delete element buffer-invisibility-spec))))
3953 (defmacro with-syntax-table (table &rest body)
3954 "Evaluate BODY with syntax table of current buffer set to TABLE.
3955 The syntax table of the current buffer is saved, BODY is evaluated, and the
3956 saved table is restored, even in case of an abnormal exit.
3957 Value is what BODY returns."
3958 (declare (debug t) (indent 1))
3959 (let ((old-table (make-symbol "table"))
3960 (old-buffer (make-symbol "buffer")))
3961 `(let ((,old-table (syntax-table))
3962 (,old-buffer (current-buffer)))
3965 (set-syntax-table ,table)
3967 (save-current-buffer
3968 (set-buffer ,old-buffer)
3969 (set-syntax-table ,old-table))))))
3971 (defun make-syntax-table (&optional oldtable)
3972 "Return a new syntax table.
3973 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3974 from `standard-syntax-table' otherwise."
3975 (let ((table (make-char-table 'syntax-table nil)))
3976 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3979 (defun syntax-after (pos)
3980 "Return the raw syntax descriptor for the char after POS.
3981 If POS is outside the buffer's accessible portion, return nil."
3982 (unless (or (< pos (point-min)) (>= pos (point-max)))
3983 (let ((st (if parse-sexp-lookup-properties
3984 (get-char-property pos 'syntax-table))))
3986 (aref (or st (syntax-table)) (char-after pos))))))
3988 (defun syntax-class (syntax)
3989 "Return the code for the syntax class described by SYNTAX.
3991 SYNTAX should be a raw syntax descriptor; the return value is a
3992 integer which encodes the corresponding syntax class. See Info
3993 node `(elisp)Syntax Table Internals' for a list of codes.
3995 If SYNTAX is nil, return nil."
3996 (and syntax (logand (car syntax) 65535)))
3998 ;; Utility motion commands
4002 (defun forward-whitespace (arg)
4003 "Move point to the end of the next sequence of whitespace chars.
4004 Each such sequence may be a single newline, or a sequence of
4005 consecutive space and/or tab characters.
4006 With prefix argument ARG, do it ARG times if positive, or move
4007 backwards ARG times if negative."
4010 (re-search-forward "[ \t]+\\|\n" nil 'move arg)
4012 (if (re-search-backward "[ \t]+\\|\n" nil 'move)
4013 (or (eq (char-after (match-beginning 0)) ?\n)
4014 (skip-chars-backward " \t")))
4015 (setq arg (1+ arg)))))
4019 (defun forward-symbol (arg)
4020 "Move point to the next position that is the end of a symbol.
4021 A symbol is any sequence of characters that are in either the
4022 word constituent or symbol constituent syntax class.
4023 With prefix argument ARG, do it ARG times if positive, or move
4024 backwards ARG times if negative."
4027 (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
4029 (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
4030 (skip-syntax-backward "w_"))
4031 (setq arg (1+ arg)))))
4035 (defun forward-same-syntax (&optional arg)
4036 "Move point past all characters with the same syntax class.
4037 With prefix argument ARG, do it ARG times if positive, or move
4038 backwards ARG times if negative."
4040 (or arg (setq arg 1))
4042 (skip-syntax-backward
4043 (char-to-string (char-syntax (char-before))))
4044 (setq arg (1+ arg)))
4046 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4047 (setq arg (1- arg))))
4052 (defvar text-clone--maintaining nil)
4054 (defun text-clone--maintain (ol1 after beg end &optional _len)
4055 "Propagate the changes made under the overlay OL1 to the other clones.
4056 This is used on the `modification-hooks' property of text clones."
4057 (when (and after (not undo-in-progress)
4058 (not text-clone--maintaining)
4059 (overlay-start ol1))
4060 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4061 (setq beg (max beg (+ (overlay-start ol1) margin)))
4062 (setq end (min end (- (overlay-end ol1) margin)))
4065 (when (overlay-get ol1 'text-clone-syntax)
4066 ;; Check content of the clone's text.
4067 (let ((cbeg (+ (overlay-start ol1) margin))
4068 (cend (- (overlay-end ol1) margin)))
4071 (if (not (re-search-forward
4072 (overlay-get ol1 'text-clone-syntax) cend t))
4073 ;; Mark the overlay for deletion.
4075 (when (< (match-end 0) cend)
4076 ;; Shrink the clone at its end.
4077 (setq end (min end (match-end 0)))
4078 (move-overlay ol1 (overlay-start ol1)
4079 (+ (match-end 0) margin)))
4080 (when (> (match-beginning 0) cbeg)
4081 ;; Shrink the clone at its beginning.
4082 (setq beg (max (match-beginning 0) beg))
4083 (move-overlay ol1 (- (match-beginning 0) margin)
4084 (overlay-end ol1)))))))
4085 ;; Now go ahead and update the clones.
4086 (let ((head (- beg (overlay-start ol1)))
4087 (tail (- (overlay-end ol1) end))
4088 (str (buffer-substring beg end))
4090 (text-clone--maintaining t))
4091 (dolist (ol2 (overlay-get ol1 'text-clones))
4092 (let ((oe (overlay-end ol2)))
4093 (unless (or (eq ol1 ol2) (null oe))
4094 (setq nothing-left nil)
4095 (let ((mod-beg (+ (overlay-start ol2) head)))
4096 ;;(overlay-put ol2 'modification-hooks nil)
4097 (goto-char (- (overlay-end ol2) tail))
4098 (unless (> mod-beg (point))
4099 (save-excursion (insert str))
4100 (delete-region mod-beg (point)))
4101 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4103 (if nothing-left (delete-overlay ol1))))))))
4105 (defun text-clone-create (start end &optional spreadp syntax)
4106 "Create a text clone of START...END at point.
4107 Text clones are chunks of text that are automatically kept identical:
4108 changes done to one of the clones will be immediately propagated to the other.
4110 The buffer's content at point is assumed to be already identical to
4111 the one between START and END.
4112 If SYNTAX is provided it's a regexp that describes the possible text of
4113 the clones; the clone will be shrunk or killed if necessary to ensure that
4114 its text matches the regexp.
4115 If SPREADP is non-nil it indicates that text inserted before/after the
4116 clone should be incorporated in the clone."
4117 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4118 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4119 ;; (with a one-char margin at each end) with `t nil'.
4120 ;; We opted for a larger overlay because it behaves better in the case
4121 ;; where the clone is reduced to the empty string (we want the overlay to
4122 ;; stay when the clone's content is the empty string and we want to use
4123 ;; `evaporate' to make sure those overlays get deleted when needed).
4125 (let* ((pt-end (+ (point) (- end start)))
4126 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4128 (end-margin (if (or (not spreadp)
4129 (>= pt-end (point-max))
4130 (>= start (point-max)))
4132 ;; FIXME: Reuse overlays at point to extend dups!
4133 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4134 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4135 (dups (list ol1 ol2)))
4136 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4137 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4138 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4139 ;;(overlay-put ol1 'face 'underline)
4140 (overlay-put ol1 'evaporate t)
4141 (overlay-put ol1 'text-clones dups)
4143 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4144 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4145 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4146 ;;(overlay-put ol2 'face 'underline)
4147 (overlay-put ol2 'evaporate t)
4148 (overlay-put ol2 'text-clones dups)))
4150 ;;;; Mail user agents.
4152 ;; Here we include just enough for other packages to be able
4155 (defun define-mail-user-agent (symbol composefunc sendfunc
4156 &optional abortfunc hookvar)
4157 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4159 SYMBOL can be any Lisp symbol. Its function definition and/or
4160 value as a variable do not matter for this usage; we use only certain
4161 properties on its property list, to encode the rest of the arguments.
4163 COMPOSEFUNC is program callable function that composes an outgoing
4164 mail message buffer. This function should set up the basics of the
4165 buffer without requiring user interaction. It should populate the
4166 standard mail headers, leaving the `to:' and `subject:' headers blank
4169 COMPOSEFUNC should accept several optional arguments--the same
4170 arguments that `compose-mail' takes. See that function's documentation.
4172 SENDFUNC is the command a user would run to send the message.
4174 Optional ABORTFUNC is the command a user would run to abort the
4175 message. For mail packages that don't have a separate abort function,
4176 this can be `kill-buffer' (the equivalent of omitting this argument).
4178 Optional HOOKVAR is a hook variable that gets run before the message
4179 is actually sent. Callers that use the `mail-user-agent' may
4180 install a hook function temporarily on this hook variable.
4181 If HOOKVAR is nil, `mail-send-hook' is used.
4183 The properties used on SYMBOL are `composefunc', `sendfunc',
4184 `abortfunc', and `hookvar'."
4185 (put symbol 'composefunc composefunc)
4186 (put symbol 'sendfunc sendfunc)
4187 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4188 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4190 (defvar called-interactively-p-functions nil
4191 "Special hook called to skip special frames in `called-interactively-p'.
4192 The functions are called with 3 arguments: (I FRAME1 FRAME2),
4193 where FRAME1 is a \"current frame\", FRAME2 is the next frame,
4194 I is the index of the frame after FRAME2. It should return nil
4195 if those frames don't seem special and otherwise, it should return
4196 the number of frames to skip (minus 1).")
4198 (defconst internal--call-interactively (symbol-function 'call-interactively))
4200 (defun called-interactively-p (&optional kind)
4201 "Return t if the containing function was called by `call-interactively'.
4202 If KIND is `interactive', then only return t if the call was made
4203 interactively by the user, i.e. not in `noninteractive' mode nor
4204 when `executing-kbd-macro'.
4205 If KIND is `any', on the other hand, it will return t for any kind of
4206 interactive call, including being called as the binding of a key or
4207 from a keyboard macro, even in `noninteractive' mode.
4209 This function is very brittle, it may fail to return the intended result when
4210 the code is debugged, advised, or instrumented in some form. Some macros and
4211 special forms (such as `condition-case') may also sometimes wrap their bodies
4212 in a `lambda', so any call to `called-interactively-p' from those bodies will
4213 indicate whether that lambda (rather than the surrounding function) was called
4216 Instead of using this function, it is cleaner and more reliable to give your
4217 function an extra optional argument whose `interactive' spec specifies
4218 non-nil unconditionally (\"p\" is a good way to do this), or via
4219 \(not (or executing-kbd-macro noninteractive)).
4221 The only known proper use of `interactive' for KIND is in deciding
4222 whether to display a helpful message, or how to display it. If you're
4223 thinking of using it for any other purpose, it is quite likely that
4224 you're making a mistake. Think: what do you want to do when the
4225 command is called from a keyboard macro?"
4226 (declare (advertised-calling-convention (kind) "23.1"))
4227 (when (not (and (eq kind 'interactive)
4228 (or executing-kbd-macro noninteractive)))
4229 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4233 (setq frame nextframe)
4234 (setq nextframe (backtrace-frame i 'called-interactively-p))
4235 ;; (message "Frame %d = %S" i nextframe)
4237 (funcall get-next-frame) ;; Get the first frame.
4239 ;; FIXME: The edebug and advice handling should be made modular and
4240 ;; provided directly by edebug.el and nadvice.el.
4242 ;; frame =(backtrace-frame i-2)
4243 ;; nextframe=(backtrace-frame i-1)
4244 (funcall get-next-frame)
4245 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4246 ;; branches within local functions, which then messes up the
4247 ;; `backtrace-frame' data we get,
4249 ;; Skip special forms (from non-compiled code).
4250 (and frame (null (car frame)))
4251 ;; Skip also `interactive-p' (because we don't want to know if
4252 ;; interactive-p was called interactively but if it's caller was)
4253 ;; and `byte-code' (idem; this appears in subexpressions of things
4254 ;; like condition-case, which are wrapped in a separate bytecode
4256 ;; FIXME: For lexical-binding code, this is much worse,
4257 ;; because the frames look like "byte-code -> funcall -> #[...]",
4258 ;; which is not a reliable signature.
4259 (memq (nth 1 frame) '(interactive-p 'byte-code))
4260 ;; Skip package-specific stack-frames.
4261 (let ((skip (run-hook-with-args-until-success
4262 'called-interactively-p-functions
4263 i frame nextframe)))
4267 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4268 ;; Now `frame' should be "the function from which we were called".
4269 (pcase (cons frame nextframe)
4270 ;; No subr calls `interactive-p', so we can rule that out.
4271 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
4272 ;; In case #<subr call-interactively> without going through the
4273 ;; `call-interactively' symbol (bug#3984).
4274 (`(,_ . (t ,(pred (eq internal--call-interactively)) . ,_)) t)
4275 (`(,_ . (t call-interactively . ,_)) t)))))
4277 (defun interactive-p ()
4278 "Return t if the containing function was run directly by user input.
4279 This means that the function was called with `call-interactively'
4280 \(which includes being called as the binding of a key)
4281 and input is currently coming from the keyboard (not a keyboard macro),
4282 and Emacs is not running in batch mode (`noninteractive' is nil).
4284 The only known proper use of `interactive-p' is in deciding whether to
4285 display a helpful message, or how to display it. If you're thinking
4286 of using it for any other purpose, it is quite likely that you're
4287 making a mistake. Think: what do you want to do when the command is
4288 called from a keyboard macro or in batch mode?
4290 To test whether your function was called with `call-interactively',
4291 either (i) add an extra optional argument and give it an `interactive'
4292 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
4293 use `called-interactively-p'."
4294 (declare (obsolete called-interactively-p "23.2"))
4295 (called-interactively-p 'interactive))
4297 (defun internal-push-keymap (keymap symbol)
4298 (let ((map (symbol-value symbol)))
4299 (unless (memq keymap map)
4300 (unless (memq 'add-keymap-witness (symbol-value symbol))
4301 (setq map (make-composed-keymap nil (symbol-value symbol)))
4302 (push 'add-keymap-witness (cdr map))
4304 (push keymap (cdr map)))))
4306 (defun internal-pop-keymap (keymap symbol)
4307 (let ((map (symbol-value symbol)))
4308 (when (memq keymap map)
4309 (setf (cdr map) (delq keymap (cdr map))))
4310 (let ((tail (cddr map)))
4311 (and (or (null tail) (keymapp tail))
4312 (eq 'add-keymap-witness (nth 1 map))
4313 (set symbol tail)))))
4315 (define-obsolete-function-alias
4316 'set-temporary-overlay-map 'set-transient-map "24.4")
4318 (defun set-transient-map (map &optional keep-pred on-exit)
4319 "Set MAP as a temporary keymap taking precedence over other keymaps.
4320 Normally, MAP is used only once, to look up the very next key.
4321 However, if the optional argument KEEP-PRED is t, MAP stays
4322 active if a key from MAP is used. KEEP-PRED can also be a
4323 function of no arguments: if it returns non-nil, then MAP stays
4326 Optional arg ON-EXIT, if non-nil, specifies a function that is
4327 called, with no arguments, after MAP is deactivated.
4329 This uses `overriding-terminal-local-map' which takes precedence over all other
4330 keymaps. As usual, if no match for a key is found in MAP, the normal key
4331 lookup sequence then continues."
4332 (let ((clearfun (make-symbol "clear-transient-map")))
4333 ;; Don't use letrec, because equal (in add/remove-hook) would get trapped
4337 (with-demoted-errors "set-transient-map PCH: %S"
4339 ((null keep-pred) nil)
4340 ((not (eq map (cadr overriding-terminal-local-map)))
4341 ;; There's presumably some other transient-map in
4342 ;; effect. Wait for that one to terminate before we
4343 ;; remove ourselves.
4344 ;; For example, if isearch and C-u both use transient
4345 ;; maps, then the lifetime of the C-u should be nested
4346 ;; within isearch's, so the pre-command-hook of
4347 ;; isearch should be suspended during the C-u one so
4348 ;; we don't exit isearch just because we hit 1 after
4349 ;; C-u and that 1 exits isearch whereas it doesn't
4354 (lookup-key map (this-command-keys-vector))))
4355 (t (funcall keep-pred)))
4356 (internal-pop-keymap map 'overriding-terminal-local-map)
4357 (remove-hook 'pre-command-hook clearfun)
4358 (when on-exit (funcall on-exit))))))
4359 (add-hook 'pre-command-hook clearfun)
4360 (internal-push-keymap map 'overriding-terminal-local-map)))
4362 ;;;; Progress reporters.
4364 ;; Progress reporter has the following structure:
4366 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4373 ;; This weirdness is for optimization reasons: we want
4374 ;; `progress-reporter-update' to be as fast as possible, so
4375 ;; `(car reporter)' is better than `(aref reporter 0)'.
4377 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4378 ;; digits of precision, it doesn't really matter here. On the other
4379 ;; hand, it greatly simplifies the code.
4381 (defsubst progress-reporter-update (reporter &optional value)
4382 "Report progress of an operation in the echo area.
4383 REPORTER should be the result of a call to `make-progress-reporter'.
4385 If REPORTER is a numerical progress reporter---i.e. if it was
4386 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4387 `make-progress-reporter'---then VALUE should be a number between
4388 MIN-VALUE and MAX-VALUE.
4390 If REPORTER is a non-numerical reporter, VALUE should be nil.
4392 This function is relatively inexpensive. If the change since
4393 last update is too small or insufficient time has passed, it does
4395 (when (or (not (numberp value)) ; For pulsing reporter
4396 (>= value (car reporter))) ; For numerical reporter
4397 (progress-reporter-do-update reporter value)))
4399 (defun make-progress-reporter (message &optional min-value max-value
4400 current-value min-change min-time)
4401 "Return progress reporter object for use with `progress-reporter-update'.
4403 MESSAGE is shown in the echo area, with a status indicator
4404 appended to the end. When you call `progress-reporter-done', the
4405 word \"done\" is printed after the MESSAGE. You can change the
4406 MESSAGE of an existing progress reporter by calling
4407 `progress-reporter-force-update'.
4409 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4410 and final (100% complete) states of operation; the latter should
4411 be larger. In this case, the status message shows the percentage
4414 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4415 message shows a \"spinning\", non-numeric indicator.
4417 Optional CURRENT-VALUE is the initial progress; the default is
4419 Optional MIN-CHANGE is the minimal change in percents to report;
4421 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4422 and/or MAX-VALUE are nil.
4424 Optional MIN-TIME specifies the minimum interval time between
4425 echo area updates (default is 0.2 seconds.) If the function
4426 `float-time' is not present, time is not tracked at all. If the
4427 OS is not capable of measuring fractions of seconds, this
4428 parameter is effectively rounded up."
4429 (when (string-match "[[:alnum:]]\\'" message)
4430 (setq message (concat message "...")))
4432 (setq min-time 0.2))
4434 ;; Force a call to `message' now
4435 (cons (or min-value 0)
4436 (vector (if (and (fboundp 'float-time)
4442 (if min-change (max (min min-change 50) 1) 1)
4444 (progress-reporter-update reporter (or current-value min-value))
4447 (defun progress-reporter-force-update (reporter &optional value new-message)
4448 "Report progress of an operation in the echo area unconditionally.
4450 The first two arguments are the same as in `progress-reporter-update'.
4451 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4452 (let ((parameters (cdr reporter)))
4454 (aset parameters 3 new-message))
4455 (when (aref parameters 0)
4456 (aset parameters 0 (float-time)))
4457 (progress-reporter-do-update reporter value)))
4459 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4460 "Characters to use for pulsing progress reporters.")
4462 (defun progress-reporter-do-update (reporter value)
4463 (let* ((parameters (cdr reporter))
4464 (update-time (aref parameters 0))
4465 (min-value (aref parameters 1))
4466 (max-value (aref parameters 2))
4467 (text (aref parameters 3))
4468 (current-time (float-time))
4470 ;; See if enough time has passed since the last update.
4471 (or (not update-time)
4472 (when (>= current-time update-time)
4473 ;; Calculate time for the next update
4474 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4475 (cond ((and min-value max-value)
4476 ;; Numerical indicator
4477 (let* ((one-percent (/ (- max-value min-value) 100.0))
4478 (percentage (if (= max-value min-value)
4480 (truncate (/ (- value min-value)
4482 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4483 ;; message because not enough time has passed, use 1
4484 ;; instead of MIN-CHANGE. This makes delays between echo
4485 ;; area updates closer to MIN-TIME.
4487 (min (+ min-value (* (+ percentage
4488 (if enough-time-passed
4494 (when (integerp value)
4495 (setcar reporter (ceiling (car reporter))))
4496 ;; Only print message if enough time has passed
4497 (when enough-time-passed
4498 (if (> percentage 0)
4499 (message "%s%d%%" text percentage)
4500 (message "%s" text)))))
4501 ;; Pulsing indicator
4503 (let ((index (mod (1+ (car reporter)) 4))
4504 (message-log-max nil))
4505 (setcar reporter index)
4508 (aref progress-reporter--pulse-characters
4511 (defun progress-reporter-done (reporter)
4512 "Print reporter's message followed by word \"done\" in echo area."
4513 (message "%sdone" (aref (cdr reporter) 3)))
4515 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4516 "Loop a certain number of times and report progress in the echo area.
4517 Evaluate BODY with VAR bound to successive integers running from
4518 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4519 the return value (nil if RESULT is omitted).
4521 At each iteration MESSAGE followed by progress percentage is
4522 printed in the echo area. After the loop is finished, MESSAGE
4523 followed by word \"done\" is printed. This macro is a
4524 convenience wrapper around `make-progress-reporter' and friends.
4526 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4527 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4528 (let ((temp (make-symbol "--dotimes-temp--"))
4529 (temp2 (make-symbol "--dotimes-temp2--"))
4533 (,(car spec) ,start)
4534 (,temp2 (make-progress-reporter ,message ,start ,end)))
4535 (while (< ,(car spec) ,temp)
4537 (progress-reporter-update ,temp2
4538 (setq ,(car spec) (1+ ,(car spec)))))
4539 (progress-reporter-done ,temp2)
4540 nil ,@(cdr (cdr spec)))))
4543 ;;;; Comparing version strings.
4545 (defconst version-separator "."
4546 "Specify the string used to separate the version elements.
4548 Usually the separator is \".\", but it can be any other string.")
4551 (defconst version-regexp-alist
4552 '(("^[-_+ ]?snapshot$" . -4)
4553 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4555 ;; treat "1.2.3-CVS" as snapshot release
4556 ("^[-_+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4)
4557 ("^[-_+ ]?alpha$" . -3)
4558 ("^[-_+ ]?beta$" . -2)
4559 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
4560 "Specify association between non-numeric version and its priority.
4562 This association is used to handle version string like \"1.0pre2\",
4563 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4564 non-numeric part of a version string to an integer. For example:
4566 String Version Integer List Version
4567 \"0.9snapshot\" (0 9 -4)
4568 \"1.0-git\" (1 0 -4)
4569 \"1.0pre2\" (1 0 -1 2)
4570 \"1.0PRE2\" (1 0 -1 2)
4571 \"22.8beta3\" (22 8 -2 3)
4572 \"22.8 Beta3\" (22 8 -2 3)
4573 \"0.9alpha1\" (0 9 -3 1)
4574 \"0.9AlphA1\" (0 9 -3 1)
4575 \"0.9 alpha\" (0 9 -3)
4577 Each element has the following form:
4583 REGEXP regexp used to match non-numeric part of a version string.
4584 It should begin with the `^' anchor and end with a `$' to
4585 prevent false hits. Letter-case is ignored while matching
4588 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4591 (defun version-to-list (ver)
4592 "Convert version string VER into a list of integers.
4594 The version syntax is given by the following EBNF:
4596 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4598 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4600 SEPARATOR ::= `version-separator' (which see)
4601 | `version-regexp-alist' (which see).
4603 The NUMBER part is optional if SEPARATOR is a match for an element
4604 in `version-regexp-alist'.
4606 Examples of valid version syntax:
4608 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4610 Examples of invalid version syntax:
4612 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4614 Examples of version conversion:
4616 Version String Version as a List of Integers
4617 \"1.0.7.5\" (1 0 7 5)
4618 \"1.0pre2\" (1 0 -1 2)
4619 \"1.0PRE2\" (1 0 -1 2)
4620 \"22.8beta3\" (22 8 -2 3)
4621 \"22.8Beta3\" (22 8 -2 3)
4622 \"0.9alpha1\" (0 9 -3 1)
4623 \"0.9AlphA1\" (0 9 -3 1)
4624 \"0.9alpha\" (0 9 -3)
4625 \"0.9snapshot\" (0 9 -4)
4626 \"1.0-git\" (1 0 -4)
4628 See documentation for `version-separator' and `version-regexp-alist'."
4629 (or (and (stringp ver) (> (length ver) 0))
4630 (error "Invalid version string: '%s'" ver))
4631 ;; Change .x.y to 0.x.y
4632 (if (and (>= (length ver) (length version-separator))
4633 (string-equal (substring ver 0 (length version-separator))
4635 (setq ver (concat "0" ver)))
4638 (case-fold-search t) ; ignore case in matching
4640 (while (and (setq s (string-match "[0-9]+" ver i))
4642 ;; handle numeric part
4643 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4646 ;; handle non-numeric part
4647 (when (and (setq s (string-match "[^0-9]+" ver i))
4649 (setq s (substring ver i (match-end 0))
4651 ;; handle alpha, beta, pre, etc. separator
4652 (unless (string= s version-separator)
4653 (setq al version-regexp-alist)
4654 (while (and al (not (string-match (caar al) s)))
4657 (push (cdar al) lst))
4658 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4659 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4660 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4662 (t (error "Invalid version syntax: '%s'" ver))))))
4664 (error "Invalid version syntax: '%s'" ver)
4668 (defun version-list-< (l1 l2)
4669 "Return t if L1, a list specification of a version, is lower than L2.
4671 Note that a version specified by the list (1) is equal to (1 0),
4672 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4673 Also, a version given by the list (1) is higher than (1 -1), which in
4674 turn is higher than (1 -2), which is higher than (1 -3)."
4675 (while (and l1 l2 (= (car l1) (car l2)))
4679 ;; l1 not null and l2 not null
4680 ((and l1 l2) (< (car l1) (car l2)))
4681 ;; l1 null and l2 null ==> l1 length = l2 length
4682 ((and (null l1) (null l2)) nil)
4683 ;; l1 not null and l2 null ==> l1 length > l2 length
4684 (l1 (< (version-list-not-zero l1) 0))
4685 ;; l1 null and l2 not null ==> l2 length > l1 length
4686 (t (< 0 (version-list-not-zero l2)))))
4689 (defun version-list-= (l1 l2)
4690 "Return t if L1, a list specification of a version, is equal to L2.
4692 Note that a version specified by the list (1) is equal to (1 0),
4693 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4694 Also, a version given by the list (1) is higher than (1 -1), which in
4695 turn is higher than (1 -2), which is higher than (1 -3)."
4696 (while (and l1 l2 (= (car l1) (car l2)))
4700 ;; l1 not null and l2 not null
4702 ;; l1 null and l2 null ==> l1 length = l2 length
4703 ((and (null l1) (null l2)))
4704 ;; l1 not null and l2 null ==> l1 length > l2 length
4705 (l1 (zerop (version-list-not-zero l1)))
4706 ;; l1 null and l2 not null ==> l2 length > l1 length
4707 (t (zerop (version-list-not-zero l2)))))
4710 (defun version-list-<= (l1 l2)
4711 "Return t if L1, a list specification of a version, is lower or equal to L2.
4713 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4714 etc. That is, the trailing zeroes are insignificant. Also, integer
4715 list (1) is greater than (1 -1) which is greater than (1 -2)
4716 which is greater than (1 -3)."
4717 (while (and l1 l2 (= (car l1) (car l2)))
4721 ;; l1 not null and l2 not null
4722 ((and l1 l2) (< (car l1) (car l2)))
4723 ;; l1 null and l2 null ==> l1 length = l2 length
4724 ((and (null l1) (null l2)))
4725 ;; l1 not null and l2 null ==> l1 length > l2 length
4726 (l1 (<= (version-list-not-zero l1) 0))
4727 ;; l1 null and l2 not null ==> l2 length > l1 length
4728 (t (<= 0 (version-list-not-zero l2)))))
4730 (defun version-list-not-zero (lst)
4731 "Return the first non-zero element of LST, which is a list of integers.
4733 If all LST elements are zeros or LST is nil, return zero."
4734 (while (and lst (zerop (car lst)))
4735 (setq lst (cdr lst)))
4738 ;; there is no element different of zero
4742 (defun version< (v1 v2)
4743 "Return t if version V1 is lower (older) than V2.
4745 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4746 etc. That is, the trailing \".0\"s are insignificant. Also, version
4747 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4748 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4749 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4750 (version-list-< (version-to-list v1) (version-to-list v2)))
4752 (defun version<= (v1 v2)
4753 "Return t if version V1 is lower (older) than or equal to V2.
4755 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4756 etc. That is, the trailing \".0\"s are insignificant. Also, version
4757 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4758 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4759 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4760 (version-list-<= (version-to-list v1) (version-to-list v2)))
4762 (defun version= (v1 v2)
4763 "Return t if version V1 is equal to V2.
4765 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4766 etc. That is, the trailing \".0\"s are insignificant. Also, version
4767 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4768 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4769 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4770 (version-list-= (version-to-list v1) (version-to-list v2)))
4774 (defconst menu-bar-separator '("--")
4775 "Separator for menus.")
4777 ;; The following statement ought to be in print.c, but `provide' can't
4779 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4780 (when (hash-table-p (car (read-from-string
4781 (prin1-to-string (make-hash-table)))))
4782 (provide 'hashtable-print-readable))
4784 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
4785 ;; generate file names for autoloads, custom-deps, and finder-data.
4786 (defun unmsys--file-name (file)
4787 "Produce the canonical file name for FILE from its MSYS form.
4789 On systems other than MS-Windows, just returns FILE.
4790 On MS-Windows, converts /d/foo/bar form of file names
4791 passed by MSYS Make into d:/foo/bar that Emacs can grok.
4793 This function is called from lisp/Makefile and leim/Makefile."
4794 (when (and (eq system-type 'windows-nt)
4795 (string-match "\\`/[a-zA-Z]/" file))
4796 (setq file (concat (substring file 1 2) ":" (substring file 2))))
4800 ;;; subr.el ends here