| blob | 79ae1f4830d880512e635cdf18dde2f22fac4388 |
1 ;;; subr.el --- basic lisp subroutines for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2017 Free Software
4 ;; Foundation, Inc.
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
25 ;; Beware: while this file has tag `utf-8', before it's compiled, it gets
26 ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
29 ;; declare-function's args use &rest, not &optional, for compatibility
30 ;; with byte-compile-macroexpand-declare-function.
33 "Tell the byte-compiler that function FN is defined, in FILE.
34 The FILE argument is not used by the byte-compiler, but by the
35 `check-declare' package, which checks that FILE contains a
36 definition for FN.
39 extension is optional), or a C file. C files are expanded
41 searched for using `locate-library', and if that fails they are
42 expanded relative to the location of the file containing the
44 `check-declare' will check such files if they are found, and skip
45 them without error if they are not.
47 Optional ARGLIST specifies FN's arguments, or is t to not specify
48 FN's arguments. An omitted ARGLIST defaults to t, not nil: a nil
49 ARGLIST specifies an empty argument list, and an explicit t
50 ARGLIST is a placeholder that allows supplying a later arg.
52 Optional FILEONLY non-nil means that `check-declare' will check
53 only that FILE exists, not that it defines FN. This is intended
54 for function definitions that `check-declare' does not recognize,
55 e.g., `defstruct'.
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'."
63 ;; Does nothing - byte-compile-declare-function does the work.
64 nil)
66 \f
67 ;;;; Basic Lisp macros.
73 "Evaluate FORM, expecting it not to return.
74 If FORM does return, signal an error."
80 "Evaluate FORM, expecting a constant return value.
81 This is the global do-nothing version. There is also `testcover-1value'
82 that complains if FORM ever does return differing values."
84 form)
87 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
88 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
89 0 (instrument no arguments); t (instrument all arguments);
90 a symbol (naming a function with an Edebug specification); or a list.
91 The elements of the list describe the argument types; see
92 Info node `(elisp)Specification List' for details."
96 "Return a lambda expression.
97 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
98 self-quoting; the result of evaluating the lambda expression is the
99 expression itself. The lambda expression may then be treated as a
100 function, i.e., stored as the function value of a symbol, passed to
101 `funcall' or `mapcar', etc.
103 ARGS should take the same form as an argument list for a `defun'.
104 DOCSTRING is an optional documentation string.
105 If present, it should describe how to call the function.
106 But documentation strings are usually not useful in nameless functions.
107 INTERACTIVE should be a call to the function `interactive', which see.
108 It may also be omitted.
109 BODY should be a list of Lisp expressions.
111 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
116 def-body)))
117 ;; Note that this definition should not use backquotes; subr.el should not
118 ;; depend on backquote.el.
122 "Set variable VAR to value VAL in current buffer."
123 ;; Can't use backquote here, it's too early in the bootstrap.
128 "Define VAR as a buffer-local variable with default value VAL.
129 Like `defvar' but additionally marks the variable as being automatically
130 buffer-local wherever it is set."
132 ;; Can't use backquote here, it's too early in the bootstrap.
137 "Add NEWELT to the list stored in the generalized variable PLACE.
138 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
139 except that PLACE is only evaluated once (after NEWELT)."
142 ;; Important special case, to avoid triggering GV too early in
143 ;; the bootstrap.
152 "Return the first element of PLACE's value, and remove it from the list.
153 PLACE must be a generalized variable whose value is a list.
154 If the value is nil, `pop' returns nil but does not actually
155 change the list."
157 ;; We use `car-safe' here instead of `car' because the behavior is the same
158 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
159 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
160 ;; result is not used.
163 ;; So we can use `pop' in the bootstrap before `gv' can be used.
170 "If COND yields non-nil, do BODY, else return nil.
171 When COND yields non-nil, eval BODY forms sequentially and return
172 value of last one, or nil if there are none.
174 \(fn COND BODY...)"
179 "If COND yields nil, do BODY, else return nil.
180 When COND yields nil, eval BODY forms sequentially and return
181 value of last one, or nil if there are none.
183 \(fn COND BODY...)"
188 "Loop over a list.
189 Evaluate BODY with VAR bound to each car from LIST, in turn.
190 Then evaluate RESULT to get return value, default nil.
192 \(fn (VAR LIST [RESULT]) 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
200 ;; use dolist.
201 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
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.
211 ,@body
218 ,@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...)"
231 ;; It would be cleaner to create an uninterned symbol,
232 ;; but that uses a lot more space when many functions in many files
233 ;; use dotimes.
234 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
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.
250 ;; FIXME: This let often leads to "unused var" warnings.
255 ,@body
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'.
269 For more information, see info node `(elisp)Declare Form'."
270 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
271 nil)
274 "Execute BODY; if an error occurs, return nil.
275 Otherwise, return result of last form in BODY.
276 See also `with-demoted-errors' that does something similar
277 without silencing all errors."
280 \f
281 ;;;; Basic Lisp functions.
287 "Return a new uninterned symbol.
288 The name is made by appending `gensym-counter' to PREFIX.
295 "Do nothing and return nil.
296 This function accepts any number of arguments, but ignores them."
298 nil)
300 ;; Signal a compile-error if the first arg is missing.
302 "Signal an error, making a message by passing args to `format-message'.
303 In Emacs, the convention is that error messages start with a capital
304 letter but *do not* end with a period. Please follow this convention
305 for the sake of consistency.
313 "Signal a pilot error, making a message by passing args to `format-message'.
314 In Emacs, the convention is that error messages start with a capital
315 letter but *do not* end with a period. Please follow this convention
316 for the sake of consistency.
317 This is just like `error' except that `user-error's are expected to be the
318 result of an incorrect manipulation on the part of the user, rather than the
319 result of an actual problem.
326 "Define NAME as a new error signal.
327 MESSAGE is a string that will be output to the echo area if such an error
328 is signaled without being caught by a `condition-case'.
329 PARENT is either a signal or a list of signals from which it inherits.
330 Defaults to `error'."
339 parent))
345 ;; We put this here instead of in frame.el so that it's defined even on
346 ;; systems where frame.el isn't loaded.
348 "Return non-nil if OBJECT seems to be a frame configuration.
349 Any list whose car is `frame-configuration' is assumed to be a frame
350 configuration."
355 "Return a function that is a partial application of FUN to ARGS.
356 ARGS is a list of the first N arguments to pass to FUN.
357 The result is a new function which does the same as FUN, except that
358 the first N arguments are fixed at the values with which this function
359 was called."
363 \f
364 ;;;; List functions.
366 ;; Note: `internal--compiler-macro-cXXr' was copied from
367 ;; `cl--compiler-macro-cXXr' in cl-macs.el. If you amend either one,
368 ;; you may want to amend the other, too.
376 x)
381 x)))
384 "Return the car of the car of X."
389 "Return the car of the cdr of X."
394 "Return the cdr of the car of X."
399 "Return the cdr of the cdr of X."
404 "Return the `car' of the `car' of the `car' of X."
409 "Return the `car' of the `car' of the `cdr' of X."
414 "Return the `car' of the `cdr' of the `car' of X."
419 "Return the `car' of the `cdr' of the `cdr' of X."
424 "Return the `cdr' of the `car' of the `car' of X."
429 "Return the `cdr' of the `car' of the `cdr' of X."
434 "Return the `cdr' of the `cdr' of the `car' of X."
439 "Return the `cdr' of the `cdr' of the `cdr' of X."
444 "Return the `car' of the `car' of the `car' of the `car' of X."
449 "Return the `car' of the `car' of the `car' of the `cdr' of X."
454 "Return the `car' of the `car' of the `cdr' of the `car' of X."
459 "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
464 "Return the `car' of the `cdr' of the `car' of the `car' of X."
469 "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
474 "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
479 "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
484 "Return the `cdr' of the `car' of the `car' of the `car' of X."
489 "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
494 "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
499 "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
504 "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
509 "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
514 "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
519 "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
524 "Return the last link of LIST. Its car is the last element.
525 If LIST is nil, return nil.
526 If N is non-nil, return the Nth-to-last link of LIST.
527 If N is bigger than the length of LIST, return LIST."
536 "Return a copy of LIST with the last N elements removed.
537 If N is omitted or nil, the last element is removed from the
538 copy."
543 "Modifies LIST to remove the last N elements.
544 If N is omitted or nil, remove the last element."
550 list))))
553 "Return t if NUMBER is zero."
554 ;; Used to be in C, but it's pointless since (= 0 n) is faster anyway because
555 ;; = has a byte-code.
560 "Destructively remove `equal' duplicates from LIST.
561 Store the result in LIST and return it. LIST must be a proper list.
562 Of several `equal' occurrences of an element in LIST, the first
563 one is kept."
579 list)
581 ;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html
583 "Destructively remove `equal' consecutive duplicates from LIST.
584 First and last elements are considered consecutive if CIRCULAR is
585 non-nil."
593 last
596 list)
599 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
600 INC is the increment used between numbers in the sequence and defaults to 1.
601 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
602 zero. TO is only included if there is an N for which TO = FROM + N * INC.
603 If TO is nil or numerically equal to FROM, return (FROM).
604 If INC is positive and TO is less than FROM, or INC is negative
605 and TO is larger than FROM, return nil.
606 If INC is zero and TO is neither nil nor numerically equal to
607 FROM, signal an error.
609 This function is primarily designed for integer arguments.
610 Nevertheless, FROM, TO and INC can be integer or float. However,
611 floating point arithmetic is inexact. For instance, depending on
612 the machine, it may quite well happen that
613 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
614 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
615 elements. Thus, if some of the arguments are floats and one wants
616 to make sure that TO is included, one may have to explicitly write
617 TO as (+ FROM (* N INC)) or use a variable whose value was
618 computed with this exact expression. Alternatively, you can,
619 of course, also replace TO with a slightly larger value
620 \(or a slightly more negative value if INC is negative)."
627 ;; The (>= next last) condition protects against integer
628 ;; overflow in computing NEXT.
632 last next
641 "Make a copy of TREE.
642 If TREE is a cons cell, this recursively copies both its car and its cdr.
643 Contrast to `copy-sequence', which copies only along the cdrs. With second
644 argument VECP, this copies vectors as well as conses."
659 tree)
660 tree)))
661 \f
662 ;;;; Various list-search functions.
665 "Find object KEY in a pseudo-alist ALIST.
666 ALIST is a list of conses or objects. Each element
667 (or the element's car, if it is a cons) is compared with KEY by
668 calling TEST, with two arguments: (i) the element or its car,
669 and (ii) KEY.
670 If that is non-nil, the element matches; then `assoc-default'
671 returns the element's cdr, if it is a cons, or DEFAULT if the
672 element is not a cons.
674 If no element matches, the value is nil.
675 If TEST is omitted or nil, `equal' is used."
682 value))
685 "Like `assoc', but ignores differences in case and text representation.
686 KEY must be a string. Upper-case and lower-case letters are treated as equal.
687 Unibyte strings are converted to multibyte for comparison."
692 "Like `assoc', but ignores differences in text representation.
693 KEY must be a string.
694 Unibyte strings are converted to multibyte for comparison."
699 "Like `member', but ignore differences in case and text representation.
700 ELT must be a string. Upper-case and lower-case letters are treated as equal.
701 Unibyte strings are converted to multibyte for comparison.
702 Non-strings in LIST are ignored."
707 list)
710 "Delete from ALIST all elements whose car is `eq' to KEY.
711 Return the modified alist.
712 Elements of ALIST that are not conses are ignored."
722 alist)
725 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
726 Return the modified alist.
727 Elements of ALIST that are not conses are ignored."
737 alist)
740 "Return the value associated with KEY in ALIST.
741 If KEY is not found in ALIST, return DEFAULT.
742 Use TESTFN to lookup in the alist if non-nil. Otherwise, use `assq'.
744 This is a generalized variable suitable for use with `setf'.
745 When using it to set a value, optional argument REMOVE non-nil
746 means to remove KEY from ALIST if the new value is `eql' to DEFAULT."
754 "Return a copy of SEQ with all occurrences of ELT removed.
755 SEQ must be a list, vector, or string. The comparison is done with `equal'."
757 ;; If SEQ isn't a list, there's no need to copy SEQ because
758 ;; `delete' will return a new object.
763 "Return LIST with all occurrences of ELT removed.
764 The comparison is done with `eq'. Contrary to `delq', this does not use
765 side-effects, and the argument LIST is not modified."
769 list))
770 \f
771 ;;;; Keymap support.
774 "Convert KEYS to the internal Emacs key representation.
775 KEYS should be a string in the format returned by commands such
776 as `C-h k' (`describe-key').
777 This is the same format used for saving keyboard macros (see
778 `edmacro-mode')."
779 ;; Don't use a defalias, since the `pure' property is only true for
780 ;; the calling convention of `kbd'.
785 "Beep to tell the user this binding is undefined."
791 ;; If this is a down-mouse event, don't reset prefix-arg;
792 ;; pass it to the command run by the up event.
795 current-prefix-arg)))
797 ;; Prevent the \{...} documentation construct
798 ;; from mentioning keys that run this command.
802 "Make MAP override all normally self-inserting keys to be undefined.
803 Normally, as an exception, digits and minus-sign are set to make prefix args,
804 but optional second arg NODIGITS non-nil treats them like other chars."
809 ;; Make plain numbers do numeric args.
816 "Construct a new keymap composed of MAPS and inheriting from PARENT.
817 When looking up a key in the returned map, the key is looked in each
818 keymap of MAPS in turn until a binding is found.
819 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
820 As always with keymap inheritance, a nil binding in MAPS overrides
821 any corresponding binding in PARENT, but it does not override corresponding
822 bindings in other keymaps of MAPS.
823 MAPS can be a list of keymaps or a single keymap.
824 PARENT if non-nil should be a keymap."
830 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
831 This is like `define-key' except that the binding for KEY is placed
832 just after the binding for the event AFTER, instead of at the beginning
833 of the map. Note that AFTER must be an event type (like KEY), NOT a command
834 \(like DEFINITION).
836 If AFTER is t or omitted, the new binding goes at the end of the keymap.
837 AFTER should be a single event type--a symbol or a character, not a sequence.
839 Bindings are always added before any inherited map.
841 The order of bindings in a keymap only matters when it is used as
842 a menu, so this function is not useful for non-menu keymaps."
854 ;; Delete any earlier bindings for the same key.
857 ;; If we hit an included map, go down that one.
859 ;; When we reach AFTER's binding, insert the new binding after.
860 ;; If we reach an inherited keymap, insert just before that.
861 ;; If we reach the end of this keymap, insert at the end.
867 ;; Stop the scan only if we find a parent keymap.
868 ;; Keep going past the inserted element
869 ;; so we can delete any duplications that come later.
872 ;; Don't insert more than once.
879 "Implement `map-keymap' with sorting.
880 Don't call this function; it is for internal use only."
883 keymap)
889 t)
891 ;; string< also accepts symbols.
897 "Return the binding part of a menu-item."
905 binding)))
913 "Build a menu-item like ITEM but with its binding changed to BINDING."
920 ;; Remove any potential filter.
923 item)
929 "Merge bindings VAL1 and VAL2."
933 ;; There's nothing to merge: val1 takes precedence.
934 val1
940 "Return a simpler equivalent keymap.
941 This resolves inheritance and redefinitions. The returned keymap
942 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
943 and use in active keymaps and menus.
944 Subkeymaps may be modified but are not canonicalized."
945 ;; FIXME: Problem with the difference between a nil binding
946 ;; that hides a binding in an inherited map and a nil binding that's ignored
947 ;; to let some further binding visible. Currently a nil binding hides all.
948 ;; FIXME: we may want to carefully (re)order elements in case they're
949 ;; menu-entries.
957 ;; Treat char-ranges specially.
960 map)))
961 ;; Create the new map.
964 ;; Treat char-ranges specially. FIXME: need to merge as well.
966 ;; Process the bindings starting from the end.
971 ;; The normal case: no duplicate bindings.
972 binding
973 ;; This is the second binding for this key.
977 bindings)))
983 "Translate character FROM to TO on the current terminal.
984 This function creates a `keyboard-translate-table' if necessary
985 and then modifies one entry in it."
990 \f
991 ;;;; Key binding commands.
994 "Give KEY a global binding as COMMAND.
995 COMMAND is the command definition to use; usually it is
996 a symbol naming an interactively-callable function.
997 KEY is a key sequence; noninteractively, it is a string or vector
998 of characters or event types, and non-ASCII characters with codes
999 above 127 (such as ISO Latin-1) can be included if you use a vector.
1001 Note that if KEY has a local binding in the current buffer,
1002 that local binding will continue to shadow any global binding
1003 that you make with this function."
1015 "Give KEY a local binding as COMMAND.
1016 COMMAND is the command definition to use; usually it is
1017 a symbol naming an interactively-callable function.
1018 KEY is a key sequence; noninteractively, it is a string or vector
1019 of characters or event types, and non-ASCII characters with codes
1020 above 127 (such as ISO Latin-1) can be included if you use a vector.
1022 The binding goes in the current buffer's local map, which in most
1023 cases is shared with all other buffers in the same major mode."
1033 "Remove global binding of KEY.
1034 KEY is a string or vector representing a sequence of keystrokes."
1039 "Remove local binding of KEY.
1040 KEY is a string or vector representing a sequence of keystrokes."
1044 nil)
1045 \f
1046 ;;;; substitute-key-definition and its subroutines.
1052 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
1053 In other words, OLDDEF is replaced with NEWDEF wherever it appears.
1054 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
1055 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
1057 If you don't specify OLDMAP, you can usually get the same results
1058 in a cleaner way with command remapping, like this:
1059 (define-key KEYMAP [remap OLDDEF] NEWDEF)
1061 ;; Don't document PREFIX in the doc string because we don't want to
1062 ;; advertise it. It's meant for recursive calls only. Here's its
1063 ;; meaning
1065 ;; If optional argument PREFIX is specified, it should be a key
1066 ;; prefix, a string. Redefined bindings will then be bound to the
1067 ;; original key, with PREFIX added at the front.
1071 (key-substitution-in-progress
1072 (cons scan key-substitution-in-progress)))
1073 ;; Scan OLDMAP, finding each char or event-symbol that
1074 ;; has any definition, and act on it with hack-key.
1075 (map-keymap
1076 (lambda (char defn)
1077 (aset prefix1 (length prefix) char)
1078 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
1079 scan)))
1081 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
1082 (let (inner-def skipped menu-item)
1083 ;; Find the actual command name within the binding.
1084 (if (eq (car-safe defn) 'menu-item)
1085 (setq menu-item defn defn (nth 2 defn))
1086 ;; Skip past menu-prompt.
1087 (while (stringp (car-safe defn))
1088 (push (pop defn) skipped))
1089 ;; Skip past cached key-equivalence data for menu items.
1090 (if (consp (car-safe defn))
1091 (setq defn (cdr defn))))
1092 (if (or (eq defn olddef)
1093 ;; Compare with equal if definition is a key sequence.
1094 ;; That is useful for operating on function-key-map.
1095 (and (or (stringp defn) (vectorp defn))
1096 (equal defn olddef)))
1097 (define-key keymap prefix
1098 (if menu-item
1099 (let ((copy (copy-sequence menu-item)))
1100 (setcar (nthcdr 2 copy) newdef)
1101 copy)
1102 (nconc (nreverse skipped) newdef)))
1103 ;; Look past a symbol that names a keymap.
1104 (setq inner-def
1105 (or (indirect-function defn) defn))
1106 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
1107 ;; avoid autoloading a keymap. This is mostly done to preserve the
1108 ;; original non-autoloading behavior of pre-map-keymap times.
1109 (if (and (keymapp inner-def)
1110 ;; Avoid recursively scanning
1111 ;; where KEYMAP does not have a submap.
1112 (let ((elt (lookup-key keymap prefix)))
1113 (or (null elt) (natnump elt) (keymapp elt)))
1114 ;; Avoid recursively rescanning keymap being scanned.
1115 (not (memq inner-def key-substitution-in-progress)))
1116 ;; If this one isn't being scanned already, scan it now.
1117 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
1119 \f
1120 ;;;; The global keymap tree.
1122 ;; global-map, esc-map, and ctl-x-map have their values set up in
1123 ;; keymap.c; we just give them docstrings here.
1125 (defvar global-map nil
1126 "Default global keymap mapping Emacs keyboard input into commands.
1127 The value is a keymap which is usually (but not necessarily) Emacs's
1128 global map.")
1130 (defvar esc-map nil
1131 "Default keymap for ESC (meta) commands.
1132 The normal global definition of the character ESC indirects to this keymap.")
1134 (defvar ctl-x-map nil
1135 "Default keymap for C-x commands.
1136 The normal global definition of the character C-x indirects to this keymap.")
1138 (defvar ctl-x-4-map (make-sparse-keymap)
1139 "Keymap for subcommands of C-x 4.")
1140 (defalias 'ctl-x-4-prefix ctl-x-4-map)
1141 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
1143 (defvar ctl-x-5-map (make-sparse-keymap)
1144 "Keymap for frame commands.")
1145 (defalias 'ctl-x-5-prefix ctl-x-5-map)
1146 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
1148 \f
1149 ;;;; Event manipulation functions.
1151 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
1153 (defun listify-key-sequence (key)
1154 "Convert a key sequence to a list of events."
1155 (if (vectorp key)
1156 (append key nil)
1157 (mapcar (function (lambda (c)
1158 (if (> c 127)
1159 (logxor c listify-key-sequence-1)
1160 c)))
1161 key)))
1163 (defun eventp (obj)
1164 "True if the argument is an event object."
1165 (when obj
1166 (or (integerp obj)
1167 (and (symbolp obj) obj (not (keywordp obj)))
1168 (and (consp obj) (symbolp (car obj))))))
1170 (defun event-modifiers (event)
1171 "Return a list of symbols representing the modifier keys in event EVENT.
1172 The elements of the list may include `meta', `control',
1173 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
1174 and `down'.
1175 EVENT may be an event or an event type. If EVENT is a symbol
1176 that has never been used in an event that has been read as input
1177 in the current Emacs session, then this function may fail to include
1178 the `click' modifier."
1179 (let ((type event))
1180 (if (listp type)
1181 (setq type (car type)))
1182 (if (symbolp type)
1183 ;; Don't read event-symbol-elements directly since we're not
1184 ;; sure the symbol has already been parsed.
1185 (cdr (internal-event-symbol-parse-modifiers type))
1186 (let ((list nil)
1187 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
1188 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
1189 (if (not (zerop (logand type ?\M-\^@)))
1190 (push 'meta list))
1191 (if (or (not (zerop (logand type ?\C-\^@)))
1192 (< char 32))
1193 (push 'control list))
1194 (if (or (not (zerop (logand type ?\S-\^@)))
1195 (/= char (downcase char)))
1196 (push 'shift list))
1197 (or (zerop (logand type ?\H-\^@))
1198 (push 'hyper list))
1199 (or (zerop (logand type ?\s-\^@))
1200 (push 'super list))
1201 (or (zerop (logand type ?\A-\^@))
1202 (push 'alt list))
1203 list))))
1205 (defun event-basic-type (event)
1206 "Return the basic type of the given event (all modifiers removed).
1207 The value is a printing character (not upper case) or a symbol.
1208 EVENT may be an event or an event type. If EVENT is a symbol
1209 that has never been used in an event that has been read as input
1210 in the current Emacs session, then this function may return nil."
1211 (if (consp event)
1212 (setq event (car event)))
1213 (if (symbolp event)
1214 (car (get event 'event-symbol-elements))
1215 (let* ((base (logand event (1- ?\A-\^@)))
1216 (uncontrolled (if (< base 32) (logior base 64) base)))
1217 ;; There are some numbers that are invalid characters and
1218 ;; cause `downcase' to get an error.
1219 (condition-case ()
1220 (downcase uncontrolled)
1221 (error uncontrolled)))))
1223 (defsubst mouse-movement-p (object)
1224 "Return non-nil if OBJECT is a mouse movement event."
1225 (eq (car-safe object) 'mouse-movement))
1227 (defun mouse-event-p (object)
1228 "Return non-nil if OBJECT is a mouse click event."
1229 ;; is this really correct? maybe remove mouse-movement?
1230 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
1232 (defun event-start (event)
1233 "Return the starting position of EVENT.
1234 EVENT should be a mouse click, drag, or key press event. If
1235 EVENT is nil, the value of `posn-at-point' is used instead.
1237 The following accessor functions are used to access the elements
1238 of the position:
1240 `posn-window': The window the event is in.
1241 `posn-area': A symbol identifying the area the event occurred in,
1242 or nil if the event occurred in the text area.
1243 `posn-point': The buffer position of the event.
1244 `posn-x-y': The pixel-based coordinates of the event.
1245 `posn-col-row': The estimated column and row corresponding to the
1246 position of the event.
1247 `posn-actual-col-row': The actual column and row corresponding to the
1248 position of the event.
1249 `posn-string': The string object of the event, which is either
1250 nil or (STRING . POSITION)'.
1251 `posn-image': The image object of the event, if any.
1252 `posn-object': The image or string object of the event, if any.
1253 `posn-timestamp': The time the event occurred, in milliseconds.
1255 For more information, see Info node `(elisp)Click Events'."
1256 (if (consp event) (nth 1 event)
1257 (or (posn-at-point)
1258 (list (selected-window) (point) '(0 . 0) 0))))
1260 (defun event-end (event)
1261 "Return the ending position of EVENT.
1262 EVENT should be a click, drag, or key press event.
1264 See `event-start' for a description of the value returned."
1265 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1266 (or (posn-at-point)
1267 (list (selected-window) (point) '(0 . 0) 0))))
1269 (defsubst event-click-count (event)
1270 "Return the multi-click count of EVENT, a click or drag event.
1271 The return value is a positive integer."
1272 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1273 \f
1274 ;;;; Extracting fields of the positions in an event.
1276 (defun posnp (obj)
1277 "Return non-nil if OBJ appears to be a valid `posn' object specifying a window.
1278 A `posn' object is returned from functions such as `event-start'.
1279 If OBJ is a valid `posn' object, but specifies a frame rather
1280 than a window, return nil."
1281 ;; FIXME: Correct the behavior of this function so that all valid
1282 ;; `posn' objects are recognized, after updating other code that
1283 ;; depends on its present behavior.
1284 (and (windowp (car-safe obj))
1285 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1286 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1287 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1289 (defsubst posn-window (position)
1290 "Return the window in POSITION.
1291 POSITION should be a list of the form returned by the `event-start'
1292 and `event-end' functions."
1293 (nth 0 position))
1295 (defsubst posn-area (position)
1296 "Return the window area recorded in POSITION, or nil for the text area.
1297 POSITION should be a list of the form returned by the `event-start'
1298 and `event-end' functions."
1299 (let ((area (if (consp (nth 1 position))
1300 (car (nth 1 position))
1301 (nth 1 position))))
1302 (and (symbolp area) area)))
1304 (defun posn-point (position)
1305 "Return the buffer location in POSITION.
1306 POSITION should be a list of the form returned by the `event-start'
1307 and `event-end' functions.
1308 Returns nil if POSITION does not correspond to any buffer location (e.g.
1309 a click on a scroll bar)."
1310 (or (nth 5 position)
1311 (let ((pt (nth 1 position)))
1312 (or (car-safe pt)
1313 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1314 (if (integerp pt) pt)))))
1316 (defun posn-set-point (position)
1317 "Move point to POSITION.
1318 Select the corresponding window as well."
1319 (if (not (windowp (posn-window position)))
1320 (error "Position not in text area of window"))
1321 (select-window (posn-window position))
1322 (if (numberp (posn-point position))
1323 (goto-char (posn-point position))))
1325 (defsubst posn-x-y (position)
1326 "Return the x and y coordinates in POSITION.
1327 The return value has the form (X . Y), where X and Y are given in
1328 pixels. POSITION should be a list of the form returned by
1329 `event-start' and `event-end'."
1330 (nth 2 position))
1332 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1334 (defun posn-col-row (position)
1335 "Return the nominal column and row in POSITION, measured in characters.
1336 The column and row values are approximations calculated from the x
1337 and y coordinates in POSITION and the frame's default character width
1338 and default line height, including spacing.
1339 For a scroll-bar event, the result column is 0, and the row
1340 corresponds to the vertical position of the click in the scroll bar.
1341 POSITION should be a list of the form returned by the `event-start'
1342 and `event-end' functions."
1343 (let* ((pair (posn-x-y position))
1344 (frame-or-window (posn-window position))
1345 (frame (if (framep frame-or-window)
1346 frame-or-window
1347 (window-frame frame-or-window)))
1348 (window (when (windowp frame-or-window) frame-or-window))
1349 (area (posn-area position)))
1350 (cond
1351 ((null frame-or-window)
1352 '(0 . 0))
1353 ((eq area 'vertical-scroll-bar)
1354 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1355 ((eq area 'horizontal-scroll-bar)
1356 (cons (scroll-bar-scale pair (window-width window)) 0))
1357 (t
1358 ;; FIXME: This should take line-spacing properties on
1359 ;; newlines into account.
1360 (let* ((spacing (when (display-graphic-p frame)
1361 (or (with-current-buffer
1362 (window-buffer (frame-selected-window frame))
1363 line-spacing)
1364 (frame-parameter frame 'line-spacing)))))
1365 (cond ((floatp spacing)
1366 (setq spacing (truncate (* spacing
1367 (frame-char-height frame)))))
1368 ((null spacing)
1369 (setq spacing 0)))
1370 (cons (/ (car pair) (frame-char-width frame))
1371 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
1373 (defun posn-actual-col-row (position)
1374 "Return the window row number in POSITION and character number in that row.
1376 Return nil if POSITION does not contain the actual position; in that case
1377 `posn-col-row' can be used to get approximate values.
1378 POSITION should be a list of the form returned by the `event-start'
1379 and `event-end' functions.
1381 This function does not account for the width on display, like the
1382 number of visual columns taken by a TAB or image. If you need
1383 the coordinates of POSITION in character units, you should use
1384 `posn-col-row', not this function."
1385 (nth 6 position))
1387 (defsubst posn-timestamp (position)
1388 "Return the timestamp of POSITION.
1389 POSITION should be a list of the form returned by the `event-start'
1390 and `event-end' functions."
1391 (nth 3 position))
1393 (defun posn-string (position)
1394 "Return the string object of POSITION.
1395 Value is a cons (STRING . STRING-POS), or nil if not a string.
1396 POSITION should be a list of the form returned by the `event-start'
1397 and `event-end' functions."
1398 (let ((x (nth 4 position)))
1399 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1400 (when (consp x) x)))
1402 (defsubst posn-image (position)
1403 "Return the image object of POSITION.
1404 Value is a list (image ...), or nil if not an image.
1405 POSITION should be a list of the form returned by the `event-start'
1406 and `event-end' functions."
1407 (nth 7 position))
1409 (defsubst posn-object (position)
1410 "Return the object (image or string) of POSITION.
1411 Value is a list (image ...) for an image object, a cons cell
1412 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1413 POSITION should be a list of the form returned by the `event-start'
1414 and `event-end' functions."
1415 (or (posn-image position) (posn-string position)))
1417 (defsubst posn-object-x-y (position)
1418 "Return the x and y coordinates relative to the object of POSITION.
1419 The return value has the form (DX . DY), where DX and DY are
1420 given in pixels. POSITION should be a list of the form returned
1421 by `event-start' and `event-end'."
1422 (nth 8 position))
1424 (defsubst posn-object-width-height (position)
1425 "Return the pixel width and height of the object of POSITION.
1426 The return value has the form (WIDTH . HEIGHT). POSITION should
1427 be a list of the form returned by `event-start' and `event-end'."
1428 (nth 9 position))
1430 \f
1431 ;;;; Obsolescent names for functions.
1433 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1434 (make-obsolete 'buffer-has-markers-at nil "24.3")
1436 ;; bug#23850
1437 (make-obsolete 'string-to-unibyte "use `encode-coding-string'." "26.1")
1438 (make-obsolete 'string-as-unibyte "use `encode-coding-string'." "26.1")
1439 (make-obsolete 'string-make-unibyte "use `encode-coding-string'." "26.1")
1440 (make-obsolete 'string-to-multibyte "use `decode-coding-string'." "26.1")
1441 (make-obsolete 'string-as-multibyte "use `decode-coding-string'." "26.1")
1442 (make-obsolete 'string-make-multibyte "use `decode-coding-string'." "26.1")
1444 (defun log10 (x)
1445 "Return (log X 10), the log base 10 of X."
1446 (declare (obsolete log "24.4"))
1447 (log x 10))
1449 ;; These are used by VM and some old programs
1450 (defalias 'focus-frame 'ignore "")
1451 (make-obsolete 'focus-frame "it does nothing." "22.1")
1452 (defalias 'unfocus-frame 'ignore "")
1453 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1455 (set-advertised-calling-convention
1456 'all-completions '(string collection &optional predicate) "23.1")
1457 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1458 (set-advertised-calling-convention 'indirect-function '(object) "25.1")
1459 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1460 \f
1461 ;;;; Obsolescence declarations for variables, and aliases.
1463 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1464 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1465 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1466 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1467 (make-obsolete-variable 'redisplay-dont-pause nil "24.5")
1468 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1469 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1471 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1472 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1474 (make-obsolete-variable 'command-debug-status
1475 "expect it to be removed in a future version." "25.2")
1477 ;; Lisp manual only updated in 22.1.
1478 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1479 "before 19.34")
1481 (define-obsolete-variable-alias 'x-lost-selection-hooks
1482 'x-lost-selection-functions "22.1")
1483 (define-obsolete-variable-alias 'x-sent-selection-hooks
1484 'x-sent-selection-functions "22.1")
1486 ;; This was introduced in 21.4 for pre-unicode unification. That
1487 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1488 ;; Other uses are possible, so this variable is not _really_ obsolete,
1489 ;; but Stefan insists to mark it so.
1490 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1492 (make-obsolete-variable 'x-gtk-use-window-move nil "26.1")
1494 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1495 \f
1496 ;;;; Alternate names for functions - these are not being phased out.
1498 (defalias 'send-string 'process-send-string)
1499 (defalias 'send-region 'process-send-region)
1500 (defalias 'string= 'string-equal)
1501 (defalias 'string< 'string-lessp)
1502 (defalias 'string> 'string-greaterp)
1503 (defalias 'move-marker 'set-marker)
1504 (defalias 'rplaca 'setcar)
1505 (defalias 'rplacd 'setcdr)
1506 (defalias 'beep 'ding) ;preserve lingual purity
1507 (defalias 'indent-to-column 'indent-to)
1508 (defalias 'backward-delete-char 'delete-backward-char)
1509 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1510 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1511 (defalias 'int-to-string 'number-to-string)
1512 (defalias 'store-match-data 'set-match-data)
1513 (defalias 'chmod 'set-file-modes)
1514 (defalias 'mkdir 'make-directory)
1515 ;; These are the XEmacs names:
1516 (defalias 'point-at-eol 'line-end-position)
1517 (defalias 'point-at-bol 'line-beginning-position)
1519 (defalias 'user-original-login-name 'user-login-name)
1521 \f
1522 ;;;; Hook manipulation functions.
1524 (defun add-hook (hook function &optional append local)
1525 "Add to the value of HOOK the function FUNCTION.
1526 FUNCTION is not added if already present.
1527 FUNCTION is added (if necessary) at the beginning of the hook list
1528 unless the optional argument APPEND is non-nil, in which case
1529 FUNCTION is added at the end.
1531 The optional fourth argument, LOCAL, if non-nil, says to modify
1532 the hook's buffer-local value rather than its global value.
1533 This makes the hook buffer-local, and it makes t a member of the
1534 buffer-local value. That acts as a flag to run the hook
1535 functions of the global value as well as in the local value.
1537 HOOK should be a symbol, and FUNCTION may be any valid function. If
1538 HOOK is void, it is first set to nil. If HOOK's value is a single
1539 function, it is changed to a list of functions."
1540 (or (boundp hook) (set hook nil))
1541 (or (default-boundp hook) (set-default hook nil))
1542 (if local (unless (local-variable-if-set-p hook)
1543 (set (make-local-variable hook) (list t)))
1544 ;; Detect the case where make-local-variable was used on a hook
1545 ;; and do what we used to do.
1546 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1547 (setq local t)))
1548 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1549 ;; If the hook value is a single function, turn it into a list.
1550 (when (or (not (listp hook-value)) (functionp hook-value))
1551 (setq hook-value (list hook-value)))
1552 ;; Do the actual addition if necessary
1553 (unless (member function hook-value)
1554 (when (stringp function)
1555 (setq function (purecopy function)))
1556 (setq hook-value
1557 (if append
1558 (append hook-value (list function))
1559 (cons function hook-value))))
1560 ;; Set the actual variable
1561 (if local
1562 (progn
1563 ;; If HOOK isn't a permanent local,
1564 ;; but FUNCTION wants to survive a change of modes,
1565 ;; mark HOOK as partially permanent.
1566 (and (symbolp function)
1567 (get function 'permanent-local-hook)
1568 (not (get hook 'permanent-local))
1569 (put hook 'permanent-local 'permanent-local-hook))
1570 (set hook hook-value))
1571 (set-default hook hook-value))))
1573 (defun remove-hook (hook function &optional local)
1574 "Remove from the value of HOOK the function FUNCTION.
1575 HOOK should be a symbol, and FUNCTION may be any valid function. If
1576 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1577 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1579 The optional third argument, LOCAL, if non-nil, says to modify
1580 the hook's buffer-local value rather than its default value."
1581 (or (boundp hook) (set hook nil))
1582 (or (default-boundp hook) (set-default hook nil))
1583 ;; Do nothing if LOCAL is t but this hook has no local binding.
1584 (unless (and local (not (local-variable-p hook)))
1585 ;; Detect the case where make-local-variable was used on a hook
1586 ;; and do what we used to do.
1587 (when (and (local-variable-p hook)
1588 (not (and (consp (symbol-value hook))
1589 (memq t (symbol-value hook)))))
1590 (setq local t))
1591 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1592 ;; Remove the function, for both the list and the non-list cases.
1593 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1594 (if (equal hook-value function) (setq hook-value nil))
1595 (setq hook-value (delete function (copy-sequence hook-value))))
1596 ;; If the function is on the global hook, we need to shadow it locally
1597 ;;(when (and local (member function (default-value hook))
1598 ;; (not (member (cons 'not function) hook-value)))
1599 ;; (push (cons 'not function) hook-value))
1600 ;; Set the actual variable
1601 (if (not local)
1602 (set-default hook hook-value)
1603 (if (equal hook-value '(t))
1604 (kill-local-variable hook)
1605 (set hook hook-value))))))
1607 (defmacro letrec (binders &rest body)
1608 "Bind variables according to BINDERS then eval BODY.
1609 The value of the last form in BODY is returned.
1610 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1611 SYMBOL to the value of VALUEFORM.
1612 All symbols are bound before the VALUEFORMs are evalled."
1613 ;; Only useful in lexical-binding mode.
1614 ;; As a special-form, we could implement it more efficiently (and cleanly,
1615 ;; making the vars actually unbound during evaluation of the binders).
1616 (declare (debug let) (indent 1))
1617 `(let ,(mapcar #'car binders)
1618 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1619 ,@body))
1621 (defmacro with-wrapper-hook (hook args &rest body)
1622 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1624 around the preceding ones, like a set of nested `around' advices.
1626 Each hook function should accept an argument list consisting of a
1627 function FUN, followed by the additional arguments in ARGS.
1629 The first hook function in HOOK is passed a FUN that, if it is called
1630 with arguments ARGS, performs BODY (i.e., the default operation).
1631 The FUN passed to each successive hook function is defined based
1632 on the preceding hook functions; if called with arguments ARGS,
1633 it does what the `with-wrapper-hook' call would do if the
1634 preceding hook functions were the only ones present in HOOK.
1636 Each hook function may call its FUN argument as many times as it wishes,
1637 including never. In that case, such a hook function acts to replace
1638 the default definition altogether, and any preceding hook functions.
1639 Of course, a subsequent hook function may do the same thing.
1641 Each hook function definition is used to construct the FUN passed
1643 FUN is then called once."
1644 (declare (indent 2) (debug (form sexp body))
1645 (obsolete "use a <foo>-function variable modified by `add-function'."
1646 "24.4"))
1647 `(subr--with-wrapper-hook-no-warnings ,hook ,args ,@body))
1649 (defmacro subr--with-wrapper-hook-no-warnings (hook args &rest body)
1650 "Like (with-wrapper-hook HOOK ARGS BODY), but without warnings."
1651 ;; We need those two gensyms because CL's lexical scoping is not available
1652 ;; for function arguments :-(
1653 (let ((funs (make-symbol "funs"))
1654 (global (make-symbol "global"))
1655 (argssym (make-symbol "args"))
1656 (runrestofhook (make-symbol "runrestofhook")))
1657 ;; Since the hook is a wrapper, the loop has to be done via
1658 ;; recursion: a given hook function will call its parameter in order to
1659 ;; continue looping.
1660 `(letrec ((,runrestofhook
1661 (lambda (,funs ,global ,argssym)
1662 ;; `funs' holds the functions left on the hook and `global'
1663 ;; holds the functions left on the global part of the hook
1664 ;; (in case the hook is local).
1665 (if (consp ,funs)
1666 (if (eq t (car ,funs))
1667 (funcall ,runrestofhook
1668 (append ,global (cdr ,funs)) nil ,argssym)
1669 (apply (car ,funs)
1670 (apply-partially
1671 (lambda (,funs ,global &rest ,argssym)
1672 (funcall ,runrestofhook ,funs ,global ,argssym))
1673 (cdr ,funs) ,global)
1674 ,argssym))
1675 ;; Once there are no more functions on the hook, run
1676 ;; the original body.
1677 (apply (lambda ,args ,@body) ,argssym)))))
1678 (funcall ,runrestofhook ,hook
1679 ;; The global part of the hook, if any.
1680 ,(if (symbolp hook)
1681 `(if (local-variable-p ',hook)
1682 (default-value ',hook)))
1683 (list ,@args)))))
1685 (defun add-to-list (list-var element &optional append compare-fn)
1686 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1687 The test for presence of ELEMENT is done with `equal', or with
1688 COMPARE-FN if that's non-nil.
1689 If ELEMENT is added, it is added at the beginning of the list,
1690 unless the optional argument APPEND is non-nil, in which case
1691 ELEMENT is added at the end.
1693 The return value is the new value of LIST-VAR.
1695 This is handy to add some elements to configuration variables,
1696 but please do not abuse it in Elisp code, where you are usually
1697 better off using `push' or `cl-pushnew'.
1699 If you want to use `add-to-list' on a variable that is not
1700 defined until a certain package is loaded, you should put the
1701 call to `add-to-list' into a hook function that will be run only
1702 after loading the package. `eval-after-load' provides one way to
1703 do this. In some cases other hooks, such as major mode hooks,
1704 can do the job."
1705 (declare
1706 (compiler-macro
1707 (lambda (exp)
1708 ;; FIXME: Something like this could be used for `set' as well.
1709 (if (or (not (eq 'quote (car-safe list-var)))
1710 (special-variable-p (cadr list-var))
1711 (not (macroexp-const-p append)))
1712 exp
1713 (let* ((sym (cadr list-var))
1714 (append (eval append))
1715 (msg (format-message
1716 "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1717 sym))
1718 ;; Big ugly hack so we only output a warning during
1719 ;; byte-compilation, and so we can use
1720 ;; byte-compile-not-lexical-var-p to silence the warning
1721 ;; when a defvar has been seen but not yet executed.
1722 (warnfun (lambda ()
1723 ;; FIXME: We should also emit a warning for let-bound
1724 ;; variables with dynamic binding.
1725 (when (assq sym byte-compile--lexical-environment)
1726 (byte-compile-report-error msg :fill))))
1727 (code
1728 (macroexp-let2 macroexp-copyable-p x element
1729 `(if ,(if compare-fn
1730 (progn
1731 (require 'cl-lib)
1732 `(cl-member ,x ,sym :test ,compare-fn))
1733 ;; For bootstrapping reasons, don't rely on
1734 ;; cl--compiler-macro-member for the base case.
1735 `(member ,x ,sym))
1736 ,sym
1737 ,(if append
1738 `(setq ,sym (append ,sym (list ,x)))
1739 `(push ,x ,sym))))))
1740 (if (not (macroexp--compiling-p))
1741 code
1742 `(progn
1743 (macroexp--funcall-if-compiled ',warnfun)
1744 ,code)))))))
1745 (if (cond
1746 ((null compare-fn)
1747 (member element (symbol-value list-var)))
1748 ((eq compare-fn 'eq)
1749 (memq element (symbol-value list-var)))
1750 ((eq compare-fn 'eql)
1751 (memql element (symbol-value list-var)))
1752 (t
1753 (let ((lst (symbol-value list-var)))
1754 (while (and lst
1755 (not (funcall compare-fn element (car lst))))
1756 (setq lst (cdr lst)))
1757 lst)))
1758 (symbol-value list-var)
1759 (set list-var
1760 (if append
1761 (append (symbol-value list-var) (list element))
1762 (cons element (symbol-value list-var))))))
1765 (defun add-to-ordered-list (list-var element &optional order)
1766 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1767 The test for presence of ELEMENT is done with `eq'.
1769 The resulting list is reordered so that the elements are in the
1770 order given by each element's numeric list order. Elements
1771 without a numeric list order are placed at the end of the list.
1773 If the third optional argument ORDER is a number (integer or
1774 float), set the element's list order to the given value. If
1775 ORDER is nil or omitted, do not change the numeric order of
1776 ELEMENT. If ORDER has any other value, remove the numeric order
1777 of ELEMENT if it has one.
1779 The list order for each element is stored in LIST-VAR's
1780 `list-order' property.
1782 The return value is the new value of LIST-VAR."
1783 (let ((ordering (get list-var 'list-order)))
1784 (unless ordering
1785 (put list-var 'list-order
1786 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1787 (when order
1788 (puthash element (and (numberp order) order) ordering))
1789 (unless (memq element (symbol-value list-var))
1790 (set list-var (cons element (symbol-value list-var))))
1791 (set list-var (sort (symbol-value list-var)
1792 (lambda (a b)
1793 (let ((oa (gethash a ordering))
1794 (ob (gethash b ordering)))
1795 (if (and oa ob)
1796 (< oa ob)
1797 oa)))))))
1799 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1800 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1801 Return the new history list.
1802 If MAXELT is non-nil, it specifies the maximum length of the history.
1803 Otherwise, the maximum history length is the value of the `history-length'
1804 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1805 variable. The possible values of maximum length have the same meaning as
1806 the values of `history-length'.
1807 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1808 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1809 if it is empty or a duplicate."
1810 (unless maxelt
1811 (setq maxelt (or (get history-var 'history-length)
1812 history-length)))
1813 (let ((history (symbol-value history-var))
1814 tail)
1815 (when (and (listp history)
1816 (or keep-all
1817 (not (stringp newelt))
1818 (> (length newelt) 0))
1819 (or keep-all
1820 (not (equal (car history) newelt))))
1821 (if history-delete-duplicates
1822 (setq history (delete newelt history)))
1823 (setq history (cons newelt history))
1824 (when (integerp maxelt)
1825 (if (= 0 maxelt)
1826 (setq history nil)
1827 (setq tail (nthcdr (1- maxelt) history))
1828 (when (consp tail)
1829 (setcdr tail nil)))))
1830 (set history-var history)))
1832 \f
1833 ;;;; Mode hooks.
1835 (defvar delay-mode-hooks nil
1836 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1837 (defvar delayed-mode-hooks nil
1838 "List of delayed mode hooks waiting to be run.")
1839 (make-variable-buffer-local 'delayed-mode-hooks)
1840 (put 'delay-mode-hooks 'permanent-local t)
1842 (defvar delayed-after-hook-forms nil
1843 "List of delayed :after-hook forms waiting to be run.
1844 These forms come from `define-derived-mode'.")
1845 (make-variable-buffer-local 'delayed-after-hook-forms)
1847 (defvar change-major-mode-after-body-hook nil
1848 "Normal hook run in major mode functions, before the mode hooks.")
1850 (defvar after-change-major-mode-hook nil
1851 "Normal hook run at the very end of major mode functions.")
1853 (defun run-mode-hooks (&rest hooks)
1854 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1855 Call `hack-local-variables' to set up file local and directory local
1856 variables.
1858 If the variable `delay-mode-hooks' is non-nil, does not do anything,
1859 just adds the HOOKS to the list `delayed-mode-hooks'.
1860 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1861 `delayed-mode-hooks' (in reverse order), HOOKS, then runs
1862 `hack-local-variables', runs the hook `after-change-major-mode-hook', and
1863 finally evaluates the forms in `delayed-after-hook-forms' (see
1864 `define-derived-mode').
1866 Major mode functions should use this instead of `run-hooks' when
1867 running their FOO-mode-hook."
1868 (if delay-mode-hooks
1869 ;; Delaying case.
1870 (dolist (hook hooks)
1871 (push hook delayed-mode-hooks))
1872 ;; Normal case, just run the hook as before plus any delayed hooks.
1873 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1874 (setq delayed-mode-hooks nil)
1875 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1876 (if (buffer-file-name)
1877 (with-demoted-errors "File local-variables error: %s"
1878 (hack-local-variables 'no-mode)))
1879 (run-hooks 'after-change-major-mode-hook)
1880 (dolist (form (nreverse delayed-after-hook-forms))
1881 (eval form))
1882 (setq delayed-after-hook-forms nil)))
1884 (defmacro delay-mode-hooks (&rest body)
1885 "Execute BODY, but delay any `run-mode-hooks'.
1886 These hooks will be executed by the first following call to
1887 `run-mode-hooks' that occurs outside any `delay-mode-hooks' form.
1888 Only affects hooks run in the current buffer."
1889 (declare (debug t) (indent 0))
1890 `(progn
1891 (make-local-variable 'delay-mode-hooks)
1892 (let ((delay-mode-hooks t))
1893 ,@body)))
1895 ;; PUBLIC: find if the current mode derives from another.
1897 (defun provided-mode-derived-p (mode &rest modes)
1898 "Non-nil if MODE is derived from one of MODES.
1899 Uses the `derived-mode-parent' property of the symbol to trace backwards.
1900 If you just want to check `major-mode', use `derived-mode-p'."
1901 (while (and (not (memq mode modes))
1902 (setq mode (get mode 'derived-mode-parent))))
1903 mode)
1905 (defun derived-mode-p (&rest modes)
1906 "Non-nil if the current major mode is derived from one of MODES.
1907 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1908 (apply #'provided-mode-derived-p major-mode modes))
1909 \f
1910 ;;;; Minor modes.
1912 ;; If a minor mode is not defined with define-minor-mode,
1913 ;; add it here explicitly.
1914 ;; isearch-mode is deliberately excluded, since you should
1915 ;; not call it yourself.
1916 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1917 overwrite-mode view-mode
1918 hs-minor-mode)
1919 "List of all minor mode functions.")
1921 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1922 "Register a new minor mode.
1924 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1926 TOGGLE is a symbol which is the name of a buffer-local variable that
1927 is toggled on or off to say whether the minor mode is active or not.
1929 NAME specifies what will appear in the mode line when the minor mode
1930 is active. NAME should be either a string starting with a space, or a
1931 symbol whose value is such a string.
1933 Optional KEYMAP is the keymap for the minor mode that will be added
1934 to `minor-mode-map-alist'.
1936 Optional AFTER specifies that TOGGLE should be added after AFTER
1937 in `minor-mode-alist'.
1939 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1940 It defaults to (and should by convention be) TOGGLE.
1942 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1943 included in the mode-line minor mode menu.
1944 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1945 (unless (memq toggle minor-mode-list)
1946 (push toggle minor-mode-list))
1948 (unless toggle-fun (setq toggle-fun toggle))
1949 (unless (eq toggle-fun toggle)
1950 (put toggle :minor-mode-function toggle-fun))
1951 ;; Add the name to the minor-mode-alist.
1952 (when name
1953 (let ((existing (assq toggle minor-mode-alist)))
1954 (if existing
1955 (setcdr existing (list name))
1956 (let ((tail minor-mode-alist) found)
1957 (while (and tail (not found))
1958 (if (eq after (caar tail))
1959 (setq found tail)
1960 (setq tail (cdr tail))))
1961 (if found
1962 (let ((rest (cdr found)))
1963 (setcdr found nil)
1964 (nconc found (list (list toggle name)) rest))
1965 (push (list toggle name) minor-mode-alist))))))
1966 ;; Add the toggle to the minor-modes menu if requested.
1967 (when (get toggle :included)
1968 (define-key mode-line-mode-menu
1969 (vector toggle)
1970 (list 'menu-item
1971 (concat
1972 (or (get toggle :menu-tag)
1973 (if (stringp name) name (symbol-name toggle)))
1974 (let ((mode-name (if (symbolp name) (symbol-value name))))
1975 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1976 (concat " (" (match-string 0 mode-name) ")"))))
1977 toggle-fun
1978 :button (cons :toggle toggle))))
1980 ;; Add the map to the minor-mode-map-alist.
1981 (when keymap
1982 (let ((existing (assq toggle minor-mode-map-alist)))
1983 (if existing
1984 (setcdr existing keymap)
1985 (let ((tail minor-mode-map-alist) found)
1986 (while (and tail (not found))
1987 (if (eq after (caar tail))
1988 (setq found tail)
1989 (setq tail (cdr tail))))
1990 (if found
1991 (let ((rest (cdr found)))
1992 (setcdr found nil)
1993 (nconc found (list (cons toggle keymap)) rest))
1994 (push (cons toggle keymap) minor-mode-map-alist)))))))
1995 \f
1996 ;;;; Load history
1998 (defsubst autoloadp (object)
1999 "Non-nil if OBJECT is an autoload."
2000 (eq 'autoload (car-safe object)))
2002 ;; (defun autoload-type (object)
2003 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
2004 ;; OBJECT should be an autoload object."
2005 ;; (when (autoloadp object)
2006 ;; (let ((type (nth 3 object)))
2007 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
2008 ;; ((eq 'keymap t) 'macro)
2009 ;; (type)))))
2011 ;; (defalias 'autoload-file #'cadr
2012 ;; "Return the name of the file from which AUTOLOAD will be loaded.
2015 (defun define-symbol-prop (symbol prop val)
2016 "Define the property PROP of SYMBOL to be VAL.
2017 This is to `put' what `defalias' is to `fset'."
2018 ;; Can't use `cl-pushnew' here (nor `push' on (cdr foo)).
2019 ;; (cl-pushnew symbol (alist-get prop
2020 ;; (alist-get 'define-symbol-props
2021 ;; current-load-list)))
2022 (let ((sps (assq 'define-symbol-props current-load-list)))
2023 (unless sps
2024 (setq sps (list 'define-symbol-props))
2025 (push sps current-load-list))
2026 (let ((ps (assq prop sps)))
2027 (unless ps
2028 (setq ps (list prop))
2029 (setcdr sps (cons ps (cdr sps))))
2030 (unless (member symbol (cdr ps))
2031 (setcdr ps (cons symbol (cdr ps))))))
2032 (put symbol prop val))
2034 (defun symbol-file (symbol &optional type)
2035 "Return the name of the file that defined SYMBOL.
2036 The value is normally an absolute file name. It can also be nil,
2037 if the definition is not associated with any file. If SYMBOL
2038 specifies an autoloaded function, the value can be a relative
2039 file name without extension.
2041 If TYPE is nil, then any kind of definition is acceptable. If
2042 TYPE is `defun', `defvar', or `defface', that specifies function
2043 definition, variable definition, or face definition only.
2044 Otherwise TYPE is assumed to be a symbol property."
2045 (if (and (or (null type) (eq type 'defun))
2046 (symbolp symbol)
2047 (autoloadp (symbol-function symbol)))
2048 (nth 1 (symbol-function symbol))
2049 (catch 'found
2050 (pcase-dolist (`(,file . ,elems) load-history)
2051 (when (if type
2052 (if (eq type 'defvar)
2053 ;; Variables are present just as their names.
2054 (member symbol elems)
2055 ;; Many other types are represented as (TYPE . NAME).
2056 (or (member (cons type symbol) elems)
2057 (memq symbol (alist-get type
2058 (alist-get 'define-symbol-props
2059 elems)))))
2060 ;; We accept all types, so look for variable def
2061 ;; and then for any other kind.
2062 (or (member symbol elems)
2063 (let ((match (rassq symbol elems)))
2064 (and match
2065 (not (eq 'require (car match)))))))
2066 (throw 'found file))))))
2068 (defun locate-library (library &optional nosuffix path interactive-call)
2069 "Show the precise file name of Emacs library LIBRARY.
2070 LIBRARY should be a relative file name of the library, a string.
2071 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
2072 nil (which is the default, see below).
2075 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
2076 to the specified name LIBRARY.
2078 If the optional third arg PATH is specified, that list of directories
2079 is used instead of `load-path'.
2081 When called from a program, the file name is normally returned as a
2082 string. When run interactively, the argument INTERACTIVE-CALL is t,
2083 and the file name is displayed in the echo area."
2084 (interactive (list (completing-read "Locate library: "
2085 (apply-partially
2086 'locate-file-completion-table
2087 load-path (get-load-suffixes)))
2088 nil nil
2089 t))
2090 (let ((file (locate-file library
2091 (or path load-path)
2092 (append (unless nosuffix (get-load-suffixes))
2093 load-file-rep-suffixes))))
2094 (if interactive-call
2095 (if file
2096 (message "Library is file %s" (abbreviate-file-name file))
2097 (message "No library %s in search path" library)))
2098 file))
2100 \f
2101 ;;;; Process stuff.
2103 (defun start-process (name buffer program &rest program-args)
2104 "Start a program in a subprocess. Return the process object for it.
2105 NAME is name for process. It is modified if necessary to make it unique.
2106 BUFFER is the buffer (or buffer name) to associate with the process.
2108 Process output (both standard output and standard error streams) goes
2109 at end of BUFFER, unless you specify an output stream or filter
2110 function to handle the output. BUFFER may also be nil, meaning that
2111 this process is not associated with any buffer.
2113 PROGRAM is the program file name. It is searched for in `exec-path'
2114 \(which see). If nil, just associate a pty with the buffer. Remaining
2115 arguments PROGRAM-ARGS are strings to give program as arguments.
2117 If you want to separate standard output from standard error, use
2118 `make-process' or invoke the command through a shell and redirect
2119 one of them using the shell syntax.
2121 The process runs in `default-directory' if that is local (as
2123 otherwise. If you want to run a process in a remote directory
2124 use `start-file-process'."
2125 (unless (fboundp 'make-process)
2126 (error "Emacs was compiled without subprocess support"))
2127 (apply #'make-process
2128 (append (list :name name :buffer buffer)
2129 (if program
2130 (list :command (cons program program-args))))))
2132 (defun process-lines (program &rest args)
2133 "Execute PROGRAM with ARGS, returning its output as a list of lines.
2134 Signal an error if the program returns with a non-zero exit status."
2135 (with-temp-buffer
2136 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
2137 (unless (eq status 0)
2138 (error "%s exited with status %s" program status))
2139 (goto-char (point-min))
2140 (let (lines)
2141 (while (not (eobp))
2142 (setq lines (cons (buffer-substring-no-properties
2143 (line-beginning-position)
2144 (line-end-position))
2145 lines))
2146 (forward-line 1))
2147 (nreverse lines)))))
2149 (defun process-live-p (process)
2150 "Returns non-nil if PROCESS is alive.
2151 A process is considered alive if its status is `run', `open',
2152 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
2153 process."
2154 (and (processp process)
2155 (memq (process-status process)
2156 '(run open listen connect stop))))
2158 ;; compatibility
2160 (defun process-kill-without-query (process &optional _flag)
2161 "Say no query needed if PROCESS is running when Emacs is exited.
2162 Optional second argument if non-nil says to require a query.
2163 Value is t if a query was formerly required."
2164 (declare (obsolete
2165 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
2166 "22.1"))
2167 (let ((old (process-query-on-exit-flag process)))
2168 (set-process-query-on-exit-flag process nil)
2169 old))
2171 (defun process-kill-buffer-query-function ()
2172 "Ask before killing a buffer that has a running process."
2173 (let ((process (get-buffer-process (current-buffer))))
2174 (or (not process)
2175 (not (memq (process-status process) '(run stop open listen)))
2176 (not (process-query-on-exit-flag process))
2177 (yes-or-no-p
2178 (format "Buffer %S has a running process; kill it? "
2179 (buffer-name (current-buffer)))))))
2181 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
2183 ;; process plist management
2185 (defun process-get (process propname)
2186 "Return the value of PROCESS' PROPNAME property.
2187 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
2188 (plist-get (process-plist process) propname))
2190 (defun process-put (process propname value)
2191 "Change PROCESS' PROPNAME property to VALUE.
2192 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2193 (set-process-plist process
2194 (plist-put (process-plist process) propname value)))
2196 \f
2197 ;;;; Input and display facilities.
2199 (defconst read-key-empty-map (make-sparse-keymap))
2201 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2203 (defun read-key (&optional prompt)
2204 "Read a key from the keyboard.
2205 Contrary to `read-event' this will not return a raw event but instead will
2206 obey the input decoding and translations usually done by `read-key-sequence'.
2207 So escape sequences and keyboard encoding are taken into account.
2208 When there's an ambiguity because the key looks like the prefix of
2209 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2210 ;; This overriding-terminal-local-map binding also happens to
2211 ;; disable quail's input methods, so although read-key-sequence
2212 ;; always inherits the input method, in practice read-key does not
2213 ;; inherit the input method (at least not if it's based on quail).
2214 (let ((overriding-terminal-local-map nil)
2215 (overriding-local-map read-key-empty-map)
2216 (echo-keystrokes 0)
2217 (old-global-map (current-global-map))
2218 (timer (run-with-idle-timer
2219 ;; Wait long enough that Emacs has the time to receive and
2220 ;; process all the raw events associated with the single-key.
2221 ;; But don't wait too long, or the user may find the delay
2222 ;; annoying (or keep hitting more keys which may then get
2223 ;; lost or misinterpreted).
2224 ;; This is only relevant for keys which Emacs perceives as
2225 ;; "prefixes", such as C-x (because of the C-x 8 map in
2226 ;; key-translate-table and the C-x @ map in function-key-map)
2227 ;; or ESC (because of terminal escape sequences in
2228 ;; input-decode-map).
2229 read-key-delay t
2230 (lambda ()
2231 (let ((keys (this-command-keys-vector)))
2232 (unless (zerop (length keys))
2233 ;; `keys' is non-empty, so the user has hit at least
2234 ;; one key; there's no point waiting any longer, even
2235 ;; though read-key-sequence thinks we should wait
2236 ;; for more input to decide how to interpret the
2237 ;; current input.
2238 (throw 'read-key keys)))))))
2239 (unwind-protect
2240 (progn
2241 (use-global-map
2242 (let ((map (make-sparse-keymap)))
2243 ;; Don't hide the menu-bar and tool-bar entries.
2244 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2245 (define-key map [tool-bar]
2246 ;; This hack avoids evaluating the :filter (Bug#9922).
2247 (or (cdr (assq 'tool-bar global-map))
2248 (lookup-key global-map [tool-bar])))
2249 map))
2250 (let* ((keys
2251 (catch 'read-key (read-key-sequence-vector prompt nil t)))
2252 (key (aref keys 0)))
2253 (if (and (> (length keys) 1)
2254 (memq key '(mode-line header-line
2255 left-fringe right-fringe)))
2256 (aref keys 1)
2257 key)))
2258 (cancel-timer timer)
2259 ;; For some reason, `read-key(-sequence)' leaves the prompt in the echo
2260 ;; area, whereas `read-event' seems to empty it just before returning
2261 ;; (bug#22714). So, let's mimic the behavior of `read-event'.
2262 (message nil)
2263 (use-global-map old-global-map))))
2265 (defvar read-passwd-map
2266 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2267 ;; minibuffer-local-map along the way!
2268 (let ((map (make-sparse-keymap)))
2269 (set-keymap-parent map minibuffer-local-map)
2270 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2271 map)
2272 "Keymap used while reading passwords.")
2274 (defun read-passwd (prompt &optional confirm default)
2275 "Read a password, prompting with PROMPT, and return it.
2276 If optional CONFIRM is non-nil, read the password twice to make sure.
2277 Optional DEFAULT is a default password to use instead of empty input.
2279 This function echoes `.' for each character that the user types.
2280 You could let-bind `read-hide-char' to another hiding character, though.
2282 Once the caller uses the password, it can erase the password
2283 by doing (clear-string STRING)."
2284 (if confirm
2285 (let (success)
2286 (while (not success)
2287 (let ((first (read-passwd prompt nil default))
2288 (second (read-passwd "Confirm password: " nil default)))
2289 (if (equal first second)
2290 (progn
2291 (and (arrayp second) (not (eq first second)) (clear-string second))
2292 (setq success first))
2293 (and (arrayp first) (clear-string first))
2294 (and (arrayp second) (clear-string second))
2295 (message "Password not repeated accurately; please start over")
2296 (sit-for 1))))
2297 success)
2298 (let ((hide-chars-fun
2299 (lambda (beg end _len)
2300 (clear-this-command-keys)
2301 (setq beg (min end (max (minibuffer-prompt-end)
2302 beg)))
2303 (dotimes (i (- end beg))
2304 (put-text-property (+ i beg) (+ 1 i beg)
2305 'display (string (or read-hide-char ?.))))))
2306 minibuf)
2307 (minibuffer-with-setup-hook
2308 (lambda ()
2309 (setq minibuf (current-buffer))
2310 ;; Turn off electricity.
2311 (setq-local post-self-insert-hook nil)
2312 (setq-local buffer-undo-list t)
2313 (setq-local select-active-regions nil)
2314 (use-local-map read-passwd-map)
2315 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2316 (setq-local show-paren-mode nil) ;bug#16091.
2317 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2318 (unwind-protect
2319 (let ((enable-recursive-minibuffers t)
2320 (read-hide-char (or read-hide-char ?.)))
2321 (read-string prompt nil t default)) ; t = "no history"
2322 (when (buffer-live-p minibuf)
2323 (with-current-buffer minibuf
2324 ;; Not sure why but it seems that there might be cases where the
2325 ;; minibuffer is not always properly reset later on, so undo
2326 ;; whatever we've done here (bug#11392).
2327 (remove-hook 'after-change-functions hide-chars-fun 'local)
2328 (kill-local-variable 'post-self-insert-hook)
2329 ;; And of course, don't keep the sensitive data around.
2330 (erase-buffer))))))))
2332 (defun read-number (prompt &optional default)
2333 "Read a numeric value in the minibuffer, prompting with PROMPT.
2334 DEFAULT specifies a default value to return if the user just types RET.
2335 The value of DEFAULT is inserted into PROMPT.
2336 This function is used by the `interactive' code letter `n'."
2337 (let ((n nil)
2338 (default1 (if (consp default) (car default) default)))
2339 (when default1
2340 (setq prompt
2342 (replace-match (format " (default %s)" default1) t t prompt 1)
2344 (format " (default %s) " default1)
2345 prompt t t))))
2346 (while
2347 (progn
2348 (let ((str (read-from-minibuffer
2349 prompt nil nil nil nil
2350 (when default
2351 (if (consp default)
2352 (mapcar 'number-to-string (delq nil default))
2353 (number-to-string default))))))
2354 (condition-case nil
2355 (setq n (cond
2356 ((zerop (length str)) default1)
2357 ((stringp str) (read str))))
2358 (error nil)))
2359 (unless (numberp n)
2360 (message "Please enter a number.")
2361 (sit-for 1)
2362 t)))
2363 n))
2365 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2366 "Read and return one of CHARS, prompting for PROMPT.
2367 Any input that is not one of CHARS is ignored.
2369 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2370 keyboard-quit events while waiting for a valid input."
2371 (unless (consp chars)
2372 (error "Called `read-char-choice' without valid char choices"))
2373 (let (char done show-help (helpbuf " *Char Help*"))
2374 (let ((cursor-in-echo-area t)
2375 (executing-kbd-macro executing-kbd-macro)
2376 (esc-flag nil))
2377 (save-window-excursion ; in case we call help-form-show
2378 (while (not done)
2379 (unless (get-text-property 0 'face prompt)
2380 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2381 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2382 (read-key prompt)))
2383 (and show-help (buffer-live-p (get-buffer helpbuf))
2384 (kill-buffer helpbuf))
2385 (cond
2386 ((not (numberp char)))
2387 ;; If caller has set help-form, that's enough.
2388 ;; They don't explicitly have to add help-char to chars.
2389 ((and help-form
2390 (eq char help-char)
2391 (setq show-help t)
2392 (help-form-show)))
2393 ((memq char chars)
2394 (setq done t))
2395 ((and executing-kbd-macro (= char -1))
2396 ;; read-event returns -1 if we are in a kbd macro and
2397 ;; there are no more events in the macro. Attempt to
2398 ;; get an event interactively.
2399 (setq executing-kbd-macro nil))
2400 ((not inhibit-keyboard-quit)
2401 (cond
2402 ((and (null esc-flag) (eq char ?\e))
2403 (setq esc-flag t))
2404 ((memq char '(?\C-g ?\e))
2405 (keyboard-quit))))))))
2406 ;; Display the question with the answer. But without cursor-in-echo-area.
2407 (message "%s%s" prompt (char-to-string char))
2408 char))
2410 (defun sit-for (seconds &optional nodisp obsolete)
2411 "Redisplay, then wait for SECONDS seconds. Stop when input is available.
2412 SECONDS may be a floating-point value.
2413 \(On operating systems that do not support waiting for fractions of a
2414 second, floating-point values are rounded down to the nearest integer.)
2416 If optional arg NODISP is t, don't redisplay, just wait for input.
2417 Redisplay does not happen if input is available before it starts.
2419 Value is t if waited the full time with no input arriving, and nil otherwise.
2421 An obsolete, but still supported form is
2422 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2423 where the optional arg MILLISECONDS specifies an additional wait period,
2424 in milliseconds; this was useful when Emacs was built without
2425 floating point support."
2426 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2427 ;; This used to be implemented in C until the following discussion:
2428 ;; http://lists.gnu.org/archive/html/emacs-devel/2006-07/msg00401.html
2429 ;; Then it was moved here using an implementation based on an idle timer,
2430 ;; which was then replaced by the use of read-event.
2431 (if (numberp nodisp)
2432 (setq seconds (+ seconds (* 1e-3 nodisp))
2433 nodisp obsolete)
2434 (if obsolete (setq nodisp obsolete)))
2435 (cond
2436 (noninteractive
2437 (sleep-for seconds)
2438 t)
2439 ((input-pending-p t)
2440 nil)
2441 ((or (<= seconds 0)
2442 ;; We are going to call read-event below, which will record
2443 ;; the the next key as part of the macro, even if that key
2444 ;; invokes kmacro-end-macro, so if we are recording a macro,
2445 ;; the macro will recursively call itself. In addition, when
2446 ;; that key is removed from unread-command-events, it will be
2447 ;; recorded the second time, so the macro will have each key
2448 ;; doubled. This used to happen if a macro was defined with
2449 ;; Flyspell mode active (because Flyspell calls sit-for in its
2450 ;; post-command-hook, see bug #21329.) To avoid all that, we
2451 ;; simply disable the wait when we are recording a macro.
2452 defining-kbd-macro)
2453 (or nodisp (redisplay)))
2454 (t
2455 (or nodisp (redisplay))
2456 ;; FIXME: we should not read-event here at all, because it's much too
2457 ;; difficult to reliably "undo" a read-event by pushing it onto
2458 ;; unread-command-events.
2459 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2460 ;; decoding (hence non-nil as second arg under POSIX ttys).
2461 ;; For bug#15614, we need read-event not to inherit-input-method.
2462 ;; So we temporarily suspend input-method-function.
2463 (let ((read (let ((input-method-function nil))
2464 (read-event nil t seconds))))
2465 (or (null read)
2466 (progn
2467 ;; https://lists.gnu.org/archive/html/emacs-devel/2006-10/msg00394.html
2468 ;; We want `read' appear in the next command's this-command-event
2469 ;; but not in the current one.
2470 ;; By pushing (cons t read), we indicate that `read' has not
2471 ;; yet been recorded in this-command-keys, so it will be recorded
2472 ;; next time it's read.
2473 ;; And indeed the `seconds' argument to read-event correctly
2474 ;; prevented recording this event in the current command's
2475 ;; this-command-keys.
2476 (push (cons t read) unread-command-events)
2477 nil))))))
2479 ;; Behind display-popup-menus-p test.
2480 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2482 (defun y-or-n-p (prompt)
2485 PROMPT is the string to display to ask the question. It should
2488 No confirmation of the answer is requested; a single character is
2489 enough. SPC also means yes, and DEL means no.
2491 To be precise, this function translates user input into responses
2492 by consulting the bindings in `query-replace-map'; see the
2493 documentation of that variable for more information. In this
2494 case, the useful bindings are `act', `skip', `recenter',
2495 `scroll-up', `scroll-down', and `quit'.
2496 An `act' response means yes, and a `skip' response means no.
2497 A `quit' response means to invoke `keyboard-quit'.
2498 If the user enters `recenter', `scroll-up', or `scroll-down'
2499 responses, perform the requested window recentering or scrolling
2500 and ask again.
2502 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2503 is nil and `use-dialog-box' is non-nil."
2504 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2505 ;; where all the keys were unbound (i.e. it somehow got triggered
2506 ;; within read-key, apparently). I had to kill it.
2507 (let ((answer 'recenter)
2508 (padded (lambda (prompt &optional dialog)
2509 (let ((l (length prompt)))
2510 (concat prompt
2511 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2512 "" " ")
2513 (if dialog "" "(y or n) "))))))
2514 (cond
2515 (noninteractive
2516 (setq prompt (funcall padded prompt))
2517 (let ((temp-prompt prompt))
2518 (while (not (memq answer '(act skip)))
2519 (let ((str (read-string temp-prompt)))
2520 (cond ((member str '("y" "Y")) (setq answer 'act))
2521 ((member str '("n" "N")) (setq answer 'skip))
2522 (t (setq temp-prompt (concat "Please answer y or n. "
2523 prompt))))))))
2524 ((and (display-popup-menus-p)
2525 last-input-event ; not during startup
2526 (listp last-nonmenu-event)
2527 use-dialog-box)
2528 (setq prompt (funcall padded prompt t)
2529 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2530 (t
2531 (setq prompt (funcall padded prompt))
2532 (while
2533 (let* ((scroll-actions '(recenter scroll-up scroll-down
2534 scroll-other-window scroll-other-window-down))
2535 (key
2536 (let ((cursor-in-echo-area t))
2537 (when minibuffer-auto-raise
2538 (raise-frame (window-frame (minibuffer-window))))
2539 (read-key (propertize (if (memq answer scroll-actions)
2540 prompt
2541 (concat "Please answer y or n. "
2542 prompt))
2543 'face 'minibuffer-prompt)))))
2544 (setq answer (lookup-key query-replace-map (vector key) t))
2545 (cond
2546 ((memq answer '(skip act)) nil)
2547 ((eq answer 'recenter)
2548 (recenter) t)
2549 ((eq answer 'scroll-up)
2550 (ignore-errors (scroll-up-command)) t)
2551 ((eq answer 'scroll-down)
2552 (ignore-errors (scroll-down-command)) t)
2553 ((eq answer 'scroll-other-window)
2554 (ignore-errors (scroll-other-window)) t)
2555 ((eq answer 'scroll-other-window-down)
2556 (ignore-errors (scroll-other-window-down)) t)
2557 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2558 (signal 'quit nil) t)
2559 (t t)))
2560 (ding)
2561 (discard-input))))
2562 (let ((ret (eq answer 'act)))
2563 (unless noninteractive
2564 (message "%s%c" prompt (if ret ?y ?n)))
2565 ret)))
2567 \f
2568 ;;; Atomic change groups.
2570 (defmacro atomic-change-group (&rest body)
2571 "Perform BODY as an atomic change group.
2572 This means that if BODY exits abnormally,
2573 all of its changes to the current buffer are undone.
2574 This works regardless of whether undo is enabled in the buffer.
2576 This mechanism is transparent to ordinary use of undo;
2577 if undo is enabled in the buffer and BODY succeeds, the
2578 user can undo the change normally."
2579 (declare (indent 0) (debug t))
2580 (let ((handle (make-symbol "--change-group-handle--"))
2581 (success (make-symbol "--change-group-success--")))
2582 `(let ((,handle (prepare-change-group))
2583 ;; Don't truncate any undo data in the middle of this.
2584 (undo-outer-limit nil)
2585 (undo-limit most-positive-fixnum)
2586 (undo-strong-limit most-positive-fixnum)
2587 (,success nil))
2588 (unwind-protect
2589 (progn
2590 ;; This is inside the unwind-protect because
2591 ;; it enables undo if that was disabled; we need
2592 ;; to make sure that it gets disabled again.
2593 (activate-change-group ,handle)
2594 ,@body
2595 (setq ,success t))
2596 ;; Either of these functions will disable undo
2597 ;; if it was disabled before.
2598 (if ,success
2599 (accept-change-group ,handle)
2600 (cancel-change-group ,handle))))))
2602 (defun prepare-change-group (&optional buffer)
2603 "Return a handle for the current buffer's state, for a change group.
2604 If you specify BUFFER, make a handle for BUFFER's state instead.
2606 Pass the handle to `activate-change-group' afterward to initiate
2607 the actual changes of the change group.
2609 To finish the change group, call either `accept-change-group' or
2610 `cancel-change-group' passing the same handle as argument. Call
2611 `accept-change-group' to accept the changes in the group as final;
2612 call `cancel-change-group' to undo them all. You should use
2613 `unwind-protect' to make sure the group is always finished. The call
2614 to `activate-change-group' should be inside the `unwind-protect'.
2615 Once you finish the group, don't use the handle again--don't try to
2616 finish the same group twice. For a simple example of correct use, see
2617 the source code of `atomic-change-group'.
2619 The handle records only the specified buffer. To make a multibuffer
2620 change group, call this function once for each buffer you want to
2621 cover, then use `nconc' to combine the returned values, like this:
2623 (nconc (prepare-change-group buffer-1)
2624 (prepare-change-group buffer-2))
2626 You can then activate that multibuffer change group with a single
2627 call to `activate-change-group' and finish it with a single call
2628 to `accept-change-group' or `cancel-change-group'."
2630 (if buffer
2631 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2632 (list (cons (current-buffer) buffer-undo-list))))
2634 (defun activate-change-group (handle)
2635 "Activate a change group made with `prepare-change-group' (which see)."
2636 (dolist (elt handle)
2637 (with-current-buffer (car elt)
2638 (if (eq buffer-undo-list t)
2639 (setq buffer-undo-list nil)))))
2641 (defun accept-change-group (handle)
2642 "Finish a change group made with `prepare-change-group' (which see).
2643 This finishes the change group by accepting its changes as final."
2644 (dolist (elt handle)
2645 (with-current-buffer (car elt)
2646 (if (eq (cdr elt) t)
2647 (setq buffer-undo-list t)))))
2649 (defun cancel-change-group (handle)
2650 "Finish a change group made with `prepare-change-group' (which see).
2651 This finishes the change group by reverting all of its changes."
2652 (dolist (elt handle)
2653 (with-current-buffer (car elt)
2654 (setq elt (cdr elt))
2655 (save-restriction
2656 ;; Widen buffer temporarily so if the buffer was narrowed within
2657 ;; the body of `atomic-change-group' all changes can be undone.
2658 (widen)
2659 (let ((old-car (car-safe elt))
2660 (old-cdr (cdr-safe elt)))
2661 (unwind-protect
2662 (progn
2663 ;; Temporarily truncate the undo log at ELT.
2664 (when (consp elt)
2665 (setcar elt nil) (setcdr elt nil))
2666 (unless (eq last-command 'undo) (undo-start))
2667 ;; Make sure there's no confusion.
2668 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2669 (error "Undoing to some unrelated state"))
2670 ;; Undo it all.
2671 (save-excursion
2672 (while (listp pending-undo-list) (undo-more 1)))
2673 ;; Revert the undo info to what it was when we grabbed
2674 ;; the state.
2675 (setq buffer-undo-list elt))
2676 ;; Reset the modified cons cell ELT to its original content.
2677 (when (consp elt)
2678 (setcar elt old-car)
2679 (setcdr elt old-cdr))))))))
2680 \f
2681 ;;;; Display-related functions.
2683 ;; For compatibility.
2684 (define-obsolete-function-alias 'redraw-modeline
2685 'force-mode-line-update "24.3")
2687 (defun momentary-string-display (string pos &optional exit-char message)
2688 "Momentarily display STRING in the buffer at POS.
2689 Display remains until next event is input.
2690 If POS is a marker, only its position is used; its buffer is ignored.
2691 Optional third arg EXIT-CHAR can be a character, event or event
2692 description list. EXIT-CHAR defaults to SPC. If the input is
2693 EXIT-CHAR it is swallowed; otherwise it is then available as
2694 input (as a command if nothing else).
2695 Display MESSAGE (optional fourth arg) in the echo area.
2696 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2697 (or exit-char (setq exit-char ?\s))
2698 (let ((ol (make-overlay pos pos))
2699 (str (copy-sequence string)))
2700 (unwind-protect
2701 (progn
2702 (save-excursion
2703 (overlay-put ol 'after-string str)
2704 (goto-char pos)
2705 ;; To avoid trouble with out-of-bounds position
2706 (setq pos (point))
2707 ;; If the string end is off screen, recenter now.
2708 (if (<= (window-end nil t) pos)
2709 (recenter (/ (window-height) 2))))
2710 (message (or message "Type %s to continue editing.")
2711 (single-key-description exit-char))
2712 (let ((event (read-key)))
2713 ;; `exit-char' can be an event, or an event description list.
2714 (or (eq event exit-char)
2715 (eq event (event-convert-list exit-char))
2716 (setq unread-command-events
2717 (append (this-single-command-raw-keys)
2718 unread-command-events)))))
2719 (delete-overlay ol))))
2721 \f
2722 ;;;; Overlay operations
2724 (defun copy-overlay (o)
2725 "Return a copy of overlay O."
2726 (let ((o1 (if (overlay-buffer o)
2727 (make-overlay (overlay-start o) (overlay-end o)
2728 ;; FIXME: there's no easy way to find the
2729 ;; insertion-type of the two markers.
2730 (overlay-buffer o))
2731 (let ((o1 (make-overlay (point-min) (point-min))))
2732 (delete-overlay o1)
2733 o1)))
2734 (props (overlay-properties o)))
2735 (while props
2736 (overlay-put o1 (pop props) (pop props)))
2737 o1))
2739 (defun remove-overlays (&optional beg end name val)
2740 "Clear BEG and END of overlays whose property NAME has value VAL.
2741 Overlays might be moved and/or split.
2742 BEG and END default respectively to the beginning and end of buffer."
2743 ;; This speeds up the loops over overlays.
2744 (unless beg (setq beg (point-min)))
2745 (unless end (setq end (point-max)))
2746 (overlay-recenter end)
2747 (if (< end beg)
2748 (setq beg (prog1 end (setq end beg))))
2749 (save-excursion
2750 (dolist (o (overlays-in beg end))
2751 (when (eq (overlay-get o name) val)
2752 ;; Either push this overlay outside beg...end
2753 ;; or split it to exclude beg...end
2754 ;; or delete it entirely (if it is contained in beg...end).
2755 (if (< (overlay-start o) beg)
2756 (if (> (overlay-end o) end)
2757 (progn
2758 (move-overlay (copy-overlay o)
2759 (overlay-start o) beg)
2760 (move-overlay o end (overlay-end o)))
2761 (move-overlay o (overlay-start o) beg))
2762 (if (> (overlay-end o) end)
2763 (move-overlay o end (overlay-end o))
2764 (delete-overlay o)))))))
2765 \f
2766 ;;;; Miscellanea.
2768 (defvar suspend-hook nil
2769 "Normal hook run by `suspend-emacs', before suspending.")
2771 (defvar suspend-resume-hook nil
2772 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2774 (defvar temp-buffer-show-hook nil
2775 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2776 When the hook runs, the temporary buffer is current, and the window it
2777 was displayed in is selected.")
2779 (defvar temp-buffer-setup-hook nil
2780 "Normal hook run by `with-output-to-temp-buffer' at the start.
2781 When the hook runs, the temporary buffer is current.
2782 This hook is normally set up with a function to put the buffer in Help
2783 mode.")
2785 (defconst user-emacs-directory
2786 (if (eq system-type 'ms-dos)
2787 ;; MS-DOS cannot have initial dot.
2788 "~/_emacs.d/"
2789 "~/.emacs.d/")
2790 "Directory beneath which additional per-user Emacs-specific files are placed.
2791 Various programs in Emacs store information in this directory.
2792 Note that this should end with a directory separator.
2793 See also `locate-user-emacs-file'.")
2794 \f
2795 ;;;; Misc. useful functions.
2797 (defsubst buffer-narrowed-p ()
2798 "Return non-nil if the current buffer is narrowed."
2799 (/= (- (point-max) (point-min)) (buffer-size)))
2801 (defun find-tag-default-bounds ()
2802 "Determine the boundaries of the default tag, based on text at point.
2803 Return a cons cell with the beginning and end of the found tag.
2804 If there is no plausible default, return nil."
2805 (bounds-of-thing-at-point 'symbol))
2807 (defun find-tag-default ()
2808 "Determine default tag to search for, based on text at point.
2809 If there is no plausible default, return nil."
2810 (let ((bounds (find-tag-default-bounds)))
2811 (when bounds
2812 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2814 (defun find-tag-default-as-regexp ()
2815 "Return regexp that matches the default tag at point.
2816 If there is no tag at point, return nil.
2818 When in a major mode that does not provide its own
2819 `find-tag-default-function', return a regexp that matches the
2820 symbol at point exactly."
2821 (let ((tag (funcall (or find-tag-default-function
2822 (get major-mode 'find-tag-default-function)
2823 'find-tag-default))))
2824 (if tag (regexp-quote tag))))
2826 (defun find-tag-default-as-symbol-regexp ()
2827 "Return regexp that matches the default tag at point as symbol.
2828 If there is no tag at point, return nil.
2830 When in a major mode that does not provide its own
2831 `find-tag-default-function', return a regexp that matches the
2832 symbol at point exactly."
2833 (let ((tag-regexp (find-tag-default-as-regexp)))
2834 (if (and tag-regexp
2835 (eq (or find-tag-default-function
2836 (get major-mode 'find-tag-default-function)
2837 'find-tag-default)
2838 'find-tag-default))
2840 tag-regexp)))
2842 (defun play-sound (sound)
2843 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2844 The following keywords are recognized:
2846 :file FILE - read sound data from FILE. If FILE isn't an
2847 absolute file name, it is searched in `data-directory'.
2849 :data DATA - read sound data from string DATA.
2851 Exactly one of :file or :data must be present.
2853 :volume VOL - set volume to VOL. VOL must an integer in the
2854 range 0..100 or a float in the range 0..1.0. If not specified,
2855 don't change the volume setting of the sound device.
2857 :device DEVICE - play sound on DEVICE. If not specified,
2858 a system-dependent default device name is used.
2860 Note: :data and :device are currently not supported on Windows."
2861 (if (fboundp 'play-sound-internal)
2862 (play-sound-internal sound)
2863 (error "This Emacs binary lacks sound support")))
2865 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2867 (defun shell-quote-argument (argument)
2868 "Quote ARGUMENT for passing as argument to an inferior shell.
2870 This function is designed to work with the syntax of your system's
2871 standard shell, and might produce incorrect results with unusual shells.
2872 See Info node `(elisp)Security Considerations'."
2873 (cond
2874 ((eq system-type 'ms-dos)
2875 ;; Quote using double quotes, but escape any existing quotes in
2876 ;; the argument with backslashes.
2877 (let ((result "")
2878 (start 0)
2879 end)
2881 (< (match-end 0) (length argument)))
2883 (setq end (match-beginning 0)
2884 result (concat result (substring argument start end)
2886 start (1+ end))))
2889 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2891 ;; First, quote argument so that CommandLineToArgvW will
2892 ;; understand it. See
2893 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2894 ;; After we perform that level of quoting, escape shell
2895 ;; metacharacters so that cmd won't mangle our argument. If the
2896 ;; argument contains no double quote characters, we can just
2897 ;; surround it with double quotes. Otherwise, we need to prefix
2898 ;; each shell metacharacter with a caret.
2900 (setq argument
2901 ;; escape backslashes at end of string
2902 (replace-regexp-in-string
2905 ;; escape backslashes and quotes in string body
2906 (replace-regexp-in-string
2909 argument)))
2912 (concat
2914 (replace-regexp-in-string
2917 argument)
2921 (t
2922 (if (equal argument "")
2923 "''"
2924 ;; Quote everything except POSIX filename characters.
2925 ;; This should be safe enough even for really weird shells.
2926 (replace-regexp-in-string
2929 ))
2931 (defsubst string-to-list (string)
2932 "Return a list of characters in STRING."
2933 (append string nil))
2935 (defsubst string-to-vector (string)
2936 "Return a vector of characters in STRING."
2937 (vconcat string))
2939 (defun string-or-null-p (object)
2940 "Return t if OBJECT is a string or nil.
2941 Otherwise, return nil."
2942 (or (stringp object) (null object)))
2944 (defun booleanp (object)
2945 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2946 Otherwise, return nil."
2947 (and (memq object '(nil t)) t))
2949 (defun special-form-p (object)
2950 "Non-nil if and only if OBJECT is a special form."
2951 (if (and (symbolp object) (fboundp object))
2952 (setq object (indirect-function object)))
2953 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2955 (defun macrop (object)
2956 "Non-nil if and only if OBJECT is a macro."
2957 (let ((def (indirect-function object)))
2958 (when (consp def)
2959 (or (eq 'macro (car def))
2960 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2962 (defun field-at-pos (pos)
2963 "Return the field at position POS, taking stickiness etc into account."
2964 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2965 (if (eq raw-field 'boundary)
2966 (get-char-property (1- (field-end pos)) 'field)
2967 raw-field)))
2969 (defun sha1 (object &optional start end binary)
2970 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2971 OBJECT is either a string or a buffer. Optional arguments START and
2972 END are character positions specifying which portion of OBJECT for
2973 computing the hash. If BINARY is non-nil, return a string in binary
2974 form."
2975 (secure-hash 'sha1 object start end binary))
2977 (defun function-get (f prop &optional autoload)
2978 "Return the value of property PROP of function F.
2979 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2980 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2981 if it's an autoloaded macro."
2982 (let ((val nil))
2983 (while (and (symbolp f)
2984 (null (setq val (get f prop)))
2985 (fboundp f))
2986 (let ((fundef (symbol-function f)))
2987 (if (and autoload (autoloadp fundef)
2988 (not (equal fundef
2989 (autoload-do-load fundef f
2990 (if (eq autoload 'macro)
2991 'macro)))))
2992 nil ;Re-try `get' on the same `f'.
2993 (setq f fundef))))
2994 val))
2995 \f
2996 ;;;; Support for yanking and text properties.
2997 ;; Why here in subr.el rather than in simple.el? --Stef
2999 (defvar yank-handled-properties)
3000 (defvar yank-excluded-properties)
3002 (defun remove-yank-excluded-properties (start end)
3003 "Process text properties between START and END, inserted for a `yank'.
3004 Perform the handling specified by `yank-handled-properties', then
3005 remove properties specified by `yank-excluded-properties'."
3006 (let ((inhibit-read-only t))
3007 (dolist (handler yank-handled-properties)
3008 (let ((prop (car handler))
3009 (fun (cdr handler))
3010 (run-start start))
3011 (while (< run-start end)
3012 (let ((value (get-text-property run-start prop))
3013 (run-end (next-single-property-change
3014 run-start prop nil end)))
3015 (funcall fun value run-start run-end)
3016 (setq run-start run-end)))))
3017 (with-silent-modifications
3018 (if (eq yank-excluded-properties t)
3019 (set-text-properties start end nil)
3020 (remove-list-of-text-properties start end yank-excluded-properties)))))
3022 (defvar yank-undo-function)
3024 (defun insert-for-yank (string)
3025 "Insert STRING at point for the `yank' command.
3027 This function is like `insert', except it honors the variables
3028 `yank-handled-properties' and `yank-excluded-properties', and the
3029 `yank-handler' text property, in the way that `yank' does."
3030 (let (to)
3031 (while (setq to (next-single-property-change 0 'yank-handler string))
3032 (insert-for-yank-1 (substring string 0 to))
3033 (setq string (substring string to))))
3034 (insert-for-yank-1 string))
3036 (defun insert-for-yank-1 (string)
3037 "Helper for `insert-for-yank', which see."
3038 (let* ((handler (and (stringp string)
3039 (get-text-property 0 'yank-handler string)))
3040 (param (or (nth 1 handler) string))
3041 (opoint (point))
3042 (inhibit-read-only inhibit-read-only)
3043 end)
3045 (setq yank-undo-function t)
3046 (if (nth 0 handler) ; FUNCTION
3047 (funcall (car handler) param)
3048 (insert param))
3049 (setq end (point))
3051 ;; Prevent read-only properties from interfering with the
3052 ;; following text property changes.
3053 (setq inhibit-read-only t)
3055 (unless (nth 2 handler) ; NOEXCLUDE
3056 (remove-yank-excluded-properties opoint end))
3058 ;; If last inserted char has properties, mark them as rear-nonsticky.
3059 (if (and (> end opoint)
3060 (text-properties-at (1- end)))
3061 (put-text-property (1- end) end 'rear-nonsticky t))
3063 (if (eq yank-undo-function t) ; not set by FUNCTION
3064 (setq yank-undo-function (nth 3 handler))) ; UNDO
3065 (if (nth 4 handler) ; COMMAND
3066 (setq this-command (nth 4 handler)))))
3068 (defun insert-buffer-substring-no-properties (buffer &optional start end)
3069 "Insert before point a substring of BUFFER, without text properties.
3070 BUFFER may be a buffer or a buffer name.
3071 Arguments START and END are character positions specifying the substring.
3072 They default to the values of (point-min) and (point-max) in BUFFER."
3073 (let ((opoint (point)))
3074 (insert-buffer-substring buffer start end)
3075 (let ((inhibit-read-only t))
3076 (set-text-properties opoint (point) nil))))
3078 (defun insert-buffer-substring-as-yank (buffer &optional start end)
3079 "Insert before point a part of BUFFER, stripping some text properties.
3080 BUFFER may be a buffer or a buffer name.
3081 Arguments START and END are character positions specifying the substring.
3082 They default to the values of (point-min) and (point-max) in BUFFER.
3083 Before insertion, process text properties according to
3084 `yank-handled-properties' and `yank-excluded-properties'."
3085 ;; Since the buffer text should not normally have yank-handler properties,
3086 ;; there is no need to handle them here.
3087 (let ((opoint (point)))
3088 (insert-buffer-substring buffer start end)
3089 (remove-yank-excluded-properties opoint (point))))
3091 (defun yank-handle-font-lock-face-property (face start end)
3092 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
3093 START and END denote the start and end of the text to act on.
3094 Do nothing if FACE is nil."
3095 (and face
3096 (null font-lock-defaults)
3097 (put-text-property start end 'face face)))
3099 ;; This removes `mouse-face' properties in *Help* buffer buttons:
3100 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
3101 (defun yank-handle-category-property (category start end)
3102 "Apply property category CATEGORY's properties between START and END."
3103 (when category
3104 (let ((start2 start))
3105 (while (< start2 end)
3106 (let ((end2 (next-property-change start2 nil end))
3107 (original (text-properties-at start2)))
3108 (set-text-properties start2 end2 (symbol-plist category))
3109 (add-text-properties start2 end2 original)
3110 (setq start2 end2))))))
3112 \f
3113 ;;;; Synchronous shell commands.
3115 (defun start-process-shell-command (name buffer &rest args)
3116 "Start a program in a subprocess. Return the process object for it.
3117 NAME is name for process. It is modified if necessary to make it unique.
3118 BUFFER is the buffer (or buffer name) to associate with the process.
3119 Process output goes at end of that buffer, unless you specify
3120 an output stream or filter function to handle the output.
3121 BUFFER may be also nil, meaning that this process is not associated
3122 with any buffer
3123 COMMAND is the shell command to run.
3125 An old calling convention accepted any number of arguments after COMMAND,
3126 which were just concatenated to COMMAND. This is still supported but strongly
3127 discouraged."
3128 (declare (advertised-calling-convention (name buffer command) "23.1"))
3129 ;; We used to use `exec' to replace the shell with the command,
3130 ;; but that failed to handle (...) and semicolon, etc.
3131 (start-process name buffer shell-file-name shell-command-switch
3132 (mapconcat 'identity args " ")))
3134 (defun start-file-process-shell-command (name buffer &rest args)
3135 "Start a program in a subprocess. Return the process object for it.
3136 Similar to `start-process-shell-command', but calls `start-file-process'."
3137 (declare (advertised-calling-convention (name buffer command) "23.1"))
3138 (start-file-process
3139 name buffer
3140 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3141 (if (file-remote-p default-directory) "-c" shell-command-switch)
3142 (mapconcat 'identity args " ")))
3144 (defun call-process-shell-command (command &optional infile buffer display
3145 &rest args)
3146 "Execute the shell command COMMAND synchronously in separate process.
3147 The remaining arguments are optional.
3148 The program's input comes from file INFILE (nil means `/dev/null').
3149 Insert output in BUFFER before point; t means current buffer;
3150 nil for BUFFER means discard it; 0 means discard and don't wait.
3151 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3152 REAL-BUFFER says what to do with standard output, as above,
3153 while STDERR-FILE says what to do with standard error in the child.
3154 STDERR-FILE may be nil (discard standard error output),
3155 t (mix it with ordinary output), or a file name string.
3157 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
3158 Wildcards and redirection are handled as usual in the shell.
3160 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
3161 Otherwise it waits for COMMAND to terminate and returns a numeric exit
3162 status or a signal description string.
3163 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
3165 An old calling convention accepted any number of arguments after DISPLAY,
3166 which were just concatenated to COMMAND. This is still supported but strongly
3167 discouraged."
3168 (declare (advertised-calling-convention
3169 (command &optional infile buffer display) "24.5"))
3170 ;; We used to use `exec' to replace the shell with the command,
3171 ;; but that failed to handle (...) and semicolon, etc.
3172 (call-process shell-file-name
3173 infile buffer display
3174 shell-command-switch
3175 (mapconcat 'identity (cons command args) " ")))
3177 (defun process-file-shell-command (command &optional infile buffer display
3178 &rest args)
3179 "Process files synchronously in a separate process.
3180 Similar to `call-process-shell-command', but calls `process-file'."
3181 (declare (advertised-calling-convention
3182 (command &optional infile buffer display) "24.5"))
3183 (process-file
3184 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3185 infile buffer display
3186 (if (file-remote-p default-directory) "-c" shell-command-switch)
3187 (mapconcat 'identity (cons command args) " ")))
3189 (defun call-shell-region (start end command &optional delete buffer)
3190 "Send text from START to END as input to an inferior shell running COMMAND.
3191 Delete the text if fourth arg DELETE is non-nil.
3193 Insert output in BUFFER before point; t means current buffer; nil for
3194 BUFFER means discard it; 0 means discard and don't wait; and `(:file
3195 FILE)', where FILE is a file name string, means that it should be
3196 written to that file (if the file already exists it is overwritten).
3197 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3198 REAL-BUFFER says what to do with standard output, as above,
3199 while STDERR-FILE says what to do with standard error in the child.
3200 STDERR-FILE may be nil (discard standard error output),
3201 t (mix it with ordinary output), or a file name string.
3203 If BUFFER is 0, `call-shell-region' returns immediately with value nil.
3204 Otherwise it waits for COMMAND to terminate
3205 and returns a numeric exit status or a signal description string.
3206 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
3207 (call-process-region start end
3208 shell-file-name delete buffer nil
3209 shell-command-switch command))
3210 \f
3211 ;;;; Lisp macros to do various things temporarily.
3213 (defmacro track-mouse (&rest body)
3214 "Evaluate BODY with mouse movement events enabled.
3215 Within a `track-mouse' form, mouse motion generates input events that
3216 you can read with `read-event'.
3217 Normally, mouse motion is ignored."
3218 (declare (debug t) (indent 0))
3219 `(internal--track-mouse (lambda () ,@body)))
3221 (defmacro with-current-buffer (buffer-or-name &rest body)
3222 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3223 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3224 The value returned is the value of the last form in BODY. See
3225 also `with-temp-buffer'."
3226 (declare (indent 1) (debug t))
3227 `(save-current-buffer
3228 (set-buffer ,buffer-or-name)
3229 ,@body))
3231 (defun internal--before-with-selected-window (window)
3232 (let ((other-frame (window-frame window)))
3233 (list window (selected-window)
3234 ;; Selecting a window on another frame also changes that
3235 ;; frame's frame-selected-window. We must save&restore it.
3236 (unless (eq (selected-frame) other-frame)
3237 (frame-selected-window other-frame))
3238 ;; Also remember the top-frame if on ttys.
3239 (unless (eq (selected-frame) other-frame)
3240 (tty-top-frame other-frame)))))
3242 (defun internal--after-with-selected-window (state)
3243 ;; First reset frame-selected-window.
3244 (when (window-live-p (nth 2 state))
3245 ;; We don't use set-frame-selected-window because it does not
3246 ;; pass the `norecord' argument to Fselect_window.
3247 (select-window (nth 2 state) 'norecord)
3248 (and (frame-live-p (nth 3 state))
3249 (not (eq (tty-top-frame) (nth 3 state)))
3250 (select-frame (nth 3 state) 'norecord)))
3251 ;; Then reset the actual selected-window.
3252 (when (window-live-p (nth 1 state))
3253 (select-window (nth 1 state) 'norecord)))
3255 (defmacro with-selected-window (window &rest body)
3256 "Execute the forms in BODY with WINDOW as the selected window.
3257 The value returned is the value of the last form in BODY.
3259 This macro saves and restores the selected window, as well as the
3260 selected window of each frame. It does not change the order of
3261 recently selected windows. If the previously selected window of
3262 some frame is no longer live at the end of BODY, that frame's
3263 selected window is left alone. If the selected window is no
3264 longer live, then whatever window is selected at the end of BODY
3265 remains selected.
3267 This macro uses `save-current-buffer' to save and restore the
3268 current buffer, since otherwise its normal operation could
3269 potentially make a different buffer current. It does not alter
3270 the buffer list ordering."
3271 (declare (indent 1) (debug t))
3272 `(let ((save-selected-window--state
3273 (internal--before-with-selected-window ,window)))
3274 (save-current-buffer
3275 (unwind-protect
3276 (progn (select-window (car save-selected-window--state) 'norecord)
3277 ,@body)
3278 (internal--after-with-selected-window save-selected-window--state)))))
3280 (defmacro with-selected-frame (frame &rest body)
3281 "Execute the forms in BODY with FRAME as the selected frame.
3282 The value returned is the value of the last form in BODY.
3284 This macro saves and restores the selected frame, and changes the
3285 order of neither the recently selected windows nor the buffers in
3286 the buffer list."
3287 (declare (indent 1) (debug t))
3288 (let ((old-frame (make-symbol "old-frame"))
3289 (old-buffer (make-symbol "old-buffer")))
3290 `(let ((,old-frame (selected-frame))
3291 (,old-buffer (current-buffer)))
3292 (unwind-protect
3293 (progn (select-frame ,frame 'norecord)
3294 ,@body)
3295 (when (frame-live-p ,old-frame)
3296 (select-frame ,old-frame 'norecord))
3297 (when (buffer-live-p ,old-buffer)
3298 (set-buffer ,old-buffer))))))
3300 (defmacro save-window-excursion (&rest body)
3301 "Execute BODY, then restore previous window configuration.
3302 This macro saves the window configuration on the selected frame,
3303 executes BODY, then calls `set-window-configuration' to restore
3304 the saved window configuration. The return value is the last
3305 form in BODY. The window configuration is also restored if BODY
3306 exits nonlocally.
3308 BEWARE: Most uses of this macro introduce bugs.
3309 E.g. it should not be used to try and prevent some code from opening
3310 a new window, since that window may sometimes appear in another frame,
3311 in which case `save-window-excursion' cannot help."
3312 (declare (indent 0) (debug t))
3313 (let ((c (make-symbol "wconfig")))
3314 `(let ((,c (current-window-configuration)))
3315 (unwind-protect (progn ,@body)
3316 (set-window-configuration ,c)))))
3318 (defun internal-temp-output-buffer-show (buffer)
3319 "Internal function for `with-output-to-temp-buffer'."
3320 (with-current-buffer buffer
3321 (set-buffer-modified-p nil)
3322 (goto-char (point-min)))
3324 (if temp-buffer-show-function
3325 (funcall temp-buffer-show-function buffer)
3326 (with-current-buffer buffer
3327 (let* ((window
3328 (let ((window-combination-limit
3329 ;; When `window-combination-limit' equals
3330 ;; `temp-buffer' or `temp-buffer-resize' and
3331 ;; `temp-buffer-resize-mode' is enabled in this
3332 ;; buffer bind it to t so resizing steals space
3333 ;; preferably from the window that was split.
3334 (if (or (eq window-combination-limit 'temp-buffer)
3335 (and (eq window-combination-limit
3336 'temp-buffer-resize)
3337 temp-buffer-resize-mode))
3338 t
3339 window-combination-limit)))
3340 (display-buffer buffer)))
3341 (frame (and window (window-frame window))))
3342 (when window
3343 (unless (eq frame (selected-frame))
3344 (make-frame-visible frame))
3345 (setq minibuffer-scroll-window window)
3346 (set-window-hscroll window 0)
3347 ;; Don't try this with NOFORCE non-nil!
3348 (set-window-start window (point-min) t)
3349 ;; This should not be necessary.
3350 (set-window-point window (point-min))
3351 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3352 (with-selected-window window
3353 (run-hooks 'temp-buffer-show-hook))))))
3354 ;; Return nil.
3355 nil)
3357 ;; Doc is very similar to with-temp-buffer-window.
3358 (defmacro with-output-to-temp-buffer (bufname &rest body)
3359 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3361 This construct makes buffer BUFNAME empty before running BODY.
3362 It does not make the buffer current for BODY.
3363 Instead it binds `standard-output' to that buffer, so that output
3364 generated with `prin1' and similar functions in BODY goes into
3365 the buffer.
3367 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3368 it in a window, but does not select it. The normal way to do this is
3369 by calling `display-buffer', then running `temp-buffer-show-hook'.
3370 However, if `temp-buffer-show-function' is non-nil, it calls that
3371 function instead (and does not run `temp-buffer-show-hook'). The
3372 function gets one argument, the buffer to display.
3374 The return value of `with-output-to-temp-buffer' is the value of the
3375 last form in BODY. If BODY does not finish normally, the buffer
3376 BUFNAME is not displayed.
3378 This runs the hook `temp-buffer-setup-hook' before BODY,
3379 with the buffer BUFNAME temporarily current. It runs the hook
3380 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3381 buffer temporarily current, and the window that was used to display it
3382 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3383 if it uses `temp-buffer-show-function'.
3385 By default, the setup hook puts the buffer into Help mode before running BODY.
3386 If BODY does not change the major mode, the show hook makes the buffer
3387 read-only, and scans it for function and variable names to make them into
3388 clickable cross-references.
3390 See the related form `with-temp-buffer-window'."
3391 (declare (debug t))
3392 (let ((old-dir (make-symbol "old-dir"))
3393 (buf (make-symbol "buf")))
3394 `(let* ((,old-dir default-directory)
3395 (,buf
3396 (with-current-buffer (get-buffer-create ,bufname)
3397 (prog1 (current-buffer)
3398 (kill-all-local-variables)
3399 ;; FIXME: delete_all_overlays
3400 (setq default-directory ,old-dir)
3401 (setq buffer-read-only nil)
3402 (setq buffer-file-name nil)
3403 (setq buffer-undo-list t)
3404 (let ((inhibit-read-only t)
3405 (inhibit-modification-hooks t))
3406 (erase-buffer)
3407 (run-hooks 'temp-buffer-setup-hook)))))
3408 (standard-output ,buf))
3409 (prog1 (progn ,@body)
3410 (internal-temp-output-buffer-show ,buf)))))
3412 (defmacro with-temp-file (file &rest body)
3413 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3414 The value returned is the value of the last form in BODY.
3415 See also `with-temp-buffer'."
3416 (declare (indent 1) (debug t))
3417 (let ((temp-file (make-symbol "temp-file"))
3418 (temp-buffer (make-symbol "temp-buffer")))
3419 `(let ((,temp-file ,file)
3420 (,temp-buffer
3421 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3422 (unwind-protect
3423 (prog1
3424 (with-current-buffer ,temp-buffer
3425 ,@body)
3426 (with-current-buffer ,temp-buffer
3427 (write-region nil nil ,temp-file nil 0)))
3428 (and (buffer-name ,temp-buffer)
3429 (kill-buffer ,temp-buffer))))))
3431 (defmacro with-temp-message (message &rest body)
3432 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3433 The original message is restored to the echo area after BODY has finished.
3434 The value returned is the value of the last form in BODY.
3435 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3436 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3438 (declare (debug t) (indent 1))
3439 (let ((current-message (make-symbol "current-message"))
3440 (temp-message (make-symbol "with-temp-message")))
3441 `(let ((,temp-message ,message)
3442 (,current-message))
3443 (unwind-protect
3444 (progn
3445 (when ,temp-message
3446 (setq ,current-message (current-message))
3447 (message "%s" ,temp-message))
3448 ,@body)
3449 (and ,temp-message
3450 (if ,current-message
3451 (message "%s" ,current-message)
3452 (message nil)))))))
3454 (defmacro with-temp-buffer (&rest body)
3455 "Create a temporary buffer, and evaluate BODY there like `progn'.
3456 See also `with-temp-file' and `with-output-to-string'."
3457 (declare (indent 0) (debug t))
3458 (let ((temp-buffer (make-symbol "temp-buffer")))
3459 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3460 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3461 (with-current-buffer ,temp-buffer
3462 (unwind-protect
3463 (progn ,@body)
3464 (and (buffer-name ,temp-buffer)
3465 (kill-buffer ,temp-buffer)))))))
3467 (defmacro with-silent-modifications (&rest body)
3468 "Execute BODY, pretending it does not modify the buffer.
3469 This macro is Typically used around modifications of
3470 text-properties which do not really affect the buffer's content.
3471 If BODY performs real modifications to the buffer's text, other
3472 than cosmetic ones, undo data may become corrupted.
3474 This macro will run BODY normally, but doesn't count its buffer
3475 modifications as being buffer modifications. This affects things
3476 like `buffer-modified-p', checking whether the file is locked by
3477 someone else, running buffer modification hooks, and other things
3478 of that nature."
3479 (declare (debug t) (indent 0))
3480 (let ((modified (make-symbol "modified")))
3481 `(let* ((,modified (buffer-modified-p))
3482 (buffer-undo-list t)
3483 (inhibit-read-only t)
3484 (inhibit-modification-hooks t))
3485 (unwind-protect
3486 (progn
3487 ,@body)
3488 (unless ,modified
3489 (restore-buffer-modified-p nil))))))
3491 (defmacro with-output-to-string (&rest body)
3492 "Execute BODY, return the text it sent to `standard-output', as a string."
3493 (declare (indent 0) (debug t))
3494 `(let ((standard-output
3495 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3496 (unwind-protect
3497 (progn
3498 (let ((standard-output standard-output))
3499 ,@body)
3500 (with-current-buffer standard-output
3501 (buffer-string)))
3502 (kill-buffer standard-output))))
3504 (defmacro with-local-quit (&rest body)
3505 "Execute BODY, allowing quits to terminate BODY but not escape further.
3506 When a quit terminates BODY, `with-local-quit' returns nil but
3507 requests another quit. That quit will be processed as soon as quitting
3508 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3509 (declare (debug t) (indent 0))
3510 `(condition-case nil
3511 (let ((inhibit-quit nil))
3512 ,@body)
3513 (quit (setq quit-flag t)
3514 ;; This call is to give a chance to handle quit-flag
3515 ;; in case inhibit-quit is nil.
3516 ;; Without this, it will not be handled until the next function
3517 ;; call, and that might allow it to exit thru a condition-case
3518 ;; that intends to handle the quit signal next time.
3519 (eval '(ignore nil)))))
3521 ;; Don't throw `throw-on-input' on those events by default.
3522 (setq while-no-input-ignore-events
3523 '(focus-in focus-out help-echo iconify-frame
3524 make-frame-visible selection-request))
3526 (defmacro while-no-input (&rest body)
3527 "Execute BODY only as long as there's no pending input.
3528 If input arrives, that ends the execution of BODY,
3529 and `while-no-input' returns t. Quitting makes it return nil.
3530 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3531 (declare (debug t) (indent 0))
3532 (let ((catch-sym (make-symbol "input")))
3533 `(with-local-quit
3534 (catch ',catch-sym
3535 (let ((throw-on-input ',catch-sym))
3536 (or (input-pending-p)
3537 (progn ,@body)))))))
3539 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3540 "Like `condition-case' except that it does not prevent debugging.
3541 More specifically if `debug-on-error' is set then the debugger will be invoked
3542 even if this catches the signal."
3543 (declare (debug condition-case) (indent 2))
3544 `(condition-case ,var
3545 ,bodyform
3546 ,@(mapcar (lambda (handler)
3547 `((debug ,@(if (listp (car handler)) (car handler)
3548 (list (car handler))))
3549 ,@(cdr handler)))
3550 handlers)))
3552 (define-obsolete-function-alias 'condition-case-no-debug
3553 'condition-case-unless-debug "24.1")
3555 (defmacro with-demoted-errors (format &rest body)
3556 "Run BODY and demote any errors to simple messages.
3557 FORMAT is a string passed to `message' to format any error message.
3560 If `debug-on-error' is non-nil, run BODY without catching its errors.
3561 This is to be used around code which is not expected to signal an error
3562 but which should be robust in the unexpected case that an error is signaled.
3564 For backward compatibility, if FORMAT is not a constant string, it
3565 is assumed to be part of BODY, in which case the message format
3567 (declare (debug t) (indent 1))
3568 (let ((err (make-symbol "err"))
3569 (format (if (and (stringp format) body) format
3570 (prog1 "Error: %S"
3571 (if format (push format body))))))
3572 `(condition-case-unless-debug ,err
3573 ,(macroexp-progn body)
3574 (error (message ,format ,err) nil))))
3576 (defmacro combine-after-change-calls (&rest body)
3577 "Execute BODY, but don't call the after-change functions till the end.
3578 If BODY makes changes in the buffer, they are recorded
3579 and the functions on `after-change-functions' are called several times
3580 when BODY is finished.
3581 The return value is the value of the last form in BODY.
3583 If `before-change-functions' is non-nil, then calls to the after-change
3584 functions can't be deferred, so in that case this macro has no effect.
3586 Do not alter `after-change-functions' or `before-change-functions'
3587 in BODY."
3588 (declare (indent 0) (debug t))
3589 `(unwind-protect
3590 (let ((combine-after-change-calls t))
3591 . ,body)
3592 (combine-after-change-execute)))
3594 (defmacro with-case-table (table &rest body)
3595 "Execute the forms in BODY with TABLE as the current case table.
3596 The value returned is the value of the last form in BODY."
3597 (declare (indent 1) (debug t))
3598 (let ((old-case-table (make-symbol "table"))
3599 (old-buffer (make-symbol "buffer")))
3600 `(let ((,old-case-table (current-case-table))
3601 (,old-buffer (current-buffer)))
3602 (unwind-protect
3603 (progn (set-case-table ,table)
3604 ,@body)
3605 (with-current-buffer ,old-buffer
3606 (set-case-table ,old-case-table))))))
3608 (defmacro with-file-modes (modes &rest body)
3609 "Execute BODY with default file permissions temporarily set to MODES.
3610 MODES is as for `set-default-file-modes'."
3611 (declare (indent 1) (debug t))
3612 (let ((umask (make-symbol "umask")))
3613 `(let ((,umask (default-file-modes)))
3614 (unwind-protect
3615 (progn
3616 (set-default-file-modes ,modes)
3617 ,@body)
3618 (set-default-file-modes ,umask)))))
3620 \f
3621 ;;; Matching and match data.
3623 (defvar save-match-data-internal)
3625 ;; We use save-match-data-internal as the local variable because
3626 ;; that works ok in practice (people should not use that variable elsewhere).
3627 ;; We used to use an uninterned symbol; the compiler handles that properly
3628 ;; now, but it generates slower code.
3629 (defmacro save-match-data (&rest body)
3630 "Execute the BODY forms, restoring the global value of the match data.
3631 The value returned is the value of the last form in BODY."
3632 ;; It is better not to use backquote here,
3633 ;; because that makes a bootstrapping problem
3634 ;; if you need to recompile all the Lisp files using interpreted code.
3635 (declare (indent 0) (debug t))
3636 (list 'let
3637 '((save-match-data-internal (match-data)))
3638 (list 'unwind-protect
3639 (cons 'progn body)
3640 ;; It is safe to free (evaporate) markers immediately here,
3641 ;; as Lisp programs should not copy from save-match-data-internal.
3642 '(set-match-data save-match-data-internal 'evaporate))))
3644 (defun match-string (num &optional string)
3645 "Return string of text matched by last search.
3646 NUM specifies which parenthesized expression in the last regexp.
3647 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3648 Zero means the entire text matched by the whole regexp or whole string.
3649 STRING should be given if the last search was by `string-match' on STRING.
3650 If STRING is nil, the current buffer should be the same buffer
3651 the search/match was performed in."
3652 (if (match-beginning num)
3653 (if string
3654 (substring string (match-beginning num) (match-end num))
3655 (buffer-substring (match-beginning num) (match-end num)))))
3657 (defun match-string-no-properties (num &optional string)
3658 "Return string of text matched by last search, without text properties.
3659 NUM specifies which parenthesized expression in the last regexp.
3660 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3661 Zero means the entire text matched by the whole regexp or whole string.
3662 STRING should be given if the last search was by `string-match' on STRING.
3663 If STRING is nil, the current buffer should be the same buffer
3664 the search/match was performed in."
3665 (if (match-beginning num)
3666 (if string
3667 (substring-no-properties string (match-beginning num)
3668 (match-end num))
3669 (buffer-substring-no-properties (match-beginning num)
3670 (match-end num)))))
3673 (defun match-substitute-replacement (replacement
3674 &optional fixedcase literal string subexp)
3675 "Return REPLACEMENT as it will be inserted by `replace-match'.
3677 are substituted with actual strings matched by the last search.
3678 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3679 meaning as for `replace-match'."
3680 (let ((match (match-string 0 string)))
3681 (save-match-data
3682 (set-match-data (mapcar (lambda (x)
3683 (if (numberp x)
3684 (- x (match-beginning 0))
3685 x))
3686 (match-data t)))
3687 (replace-match replacement fixedcase literal match subexp))))
3690 (defun looking-back (regexp &optional limit greedy)
3691 "Return non-nil if text before point matches regular expression REGEXP.
3692 Like `looking-at' except matches before point, and is slower.
3693 LIMIT if non-nil speeds up the search by specifying a minimum
3694 starting position, to avoid checking matches that would start
3695 before LIMIT.
3697 If GREEDY is non-nil, extend the match backwards as far as
3698 possible, stopping when a single additional previous character
3699 cannot be part of a match for REGEXP. When the match is
3700 extended, its starting position is allowed to occur before
3701 LIMIT.
3703 As a general recommendation, try to avoid using `looking-back'
3704 wherever possible, since it is slow."
3705 (declare
3706 (advertised-calling-convention (regexp limit &optional greedy) "25.1"))
3707 (let ((start (point))
3708 (pos
3709 (save-excursion
3711 (point)))))
3712 (if (and greedy pos)
3713 (save-restriction
3714 (narrow-to-region (point-min) start)
3715 (while (and (> pos (point-min))
3716 (save-excursion
3717 (goto-char pos)
3718 (backward-char 1)
3720 (setq pos (1- pos)))
3721 (save-excursion
3722 (goto-char pos)
3724 (not (null pos))))
3726 (defsubst looking-at-p (regexp)
3727 "\
3728 Same as `looking-at' except this function does not change the match data."
3729 (let ((inhibit-changing-match-data t))
3730 (looking-at regexp)))
3732 (defsubst string-match-p (regexp string &optional start)
3733 "\
3734 Same as `string-match' except this function does not change the match data."
3735 (let ((inhibit-changing-match-data t))
3736 (string-match regexp string start)))
3738 (defun subregexp-context-p (regexp pos &optional start)
3739 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3740 A subregexp context is one where a sub-regexp can appear.
3741 A non-subregexp context is for example within brackets, or within a
3743 If START is non-nil, it should be a position in REGEXP, smaller
3744 than POS, and known to be in a subregexp context."
3745 ;; Here's one possible implementation, with the great benefit that it
3746 ;; reuses the regexp-matcher's own parser, so it understands all the
3747 ;; details of the syntax. A disadvantage is that it needs to match the
3748 ;; error string.
3749 (condition-case err
3750 (progn
3751 (string-match (substring regexp (or start 0) pos) "")
3752 t)
3753 (invalid-regexp
3754 (not (member (cadr err) '("Unmatched [ or [^"
3756 "Trailing backslash")))))
3757 ;; An alternative implementation:
3758 ;; (defconst re-context-re
3761 ;; (class-harmless-ch "[^][]")
3762 ;; (class-lb-harmless "[^]:]")
3766 ;; (class
3774 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3775 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3776 )
3777 \f
3778 ;;;; split-string
3781 "The default value of separators for `split-string'.
3783 A regexp matching strings of whitespace. May be locale-dependent
3784 \(as yet unimplemented). Should not match non-breaking spaces.
3786 Warning: binding this to a different value and using it as default is
3787 likely to have undesired semantics.")
3789 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3790 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3791 ;; expression leads to the equivalent implementation that if SEPARATORS
3792 ;; is defaulted, OMIT-NULLS is treated as t.
3793 (defun split-string (string &optional separators omit-nulls trim)
3794 "Split STRING into substrings bounded by matches for SEPARATORS.
3796 The beginning and end of STRING, and each match for SEPARATORS, are
3797 splitting points. The substrings matching SEPARATORS are removed, and
3798 the substrings between the splitting points are collected as a list,
3799 which is returned.
3801 If SEPARATORS is non-nil, it should be a regular expression matching text
3802 which separates, but is not part of, the substrings. If nil it defaults to
3804 OMIT-NULLS is forced to t.
3806 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3807 that for the default value of SEPARATORS leading and trailing whitespace
3808 are effectively trimmed). If nil, all zero-length substrings are retained,
3809 which correctly parses CSV format, for example.
3811 If TRIM is non-nil, it should be a regular expression to match
3812 text to trim from the beginning and end of each substring. If trimming
3813 makes the substring empty, it is treated as null.
3815 If you want to trim whitespace from the substrings, the reliably correct
3816 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3817 results when there is whitespace at the start or end of STRING. If you
3818 see such calls to `split-string', please fix them.
3820 Note that the effect of `(split-string STRING)' is the same as
3821 `(split-string STRING split-string-default-separators t)'. In the rare
3822 case that you wish to retain zero-length substrings when splitting on
3823 whitespace, use `(split-string STRING split-string-default-separators)'.
3825 Modifies the match data; use `save-match-data' if necessary."
3826 (let* ((keep-nulls (not (if separators omit-nulls t)))
3827 (rexp (or separators split-string-default-separators))
3828 (start 0)
3829 this-start this-end
3830 notfirst
3831 (list nil)
3832 (push-one
3833 ;; Push the substring in range THIS-START to THIS-END
3834 ;; onto LIST, trimming it and perhaps discarding it.
3835 (lambda ()
3836 (when trim
3837 ;; Discard the trim from start of this substring.
3838 (let ((tem (string-match trim string this-start)))
3839 (and (eq tem this-start)
3840 (setq this-start (match-end 0)))))
3842 (when (or keep-nulls (< this-start this-end))
3843 (let ((this (substring string this-start this-end)))
3845 ;; Discard the trim from end of this substring.
3846 (when trim
3848 (and tem (< tem (length this))
3849 (setq this (substring this 0 tem)))))
3851 ;; Trimming could make it empty; check again.
3852 (when (or keep-nulls (> (length this) 0))
3853 (push this list)))))))
3855 (while (and (string-match rexp string
3856 (if (and notfirst
3857 (= start (match-beginning 0))
3858 (< start (length string)))
3859 (1+ start) start))
3860 (< start (length string)))
3861 (setq notfirst t)
3862 (setq this-start start this-end (match-beginning 0)
3863 start (match-end 0))
3865 (funcall push-one))
3867 ;; Handle the substring at the end of STRING.
3868 (setq this-start start this-end (length string))
3869 (funcall push-one)
3871 (nreverse list)))
3873 (defun combine-and-quote-strings (strings &optional separator)
3875 This tries to quote the strings to avoid ambiguity such that
3876 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3877 Only some SEPARATORs will work properly.
3879 Note that this is not intended to protect STRINGS from
3880 interpretation by shells, use `shell-quote-argument' for that."
3881 (let* ((sep (or separator " "))
3883 (mapconcat
3884 (lambda (str)
3885 (if (string-match re str)
3887 str))
3888 strings sep)))
3890 (defun split-string-and-unquote (string &optional separator)
3891 "Split the STRING into a list of strings.
3892 It understands Emacs Lisp quoting within STRING, such that
3893 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3897 (if (null i)
3898 (split-string string sep t) ; no quoting: easy
3899 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3900 (let ((rfs (read-from-string string i)))
3901 (cons (car rfs)
3902 (split-string-and-unquote (substring string (cdr rfs))
3903 sep)))))))
3905 \f
3906 ;;;; Replacement in strings.
3908 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3909 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3910 Unless optional argument INPLACE is non-nil, return a new string."
3911 (let ((i (length string))
3912 (newstr (if inplace string (copy-sequence string))))
3913 (while (> i 0)
3914 (setq i (1- i))
3915 (if (eq (aref newstr i) fromchar)
3916 (aset newstr i tochar)))
3917 newstr))
3919 (defun replace-regexp-in-string (regexp rep string &optional
3920 fixedcase literal subexp start)
3921 "Replace all matches for REGEXP with REP in STRING.
3923 Return a new string containing the replacements.
3925 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3926 arguments with the same names of function `replace-match'. If START
3927 is non-nil, start replacements at that index in STRING.
3929 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3930 function. If it is a function, it is called with the actual text of each
3931 match, and its value is used as the replacement text. When REP is called,
3932 the match data are the result of matching REGEXP against a substring
3933 of STRING, the same substring that is the actual text of the match which
3934 is passed to REP as its argument.
3937 and replace a sub-expression, e.g.
3941 ;; To avoid excessive consing from multiple matches in long strings,
3942 ;; don't just call `replace-match' continually. Walk down the
3943 ;; string looking for matches of REGEXP and building up a (reversed)
3944 ;; list MATCHES. This comprises segments of STRING which weren't
3945 ;; matched interspersed with replacements for segments that were.
3946 ;; [For a `large' number of replacements it's more efficient to
3947 ;; operate in a temporary buffer; we can't tell from the function's
3948 ;; args whether to choose the buffer-based implementation, though it
3949 ;; might be reasonable to do so for long enough STRING.]
3950 (let ((l (length string))
3951 (start (or start 0))
3952 matches str mb me)
3953 (save-match-data
3954 (while (and (< start l) (string-match regexp string start))
3955 (setq mb (match-beginning 0)
3956 me (match-end 0))
3957 ;; If we matched the empty string, make sure we advance by one char
3958 (when (= me mb) (setq me (min l (1+ mb))))
3959 ;; Generate a replacement for the matched substring.
3960 ;; Operate only on the substring to minimize string consing.
3961 ;; Set up match data for the substring for replacement;
3962 ;; presumably this is likely to be faster than munging the
3963 ;; match data directly in Lisp.
3964 (string-match regexp (setq str (substring string mb me)))
3965 (setq matches
3966 (cons (replace-match (if (stringp rep)
3967 rep
3968 (funcall rep (match-string 0 str)))
3969 fixedcase literal str subexp)
3970 (cons (substring string start mb) ; unmatched prefix
3971 matches)))
3972 (setq start me))
3973 ;; Reconstruct a string from the pieces.
3974 (setq matches (cons (substring string start l) matches)) ; leftover
3975 (apply #'concat (nreverse matches)))))
3976 \f
3977 (defun string-prefix-p (prefix string &optional ignore-case)
3978 "Return non-nil if PREFIX is a prefix of STRING.
3979 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3980 to case differences."
3981 (let ((prefix-length (length prefix)))
3982 (if (> prefix-length (length string)) nil
3983 (eq t (compare-strings prefix 0 prefix-length string
3984 0 prefix-length ignore-case)))))
3986 (defun string-suffix-p (suffix string &optional ignore-case)
3987 "Return non-nil if SUFFIX is a suffix of STRING.
3988 If IGNORE-CASE is non-nil, the comparison is done without paying
3989 attention to case differences."
3990 (let ((start-pos (- (length string) (length suffix))))
3991 (and (>= start-pos 0)
3992 (eq t (compare-strings suffix nil nil
3993 string start-pos nil ignore-case)))))
3995 (defun bidi-string-mark-left-to-right (str)
3996 "Return a string that can be safely inserted in left-to-right text.
3998 Normally, inserting a string with right-to-left (RTL) script into
3999 a buffer may cause some subsequent text to be displayed as part
4000 of the RTL segment (usually this affects punctuation characters).
4001 This function returns a string which displays as STR but forces
4002 subsequent text to be displayed as left-to-right.
4004 If STR contains any RTL character, this function returns a string
4005 consisting of STR followed by an invisible left-to-right mark
4006 \(LRM) character. Otherwise, it returns STR."
4007 (unless (stringp str)
4008 (signal 'wrong-type-argument (list 'stringp str)))
4011 str))
4013 (defun string-greaterp (string1 string2)
4014 "Return non-nil if STRING1 is greater than STRING2 in lexicographic order.
4015 Case is significant.
4016 Symbols are also allowed; their print names are used instead."
4017 (string-lessp string2 string1))
4019 \f
4020 ;;;; Specifying things to do later.
4022 (defun load-history-regexp (file)
4023 "Form a regexp to find FILE in `load-history'.
4024 FILE, a string, is described in the function `eval-after-load'."
4025 (if (file-name-absolute-p file)
4026 (setq file (file-truename file)))
4028 (regexp-quote file)
4029 (if (file-name-extension file)
4030 ""
4031 ;; Note: regexp-opt can't be used here, since we need to call
4032 ;; this before Emacs has been fully started. 2006-05-21
4037 (defun load-history-filename-element (file-regexp)
4038 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
4039 Return nil if there isn't one."
4040 (let* ((loads load-history)
4041 (load-elt (and loads (car loads))))
4042 (save-match-data
4043 (while (and loads
4044 (or (null (car load-elt))
4045 (not (string-match file-regexp (car load-elt)))))
4046 (setq loads (cdr loads)
4047 load-elt (and loads (car loads)))))
4048 load-elt))
4050 (put 'eval-after-load 'lisp-indent-function 1)
4051 (defun eval-after-load (file form)
4052 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
4053 If FILE is already loaded, evaluate FORM right now.
4054 FORM can be an Elisp expression (in which case it's passed to `eval'),
4055 or a function (in which case it's passed to `funcall' with no argument).
4057 If a matching file is loaded again, FORM will be evaluated again.
4059 If FILE is a string, it may be either an absolute or a relative file
4061 additionally may or may not have an extension denoting a compressed
4064 When FILE is absolute, this first converts it to a true name by chasing
4065 symbolic links. Only a file of this name (see next paragraph regarding
4066 extensions) will trigger the evaluation of FORM. When FILE is relative,
4067 a file whose absolute true name ends in FILE will trigger evaluation.
4069 When FILE lacks an extension, a file name with any extension will trigger
4070 evaluation. Otherwise, its extension must match FILE's. A further
4072 this name matching.
4074 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
4075 is evaluated at the end of any file that `provide's this feature.
4076 If the feature is provided when evaluating code not associated with a
4077 file, FORM is evaluated immediately after the provide statement.
4080 like `font-lock'.
4082 This function makes or adds to an entry on `after-load-alist'."
4083 (declare (compiler-macro
4084 (lambda (whole)
4085 (if (eq 'quote (car-safe form))
4086 ;; Quote with lambda so the compiler can look inside.
4087 `(eval-after-load ,file (lambda () ,(nth 1 form)))
4088 whole))))
4089 ;; Add this FORM into after-load-alist (regardless of whether we'll be
4090 ;; evaluating it now).
4091 (let* ((regexp-or-feature
4092 (if (stringp file)
4093 (setq file (purecopy (load-history-regexp file)))
4094 file))
4095 (elt (assoc regexp-or-feature after-load-alist))
4096 (func
4097 (if (functionp form) form
4098 ;; Try to use the "current" lexical/dynamic mode for `form'.
4099 (eval `(lambda () ,form) lexical-binding))))
4100 (unless elt
4101 (setq elt (list regexp-or-feature))
4102 (push elt after-load-alist))
4103 ;; Is there an already loaded file whose name (or `provide' name)
4104 ;; matches FILE?
4105 (prog1 (if (if (stringp file)
4106 (load-history-filename-element regexp-or-feature)
4107 (featurep file))
4108 (funcall func))
4109 (let ((delayed-func
4110 (if (not (symbolp regexp-or-feature)) func
4111 ;; For features, the after-load-alist elements get run when
4112 ;; `provide' is called rather than at the end of the file.
4113 ;; So add an indirection to make sure that `func' is really run
4114 ;; "after-load" in case the provide call happens early.
4115 (lambda ()
4116 (if (not load-file-name)
4117 ;; Not being provided from a file, run func right now.
4118 (funcall func)
4119 (let ((lfn load-file-name)
4120 ;; Don't use letrec, because equal (in
4121 ;; add/remove-hook) would get trapped in a cycle.
4122 (fun (make-symbol "eval-after-load-helper")))
4123 (fset fun (lambda (file)
4124 (when (equal file lfn)
4125 (remove-hook 'after-load-functions fun)
4126 (funcall func))))
4127 (add-hook 'after-load-functions fun 'append)))))))
4128 ;; Add FORM to the element unless it's already there.
4129 (unless (member delayed-func (cdr elt))
4130 (nconc elt (list delayed-func)))))))
4132 (defmacro with-eval-after-load (file &rest body)
4133 "Execute BODY after FILE is loaded.
4134 FILE is normally a feature name, but it can also be a file name,
4135 in case that file does not provide any feature. See `eval-after-load'
4136 for more details about the different forms of FILE and their semantics."
4137 (declare (indent 1) (debug t))
4138 `(eval-after-load ,file (lambda () ,@body)))
4140 (defvar after-load-functions nil
4141 "Special hook run after loading a file.
4142 Each function there is called with a single argument, the absolute
4143 name of the file just loaded.")
4145 (defun do-after-load-evaluation (abs-file)
4146 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
4147 ABS-FILE, a string, should be the absolute true name of a file just loaded.
4148 This function is called directly from the C code."
4149 ;; Run the relevant eval-after-load forms.
4150 (dolist (a-l-element after-load-alist)
4151 (when (and (stringp (car a-l-element))
4152 (string-match-p (car a-l-element) abs-file))
4153 ;; discard the file name regexp
4154 (mapc #'funcall (cdr a-l-element))))
4155 ;; Complain when the user uses obsolete files.
4157 ;; Maybe we should just use display-warning? This seems yucky...
4158 (let* ((file (file-name-nondirectory abs-file))
4159 (msg (format "Package %s is obsolete!"
4160 (substring file 0
4162 ;; Cribbed from cl--compiling-file.
4163 (if (and (boundp 'byte-compile--outbuffer)
4164 (bufferp (symbol-value 'byte-compile--outbuffer))
4165 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
4166 " *Compiler Output*"))
4167 ;; Don't warn about obsolete files using other obsolete files.
4168 (unless (and (stringp byte-compile-current-file)
4170 (expand-file-name
4171 byte-compile-current-file
4172 byte-compile-root-dir)))
4173 (byte-compile-warn "%s" msg))
4174 (run-with-timer 0 nil
4175 (lambda (msg)
4176 (message "%s" msg))
4177 msg))))
4179 ;; Finally, run any other hook.
4180 (run-hook-with-args 'after-load-functions abs-file))
4182 (defun eval-next-after-load (file)
4183 "Read the following input sexp, and run it whenever FILE is loaded.
4184 This makes or adds to an entry on `after-load-alist'.
4185 FILE should be the name of a library, with no directory name."
4186 (declare (obsolete eval-after-load "23.2"))
4187 (eval-after-load file (read)))
4189 \f
4190 (defun display-delayed-warnings ()
4191 "Display delayed warnings from `delayed-warnings-list'.
4192 Used from `delayed-warnings-hook' (which see)."
4193 (dolist (warning (nreverse delayed-warnings-list))
4194 (apply 'display-warning warning))
4195 (setq delayed-warnings-list nil))
4197 (defun collapse-delayed-warnings ()
4198 "Remove duplicates from `delayed-warnings-list'.
4199 Collapse identical adjacent warnings into one (plus count).
4200 Used from `delayed-warnings-hook' (which see)."
4201 (let ((count 1)
4202 collapsed warning)
4203 (while delayed-warnings-list
4204 (setq warning (pop delayed-warnings-list))
4205 (if (equal warning (car delayed-warnings-list))
4206 (setq count (1+ count))
4207 (when (> count 1)
4208 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
4209 (cddr warning)))
4210 (setq count 1))
4211 (push warning collapsed)))
4212 (setq delayed-warnings-list (nreverse collapsed))))
4214 ;; At present this is only used for Emacs internals.
4215 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
4216 (defvar delayed-warnings-hook '(collapse-delayed-warnings
4217 display-delayed-warnings)
4218 "Normal hook run to process and display delayed warnings.
4219 By default, this hook contains functions to consolidate the
4220 warnings listed in `delayed-warnings-list', display them, and set
4221 `delayed-warnings-list' back to nil.")
4223 (defun delay-warning (type message &optional level buffer-name)
4224 "Display a delayed warning.
4225 Aside from going through `delayed-warnings-list', this is equivalent
4226 to `display-warning'."
4227 (push (list type message level buffer-name) delayed-warnings-list))
4229 \f
4230 ;;;; invisibility specs
4232 (defun add-to-invisibility-spec (element)
4233 "Add ELEMENT to `buffer-invisibility-spec'.
4234 See documentation for `buffer-invisibility-spec' for the kind of elements
4235 that can be added."
4236 (if (eq buffer-invisibility-spec t)
4237 (setq buffer-invisibility-spec (list t)))
4238 (setq buffer-invisibility-spec
4239 (cons element buffer-invisibility-spec)))
4241 (defun remove-from-invisibility-spec (element)
4242 "Remove ELEMENT from `buffer-invisibility-spec'."
4243 (setq buffer-invisibility-spec
4244 (if (consp buffer-invisibility-spec)
4245 (delete element buffer-invisibility-spec)
4246 (list t))))
4247 \f
4248 ;;;; Syntax tables.
4250 (defmacro with-syntax-table (table &rest body)
4251 "Evaluate BODY with syntax table of current buffer set to TABLE.
4252 The syntax table of the current buffer is saved, BODY is evaluated, and the
4253 saved table is restored, even in case of an abnormal exit.
4254 Value is what BODY returns."
4255 (declare (debug t) (indent 1))
4256 (let ((old-table (make-symbol "table"))
4257 (old-buffer (make-symbol "buffer")))
4258 `(let ((,old-table (syntax-table))
4259 (,old-buffer (current-buffer)))
4260 (unwind-protect
4261 (progn
4262 (set-syntax-table ,table)
4263 ,@body)
4264 (save-current-buffer
4265 (set-buffer ,old-buffer)
4266 (set-syntax-table ,old-table))))))
4268 (defun make-syntax-table (&optional oldtable)
4269 "Return a new syntax table.
4270 Create a syntax table which inherits from OLDTABLE (if non-nil) or
4271 from `standard-syntax-table' otherwise."
4272 (let ((table (make-char-table 'syntax-table nil)))
4273 (set-char-table-parent table (or oldtable (standard-syntax-table)))
4274 table))
4276 (defun syntax-after (pos)
4277 "Return the raw syntax descriptor for the char after POS.
4278 If POS is outside the buffer's accessible portion, return nil."
4279 (unless (or (< pos (point-min)) (>= pos (point-max)))
4280 (let ((st (if parse-sexp-lookup-properties
4281 (get-char-property pos 'syntax-table))))
4282 (if (consp st) st
4283 (aref (or st (syntax-table)) (char-after pos))))))
4285 (defun syntax-class (syntax)
4286 "Return the code for the syntax class described by SYNTAX.
4288 SYNTAX should be a raw syntax descriptor; the return value is a
4289 integer which encodes the corresponding syntax class. See Info
4290 node `(elisp)Syntax Table Internals' for a list of codes.
4292 If SYNTAX is nil, return nil."
4293 (and syntax (logand (car syntax) 65535)))
4294 \f
4295 ;; Utility motion commands
4297 (defvar word-move-empty-char-table nil
4298 "Used in `forward-word-strictly' and `backward-word-strictly'
4299 to countermand the effect of `find-word-boundary-function-table'.")
4301 (defun forward-word-strictly (&optional arg)
4302 "Move point forward ARG words (backward if ARG is negative).
4303 If ARG is omitted or nil, move point forward one word.
4304 Normally returns t.
4305 If an edge of the buffer or a field boundary is reached, point is left there
4306 and the function returns nil. Field boundaries are not noticed if
4307 `inhibit-field-text-motion' is non-nil.
4309 This function is like `forward-word', but it is not affected
4310 by `find-word-boundary-function-table'. It is also not interactive."
4311 (let ((find-word-boundary-function-table
4312 (if (char-table-p word-move-empty-char-table)
4313 word-move-empty-char-table
4314 (setq word-move-empty-char-table (make-char-table nil)))))
4315 (forward-word (or arg 1))))
4317 (defun backward-word-strictly (&optional arg)
4318 "Move backward until encountering the beginning of a word.
4319 With argument ARG, do this that many times.
4320 If ARG is omitted or nil, move point backward one word.
4322 This function is like `forward-word', but it is not affected
4323 by `find-word-boundary-function-table'. It is also not interactive."
4324 (let ((find-word-boundary-function-table
4325 (if (char-table-p word-move-empty-char-table)
4326 word-move-empty-char-table
4327 (setq word-move-empty-char-table (make-char-table nil)))))
4328 (forward-word (- (or arg 1)))))
4330 ;; Whitespace
4332 (defun forward-whitespace (arg)
4333 "Move point to the end of the next sequence of whitespace chars.
4334 Each such sequence may be a single newline, or a sequence of
4335 consecutive space and/or tab characters.
4336 With prefix argument ARG, do it ARG times if positive, or move
4337 backwards ARG times if negative."
4338 (interactive "^p")
4339 (if (natnump arg)
4341 (while (< arg 0)
4345 (setq arg (1+ arg)))))
4347 ;; Symbols
4349 (defun forward-symbol (arg)
4350 "Move point to the next position that is the end of a symbol.
4351 A symbol is any sequence of characters that are in either the
4352 word constituent or symbol constituent syntax class.
4353 With prefix argument ARG, do it ARG times if positive, or move
4354 backwards ARG times if negative."
4355 (interactive "^p")
4356 (if (natnump arg)
4358 (while (< arg 0)
4360 (skip-syntax-backward "w_"))
4361 (setq arg (1+ arg)))))
4363 ;; Syntax blocks
4365 (defun forward-same-syntax (&optional arg)
4366 "Move point past all characters with the same syntax class.
4367 With prefix argument ARG, do it ARG times if positive, or move
4368 backwards ARG times if negative."
4369 (interactive "^p")
4370 (or arg (setq arg 1))
4371 (while (< arg 0)
4372 (skip-syntax-backward
4373 (char-to-string (char-syntax (char-before))))
4374 (setq arg (1+ arg)))
4375 (while (> arg 0)
4376 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4377 (setq arg (1- arg))))
4379 \f
4380 ;;;; Text clones
4382 (defvar text-clone--maintaining nil)
4384 (defun text-clone--maintain (ol1 after beg end &optional _len)
4385 "Propagate the changes made under the overlay OL1 to the other clones.
4386 This is used on the `modification-hooks' property of text clones."
4387 (when (and after (not undo-in-progress)
4388 (not text-clone--maintaining)
4389 (overlay-start ol1))
4390 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4391 (setq beg (max beg (+ (overlay-start ol1) margin)))
4392 (setq end (min end (- (overlay-end ol1) margin)))
4393 (when (<= beg end)
4394 (save-excursion
4395 (when (overlay-get ol1 'text-clone-syntax)
4396 ;; Check content of the clone's text.
4397 (let ((cbeg (+ (overlay-start ol1) margin))
4398 (cend (- (overlay-end ol1) margin)))
4399 (goto-char cbeg)
4400 (save-match-data
4401 (if (not (re-search-forward
4402 (overlay-get ol1 'text-clone-syntax) cend t))
4403 ;; Mark the overlay for deletion.
4404 (setq end cbeg)
4405 (when (< (match-end 0) cend)
4406 ;; Shrink the clone at its end.
4407 (setq end (min end (match-end 0)))
4408 (move-overlay ol1 (overlay-start ol1)
4409 (+ (match-end 0) margin)))
4410 (when (> (match-beginning 0) cbeg)
4411 ;; Shrink the clone at its beginning.
4412 (setq beg (max (match-beginning 0) beg))
4413 (move-overlay ol1 (- (match-beginning 0) margin)
4414 (overlay-end ol1)))))))
4415 ;; Now go ahead and update the clones.
4416 (let ((head (- beg (overlay-start ol1)))
4417 (tail (- (overlay-end ol1) end))
4418 (str (buffer-substring beg end))
4419 (nothing-left t)
4420 (text-clone--maintaining t))
4421 (dolist (ol2 (overlay-get ol1 'text-clones))
4422 (let ((oe (overlay-end ol2)))
4423 (unless (or (eq ol1 ol2) (null oe))
4424 (setq nothing-left nil)
4425 (let ((mod-beg (+ (overlay-start ol2) head)))
4426 ;;(overlay-put ol2 'modification-hooks nil)
4427 (goto-char (- (overlay-end ol2) tail))
4428 (unless (> mod-beg (point))
4429 (save-excursion (insert str))
4430 (delete-region mod-beg (point)))
4431 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4432 ))))
4433 (if nothing-left (delete-overlay ol1))))))))
4435 (defun text-clone-create (start end &optional spreadp syntax)
4436 "Create a text clone of START...END at point.
4437 Text clones are chunks of text that are automatically kept identical:
4438 changes done to one of the clones will be immediately propagated to the other.
4440 The buffer's content at point is assumed to be already identical to
4441 the one between START and END.
4442 If SYNTAX is provided it's a regexp that describes the possible text of
4443 the clones; the clone will be shrunk or killed if necessary to ensure that
4444 its text matches the regexp.
4445 If SPREADP is non-nil it indicates that text inserted before/after the
4446 clone should be incorporated in the clone."
4447 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4448 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4449 ;; (with a one-char margin at each end) with `t nil'.
4450 ;; We opted for a larger overlay because it behaves better in the case
4451 ;; where the clone is reduced to the empty string (we want the overlay to
4452 ;; stay when the clone's content is the empty string and we want to use
4453 ;; `evaporate' to make sure those overlays get deleted when needed).
4454 ;;
4455 (let* ((pt-end (+ (point) (- end start)))
4456 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4457 0 1))
4458 (end-margin (if (or (not spreadp)
4459 (>= pt-end (point-max))
4460 (>= start (point-max)))
4461 0 1))
4462 ;; FIXME: Reuse overlays at point to extend dups!
4463 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4464 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4465 (dups (list ol1 ol2)))
4466 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4467 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4468 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4469 ;;(overlay-put ol1 'face 'underline)
4470 (overlay-put ol1 'evaporate t)
4471 (overlay-put ol1 'text-clones dups)
4472 ;;
4473 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4474 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4475 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4476 ;;(overlay-put ol2 'face 'underline)
4477 (overlay-put ol2 'evaporate t)
4478 (overlay-put ol2 'text-clones dups)))
4479 \f
4480 ;;;; Mail user agents.
4482 ;; Here we include just enough for other packages to be able
4483 ;; to define them.
4485 (defun define-mail-user-agent (symbol composefunc sendfunc
4486 &optional abortfunc hookvar)
4487 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4489 SYMBOL can be any Lisp symbol. Its function definition and/or
4490 value as a variable do not matter for this usage; we use only certain
4491 properties on its property list, to encode the rest of the arguments.
4493 COMPOSEFUNC is program callable function that composes an outgoing
4494 mail message buffer. This function should set up the basics of the
4495 buffer without requiring user interaction. It should populate the
4496 standard mail headers, leaving the `to:' and `subject:' headers blank
4497 by default.
4499 COMPOSEFUNC should accept several optional arguments--the same
4500 arguments that `compose-mail' takes. See that function's documentation.
4502 SENDFUNC is the command a user would run to send the message.
4504 Optional ABORTFUNC is the command a user would run to abort the
4505 message. For mail packages that don't have a separate abort function,
4506 this can be `kill-buffer' (the equivalent of omitting this argument).
4508 Optional HOOKVAR is a hook variable that gets run before the message
4509 is actually sent. Callers that use the `mail-user-agent' may
4510 install a hook function temporarily on this hook variable.
4511 If HOOKVAR is nil, `mail-send-hook' is used.
4513 The properties used on SYMBOL are `composefunc', `sendfunc',
4514 `abortfunc', and `hookvar'."
4515 (put symbol 'composefunc composefunc)
4516 (put symbol 'sendfunc sendfunc)
4517 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4518 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4520 \f
4521 (defun backtrace--print-frame (evald func args flags)
4522 "Print a trace of a single stack frame to `standard-output'.
4523 EVALD, FUNC, ARGS, FLAGS are as in `mapbacktrace'."
4524 (princ (if (plist-get flags :debug-on-exit) "* " " "))
4525 (cond
4526 ((and evald (not debugger-stack-frame-as-list))
4527 (prin1 func)
4528 (if args (prin1 args) (princ "()")))
4529 (t
4530 (prin1 (cons func args))))
4533 (defun backtrace ()
4534 "Print a trace of Lisp function calls currently active.
4535 Output stream used is value of `standard-output'."
4536 (let ((print-level (or print-level 8))
4537 (print-escape-control-characters t))
4538 (mapbacktrace #'backtrace--print-frame 'backtrace)))
4540 (defun backtrace-frames (&optional base)
4541 "Collect all frames of current backtrace into a list.
4542 If non-nil, BASE should be a function, and frames before its
4543 nearest activation frames are discarded."
4544 (let ((frames nil))
4545 (mapbacktrace (lambda (&rest frame) (push frame frames))
4546 (or base 'backtrace-frames))
4547 (nreverse frames)))
4549 (defun backtrace-frame (nframes &optional base)
4550 "Return the function and arguments NFRAMES up from current execution point.
4551 If non-nil, BASE should be a function, and NFRAMES counts from its
4552 nearest activation frame.
4553 If the frame has not evaluated the arguments yet (or is a special form),
4554 the value is (nil FUNCTION ARG-FORMS...).
4555 If the frame has evaluated its arguments and called its function already,
4556 the value is (t FUNCTION ARG-VALUES...).
4557 A &rest arg is represented as the tail of the list ARG-VALUES.
4558 FUNCTION is whatever was supplied as car of evaluated list,
4559 or a lambda expression for macro calls.
4560 If NFRAMES is more than the number of frames, the value is nil."
4561 (backtrace-frame--internal
4562 (lambda (evald func args _) `(,evald ,func ,@args))
4563 nframes (or base 'backtrace-frame)))
4565 \f
4566 (defvar called-interactively-p-functions nil
4567 "Special hook called to skip special frames in `called-interactively-p'.
4568 The functions are called with 3 arguments: (I FRAME1 FRAME2),
4570 I is the index of the frame after FRAME2. It should return nil
4571 if those frames don't seem special and otherwise, it should return
4572 the number of frames to skip (minus 1).")
4574 (defconst internal--funcall-interactively
4575 (symbol-function 'funcall-interactively))
4577 (defun called-interactively-p (&optional kind)
4578 "Return t if the containing function was called by `call-interactively'.
4579 If KIND is `interactive', then only return t if the call was made
4580 interactively by the user, i.e. not in `noninteractive' mode nor
4581 when `executing-kbd-macro'.
4582 If KIND is `any', on the other hand, it will return t for any kind of
4583 interactive call, including being called as the binding of a key or
4584 from a keyboard macro, even in `noninteractive' mode.
4586 This function is very brittle, it may fail to return the intended result when
4587 the code is debugged, advised, or instrumented in some form. Some macros and
4588 special forms (such as `condition-case') may also sometimes wrap their bodies
4589 in a `lambda', so any call to `called-interactively-p' from those bodies will
4590 indicate whether that lambda (rather than the surrounding function) was called
4591 interactively.
4593 Instead of using this function, it is cleaner and more reliable to give your
4594 function an extra optional argument whose `interactive' spec specifies
4596 \(not (or executing-kbd-macro noninteractive)).
4598 The only known proper use of `interactive' for KIND is in deciding
4599 whether to display a helpful message, or how to display it. If you're
4600 thinking of using it for any other purpose, it is quite likely that
4601 you're making a mistake. Think: what do you want to do when the
4602 command is called from a keyboard macro?"
4603 (declare (advertised-calling-convention (kind) "23.1"))
4604 (when (not (and (eq kind 'interactive)
4605 (or executing-kbd-macro noninteractive)))
4606 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4607 frame nextframe
4608 (get-next-frame
4609 (lambda ()
4610 (setq frame nextframe)
4611 (setq nextframe (backtrace-frame i 'called-interactively-p))
4612 ;; (message "Frame %d = %S" i nextframe)
4613 (setq i (1+ i)))))
4614 (funcall get-next-frame) ;; Get the first frame.
4615 (while
4616 ;; FIXME: The edebug and advice handling should be made modular and
4617 ;; provided directly by edebug.el and nadvice.el.
4618 (progn
4619 ;; frame =(backtrace-frame i-2)
4620 ;; nextframe=(backtrace-frame i-1)
4621 (funcall get-next-frame)
4622 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4623 ;; branches within local functions, which then messes up the
4624 ;; `backtrace-frame' data we get,
4625 (or
4626 ;; Skip special forms (from non-compiled code).
4627 (and frame (null (car frame)))
4628 ;; Skip also `interactive-p' (because we don't want to know if
4629 ;; interactive-p was called interactively but if it's caller was)
4630 ;; and `byte-code' (idem; this appears in subexpressions of things
4631 ;; like condition-case, which are wrapped in a separate bytecode
4632 ;; chunk).
4633 ;; FIXME: For lexical-binding code, this is much worse,
4634 ;; because the frames look like "byte-code -> funcall -> #[...]",
4635 ;; which is not a reliable signature.
4636 (memq (nth 1 frame) '(interactive-p 'byte-code))
4637 ;; Skip package-specific stack-frames.
4638 (let ((skip (run-hook-with-args-until-success
4639 'called-interactively-p-functions
4640 i frame nextframe)))
4641 (pcase skip
4642 (`nil nil)
4643 (`0 t)
4644 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4645 ;; Now `frame' should be "the function from which we were called".
4646 (pcase (cons frame nextframe)
4647 ;; No subr calls `interactive-p', so we can rule that out.
4648 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
4649 ;; In case #<subr funcall-interactively> without going through the
4650 ;; `funcall-interactively' symbol (bug#3984).
4651 (`(,_ . (t ,(pred (lambda (f)
4652 (eq internal--funcall-interactively
4653 (indirect-function f))))
4654 . ,_))
4655 t)))))
4657 (defun interactive-p ()
4658 "Return t if the containing function was run directly by user input.
4659 This means that the function was called with `call-interactively'
4660 \(which includes being called as the binding of a key)
4661 and input is currently coming from the keyboard (not a keyboard macro),
4662 and Emacs is not running in batch mode (`noninteractive' is nil).
4664 The only known proper use of `interactive-p' is in deciding whether to
4665 display a helpful message, or how to display it. If you're thinking
4666 of using it for any other purpose, it is quite likely that you're
4667 making a mistake. Think: what do you want to do when the command is
4668 called from a keyboard macro or in batch mode?
4670 To test whether your function was called with `call-interactively',
4671 either (i) add an extra optional argument and give it an `interactive'
4673 use `called-interactively-p'.
4675 To test whether a function can be called interactively, use
4676 `commandp'."
4677 (declare (obsolete called-interactively-p "23.2"))
4678 (called-interactively-p 'interactive))
4680 (defun internal-push-keymap (keymap symbol)
4681 (let ((map (symbol-value symbol)))
4682 (unless (memq keymap map)
4683 (unless (memq 'add-keymap-witness (symbol-value symbol))
4684 (setq map (make-composed-keymap nil (symbol-value symbol)))
4685 (push 'add-keymap-witness (cdr map))
4686 (set symbol map))
4687 (push keymap (cdr map)))))
4689 (defun internal-pop-keymap (keymap symbol)
4690 (let ((map (symbol-value symbol)))
4691 (when (memq keymap map)
4692 (setf (cdr map) (delq keymap (cdr map))))
4693 (let ((tail (cddr map)))
4694 (and (or (null tail) (keymapp tail))
4695 (eq 'add-keymap-witness (nth 1 map))
4696 (set symbol tail)))))
4698 (define-obsolete-function-alias
4699 'set-temporary-overlay-map 'set-transient-map "24.4")
4701 (defun set-transient-map (map &optional keep-pred on-exit)
4702 "Set MAP as a temporary keymap taking precedence over other keymaps.
4703 Normally, MAP is used only once, to look up the very next key.
4704 However, if the optional argument KEEP-PRED is t, MAP stays
4705 active if a key from MAP is used. KEEP-PRED can also be a
4706 function of no arguments: it is called from `pre-command-hook' and
4707 if it returns non-nil, then MAP stays active.
4709 Optional arg ON-EXIT, if non-nil, specifies a function that is
4710 called, with no arguments, after MAP is deactivated.
4712 This uses `overriding-terminal-local-map' which takes precedence over all other
4713 keymaps. As usual, if no match for a key is found in MAP, the normal key
4714 lookup sequence then continues.
4717 to deactivate this transient map, regardless of KEEP-PRED."
4718 (let* ((clearfun (make-symbol "clear-transient-map"))
4719 (exitfun
4720 (lambda ()
4721 (internal-pop-keymap map 'overriding-terminal-local-map)
4722 (remove-hook 'pre-command-hook clearfun)
4723 (when on-exit (funcall on-exit)))))
4724 ;; Don't use letrec, because equal (in add/remove-hook) would get trapped
4725 ;; in a cycle.
4726 (fset clearfun
4727 (lambda ()
4728 (with-demoted-errors "set-transient-map PCH: %S"
4729 (unless (cond
4730 ((null keep-pred) nil)
4731 ((and (not (eq map (cadr overriding-terminal-local-map)))
4732 (memq map (cddr overriding-terminal-local-map)))
4733 ;; There's presumably some other transient-map in
4734 ;; effect. Wait for that one to terminate before we
4735 ;; remove ourselves.
4736 ;; For example, if isearch and C-u both use transient
4737 ;; maps, then the lifetime of the C-u should be nested
4738 ;; within isearch's, so the pre-command-hook of
4739 ;; isearch should be suspended during the C-u one so
4740 ;; we don't exit isearch just because we hit 1 after
4741 ;; C-u and that 1 exits isearch whereas it doesn't
4742 ;; exit C-u.
4743 t)
4744 ((eq t keep-pred)
4745 (let ((mc (lookup-key map (this-command-keys-vector))))
4746 ;; If the key is unbound `this-command` is
4747 ;; nil and so is `mc`.
4748 (and mc (eq this-command mc))))
4749 (t (funcall keep-pred)))
4750 (funcall exitfun)))))
4751 (add-hook 'pre-command-hook clearfun)
4752 (internal-push-keymap map 'overriding-terminal-local-map)
4753 exitfun))
4755 ;;;; Progress reporters.
4757 ;; Progress reporter has the following structure:
4758 ;;
4759 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4760 ;; MIN-VALUE
4761 ;; MAX-VALUE
4762 ;; MESSAGE
4763 ;; MIN-CHANGE
4764 ;; MIN-TIME])
4765 ;;
4766 ;; This weirdness is for optimization reasons: we want
4767 ;; `progress-reporter-update' to be as fast as possible, so
4768 ;; `(car reporter)' is better than `(aref reporter 0)'.
4769 ;;
4770 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4771 ;; digits of precision, it doesn't really matter here. On the other
4772 ;; hand, it greatly simplifies the code.
4774 (defsubst progress-reporter-update (reporter &optional value)
4775 "Report progress of an operation in the echo area.
4776 REPORTER should be the result of a call to `make-progress-reporter'.
4778 If REPORTER is a numerical progress reporter---i.e. if it was
4779 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4780 `make-progress-reporter'---then VALUE should be a number between
4781 MIN-VALUE and MAX-VALUE.
4783 If REPORTER is a non-numerical reporter, VALUE should be nil.
4785 This function is relatively inexpensive. If the change since
4786 last update is too small or insufficient time has passed, it does
4787 nothing."
4788 (when (or (not (numberp value)) ; For pulsing reporter
4789 (>= value (car reporter))) ; For numerical reporter
4790 (progress-reporter-do-update reporter value)))
4792 (defun make-progress-reporter (message &optional min-value max-value
4793 current-value min-change min-time)
4794 "Return progress reporter object for use with `progress-reporter-update'.
4796 MESSAGE is shown in the echo area, with a status indicator
4797 appended to the end. When you call `progress-reporter-done', the
4799 MESSAGE of an existing progress reporter by calling
4800 `progress-reporter-force-update'.
4802 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4803 and final (100% complete) states of operation; the latter should
4804 be larger. In this case, the status message shows the percentage
4805 progress.
4807 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4810 Optional CURRENT-VALUE is the initial progress; the default is
4811 MIN-VALUE.
4812 Optional MIN-CHANGE is the minimal change in percents to report;
4813 the default is 1%.
4814 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4815 and/or MAX-VALUE are nil.
4817 Optional MIN-TIME specifies the minimum interval time between
4818 echo area updates (default is 0.2 seconds.) If the function
4819 `float-time' is not present, time is not tracked at all. If the
4820 OS is not capable of measuring fractions of seconds, this
4821 parameter is effectively rounded up."
4823 (setq message (concat message "...")))
4824 (unless min-time
4825 (setq min-time 0.2))
4826 (let ((reporter
4827 ;; Force a call to `message' now
4828 (cons (or min-value 0)
4829 (vector (if (and (fboundp 'float-time)
4830 (>= min-time 0.02))
4831 (float-time) nil)
4832 min-value
4833 max-value
4834 message
4835 (if min-change (max (min min-change 50) 1) 1)
4836 min-time))))
4837 (progress-reporter-update reporter (or current-value min-value))
4838 reporter))
4840 (defun progress-reporter-force-update (reporter &optional value new-message)
4841 "Report progress of an operation in the echo area unconditionally.
4843 The first two arguments are the same as in `progress-reporter-update'.
4844 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4845 (let ((parameters (cdr reporter)))
4846 (when new-message
4847 (aset parameters 3 new-message))
4848 (when (aref parameters 0)
4849 (aset parameters 0 (float-time)))
4850 (progress-reporter-do-update reporter value)))
4853 "Characters to use for pulsing progress reporters.")
4855 (defun progress-reporter-do-update (reporter value)
4856 (let* ((parameters (cdr reporter))
4857 (update-time (aref parameters 0))
4858 (min-value (aref parameters 1))
4859 (max-value (aref parameters 2))
4860 (text (aref parameters 3))
4861 (enough-time-passed
4862 ;; See if enough time has passed since the last update.
4863 (or (not update-time)
4864 (when (>= (float-time) update-time)
4865 ;; Calculate time for the next update
4866 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4867 (cond ((and min-value max-value)
4868 ;; Numerical indicator
4869 (let* ((one-percent (/ (- max-value min-value) 100.0))
4870 (percentage (if (= max-value min-value)
4871 0
4872 (truncate (/ (- value min-value)
4873 one-percent)))))
4874 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4875 ;; message because not enough time has passed, use 1
4876 ;; instead of MIN-CHANGE. This makes delays between echo
4877 ;; area updates closer to MIN-TIME.
4878 (setcar reporter
4879 (min (+ min-value (* (+ percentage
4880 (if enough-time-passed
4881 ;; MIN-CHANGE
4882 (aref parameters 4)
4883 1))
4884 one-percent))
4885 max-value))
4886 (when (integerp value)
4887 (setcar reporter (ceiling (car reporter))))
4888 ;; Only print message if enough time has passed
4889 (when enough-time-passed
4890 (if (> percentage 0)
4891 (message "%s%d%%" text percentage)
4892 (message "%s" text)))))
4893 ;; Pulsing indicator
4894 (enough-time-passed
4895 (let ((index (mod (1+ (car reporter)) 4))
4896 (message-log-max nil))
4897 (setcar reporter index)
4898 (message "%s %s"
4899 text
4900 (aref progress-reporter--pulse-characters
4901 index)))))))
4903 (defun progress-reporter-done (reporter)
4905 (message "%sdone" (aref (cdr reporter) 3)))
4907 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4908 "Loop a certain number of times and report progress in the echo area.
4909 Evaluate BODY with VAR bound to successive integers running from
4910 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4911 the return value (nil if RESULT is omitted).
4913 At each iteration MESSAGE followed by progress percentage is
4914 printed in the echo area. After the loop is finished, MESSAGE
4916 convenience wrapper around `make-progress-reporter' and friends.
4918 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4919 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4920 (let ((temp (make-symbol "--dotimes-temp--"))
4921 (temp2 (make-symbol "--dotimes-temp2--"))
4922 (start 0)
4923 (end (nth 1 spec)))
4924 `(let ((,temp ,end)
4925 (,(car spec) ,start)
4926 (,temp2 (make-progress-reporter ,message ,start ,end)))
4927 (while (< ,(car spec) ,temp)
4928 ,@body
4929 (progress-reporter-update ,temp2
4930 (setq ,(car spec) (1+ ,(car spec)))))
4931 (progress-reporter-done ,temp2)
4932 nil ,@(cdr (cdr spec)))))
4934 \f
4935 ;;;; Comparing version strings.
4937 (defconst version-separator "."
4938 "Specify the string used to separate the version elements.
4943 (defconst version-regexp-alist
4944 '(("^[-._+ ]?snapshot$" . -4)
4945 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4946 ("^[-._+]$" . -4)
4947 ;; treat "1.2.3-CVS" as snapshot release
4949 ("^[-._+ ]?alpha$" . -3)
4950 ("^[-._+ ]?beta$" . -2)
4952 "Specify association between non-numeric version and its priority.
4956 non-numeric part of a version string to an integer. For example:
4958 String Version Integer List Version
4970 Each element has the following form:
4972 (REGEXP . PRIORITY)
4974 Where:
4976 REGEXP regexp used to match non-numeric part of a version string.
4977 It should begin with the `^' anchor and end with a `$' to
4978 prevent false hits. Letter-case is ignored while matching
4979 REGEXP.
4981 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4984 (defun version-to-list (ver)
4985 "Convert version string VER into a list of integers.
4987 The version syntax is given by the following EBNF:
4989 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4991 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4993 SEPARATOR ::= `version-separator' (which see)
4994 | `version-regexp-alist' (which see).
4996 The NUMBER part is optional if SEPARATOR is a match for an element
4997 in `version-regexp-alist'.
4999 Examples of valid version syntax:
5001 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta 2.4.snapshot .5
5003 Examples of invalid version syntax:
5005 1.0prepre2 1.0..7.5 22.8X3 alpha3.2
5007 Examples of version conversion:
5009 Version String Version as a List of Integers
5022 See documentation for `version-separator' and `version-regexp-alist'."
5023 (unless (stringp ver)
5024 (error "Version must be a string"))
5025 ;; Change .x.y to 0.x.y
5026 (if (and (>= (length ver) (length version-separator))
5027 (string-equal (substring ver 0 (length version-separator))
5028 version-separator))
5029 (setq ver (concat "0" ver)))
5030 (unless (string-match-p "^[0-9]" ver)
5031 (error "Invalid version syntax: `%s' (must start with a number)" ver))
5033 (save-match-data
5034 (let ((i 0)
5035 (case-fold-search t) ; ignore case in matching
5036 lst s al)
5037 ;; Parse the version-string up to a separator until there are none left
5038 (while (and (setq s (string-match "[0-9]+" ver i))
5039 (= s i))
5040 ;; Add the numeric part to the beginning of the version list;
5041 ;; lst gets reversed at the end
5042 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
5043 lst)
5044 i (match-end 0))
5045 ;; handle non-numeric part
5046 (when (and (setq s (string-match "[^0-9]+" ver i))
5047 (= s i))
5048 (setq s (substring ver i (match-end 0))
5049 i (match-end 0))
5050 ;; handle alpha, beta, pre, etc. separator
5051 (unless (string= s version-separator)
5052 (setq al version-regexp-alist)
5053 (while (and al (not (string-match (caar al) s)))
5054 (setq al (cdr al)))
5055 (cond (al
5056 (push (cdar al) lst))
5057 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc., but only if
5058 ;; the letter is the end of the version-string, to avoid
5059 ;; 22.8X3 being valid
5061 (= i (length ver)))
5062 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
5063 lst))
5064 (t (error "Invalid version syntax: `%s'" ver))))))
5065 (nreverse lst))))
5067 (defun version-list-< (l1 l2)
5068 "Return t if L1, a list specification of a version, is lower than L2.
5070 Note that a version specified by the list (1) is equal to (1 0),
5071 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5072 Also, a version given by the list (1) is higher than (1 -1), which in
5073 turn is higher than (1 -2), which is higher than (1 -3)."
5074 (while (and l1 l2 (= (car l1) (car l2)))
5075 (setq l1 (cdr l1)
5076 l2 (cdr l2)))
5077 (cond
5078 ;; l1 not null and l2 not null
5079 ((and l1 l2) (< (car l1) (car l2)))
5080 ;; l1 null and l2 null ==> l1 length = l2 length
5081 ((and (null l1) (null l2)) nil)
5082 ;; l1 not null and l2 null ==> l1 length > l2 length
5083 (l1 (< (version-list-not-zero l1) 0))
5084 ;; l1 null and l2 not null ==> l2 length > l1 length
5085 (t (< 0 (version-list-not-zero l2)))))
5088 (defun version-list-= (l1 l2)
5089 "Return t if L1, a list specification of a version, is equal to L2.
5091 Note that a version specified by the list (1) is equal to (1 0),
5092 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5093 Also, a version given by the list (1) is higher than (1 -1), which in
5094 turn is higher than (1 -2), which is higher than (1 -3)."
5095 (while (and l1 l2 (= (car l1) (car l2)))
5096 (setq l1 (cdr l1)
5097 l2 (cdr l2)))
5098 (cond
5099 ;; l1 not null and l2 not null
5100 ((and l1 l2) nil)
5101 ;; l1 null and l2 null ==> l1 length = l2 length
5102 ((and (null l1) (null l2)))
5103 ;; l1 not null and l2 null ==> l1 length > l2 length
5104 (l1 (zerop (version-list-not-zero l1)))
5105 ;; l1 null and l2 not null ==> l2 length > l1 length
5106 (t (zerop (version-list-not-zero l2)))))
5109 (defun version-list-<= (l1 l2)
5110 "Return t if L1, a list specification of a version, is lower or equal to L2.
5112 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
5113 etc. That is, the trailing zeroes are insignificant. Also, integer
5114 list (1) is greater than (1 -1) which is greater than (1 -2)
5115 which is greater than (1 -3)."
5116 (while (and l1 l2 (= (car l1) (car l2)))
5117 (setq l1 (cdr l1)
5118 l2 (cdr l2)))
5119 (cond
5120 ;; l1 not null and l2 not null
5121 ((and l1 l2) (< (car l1) (car l2)))
5122 ;; l1 null and l2 null ==> l1 length = l2 length
5123 ((and (null l1) (null l2)))
5124 ;; l1 not null and l2 null ==> l1 length > l2 length
5125 (l1 (<= (version-list-not-zero l1) 0))
5126 ;; l1 null and l2 not null ==> l2 length > l1 length
5127 (t (<= 0 (version-list-not-zero l2)))))
5129 (defun version-list-not-zero (lst)
5130 "Return the first non-zero element of LST, which is a list of integers.
5132 If all LST elements are zeros or LST is nil, return zero."
5133 (while (and lst (zerop (car lst)))
5134 (setq lst (cdr lst)))
5135 (if lst
5136 (car lst)
5137 ;; there is no element different of zero
5138 0))
5141 (defun version< (v1 v2)
5142 "Return t if version V1 is lower (older) than V2.
5149 (version-list-< (version-to-list v1) (version-to-list v2)))
5151 (defun version<= (v1 v2)
5152 "Return t if version V1 is lower (older) than or equal to V2.
5159 (version-list-<= (version-to-list v1) (version-to-list v2)))
5161 (defun version= (v1 v2)
5162 "Return t if version V1 is equal to V2.
5169 (version-list-= (version-to-list v1) (version-to-list v2)))
5171 (defvar package--builtin-versions
5172 ;; Mostly populated by loaddefs.el via autoload-builtin-package-versions.
5173 (purecopy `((emacs . ,(version-to-list emacs-version))))
5174 "Alist giving the version of each versioned builtin package.
5175 I.e. each element of the list is of the form (NAME . VERSION) where
5176 NAME is the package name as a symbol, and VERSION is its version
5177 as a list.")
5179 (defun package--description-file (dir)
5180 (concat (let ((subdir (file-name-nondirectory
5181 (directory-file-name dir))))
5182 (if (string-match "\\([^.].*?\\)-\\([0-9]+\\(?:[.][0-9]+\\|\\(?:pre\\|beta\\|alpha\\)[0-9]+\\)*\\)" subdir)
5183 (match-string 1 subdir) subdir))
5184 "-pkg.el"))
5186 \f
5187 ;;; Thread support.
5189 (defmacro with-mutex (mutex &rest body)
5190 "Invoke BODY with MUTEX held, releasing MUTEX when done.
5191 This is the simplest safe way to acquire and release a mutex."
5192 (declare (indent 1) (debug t))
5193 (let ((sym (make-symbol "mutex")))
5194 `(let ((,sym ,mutex))
5195 (mutex-lock ,sym)
5196 (unwind-protect
5197 (progn ,@body)
5198 (mutex-unlock ,sym)))))
5200 \f
5201 ;;; Misc.
5203 (defvar definition-prefixes (make-hash-table :test 'equal)
5204 "Hash table mapping prefixes to the files in which they're used.
5205 This can be used to automatically fetch not-yet-loaded definitions.
5206 More specifically, if there is a value of the form (FILES...) for a string PREFIX
5207 it means that the FILES define variables or functions with names that start
5208 with PREFIX.
5210 Note that it does not imply that all definitions starting with PREFIX can
5216 (defun register-definition-prefixes (file prefixes)
5217 "Register that FILE uses PREFIXES."
5218 (dolist (prefix prefixes)
5219 (puthash prefix (cons file (gethash prefix definition-prefixes))
5220 definition-prefixes)))
5222 (defconst menu-bar-separator '("--")
5223 "Separator for menus.")
5225 ;; The following statement ought to be in print.c, but `provide' can't
5226 ;; be used there.
5227 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
5228 (when (hash-table-p (car (read-from-string
5229 (prin1-to-string (make-hash-table)))))
5230 (provide 'hashtable-print-readable))
5232 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
5233 ;; generate file names for autoloads, custom-deps, and finder-data.
5234 (defun unmsys--file-name (file)
5235 "Produce the canonical file name for FILE from its MSYS form.
5237 On systems other than MS-Windows, just returns FILE.
5238 On MS-Windows, converts /d/foo/bar form of file names
5239 passed by MSYS Make into d:/foo/bar that Emacs can grok.
5241 This function is called from lisp/Makefile and leim/Makefile."
5242 (when (and (eq system-type 'windows-nt)
5244 (setq file (concat (substring file 1 2) ":" (substring file 2))))
5245 file)
5248 ;;; subr.el ends here