| blob | ca184d8fc81c9e0732fb99f28dd21b8cc0400b0c |
1 ;;; subr.el --- basic lisp subroutines for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2018 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 If FORM returns differing values when running under Testcover,
82 Testcover will raise an error."
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)"
115 def-body)))
116 ;; Note that this definition should not use backquotes; subr.el should not
117 ;; depend on backquote.el.
121 "Set variable VAR to value VAL in current buffer."
122 ;; Can't use backquote here, it's too early in the bootstrap.
127 "Define VAR as a buffer-local variable with default value VAL.
128 Like `defvar' but additionally marks the variable as being automatically
129 buffer-local wherever it is set."
131 ;; Can't use backquote here, it's too early in the bootstrap.
136 "Add NEWELT to the list stored in the generalized variable PLACE.
137 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
138 except that PLACE is only evaluated once (after NEWELT)."
141 ;; Important special case, to avoid triggering GV too early in
142 ;; the bootstrap.
151 "Return the first element of PLACE's value, and remove it from the list.
152 PLACE must be a generalized variable whose value is a list.
153 If the value is nil, `pop' returns nil but does not actually
154 change the list."
156 ;; We use `car-safe' here instead of `car' because the behavior is the same
157 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
158 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
159 ;; result is not used.
162 ;; So we can use `pop' in the bootstrap before `gv' can be used.
169 "If COND yields non-nil, do BODY, else return nil.
170 When COND yields non-nil, eval BODY forms sequentially and return
171 value of last one, or nil if there are none.
173 \(fn COND BODY...)"
178 "If COND yields nil, do BODY, else return nil.
179 When COND yields nil, eval BODY forms sequentially and return
180 value of last one, or nil if there are none.
182 \(fn COND BODY...)"
187 "Loop over a list.
188 Evaluate BODY with VAR bound to each car from LIST, in turn.
189 Then evaluate RESULT to get return value, default nil.
191 \(fn (VAR LIST [RESULT]) BODY...)"
197 ;; It would be cleaner to create an uninterned symbol,
198 ;; but that uses a lot more space when many functions in many files
199 ;; use dolist.
200 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
202 ;; This is not a reliable test, but it does not matter because both
203 ;; semantics are acceptable, tho one is slightly faster with dynamic
204 ;; scoping and the other is slightly faster (and has cleaner semantics)
205 ;; with lexical scoping.
210 ,@body
217 ,@body
223 "Loop a certain number of times.
224 Evaluate BODY with VAR bound to successive integers running from 0,
225 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
226 the return value (nil if RESULT is omitted). Its use is deprecated.
228 \(fn (VAR COUNT [RESULT]) BODY...)"
230 ;; It would be cleaner to create an uninterned symbol,
231 ;; but that uses a lot more space when many functions in many files
232 ;; use dotimes.
233 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
237 ;; This is not a reliable test, but it does not matter because both
238 ;; semantics are acceptable, tho one is slightly faster with dynamic
239 ;; scoping and the other has cleaner semantics.
249 ;; FIXME: This let often leads to "unused var" warnings.
254 ,@body
259 "Do not evaluate any arguments, and return nil.
260 If a `declare' form appears as the first form in the body of a
261 `defun' or `defmacro' form, SPECS specifies various additional
262 information about the function or macro; these go into effect
263 during the evaluation of the `defun' or `defmacro' form.
265 The possible values of SPECS are specified by
266 `defun-declarations-alist' and `macro-declarations-alist'.
268 For more information, see info node `(elisp)Declare Form'."
269 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
270 nil)
273 "Execute BODY; if an error occurs, return nil.
274 Otherwise, return result of last form in BODY.
275 See also `with-demoted-errors' that does something similar
276 without silencing all errors."
279 \f
280 ;;;; Basic Lisp functions.
286 "Return a new uninterned symbol.
287 The name is made by appending `gensym-counter' to PREFIX.
294 "Do nothing and return nil.
295 This function accepts any number of arguments, but ignores them."
297 nil)
299 ;; Signal a compile-error if the first arg is missing.
301 "Signal an error, making a message by passing args to `format-message'.
302 In Emacs, the convention is that error messages start with a capital
303 letter but *do not* end with a period. Please follow this convention
304 for the sake of consistency.
312 "Signal a pilot error, making a message by passing args to `format-message'.
313 In Emacs, the convention is that error messages start with a capital
314 letter but *do not* end with a period. Please follow this convention
315 for the sake of consistency.
316 This is just like `error' except that `user-error's are expected to be the
317 result of an incorrect manipulation on the part of the user, rather than the
318 result of an actual problem.
325 "Define NAME as a new error signal.
326 MESSAGE is a string that will be output to the echo area if such an error
327 is signaled without being caught by a `condition-case'.
328 PARENT is either a signal or a list of signals from which it inherits.
329 Defaults to `error'."
338 parent))
344 ;; We put this here instead of in frame.el so that it's defined even on
345 ;; systems where frame.el isn't loaded.
347 "Return non-nil if OBJECT seems to be a frame configuration.
348 Any list whose car is `frame-configuration' is assumed to be a frame
349 configuration."
354 "Return a function that is a partial application of FUN to ARGS.
355 ARGS is a list of the first N arguments to pass to FUN.
356 The result is a new function which does the same as FUN, except that
357 the first N arguments are fixed at the values with which this function
358 was called."
362 \f
363 ;;;; List functions.
365 ;; Note: `internal--compiler-macro-cXXr' was copied from
366 ;; `cl--compiler-macro-cXXr' in cl-macs.el. If you amend either one,
367 ;; you may want to amend the other, too.
375 x)
380 x)))
383 "Return the car of the car of X."
388 "Return the car of the cdr of X."
393 "Return the cdr of the car of X."
398 "Return the cdr of the cdr of X."
403 "Return the `car' of the `car' of the `car' of X."
408 "Return the `car' of the `car' of the `cdr' of X."
413 "Return the `car' of the `cdr' of the `car' of X."
418 "Return the `car' of the `cdr' of the `cdr' of X."
423 "Return the `cdr' of the `car' of the `car' of X."
428 "Return the `cdr' of the `car' of the `cdr' of X."
433 "Return the `cdr' of the `cdr' of the `car' of X."
438 "Return the `cdr' of the `cdr' of the `cdr' of X."
443 "Return the `car' of the `car' of the `car' of the `car' of X."
448 "Return the `car' of the `car' of the `car' of the `cdr' of X."
453 "Return the `car' of the `car' of the `cdr' of the `car' of X."
458 "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
463 "Return the `car' of the `cdr' of the `car' of the `car' of X."
468 "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
473 "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
478 "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
483 "Return the `cdr' of the `car' of the `car' of the `car' of X."
488 "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
493 "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
498 "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
503 "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
508 "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
513 "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
518 "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
523 "Return the last link of LIST. Its car is the last element.
524 If LIST is nil, return nil.
525 If N is non-nil, return the Nth-to-last link of LIST.
526 If N is bigger than the length of LIST, return LIST."
535 "Return a copy of LIST with the last N elements removed.
536 If N is omitted or nil, the last element is removed from the
537 copy."
542 "Modifies LIST to remove the last N elements.
543 If N is omitted or nil, remove the last element."
549 list))))
552 "Return t if NUMBER is zero."
553 ;; Used to be in C, but it's pointless since (= 0 n) is faster anyway because
554 ;; = has a byte-code.
559 "Destructively remove `equal' duplicates from LIST.
560 Store the result in LIST and return it. LIST must be a proper list.
561 Of several `equal' occurrences of an element in LIST, the first
562 one is kept."
578 list)
580 ;; See https://lists.gnu.org/r/emacs-devel/2013-05/msg00204.html
582 "Destructively remove `equal' consecutive duplicates from LIST.
583 First and last elements are considered consecutive if CIRCULAR is
584 non-nil."
592 last
595 list)
598 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
599 INC is the increment used between numbers in the sequence and defaults to 1.
600 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
601 zero. TO is only included if there is an N for which TO = FROM + N * INC.
602 If TO is nil or numerically equal to FROM, return (FROM).
603 If INC is positive and TO is less than FROM, or INC is negative
604 and TO is larger than FROM, return nil.
605 If INC is zero and TO is neither nil nor numerically equal to
606 FROM, signal an error.
608 This function is primarily designed for integer arguments.
609 Nevertheless, FROM, TO and INC can be integer or float. However,
610 floating point arithmetic is inexact. For instance, depending on
611 the machine, it may quite well happen that
612 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
613 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
614 elements. Thus, if some of the arguments are floats and one wants
615 to make sure that TO is included, one may have to explicitly write
616 TO as (+ FROM (* N INC)) or use a variable whose value was
617 computed with this exact expression. Alternatively, you can,
618 of course, also replace TO with a slightly larger value
619 \(or a slightly more negative value if INC is negative)."
626 ;; The (>= next last) condition protects against integer
627 ;; overflow in computing NEXT.
631 last next
640 "Make a copy of TREE.
641 If TREE is a cons cell, this recursively copies both its car and its cdr.
642 Contrast to `copy-sequence', which copies only along the cdrs. With second
643 argument VECP, this copies vectors as well as conses."
658 tree)
659 tree)))
660 \f
661 ;;;; Various list-search functions.
664 "Find object KEY in a pseudo-alist ALIST.
665 ALIST is a list of conses or objects. Each element
666 (or the element's car, if it is a cons) is compared with KEY by
667 calling TEST, with two arguments: (i) the element or its car,
668 and (ii) KEY.
669 If that is non-nil, the element matches; then `assoc-default'
670 returns the element's cdr, if it is a cons, or DEFAULT if the
671 element is not a cons.
673 If no element matches, the value is nil.
674 If TEST is omitted or nil, `equal' is used."
681 value))
684 "Like `member', but ignore differences in case and text representation.
685 ELT must be a string. Upper-case and lower-case letters are treated as equal.
686 Unibyte strings are converted to multibyte for comparison.
687 Non-strings in LIST are ignored."
692 list)
695 "Delete from ALIST all elements whose car is KEY.
696 Compare keys with TEST. Defaults to `equal'.
697 Return the modified alist.
698 Elements of ALIST that are not conses are ignored."
709 alist)
712 "Delete from ALIST all elements whose car is `eq' to KEY.
713 Return the modified alist.
714 Elements of ALIST that are not conses are ignored."
718 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
719 Return the modified alist.
720 Elements of ALIST that are not conses are ignored."
730 alist)
733 "Return the value associated with KEY in ALIST.
734 If KEY is not found in ALIST, return DEFAULT.
735 Use TESTFN to lookup in the alist if non-nil. Otherwise, use `assq'.
737 This is a generalized variable suitable for use with `setf'.
738 When using it to set a value, optional argument REMOVE non-nil
739 means to remove KEY from ALIST if the new value is `eql' to DEFAULT."
747 "Return a copy of SEQ with all occurrences of ELT removed.
748 SEQ must be a list, vector, or string. The comparison is done with `equal'."
750 ;; If SEQ isn't a list, there's no need to copy SEQ because
751 ;; `delete' will return a new object.
756 "Return LIST with all occurrences of ELT removed.
757 The comparison is done with `eq'. Contrary to `delq', this does not use
758 side-effects, and the argument LIST is not modified."
762 list))
763 \f
764 ;;;; Keymap support.
767 "Convert KEYS to the internal Emacs key representation.
768 KEYS should be a string in the format returned by commands such
769 as `C-h k' (`describe-key').
770 This is the same format used for saving keyboard macros (see
771 `edmacro-mode').
773 For an approximate inverse of this, see `key-description'."
774 ;; Don't use a defalias, since the `pure' property is only true for
775 ;; the calling convention of `kbd'.
780 "Beep to tell the user this binding is undefined."
787 ;; If this is a down-mouse event, don't reset prefix-arg;
788 ;; pass it to the command run by the up event.
791 current-prefix-arg)))
793 ;; Prevent the \{...} documentation construct
794 ;; from mentioning keys that run this command.
798 "Make MAP override all normally self-inserting keys to be undefined.
799 Normally, as an exception, digits and minus-sign are set to make prefix args,
800 but optional second arg NODIGITS non-nil treats them like other chars."
805 ;; Make plain numbers do numeric args.
812 "Construct a new keymap composed of MAPS and inheriting from PARENT.
813 When looking up a key in the returned map, the key is looked in each
814 keymap of MAPS in turn until a binding is found.
815 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
816 As always with keymap inheritance, a nil binding in MAPS overrides
817 any corresponding binding in PARENT, but it does not override corresponding
818 bindings in other keymaps of MAPS.
819 MAPS can be a list of keymaps or a single keymap.
820 PARENT if non-nil should be a keymap."
826 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
827 This is like `define-key' except that the binding for KEY is placed
828 just after the binding for the event AFTER, instead of at the beginning
829 of the map. Note that AFTER must be an event type (like KEY), NOT a command
830 \(like DEFINITION).
832 If AFTER is t or omitted, the new binding goes at the end of the keymap.
833 AFTER should be a single event type--a symbol or a character, not a sequence.
835 Bindings are always added before any inherited map.
837 The order of bindings in a keymap only matters when it is used as
838 a menu, so this function is not useful for non-menu keymaps."
850 ;; Delete any earlier bindings for the same key.
853 ;; If we hit an included map, go down that one.
855 ;; When we reach AFTER's binding, insert the new binding after.
856 ;; If we reach an inherited keymap, insert just before that.
857 ;; If we reach the end of this keymap, insert at the end.
863 ;; Stop the scan only if we find a parent keymap.
864 ;; Keep going past the inserted element
865 ;; so we can delete any duplications that come later.
868 ;; Don't insert more than once.
875 "Implement `map-keymap' with sorting.
876 Don't call this function; it is for internal use only."
879 keymap)
885 t)
887 ;; string< also accepts symbols.
893 "Return the binding part of a menu-item."
901 binding)))
909 "Build a menu-item like ITEM but with its binding changed to BINDING."
916 ;; Remove any potential filter.
919 item)
925 "Merge bindings VAL1 and VAL2."
929 ;; There's nothing to merge: val1 takes precedence.
930 val1
936 "Return a simpler equivalent keymap.
937 This resolves inheritance and redefinitions. The returned keymap
938 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
939 and use in active keymaps and menus.
940 Subkeymaps may be modified but are not canonicalized."
941 ;; FIXME: Problem with the difference between a nil binding
942 ;; that hides a binding in an inherited map and a nil binding that's ignored
943 ;; to let some further binding visible. Currently a nil binding hides all.
944 ;; FIXME: we may want to carefully (re)order elements in case they're
945 ;; menu-entries.
953 ;; Treat char-ranges specially.
956 map)))
957 ;; Create the new map.
960 ;; Treat char-ranges specially. FIXME: need to merge as well.
962 ;; Process the bindings starting from the end.
967 ;; The normal case: no duplicate bindings.
968 binding
969 ;; This is the second binding for this key.
973 bindings)))
979 "Translate character FROM to TO on the current terminal.
980 This function creates a `keyboard-translate-table' if necessary
981 and then modifies one entry in it."
986 \f
987 ;;;; Key binding commands.
990 "Give KEY a global binding as COMMAND.
991 COMMAND is the command definition to use; usually it is
992 a symbol naming an interactively-callable function.
993 KEY is a key sequence; noninteractively, it is a string or vector
994 of characters or event types, and non-ASCII characters with codes
995 above 127 (such as ISO Latin-1) can be included if you use a vector.
997 Note that if KEY has a local binding in the current buffer,
998 that local binding will continue to shadow any global binding
999 that you make with this function."
1011 "Give KEY a local binding as COMMAND.
1012 COMMAND is the command definition to use; usually it is
1013 a symbol naming an interactively-callable function.
1014 KEY is a key sequence; noninteractively, it is a string or vector
1015 of characters or event types, and non-ASCII characters with codes
1016 above 127 (such as ISO Latin-1) can be included if you use a vector.
1018 The binding goes in the current buffer's local map, which in most
1019 cases is shared with all other buffers in the same major mode."
1029 "Remove global binding of KEY.
1030 KEY is a string or vector representing a sequence of keystrokes."
1035 "Remove local binding of KEY.
1036 KEY is a string or vector representing a sequence of keystrokes."
1040 nil)
1041 \f
1042 ;;;; substitute-key-definition and its subroutines.
1048 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
1049 In other words, OLDDEF is replaced with NEWDEF wherever it appears.
1050 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
1051 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
1053 If you don't specify OLDMAP, you can usually get the same results
1054 in a cleaner way with command remapping, like this:
1055 (define-key KEYMAP [remap OLDDEF] NEWDEF)
1057 ;; Don't document PREFIX in the doc string because we don't want to
1058 ;; advertise it. It's meant for recursive calls only. Here's its
1059 ;; meaning
1061 ;; If optional argument PREFIX is specified, it should be a key
1062 ;; prefix, a string. Redefined bindings will then be bound to the
1063 ;; original key, with PREFIX added at the front.
1067 (key-substitution-in-progress
1068 (cons scan key-substitution-in-progress)))
1069 ;; Scan OLDMAP, finding each char or event-symbol that
1070 ;; has any definition, and act on it with hack-key.
1071 (map-keymap
1072 (lambda (char defn)
1073 (aset prefix1 (length prefix) char)
1074 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
1075 scan)))
1077 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
1078 (let (inner-def skipped menu-item)
1079 ;; Find the actual command name within the binding.
1080 (if (eq (car-safe defn) 'menu-item)
1081 (setq menu-item defn defn (nth 2 defn))
1082 ;; Skip past menu-prompt.
1083 (while (stringp (car-safe defn))
1084 (push (pop defn) skipped))
1085 ;; Skip past cached key-equivalence data for menu items.
1086 (if (consp (car-safe defn))
1087 (setq defn (cdr defn))))
1088 (if (or (eq defn olddef)
1089 ;; Compare with equal if definition is a key sequence.
1090 ;; That is useful for operating on function-key-map.
1091 (and (or (stringp defn) (vectorp defn))
1092 (equal defn olddef)))
1093 (define-key keymap prefix
1094 (if menu-item
1095 (let ((copy (copy-sequence menu-item)))
1096 (setcar (nthcdr 2 copy) newdef)
1097 copy)
1098 (nconc (nreverse skipped) newdef)))
1099 ;; Look past a symbol that names a keymap.
1100 (setq inner-def
1101 (or (indirect-function defn) defn))
1102 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
1103 ;; avoid autoloading a keymap. This is mostly done to preserve the
1104 ;; original non-autoloading behavior of pre-map-keymap times.
1105 (if (and (keymapp inner-def)
1106 ;; Avoid recursively scanning
1107 ;; where KEYMAP does not have a submap.
1108 (let ((elt (lookup-key keymap prefix)))
1109 (or (null elt) (natnump elt) (keymapp elt)))
1110 ;; Avoid recursively rescanning keymap being scanned.
1111 (not (memq inner-def key-substitution-in-progress)))
1112 ;; If this one isn't being scanned already, scan it now.
1113 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
1115 \f
1116 ;;;; The global keymap tree.
1118 ;; global-map, esc-map, and ctl-x-map have their values set up in
1119 ;; keymap.c; we just give them docstrings here.
1121 (defvar global-map nil
1122 "Default global keymap mapping Emacs keyboard input into commands.
1123 The value is a keymap which is usually (but not necessarily) Emacs's
1124 global map.")
1126 (defvar esc-map nil
1127 "Default keymap for ESC (meta) commands.
1128 The normal global definition of the character ESC indirects to this keymap.")
1130 (defvar ctl-x-map nil
1131 "Default keymap for C-x commands.
1132 The normal global definition of the character C-x indirects to this keymap.")
1134 (defvar ctl-x-4-map (make-sparse-keymap)
1135 "Keymap for subcommands of C-x 4.")
1136 (defalias 'ctl-x-4-prefix ctl-x-4-map)
1137 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
1139 (defvar ctl-x-5-map (make-sparse-keymap)
1140 "Keymap for frame commands.")
1141 (defalias 'ctl-x-5-prefix ctl-x-5-map)
1142 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
1144 \f
1145 ;;;; Event manipulation functions.
1147 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
1149 (defun listify-key-sequence (key)
1150 "Convert a key sequence to a list of events."
1151 (if (vectorp key)
1152 (append key nil)
1153 (mapcar (function (lambda (c)
1154 (if (> c 127)
1155 (logxor c listify-key-sequence-1)
1156 c)))
1157 key)))
1159 (defun eventp (obj)
1160 "True if the argument is an event object."
1161 (when obj
1162 (or (integerp obj)
1163 (and (symbolp obj) obj (not (keywordp obj)))
1164 (and (consp obj) (symbolp (car obj))))))
1166 (defun event-modifiers (event)
1167 "Return a list of symbols representing the modifier keys in event EVENT.
1168 The elements of the list may include `meta', `control',
1169 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
1170 and `down'.
1171 EVENT may be an event or an event type. If EVENT is a symbol
1172 that has never been used in an event that has been read as input
1173 in the current Emacs session, then this function may fail to include
1174 the `click' modifier."
1175 (let ((type event))
1176 (if (listp type)
1177 (setq type (car type)))
1178 (if (symbolp type)
1179 ;; Don't read event-symbol-elements directly since we're not
1180 ;; sure the symbol has already been parsed.
1181 (cdr (internal-event-symbol-parse-modifiers type))
1182 (let ((list nil)
1183 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
1184 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
1185 (if (not (zerop (logand type ?\M-\^@)))
1186 (push 'meta list))
1187 (if (or (not (zerop (logand type ?\C-\^@)))
1188 (< char 32))
1189 (push 'control list))
1190 (if (or (not (zerop (logand type ?\S-\^@)))
1191 (/= char (downcase char)))
1192 (push 'shift list))
1193 (or (zerop (logand type ?\H-\^@))
1194 (push 'hyper list))
1195 (or (zerop (logand type ?\s-\^@))
1196 (push 'super list))
1197 (or (zerop (logand type ?\A-\^@))
1198 (push 'alt list))
1199 list))))
1201 (defun event-basic-type (event)
1202 "Return the basic type of the given event (all modifiers removed).
1203 The value is a printing character (not upper case) or a symbol.
1204 EVENT may be an event or an event type. If EVENT is a symbol
1205 that has never been used in an event that has been read as input
1206 in the current Emacs session, then this function may return nil."
1207 (if (consp event)
1208 (setq event (car event)))
1209 (if (symbolp event)
1210 (car (get event 'event-symbol-elements))
1211 (let* ((base (logand event (1- ?\A-\^@)))
1212 (uncontrolled (if (< base 32) (logior base 64) base)))
1213 ;; There are some numbers that are invalid characters and
1214 ;; cause `downcase' to get an error.
1215 (condition-case ()
1216 (downcase uncontrolled)
1217 (error uncontrolled)))))
1219 (defsubst mouse-movement-p (object)
1220 "Return non-nil if OBJECT is a mouse movement event."
1221 (eq (car-safe object) 'mouse-movement))
1223 (defun mouse-event-p (object)
1224 "Return non-nil if OBJECT is a mouse click event."
1225 ;; is this really correct? maybe remove mouse-movement?
1226 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
1228 (defun event-start (event)
1229 "Return the starting position of EVENT.
1230 EVENT should be a mouse click, drag, or key press event. If
1231 EVENT is nil, the value of `posn-at-point' is used instead.
1233 The following accessor functions are used to access the elements
1234 of the position:
1236 `posn-window': The window the event is in.
1237 `posn-area': A symbol identifying the area the event occurred in,
1238 or nil if the event occurred in the text area.
1239 `posn-point': The buffer position of the event.
1240 `posn-x-y': The pixel-based coordinates of the event.
1241 `posn-col-row': The estimated column and row corresponding to the
1242 position of the event.
1243 `posn-actual-col-row': The actual column and row corresponding to the
1244 position of the event.
1245 `posn-string': The string object of the event, which is either
1246 nil or (STRING . POSITION)'.
1247 `posn-image': The image object of the event, if any.
1248 `posn-object': The image or string object of the event, if any.
1249 `posn-timestamp': The time the event occurred, in milliseconds.
1251 For more information, see Info node `(elisp)Click Events'."
1252 (if (consp event) (nth 1 event)
1253 (or (posn-at-point)
1254 (list (selected-window) (point) '(0 . 0) 0))))
1256 (defun event-end (event)
1257 "Return the ending position of EVENT.
1258 EVENT should be a click, drag, or key press event.
1260 See `event-start' for a description of the value returned."
1261 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1262 (or (posn-at-point)
1263 (list (selected-window) (point) '(0 . 0) 0))))
1265 (defsubst event-click-count (event)
1266 "Return the multi-click count of EVENT, a click or drag event.
1267 The return value is a positive integer."
1268 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1270 (defsubst event-line-count (event)
1271 "Return the line count of EVENT, a mousewheel event.
1272 The return value is a positive integer."
1273 (if (and (consp event) (integerp (nth 3 event))) (nth 3 event) 1))
1274 \f
1275 ;;;; Extracting fields of the positions in an event.
1277 (defun posnp (obj)
1278 "Return non-nil if OBJ appears to be a valid `posn' object specifying a window.
1279 A `posn' object is returned from functions such as `event-start'.
1280 If OBJ is a valid `posn' object, but specifies a frame rather
1281 than a window, return nil."
1282 ;; FIXME: Correct the behavior of this function so that all valid
1283 ;; `posn' objects are recognized, after updating other code that
1284 ;; depends on its present behavior.
1285 (and (windowp (car-safe obj))
1286 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1287 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1288 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1290 (defsubst posn-window (position)
1291 "Return the window in POSITION.
1292 POSITION should be a list of the form returned by the `event-start'
1293 and `event-end' functions."
1294 (nth 0 position))
1296 (defsubst posn-area (position)
1297 "Return the window area recorded in POSITION, or nil for the text area.
1298 POSITION should be a list of the form returned by the `event-start'
1299 and `event-end' functions."
1300 (let ((area (if (consp (nth 1 position))
1301 (car (nth 1 position))
1302 (nth 1 position))))
1303 (and (symbolp area) area)))
1305 (defun posn-point (position)
1306 "Return the buffer location in POSITION.
1307 POSITION should be a list of the form returned by the `event-start'
1308 and `event-end' functions.
1309 Returns nil if POSITION does not correspond to any buffer location (e.g.
1310 a click on a scroll bar)."
1311 (or (nth 5 position)
1312 (let ((pt (nth 1 position)))
1313 (or (car-safe pt)
1314 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1315 (if (integerp pt) pt)))))
1317 (defun posn-set-point (position)
1318 "Move point to POSITION.
1319 Select the corresponding window as well."
1320 (if (not (windowp (posn-window position)))
1321 (error "Position not in text area of window"))
1322 (select-window (posn-window position))
1323 (if (numberp (posn-point position))
1324 (goto-char (posn-point position))))
1326 (defsubst posn-x-y (position)
1327 "Return the x and y coordinates in POSITION.
1328 The return value has the form (X . Y), where X and Y are given in
1329 pixels. POSITION should be a list of the form returned by
1330 `event-start' and `event-end'."
1331 (nth 2 position))
1333 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1335 (defun posn-col-row (position)
1336 "Return the nominal column and row in POSITION, measured in characters.
1337 The column and row values are approximations calculated from the x
1338 and y coordinates in POSITION and the frame's default character width
1339 and default line height, including spacing.
1340 For a scroll-bar event, the result column is 0, and the row
1341 corresponds to the vertical position of the click in the scroll bar.
1342 POSITION should be a list of the form returned by the `event-start'
1343 and `event-end' functions."
1344 (let* ((pair (posn-x-y position))
1345 (frame-or-window (posn-window position))
1346 (frame (if (framep frame-or-window)
1347 frame-or-window
1348 (window-frame frame-or-window)))
1349 (window (when (windowp frame-or-window) frame-or-window))
1350 (area (posn-area position)))
1351 (cond
1352 ((null frame-or-window)
1353 '(0 . 0))
1354 ((eq area 'vertical-scroll-bar)
1355 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1356 ((eq area 'horizontal-scroll-bar)
1357 (cons (scroll-bar-scale pair (window-width window)) 0))
1358 (t
1359 ;; FIXME: This should take line-spacing properties on
1360 ;; newlines into account.
1361 (let* ((spacing (when (display-graphic-p frame)
1362 (or (with-current-buffer
1363 (window-buffer (frame-selected-window frame))
1364 line-spacing)
1365 (frame-parameter frame 'line-spacing)))))
1366 (cond ((floatp spacing)
1367 (setq spacing (truncate (* spacing
1368 (frame-char-height frame)))))
1369 ((null spacing)
1370 (setq spacing 0)))
1371 (cons (/ (car pair) (frame-char-width frame))
1372 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
1374 (defun posn-actual-col-row (position)
1375 "Return the window row number in POSITION and character number in that row.
1377 Return nil if POSITION does not contain the actual position; in that case
1378 `posn-col-row' can be used to get approximate values.
1379 POSITION should be a list of the form returned by the `event-start'
1380 and `event-end' functions.
1382 This function does not account for the width on display, like the
1383 number of visual columns taken by a TAB or image. If you need
1384 the coordinates of POSITION in character units, you should use
1385 `posn-col-row', not this function."
1386 (nth 6 position))
1388 (defsubst posn-timestamp (position)
1389 "Return the timestamp of POSITION.
1390 POSITION should be a list of the form returned by the `event-start'
1391 and `event-end' functions."
1392 (nth 3 position))
1394 (defun posn-string (position)
1395 "Return the string object of POSITION.
1396 Value is a cons (STRING . STRING-POS), or nil if not a string.
1397 POSITION should be a list of the form returned by the `event-start'
1398 and `event-end' functions."
1399 (let ((x (nth 4 position)))
1400 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1401 (when (consp x) x)))
1403 (defsubst posn-image (position)
1404 "Return the image object of POSITION.
1405 Value is a list (image ...), or nil if not an image.
1406 POSITION should be a list of the form returned by the `event-start'
1407 and `event-end' functions."
1408 (nth 7 position))
1410 (defsubst posn-object (position)
1411 "Return the object (image or string) of POSITION.
1412 Value is a list (image ...) for an image object, a cons cell
1413 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1414 POSITION should be a list of the form returned by the `event-start'
1415 and `event-end' functions."
1416 (or (posn-image position) (posn-string position)))
1418 (defsubst posn-object-x-y (position)
1419 "Return the x and y coordinates relative to the object of POSITION.
1420 The return value has the form (DX . DY), where DX and DY are
1421 given in pixels. POSITION should be a list of the form returned
1422 by `event-start' and `event-end'."
1423 (nth 8 position))
1425 (defsubst posn-object-width-height (position)
1426 "Return the pixel width and height of the object of POSITION.
1427 The return value has the form (WIDTH . HEIGHT). POSITION should
1428 be a list of the form returned by `event-start' and `event-end'."
1429 (nth 9 position))
1431 \f
1432 ;;;; Obsolescent names for functions.
1434 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1435 (make-obsolete 'buffer-has-markers-at nil "24.3")
1437 (make-obsolete 'invocation-directory "use the variable of the same name."
1438 "27.1")
1439 (make-obsolete 'invocation-name "use the variable of the same name." "27.1")
1441 ;; We used to declare string-to-unibyte obsolete, but it is a valid
1442 ;; way of getting a unibyte string that can be indexed by bytes, when
1443 ;; the original string has raw bytes in their internal multibyte
1444 ;; representation. This can be useful when one needs to examine
1445 ;; individual bytes at known offsets from the string beginning.
1446 ;; (make-obsolete 'string-to-unibyte "use `encode-coding-string'." "26.1")
1447 ;; bug#23850
1448 (make-obsolete 'string-as-unibyte "use `encode-coding-string'." "26.1")
1449 (make-obsolete 'string-make-unibyte "use `encode-coding-string'." "26.1")
1450 (make-obsolete 'string-to-multibyte "use `decode-coding-string'." "26.1")
1451 (make-obsolete 'string-as-multibyte "use `decode-coding-string'." "26.1")
1452 (make-obsolete 'string-make-multibyte "use `decode-coding-string'." "26.1")
1454 (defun log10 (x)
1455 "Return (log X 10), the log base 10 of X."
1456 (declare (obsolete log "24.4"))
1457 (log x 10))
1459 (set-advertised-calling-convention
1460 'all-completions '(string collection &optional predicate) "23.1")
1461 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1462 (set-advertised-calling-convention 'indirect-function '(object) "25.1")
1463 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1464 (set-advertised-calling-convention 'libxml-parse-xml-region '(start end &optional base-url) "27.1")
1465 (set-advertised-calling-convention 'libxml-parse-html-region '(start end &optional base-url) "27.1")
1466 \f
1467 ;;;; Obsolescence declarations for variables, and aliases.
1469 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1470 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1471 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1472 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1473 (make-obsolete-variable 'redisplay-dont-pause nil "24.5")
1474 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1475 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1477 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1478 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1480 (make-obsolete-variable 'command-debug-status
1481 "expect it to be removed in a future version." "25.2")
1483 ;; This was introduced in 21.4 for pre-unicode unification. That
1484 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1485 ;; Other uses are possible, so this variable is not _really_ obsolete,
1486 ;; but Stefan insists to mark it so.
1487 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1489 (make-obsolete-variable 'x-gtk-use-window-move nil "26.1")
1491 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1492 \f
1493 ;;;; Alternate names for functions - these are not being phased out.
1495 (defalias 'send-string 'process-send-string)
1496 (defalias 'send-region 'process-send-region)
1497 (defalias 'string= 'string-equal)
1498 (defalias 'string< 'string-lessp)
1499 (defalias 'string> 'string-greaterp)
1500 (defalias 'move-marker 'set-marker)
1501 (defalias 'rplaca 'setcar)
1502 (defalias 'rplacd 'setcdr)
1503 (defalias 'beep 'ding) ;preserve lingual purity
1504 (defalias 'indent-to-column 'indent-to)
1505 (defalias 'backward-delete-char 'delete-backward-char)
1506 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1507 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1508 (defalias 'int-to-string 'number-to-string)
1509 (defalias 'store-match-data 'set-match-data)
1510 (defalias 'chmod 'set-file-modes)
1511 (defalias 'mkdir 'make-directory)
1512 ;; These are the XEmacs names:
1513 (defalias 'point-at-eol 'line-end-position)
1514 (defalias 'point-at-bol 'line-beginning-position)
1516 (defalias 'user-original-login-name 'user-login-name)
1518 \f
1519 ;;;; Hook manipulation functions.
1521 (defun add-hook (hook function &optional append local)
1522 "Add to the value of HOOK the function FUNCTION.
1523 FUNCTION is not added if already present.
1524 FUNCTION is added (if necessary) at the beginning of the hook list
1525 unless the optional argument APPEND is non-nil, in which case
1526 FUNCTION is added at the end.
1528 The optional fourth argument, LOCAL, if non-nil, says to modify
1529 the hook's buffer-local value rather than its global value.
1530 This makes the hook buffer-local, and it makes t a member of the
1531 buffer-local value. That acts as a flag to run the hook
1532 functions of the global value as well as in the local value.
1534 HOOK should be a symbol, and FUNCTION may be any valid function. If
1535 HOOK is void, it is first set to nil. If HOOK's value is a single
1536 function, it is changed to a list of functions."
1537 (or (boundp hook) (set hook nil))
1538 (or (default-boundp hook) (set-default hook nil))
1539 (if local (unless (local-variable-if-set-p hook)
1540 (set (make-local-variable hook) (list t)))
1541 ;; Detect the case where make-local-variable was used on a hook
1542 ;; and do what we used to do.
1543 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1544 (setq local t)))
1545 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1546 ;; If the hook value is a single function, turn it into a list.
1547 (when (or (not (listp hook-value)) (functionp hook-value))
1548 (setq hook-value (list hook-value)))
1549 ;; Do the actual addition if necessary
1550 (unless (member function hook-value)
1551 (when (stringp function)
1552 (setq function (purecopy function)))
1553 (setq hook-value
1554 (if append
1555 (append hook-value (list function))
1556 (cons function hook-value))))
1557 ;; Set the actual variable
1558 (if local
1559 (progn
1560 ;; If HOOK isn't a permanent local,
1561 ;; but FUNCTION wants to survive a change of modes,
1562 ;; mark HOOK as partially permanent.
1563 (and (symbolp function)
1564 (get function 'permanent-local-hook)
1565 (not (get hook 'permanent-local))
1566 (put hook 'permanent-local 'permanent-local-hook))
1567 (set hook hook-value))
1568 (set-default hook hook-value))))
1570 (defun remove-hook (hook function &optional local)
1571 "Remove from the value of HOOK the function FUNCTION.
1572 HOOK should be a symbol, and FUNCTION may be any valid function. If
1573 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1574 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1576 The optional third argument, LOCAL, if non-nil, says to modify
1577 the hook's buffer-local value rather than its default value."
1578 (or (boundp hook) (set hook nil))
1579 (or (default-boundp hook) (set-default hook nil))
1580 ;; Do nothing if LOCAL is t but this hook has no local binding.
1581 (unless (and local (not (local-variable-p hook)))
1582 ;; Detect the case where make-local-variable was used on a hook
1583 ;; and do what we used to do.
1584 (when (and (local-variable-p hook)
1585 (not (and (consp (symbol-value hook))
1586 (memq t (symbol-value hook)))))
1587 (setq local t))
1588 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1589 ;; Remove the function, for both the list and the non-list cases.
1590 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1591 (if (equal hook-value function) (setq hook-value nil))
1592 (setq hook-value (delete function (copy-sequence hook-value))))
1593 ;; If the function is on the global hook, we need to shadow it locally
1594 ;;(when (and local (member function (default-value hook))
1595 ;; (not (member (cons 'not function) hook-value)))
1596 ;; (push (cons 'not function) hook-value))
1597 ;; Set the actual variable
1598 (if (not local)
1599 (set-default hook hook-value)
1600 (if (equal hook-value '(t))
1601 (kill-local-variable hook)
1602 (set hook hook-value))))))
1604 (defmacro letrec (binders &rest body)
1605 "Bind variables according to BINDERS then eval BODY.
1606 The value of the last form in BODY is returned.
1607 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1608 SYMBOL to the value of VALUEFORM.
1609 All symbols are bound before the VALUEFORMs are evalled."
1610 ;; Only useful in lexical-binding mode.
1611 ;; As a special-form, we could implement it more efficiently (and cleanly,
1612 ;; making the vars actually unbound during evaluation of the binders).
1613 (declare (debug let) (indent 1))
1614 `(let ,(mapcar #'car binders)
1615 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1616 ,@body))
1618 (defmacro with-wrapper-hook (hook args &rest body)
1619 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1621 around the preceding ones, like a set of nested `around' advices.
1623 Each hook function should accept an argument list consisting of a
1624 function FUN, followed by the additional arguments in ARGS.
1626 The first hook function in HOOK is passed a FUN that, if it is called
1627 with arguments ARGS, performs BODY (i.e., the default operation).
1628 The FUN passed to each successive hook function is defined based
1629 on the preceding hook functions; if called with arguments ARGS,
1630 it does what the `with-wrapper-hook' call would do if the
1631 preceding hook functions were the only ones present in HOOK.
1633 Each hook function may call its FUN argument as many times as it wishes,
1634 including never. In that case, such a hook function acts to replace
1635 the default definition altogether, and any preceding hook functions.
1636 Of course, a subsequent hook function may do the same thing.
1638 Each hook function definition is used to construct the FUN passed
1640 FUN is then called once."
1641 (declare (indent 2) (debug (form sexp body))
1642 (obsolete "use a <foo>-function variable modified by `add-function'."
1643 "24.4"))
1644 `(subr--with-wrapper-hook-no-warnings ,hook ,args ,@body))
1646 (defmacro subr--with-wrapper-hook-no-warnings (hook args &rest body)
1647 "Like (with-wrapper-hook HOOK ARGS BODY), but without warnings."
1648 ;; We need those two gensyms because CL's lexical scoping is not available
1649 ;; for function arguments :-(
1650 (let ((funs (make-symbol "funs"))
1651 (global (make-symbol "global"))
1652 (argssym (make-symbol "args"))
1653 (runrestofhook (make-symbol "runrestofhook")))
1654 ;; Since the hook is a wrapper, the loop has to be done via
1655 ;; recursion: a given hook function will call its parameter in order to
1656 ;; continue looping.
1657 `(letrec ((,runrestofhook
1658 (lambda (,funs ,global ,argssym)
1659 ;; `funs' holds the functions left on the hook and `global'
1660 ;; holds the functions left on the global part of the hook
1661 ;; (in case the hook is local).
1662 (if (consp ,funs)
1663 (if (eq t (car ,funs))
1664 (funcall ,runrestofhook
1665 (append ,global (cdr ,funs)) nil ,argssym)
1666 (apply (car ,funs)
1667 (apply-partially
1668 (lambda (,funs ,global &rest ,argssym)
1669 (funcall ,runrestofhook ,funs ,global ,argssym))
1670 (cdr ,funs) ,global)
1671 ,argssym))
1672 ;; Once there are no more functions on the hook, run
1673 ;; the original body.
1674 (apply (lambda ,args ,@body) ,argssym)))))
1675 (funcall ,runrestofhook ,hook
1676 ;; The global part of the hook, if any.
1677 ,(if (symbolp hook)
1678 `(if (local-variable-p ',hook)
1679 (default-value ',hook)))
1680 (list ,@args)))))
1682 (defun add-to-list (list-var element &optional append compare-fn)
1683 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1684 The test for presence of ELEMENT is done with `equal', or with
1685 COMPARE-FN if that's non-nil.
1686 If ELEMENT is added, it is added at the beginning of the list,
1687 unless the optional argument APPEND is non-nil, in which case
1688 ELEMENT is added at the end.
1690 The return value is the new value of LIST-VAR.
1692 This is handy to add some elements to configuration variables,
1693 but please do not abuse it in Elisp code, where you are usually
1694 better off using `push' or `cl-pushnew'.
1696 If you want to use `add-to-list' on a variable that is not
1697 defined until a certain package is loaded, you should put the
1698 call to `add-to-list' into a hook function that will be run only
1699 after loading the package. `eval-after-load' provides one way to
1700 do this. In some cases other hooks, such as major mode hooks,
1701 can do the job."
1702 (declare
1703 (compiler-macro
1704 (lambda (exp)
1705 ;; FIXME: Something like this could be used for `set' as well.
1706 (if (or (not (eq 'quote (car-safe list-var)))
1707 (special-variable-p (cadr list-var))
1708 (not (macroexp-const-p append)))
1709 exp
1710 (let* ((sym (cadr list-var))
1711 (append (eval append))
1712 (msg (format-message
1713 "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1714 sym))
1715 ;; Big ugly hack so we only output a warning during
1716 ;; byte-compilation, and so we can use
1717 ;; byte-compile-not-lexical-var-p to silence the warning
1718 ;; when a defvar has been seen but not yet executed.
1719 (warnfun (lambda ()
1720 ;; FIXME: We should also emit a warning for let-bound
1721 ;; variables with dynamic binding.
1722 (when (assq sym byte-compile--lexical-environment)
1723 (byte-compile-report-error msg :fill))))
1724 (code
1725 (macroexp-let2 macroexp-copyable-p x element
1726 `(if ,(if compare-fn
1727 (progn
1728 (require 'cl-lib)
1729 `(cl-member ,x ,sym :test ,compare-fn))
1730 ;; For bootstrapping reasons, don't rely on
1731 ;; cl--compiler-macro-member for the base case.
1732 `(member ,x ,sym))
1733 ,sym
1734 ,(if append
1735 `(setq ,sym (append ,sym (list ,x)))
1736 `(push ,x ,sym))))))
1737 (if (not (macroexp--compiling-p))
1738 code
1739 `(progn
1740 (macroexp--funcall-if-compiled ',warnfun)
1741 ,code)))))))
1742 (if (cond
1743 ((null compare-fn)
1744 (member element (symbol-value list-var)))
1745 ((eq compare-fn 'eq)
1746 (memq element (symbol-value list-var)))
1747 ((eq compare-fn 'eql)
1748 (memql element (symbol-value list-var)))
1749 (t
1750 (let ((lst (symbol-value list-var)))
1751 (while (and lst
1752 (not (funcall compare-fn element (car lst))))
1753 (setq lst (cdr lst)))
1754 lst)))
1755 (symbol-value list-var)
1756 (set list-var
1757 (if append
1758 (append (symbol-value list-var) (list element))
1759 (cons element (symbol-value list-var))))))
1762 (defun add-to-ordered-list (list-var element &optional order)
1763 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1764 The test for presence of ELEMENT is done with `eq'.
1766 The resulting list is reordered so that the elements are in the
1767 order given by each element's numeric list order. Elements
1768 without a numeric list order are placed at the end of the list.
1770 If the third optional argument ORDER is a number (integer or
1771 float), set the element's list order to the given value. If
1772 ORDER is nil or omitted, do not change the numeric order of
1773 ELEMENT. If ORDER has any other value, remove the numeric order
1774 of ELEMENT if it has one.
1776 The list order for each element is stored in LIST-VAR's
1777 `list-order' property.
1779 The return value is the new value of LIST-VAR."
1780 (let ((ordering (get list-var 'list-order)))
1781 (unless ordering
1782 (put list-var 'list-order
1783 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1784 (when order
1785 (puthash element (and (numberp order) order) ordering))
1786 (unless (memq element (symbol-value list-var))
1787 (set list-var (cons element (symbol-value list-var))))
1788 (set list-var (sort (symbol-value list-var)
1789 (lambda (a b)
1790 (let ((oa (gethash a ordering))
1791 (ob (gethash b ordering)))
1792 (if (and oa ob)
1793 (< oa ob)
1794 oa)))))))
1796 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1797 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1798 Return the new history list.
1799 If MAXELT is non-nil, it specifies the maximum length of the history.
1800 Otherwise, the maximum history length is the value of the `history-length'
1801 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1802 variable. The possible values of maximum length have the same meaning as
1803 the values of `history-length'.
1804 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1805 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1806 if it is empty or duplicates the most recent entry in the history."
1807 (unless maxelt
1808 (setq maxelt (or (get history-var 'history-length)
1809 history-length)))
1810 (let ((history (symbol-value history-var))
1811 tail)
1812 (when (and (listp history)
1813 (or keep-all
1814 (not (stringp newelt))
1815 (> (length newelt) 0))
1816 (or keep-all
1817 (not (equal (car history) newelt))))
1818 (if history-delete-duplicates
1819 (setq history (delete newelt history)))
1820 (setq history (cons newelt history))
1821 (when (integerp maxelt)
1822 (if (>= 0 maxelt)
1823 (setq history nil)
1824 (setq tail (nthcdr (1- maxelt) history))
1825 (when (consp tail)
1826 (setcdr tail nil))))
1827 (set history-var history))))
1829 \f
1830 ;;;; Mode hooks.
1832 (defvar delay-mode-hooks nil
1833 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1834 (defvar-local delayed-mode-hooks nil
1835 "List of delayed mode hooks waiting to be run.")
1836 (put 'delay-mode-hooks 'permanent-local t)
1838 (defvar-local delayed-after-hook-functions nil
1839 "List of delayed :after-hook forms waiting to be run.
1840 These forms come from `define-derived-mode'.")
1842 (defvar change-major-mode-after-body-hook nil
1843 "Normal hook run in major mode functions, before the mode hooks.")
1845 (defvar after-change-major-mode-hook nil
1846 "Normal hook run at the very end of major mode functions.")
1848 (defun run-mode-hooks (&rest hooks)
1849 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1850 Call `hack-local-variables' to set up file local and directory local
1851 variables.
1853 If the variable `delay-mode-hooks' is non-nil, does not do anything,
1854 just adds the HOOKS to the list `delayed-mode-hooks'.
1855 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1856 `delayed-mode-hooks' (in reverse order), HOOKS, then runs
1857 `hack-local-variables', runs the hook `after-change-major-mode-hook', and
1858 finally evaluates the functions in `delayed-after-hook-functions' (see
1859 `define-derived-mode').
1861 Major mode functions should use this instead of `run-hooks' when
1862 running their FOO-mode-hook."
1863 (if delay-mode-hooks
1864 ;; Delaying case.
1865 (dolist (hook hooks)
1866 (push hook delayed-mode-hooks))
1867 ;; Normal case, just run the hook as before plus any delayed hooks.
1868 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1869 (and (bound-and-true-p syntax-propertize-function)
1870 (not (local-variable-p 'parse-sexp-lookup-properties))
1871 ;; `syntax-propertize' sets `parse-sexp-lookup-properties' for us, but
1872 ;; in order for the sexp primitives to automatically call
1873 ;; `syntax-propertize' we need `parse-sexp-lookup-properties' to be
1874 ;; set first.
1875 (setq-local parse-sexp-lookup-properties t))
1876 (setq delayed-mode-hooks nil)
1877 (apply #'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1878 (if (buffer-file-name)
1879 (with-demoted-errors "File local-variables error: %s"
1880 (hack-local-variables 'no-mode)))
1881 (run-hooks 'after-change-major-mode-hook)
1882 (dolist (fun (prog1 (nreverse delayed-after-hook-functions)
1883 (setq delayed-after-hook-functions nil)))
1884 (funcall fun))))
1886 (defmacro delay-mode-hooks (&rest body)
1887 "Execute BODY, but delay any `run-mode-hooks'.
1888 These hooks will be executed by the first following call to
1889 `run-mode-hooks' that occurs outside any `delay-mode-hooks' form.
1890 Only affects hooks run in the current buffer."
1891 (declare (debug t) (indent 0))
1892 `(progn
1893 (make-local-variable 'delay-mode-hooks)
1894 (let ((delay-mode-hooks t))
1895 ,@body)))
1897 ;; PUBLIC: find if the current mode derives from another.
1899 (defun provided-mode-derived-p (mode &rest modes)
1900 "Non-nil if MODE is derived from one of MODES.
1901 Uses the `derived-mode-parent' property of the symbol to trace backwards.
1902 If you just want to check `major-mode', use `derived-mode-p'."
1903 (while (and (not (memq mode modes))
1904 (setq mode (get mode 'derived-mode-parent))))
1905 mode)
1907 (defun derived-mode-p (&rest modes)
1908 "Non-nil if the current major mode is derived from one of MODES.
1909 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1910 (apply #'provided-mode-derived-p major-mode modes))
1912 (defvar-local major-mode--suspended nil)
1913 (put 'major-mode--suspended 'permanent-local t)
1915 (defun major-mode-suspend ()
1916 "Exit current major, remembering it."
1917 (let* ((prev-major-mode (or major-mode--suspended
1918 (unless (eq major-mode 'fundamental-mode)
1919 major-mode))))
1920 (kill-all-local-variables)
1921 (setq-local major-mode--suspended prev-major-mode)))
1923 (defun major-mode-restore (&optional avoided-modes)
1924 "Restore major mode earlier suspended with `major-mode-suspend'.
1925 If there was no earlier suspended major mode, then fallback to `normal-mode',
1926 tho trying to avoid AVOIDED-MODES."
1927 (if major-mode--suspended
1928 (funcall (prog1 major-mode--suspended
1929 (kill-local-variable 'major-mode--suspended)))
1930 (let ((auto-mode-alist
1931 (let ((alist (copy-sequence auto-mode-alist)))
1932 (dolist (mode avoided-modes)
1933 (setq alist (rassq-delete-all mode alist)))
1934 alist))
1935 (magic-fallback-mode-alist
1936 (let ((alist (copy-sequence magic-fallback-mode-alist)))
1937 (dolist (mode avoided-modes)
1938 (setq alist (rassq-delete-all mode alist)))
1939 alist)))
1940 (normal-mode))))
1941 \f
1942 ;;;; Minor modes.
1944 ;; If a minor mode is not defined with define-minor-mode,
1945 ;; add it here explicitly.
1946 ;; isearch-mode is deliberately excluded, since you should
1947 ;; not call it yourself.
1948 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1949 overwrite-mode view-mode
1950 hs-minor-mode)
1951 "List of all minor mode functions.")
1953 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1954 "Register a new minor mode.
1956 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1958 TOGGLE is a symbol which is the name of a buffer-local variable that
1959 is toggled on or off to say whether the minor mode is active or not.
1961 NAME specifies what will appear in the mode line when the minor mode
1962 is active. NAME should be either a string starting with a space, or a
1963 symbol whose value is such a string.
1965 Optional KEYMAP is the keymap for the minor mode that will be added
1966 to `minor-mode-map-alist'.
1968 Optional AFTER specifies that TOGGLE should be added after AFTER
1969 in `minor-mode-alist'.
1971 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1972 It defaults to (and should by convention be) TOGGLE.
1974 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1975 included in the mode-line minor mode menu.
1976 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1977 (unless (memq toggle minor-mode-list)
1978 (push toggle minor-mode-list))
1980 (unless toggle-fun (setq toggle-fun toggle))
1981 (unless (eq toggle-fun toggle)
1982 (put toggle :minor-mode-function toggle-fun))
1983 ;; Add the name to the minor-mode-alist.
1984 (when name
1985 (let ((existing (assq toggle minor-mode-alist)))
1986 (if existing
1987 (setcdr existing (list name))
1988 (let ((tail minor-mode-alist) found)
1989 (while (and tail (not found))
1990 (if (eq after (caar tail))
1991 (setq found tail)
1992 (setq tail (cdr tail))))
1993 (if found
1994 (let ((rest (cdr found)))
1995 (setcdr found nil)
1996 (nconc found (list (list toggle name)) rest))
1997 (push (list toggle name) minor-mode-alist))))))
1998 ;; Add the toggle to the minor-modes menu if requested.
1999 (when (get toggle :included)
2000 (define-key mode-line-mode-menu
2001 (vector toggle)
2002 (list 'menu-item
2003 (concat
2004 (or (get toggle :menu-tag)
2005 (if (stringp name) name (symbol-name toggle)))
2006 (let ((mode-name (if (symbolp name) (symbol-value name))))
2007 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
2008 (concat " (" (match-string 0 mode-name) ")"))))
2009 toggle-fun
2010 :button (cons :toggle toggle))))
2012 ;; Add the map to the minor-mode-map-alist.
2013 (when keymap
2014 (let ((existing (assq toggle minor-mode-map-alist)))
2015 (if existing
2016 (setcdr existing keymap)
2017 (let ((tail minor-mode-map-alist) found)
2018 (while (and tail (not found))
2019 (if (eq after (caar tail))
2020 (setq found tail)
2021 (setq tail (cdr tail))))
2022 (if found
2023 (let ((rest (cdr found)))
2024 (setcdr found nil)
2025 (nconc found (list (cons toggle keymap)) rest))
2026 (push (cons toggle keymap) minor-mode-map-alist)))))))
2027 \f
2028 ;;;; Load history
2030 (defsubst autoloadp (object)
2031 "Non-nil if OBJECT is an autoload."
2032 (eq 'autoload (car-safe object)))
2034 ;; (defun autoload-type (object)
2035 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
2036 ;; OBJECT should be an autoload object."
2037 ;; (when (autoloadp object)
2038 ;; (let ((type (nth 3 object)))
2039 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
2040 ;; ((eq 'keymap t) 'macro)
2041 ;; (type)))))
2043 ;; (defalias 'autoload-file #'cadr
2044 ;; "Return the name of the file from which AUTOLOAD will be loaded.
2047 (defun define-symbol-prop (symbol prop val)
2048 "Define the property PROP of SYMBOL to be VAL.
2049 This is to `put' what `defalias' is to `fset'."
2050 ;; Can't use `cl-pushnew' here (nor `push' on (cdr foo)).
2051 ;; (cl-pushnew symbol (alist-get prop
2052 ;; (alist-get 'define-symbol-props
2053 ;; current-load-list)))
2054 (let ((sps (assq 'define-symbol-props current-load-list)))
2055 (unless sps
2056 (setq sps (list 'define-symbol-props))
2057 (push sps current-load-list))
2058 (let ((ps (assq prop sps)))
2059 (unless ps
2060 (setq ps (list prop))
2061 (setcdr sps (cons ps (cdr sps))))
2062 (unless (member symbol (cdr ps))
2063 (setcdr ps (cons symbol (cdr ps))))))
2064 (put symbol prop val))
2066 (defun symbol-file (symbol &optional type)
2067 "Return the name of the file that defined SYMBOL.
2068 The value is normally an absolute file name. It can also be nil,
2069 if the definition is not associated with any file. If SYMBOL
2070 specifies an autoloaded function, the value can be a relative
2071 file name without extension.
2073 If TYPE is nil, then any kind of definition is acceptable. If
2074 TYPE is `defun', `defvar', or `defface', that specifies function
2075 definition, variable definition, or face definition only.
2076 Otherwise TYPE is assumed to be a symbol property."
2077 (if (and (or (null type) (eq type 'defun))
2078 (symbolp symbol)
2079 (autoloadp (symbol-function symbol)))
2080 (nth 1 (symbol-function symbol))
2081 (catch 'found
2082 (pcase-dolist (`(,file . ,elems) load-history)
2083 (when (if type
2084 (if (eq type 'defvar)
2085 ;; Variables are present just as their names.
2086 (member symbol elems)
2087 ;; Many other types are represented as (TYPE . NAME).
2088 (or (member (cons type symbol) elems)
2089 (memq symbol (alist-get type
2090 (alist-get 'define-symbol-props
2091 elems)))))
2092 ;; We accept all types, so look for variable def
2093 ;; and then for any other kind.
2094 (or (member symbol elems)
2095 (let ((match (rassq symbol elems)))
2096 (and match
2097 (not (eq 'require (car match)))))))
2098 (throw 'found file))))))
2100 (defun locate-library (library &optional nosuffix path interactive-call)
2101 "Show the precise file name of Emacs library LIBRARY.
2102 LIBRARY should be a relative file name of the library, a string.
2103 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
2104 nil (which is the default, see below).
2107 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
2108 to the specified name LIBRARY.
2110 If the optional third arg PATH is specified, that list of directories
2111 is used instead of `load-path'.
2113 When called from a program, the file name is normally returned as a
2114 string. When run interactively, the argument INTERACTIVE-CALL is t,
2115 and the file name is displayed in the echo area."
2116 (interactive (list (completing-read "Locate library: "
2117 (apply-partially
2118 'locate-file-completion-table
2119 load-path (get-load-suffixes)))
2120 nil nil
2121 t))
2122 (let ((file (locate-file library
2123 (or path load-path)
2124 (append (unless nosuffix (get-load-suffixes))
2125 load-file-rep-suffixes))))
2126 (if interactive-call
2127 (if file
2128 (message "Library is file %s" (abbreviate-file-name file))
2129 (message "No library %s in search path" library)))
2130 file))
2132 \f
2133 ;;;; Process stuff.
2135 (defun start-process (name buffer program &rest program-args)
2136 "Start a program in a subprocess. Return the process object for it.
2137 NAME is name for process. It is modified if necessary to make it unique.
2138 BUFFER is the buffer (or buffer name) to associate with the process.
2140 Process output (both standard output and standard error streams)
2141 goes at end of BUFFER, unless you specify a filter function to
2142 handle the output. BUFFER may also be nil, meaning that this
2143 process is not associated with any buffer.
2145 PROGRAM is the program file name. It is searched for in `exec-path'
2146 \(which see). If nil, just associate a pty with the buffer. Remaining
2147 arguments PROGRAM-ARGS are strings to give program as arguments.
2149 If you want to separate standard output from standard error, use
2150 `make-process' or invoke the command through a shell and redirect
2151 one of them using the shell syntax.
2153 The process runs in `default-directory' if that is local (as
2155 otherwise. If you want to run a process in a remote directory
2156 use `start-file-process'."
2157 (unless (fboundp 'make-process)
2158 (error "Emacs was compiled without subprocess support"))
2159 (apply #'make-process
2160 (append (list :name name :buffer buffer)
2161 (if program
2162 (list :command (cons program program-args))))))
2164 (defun process-lines (program &rest args)
2165 "Execute PROGRAM with ARGS, returning its output as a list of lines.
2166 Signal an error if the program returns with a non-zero exit status."
2167 (with-temp-buffer
2168 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
2169 (unless (eq status 0)
2170 (error "%s exited with status %s" program status))
2171 (goto-char (point-min))
2172 (let (lines)
2173 (while (not (eobp))
2174 (setq lines (cons (buffer-substring-no-properties
2175 (line-beginning-position)
2176 (line-end-position))
2177 lines))
2178 (forward-line 1))
2179 (nreverse lines)))))
2181 (defun process-live-p (process)
2182 "Returns non-nil if PROCESS is alive.
2183 A process is considered alive if its status is `run', `open',
2184 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
2185 process."
2186 (and (processp process)
2187 (memq (process-status process)
2188 '(run open listen connect stop))))
2190 (defun process-kill-buffer-query-function ()
2191 "Ask before killing a buffer that has a running process."
2192 (let ((process (get-buffer-process (current-buffer))))
2193 (or (not process)
2194 (not (memq (process-status process) '(run stop open listen)))
2195 (not (process-query-on-exit-flag process))
2196 (yes-or-no-p
2197 (format "Buffer %S has a running process; kill it? "
2198 (buffer-name (current-buffer)))))))
2200 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
2202 ;; process plist management
2204 (defun process-get (process propname)
2205 "Return the value of PROCESS' PROPNAME property.
2206 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
2207 (plist-get (process-plist process) propname))
2209 (defun process-put (process propname value)
2210 "Change PROCESS' PROPNAME property to VALUE.
2211 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2212 (set-process-plist process
2213 (plist-put (process-plist process) propname value)))
2215 (defun memory-limit ()
2216 "Return an estimate of Emacs virtual memory usage, divided by 1024."
2217 (or (cdr (assq 'vsize (process-attributes (emacs-pid)))) 0))
2219 \f
2220 ;;;; Input and display facilities.
2222 (defconst read-key-empty-map (make-sparse-keymap))
2224 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2226 (defun read-key (&optional prompt)
2227 "Read a key from the keyboard.
2228 Contrary to `read-event' this will not return a raw event but instead will
2229 obey the input decoding and translations usually done by `read-key-sequence'.
2230 So escape sequences and keyboard encoding are taken into account.
2231 When there's an ambiguity because the key looks like the prefix of
2232 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2233 ;; This overriding-terminal-local-map binding also happens to
2234 ;; disable quail's input methods, so although read-key-sequence
2235 ;; always inherits the input method, in practice read-key does not
2236 ;; inherit the input method (at least not if it's based on quail).
2237 (let ((overriding-terminal-local-map nil)
2238 (overriding-local-map read-key-empty-map)
2239 (echo-keystrokes 0)
2240 (old-global-map (current-global-map))
2241 (timer (run-with-idle-timer
2242 ;; Wait long enough that Emacs has the time to receive and
2243 ;; process all the raw events associated with the single-key.
2244 ;; But don't wait too long, or the user may find the delay
2245 ;; annoying (or keep hitting more keys which may then get
2246 ;; lost or misinterpreted).
2247 ;; This is only relevant for keys which Emacs perceives as
2248 ;; "prefixes", such as C-x (because of the C-x 8 map in
2249 ;; key-translate-table and the C-x @ map in function-key-map)
2250 ;; or ESC (because of terminal escape sequences in
2251 ;; input-decode-map).
2252 read-key-delay t
2253 (lambda ()
2254 (let ((keys (this-command-keys-vector)))
2255 (unless (zerop (length keys))
2256 ;; `keys' is non-empty, so the user has hit at least
2257 ;; one key; there's no point waiting any longer, even
2258 ;; though read-key-sequence thinks we should wait
2259 ;; for more input to decide how to interpret the
2260 ;; current input.
2261 (throw 'read-key keys)))))))
2262 (unwind-protect
2263 (progn
2264 (use-global-map
2265 (let ((map (make-sparse-keymap)))
2266 ;; Don't hide the menu-bar and tool-bar entries.
2267 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2268 (define-key map [tool-bar]
2269 ;; This hack avoids evaluating the :filter (Bug#9922).
2270 (or (cdr (assq 'tool-bar global-map))
2271 (lookup-key global-map [tool-bar])))
2272 map))
2273 (let* ((keys
2274 (catch 'read-key (read-key-sequence-vector prompt nil t)))
2275 (key (aref keys 0)))
2276 (if (and (> (length keys) 1)
2277 (memq key '(mode-line header-line
2278 left-fringe right-fringe)))
2279 (aref keys 1)
2280 key)))
2281 (cancel-timer timer)
2282 ;; For some reason, `read-key(-sequence)' leaves the prompt in the echo
2283 ;; area, whereas `read-event' seems to empty it just before returning
2284 ;; (bug#22714). So, let's mimic the behavior of `read-event'.
2285 (message nil)
2286 (use-global-map old-global-map))))
2288 (defvar read-passwd-map
2289 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2290 ;; minibuffer-local-map along the way!
2291 (let ((map (make-sparse-keymap)))
2292 (set-keymap-parent map minibuffer-local-map)
2293 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2294 map)
2295 "Keymap used while reading passwords.")
2297 (defun read-passwd (prompt &optional confirm default)
2298 "Read a password, prompting with PROMPT, and return it.
2299 If optional CONFIRM is non-nil, read the password twice to make sure.
2300 Optional DEFAULT is a default password to use instead of empty input.
2302 This function echoes `.' for each character that the user types.
2303 You could let-bind `read-hide-char' to another hiding character, though.
2305 Once the caller uses the password, it can erase the password
2306 by doing (clear-string STRING)."
2307 (if confirm
2308 (let (success)
2309 (while (not success)
2310 (let ((first (read-passwd prompt nil default))
2311 (second (read-passwd "Confirm password: " nil default)))
2312 (if (equal first second)
2313 (progn
2314 (and (arrayp second) (not (eq first second)) (clear-string second))
2315 (setq success first))
2316 (and (arrayp first) (clear-string first))
2317 (and (arrayp second) (clear-string second))
2318 (message "Password not repeated accurately; please start over")
2319 (sit-for 1))))
2320 success)
2321 (let ((hide-chars-fun
2322 (lambda (beg end _len)
2323 (clear-this-command-keys)
2324 (setq beg (min end (max (minibuffer-prompt-end)
2325 beg)))
2326 (dotimes (i (- end beg))
2327 (put-text-property (+ i beg) (+ 1 i beg)
2328 'display (string (or read-hide-char ?.))))))
2329 minibuf)
2330 (minibuffer-with-setup-hook
2331 (lambda ()
2332 (setq minibuf (current-buffer))
2333 ;; Turn off electricity.
2334 (setq-local post-self-insert-hook nil)
2335 (setq-local buffer-undo-list t)
2336 (setq-local select-active-regions nil)
2337 (use-local-map read-passwd-map)
2338 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2339 (setq-local show-paren-mode nil) ;bug#16091.
2340 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2341 (unwind-protect
2342 (let ((enable-recursive-minibuffers t)
2343 (read-hide-char (or read-hide-char ?.)))
2344 (read-string prompt nil t default)) ; t = "no history"
2345 (when (buffer-live-p minibuf)
2346 (with-current-buffer minibuf
2347 ;; Not sure why but it seems that there might be cases where the
2348 ;; minibuffer is not always properly reset later on, so undo
2349 ;; whatever we've done here (bug#11392).
2350 (remove-hook 'after-change-functions hide-chars-fun 'local)
2351 (kill-local-variable 'post-self-insert-hook)
2352 ;; And of course, don't keep the sensitive data around.
2353 (erase-buffer))))))))
2355 (defun read-number (prompt &optional default)
2356 "Read a numeric value in the minibuffer, prompting with PROMPT.
2357 DEFAULT specifies a default value to return if the user just types RET.
2358 The value of DEFAULT is inserted into PROMPT.
2359 This function is used by the `interactive' code letter `n'."
2360 (let ((n nil)
2361 (default1 (if (consp default) (car default) default)))
2362 (when default1
2363 (setq prompt
2365 (replace-match (format " (default %s)" default1) t t prompt 1)
2367 (format " (default %s) " default1)
2368 prompt t t))))
2369 (while
2370 (progn
2371 (let ((str (read-from-minibuffer
2372 prompt nil nil nil nil
2373 (when default
2374 (if (consp default)
2375 (mapcar 'number-to-string (delq nil default))
2376 (number-to-string default))))))
2377 (condition-case nil
2378 (setq n (cond
2379 ((zerop (length str)) default1)
2380 ((stringp str) (read str))))
2381 (error nil)))
2382 (unless (numberp n)
2383 (message "Please enter a number.")
2384 (sit-for 1)
2385 t)))
2386 n))
2388 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2389 "Read and return one of CHARS, prompting for PROMPT.
2390 Any input that is not one of CHARS is ignored.
2392 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2393 keyboard-quit events while waiting for a valid input."
2394 (unless (consp chars)
2395 (error "Called `read-char-choice' without valid char choices"))
2396 (let (char done show-help (helpbuf " *Char Help*"))
2397 (let ((cursor-in-echo-area t)
2398 (executing-kbd-macro executing-kbd-macro)
2399 (esc-flag nil))
2400 (save-window-excursion ; in case we call help-form-show
2401 (while (not done)
2402 (unless (get-text-property 0 'face prompt)
2403 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2404 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2405 (read-key prompt)))
2406 (and show-help (buffer-live-p (get-buffer helpbuf))
2407 (kill-buffer helpbuf))
2408 (cond
2409 ((not (numberp char)))
2410 ;; If caller has set help-form, that's enough.
2411 ;; They don't explicitly have to add help-char to chars.
2412 ((and help-form
2413 (eq char help-char)
2414 (setq show-help t)
2415 (help-form-show)))
2416 ((memq char chars)
2417 (setq done t))
2418 ((and executing-kbd-macro (= char -1))
2419 ;; read-event returns -1 if we are in a kbd macro and
2420 ;; there are no more events in the macro. Attempt to
2421 ;; get an event interactively.
2422 (setq executing-kbd-macro nil))
2423 ((not inhibit-keyboard-quit)
2424 (cond
2425 ((and (null esc-flag) (eq char ?\e))
2426 (setq esc-flag t))
2427 ((memq char '(?\C-g ?\e))
2428 (keyboard-quit))))))))
2429 ;; Display the question with the answer. But without cursor-in-echo-area.
2430 (message "%s%s" prompt (char-to-string char))
2431 char))
2433 (defun sit-for (seconds &optional nodisp obsolete)
2434 "Redisplay, then wait for SECONDS seconds. Stop when input is available.
2435 SECONDS may be a floating-point value.
2436 \(On operating systems that do not support waiting for fractions of a
2437 second, floating-point values are rounded down to the nearest integer.)
2439 If optional arg NODISP is t, don't redisplay, just wait for input.
2440 Redisplay does not happen if input is available before it starts.
2442 Value is t if waited the full time with no input arriving, and nil otherwise.
2444 An obsolete, but still supported form is
2445 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2446 where the optional arg MILLISECONDS specifies an additional wait period,
2447 in milliseconds; this was useful when Emacs was built without
2448 floating point support."
2449 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2450 ;; This used to be implemented in C until the following discussion:
2451 ;; https://lists.gnu.org/r/emacs-devel/2006-07/msg00401.html
2452 ;; Then it was moved here using an implementation based on an idle timer,
2453 ;; which was then replaced by the use of read-event.
2454 (if (numberp nodisp)
2455 (setq seconds (+ seconds (* 1e-3 nodisp))
2456 nodisp obsolete)
2457 (if obsolete (setq nodisp obsolete)))
2458 (cond
2459 (noninteractive
2460 (sleep-for seconds)
2461 t)
2462 ((input-pending-p t)
2463 nil)
2464 ((or (<= seconds 0)
2465 ;; We are going to call read-event below, which will record
2466 ;; the next key as part of the macro, even if that key
2467 ;; invokes kmacro-end-macro, so if we are recording a macro,
2468 ;; the macro will recursively call itself. In addition, when
2469 ;; that key is removed from unread-command-events, it will be
2470 ;; recorded the second time, so the macro will have each key
2471 ;; doubled. This used to happen if a macro was defined with
2472 ;; Flyspell mode active (because Flyspell calls sit-for in its
2473 ;; post-command-hook, see bug #21329.) To avoid all that, we
2474 ;; simply disable the wait when we are recording a macro.
2475 defining-kbd-macro)
2476 (or nodisp (redisplay)))
2477 (t
2478 (or nodisp (redisplay))
2479 ;; FIXME: we should not read-event here at all, because it's much too
2480 ;; difficult to reliably "undo" a read-event by pushing it onto
2481 ;; unread-command-events.
2482 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2483 ;; decoding (hence non-nil as second arg under POSIX ttys).
2484 ;; For bug#15614, we need read-event not to inherit-input-method.
2485 ;; So we temporarily suspend input-method-function.
2486 (let ((read (let ((input-method-function nil))
2487 (read-event nil t seconds))))
2488 (or (null read)
2489 (progn
2490 ;; https://lists.gnu.org/r/emacs-devel/2006-10/msg00394.html
2491 ;; We want `read' appear in the next command's this-command-event
2492 ;; but not in the current one.
2493 ;; By pushing (cons t read), we indicate that `read' has not
2494 ;; yet been recorded in this-command-keys, so it will be recorded
2495 ;; next time it's read.
2496 ;; And indeed the `seconds' argument to read-event correctly
2497 ;; prevented recording this event in the current command's
2498 ;; this-command-keys.
2499 (push (cons t read) unread-command-events)
2500 nil))))))
2502 ;; Behind display-popup-menus-p test.
2503 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2505 (defun y-or-n-p (prompt)
2508 PROMPT is the string to display to ask the question. It should
2511 No confirmation of the answer is requested; a single character is
2512 enough. SPC also means yes, and DEL means no.
2514 To be precise, this function translates user input into responses
2515 by consulting the bindings in `query-replace-map'; see the
2516 documentation of that variable for more information. In this
2517 case, the useful bindings are `act', `skip', `recenter',
2518 `scroll-up', `scroll-down', and `quit'.
2519 An `act' response means yes, and a `skip' response means no.
2520 A `quit' response means to invoke `keyboard-quit'.
2521 If the user enters `recenter', `scroll-up', or `scroll-down'
2522 responses, perform the requested window recentering or scrolling
2523 and ask again.
2525 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2526 is nil and `use-dialog-box' is non-nil."
2527 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2528 ;; where all the keys were unbound (i.e. it somehow got triggered
2529 ;; within read-key, apparently). I had to kill it.
2530 (let ((answer 'recenter)
2531 (padded (lambda (prompt &optional dialog)
2532 (let ((l (length prompt)))
2533 (concat prompt
2534 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2535 "" " ")
2536 (if dialog "" "(y or n) "))))))
2537 (cond
2538 (noninteractive
2539 (setq prompt (funcall padded prompt))
2540 (let ((temp-prompt prompt))
2541 (while (not (memq answer '(act skip)))
2542 (let ((str (read-string temp-prompt)))
2543 (cond ((member str '("y" "Y")) (setq answer 'act))
2544 ((member str '("n" "N")) (setq answer 'skip))
2545 (t (setq temp-prompt (concat "Please answer y or n. "
2546 prompt))))))))
2547 ((and (display-popup-menus-p)
2548 last-input-event ; not during startup
2549 (listp last-nonmenu-event)
2550 use-dialog-box)
2551 (setq prompt (funcall padded prompt t)
2552 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2553 (t
2554 (setq prompt (funcall padded prompt))
2555 (while
2556 (let* ((scroll-actions '(recenter scroll-up scroll-down
2557 scroll-other-window scroll-other-window-down))
2558 (key
2559 (let ((cursor-in-echo-area t))
2560 (when minibuffer-auto-raise
2561 (raise-frame (window-frame (minibuffer-window))))
2562 (read-key (propertize (if (memq answer scroll-actions)
2563 prompt
2564 (concat "Please answer y or n. "
2565 prompt))
2566 'face 'minibuffer-prompt)))))
2567 (setq answer (lookup-key query-replace-map (vector key) t))
2568 (cond
2569 ((memq answer '(skip act)) nil)
2570 ((eq answer 'recenter)
2571 (recenter) t)
2572 ((eq answer 'scroll-up)
2573 (ignore-errors (scroll-up-command)) t)
2574 ((eq answer 'scroll-down)
2575 (ignore-errors (scroll-down-command)) t)
2576 ((eq answer 'scroll-other-window)
2577 (ignore-errors (scroll-other-window)) t)
2578 ((eq answer 'scroll-other-window-down)
2579 (ignore-errors (scroll-other-window-down)) t)
2580 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2581 (signal 'quit nil) t)
2582 (t t)))
2583 (ding)
2584 (discard-input))))
2585 (let ((ret (eq answer 'act)))
2586 (unless noninteractive
2587 (message "%s%c" prompt (if ret ?y ?n)))
2588 ret)))
2590 \f
2591 ;;; Atomic change groups.
2593 (defmacro atomic-change-group (&rest body)
2594 "Like `progn' but perform BODY as an atomic change group.
2595 This means that if BODY exits abnormally,
2596 all of its changes to the current buffer are undone.
2597 This works regardless of whether undo is enabled in the buffer.
2599 This mechanism is transparent to ordinary use of undo;
2600 if undo is enabled in the buffer and BODY succeeds, the
2601 user can undo the change normally."
2602 (declare (indent 0) (debug t))
2603 (let ((handle (make-symbol "--change-group-handle--"))
2604 (success (make-symbol "--change-group-success--")))
2605 `(let ((,handle (prepare-change-group))
2606 ;; Don't truncate any undo data in the middle of this.
2607 (undo-outer-limit nil)
2608 (undo-limit most-positive-fixnum)
2609 (undo-strong-limit most-positive-fixnum)
2610 (,success nil))
2611 (unwind-protect
2612 (progn
2613 ;; This is inside the unwind-protect because
2614 ;; it enables undo if that was disabled; we need
2615 ;; to make sure that it gets disabled again.
2616 (activate-change-group ,handle)
2617 (prog1 ,(macroexp-progn body)
2618 (setq ,success t)))
2619 ;; Either of these functions will disable undo
2620 ;; if it was disabled before.
2621 (if ,success
2622 (accept-change-group ,handle)
2623 (cancel-change-group ,handle))))))
2625 (defun prepare-change-group (&optional buffer)
2626 "Return a handle for the current buffer's state, for a change group.
2627 If you specify BUFFER, make a handle for BUFFER's state instead.
2629 Pass the handle to `activate-change-group' afterward to initiate
2630 the actual changes of the change group.
2632 To finish the change group, call either `accept-change-group' or
2633 `cancel-change-group' passing the same handle as argument. Call
2634 `accept-change-group' to accept the changes in the group as final;
2635 call `cancel-change-group' to undo them all. You should use
2636 `unwind-protect' to make sure the group is always finished. The call
2637 to `activate-change-group' should be inside the `unwind-protect'.
2638 Once you finish the group, don't use the handle again--don't try to
2639 finish the same group twice. For a simple example of correct use, see
2640 the source code of `atomic-change-group'.
2642 The handle records only the specified buffer. To make a multibuffer
2643 change group, call this function once for each buffer you want to
2644 cover, then use `nconc' to combine the returned values, like this:
2646 (nconc (prepare-change-group buffer-1)
2647 (prepare-change-group buffer-2))
2649 You can then activate that multibuffer change group with a single
2650 call to `activate-change-group' and finish it with a single call
2651 to `accept-change-group' or `cancel-change-group'."
2653 (if buffer
2654 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2655 (list (cons (current-buffer) buffer-undo-list))))
2657 (defun activate-change-group (handle)
2658 "Activate a change group made with `prepare-change-group' (which see)."
2659 (dolist (elt handle)
2660 (with-current-buffer (car elt)
2661 (if (eq buffer-undo-list t)
2662 (setq buffer-undo-list nil)))))
2664 (defun accept-change-group (handle)
2665 "Finish a change group made with `prepare-change-group' (which see).
2666 This finishes the change group by accepting its changes as final."
2667 (dolist (elt handle)
2668 (with-current-buffer (car elt)
2669 (if (eq (cdr elt) t)
2670 (setq buffer-undo-list t)))))
2672 (defun cancel-change-group (handle)
2673 "Finish a change group made with `prepare-change-group' (which see).
2674 This finishes the change group by reverting all of its changes."
2675 (dolist (elt handle)
2676 (with-current-buffer (car elt)
2677 (setq elt (cdr elt))
2678 (save-restriction
2679 ;; Widen buffer temporarily so if the buffer was narrowed within
2680 ;; the body of `atomic-change-group' all changes can be undone.
2681 (widen)
2682 (let ((old-car (car-safe elt))
2683 (old-cdr (cdr-safe elt)))
2684 (unwind-protect
2685 (progn
2686 ;; Temporarily truncate the undo log at ELT.
2687 (when (consp elt)
2688 (setcar elt nil) (setcdr elt nil))
2689 (unless (eq last-command 'undo) (undo-start))
2690 ;; Make sure there's no confusion.
2691 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2692 (error "Undoing to some unrelated state"))
2693 ;; Undo it all.
2694 (save-excursion
2695 (while (listp pending-undo-list) (undo-more 1)))
2696 ;; Revert the undo info to what it was when we grabbed
2697 ;; the state.
2698 (setq buffer-undo-list elt))
2699 ;; Reset the modified cons cell ELT to its original content.
2700 (when (consp elt)
2701 (setcar elt old-car)
2702 (setcdr elt old-cdr))))))))
2703 \f
2704 ;;;; Display-related functions.
2706 ;; For compatibility.
2707 (define-obsolete-function-alias 'redraw-modeline
2708 'force-mode-line-update "24.3")
2710 (defun momentary-string-display (string pos &optional exit-char message)
2711 "Momentarily display STRING in the buffer at POS.
2712 Display remains until next event is input.
2713 If POS is a marker, only its position is used; its buffer is ignored.
2714 Optional third arg EXIT-CHAR can be a character, event or event
2715 description list. EXIT-CHAR defaults to SPC. If the input is
2716 EXIT-CHAR it is swallowed; otherwise it is then available as
2717 input (as a command if nothing else).
2718 Display MESSAGE (optional fourth arg) in the echo area.
2719 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2720 (or exit-char (setq exit-char ?\s))
2721 (let ((ol (make-overlay pos pos))
2722 (str (copy-sequence string)))
2723 (unwind-protect
2724 (progn
2725 (save-excursion
2726 (overlay-put ol 'after-string str)
2727 (goto-char pos)
2728 ;; To avoid trouble with out-of-bounds position
2729 (setq pos (point))
2730 ;; If the string end is off screen, recenter now.
2731 (if (<= (window-end nil t) pos)
2732 (recenter (/ (window-height) 2))))
2733 (message (or message "Type %s to continue editing.")
2734 (single-key-description exit-char))
2735 (let ((event (read-key)))
2736 ;; `exit-char' can be an event, or an event description list.
2737 (or (eq event exit-char)
2738 (eq event (event-convert-list exit-char))
2739 (setq unread-command-events
2740 (append (this-single-command-raw-keys)
2741 unread-command-events)))))
2742 (delete-overlay ol))))
2744 \f
2745 ;;;; Overlay operations
2747 (defun copy-overlay (o)
2748 "Return a copy of overlay O."
2749 (let ((o1 (if (overlay-buffer o)
2750 (make-overlay (overlay-start o) (overlay-end o)
2751 ;; FIXME: there's no easy way to find the
2752 ;; insertion-type of the two markers.
2753 (overlay-buffer o))
2754 (let ((o1 (make-overlay (point-min) (point-min))))
2755 (delete-overlay o1)
2756 o1)))
2757 (props (overlay-properties o)))
2758 (while props
2759 (overlay-put o1 (pop props) (pop props)))
2760 o1))
2762 (defun remove-overlays (&optional beg end name val)
2763 "Clear BEG and END of overlays whose property NAME has value VAL.
2764 Overlays might be moved and/or split.
2765 BEG and END default respectively to the beginning and end of buffer."
2766 ;; This speeds up the loops over overlays.
2767 (unless beg (setq beg (point-min)))
2768 (unless end (setq end (point-max)))
2769 (overlay-recenter end)
2770 (if (< end beg)
2771 (setq beg (prog1 end (setq end beg))))
2772 (save-excursion
2773 (dolist (o (overlays-in beg end))
2774 (when (eq (overlay-get o name) val)
2775 ;; Either push this overlay outside beg...end
2776 ;; or split it to exclude beg...end
2777 ;; or delete it entirely (if it is contained in beg...end).
2778 (if (< (overlay-start o) beg)
2779 (if (> (overlay-end o) end)
2780 (progn
2781 (move-overlay (copy-overlay o)
2782 (overlay-start o) beg)
2783 (move-overlay o end (overlay-end o)))
2784 (move-overlay o (overlay-start o) beg))
2785 (if (> (overlay-end o) end)
2786 (move-overlay o end (overlay-end o))
2787 (delete-overlay o)))))))
2788 \f
2789 ;;;; Miscellanea.
2791 (defvar suspend-hook nil
2792 "Normal hook run by `suspend-emacs', before suspending.")
2794 (defvar suspend-resume-hook nil
2795 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2797 (defvar temp-buffer-show-hook nil
2798 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2799 When the hook runs, the temporary buffer is current, and the window it
2800 was displayed in is selected.")
2802 (defvar temp-buffer-setup-hook nil
2803 "Normal hook run by `with-output-to-temp-buffer' at the start.
2804 When the hook runs, the temporary buffer is current.
2805 This hook is normally set up with a function to put the buffer in Help
2806 mode.")
2808 (defconst user-emacs-directory
2809 (if (eq system-type 'ms-dos)
2810 ;; MS-DOS cannot have initial dot.
2811 "~/_emacs.d/"
2812 "~/.emacs.d/")
2813 "Directory beneath which additional per-user Emacs-specific files are placed.
2814 Various programs in Emacs store information in this directory.
2815 Note that this should end with a directory separator.
2816 See also `locate-user-emacs-file'.")
2817 \f
2818 ;;;; Misc. useful functions.
2820 (defsubst buffer-narrowed-p ()
2821 "Return non-nil if the current buffer is narrowed."
2822 (/= (- (point-max) (point-min)) (buffer-size)))
2824 (defun find-tag-default-bounds ()
2825 "Determine the boundaries of the default tag, based on text at point.
2826 Return a cons cell with the beginning and end of the found tag.
2827 If there is no plausible default, return nil."
2828 (bounds-of-thing-at-point 'symbol))
2830 (defun find-tag-default ()
2831 "Determine default tag to search for, based on text at point.
2832 If there is no plausible default, return nil."
2833 (let ((bounds (find-tag-default-bounds)))
2834 (when bounds
2835 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2837 (defun find-tag-default-as-regexp ()
2838 "Return regexp that matches the default tag at point.
2839 If there is no tag at point, return nil.
2841 When in a major mode that does not provide its own
2842 `find-tag-default-function', return a regexp that matches the
2843 symbol at point exactly."
2844 (let ((tag (funcall (or find-tag-default-function
2845 (get major-mode 'find-tag-default-function)
2846 'find-tag-default))))
2847 (if tag (regexp-quote tag))))
2849 (defun find-tag-default-as-symbol-regexp ()
2850 "Return regexp that matches the default tag at point as symbol.
2851 If there is no tag at point, return nil.
2853 When in a major mode that does not provide its own
2854 `find-tag-default-function', return a regexp that matches the
2855 symbol at point exactly."
2856 (let ((tag-regexp (find-tag-default-as-regexp)))
2857 (if (and tag-regexp
2858 (eq (or find-tag-default-function
2859 (get major-mode 'find-tag-default-function)
2860 'find-tag-default)
2861 'find-tag-default))
2863 tag-regexp)))
2865 (defun play-sound (sound)
2866 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2867 The following keywords are recognized:
2869 :file FILE - read sound data from FILE. If FILE isn't an
2870 absolute file name, it is searched in `data-directory'.
2872 :data DATA - read sound data from string DATA.
2874 Exactly one of :file or :data must be present.
2876 :volume VOL - set volume to VOL. VOL must an integer in the
2877 range 0..100 or a float in the range 0..1.0. If not specified,
2878 don't change the volume setting of the sound device.
2880 :device DEVICE - play sound on DEVICE. If not specified,
2881 a system-dependent default device name is used.
2883 Note: :data and :device are currently not supported on Windows."
2884 (if (fboundp 'play-sound-internal)
2885 (play-sound-internal sound)
2886 (error "This Emacs binary lacks sound support")))
2888 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2890 (defun shell-quote-argument (argument)
2891 "Quote ARGUMENT for passing as argument to an inferior shell.
2893 This function is designed to work with the syntax of your system's
2894 standard shell, and might produce incorrect results with unusual shells.
2895 See Info node `(elisp)Security Considerations'."
2896 (cond
2897 ((eq system-type 'ms-dos)
2898 ;; Quote using double quotes, but escape any existing quotes in
2899 ;; the argument with backslashes.
2900 (let ((result "")
2901 (start 0)
2902 end)
2904 (< (match-end 0) (length argument)))
2906 (setq end (match-beginning 0)
2907 result (concat result (substring argument start end)
2909 start (1+ end))))
2912 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2914 ;; First, quote argument so that CommandLineToArgvW will
2915 ;; understand it. See
2916 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2917 ;; After we perform that level of quoting, escape shell
2918 ;; metacharacters so that cmd won't mangle our argument. If the
2919 ;; argument contains no double quote characters, we can just
2920 ;; surround it with double quotes. Otherwise, we need to prefix
2921 ;; each shell metacharacter with a caret.
2923 (setq argument
2924 ;; escape backslashes at end of string
2925 (replace-regexp-in-string
2928 ;; escape backslashes and quotes in string body
2929 (replace-regexp-in-string
2932 argument)))
2935 (concat
2937 (replace-regexp-in-string
2940 argument)
2944 (t
2945 (if (equal argument "")
2946 "''"
2947 ;; Quote everything except POSIX filename characters.
2948 ;; This should be safe enough even for really weird shells.
2949 (replace-regexp-in-string
2952 ))
2954 (defsubst string-to-list (string)
2955 "Return a list of characters in STRING."
2956 (append string nil))
2958 (defsubst string-to-vector (string)
2959 "Return a vector of characters in STRING."
2960 (vconcat string))
2962 (defun string-or-null-p (object)
2963 "Return t if OBJECT is a string or nil.
2964 Otherwise, return nil."
2965 (or (stringp object) (null object)))
2967 (defun booleanp (object)
2968 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2969 Otherwise, return nil."
2970 (and (memq object '(nil t)) t))
2972 (defun special-form-p (object)
2973 "Non-nil if and only if OBJECT is a special form."
2974 (if (and (symbolp object) (fboundp object))
2975 (setq object (indirect-function object)))
2976 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2978 (defun macrop (object)
2979 "Non-nil if and only if OBJECT is a macro."
2980 (let ((def (indirect-function object)))
2981 (when (consp def)
2982 (or (eq 'macro (car def))
2983 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2985 (defun field-at-pos (pos)
2986 "Return the field at position POS, taking stickiness etc into account."
2987 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2988 (if (eq raw-field 'boundary)
2989 (get-char-property (1- (field-end pos)) 'field)
2990 raw-field)))
2992 (defun sha1 (object &optional start end binary)
2993 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2994 OBJECT is either a string or a buffer. Optional arguments START and
2995 END are character positions specifying which portion of OBJECT for
2996 computing the hash. If BINARY is non-nil, return a string in binary
2997 form."
2998 (secure-hash 'sha1 object start end binary))
3000 (defun function-get (f prop &optional autoload)
3001 "Return the value of property PROP of function F.
3002 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
3003 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
3004 if it's an autoloaded macro."
3005 (let ((val nil))
3006 (while (and (symbolp f)
3007 (null (setq val (get f prop)))
3008 (fboundp f))
3009 (let ((fundef (symbol-function f)))
3010 (if (and autoload (autoloadp fundef)
3011 (not (equal fundef
3012 (autoload-do-load fundef f
3013 (if (eq autoload 'macro)
3014 'macro)))))
3015 nil ;Re-try `get' on the same `f'.
3016 (setq f fundef))))
3017 val))
3018 \f
3019 ;;;; Support for yanking and text properties.
3020 ;; Why here in subr.el rather than in simple.el? --Stef
3022 (defvar yank-handled-properties)
3023 (defvar yank-excluded-properties)
3025 (defun remove-yank-excluded-properties (start end)
3026 "Process text properties between START and END, inserted for a `yank'.
3027 Perform the handling specified by `yank-handled-properties', then
3028 remove properties specified by `yank-excluded-properties'."
3029 (let ((inhibit-read-only t))
3030 (dolist (handler yank-handled-properties)
3031 (let ((prop (car handler))
3032 (fun (cdr handler))
3033 (run-start start))
3034 (while (< run-start end)
3035 (let ((value (get-text-property run-start prop))
3036 (run-end (next-single-property-change
3037 run-start prop nil end)))
3038 (funcall fun value run-start run-end)
3039 (setq run-start run-end)))))
3040 (if (eq yank-excluded-properties t)
3041 (set-text-properties start end nil)
3042 (remove-list-of-text-properties start end yank-excluded-properties))))
3044 (defvar yank-undo-function)
3046 (defun insert-for-yank (string)
3047 "Insert STRING at point for the `yank' command.
3049 This function is like `insert', except it honors the variables
3050 `yank-handled-properties' and `yank-excluded-properties', and the
3051 `yank-handler' text property, in the way that `yank' does."
3052 (let (to)
3053 (while (setq to (next-single-property-change 0 'yank-handler string))
3054 (insert-for-yank-1 (substring string 0 to))
3055 (setq string (substring string to))))
3056 (insert-for-yank-1 string))
3058 (defun insert-for-yank-1 (string)
3059 "Helper for `insert-for-yank', which see."
3060 (let* ((handler (and (stringp string)
3061 (get-text-property 0 'yank-handler string)))
3062 (param (or (nth 1 handler) string))
3063 (opoint (point))
3064 (inhibit-read-only inhibit-read-only)
3065 end)
3067 ;; FIXME: This throws away any yank-undo-function set by previous calls
3068 ;; to insert-for-yank-1 within the loop of insert-for-yank!
3069 (setq yank-undo-function t)
3070 (if (nth 0 handler) ; FUNCTION
3071 (funcall (car handler) param)
3072 (insert param))
3073 (setq end (point))
3075 ;; Prevent read-only properties from interfering with the
3076 ;; following text property changes.
3077 (setq inhibit-read-only t)
3079 (unless (nth 2 handler) ; NOEXCLUDE
3080 (remove-yank-excluded-properties opoint end))
3082 ;; If last inserted char has properties, mark them as rear-nonsticky.
3083 (if (and (> end opoint)
3084 (text-properties-at (1- end)))
3085 (put-text-property (1- end) end 'rear-nonsticky t))
3087 (if (eq yank-undo-function t) ; not set by FUNCTION
3088 (setq yank-undo-function (nth 3 handler))) ; UNDO
3089 (if (nth 4 handler) ; COMMAND
3090 (setq this-command (nth 4 handler)))))
3092 (defun insert-buffer-substring-no-properties (buffer &optional start end)
3093 "Insert before point a substring of BUFFER, without text properties.
3094 BUFFER may be a buffer or a buffer name.
3095 Arguments START and END are character positions specifying the substring.
3096 They default to the values of (point-min) and (point-max) in BUFFER."
3097 (let ((opoint (point)))
3098 (insert-buffer-substring buffer start end)
3099 (let ((inhibit-read-only t))
3100 (set-text-properties opoint (point) nil))))
3102 (defun insert-buffer-substring-as-yank (buffer &optional start end)
3103 "Insert before point a part of BUFFER, stripping some text properties.
3104 BUFFER may be a buffer or a buffer name.
3105 Arguments START and END are character positions specifying the substring.
3106 They default to the values of (point-min) and (point-max) in BUFFER.
3107 Before insertion, process text properties according to
3108 `yank-handled-properties' and `yank-excluded-properties'."
3109 ;; Since the buffer text should not normally have yank-handler properties,
3110 ;; there is no need to handle them here.
3111 (let ((opoint (point)))
3112 (insert-buffer-substring buffer start end)
3113 (remove-yank-excluded-properties opoint (point))))
3115 (defun yank-handle-font-lock-face-property (face start end)
3116 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
3117 START and END denote the start and end of the text to act on.
3118 Do nothing if FACE is nil."
3119 (and face
3120 (null font-lock-defaults)
3121 (put-text-property start end 'face face)))
3123 ;; This removes `mouse-face' properties in *Help* buffer buttons:
3124 ;; https://lists.gnu.org/r/emacs-devel/2002-04/msg00648.html
3125 (defun yank-handle-category-property (category start end)
3126 "Apply property category CATEGORY's properties between START and END."
3127 (when category
3128 (let ((start2 start))
3129 (while (< start2 end)
3130 (let ((end2 (next-property-change start2 nil end))
3131 (original (text-properties-at start2)))
3132 (set-text-properties start2 end2 (symbol-plist category))
3133 (add-text-properties start2 end2 original)
3134 (setq start2 end2))))))
3136 \f
3137 ;;;; Synchronous shell commands.
3139 (defun start-process-shell-command (name buffer &rest args)
3140 "Start a program in a subprocess. Return the process object for it.
3141 NAME is name for process. It is modified if necessary to make it unique.
3142 BUFFER is the buffer (or buffer name) to associate with the process.
3143 Process output goes at end of that buffer, unless you specify
3144 an output stream or filter function to handle the output.
3145 BUFFER may be also nil, meaning that this process is not associated
3146 with any buffer
3147 COMMAND is the shell command to run.
3149 An old calling convention accepted any number of arguments after COMMAND,
3150 which were just concatenated to COMMAND. This is still supported but strongly
3151 discouraged."
3152 (declare (advertised-calling-convention (name buffer command) "23.1"))
3153 ;; We used to use `exec' to replace the shell with the command,
3154 ;; but that failed to handle (...) and semicolon, etc.
3155 (start-process name buffer shell-file-name shell-command-switch
3156 (mapconcat 'identity args " ")))
3158 (defun start-file-process-shell-command (name buffer &rest args)
3159 "Start a program in a subprocess. Return the process object for it.
3160 Similar to `start-process-shell-command', but calls `start-file-process'."
3161 (declare (advertised-calling-convention (name buffer command) "23.1"))
3162 (start-file-process
3163 name buffer
3164 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3165 (if (file-remote-p default-directory) "-c" shell-command-switch)
3166 (mapconcat 'identity args " ")))
3168 (defun call-process-shell-command (command &optional infile buffer display
3169 &rest args)
3170 "Execute the shell command COMMAND synchronously in separate process.
3171 The remaining arguments are optional.
3172 The program's input comes from file INFILE (nil means `/dev/null').
3173 Insert output in BUFFER before point; t means current buffer;
3174 nil for BUFFER means discard it; 0 means discard and don't wait.
3175 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3176 REAL-BUFFER says what to do with standard output, as above,
3177 while STDERR-FILE says what to do with standard error in the child.
3178 STDERR-FILE may be nil (discard standard error output),
3179 t (mix it with ordinary output), or a file name string.
3181 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
3182 Wildcards and redirection are handled as usual in the shell.
3184 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
3185 Otherwise it waits for COMMAND to terminate and returns a numeric exit
3186 status or a signal description string.
3187 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
3189 An old calling convention accepted any number of arguments after DISPLAY,
3190 which were just concatenated to COMMAND. This is still supported but strongly
3191 discouraged."
3192 (declare (advertised-calling-convention
3193 (command &optional infile buffer display) "24.5"))
3194 ;; We used to use `exec' to replace the shell with the command,
3195 ;; but that failed to handle (...) and semicolon, etc.
3196 (call-process shell-file-name
3197 infile buffer display
3198 shell-command-switch
3199 (mapconcat 'identity (cons command args) " ")))
3201 (defun process-file-shell-command (command &optional infile buffer display
3202 &rest args)
3203 "Process files synchronously in a separate process.
3204 Similar to `call-process-shell-command', but calls `process-file'."
3205 (declare (advertised-calling-convention
3206 (command &optional infile buffer display) "24.5"))
3207 (process-file
3208 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
3209 infile buffer display
3210 (if (file-remote-p default-directory) "-c" shell-command-switch)
3211 (mapconcat 'identity (cons command args) " ")))
3213 (defun call-shell-region (start end command &optional delete buffer)
3214 "Send text from START to END as input to an inferior shell running COMMAND.
3215 Delete the text if fourth arg DELETE is non-nil.
3217 Insert output in BUFFER before point; t means current buffer; nil for
3218 BUFFER means discard it; 0 means discard and don't wait; and `(:file
3219 FILE)', where FILE is a file name string, means that it should be
3220 written to that file (if the file already exists it is overwritten).
3221 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
3222 REAL-BUFFER says what to do with standard output, as above,
3223 while STDERR-FILE says what to do with standard error in the child.
3224 STDERR-FILE may be nil (discard standard error output),
3225 t (mix it with ordinary output), or a file name string.
3227 If BUFFER is 0, `call-shell-region' returns immediately with value nil.
3228 Otherwise it waits for COMMAND to terminate
3229 and returns a numeric exit status or a signal description string.
3230 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
3231 (call-process-region start end
3232 shell-file-name delete buffer nil
3233 shell-command-switch command))
3234 \f
3235 ;;;; Lisp macros to do various things temporarily.
3237 (defmacro track-mouse (&rest body)
3238 "Evaluate BODY with mouse movement events enabled.
3239 Within a `track-mouse' form, mouse motion generates input events that
3240 you can read with `read-event'.
3241 Normally, mouse motion is ignored."
3242 (declare (debug t) (indent 0))
3243 `(internal--track-mouse (lambda () ,@body)))
3245 (defmacro with-current-buffer (buffer-or-name &rest body)
3246 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
3247 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3248 The value returned is the value of the last form in BODY. See
3249 also `with-temp-buffer'."
3250 (declare (indent 1) (debug t))
3251 `(save-current-buffer
3252 (set-buffer ,buffer-or-name)
3253 ,@body))
3255 (defun internal--before-with-selected-window (window)
3256 (let ((other-frame (window-frame window)))
3257 (list window (selected-window)
3258 ;; Selecting a window on another frame also changes that
3259 ;; frame's frame-selected-window. We must save&restore it.
3260 (unless (eq (selected-frame) other-frame)
3261 (frame-selected-window other-frame))
3262 ;; Also remember the top-frame if on ttys.
3263 (unless (eq (selected-frame) other-frame)
3264 (tty-top-frame other-frame)))))
3266 (defun internal--after-with-selected-window (state)
3267 ;; First reset frame-selected-window.
3268 (when (window-live-p (nth 2 state))
3269 ;; We don't use set-frame-selected-window because it does not
3270 ;; pass the `norecord' argument to Fselect_window.
3271 (select-window (nth 2 state) 'norecord)
3272 (and (frame-live-p (nth 3 state))
3273 (not (eq (tty-top-frame) (nth 3 state)))
3274 (select-frame (nth 3 state) 'norecord)))
3275 ;; Then reset the actual selected-window.
3276 (when (window-live-p (nth 1 state))
3277 (select-window (nth 1 state) 'norecord)))
3279 (defmacro with-selected-window (window &rest body)
3280 "Execute the forms in BODY with WINDOW as the selected window.
3281 The value returned is the value of the last form in BODY.
3283 This macro saves and restores the selected window, as well as the
3284 selected window of each frame. It does not change the order of
3285 recently selected windows. If the previously selected window of
3286 some frame is no longer live at the end of BODY, that frame's
3287 selected window is left alone. If the selected window is no
3288 longer live, then whatever window is selected at the end of BODY
3289 remains selected.
3291 This macro uses `save-current-buffer' to save and restore the
3292 current buffer, since otherwise its normal operation could
3293 potentially make a different buffer current. It does not alter
3294 the buffer list ordering."
3295 (declare (indent 1) (debug t))
3296 `(let ((save-selected-window--state
3297 (internal--before-with-selected-window ,window)))
3298 (save-current-buffer
3299 (unwind-protect
3300 (progn (select-window (car save-selected-window--state) 'norecord)
3301 ,@body)
3302 (internal--after-with-selected-window save-selected-window--state)))))
3304 (defmacro with-selected-frame (frame &rest body)
3305 "Execute the forms in BODY with FRAME as the selected frame.
3306 The value returned is the value of the last form in BODY.
3308 This macro saves and restores the selected frame, and changes the
3309 order of neither the recently selected windows nor the buffers in
3310 the buffer list."
3311 (declare (indent 1) (debug t))
3312 (let ((old-frame (make-symbol "old-frame"))
3313 (old-buffer (make-symbol "old-buffer")))
3314 `(let ((,old-frame (selected-frame))
3315 (,old-buffer (current-buffer)))
3316 (unwind-protect
3317 (progn (select-frame ,frame 'norecord)
3318 ,@body)
3319 (when (frame-live-p ,old-frame)
3320 (select-frame ,old-frame 'norecord))
3321 (when (buffer-live-p ,old-buffer)
3322 (set-buffer ,old-buffer))))))
3324 (defmacro save-window-excursion (&rest body)
3325 "Execute BODY, then restore previous window configuration.
3326 This macro saves the window configuration on the selected frame,
3327 executes BODY, then calls `set-window-configuration' to restore
3328 the saved window configuration. The return value is the last
3329 form in BODY. The window configuration is also restored if BODY
3330 exits nonlocally.
3332 BEWARE: Most uses of this macro introduce bugs.
3333 E.g. it should not be used to try and prevent some code from opening
3334 a new window, since that window may sometimes appear in another frame,
3335 in which case `save-window-excursion' cannot help."
3336 (declare (indent 0) (debug t))
3337 (let ((c (make-symbol "wconfig")))
3338 `(let ((,c (current-window-configuration)))
3339 (unwind-protect (progn ,@body)
3340 (set-window-configuration ,c)))))
3342 (defun internal-temp-output-buffer-show (buffer)
3343 "Internal function for `with-output-to-temp-buffer'."
3344 (with-current-buffer buffer
3345 (set-buffer-modified-p nil)
3346 (goto-char (point-min)))
3348 (if temp-buffer-show-function
3349 (funcall temp-buffer-show-function buffer)
3350 (with-current-buffer buffer
3351 (let* ((window
3352 (let ((window-combination-limit
3353 ;; When `window-combination-limit' equals
3354 ;; `temp-buffer' or `temp-buffer-resize' and
3355 ;; `temp-buffer-resize-mode' is enabled in this
3356 ;; buffer bind it to t so resizing steals space
3357 ;; preferably from the window that was split.
3358 (if (or (eq window-combination-limit 'temp-buffer)
3359 (and (eq window-combination-limit
3360 'temp-buffer-resize)
3361 temp-buffer-resize-mode))
3362 t
3363 window-combination-limit)))
3364 (display-buffer buffer)))
3365 (frame (and window (window-frame window))))
3366 (when window
3367 (unless (eq frame (selected-frame))
3368 (make-frame-visible frame))
3369 (setq minibuffer-scroll-window window)
3370 (set-window-hscroll window 0)
3371 ;; Don't try this with NOFORCE non-nil!
3372 (set-window-start window (point-min) t)
3373 ;; This should not be necessary.
3374 (set-window-point window (point-min))
3375 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3376 (with-selected-window window
3377 (run-hooks 'temp-buffer-show-hook))))))
3378 ;; Return nil.
3379 nil)
3381 ;; Doc is very similar to with-temp-buffer-window.
3382 (defmacro with-output-to-temp-buffer (bufname &rest body)
3383 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3385 This construct makes buffer BUFNAME empty before running BODY.
3386 It does not make the buffer current for BODY.
3387 Instead it binds `standard-output' to that buffer, so that output
3388 generated with `prin1' and similar functions in BODY goes into
3389 the buffer.
3391 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3392 it in a window, but does not select it. The normal way to do this is
3393 by calling `display-buffer', then running `temp-buffer-show-hook'.
3394 However, if `temp-buffer-show-function' is non-nil, it calls that
3395 function instead (and does not run `temp-buffer-show-hook'). The
3396 function gets one argument, the buffer to display.
3398 The return value of `with-output-to-temp-buffer' is the value of the
3399 last form in BODY. If BODY does not finish normally, the buffer
3400 BUFNAME is not displayed.
3402 This runs the hook `temp-buffer-setup-hook' before BODY,
3403 with the buffer BUFNAME temporarily current. It runs the hook
3404 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3405 buffer temporarily current, and the window that was used to display it
3406 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3407 if it uses `temp-buffer-show-function'.
3409 By default, the setup hook puts the buffer into Help mode before running BODY.
3410 If BODY does not change the major mode, the show hook makes the buffer
3411 read-only, and scans it for function and variable names to make them into
3412 clickable cross-references.
3414 See the related form `with-temp-buffer-window'."
3415 (declare (debug t))
3416 (let ((old-dir (make-symbol "old-dir"))
3417 (buf (make-symbol "buf")))
3418 `(let* ((,old-dir default-directory)
3419 (,buf
3420 (with-current-buffer (get-buffer-create ,bufname)
3421 (prog1 (current-buffer)
3422 (kill-all-local-variables)
3423 ;; FIXME: delete_all_overlays
3424 (setq default-directory ,old-dir)
3425 (setq buffer-read-only nil)
3426 (setq buffer-file-name nil)
3427 (setq buffer-undo-list t)
3428 (let ((inhibit-read-only t)
3429 (inhibit-modification-hooks t))
3430 (erase-buffer)
3431 (run-hooks 'temp-buffer-setup-hook)))))
3432 (standard-output ,buf))
3433 (prog1 (progn ,@body)
3434 (internal-temp-output-buffer-show ,buf)))))
3436 (defmacro with-temp-file (file &rest body)
3437 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3438 The value returned is the value of the last form in BODY.
3439 See also `with-temp-buffer'."
3440 (declare (indent 1) (debug t))
3441 (let ((temp-file (make-symbol "temp-file"))
3442 (temp-buffer (make-symbol "temp-buffer")))
3443 `(let ((,temp-file ,file)
3444 (,temp-buffer
3445 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3446 (unwind-protect
3447 (prog1
3448 (with-current-buffer ,temp-buffer
3449 ,@body)
3450 (with-current-buffer ,temp-buffer
3451 (write-region nil nil ,temp-file nil 0)))
3452 (and (buffer-name ,temp-buffer)
3453 (kill-buffer ,temp-buffer))))))
3455 (defmacro with-temp-message (message &rest body)
3456 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3457 The original message is restored to the echo area after BODY has finished.
3458 The value returned is the value of the last form in BODY.
3459 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3460 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3462 (declare (debug t) (indent 1))
3463 (let ((current-message (make-symbol "current-message"))
3464 (temp-message (make-symbol "with-temp-message")))
3465 `(let ((,temp-message ,message)
3466 (,current-message))
3467 (unwind-protect
3468 (progn
3469 (when ,temp-message
3470 (setq ,current-message (current-message))
3471 (message "%s" ,temp-message))
3472 ,@body)
3473 (and ,temp-message
3474 (if ,current-message
3475 (message "%s" ,current-message)
3476 (message nil)))))))
3478 (defmacro with-temp-buffer (&rest body)
3479 "Create a temporary buffer, and evaluate BODY there like `progn'.
3480 See also `with-temp-file' and `with-output-to-string'."
3481 (declare (indent 0) (debug t))
3482 (let ((temp-buffer (make-symbol "temp-buffer")))
3483 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3484 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3485 (with-current-buffer ,temp-buffer
3486 (unwind-protect
3487 (progn ,@body)
3488 (and (buffer-name ,temp-buffer)
3489 (kill-buffer ,temp-buffer)))))))
3491 (defmacro with-silent-modifications (&rest body)
3492 "Execute BODY, pretending it does not modify the buffer.
3493 This macro is typically used around modifications of
3494 text properties which do not really affect the buffer's content.
3495 If BODY performs real modifications to the buffer's text, other
3496 than cosmetic ones, undo data may become corrupted.
3498 This macro will run BODY normally, but doesn't count its buffer
3499 modifications as being buffer modifications. This affects things
3500 like `buffer-modified-p', checking whether the file is locked by
3501 someone else, running buffer modification hooks, and other things
3502 of that nature."
3503 (declare (debug t) (indent 0))
3504 (let ((modified (make-symbol "modified")))
3505 `(let* ((,modified (buffer-modified-p))
3506 (buffer-undo-list t)
3507 (inhibit-read-only t)
3508 (inhibit-modification-hooks t))
3509 (unwind-protect
3510 (progn
3511 ,@body)
3512 (unless ,modified
3513 (restore-buffer-modified-p nil))))))
3515 (defmacro with-output-to-string (&rest body)
3516 "Execute BODY, return the text it sent to `standard-output', as a string."
3517 (declare (indent 0) (debug t))
3518 `(let ((standard-output
3519 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3520 (unwind-protect
3521 (progn
3522 (let ((standard-output standard-output))
3523 ,@body)
3524 (with-current-buffer standard-output
3525 (buffer-string)))
3526 (kill-buffer standard-output))))
3528 (defmacro with-local-quit (&rest body)
3529 "Execute BODY, allowing quits to terminate BODY but not escape further.
3530 When a quit terminates BODY, `with-local-quit' returns nil but
3531 requests another quit. That quit will be processed as soon as quitting
3532 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3533 (declare (debug t) (indent 0))
3534 `(condition-case nil
3535 (let ((inhibit-quit nil))
3536 ,@body)
3537 (quit (setq quit-flag t)
3538 ;; This call is to give a chance to handle quit-flag
3539 ;; in case inhibit-quit is nil.
3540 ;; Without this, it will not be handled until the next function
3541 ;; call, and that might allow it to exit thru a condition-case
3542 ;; that intends to handle the quit signal next time.
3543 (eval '(ignore nil)))))
3545 ;; Don't throw `throw-on-input' on those events by default.
3546 (setq while-no-input-ignore-events
3547 '(focus-in focus-out help-echo iconify-frame
3548 make-frame-visible selection-request))
3550 (defmacro while-no-input (&rest body)
3551 "Execute BODY only as long as there's no pending input.
3552 If input arrives, that ends the execution of BODY,
3553 and `while-no-input' returns t. Quitting makes it return nil.
3554 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3555 (declare (debug t) (indent 0))
3556 (let ((catch-sym (make-symbol "input")))
3557 `(with-local-quit
3558 (catch ',catch-sym
3559 (let ((throw-on-input ',catch-sym)
3560 val)
3561 (setq val (or (input-pending-p)
3562 (progn ,@body)))
3563 (cond
3564 ;; When input arrives while throw-on-input is non-nil,
3565 ;; kbd_buffer_store_buffered_event sets quit-flag to the
3566 ;; value of throw-on-input. If, when BODY finishes,
3567 ;; quit-flag still has the same value as throw-on-input, it
3568 ;; means BODY never tested quit-flag, and therefore ran to
3569 ;; completion even though input did arrive before it
3570 ;; finished. In that case, we must manually simulate what
3571 ;; 'throw' in process_quit_flag would do, and we must
3572 ;; reset quit-flag, because leaving it set will cause us
3573 ;; quit to top-level, which has undesirable consequences,
3574 ;; such as discarding input etc. We return t in that case
3575 ;; because input did arrive during execution of BODY.
3576 ((eq quit-flag throw-on-input)
3577 (setq quit-flag nil)
3578 t)
3579 ;; This is for when the user actually QUITs during
3580 ;; execution of BODY.
3581 (quit-flag
3582 nil)
3583 (t val)))))))
3585 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3586 "Like `condition-case' except that it does not prevent debugging.
3587 More specifically if `debug-on-error' is set then the debugger will be invoked
3588 even if this catches the signal."
3589 (declare (debug condition-case) (indent 2))
3590 `(condition-case ,var
3591 ,bodyform
3592 ,@(mapcar (lambda (handler)
3593 `((debug ,@(if (listp (car handler)) (car handler)
3594 (list (car handler))))
3595 ,@(cdr handler)))
3596 handlers)))
3598 (define-obsolete-function-alias 'condition-case-no-debug
3599 'condition-case-unless-debug "24.1")
3601 (defmacro with-demoted-errors (format &rest body)
3602 "Run BODY and demote any errors to simple messages.
3603 FORMAT is a string passed to `message' to format any error message.
3606 If `debug-on-error' is non-nil, run BODY without catching its errors.
3607 This is to be used around code which is not expected to signal an error
3608 but which should be robust in the unexpected case that an error is signaled.
3610 For backward compatibility, if FORMAT is not a constant string, it
3611 is assumed to be part of BODY, in which case the message format
3613 (declare (debug t) (indent 1))
3614 (let ((err (make-symbol "err"))
3615 (format (if (and (stringp format) body) format
3616 (prog1 "Error: %S"
3617 (if format (push format body))))))
3618 `(condition-case-unless-debug ,err
3619 ,(macroexp-progn body)
3620 (error (message ,format ,err) nil))))
3622 (defmacro combine-after-change-calls (&rest body)
3623 "Execute BODY, but don't call the after-change functions till the end.
3624 If BODY makes changes in the buffer, they are recorded
3625 and the functions on `after-change-functions' are called several times
3626 when BODY is finished.
3627 The return value is the value of the last form in BODY.
3629 If `before-change-functions' is non-nil, then calls to the after-change
3630 functions can't be deferred, so in that case this macro has no effect.
3632 Do not alter `after-change-functions' or `before-change-functions'
3633 in BODY."
3634 (declare (indent 0) (debug t))
3635 `(unwind-protect
3636 (let ((combine-after-change-calls t))
3637 . ,body)
3638 (combine-after-change-execute)))
3640 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3641 (defvar undo--combining-change-calls nil
3642 "Non-nil when `combine-change-calls-1' is running.")
3644 (defun combine-change-calls-1 (beg end body)
3645 "Evaluate BODY, running the change hooks just once, for region \(BEG END).
3647 Firstly, `before-change-functions' is invoked for the region
3648 \(BEG END), then BODY (a function) is evaluated with
3649 `before-change-functions' and `after-change-functions' bound to
3650 nil, then finally `after-change-functions' is invoked on the
3651 updated region (BEG NEW-END) with a calculated OLD-LEN argument.
3652 If `inhibit-modification-hooks' is initially non-nil, the change
3653 hooks are not run.
3655 The result of `combine-change-calls-1' is the value returned by
3656 BODY. BODY must not make a different buffer current, except
3657 temporarily. It must not make any changes to the buffer outside
3658 the specified region. It must not change
3659 `before-change-functions' or `after-change-functions'.
3661 Additionally, the buffer modifications of BODY are recorded on
3662 the buffer's undo list as a single \(apply ...) entry containing
3663 the function `undo--wrap-and-run-primitive-undo'."
3664 (let ((old-bul buffer-undo-list)
3665 (end-marker (copy-marker end t))
3666 result)
3667 (if undo--combining-change-calls
3668 (setq result (funcall body))
3669 (let ((undo--combining-change-calls t))
3670 (if (not inhibit-modification-hooks)
3671 (run-hook-with-args 'before-change-functions beg end))
3672 (if (eq buffer-undo-list t)
3673 (setq result (funcall body))
3674 (let (;; (inhibit-modification-hooks t)
3675 before-change-functions after-change-functions)
3676 (setq result (funcall body)))
3677 (let ((ap-elt
3678 (list 'apply
3679 (- end end-marker)
3680 beg
3681 (marker-position end-marker)
3682 #'undo--wrap-and-run-primitive-undo
3683 beg (marker-position end-marker) buffer-undo-list))
3684 (ptr buffer-undo-list))
3685 (if (not (eq buffer-undo-list old-bul))
3686 (progn
3687 (while (and (not (eq (cdr ptr) old-bul))
3688 ;; In case garbage collection has removed OLD-BUL.
3689 (cdr ptr)
3690 ;; Don't include a timestamp entry.
3691 (not (and (consp (cdr ptr))
3692 (consp (cadr ptr))
3693 (eq (caadr ptr) t)
3694 (setq old-bul (cdr ptr)))))
3695 (setq ptr (cdr ptr)))
3696 (unless (cdr ptr)
3697 (message "combine-change-calls: buffer-undo-list broken"))
3698 (setcdr ptr nil)
3699 (push ap-elt buffer-undo-list)
3700 (setcdr buffer-undo-list old-bul)))))
3701 (if (not inhibit-modification-hooks)
3702 (run-hook-with-args 'after-change-functions
3703 beg (marker-position end-marker)
3704 (- end beg)))))
3705 (set-marker end-marker nil)
3706 result))
3708 (defmacro combine-change-calls (beg end &rest body)
3709 "Evaluate BODY, running the change hooks just once.
3711 BODY is a sequence of lisp forms to evaluate. BEG and END bound
3712 the region the change hooks will be run for.
3714 Firstly, `before-change-functions' is invoked for the region
3715 \(BEG END), then the BODY forms are evaluated with
3716 `before-change-functions' and `after-change-functions' bound to
3717 nil, and finally `after-change-functions' is invoked on the
3718 updated region. The change hooks are not run if
3719 `inhibit-modification-hooks' is initially non-nil.
3721 The result of `combine-change-calls' is the value returned by the
3722 last of the BODY forms to be evaluated. BODY may not make a
3723 different buffer current, except temporarily. BODY may not
3724 change the buffer outside the specified region. It must not
3725 change `before-change-functions' or `after-change-functions'.
3727 Additionally, the buffer modifications of BODY are recorded on
3728 the buffer's undo list as a single \(apply ...) entry containing
3729 the function `undo--wrap-and-run-primitive-undo'. "
3730 `(combine-change-calls-1 ,beg ,end (lambda () ,@body)))
3732 (defun undo--wrap-and-run-primitive-undo (beg end list)
3733 "Call `primitive-undo' on the undo elements in LIST.
3735 This function is intended to be called purely by `undo' as the
3736 function in an \(apply DELTA BEG END FUNNAME . ARGS) undo
3737 element. It invokes `before-change-functions' and
3738 `after-change-functions' once each for the entire region \(BEG
3739 END) rather than once for each individual change.
3743 `undo--wrap-and-run-primitive-undo'.
3745 Undo elements of this form are generated by the macro
3746 `combine-change-calls'."
3747 (combine-change-calls beg end
3748 (while list
3749 (setq list (primitive-undo 1 list)))))
3751 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3753 (defmacro with-case-table (table &rest body)
3754 "Execute the forms in BODY with TABLE as the current case table.
3755 The value returned is the value of the last form in BODY."
3756 (declare (indent 1) (debug t))
3757 (let ((old-case-table (make-symbol "table"))
3758 (old-buffer (make-symbol "buffer")))
3759 `(let ((,old-case-table (current-case-table))
3760 (,old-buffer (current-buffer)))
3761 (unwind-protect
3762 (progn (set-case-table ,table)
3763 ,@body)
3764 (with-current-buffer ,old-buffer
3765 (set-case-table ,old-case-table))))))
3767 (defmacro with-file-modes (modes &rest body)
3768 "Execute BODY with default file permissions temporarily set to MODES.
3769 MODES is as for `set-default-file-modes'."
3770 (declare (indent 1) (debug t))
3771 (let ((umask (make-symbol "umask")))
3772 `(let ((,umask (default-file-modes)))
3773 (unwind-protect
3774 (progn
3775 (set-default-file-modes ,modes)
3776 ,@body)
3777 (set-default-file-modes ,umask)))))
3779 \f
3780 ;;; Matching and match data.
3782 (defvar save-match-data-internal)
3784 ;; We use save-match-data-internal as the local variable because
3785 ;; that works ok in practice (people should not use that variable elsewhere).
3786 ;; We used to use an uninterned symbol; the compiler handles that properly
3787 ;; now, but it generates slower code.
3788 (defmacro save-match-data (&rest body)
3789 "Execute the BODY forms, restoring the global value of the match data.
3790 The value returned is the value of the last form in BODY."
3791 ;; It is better not to use backquote here,
3792 ;; because that makes a bootstrapping problem
3793 ;; if you need to recompile all the Lisp files using interpreted code.
3794 (declare (indent 0) (debug t))
3795 (list 'let
3796 '((save-match-data-internal (match-data)))
3797 (list 'unwind-protect
3798 (cons 'progn body)
3799 ;; It is safe to free (evaporate) markers immediately here,
3800 ;; as Lisp programs should not copy from save-match-data-internal.
3801 '(set-match-data save-match-data-internal 'evaporate))))
3803 (defun match-string (num &optional string)
3804 "Return string of text matched by last search.
3805 NUM specifies which parenthesized expression in the last regexp.
3806 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3807 Zero means the entire text matched by the whole regexp or whole string.
3808 STRING should be given if the last search was by `string-match' on STRING.
3809 If STRING is nil, the current buffer should be the same buffer
3810 the search/match was performed in."
3811 (if (match-beginning num)
3812 (if string
3813 (substring string (match-beginning num) (match-end num))
3814 (buffer-substring (match-beginning num) (match-end num)))))
3816 (defun match-string-no-properties (num &optional string)
3817 "Return string of text matched by last search, without text properties.
3818 NUM specifies which parenthesized expression in the last regexp.
3819 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3820 Zero means the entire text matched by the whole regexp or whole string.
3821 STRING should be given if the last search was by `string-match' on STRING.
3822 If STRING is nil, the current buffer should be the same buffer
3823 the search/match was performed in."
3824 (if (match-beginning num)
3825 (if string
3826 (substring-no-properties string (match-beginning num)
3827 (match-end num))
3828 (buffer-substring-no-properties (match-beginning num)
3829 (match-end num)))))
3832 (defun match-substitute-replacement (replacement
3833 &optional fixedcase literal string subexp)
3834 "Return REPLACEMENT as it will be inserted by `replace-match'.
3836 are substituted with actual strings matched by the last search.
3837 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3838 meaning as for `replace-match'."
3839 (let ((match (match-string 0 string)))
3840 (save-match-data
3841 (set-match-data (mapcar (lambda (x)
3842 (if (numberp x)
3843 (- x (match-beginning 0))
3844 x))
3845 (match-data t)))
3846 (replace-match replacement fixedcase literal match subexp))))
3849 (defun looking-back (regexp &optional limit greedy)
3850 "Return non-nil if text before point matches regular expression REGEXP.
3851 Like `looking-at' except matches before point, and is slower.
3852 LIMIT if non-nil speeds up the search by specifying a minimum
3853 starting position, to avoid checking matches that would start
3854 before LIMIT.
3856 If GREEDY is non-nil, extend the match backwards as far as
3857 possible, stopping when a single additional previous character
3858 cannot be part of a match for REGEXP. When the match is
3859 extended, its starting position is allowed to occur before
3860 LIMIT.
3862 As a general recommendation, try to avoid using `looking-back'
3863 wherever possible, since it is slow."
3864 (declare
3865 (advertised-calling-convention (regexp limit &optional greedy) "25.1"))
3866 (let ((start (point))
3867 (pos
3868 (save-excursion
3870 (point)))))
3871 (if (and greedy pos)
3872 (save-restriction
3873 (narrow-to-region (point-min) start)
3874 (while (and (> pos (point-min))
3875 (save-excursion
3876 (goto-char pos)
3877 (backward-char 1)
3879 (setq pos (1- pos)))
3880 (save-excursion
3881 (goto-char pos)
3883 (not (null pos))))
3885 (defsubst looking-at-p (regexp)
3886 "\
3887 Same as `looking-at' except this function does not change the match data."
3888 (let ((inhibit-changing-match-data t))
3889 (looking-at regexp)))
3891 (defsubst string-match-p (regexp string &optional start)
3892 "\
3893 Same as `string-match' except this function does not change the match data."
3894 (let ((inhibit-changing-match-data t))
3895 (string-match regexp string start)))
3897 (defun subregexp-context-p (regexp pos &optional start)
3898 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3899 A subregexp context is one where a sub-regexp can appear.
3900 A non-subregexp context is for example within brackets, or within a
3902 If START is non-nil, it should be a position in REGEXP, smaller
3903 than POS, and known to be in a subregexp context."
3904 ;; Here's one possible implementation, with the great benefit that it
3905 ;; reuses the regexp-matcher's own parser, so it understands all the
3906 ;; details of the syntax. A disadvantage is that it needs to match the
3907 ;; error string.
3908 (condition-case err
3909 (progn
3910 (string-match (substring regexp (or start 0) pos) "")
3911 t)
3912 (invalid-regexp
3913 (not (member (cadr err) '("Unmatched [ or [^"
3915 "Trailing backslash")))))
3916 ;; An alternative implementation:
3917 ;; (defconst re-context-re
3920 ;; (class-harmless-ch "[^][]")
3921 ;; (class-lb-harmless "[^]:]")
3925 ;; (class
3933 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3934 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3935 )
3936 \f
3937 ;;;; split-string
3940 "The default value of separators for `split-string'.
3942 A regexp matching strings of whitespace. May be locale-dependent
3943 \(as yet unimplemented). Should not match non-breaking spaces.
3945 Warning: binding this to a different value and using it as default is
3946 likely to have undesired semantics.")
3948 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3949 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3950 ;; expression leads to the equivalent implementation that if SEPARATORS
3951 ;; is defaulted, OMIT-NULLS is treated as t.
3952 (defun split-string (string &optional separators omit-nulls trim)
3953 "Split STRING into substrings bounded by matches for SEPARATORS.
3955 The beginning and end of STRING, and each match for SEPARATORS, are
3956 splitting points. The substrings matching SEPARATORS are removed, and
3957 the substrings between the splitting points are collected as a list,
3958 which is returned.
3960 If SEPARATORS is non-nil, it should be a regular expression matching text
3961 which separates, but is not part of, the substrings. If nil it defaults to
3963 OMIT-NULLS is forced to t.
3965 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3966 that for the default value of SEPARATORS leading and trailing whitespace
3967 are effectively trimmed). If nil, all zero-length substrings are retained,
3968 which correctly parses CSV format, for example.
3970 If TRIM is non-nil, it should be a regular expression to match
3971 text to trim from the beginning and end of each substring. If trimming
3972 makes the substring empty, it is treated as null.
3974 If you want to trim whitespace from the substrings, the reliably correct
3975 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3976 results when there is whitespace at the start or end of STRING. If you
3977 see such calls to `split-string', please fix them.
3979 Note that the effect of `(split-string STRING)' is the same as
3980 `(split-string STRING split-string-default-separators t)'. In the rare
3981 case that you wish to retain zero-length substrings when splitting on
3982 whitespace, use `(split-string STRING split-string-default-separators)'.
3984 Modifies the match data; use `save-match-data' if necessary."
3985 (let* ((keep-nulls (not (if separators omit-nulls t)))
3986 (rexp (or separators split-string-default-separators))
3987 (start 0)
3988 this-start this-end
3989 notfirst
3990 (list nil)
3991 (push-one
3992 ;; Push the substring in range THIS-START to THIS-END
3993 ;; onto LIST, trimming it and perhaps discarding it.
3994 (lambda ()
3995 (when trim
3996 ;; Discard the trim from start of this substring.
3997 (let ((tem (string-match trim string this-start)))
3998 (and (eq tem this-start)
3999 (setq this-start (match-end 0)))))
4001 (when (or keep-nulls (< this-start this-end))
4002 (let ((this (substring string this-start this-end)))
4004 ;; Discard the trim from end of this substring.
4005 (when trim
4007 (and tem (< tem (length this))
4008 (setq this (substring this 0 tem)))))
4010 ;; Trimming could make it empty; check again.
4011 (when (or keep-nulls (> (length this) 0))
4012 (push this list)))))))
4014 (while (and (string-match rexp string
4015 (if (and notfirst
4016 (= start (match-beginning 0))
4017 (< start (length string)))
4018 (1+ start) start))
4019 (< start (length string)))
4020 (setq notfirst t)
4021 (setq this-start start this-end (match-beginning 0)
4022 start (match-end 0))
4024 (funcall push-one))
4026 ;; Handle the substring at the end of STRING.
4027 (setq this-start start this-end (length string))
4028 (funcall push-one)
4030 (nreverse list)))
4032 (defun combine-and-quote-strings (strings &optional separator)
4034 This tries to quote the strings to avoid ambiguity such that
4035 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
4036 Only some SEPARATORs will work properly.
4038 Note that this is not intended to protect STRINGS from
4039 interpretation by shells, use `shell-quote-argument' for that."
4040 (let* ((sep (or separator " "))
4042 (mapconcat
4043 (lambda (str)
4044 (if (string-match re str)
4046 str))
4047 strings sep)))
4049 (defun split-string-and-unquote (string &optional separator)
4050 "Split the STRING into a list of strings.
4051 It understands Emacs Lisp quoting within STRING, such that
4052 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
4056 (if (null i)
4057 (split-string string sep t) ; no quoting: easy
4058 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
4059 (let ((rfs (read-from-string string i)))
4060 (cons (car rfs)
4061 (split-string-and-unquote (substring string (cdr rfs))
4062 sep)))))))
4064 \f
4065 ;;;; Replacement in strings.
4067 (defun subst-char-in-string (fromchar tochar string &optional inplace)
4068 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
4069 Unless optional argument INPLACE is non-nil, return a new string."
4070 (let ((i (length string))
4071 (newstr (if inplace string (copy-sequence string))))
4072 (while (> i 0)
4073 (setq i (1- i))
4074 (if (eq (aref newstr i) fromchar)
4075 (aset newstr i tochar)))
4076 newstr))
4078 (defun replace-regexp-in-string (regexp rep string &optional
4079 fixedcase literal subexp start)
4080 "Replace all matches for REGEXP with REP in STRING.
4082 Return a new string containing the replacements.
4084 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
4085 arguments with the same names of function `replace-match'. If START
4086 is non-nil, start replacements at that index in STRING.
4088 REP is either a string used as the NEWTEXT arg of `replace-match' or a
4089 function. If it is a function, it is called with the actual text of each
4090 match, and its value is used as the replacement text. When REP is called,
4091 the match data are the result of matching REGEXP against a substring
4092 of STRING, the same substring that is the actual text of the match which
4093 is passed to REP as its argument.
4096 and replace a sub-expression, e.g.
4100 ;; To avoid excessive consing from multiple matches in long strings,
4101 ;; don't just call `replace-match' continually. Walk down the
4102 ;; string looking for matches of REGEXP and building up a (reversed)
4103 ;; list MATCHES. This comprises segments of STRING which weren't
4104 ;; matched interspersed with replacements for segments that were.
4105 ;; [For a `large' number of replacements it's more efficient to
4106 ;; operate in a temporary buffer; we can't tell from the function's
4107 ;; args whether to choose the buffer-based implementation, though it
4108 ;; might be reasonable to do so for long enough STRING.]
4109 (let ((l (length string))
4110 (start (or start 0))
4111 matches str mb me)
4112 (save-match-data
4113 (while (and (< start l) (string-match regexp string start))
4114 (setq mb (match-beginning 0)
4115 me (match-end 0))
4116 ;; If we matched the empty string, make sure we advance by one char
4117 (when (= me mb) (setq me (min l (1+ mb))))
4118 ;; Generate a replacement for the matched substring.
4119 ;; Operate only on the substring to minimize string consing.
4120 ;; Set up match data for the substring for replacement;
4121 ;; presumably this is likely to be faster than munging the
4122 ;; match data directly in Lisp.
4123 (string-match regexp (setq str (substring string mb me)))
4124 (setq matches
4125 (cons (replace-match (if (stringp rep)
4126 rep
4127 (funcall rep (match-string 0 str)))
4128 fixedcase literal str subexp)
4129 (cons (substring string start mb) ; unmatched prefix
4130 matches)))
4131 (setq start me))
4132 ;; Reconstruct a string from the pieces.
4133 (setq matches (cons (substring string start l) matches)) ; leftover
4134 (apply #'concat (nreverse matches)))))
4135 \f
4136 (defun string-prefix-p (prefix string &optional ignore-case)
4137 "Return non-nil if PREFIX is a prefix of STRING.
4138 If IGNORE-CASE is non-nil, the comparison is done without paying attention
4139 to case differences."
4140 (let ((prefix-length (length prefix)))
4141 (if (> prefix-length (length string)) nil
4142 (eq t (compare-strings prefix 0 prefix-length string
4143 0 prefix-length ignore-case)))))
4145 (defun string-suffix-p (suffix string &optional ignore-case)
4146 "Return non-nil if SUFFIX is a suffix of STRING.
4147 If IGNORE-CASE is non-nil, the comparison is done without paying
4148 attention to case differences."
4149 (let ((start-pos (- (length string) (length suffix))))
4150 (and (>= start-pos 0)
4151 (eq t (compare-strings suffix nil nil
4152 string start-pos nil ignore-case)))))
4154 (defun bidi-string-mark-left-to-right (str)
4155 "Return a string that can be safely inserted in left-to-right text.
4157 Normally, inserting a string with right-to-left (RTL) script into
4158 a buffer may cause some subsequent text to be displayed as part
4159 of the RTL segment (usually this affects punctuation characters).
4160 This function returns a string which displays as STR but forces
4161 subsequent text to be displayed as left-to-right.
4163 If STR contains any RTL character, this function returns a string
4164 consisting of STR followed by an invisible left-to-right mark
4165 \(LRM) character. Otherwise, it returns STR."
4166 (unless (stringp str)
4167 (signal 'wrong-type-argument (list 'stringp str)))
4170 str))
4172 (defun string-greaterp (string1 string2)
4173 "Return non-nil if STRING1 is greater than STRING2 in lexicographic order.
4174 Case is significant.
4175 Symbols are also allowed; their print names are used instead."
4176 (string-lessp string2 string1))
4178 \f
4179 ;;;; Specifying things to do later.
4181 (defun load-history-regexp (file)
4182 "Form a regexp to find FILE in `load-history'.
4183 FILE, a string, is described in the function `eval-after-load'."
4184 (if (file-name-absolute-p file)
4185 (setq file (file-truename file)))
4187 (regexp-quote file)
4188 (if (file-name-extension file)
4189 ""
4190 ;; Note: regexp-opt can't be used here, since we need to call
4191 ;; this before Emacs has been fully started. 2006-05-21
4196 (defun load-history-filename-element (file-regexp)
4197 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
4198 Return nil if there isn't one."
4199 (let* ((loads load-history)
4200 (load-elt (and loads (car loads))))
4201 (save-match-data
4202 (while (and loads
4203 (or (null (car load-elt))
4204 (not (string-match file-regexp (car load-elt)))))
4205 (setq loads (cdr loads)
4206 load-elt (and loads (car loads)))))
4207 load-elt))
4209 (put 'eval-after-load 'lisp-indent-function 1)
4210 (defun eval-after-load (file form)
4211 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
4212 If FILE is already loaded, evaluate FORM right now.
4213 FORM can be an Elisp expression (in which case it's passed to `eval'),
4214 or a function (in which case it's passed to `funcall' with no argument).
4216 If a matching file is loaded again, FORM will be evaluated again.
4218 If FILE is a string, it may be either an absolute or a relative file
4220 additionally may or may not have an extension denoting a compressed
4223 When FILE is absolute, this first converts it to a true name by chasing
4224 symbolic links. Only a file of this name (see next paragraph regarding
4225 extensions) will trigger the evaluation of FORM. When FILE is relative,
4226 a file whose absolute true name ends in FILE will trigger evaluation.
4228 When FILE lacks an extension, a file name with any extension will trigger
4229 evaluation. Otherwise, its extension must match FILE's. A further
4231 this name matching.
4233 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
4234 is evaluated at the end of any file that `provide's this feature.
4235 If the feature is provided when evaluating code not associated with a
4236 file, FORM is evaluated immediately after the provide statement.
4239 like `font-lock'.
4241 This function makes or adds to an entry on `after-load-alist'."
4242 (declare (compiler-macro
4243 (lambda (whole)
4244 (if (eq 'quote (car-safe form))
4245 ;; Quote with lambda so the compiler can look inside.
4246 `(eval-after-load ,file (lambda () ,(nth 1 form)))
4247 whole))))
4248 ;; Add this FORM into after-load-alist (regardless of whether we'll be
4249 ;; evaluating it now).
4250 (let* ((regexp-or-feature
4251 (if (stringp file)
4252 (setq file (purecopy (load-history-regexp file)))
4253 file))
4254 (elt (assoc regexp-or-feature after-load-alist))
4255 (func
4256 (if (functionp form) form
4257 ;; Try to use the "current" lexical/dynamic mode for `form'.
4258 (eval `(lambda () ,form) lexical-binding))))
4259 (unless elt
4260 (setq elt (list regexp-or-feature))
4261 (push elt after-load-alist))
4262 ;; Is there an already loaded file whose name (or `provide' name)
4263 ;; matches FILE?
4264 (prog1 (if (if (stringp file)
4265 (load-history-filename-element regexp-or-feature)
4266 (featurep file))
4267 (funcall func))
4268 (let ((delayed-func
4269 (if (not (symbolp regexp-or-feature)) func
4270 ;; For features, the after-load-alist elements get run when
4271 ;; `provide' is called rather than at the end of the file.
4272 ;; So add an indirection to make sure that `func' is really run
4273 ;; "after-load" in case the provide call happens early.
4274 (lambda ()
4275 (if (not load-file-name)
4276 ;; Not being provided from a file, run func right now.
4277 (funcall func)
4278 (let ((lfn load-file-name)
4279 ;; Don't use letrec, because equal (in
4280 ;; add/remove-hook) would get trapped in a cycle.
4281 (fun (make-symbol "eval-after-load-helper")))
4282 (fset fun (lambda (file)
4283 (when (equal file lfn)
4284 (remove-hook 'after-load-functions fun)
4285 (funcall func))))
4286 (add-hook 'after-load-functions fun 'append)))))))
4287 ;; Add FORM to the element unless it's already there.
4288 (unless (member delayed-func (cdr elt))
4289 (nconc elt (list delayed-func)))))))
4291 (defmacro with-eval-after-load (file &rest body)
4292 "Execute BODY after FILE is loaded.
4293 FILE is normally a feature name, but it can also be a file name,
4294 in case that file does not provide any feature. See `eval-after-load'
4295 for more details about the different forms of FILE and their semantics."
4296 (declare (indent 1) (debug t))
4297 `(eval-after-load ,file (lambda () ,@body)))
4299 (defvar after-load-functions nil
4300 "Special hook run after loading a file.
4301 Each function there is called with a single argument, the absolute
4302 name of the file just loaded.")
4304 (defun do-after-load-evaluation (abs-file)
4305 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
4306 ABS-FILE, a string, should be the absolute true name of a file just loaded.
4307 This function is called directly from the C code."
4308 ;; Run the relevant eval-after-load forms.
4309 (dolist (a-l-element after-load-alist)
4310 (when (and (stringp (car a-l-element))
4311 (string-match-p (car a-l-element) abs-file))
4312 ;; discard the file name regexp
4313 (mapc #'funcall (cdr a-l-element))))
4314 ;; Complain when the user uses obsolete files.
4316 ;; Maybe we should just use display-warning? This seems yucky...
4317 (let* ((file (file-name-nondirectory abs-file))
4318 (msg (format "Package %s is obsolete!"
4319 (substring file 0
4321 ;; Cribbed from cl--compiling-file.
4322 (if (and (boundp 'byte-compile--outbuffer)
4323 (bufferp (symbol-value 'byte-compile--outbuffer))
4324 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
4325 " *Compiler Output*"))
4326 ;; Don't warn about obsolete files using other obsolete files.
4327 (unless (and (stringp byte-compile-current-file)
4329 (expand-file-name
4330 byte-compile-current-file
4331 byte-compile-root-dir)))
4332 (byte-compile-warn "%s" msg))
4333 (run-with-timer 0 nil
4334 (lambda (msg)
4335 (message "%s" msg))
4336 msg))))
4338 ;; Finally, run any other hook.
4339 (run-hook-with-args 'after-load-functions abs-file))
4341 (defun eval-next-after-load (file)
4342 "Read the following input sexp, and run it whenever FILE is loaded.
4343 This makes or adds to an entry on `after-load-alist'.
4344 FILE should be the name of a library, with no directory name."
4345 (declare (obsolete eval-after-load "23.2"))
4346 (eval-after-load file (read)))
4348 \f
4349 (defun display-delayed-warnings ()
4350 "Display delayed warnings from `delayed-warnings-list'.
4351 Used from `delayed-warnings-hook' (which see)."
4352 (dolist (warning (nreverse delayed-warnings-list))
4353 (apply 'display-warning warning))
4354 (setq delayed-warnings-list nil))
4356 (defun collapse-delayed-warnings ()
4357 "Remove duplicates from `delayed-warnings-list'.
4358 Collapse identical adjacent warnings into one (plus count).
4359 Used from `delayed-warnings-hook' (which see)."
4360 (let ((count 1)
4361 collapsed warning)
4362 (while delayed-warnings-list
4363 (setq warning (pop delayed-warnings-list))
4364 (if (equal warning (car delayed-warnings-list))
4365 (setq count (1+ count))
4366 (when (> count 1)
4367 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
4368 (cddr warning)))
4369 (setq count 1))
4370 (push warning collapsed)))
4371 (setq delayed-warnings-list (nreverse collapsed))))
4373 ;; At present this is only used for Emacs internals.
4374 ;; Ref https://lists.gnu.org/r/emacs-devel/2012-02/msg00085.html
4375 (defvar delayed-warnings-hook '(collapse-delayed-warnings
4376 display-delayed-warnings)
4377 "Normal hook run to process and display delayed warnings.
4378 By default, this hook contains functions to consolidate the
4379 warnings listed in `delayed-warnings-list', display them, and set
4380 `delayed-warnings-list' back to nil.")
4382 (defun delay-warning (type message &optional level buffer-name)
4383 "Display a delayed warning.
4384 Aside from going through `delayed-warnings-list', this is equivalent
4385 to `display-warning'."
4386 (push (list type message level buffer-name) delayed-warnings-list))
4388 \f
4389 ;;;; invisibility specs
4391 (defun add-to-invisibility-spec (element)
4392 "Add ELEMENT to `buffer-invisibility-spec'.
4393 See documentation for `buffer-invisibility-spec' for the kind of elements
4394 that can be added.
4396 If `buffer-invisibility-spec' isn't a list before calling this
4397 function, `buffer-invisibility-spec' will afterwards be a list
4398 with the value `(t ELEMENT)'. This means that if text exists
4399 that invisibility values that aren't either `t' or ELEMENT, that
4400 text will become visible."
4401 (if (eq buffer-invisibility-spec t)
4402 (setq buffer-invisibility-spec (list t)))
4403 (setq buffer-invisibility-spec
4404 (cons element buffer-invisibility-spec)))
4406 (defun remove-from-invisibility-spec (element)
4407 "Remove ELEMENT from `buffer-invisibility-spec'.
4408 If `buffer-invisibility-spec' isn't a list before calling this
4409 function, it will be made into a list containing just `t' as the
4410 only list member. This means that if text exists with non-`t'
4411 invisibility values, that text will become visible."
4412 (setq buffer-invisibility-spec
4413 (if (consp buffer-invisibility-spec)
4414 (delete element buffer-invisibility-spec)
4415 (list t))))
4416 \f
4417 ;;;; Syntax tables.
4419 (defmacro with-syntax-table (table &rest body)
4420 "Evaluate BODY with syntax table of current buffer set to TABLE.
4421 The syntax table of the current buffer is saved, BODY is evaluated, and the
4422 saved table is restored, even in case of an abnormal exit.
4423 Value is what BODY returns."
4424 (declare (debug t) (indent 1))
4425 (let ((old-table (make-symbol "table"))
4426 (old-buffer (make-symbol "buffer")))
4427 `(let ((,old-table (syntax-table))
4428 (,old-buffer (current-buffer)))
4429 (unwind-protect
4430 (progn
4431 (set-syntax-table ,table)
4432 ,@body)
4433 (save-current-buffer
4434 (set-buffer ,old-buffer)
4435 (set-syntax-table ,old-table))))))
4437 (defun make-syntax-table (&optional oldtable)
4438 "Return a new syntax table.
4439 Create a syntax table which inherits from OLDTABLE (if non-nil) or
4440 from `standard-syntax-table' otherwise."
4441 (let ((table (make-char-table 'syntax-table nil)))
4442 (set-char-table-parent table (or oldtable (standard-syntax-table)))
4443 table))
4445 (defun syntax-after (pos)
4446 "Return the raw syntax descriptor for the char after POS.
4447 If POS is outside the buffer's accessible portion, return nil."
4448 (unless (or (< pos (point-min)) (>= pos (point-max)))
4449 (let ((st (if parse-sexp-lookup-properties
4450 (get-char-property pos 'syntax-table))))
4451 (if (consp st) st
4452 (aref (or st (syntax-table)) (char-after pos))))))
4454 (defun syntax-class (syntax)
4455 "Return the code for the syntax class described by SYNTAX.
4457 SYNTAX should be a raw syntax descriptor; the return value is a
4458 integer which encodes the corresponding syntax class. See Info
4459 node `(elisp)Syntax Table Internals' for a list of codes.
4461 If SYNTAX is nil, return nil."
4462 (and syntax (logand (car syntax) 65535)))
4463 \f
4464 ;; Utility motion commands
4466 (defvar word-move-empty-char-table nil
4467 "Used in `forward-word-strictly' and `backward-word-strictly'
4468 to countermand the effect of `find-word-boundary-function-table'.")
4470 (defun forward-word-strictly (&optional arg)
4471 "Move point forward ARG words (backward if ARG is negative).
4472 If ARG is omitted or nil, move point forward one word.
4473 Normally returns t.
4474 If an edge of the buffer or a field boundary is reached, point is left there
4475 and the function returns nil. Field boundaries are not noticed if
4476 `inhibit-field-text-motion' is non-nil.
4478 This function is like `forward-word', but it is not affected
4479 by `find-word-boundary-function-table'. It is also not interactive."
4480 (let ((find-word-boundary-function-table
4481 (if (char-table-p word-move-empty-char-table)
4482 word-move-empty-char-table
4483 (setq word-move-empty-char-table (make-char-table nil)))))
4484 (forward-word (or arg 1))))
4486 (defun backward-word-strictly (&optional arg)
4487 "Move backward until encountering the beginning of a word.
4488 With argument ARG, do this that many times.
4489 If ARG is omitted or nil, move point backward one word.
4491 This function is like `forward-word', but it is not affected
4492 by `find-word-boundary-function-table'. It is also not interactive."
4493 (let ((find-word-boundary-function-table
4494 (if (char-table-p word-move-empty-char-table)
4495 word-move-empty-char-table
4496 (setq word-move-empty-char-table (make-char-table nil)))))
4497 (forward-word (- (or arg 1)))))
4499 ;; Whitespace
4501 (defun forward-whitespace (arg)
4502 "Move point to the end of the next sequence of whitespace chars.
4503 Each such sequence may be a single newline, or a sequence of
4504 consecutive space and/or tab characters.
4505 With prefix argument ARG, do it ARG times if positive, or move
4506 backwards ARG times if negative."
4507 (interactive "^p")
4508 (if (natnump arg)
4510 (while (< arg 0)
4514 (setq arg (1+ arg)))))
4516 ;; Symbols
4518 (defun forward-symbol (arg)
4519 "Move point to the next position that is the end of a symbol.
4520 A symbol is any sequence of characters that are in either the
4521 word constituent or symbol constituent syntax class.
4522 With prefix argument ARG, do it ARG times if positive, or move
4523 backwards ARG times if negative."
4524 (interactive "^p")
4525 (if (natnump arg)
4527 (while (< arg 0)
4529 (skip-syntax-backward "w_"))
4530 (setq arg (1+ arg)))))
4532 ;; Syntax blocks
4534 (defun forward-same-syntax (&optional arg)
4535 "Move point past all characters with the same syntax class.
4536 With prefix argument ARG, do it ARG times if positive, or move
4537 backwards ARG times if negative."
4538 (interactive "^p")
4539 (or arg (setq arg 1))
4540 (while (< arg 0)
4541 (skip-syntax-backward
4542 (char-to-string (char-syntax (char-before))))
4543 (setq arg (1+ arg)))
4544 (while (> arg 0)
4545 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4546 (setq arg (1- arg))))
4548 \f
4549 ;;;; Text clones
4551 (defvar text-clone--maintaining nil)
4553 (defun text-clone--maintain (ol1 after beg end &optional _len)
4554 "Propagate the changes made under the overlay OL1 to the other clones.
4555 This is used on the `modification-hooks' property of text clones."
4556 (when (and after (not undo-in-progress)
4557 (not text-clone--maintaining)
4558 (overlay-start ol1))
4559 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4560 (setq beg (max beg (+ (overlay-start ol1) margin)))
4561 (setq end (min end (- (overlay-end ol1) margin)))
4562 (when (<= beg end)
4563 (save-excursion
4564 (when (overlay-get ol1 'text-clone-syntax)
4565 ;; Check content of the clone's text.
4566 (let ((cbeg (+ (overlay-start ol1) margin))
4567 (cend (- (overlay-end ol1) margin)))
4568 (goto-char cbeg)
4569 (save-match-data
4570 (if (not (re-search-forward
4571 (overlay-get ol1 'text-clone-syntax) cend t))
4572 ;; Mark the overlay for deletion.
4573 (setq end cbeg)
4574 (when (< (match-end 0) cend)
4575 ;; Shrink the clone at its end.
4576 (setq end (min end (match-end 0)))
4577 (move-overlay ol1 (overlay-start ol1)
4578 (+ (match-end 0) margin)))
4579 (when (> (match-beginning 0) cbeg)
4580 ;; Shrink the clone at its beginning.
4581 (setq beg (max (match-beginning 0) beg))
4582 (move-overlay ol1 (- (match-beginning 0) margin)
4583 (overlay-end ol1)))))))
4584 ;; Now go ahead and update the clones.
4585 (let ((head (- beg (overlay-start ol1)))
4586 (tail (- (overlay-end ol1) end))
4587 (str (buffer-substring beg end))
4588 (nothing-left t)
4589 (text-clone--maintaining t))
4590 (dolist (ol2 (overlay-get ol1 'text-clones))
4591 (let ((oe (overlay-end ol2)))
4592 (unless (or (eq ol1 ol2) (null oe))
4593 (setq nothing-left nil)
4594 (let ((mod-beg (+ (overlay-start ol2) head)))
4595 ;;(overlay-put ol2 'modification-hooks nil)
4596 (goto-char (- (overlay-end ol2) tail))
4597 (unless (> mod-beg (point))
4598 (save-excursion (insert str))
4599 (delete-region mod-beg (point)))
4600 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4601 ))))
4602 (if nothing-left (delete-overlay ol1))))))))
4604 (defun text-clone-create (start end &optional spreadp syntax)
4605 "Create a text clone of START...END at point.
4606 Text clones are chunks of text that are automatically kept identical:
4607 changes done to one of the clones will be immediately propagated to the other.
4609 The buffer's content at point is assumed to be already identical to
4610 the one between START and END.
4611 If SYNTAX is provided it's a regexp that describes the possible text of
4612 the clones; the clone will be shrunk or killed if necessary to ensure that
4613 its text matches the regexp.
4614 If SPREADP is non-nil it indicates that text inserted before/after the
4615 clone should be incorporated in the clone."
4616 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4617 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4618 ;; (with a one-char margin at each end) with `t nil'.
4619 ;; We opted for a larger overlay because it behaves better in the case
4620 ;; where the clone is reduced to the empty string (we want the overlay to
4621 ;; stay when the clone's content is the empty string and we want to use
4622 ;; `evaporate' to make sure those overlays get deleted when needed).
4623 ;;
4624 (let* ((pt-end (+ (point) (- end start)))
4625 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4626 0 1))
4627 (end-margin (if (or (not spreadp)
4628 (>= pt-end (point-max))
4629 (>= start (point-max)))
4630 0 1))
4631 ;; FIXME: Reuse overlays at point to extend dups!
4632 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4633 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4634 (dups (list ol1 ol2)))
4635 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4636 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4637 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4638 ;;(overlay-put ol1 'face 'underline)
4639 (overlay-put ol1 'evaporate t)
4640 (overlay-put ol1 'text-clones dups)
4641 ;;
4642 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4643 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4644 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4645 ;;(overlay-put ol2 'face 'underline)
4646 (overlay-put ol2 'evaporate t)
4647 (overlay-put ol2 'text-clones dups)))
4648 \f
4649 ;;;; Mail user agents.
4651 ;; Here we include just enough for other packages to be able
4652 ;; to define them.
4654 (defun define-mail-user-agent (symbol composefunc sendfunc
4655 &optional abortfunc hookvar)
4656 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4658 SYMBOL can be any Lisp symbol. Its function definition and/or
4659 value as a variable do not matter for this usage; we use only certain
4660 properties on its property list, to encode the rest of the arguments.
4662 COMPOSEFUNC is program callable function that composes an outgoing
4663 mail message buffer. This function should set up the basics of the
4664 buffer without requiring user interaction. It should populate the
4665 standard mail headers, leaving the `to:' and `subject:' headers blank
4666 by default.
4668 COMPOSEFUNC should accept several optional arguments--the same
4669 arguments that `compose-mail' takes. See that function's documentation.
4671 SENDFUNC is the command a user would run to send the message.
4673 Optional ABORTFUNC is the command a user would run to abort the
4674 message. For mail packages that don't have a separate abort function,
4675 this can be `kill-buffer' (the equivalent of omitting this argument).
4677 Optional HOOKVAR is a hook variable that gets run before the message
4678 is actually sent. Callers that use the `mail-user-agent' may
4679 install a hook function temporarily on this hook variable.
4680 If HOOKVAR is nil, `mail-send-hook' is used.
4682 The properties used on SYMBOL are `composefunc', `sendfunc',
4683 `abortfunc', and `hookvar'."
4684 (put symbol 'composefunc composefunc)
4685 (put symbol 'sendfunc sendfunc)
4686 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4687 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4689 \f
4690 (defun backtrace--print-frame (evald func args flags)
4691 "Print a trace of a single stack frame to `standard-output'.
4692 EVALD, FUNC, ARGS, FLAGS are as in `mapbacktrace'."
4693 (princ (if (plist-get flags :debug-on-exit) "* " " "))
4694 (cond
4695 ((and evald (not debugger-stack-frame-as-list))
4696 (cl-prin1 func)
4697 (if args (cl-prin1 args) (princ "()")))
4698 (t
4699 (cl-prin1 (cons func args))))
4702 (defun backtrace ()
4703 "Print a trace of Lisp function calls currently active.
4704 Output stream used is value of `standard-output'."
4705 (let ((print-level (or print-level 8))
4706 (print-escape-control-characters t))
4707 (mapbacktrace #'backtrace--print-frame 'backtrace)))
4709 (defun backtrace-frames (&optional base)
4710 "Collect all frames of current backtrace into a list.
4711 If non-nil, BASE should be a function, and frames before its
4712 nearest activation frames are discarded."
4713 (let ((frames nil))
4714 (mapbacktrace (lambda (&rest frame) (push frame frames))
4715 (or base 'backtrace-frames))
4716 (nreverse frames)))
4718 (defun backtrace-frame (nframes &optional base)
4719 "Return the function and arguments NFRAMES up from current execution point.
4720 If non-nil, BASE should be a function, and NFRAMES counts from its
4721 nearest activation frame.
4722 If the frame has not evaluated the arguments yet (or is a special form),
4723 the value is (nil FUNCTION ARG-FORMS...).
4724 If the frame has evaluated its arguments and called its function already,
4725 the value is (t FUNCTION ARG-VALUES...).
4726 A &rest arg is represented as the tail of the list ARG-VALUES.
4727 FUNCTION is whatever was supplied as car of evaluated list,
4728 or a lambda expression for macro calls.
4729 If NFRAMES is more than the number of frames, the value is nil."
4730 (backtrace-frame--internal
4731 (lambda (evald func args _) `(,evald ,func ,@args))
4732 nframes (or base 'backtrace-frame)))
4734 \f
4735 (defvar called-interactively-p-functions nil
4736 "Special hook called to skip special frames in `called-interactively-p'.
4737 The functions are called with 3 arguments: (I FRAME1 FRAME2),
4739 I is the index of the frame after FRAME2. It should return nil
4740 if those frames don't seem special and otherwise, it should return
4741 the number of frames to skip (minus 1).")
4743 (defconst internal--funcall-interactively
4744 (symbol-function 'funcall-interactively))
4746 (defun called-interactively-p (&optional kind)
4747 "Return t if the containing function was called by `call-interactively'.
4748 If KIND is `interactive', then only return t if the call was made
4749 interactively by the user, i.e. not in `noninteractive' mode nor
4750 when `executing-kbd-macro'.
4751 If KIND is `any', on the other hand, it will return t for any kind of
4752 interactive call, including being called as the binding of a key or
4753 from a keyboard macro, even in `noninteractive' mode.
4755 This function is very brittle, it may fail to return the intended result when
4756 the code is debugged, advised, or instrumented in some form. Some macros and
4757 special forms (such as `condition-case') may also sometimes wrap their bodies
4758 in a `lambda', so any call to `called-interactively-p' from those bodies will
4759 indicate whether that lambda (rather than the surrounding function) was called
4760 interactively.
4762 Instead of using this function, it is cleaner and more reliable to give your
4763 function an extra optional argument whose `interactive' spec specifies
4765 \(not (or executing-kbd-macro noninteractive)).
4767 The only known proper use of `interactive' for KIND is in deciding
4768 whether to display a helpful message, or how to display it. If you're
4769 thinking of using it for any other purpose, it is quite likely that
4770 you're making a mistake. Think: what do you want to do when the
4771 command is called from a keyboard macro?"
4772 (declare (advertised-calling-convention (kind) "23.1"))
4773 (when (not (and (eq kind 'interactive)
4774 (or executing-kbd-macro noninteractive)))
4775 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4776 frame nextframe
4777 (get-next-frame
4778 (lambda ()
4779 (setq frame nextframe)
4780 (setq nextframe (backtrace-frame i 'called-interactively-p))
4781 ;; (message "Frame %d = %S" i nextframe)
4782 (setq i (1+ i)))))
4783 (funcall get-next-frame) ;; Get the first frame.
4784 (while
4785 ;; FIXME: The edebug and advice handling should be made modular and
4786 ;; provided directly by edebug.el and nadvice.el.
4787 (progn
4788 ;; frame =(backtrace-frame i-2)
4789 ;; nextframe=(backtrace-frame i-1)
4790 (funcall get-next-frame)
4791 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4792 ;; branches within local functions, which then messes up the
4793 ;; `backtrace-frame' data we get,
4794 (or
4795 ;; Skip special forms (from non-compiled code).
4796 (and frame (null (car frame)))
4797 ;; Skip also `interactive-p' (because we don't want to know if
4798 ;; interactive-p was called interactively but if it's caller was)
4799 ;; and `byte-code' (idem; this appears in subexpressions of things
4800 ;; like condition-case, which are wrapped in a separate bytecode
4801 ;; chunk).
4802 ;; FIXME: For lexical-binding code, this is much worse,
4803 ;; because the frames look like "byte-code -> funcall -> #[...]",
4804 ;; which is not a reliable signature.
4805 (memq (nth 1 frame) '(interactive-p 'byte-code))
4806 ;; Skip package-specific stack-frames.
4807 (let ((skip (run-hook-with-args-until-success
4808 'called-interactively-p-functions
4809 i frame nextframe)))
4810 (pcase skip
4811 (`nil nil)
4812 (`0 t)
4813 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4814 ;; Now `frame' should be "the function from which we were called".
4815 (pcase (cons frame nextframe)
4816 ;; No subr calls `interactive-p', so we can rule that out.
4817 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
4818 ;; In case #<subr funcall-interactively> without going through the
4819 ;; `funcall-interactively' symbol (bug#3984).
4820 (`(,_ . (t ,(pred (lambda (f)
4821 (eq internal--funcall-interactively
4822 (indirect-function f))))
4823 . ,_))
4824 t)))))
4826 (defun interactive-p ()
4827 "Return t if the containing function was run directly by user input.
4828 This means that the function was called with `call-interactively'
4829 \(which includes being called as the binding of a key)
4830 and input is currently coming from the keyboard (not a keyboard macro),
4831 and Emacs is not running in batch mode (`noninteractive' is nil).
4833 The only known proper use of `interactive-p' is in deciding whether to
4834 display a helpful message, or how to display it. If you're thinking
4835 of using it for any other purpose, it is quite likely that you're
4836 making a mistake. Think: what do you want to do when the command is
4837 called from a keyboard macro or in batch mode?
4839 To test whether your function was called with `call-interactively',
4840 either (i) add an extra optional argument and give it an `interactive'
4842 use `called-interactively-p'.
4844 To test whether a function can be called interactively, use
4845 `commandp'."
4846 (declare (obsolete called-interactively-p "23.2"))
4847 (called-interactively-p 'interactive))
4849 (defun internal-push-keymap (keymap symbol)
4850 (let ((map (symbol-value symbol)))
4851 (unless (memq keymap map)
4852 (unless (memq 'add-keymap-witness (symbol-value symbol))
4853 (setq map (make-composed-keymap nil (symbol-value symbol)))
4854 (push 'add-keymap-witness (cdr map))
4855 (set symbol map))
4856 (push keymap (cdr map)))))
4858 (defun internal-pop-keymap (keymap symbol)
4859 (let ((map (symbol-value symbol)))
4860 (when (memq keymap map)
4861 (setf (cdr map) (delq keymap (cdr map))))
4862 (let ((tail (cddr map)))
4863 (and (or (null tail) (keymapp tail))
4864 (eq 'add-keymap-witness (nth 1 map))
4865 (set symbol tail)))))
4867 (define-obsolete-function-alias
4868 'set-temporary-overlay-map 'set-transient-map "24.4")
4870 (defun set-transient-map (map &optional keep-pred on-exit)
4871 "Set MAP as a temporary keymap taking precedence over other keymaps.
4872 Normally, MAP is used only once, to look up the very next key.
4873 However, if the optional argument KEEP-PRED is t, MAP stays
4874 active if a key from MAP is used. KEEP-PRED can also be a
4875 function of no arguments: it is called from `pre-command-hook' and
4876 if it returns non-nil, then MAP stays active.
4878 Optional arg ON-EXIT, if non-nil, specifies a function that is
4879 called, with no arguments, after MAP is deactivated.
4881 This uses `overriding-terminal-local-map' which takes precedence over all other
4882 keymaps. As usual, if no match for a key is found in MAP, the normal key
4883 lookup sequence then continues.
4886 to deactivate this transient map, regardless of KEEP-PRED."
4887 (let* ((clearfun (make-symbol "clear-transient-map"))
4888 (exitfun
4889 (lambda ()
4890 (internal-pop-keymap map 'overriding-terminal-local-map)
4891 (remove-hook 'pre-command-hook clearfun)
4892 (when on-exit (funcall on-exit)))))
4893 ;; Don't use letrec, because equal (in add/remove-hook) would get trapped
4894 ;; in a cycle.
4895 (fset clearfun
4896 (lambda ()
4897 (with-demoted-errors "set-transient-map PCH: %S"
4898 (unless (cond
4899 ((null keep-pred) nil)
4900 ((and (not (eq map (cadr overriding-terminal-local-map)))
4901 (memq map (cddr overriding-terminal-local-map)))
4902 ;; There's presumably some other transient-map in
4903 ;; effect. Wait for that one to terminate before we
4904 ;; remove ourselves.
4905 ;; For example, if isearch and C-u both use transient
4906 ;; maps, then the lifetime of the C-u should be nested
4907 ;; within isearch's, so the pre-command-hook of
4908 ;; isearch should be suspended during the C-u one so
4909 ;; we don't exit isearch just because we hit 1 after
4910 ;; C-u and that 1 exits isearch whereas it doesn't
4911 ;; exit C-u.
4912 t)
4913 ((eq t keep-pred)
4914 (let ((mc (lookup-key map (this-command-keys-vector))))
4915 ;; If the key is unbound `this-command` is
4916 ;; nil and so is `mc`.
4917 (and mc (eq this-command mc))))
4918 (t (funcall keep-pred)))
4919 (funcall exitfun)))))
4920 (add-hook 'pre-command-hook clearfun)
4921 (internal-push-keymap map 'overriding-terminal-local-map)
4922 exitfun))
4924 ;;;; Progress reporters.
4926 ;; Progress reporter has the following structure:
4927 ;;
4928 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4929 ;; MIN-VALUE
4930 ;; MAX-VALUE
4931 ;; MESSAGE
4932 ;; MIN-CHANGE
4933 ;; MIN-TIME])
4934 ;;
4935 ;; This weirdness is for optimization reasons: we want
4936 ;; `progress-reporter-update' to be as fast as possible, so
4937 ;; `(car reporter)' is better than `(aref reporter 0)'.
4938 ;;
4939 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4940 ;; digits of precision, it doesn't really matter here. On the other
4941 ;; hand, it greatly simplifies the code.
4943 (defsubst progress-reporter-update (reporter &optional value)
4944 "Report progress of an operation in the echo area.
4945 REPORTER should be the result of a call to `make-progress-reporter'.
4947 If REPORTER is a numerical progress reporter---i.e. if it was
4948 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4949 `make-progress-reporter'---then VALUE should be a number between
4950 MIN-VALUE and MAX-VALUE.
4952 If REPORTER is a non-numerical reporter, VALUE should be nil.
4954 This function is relatively inexpensive. If the change since
4955 last update is too small or insufficient time has passed, it does
4956 nothing."
4957 (when (or (not (numberp value)) ; For pulsing reporter
4958 (>= value (car reporter))) ; For numerical reporter
4959 (progress-reporter-do-update reporter value)))
4961 (defun make-progress-reporter (message &optional min-value max-value
4962 current-value min-change min-time)
4963 "Return progress reporter object for use with `progress-reporter-update'.
4965 MESSAGE is shown in the echo area, with a status indicator
4966 appended to the end. When you call `progress-reporter-done', the
4968 MESSAGE of an existing progress reporter by calling
4969 `progress-reporter-force-update'.
4971 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4972 and final (100% complete) states of operation; the latter should
4973 be larger. In this case, the status message shows the percentage
4974 progress.
4976 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4979 Optional CURRENT-VALUE is the initial progress; the default is
4980 MIN-VALUE.
4981 Optional MIN-CHANGE is the minimal change in percents to report;
4982 the default is 1%.
4983 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4984 and/or MAX-VALUE are nil.
4986 Optional MIN-TIME specifies the minimum interval time between
4987 echo area updates (default is 0.2 seconds.) If the OS is not
4988 capable of measuring fractions of seconds, this parameter is
4989 effectively rounded up."
4991 (setq message (concat message "...")))
4992 (unless min-time
4993 (setq min-time 0.2))
4994 (let ((reporter
4995 ;; Force a call to `message' now
4996 (cons (or min-value 0)
4997 (vector (if (>= min-time 0.02)
4998 (float-time) nil)
4999 min-value
5000 max-value
5001 message
5002 (if min-change (max (min min-change 50) 1) 1)
5003 min-time))))
5004 (progress-reporter-update reporter (or current-value min-value))
5005 reporter))
5007 (defun progress-reporter-force-update (reporter &optional value new-message)
5008 "Report progress of an operation in the echo area unconditionally.
5010 The first two arguments are the same as in `progress-reporter-update'.
5011 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
5012 (let ((parameters (cdr reporter)))
5013 (when new-message
5014 (aset parameters 3 new-message))
5015 (when (aref parameters 0)
5016 (aset parameters 0 (float-time)))
5017 (progress-reporter-do-update reporter value)))
5020 "Characters to use for pulsing progress reporters.")
5022 (defun progress-reporter-do-update (reporter value)
5023 (let* ((parameters (cdr reporter))
5024 (update-time (aref parameters 0))
5025 (min-value (aref parameters 1))
5026 (max-value (aref parameters 2))
5027 (text (aref parameters 3))
5028 (enough-time-passed
5029 ;; See if enough time has passed since the last update.
5030 (or (not update-time)
5031 (when (>= (float-time) update-time)
5032 ;; Calculate time for the next update
5033 (aset parameters 0 (+ update-time (aref parameters 5)))))))
5034 (cond ((and min-value max-value)
5035 ;; Numerical indicator
5036 (let* ((one-percent (/ (- max-value min-value) 100.0))
5037 (percentage (if (= max-value min-value)
5038 0
5039 (truncate (/ (- value min-value)
5040 one-percent)))))
5041 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
5042 ;; message because not enough time has passed, use 1
5043 ;; instead of MIN-CHANGE. This makes delays between echo
5044 ;; area updates closer to MIN-TIME.
5045 (setcar reporter
5046 (min (+ min-value (* (+ percentage
5047 (if enough-time-passed
5048 ;; MIN-CHANGE
5049 (aref parameters 4)
5050 1))
5051 one-percent))
5052 max-value))
5053 (when (integerp value)
5054 (setcar reporter (ceiling (car reporter))))
5055 ;; Only print message if enough time has passed
5056 (when enough-time-passed
5057 (if (> percentage 0)
5058 (message "%s%d%%" text percentage)
5059 (message "%s" text)))))
5060 ;; Pulsing indicator
5061 (enough-time-passed
5062 (let ((index (mod (1+ (car reporter)) 4))
5063 (message-log-max nil))
5064 (setcar reporter index)
5065 (message "%s %s"
5066 text
5067 (aref progress-reporter--pulse-characters
5068 index)))))))
5070 (defun progress-reporter-done (reporter)
5072 (message "%sdone" (aref (cdr reporter) 3)))
5074 (defmacro dotimes-with-progress-reporter (spec reporter-or-message &rest body)
5075 "Loop a certain number of times and report progress in the echo area.
5076 Evaluate BODY with VAR bound to successive integers running from
5077 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
5078 the return value (nil if RESULT is omitted).
5080 REPORTER-OR-MESSAGE is a progress reporter object or a string. In the latter
5081 case, use this string to create a progress reporter.
5083 At each iteration, print the reporter message followed by progress
5084 percentage in the echo area. After the loop is finished,
5087 This macro is a convenience wrapper around `make-progress-reporter' and friends.
5089 \(fn (VAR COUNT [RESULT]) REPORTER-OR-MESSAGE BODY...)"
5090 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
5091 (let ((prep (make-symbol "--dotimes-prep--"))
5092 (end (make-symbol "--dotimes-end--")))
5093 `(let ((,prep ,reporter-or-message)
5094 (,end ,(cadr spec)))
5095 (when (stringp ,prep)
5096 (setq ,prep (make-progress-reporter ,prep 0 ,end)))
5097 (dotimes (,(car spec) ,end)
5098 ,@body
5099 (progress-reporter-update ,prep (1+ ,(car spec))))
5100 (progress-reporter-done ,prep)
5101 (or ,@(cdr (cdr spec)) nil))))
5103 (defmacro dolist-with-progress-reporter (spec reporter-or-message &rest body)
5104 "Loop over a list and report progress in the echo area.
5105 Evaluate BODY with VAR bound to each car from LIST, in turn.
5106 Then evaluate RESULT to get return value, default nil.
5108 REPORTER-OR-MESSAGE is a progress reporter object or a string. In the latter
5109 case, use this string to create a progress reporter.
5111 At each iteration, print the reporter message followed by progress
5112 percentage in the echo area. After the loop is finished,
5115 \(fn (VAR LIST [RESULT]) REPORTER-OR-MESSAGE BODY...)"
5116 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
5117 (let ((prep (make-symbol "--dolist-progress-reporter--"))
5118 (count (make-symbol "--dolist-count--"))
5119 (list (make-symbol "--dolist-list--")))
5120 `(let ((,prep ,reporter-or-message)
5121 (,count 0)
5122 (,list ,(cadr spec)))
5123 (when (stringp ,prep)
5124 (setq ,prep (make-progress-reporter ,prep 0 (1- (length ,list)))))
5125 (dolist (,(car spec) ,list)
5126 ,@body
5127 (progress-reporter-update ,prep (setq ,count (1+ ,count))))
5128 (progress-reporter-done ,prep)
5129 (or ,@(cdr (cdr spec)) nil))))
5131 \f
5132 ;;;; Comparing version strings.
5134 (defconst version-separator "."
5135 "Specify the string used to separate the version elements.
5140 (defconst version-regexp-alist
5141 '(("^[-._+ ]?snapshot$" . -4)
5142 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
5143 ("^[-._+]$" . -4)
5144 ;; treat "1.2.3-CVS" as snapshot release
5146 ("^[-._+ ]?alpha$" . -3)
5147 ("^[-._+ ]?beta$" . -2)
5149 "Specify association between non-numeric version and its priority.
5153 non-numeric part of a version string to an integer. For example:
5155 String Version Integer List Version
5167 Each element has the following form:
5169 (REGEXP . PRIORITY)
5171 Where:
5173 REGEXP regexp used to match non-numeric part of a version string.
5174 It should begin with the `^' anchor and end with a `$' to
5175 prevent false hits. Letter-case is ignored while matching
5176 REGEXP.
5178 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
5181 (defun version-to-list (ver)
5182 "Convert version string VER into a list of integers.
5184 The version syntax is given by the following EBNF:
5186 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
5188 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
5190 SEPARATOR ::= `version-separator' (which see)
5191 | `version-regexp-alist' (which see).
5193 The NUMBER part is optional if SEPARATOR is a match for an element
5194 in `version-regexp-alist'.
5196 Examples of valid version syntax:
5198 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta 2.4.snapshot .5
5200 Examples of invalid version syntax:
5202 1.0prepre2 1.0..7.5 22.8X3 alpha3.2
5204 Examples of version conversion:
5206 Version String Version as a List of Integers
5219 See documentation for `version-separator' and `version-regexp-alist'."
5220 (unless (stringp ver)
5221 (error "Version must be a string"))
5222 ;; Change .x.y to 0.x.y
5223 (if (and (>= (length ver) (length version-separator))
5224 (string-equal (substring ver 0 (length version-separator))
5225 version-separator))
5226 (setq ver (concat "0" ver)))
5227 (unless (string-match-p "^[0-9]" ver)
5228 (error "Invalid version syntax: `%s' (must start with a number)" ver))
5230 (save-match-data
5231 (let ((i 0)
5232 (case-fold-search t) ; ignore case in matching
5233 lst s al)
5234 ;; Parse the version-string up to a separator until there are none left
5235 (while (and (setq s (string-match "[0-9]+" ver i))
5236 (= s i))
5237 ;; Add the numeric part to the beginning of the version list;
5238 ;; lst gets reversed at the end
5239 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
5240 lst)
5241 i (match-end 0))
5242 ;; handle non-numeric part
5243 (when (and (setq s (string-match "[^0-9]+" ver i))
5244 (= s i))
5245 (setq s (substring ver i (match-end 0))
5246 i (match-end 0))
5247 ;; handle alpha, beta, pre, etc. separator
5248 (unless (string= s version-separator)
5249 (setq al version-regexp-alist)
5250 (while (and al (not (string-match (caar al) s)))
5251 (setq al (cdr al)))
5252 (cond (al
5253 (push (cdar al) lst))
5254 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc., but only if
5255 ;; the letter is the end of the version-string, to avoid
5256 ;; 22.8X3 being valid
5258 (= i (length ver)))
5259 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
5260 lst))
5261 (t (error "Invalid version syntax: `%s'" ver))))))
5262 (nreverse lst))))
5264 (defun version-list-< (l1 l2)
5265 "Return t if L1, a list specification of a version, is lower than L2.
5267 Note that a version specified by the list (1) is equal to (1 0),
5268 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5269 Also, a version given by the list (1) is higher than (1 -1), which in
5270 turn is higher than (1 -2), which is higher than (1 -3)."
5271 (while (and l1 l2 (= (car l1) (car l2)))
5272 (setq l1 (cdr l1)
5273 l2 (cdr l2)))
5274 (cond
5275 ;; l1 not null and l2 not null
5276 ((and l1 l2) (< (car l1) (car l2)))
5277 ;; l1 null and l2 null ==> l1 length = l2 length
5278 ((and (null l1) (null l2)) nil)
5279 ;; l1 not null and l2 null ==> l1 length > l2 length
5280 (l1 (< (version-list-not-zero l1) 0))
5281 ;; l1 null and l2 not null ==> l2 length > l1 length
5282 (t (< 0 (version-list-not-zero l2)))))
5285 (defun version-list-= (l1 l2)
5286 "Return t if L1, a list specification of a version, is equal to L2.
5288 Note that a version specified by the list (1) is equal to (1 0),
5289 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
5290 Also, a version given by the list (1) is higher than (1 -1), which in
5291 turn is higher than (1 -2), which is higher than (1 -3)."
5292 (while (and l1 l2 (= (car l1) (car l2)))
5293 (setq l1 (cdr l1)
5294 l2 (cdr l2)))
5295 (cond
5296 ;; l1 not null and l2 not null
5297 ((and l1 l2) nil)
5298 ;; l1 null and l2 null ==> l1 length = l2 length
5299 ((and (null l1) (null l2)))
5300 ;; l1 not null and l2 null ==> l1 length > l2 length
5301 (l1 (zerop (version-list-not-zero l1)))
5302 ;; l1 null and l2 not null ==> l2 length > l1 length
5303 (t (zerop (version-list-not-zero l2)))))
5306 (defun version-list-<= (l1 l2)
5307 "Return t if L1, a list specification of a version, is lower or equal to L2.
5309 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
5310 etc. That is, the trailing zeroes are insignificant. Also, integer
5311 list (1) is greater than (1 -1) which is greater than (1 -2)
5312 which is greater than (1 -3)."
5313 (while (and l1 l2 (= (car l1) (car l2)))
5314 (setq l1 (cdr l1)
5315 l2 (cdr l2)))
5316 (cond
5317 ;; l1 not null and l2 not null
5318 ((and l1 l2) (< (car l1) (car l2)))
5319 ;; l1 null and l2 null ==> l1 length = l2 length
5320 ((and (null l1) (null l2)))
5321 ;; l1 not null and l2 null ==> l1 length > l2 length
5322 (l1 (<= (version-list-not-zero l1) 0))
5323 ;; l1 null and l2 not null ==> l2 length > l1 length
5324 (t (<= 0 (version-list-not-zero l2)))))
5326 (defun version-list-not-zero (lst)
5327 "Return the first non-zero element of LST, which is a list of integers.
5329 If all LST elements are zeros or LST is nil, return zero."
5330 (while (and lst (zerop (car lst)))
5331 (setq lst (cdr lst)))
5332 (if lst
5333 (car lst)
5334 ;; there is no element different of zero
5335 0))
5338 (defun version< (v1 v2)
5339 "Return t if version V1 is lower (older) than V2.
5346 (version-list-< (version-to-list v1) (version-to-list v2)))
5348 (defun version<= (v1 v2)
5349 "Return t if version V1 is lower (older) than or equal to V2.
5356 (version-list-<= (version-to-list v1) (version-to-list v2)))
5358 (defun version= (v1 v2)
5359 "Return t if version V1 is equal to V2.
5366 (version-list-= (version-to-list v1) (version-to-list v2)))
5368 (defvar package--builtin-versions
5369 ;; Mostly populated by loaddefs.el via autoload-builtin-package-versions.
5370 (purecopy `((emacs . ,(version-to-list emacs-version))))
5371 "Alist giving the version of each versioned builtin package.
5372 I.e. each element of the list is of the form (NAME . VERSION) where
5373 NAME is the package name as a symbol, and VERSION is its version
5374 as a list.")
5376 (defun package--description-file (dir)
5377 (concat (let ((subdir (file-name-nondirectory
5378 (directory-file-name dir))))
5379 (if (string-match "\\([^.].*?\\)-\\([0-9]+\\(?:[.][0-9]+\\|\\(?:pre\\|beta\\|alpha\\)[0-9]+\\)*\\)" subdir)
5380 (match-string 1 subdir) subdir))
5381 "-pkg.el"))
5383 \f
5384 ;;; Thread support.
5386 (defmacro with-mutex (mutex &rest body)
5387 "Invoke BODY with MUTEX held, releasing MUTEX when done.
5388 This is the simplest safe way to acquire and release a mutex."
5389 (declare (indent 1) (debug t))
5390 (let ((sym (make-symbol "mutex")))
5391 `(let ((,sym ,mutex))
5392 (mutex-lock ,sym)
5393 (unwind-protect
5394 (progn ,@body)
5395 (mutex-unlock ,sym)))))
5397 \f
5398 ;;; Misc.
5400 (defvar definition-prefixes (make-hash-table :test 'equal)
5401 "Hash table mapping prefixes to the files in which they're used.
5402 This can be used to automatically fetch not-yet-loaded definitions.
5403 More specifically, if there is a value of the form (FILES...) for a string PREFIX
5404 it means that the FILES define variables or functions with names that start
5405 with PREFIX.
5407 Note that it does not imply that all definitions starting with PREFIX can
5413 (defun register-definition-prefixes (file prefixes)
5414 "Register that FILE uses PREFIXES."
5415 (dolist (prefix prefixes)
5416 (puthash prefix (cons file (gethash prefix definition-prefixes))
5417 definition-prefixes)))
5419 (defconst menu-bar-separator '("--")
5420 "Separator for menus.")
5422 ;; The following statement ought to be in print.c, but `provide' can't
5423 ;; be used there.
5424 ;; https://lists.gnu.org/r/emacs-devel/2009-08/msg00236.html
5425 (when (hash-table-p (car (read-from-string
5426 (prin1-to-string (make-hash-table)))))
5427 (provide 'hashtable-print-readable))
5429 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
5430 ;; generate file names for autoloads, custom-deps, and finder-data.
5431 (defun unmsys--file-name (file)
5432 "Produce the canonical file name for FILE from its MSYS form.
5434 On systems other than MS-Windows, just returns FILE.
5435 On MS-Windows, converts /d/foo/bar form of file names
5436 passed by MSYS Make into d:/foo/bar that Emacs can grok.
5438 This function is called from lisp/Makefile and leim/Makefile."
5439 (when (and (eq system-type 'windows-nt)
5441 (setq file (concat (substring file 1 2) ":" (substring file 2))))
5442 file)
5445 ;;; subr.el ends here