1 ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8; lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2014 Free Software
6 ;; Maintainer: emacs-devel@gnu.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; Beware: while this file has tag `utf-8', before it's compiled, it gets
30 ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
32 (defmacro declare-function
(_fn _file
&optional _arglist _fileonly
)
33 "Tell the byte-compiler that function FN is defined, in FILE.
34 Optional ARGLIST is the argument list used by the function.
35 The FILE argument is not used by the byte-compiler, but by the
36 `check-declare' package, which checks that FILE contains a
37 definition for FN. ARGLIST is used by both the byte-compiler
38 and `check-declare' to check for consistency.
40 FILE can be either a Lisp file (in which case the \".el\"
41 extension is optional), or a C file. C files are expanded
42 relative to the Emacs \"src/\" directory. Lisp files are
43 searched for using `locate-library', and if that fails they are
44 expanded relative to the location of the file containing the
45 declaration. A FILE with an \"ext:\" prefix is an external file.
46 `check-declare' will check such files if they are found, and skip
47 them without error if they are not.
49 FILEONLY non-nil means that `check-declare' will only check that
50 FILE exists, not that it defines FN. This is intended for
51 function-definitions that `check-declare' does not recognize, e.g.
54 To specify a value for FILEONLY without passing an argument list,
55 set ARGLIST to t. This is necessary because nil means an
56 empty argument list, rather than an unspecified one.
58 Note that for the purposes of `check-declare', this statement
59 must be the first non-whitespace on a line.
61 For more information, see Info node `(elisp)Declaring Functions'."
62 ;; Does nothing - byte-compile-declare-function does the work.
66 ;;;; Basic Lisp macros.
68 (defmacro noreturn
(form)
69 "Evaluate FORM, expecting it not to return.
70 If FORM does return, signal an error."
73 (error "Form marked with `noreturn' did return")))
75 (defmacro 1value
(form)
76 "Evaluate FORM, expecting a constant return value.
77 This is the global do-nothing version. There is also `testcover-1value'
78 that complains if FORM ever does return differing values."
82 (defmacro def-edebug-spec
(symbol spec
)
83 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
84 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
85 0 (instrument no arguments); t (instrument all arguments);
86 a symbol (naming a function with an Edebug specification); or a list.
87 The elements of the list describe the argument types; see
88 Info node `(elisp)Specification List' for details."
89 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
91 (defmacro lambda
(&rest cdr
)
92 "Return a lambda expression.
93 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
94 self-quoting; the result of evaluating the lambda expression is the
95 expression itself. The lambda expression may then be treated as a
96 function, i.e., stored as the function value of a symbol, passed to
97 `funcall' or `mapcar', etc.
99 ARGS should take the same form as an argument list for a `defun'.
100 DOCSTRING is an optional documentation string.
101 If present, it should describe how to call the function.
102 But documentation strings are usually not useful in nameless functions.
103 INTERACTIVE should be a call to the function `interactive', which see.
104 It may also be omitted.
105 BODY should be a list of Lisp expressions.
107 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
108 (declare (doc-string 2) (indent defun
)
109 (debug (&define lambda-list
111 [&optional
("interactive" interactive
)]
113 ;; Note that this definition should not use backquotes; subr.el should not
114 ;; depend on backquote.el.
115 (list 'function
(cons 'lambda cdr
)))
117 (defmacro setq-local
(var val
)
118 "Set variable VAR to value VAL in current buffer."
119 ;; Can't use backquote here, it's too early in the bootstrap.
120 (list 'set
(list 'make-local-variable
(list 'quote var
)) val
))
122 (defmacro defvar-local
(var val
&optional docstring
)
123 "Define VAR as a buffer-local variable with default value VAL.
124 Like `defvar' but additionally marks the variable as being automatically
125 buffer-local wherever it is set."
126 (declare (debug defvar
) (doc-string 3))
127 ;; Can't use backquote here, it's too early in the bootstrap.
128 (list 'progn
(list 'defvar var val docstring
)
129 (list 'make-variable-buffer-local
(list 'quote var
))))
131 (defun apply-partially (fun &rest args
)
132 "Return a function that is a partial application of FUN to ARGS.
133 ARGS is a list of the first N arguments to pass to FUN.
134 The result is a new function which does the same as FUN, except that
135 the first N arguments are fixed at the values with which this function
137 `(closure (t) (&rest args
)
138 (apply ',fun
,@(mapcar (lambda (arg) `',arg
) args
) args
)))
140 (defmacro push
(newelt place
)
141 "Add NEWELT to the list stored in the generalized variable PLACE.
142 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
143 except that PLACE is only evaluated once (after NEWELT)."
144 (declare (debug (form gv-place
)))
146 ;; Important special case, to avoid triggering GV too early in
149 (list 'cons newelt place
))
152 (eval `(let ((newelt ',newelt
)
154 (macroexp-let2 macroexp-copyable-p v newelt
155 (gv-letplace (getter setter
) place
156 (funcall setter
(list 'cons v getter
))))))))
158 (defmacro pop
(place)
159 "Return the first element of PLACE's value, and remove it from the list.
160 PLACE must be a generalized variable whose value is a list.
161 If the value is nil, `pop' returns nil but does not actually
163 (declare (debug (gv-place)))
164 ;; We use `car-safe' here instead of `car' because the behavior is the same
165 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
166 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
167 ;; result is not used.
170 ;; So we can use `pop' in the bootstrap before `gv' can be used.
171 (list 'prog1 place
(list 'setq place
(list 'cdr place
)))
173 (eval `(let ((place ',place
))
174 (gv-letplace (getter setter
) place
175 `(prog1 ,getter
,(funcall setter
`(cdr ,getter
)))))))))
177 (defmacro when
(cond &rest body
)
178 "If COND yields non-nil, do BODY, else return nil.
179 When COND yields non-nil, eval BODY forms sequentially and return
180 value of last one, or nil if there are none.
183 (declare (indent 1) (debug t
))
184 (list 'if cond
(cons 'progn body
)))
186 (defmacro unless
(cond &rest body
)
187 "If COND yields nil, do BODY, else return nil.
188 When COND yields nil, eval BODY forms sequentially and return
189 value of last one, or nil if there are none.
192 (declare (indent 1) (debug t
))
193 (cons 'if
(cons cond
(cons nil body
))))
195 (defmacro dotimes
(spec &rest body
)
196 "Loop a certain number of times.
197 Evaluate BODY with VAR bound to successive integers running from 0,
198 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
199 the return value (nil if RESULT is omitted).
201 \(fn (VAR COUNT [RESULT]) BODY...)"
202 (declare (indent 1) (debug dolist
))
203 ;; It would be cleaner to create an uninterned symbol,
204 ;; but that uses a lot more space when many functions in many files
206 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
207 (let ((temp '--dotimes-limit--
)
210 ;; This is not a reliable test, but it does not matter because both
211 ;; semantics are acceptable, tho one is slightly faster with dynamic
212 ;; scoping and the other has cleaner semantics.
214 (let ((counter '--dotimes-counter--
))
217 (while (< ,counter
,temp
)
218 (let ((,(car spec
) ,counter
))
220 (setq ,counter
(1+ ,counter
)))
222 ;; FIXME: This let often leads to "unused var" warnings.
223 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
225 (,(car spec
) ,start
))
226 (while (< ,(car spec
) ,temp
)
228 (setq ,(car spec
) (1+ ,(car spec
))))
229 ,@(cdr (cdr spec
))))))
231 (defmacro ignore-errors
(&rest body
)
232 "Execute BODY; if an error occurs, return nil.
233 Otherwise, return result of last form in BODY.
234 See also `with-demoted-errors' that does something similar
235 without silencing all errors."
236 (declare (debug t
) (indent 0))
237 `(condition-case nil
(progn ,@body
) (error nil
)))
239 ;;;; Basic Lisp functions.
241 (defun ignore (&rest _ignore
)
242 "Do nothing and return nil.
243 This function accepts any number of arguments, but ignores them."
247 ;; Signal a compile-error if the first arg is missing.
248 (defun error (&rest args
)
249 "Signal an error, making error message by passing all args to `format'.
250 In Emacs, the convention is that error messages start with a capital
251 letter but *do not* end with a period. Please follow this convention
252 for the sake of consistency."
253 (declare (advertised-calling-convention (string &rest args
) "23.1"))
254 (signal 'error
(list (apply 'format args
))))
256 (defun user-error (format &rest args
)
257 "Signal a pilot error, making error message by passing all args to `format'.
258 In Emacs, the convention is that error messages start with a capital
259 letter but *do not* end with a period. Please follow this convention
260 for the sake of consistency.
261 This is just like `error' except that `user-error's are expected to be the
262 result of an incorrect manipulation on the part of the user, rather than the
263 result of an actual problem."
264 (signal 'user-error
(list (apply #'format format args
))))
266 (defun define-error (name message
&optional parent
)
267 "Define NAME as a new error signal.
268 MESSAGE is a string that will be output to the echo area if such an error
269 is signaled without being caught by a `condition-case'.
270 PARENT is either a signal or a list of signals from which it inherits.
271 Defaults to `error'."
272 (unless parent
(setq parent
'error
))
276 (mapcar (lambda (parent)
278 (or (get parent
'error-conditions
)
279 (error "Unknown signal `%s'" parent
))))
281 (cons parent
(get parent
'error-conditions
)))))
282 (put name
'error-conditions
283 (delete-dups (copy-sequence (cons name conditions
))))
284 (when message
(put name
'error-message message
))))
286 ;; We put this here instead of in frame.el so that it's defined even on
287 ;; systems where frame.el isn't loaded.
288 (defun frame-configuration-p (object)
289 "Return non-nil if OBJECT seems to be a frame configuration.
290 Any list whose car is `frame-configuration' is assumed to be a frame
293 (eq (car object
) 'frame-configuration
)))
299 "Return the car of the car of X."
303 "Return the car of the cdr of X."
307 "Return the cdr of the car of X."
311 "Return the cdr of the cdr of X."
314 (defun last (list &optional n
)
315 "Return the last link of LIST. Its car is the last element.
316 If LIST is nil, return nil.
317 If N is non-nil, return the Nth-to-last link of LIST.
318 If N is bigger than the length of LIST, return LIST."
321 (let ((m (safe-length list
)))
322 (if (< n m
) (nthcdr (- m n
) list
) list
)))
324 (nthcdr (1- (safe-length list
)) list
))))
326 (defun butlast (list &optional n
)
327 "Return a copy of LIST with the last N elements removed.
328 If N is omitted or nil, the last element is removed from the
330 (if (and n
(<= n
0)) list
331 (nbutlast (copy-sequence list
) n
)))
333 (defun nbutlast (list &optional n
)
334 "Modifies LIST to remove the last N elements.
335 If N is omitted or nil, remove the last element."
336 (let ((m (length list
)))
340 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
343 (defun zerop (number)
344 "Return t if NUMBER is zero."
345 ;; Used to be in C, but it's pointless since (= 0 n) is faster anyway because
346 ;; = has a byte-code.
347 (declare (compiler-macro (lambda (_) `(= 0 ,number
))))
350 (defun delete-dups (list)
351 "Destructively remove `equal' duplicates from LIST.
352 Store the result in LIST and return it. LIST must be a proper list.
353 Of several `equal' occurrences of an element in LIST, the first
357 (setcdr tail
(delete (car tail
) (cdr tail
)))
358 (setq tail
(cdr tail
))))
361 ;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html
362 (defun delete-consecutive-dups (list &optional circular
)
363 "Destructively remove `equal' consecutive duplicates from LIST.
364 First and last elements are considered consecutive if CIRCULAR is
366 (let ((tail list
) last
)
368 (if (equal (car tail
) (cadr tail
))
369 (setcdr tail
(cddr tail
))
370 (setq last
(car tail
)
374 (equal last
(car list
)))
378 (defun number-sequence (from &optional to inc
)
379 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
380 INC is the increment used between numbers in the sequence and defaults to 1.
381 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
382 zero. TO is only included if there is an N for which TO = FROM + N * INC.
383 If TO is nil or numerically equal to FROM, return (FROM).
384 If INC is positive and TO is less than FROM, or INC is negative
385 and TO is larger than FROM, return nil.
386 If INC is zero and TO is neither nil nor numerically equal to
387 FROM, signal an error.
389 This function is primarily designed for integer arguments.
390 Nevertheless, FROM, TO and INC can be integer or float. However,
391 floating point arithmetic is inexact. For instance, depending on
392 the machine, it may quite well happen that
393 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
394 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
395 elements. Thus, if some of the arguments are floats and one wants
396 to make sure that TO is included, one may have to explicitly write
397 TO as (+ FROM (* N INC)) or use a variable whose value was
398 computed with this exact expression. Alternatively, you can,
399 of course, also replace TO with a slightly larger value
400 \(or a slightly more negative value if INC is negative)."
401 (if (or (not to
) (= from to
))
403 (or inc
(setq inc
1))
404 (when (zerop inc
) (error "The increment can not be zero"))
405 (let (seq (n 0) (next from
))
408 (setq seq
(cons next seq
)
410 next
(+ from
(* n inc
))))
412 (setq seq
(cons next seq
)
414 next
(+ from
(* n inc
)))))
417 (defun copy-tree (tree &optional vecp
)
418 "Make a copy of TREE.
419 If TREE is a cons cell, this recursively copies both its car and its cdr.
420 Contrast to `copy-sequence', which copies only along the cdrs. With second
421 argument VECP, this copies vectors as well as conses."
425 (let ((newcar (car tree
)))
426 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
427 (setq newcar
(copy-tree (car tree
) vecp
)))
428 (push newcar result
))
429 (setq tree
(cdr tree
)))
430 (nconc (nreverse result
) tree
))
431 (if (and vecp
(vectorp tree
))
432 (let ((i (length (setq tree
(copy-sequence tree
)))))
433 (while (>= (setq i
(1- i
)) 0)
434 (aset tree i
(copy-tree (aref tree i
) vecp
)))
438 ;;;; Various list-search functions.
440 (defun assoc-default (key alist
&optional test default
)
441 "Find object KEY in a pseudo-alist ALIST.
442 ALIST is a list of conses or objects. Each element
443 (or the element's car, if it is a cons) is compared with KEY by
444 calling TEST, with two arguments: (i) the element or its car,
446 If that is non-nil, the element matches; then `assoc-default'
447 returns the element's cdr, if it is a cons, or DEFAULT if the
448 element is not a cons.
450 If no element matches, the value is nil.
451 If TEST is omitted or nil, `equal' is used."
452 (let (found (tail alist
) value
)
453 (while (and tail
(not found
))
454 (let ((elt (car tail
)))
455 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
456 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
457 (setq tail
(cdr tail
)))
460 (defun assoc-ignore-case (key alist
)
461 "Like `assoc', but ignores differences in case and text representation.
462 KEY must be a string. Upper-case and lower-case letters are treated as equal.
463 Unibyte strings are converted to multibyte for comparison."
464 (declare (obsolete assoc-string
"22.1"))
465 (assoc-string key alist t
))
467 (defun assoc-ignore-representation (key alist
)
468 "Like `assoc', but ignores differences in text representation.
469 KEY must be a string.
470 Unibyte strings are converted to multibyte for comparison."
471 (declare (obsolete assoc-string
"22.1"))
472 (assoc-string key alist nil
))
474 (defun member-ignore-case (elt list
)
475 "Like `member', but ignore differences in case and text representation.
476 ELT must be a string. Upper-case and lower-case letters are treated as equal.
477 Unibyte strings are converted to multibyte for comparison.
478 Non-strings in LIST are ignored."
480 (not (and (stringp (car list
))
481 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
482 (setq list
(cdr list
)))
485 (defun assq-delete-all (key alist
)
486 "Delete from ALIST all elements whose car is `eq' to KEY.
487 Return the modified alist.
488 Elements of ALIST that are not conses are ignored."
489 (while (and (consp (car alist
))
490 (eq (car (car alist
)) key
))
491 (setq alist
(cdr alist
)))
492 (let ((tail alist
) tail-cdr
)
493 (while (setq tail-cdr
(cdr tail
))
494 (if (and (consp (car tail-cdr
))
495 (eq (car (car tail-cdr
)) key
))
496 (setcdr tail
(cdr tail-cdr
))
497 (setq tail tail-cdr
))))
500 (defun rassq-delete-all (value alist
)
501 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
502 Return the modified alist.
503 Elements of ALIST that are not conses are ignored."
504 (while (and (consp (car alist
))
505 (eq (cdr (car alist
)) value
))
506 (setq alist
(cdr alist
)))
507 (let ((tail alist
) tail-cdr
)
508 (while (setq tail-cdr
(cdr tail
))
509 (if (and (consp (car tail-cdr
))
510 (eq (cdr (car tail-cdr
)) value
))
511 (setcdr tail
(cdr tail-cdr
))
512 (setq tail tail-cdr
))))
515 (defun remove (elt seq
)
516 "Return a copy of SEQ with all occurrences of ELT removed.
517 SEQ must be a list, vector, or string. The comparison is done with `equal'."
519 ;; If SEQ isn't a list, there's no need to copy SEQ because
520 ;; `delete' will return a new object.
522 (delete elt
(copy-sequence seq
))))
524 (defun remq (elt list
)
525 "Return LIST with all occurrences of ELT removed.
526 The comparison is done with `eq'. Contrary to `delq', this does not use
527 side-effects, and the argument LIST is not modified."
528 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
530 (delq elt
(copy-sequence list
))
536 "Convert KEYS to the internal Emacs key representation.
537 KEYS should be a string constant in the format used for
538 saving keyboard macros (see `edmacro-mode')."
539 ;; Don't use a defalias, since the `pure' property is only true for
540 ;; the calling convention of `kbd'.
541 (read-kbd-macro keys
))
545 "Beep to tell the user this binding is undefined."
548 (message "%s is undefined" (key-description (this-single-command-keys)))
549 (setq defining-kbd-macro nil
)
550 (force-mode-line-update)
551 ;; If this is a down-mouse event, don't reset prefix-arg;
552 ;; pass it to the command run by the up event.
554 (when (memq 'down
(event-modifiers last-command-event
))
555 current-prefix-arg
)))
557 ;; Prevent the \{...} documentation construct
558 ;; from mentioning keys that run this command.
559 (put 'undefined
'suppress-keymap t
)
561 (defun suppress-keymap (map &optional nodigits
)
562 "Make MAP override all normally self-inserting keys to be undefined.
563 Normally, as an exception, digits and minus-sign are set to make prefix args,
564 but optional second arg NODIGITS non-nil treats them like other chars."
565 (define-key map
[remap self-insert-command
] 'undefined
)
568 (define-key map
"-" 'negative-argument
)
569 ;; Make plain numbers do numeric args.
572 (define-key map
(char-to-string loop
) 'digit-argument
)
573 (setq loop
(1+ loop
))))))
575 (defun make-composed-keymap (maps &optional parent
)
576 "Construct a new keymap composed of MAPS and inheriting from PARENT.
577 When looking up a key in the returned map, the key is looked in each
578 keymap of MAPS in turn until a binding is found.
579 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
580 As always with keymap inheritance, a nil binding in MAPS overrides
581 any corresponding binding in PARENT, but it does not override corresponding
582 bindings in other keymaps of MAPS.
583 MAPS can be a list of keymaps or a single keymap.
584 PARENT if non-nil should be a keymap."
586 ,@(if (keymapp maps
) (list maps
) maps
)
589 (defun define-key-after (keymap key definition
&optional after
)
590 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
591 This is like `define-key' except that the binding for KEY is placed
592 just after the binding for the event AFTER, instead of at the beginning
593 of the map. Note that AFTER must be an event type (like KEY), NOT a command
596 If AFTER is t or omitted, the new binding goes at the end of the keymap.
597 AFTER should be a single event type--a symbol or a character, not a sequence.
599 Bindings are always added before any inherited map.
601 The order of bindings in a keymap only matters when it is used as
602 a menu, so this function is not useful for non-menu keymaps."
603 (unless after
(setq after t
))
605 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
607 (if (<= (length key
) 1) (aref key
0)
608 (setq keymap
(lookup-key keymap
610 (butlast (mapcar 'identity key
)))))
611 (aref key
(1- (length key
)))))
612 (let ((tail keymap
) done inserted
)
613 (while (and (not done
) tail
)
614 ;; Delete any earlier bindings for the same key.
615 (if (eq (car-safe (car (cdr tail
))) key
)
616 (setcdr tail
(cdr (cdr tail
))))
617 ;; If we hit an included map, go down that one.
618 (if (keymapp (car tail
)) (setq tail
(car tail
)))
619 ;; When we reach AFTER's binding, insert the new binding after.
620 ;; If we reach an inherited keymap, insert just before that.
621 ;; If we reach the end of this keymap, insert at the end.
622 (if (or (and (eq (car-safe (car tail
)) after
)
624 (eq (car (cdr tail
)) 'keymap
)
627 ;; Stop the scan only if we find a parent keymap.
628 ;; Keep going past the inserted element
629 ;; so we can delete any duplications that come later.
630 (if (eq (car (cdr tail
)) 'keymap
)
632 ;; Don't insert more than once.
634 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
636 (setq tail
(cdr tail
)))))
638 (defun map-keymap-sorted (function keymap
)
639 "Implement `map-keymap' with sorting.
640 Don't call this function; it is for internal use only."
642 (map-keymap (lambda (a b
) (push (cons a b
) list
))
644 (setq list
(sort list
646 (setq a
(car a
) b
(car b
))
648 (if (integerp b
) (< a b
)
651 ;; string< also accepts symbols.
654 (funcall function
(car p
) (cdr p
)))))
656 (defun keymap--menu-item-binding (val)
657 "Return the binding part of a menu-item."
659 ((not (consp val
)) val
) ;Not a menu-item.
660 ((eq 'menu-item
(car val
))
661 (let* ((binding (nth 2 val
))
662 (plist (nthcdr 3 val
))
663 (filter (plist-get plist
:filter
)))
664 (if filter
(funcall filter binding
)
666 ((and (consp (cdr val
)) (stringp (cadr val
)))
670 (t val
))) ;Not a menu-item either.
672 (defun keymap--menu-item-with-binding (item binding
)
673 "Build a menu-item like ITEM but with its binding changed to BINDING."
675 ((not (consp item
)) binding
) ;Not a menu-item.
676 ((eq 'menu-item
(car item
))
677 (setq item
(copy-sequence item
))
678 (let ((tail (nthcdr 2 item
)))
679 (setcar tail binding
)
680 ;; Remove any potential filter.
681 (if (plist-get (cdr tail
) :filter
)
682 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
684 ((and (consp (cdr item
)) (stringp (cadr item
)))
685 (cons (car item
) (cons (cadr item
) binding
)))
686 (t (cons (car item
) binding
))))
688 (defun keymap--merge-bindings (val1 val2
)
689 "Merge bindings VAL1 and VAL2."
690 (let ((map1 (keymap--menu-item-binding val1
))
691 (map2 (keymap--menu-item-binding val2
)))
692 (if (not (and (keymapp map1
) (keymapp map2
)))
693 ;; There's nothing to merge: val1 takes precedence.
695 (let ((map (list 'keymap map1 map2
))
696 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
697 (keymap--menu-item-with-binding item map
)))))
699 (defun keymap-canonicalize (map)
700 "Return a simpler equivalent keymap.
701 This resolves inheritance and redefinitions. The returned keymap
702 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
703 and use in active keymaps and menus.
704 Subkeymaps may be modified but are not canonicalized."
705 ;; FIXME: Problem with the difference between a nil binding
706 ;; that hides a binding in an inherited map and a nil binding that's ignored
707 ;; to let some further binding visible. Currently a nil binding hides all.
708 ;; FIXME: we may want to carefully (re)order elements in case they're
712 (prompt (keymap-prompt map
)))
714 (setq map
(map-keymap ;; -internal
717 ;; Treat char-ranges specially.
718 (push (cons key item
) ranges
)
719 (push (cons key item
) bindings
)))
721 ;; Create the new map.
722 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
723 (dolist (binding ranges
)
724 ;; Treat char-ranges specially. FIXME: need to merge as well.
725 (define-key map
(vector (car binding
)) (cdr binding
)))
726 ;; Process the bindings starting from the end.
727 (dolist (binding (prog1 bindings
(setq bindings
())))
728 (let* ((key (car binding
))
729 (oldbind (assq key bindings
)))
730 (push (if (not oldbind
)
731 ;; The normal case: no duplicate bindings.
733 ;; This is the second binding for this key.
734 (setq bindings
(delq oldbind bindings
))
735 (cons key
(keymap--merge-bindings (cdr binding
)
738 (nconc map bindings
)))
740 (put 'keyboard-translate-table
'char-table-extra-slots
0)
742 (defun keyboard-translate (from to
)
743 "Translate character FROM to TO on the current terminal.
744 This function creates a `keyboard-translate-table' if necessary
745 and then modifies one entry in it."
746 (or (char-table-p keyboard-translate-table
)
747 (setq keyboard-translate-table
748 (make-char-table 'keyboard-translate-table nil
)))
749 (aset keyboard-translate-table from to
))
751 ;;;; Key binding commands.
753 (defun global-set-key (key command
)
754 "Give KEY a global binding as COMMAND.
755 COMMAND is the command definition to use; usually it is
756 a symbol naming an interactively-callable function.
757 KEY is a key sequence; noninteractively, it is a string or vector
758 of characters or event types, and non-ASCII characters with codes
759 above 127 (such as ISO Latin-1) can be included if you use a vector.
761 Note that if KEY has a local binding in the current buffer,
762 that local binding will continue to shadow any global binding
763 that you make with this function."
764 (interactive "KSet key globally: \nCSet key %s to command: ")
765 (or (vectorp key
) (stringp key
)
766 (signal 'wrong-type-argument
(list 'arrayp key
)))
767 (define-key (current-global-map) key command
))
769 (defun local-set-key (key command
)
770 "Give KEY a local binding as COMMAND.
771 COMMAND is the command definition to use; usually it is
772 a symbol naming an interactively-callable function.
773 KEY is a key sequence; noninteractively, it is a string or vector
774 of characters or event types, and non-ASCII characters with codes
775 above 127 (such as ISO Latin-1) can be included if you use a vector.
777 The binding goes in the current buffer's local map, which in most
778 cases is shared with all other buffers in the same major mode."
779 (interactive "KSet key locally: \nCSet key %s locally to command: ")
780 (let ((map (current-local-map)))
782 (use-local-map (setq map
(make-sparse-keymap))))
783 (or (vectorp key
) (stringp key
)
784 (signal 'wrong-type-argument
(list 'arrayp key
)))
785 (define-key map key command
)))
787 (defun global-unset-key (key)
788 "Remove global binding of KEY.
789 KEY is a string or vector representing a sequence of keystrokes."
790 (interactive "kUnset key globally: ")
791 (global-set-key key nil
))
793 (defun local-unset-key (key)
794 "Remove local binding of KEY.
795 KEY is a string or vector representing a sequence of keystrokes."
796 (interactive "kUnset key locally: ")
797 (if (current-local-map)
798 (local-set-key key nil
))
801 ;;;; substitute-key-definition and its subroutines.
803 (defvar key-substitution-in-progress nil
804 "Used internally by `substitute-key-definition'.")
806 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
807 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
808 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
809 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
810 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
812 If you don't specify OLDMAP, you can usually get the same results
813 in a cleaner way with command remapping, like this:
814 (define-key KEYMAP [remap OLDDEF] NEWDEF)
815 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
816 ;; Don't document PREFIX in the doc string because we don't want to
817 ;; advertise it. It's meant for recursive calls only. Here's its
820 ;; If optional argument PREFIX is specified, it should be a key
821 ;; prefix, a string. Redefined bindings will then be bound to the
822 ;; original key, with PREFIX added at the front.
823 (or prefix
(setq prefix
""))
824 (let* ((scan (or oldmap keymap
))
825 (prefix1 (vconcat prefix
[nil]))
826 (key-substitution-in-progress
827 (cons scan key-substitution-in-progress)))
828 ;; Scan OLDMAP, finding each char or event-symbol that
829 ;; has any definition, and act on it with hack-key.
832 (aset prefix1 (length prefix) char)
833 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
836 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
837 (let (inner-def skipped menu-item)
838 ;; Find the actual command name within the binding.
839 (if (eq (car-safe defn) 'menu-item)
840 (setq menu-item defn defn (nth 2 defn))
841 ;; Skip past menu-prompt.
842 (while (stringp (car-safe defn))
843 (push (pop defn) skipped))
844 ;; Skip past cached key-equivalence data for menu items.
845 (if (consp (car-safe defn))
846 (setq defn (cdr defn))))
847 (if (or (eq defn olddef)
848 ;; Compare with equal if definition is a key sequence.
849 ;; That is useful for operating on function-key-map.
850 (and (or (stringp defn) (vectorp defn))
851 (equal defn olddef)))
852 (define-key keymap prefix
854 (let ((copy (copy-sequence menu-item)))
855 (setcar (nthcdr 2 copy) newdef)
857 (nconc (nreverse skipped) newdef)))
858 ;; Look past a symbol that names a keymap.
860 (or (indirect-function defn t) defn))
861 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
862 ;; avoid autoloading a keymap. This is mostly done to preserve the
863 ;; original non-autoloading behavior of pre-map-keymap times.
864 (if (and (keymapp inner-def)
865 ;; Avoid recursively scanning
866 ;; where KEYMAP does not have a submap.
867 (let ((elt (lookup-key keymap prefix)))
868 (or (null elt) (natnump elt) (keymapp elt)))
869 ;; Avoid recursively rescanning keymap being scanned.
870 (not (memq inner-def key-substitution-in-progress)))
871 ;; If this one isn't being scanned already, scan it now.
872 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
875 ;;;; The global keymap tree.
877 ;; global-map, esc-map, and ctl-x-map have their values set up in
878 ;; keymap.c; we just give them docstrings here.
880 (defvar global-map nil
881 "Default global keymap mapping Emacs keyboard input into commands.
882 The value is a keymap which is usually (but not necessarily) Emacs's
886 "Default keymap for ESC (meta) commands.
887 The normal global definition of the character ESC indirects to this keymap.")
889 (defvar ctl-x-map nil
890 "Default keymap for C-x commands.
891 The normal global definition of the character C-x indirects to this keymap.")
893 (defvar ctl-x-4-map (make-sparse-keymap)
894 "Keymap for subcommands of C-x 4.")
895 (defalias 'ctl-x-4-prefix ctl-x-4-map)
896 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
898 (defvar ctl-x-5-map (make-sparse-keymap)
899 "Keymap for frame commands.")
900 (defalias 'ctl-x-5-prefix ctl-x-5-map)
901 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
904 ;;;; Event manipulation functions.
906 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
908 (defun listify-key-sequence (key)
909 "Convert a key sequence to a list of events."
912 (mapcar (function (lambda (c)
914 (logxor c listify-key-sequence-1)
919 "True if the argument is an event object."
922 (and (symbolp obj) obj (not (keywordp obj)))
923 (and (consp obj) (symbolp (car obj))))))
925 (defun event-modifiers (event)
926 "Return a list of symbols representing the modifier keys in event EVENT.
927 The elements of the list may include `meta', `control',
928 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
930 EVENT may be an event or an event type. If EVENT is a symbol
931 that has never been used in an event that has been read as input
932 in the current Emacs session, then this function may fail to include
933 the `click' modifier."
936 (setq type (car type)))
938 ;; Don't read event-symbol-elements directly since we're not
939 ;; sure the symbol has already been parsed.
940 (cdr (internal-event-symbol-parse-modifiers type))
942 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
943 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
944 (if (not (zerop (logand type ?\M-\^@)))
946 (if (or (not (zerop (logand type ?\C-\^@)))
948 (push 'control list))
949 (if (or (not (zerop (logand type ?\S-\^@)))
950 (/= char (downcase char)))
952 (or (zerop (logand type ?\H-\^@))
954 (or (zerop (logand type ?\s-\^@))
956 (or (zerop (logand type ?\A-\^@))
960 (defun event-basic-type (event)
961 "Return the basic type of the given event (all modifiers removed).
962 The value is a printing character (not upper case) or a symbol.
963 EVENT may be an event or an event type. If EVENT is a symbol
964 that has never been used in an event that has been read as input
965 in the current Emacs session, then this function may return nil."
967 (setq event (car event)))
969 (car (get event 'event-symbol-elements))
970 (let* ((base (logand event (1- ?\A-\^@)))
971 (uncontrolled (if (< base 32) (logior base 64) base)))
972 ;; There are some numbers that are invalid characters and
973 ;; cause `downcase' to get an error.
975 (downcase uncontrolled)
976 (error uncontrolled)))))
978 (defsubst mouse-movement-p (object)
979 "Return non-nil if OBJECT is a mouse movement event."
980 (eq (car-safe object) 'mouse-movement))
982 (defun mouse-event-p (object)
983 "Return non-nil if OBJECT is a mouse click event."
984 ;; is this really correct? maybe remove mouse-movement?
985 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
987 (defun event-start (event)
988 "Return the starting position of EVENT.
989 EVENT should be a mouse click, drag, or key press event. If
990 EVENT is nil, the value of `posn-at-point' is used instead.
992 The following accessor functions are used to access the elements
995 `posn-window': The window the event is in.
996 `posn-area': A symbol identifying the area the event occurred in,
997 or nil if the event occurred in the text area.
998 `posn-point': The buffer position of the event.
999 `posn-x-y': The pixel-based coordinates of the event.
1000 `posn-col-row': The estimated column and row corresponding to the
1001 position of the event.
1002 `posn-actual-col-row': The actual column and row corresponding to the
1003 position of the event.
1004 `posn-string': The string object of the event, which is either
1005 nil or (STRING . POSITION)'.
1006 `posn-image': The image object of the event, if any.
1007 `posn-object': The image or string object of the event, if any.
1008 `posn-timestamp': The time the event occurred, in milliseconds.
1010 For more information, see Info node `(elisp)Click Events'."
1011 (if (consp event) (nth 1 event)
1013 (list (selected-window) (point) '(0 . 0) 0))))
1015 (defun event-end (event)
1016 "Return the ending position of EVENT.
1017 EVENT should be a click, drag, or key press event.
1019 See `event-start' for a description of the value returned."
1020 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1022 (list (selected-window) (point) '(0 . 0) 0))))
1024 (defsubst event-click-count (event)
1025 "Return the multi-click count of EVENT, a click or drag event.
1026 The return value is a positive integer."
1027 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1029 ;;;; Extracting fields of the positions in an event.
1032 "Return non-nil if OBJ appears to be a valid `posn' object."
1033 (and (windowp (car-safe obj))
1034 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1035 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1036 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1038 (defsubst posn-window (position)
1039 "Return the window in POSITION.
1040 POSITION should be a list of the form returned by the `event-start'
1041 and `event-end' functions."
1044 (defsubst posn-area (position)
1045 "Return the window area recorded in POSITION, or nil for the text area.
1046 POSITION should be a list of the form returned by the `event-start'
1047 and `event-end' functions."
1048 (let ((area (if (consp (nth 1 position))
1049 (car (nth 1 position))
1051 (and (symbolp area) area)))
1053 (defun posn-point (position)
1054 "Return the buffer location in POSITION.
1055 POSITION should be a list of the form returned by the `event-start'
1056 and `event-end' functions.
1057 Returns nil if POSITION does not correspond to any buffer location (e.g.
1058 a click on a scroll bar)."
1059 (or (nth 5 position)
1060 (let ((pt (nth 1 position)))
1062 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1063 (if (integerp pt) pt)))))
1065 (defun posn-set-point (position)
1066 "Move point to POSITION.
1067 Select the corresponding window as well."
1068 (if (not (windowp (posn-window position)))
1069 (error "Position not in text area of window"))
1070 (select-window (posn-window position))
1071 (if (numberp (posn-point position))
1072 (goto-char (posn-point position))))
1074 (defsubst posn-x-y (position)
1075 "Return the x and y coordinates in POSITION.
1076 The return value has the form (X . Y), where X and Y are given in
1077 pixels. POSITION should be a list of the form returned by
1078 `event-start' and `event-end'."
1081 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1083 (defmacro with-current-buffer (buffer-or-name &rest body)
1084 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
1085 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
1086 The value returned is the value of the last form in BODY. See
1087 also `with-temp-buffer'."
1088 (declare (indent 1) (debug t))
1089 `(save-current-buffer
1090 (set-buffer ,buffer-or-name)
1093 (defun posn-col-row (position)
1094 "Return the nominal column and row in POSITION, measured in characters.
1095 The column and row values are approximations calculated from the x
1096 and y coordinates in POSITION and the frame's default character width
1097 and default line height, including spacing.
1098 For a scroll-bar event, the result column is 0, and the row
1099 corresponds to the vertical position of the click in the scroll bar.
1100 POSITION should be a list of the form returned by the `event-start'
1101 and `event-end' functions."
1102 (let* ((pair (posn-x-y position))
1103 (window (posn-window position))
1104 (area (posn-area position)))
1108 ((eq area 'vertical-scroll-bar)
1109 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1110 ((eq area 'horizontal-scroll-bar)
1111 (cons (scroll-bar-scale pair (window-width window)) 0))
1113 (let* ((frame (if (framep window) window (window-frame window)))
1114 ;; FIXME: This should take line-spacing properties on
1115 ;; newlines into account.
1116 (spacing (when (display-graphic-p frame)
1117 (or (with-current-buffer (window-buffer window)
1119 (frame-parameter frame 'line-spacing)))))
1120 (cond ((floatp spacing)
1121 (setq spacing (truncate (* spacing
1122 (frame-char-height frame)))))
1125 (cons (/ (car pair) (frame-char-width frame))
1126 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1127 (if (null (with-current-buffer (window-buffer window)
1128 header-line-format))
1131 (defun posn-actual-col-row (position)
1132 "Return the actual column and row in POSITION, measured in characters.
1133 These are the actual row number in the window and character number in that row.
1134 Return nil if POSITION does not contain the actual position; in that case
1135 `posn-col-row' can be used to get approximate values.
1136 POSITION should be a list of the form returned by the `event-start'
1137 and `event-end' functions."
1140 (defsubst posn-timestamp (position)
1141 "Return the timestamp of POSITION.
1142 POSITION should be a list of the form returned by the `event-start'
1143 and `event-end' functions."
1146 (defun posn-string (position)
1147 "Return the string object of POSITION.
1148 Value is a cons (STRING . STRING-POS), or nil if not a string.
1149 POSITION should be a list of the form returned by the `event-start'
1150 and `event-end' functions."
1151 (let ((x (nth 4 position)))
1152 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1153 (when (consp x) x)))
1155 (defsubst posn-image (position)
1156 "Return the image object of POSITION.
1157 Value is a list (image ...), or nil if not an image.
1158 POSITION should be a list of the form returned by the `event-start'
1159 and `event-end' functions."
1162 (defsubst posn-object (position)
1163 "Return the object (image or string) of POSITION.
1164 Value is a list (image ...) for an image object, a cons cell
1165 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1166 POSITION should be a list of the form returned by the `event-start'
1167 and `event-end' functions."
1168 (or (posn-image position) (posn-string position)))
1170 (defsubst posn-object-x-y (position)
1171 "Return the x and y coordinates relative to the object of POSITION.
1172 The return value has the form (DX . DY), where DX and DY are
1173 given in pixels. POSITION should be a list of the form returned
1174 by `event-start' and `event-end'."
1177 (defsubst posn-object-width-height (position)
1178 "Return the pixel width and height of the object of POSITION.
1179 The return value has the form (WIDTH . HEIGHT). POSITION should
1180 be a list of the form returned by `event-start' and `event-end'."
1184 ;;;; Obsolescent names for functions.
1186 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1187 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1188 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1189 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1190 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1191 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1193 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1194 (make-obsolete 'buffer-has-markers-at nil "24.3")
1196 (defun insert-string (&rest args)
1197 "Mocklisp-compatibility insert function.
1198 Like the function `insert' except that any argument that is a number
1199 is converted into a string by expressing it in decimal."
1200 (declare (obsolete insert "22.1"))
1202 (insert (if (integerp el) (number-to-string el) el))))
1204 (defun makehash (&optional test)
1205 (declare (obsolete make-hash-table "22.1"))
1206 (make-hash-table :test (or test 'eql)))
1209 "Return (log X 10), the log base 10 of X."
1210 (declare (obsolete log "24.4"))
1213 ;; These are used by VM and some old programs
1214 (defalias 'focus-frame 'ignore "")
1215 (make-obsolete 'focus-frame "it does nothing." "22.1")
1216 (defalias 'unfocus-frame 'ignore "")
1217 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1218 (make-obsolete 'make-variable-frame-local
1219 "explicitly check for a frame-parameter instead." "22.2")
1220 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1221 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1222 (set-advertised-calling-convention 'decode-char '(ch charset) "21.4")
1223 (set-advertised-calling-convention 'encode-char '(ch charset) "21.4")
1225 ;;;; Obsolescence declarations for variables, and aliases.
1227 ;; Special "default-FOO" variables which contain the default value of
1228 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1229 ;; slows down several unrelated variable operations; furthermore, they
1230 ;; can lead to really odd behavior if you decide to make them
1233 ;; Not used at all in Emacs, last time I checked:
1234 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1235 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1236 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1237 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1238 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1239 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1240 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1241 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1242 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1243 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1244 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1245 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1246 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1247 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1248 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1249 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1250 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1251 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1252 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1253 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1254 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1255 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1256 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1257 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1258 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1259 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1260 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1261 (make-obsolete-variable 'default-enable-multibyte-characters
1262 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1264 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1265 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1266 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1267 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1268 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1269 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1271 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1272 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1274 ;; Lisp manual only updated in 22.1.
1275 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1278 (define-obsolete-variable-alias 'x-lost-selection-hooks
1279 'x-lost-selection-functions "22.1")
1280 (define-obsolete-variable-alias 'x-sent-selection-hooks
1281 'x-sent-selection-functions "22.1")
1283 ;; This was introduced in 21.4 for pre-unicode unification. That
1284 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1285 ;; Other uses are possible, so this variable is not _really_ obsolete,
1286 ;; but Stefan insists to mark it so.
1287 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1289 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1291 ;;;; Alternate names for functions - these are not being phased out.
1293 (defalias 'send-string 'process-send-string)
1294 (defalias 'send-region 'process-send-region)
1295 (defalias 'string= 'string-equal)
1296 (defalias 'string< 'string-lessp)
1297 (defalias 'move-marker 'set-marker)
1298 (defalias 'rplaca 'setcar)
1299 (defalias 'rplacd 'setcdr)
1300 (defalias 'beep 'ding) ;preserve lingual purity
1301 (defalias 'indent-to-column 'indent-to)
1302 (defalias 'backward-delete-char 'delete-backward-char)
1303 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1304 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1305 (defalias 'int-to-string 'number-to-string)
1306 (defalias 'store-match-data 'set-match-data)
1307 (defalias 'chmod 'set-file-modes)
1308 (defalias 'mkdir 'make-directory)
1309 ;; These are the XEmacs names:
1310 (defalias 'point-at-eol 'line-end-position)
1311 (defalias 'point-at-bol 'line-beginning-position)
1313 (defalias 'user-original-login-name 'user-login-name)
1316 ;;;; Hook manipulation functions.
1318 (defun add-hook (hook function &optional append local)
1319 "Add to the value of HOOK the function FUNCTION.
1320 FUNCTION is not added if already present.
1321 FUNCTION is added (if necessary) at the beginning of the hook list
1322 unless the optional argument APPEND is non-nil, in which case
1323 FUNCTION is added at the end.
1325 The optional fourth argument, LOCAL, if non-nil, says to modify
1326 the hook's buffer-local value rather than its global value.
1327 This makes the hook buffer-local, and it makes t a member of the
1328 buffer-local value. That acts as a flag to run the hook
1329 functions of the global value as well as in the local value.
1331 HOOK should be a symbol, and FUNCTION may be any valid function. If
1332 HOOK is void, it is first set to nil. If HOOK's value is a single
1333 function, it is changed to a list of functions."
1334 (or (boundp hook) (set hook nil))
1335 (or (default-boundp hook) (set-default hook nil))
1336 (if local (unless (local-variable-if-set-p hook)
1337 (set (make-local-variable hook) (list t)))
1338 ;; Detect the case where make-local-variable was used on a hook
1339 ;; and do what we used to do.
1340 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1342 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1343 ;; If the hook value is a single function, turn it into a list.
1344 (when (or (not (listp hook-value)) (functionp hook-value))
1345 (setq hook-value (list hook-value)))
1346 ;; Do the actual addition if necessary
1347 (unless (member function hook-value)
1348 (when (stringp function)
1349 (setq function (purecopy function)))
1352 (append hook-value (list function))
1353 (cons function hook-value))))
1354 ;; Set the actual variable
1357 ;; If HOOK isn't a permanent local,
1358 ;; but FUNCTION wants to survive a change of modes,
1359 ;; mark HOOK as partially permanent.
1360 (and (symbolp function)
1361 (get function 'permanent-local-hook)
1362 (not (get hook 'permanent-local))
1363 (put hook 'permanent-local 'permanent-local-hook))
1364 (set hook hook-value))
1365 (set-default hook hook-value))))
1367 (defun remove-hook (hook function &optional local)
1368 "Remove from the value of HOOK the function FUNCTION.
1369 HOOK should be a symbol, and FUNCTION may be any valid function. If
1370 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1371 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1373 The optional third argument, LOCAL, if non-nil, says to modify
1374 the hook's buffer-local value rather than its default value."
1375 (or (boundp hook) (set hook nil))
1376 (or (default-boundp hook) (set-default hook nil))
1377 ;; Do nothing if LOCAL is t but this hook has no local binding.
1378 (unless (and local (not (local-variable-p hook)))
1379 ;; Detect the case where make-local-variable was used on a hook
1380 ;; and do what we used to do.
1381 (when (and (local-variable-p hook)
1382 (not (and (consp (symbol-value hook))
1383 (memq t (symbol-value hook)))))
1385 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1386 ;; Remove the function, for both the list and the non-list cases.
1387 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1388 (if (equal hook-value function) (setq hook-value nil))
1389 (setq hook-value (delete function (copy-sequence hook-value))))
1390 ;; If the function is on the global hook, we need to shadow it locally
1391 ;;(when (and local (member function (default-value hook))
1392 ;; (not (member (cons 'not function) hook-value)))
1393 ;; (push (cons 'not function) hook-value))
1394 ;; Set the actual variable
1396 (set-default hook hook-value)
1397 (if (equal hook-value '(t))
1398 (kill-local-variable hook)
1399 (set hook hook-value))))))
1401 (defmacro letrec (binders &rest body)
1402 "Bind variables according to BINDERS then eval BODY.
1403 The value of the last form in BODY is returned.
1404 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1405 SYMBOL to the value of VALUEFORM.
1406 All symbols are bound before the VALUEFORMs are evalled."
1407 ;; Only useful in lexical-binding mode.
1408 ;; As a special-form, we could implement it more efficiently (and cleanly,
1409 ;; making the vars actually unbound during evaluation of the binders).
1410 (declare (debug let) (indent 1))
1411 `(let ,(mapcar #'car binders)
1412 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1415 (defmacro with-wrapper-hook (hook args &rest body)
1416 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1417 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1418 around the preceding ones, like a set of nested `around' advices.
1420 Each hook function should accept an argument list consisting of a
1421 function FUN, followed by the additional arguments in ARGS.
1423 The first hook function in HOOK is passed a FUN that, if it is called
1424 with arguments ARGS, performs BODY (i.e., the default operation).
1425 The FUN passed to each successive hook function is defined based
1426 on the preceding hook functions; if called with arguments ARGS,
1427 it does what the `with-wrapper-hook' call would do if the
1428 preceding hook functions were the only ones present in HOOK.
1430 Each hook function may call its FUN argument as many times as it wishes,
1431 including never. In that case, such a hook function acts to replace
1432 the default definition altogether, and any preceding hook functions.
1433 Of course, a subsequent hook function may do the same thing.
1435 Each hook function definition is used to construct the FUN passed
1436 to the next hook function, if any. The last (or \"outermost\")
1437 FUN is then called once."
1438 (declare (indent 2) (debug (form sexp body))
1439 (obsolete "use a <foo>-function variable modified by `add-function'."
1441 ;; We need those two gensyms because CL's lexical scoping is not available
1442 ;; for function arguments :-(
1443 (let ((funs (make-symbol "funs"))
1444 (global (make-symbol "global"))
1445 (argssym (make-symbol "args"))
1446 (runrestofhook (make-symbol "runrestofhook")))
1447 ;; Since the hook is a wrapper, the loop has to be done via
1448 ;; recursion: a given hook function will call its parameter in order to
1449 ;; continue looping.
1450 `(letrec ((,runrestofhook
1451 (lambda (,funs ,global ,argssym)
1452 ;; `funs' holds the functions left on the hook and `global'
1453 ;; holds the functions left on the global part of the hook
1454 ;; (in case the hook is local).
1456 (if (eq t (car ,funs))
1457 (funcall ,runrestofhook
1458 (append ,global (cdr ,funs)) nil ,argssym)
1461 (lambda (,funs ,global &rest ,argssym)
1462 (funcall ,runrestofhook ,funs ,global ,argssym))
1463 (cdr ,funs) ,global)
1465 ;; Once there are no more functions on the hook, run
1466 ;; the original body.
1467 (apply (lambda ,args ,@body) ,argssym)))))
1468 (funcall ,runrestofhook ,hook
1469 ;; The global part of the hook, if any.
1471 `(if (local-variable-p ',hook)
1472 (default-value ',hook)))
1475 (defun add-to-list (list-var element &optional append compare-fn)
1476 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1477 The test for presence of ELEMENT is done with `equal', or with
1478 COMPARE-FN if that's non-nil.
1479 If ELEMENT is added, it is added at the beginning of the list,
1480 unless the optional argument APPEND is non-nil, in which case
1481 ELEMENT is added at the end.
1483 The return value is the new value of LIST-VAR.
1485 This is handy to add some elements to configuration variables,
1486 but please do not abuse it in Elisp code, where you are usually
1487 better off using `push' or `cl-pushnew'.
1489 If you want to use `add-to-list' on a variable that is not
1490 defined until a certain package is loaded, you should put the
1491 call to `add-to-list' into a hook function that will be run only
1492 after loading the package. `eval-after-load' provides one way to
1493 do this. In some cases other hooks, such as major mode hooks,
1498 ;; FIXME: Something like this could be used for `set' as well.
1499 (if (or (not (eq 'quote (car-safe list-var)))
1500 (special-variable-p (cadr list-var))
1501 (not (macroexp-const-p append)))
1503 (let* ((sym (cadr list-var))
1504 (append (eval append))
1505 (msg (format "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1507 ;; Big ugly hack so we only output a warning during
1508 ;; byte-compilation, and so we can use
1509 ;; byte-compile-not-lexical-var-p to silence the warning
1510 ;; when a defvar has been seen but not yet executed.
1512 ;; FIXME: We should also emit a warning for let-bound
1513 ;; variables with dynamic binding.
1514 (when (assq sym byte-compile--lexical-environment)
1515 (byte-compile-log-warning msg t :error))))
1517 (macroexp-let2 macroexp-copyable-p x element
1518 `(if ,(if compare-fn
1521 `(cl-member ,x ,sym :test ,compare-fn))
1522 ;; For bootstrapping reasons, don't rely on
1523 ;; cl--compiler-macro-member for the base case.
1527 `(setq ,sym (append ,sym (list ,x)))
1528 `(push ,x ,sym))))))
1529 (if (not (macroexp--compiling-p))
1532 (macroexp--funcall-if-compiled ',warnfun)
1536 (member element (symbol-value list-var)))
1537 ((eq compare-fn 'eq)
1538 (memq element (symbol-value list-var)))
1539 ((eq compare-fn 'eql)
1540 (memql element (symbol-value list-var)))
1542 (let ((lst (symbol-value list-var)))
1544 (not (funcall compare-fn element (car lst))))
1545 (setq lst (cdr lst)))
1547 (symbol-value list-var)
1550 (append (symbol-value list-var) (list element))
1551 (cons element (symbol-value list-var))))))
1554 (defun add-to-ordered-list (list-var element &optional order)
1555 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1556 The test for presence of ELEMENT is done with `eq'.
1558 The resulting list is reordered so that the elements are in the
1559 order given by each element's numeric list order. Elements
1560 without a numeric list order are placed at the end of the list.
1562 If the third optional argument ORDER is a number (integer or
1563 float), set the element's list order to the given value. If
1564 ORDER is nil or omitted, do not change the numeric order of
1565 ELEMENT. If ORDER has any other value, remove the numeric order
1566 of ELEMENT if it has one.
1568 The list order for each element is stored in LIST-VAR's
1569 `list-order' property.
1571 The return value is the new value of LIST-VAR."
1572 (let ((ordering (get list-var 'list-order)))
1574 (put list-var 'list-order
1575 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1577 (puthash element (and (numberp order) order) ordering))
1578 (unless (memq element (symbol-value list-var))
1579 (set list-var (cons element (symbol-value list-var))))
1580 (set list-var (sort (symbol-value list-var)
1582 (let ((oa (gethash a ordering))
1583 (ob (gethash b ordering)))
1588 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1589 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1590 Return the new history list.
1591 If MAXELT is non-nil, it specifies the maximum length of the history.
1592 Otherwise, the maximum history length is the value of the `history-length'
1593 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1595 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1596 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1597 if it is empty or a duplicate."
1599 (setq maxelt (or (get history-var 'history-length)
1601 (let ((history (symbol-value history-var))
1603 (when (and (listp history)
1605 (not (stringp newelt))
1606 (> (length newelt) 0))
1608 (not (equal (car history) newelt))))
1609 (if history-delete-duplicates
1610 (setq history (delete newelt history)))
1611 (setq history (cons newelt history))
1612 (when (integerp maxelt)
1615 (setq tail (nthcdr (1- maxelt) history))
1617 (setcdr tail nil)))))
1618 (set history-var history)))
1623 (defvar delay-mode-hooks nil
1624 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1625 (defvar delayed-mode-hooks nil
1626 "List of delayed mode hooks waiting to be run.")
1627 (make-variable-buffer-local 'delayed-mode-hooks)
1628 (put 'delay-mode-hooks 'permanent-local t)
1630 (defvar change-major-mode-after-body-hook nil
1631 "Normal hook run in major mode functions, before the mode hooks.")
1633 (defvar after-change-major-mode-hook nil
1634 "Normal hook run at the very end of major mode functions.")
1636 (defun run-mode-hooks (&rest hooks)
1637 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1638 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1639 just adds the HOOKS to the list `delayed-mode-hooks'.
1640 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1641 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1642 `after-change-major-mode-hook'. Major mode functions should use
1643 this instead of `run-hooks' when running their FOO-mode-hook."
1644 (if delay-mode-hooks
1646 (dolist (hook hooks)
1647 (push hook delayed-mode-hooks))
1648 ;; Normal case, just run the hook as before plus any delayed hooks.
1649 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1650 (setq delayed-mode-hooks nil)
1651 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1652 (run-hooks 'after-change-major-mode-hook)))
1654 (defmacro delay-mode-hooks (&rest body)
1655 "Execute BODY, but delay any `run-mode-hooks'.
1656 These hooks will be executed by the first following call to
1657 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1658 Only affects hooks run in the current buffer."
1659 (declare (debug t) (indent 0))
1661 (make-local-variable 'delay-mode-hooks)
1662 (let ((delay-mode-hooks t))
1665 ;; PUBLIC: find if the current mode derives from another.
1667 (defun derived-mode-p (&rest modes)
1668 "Non-nil if the current major mode is derived from one of MODES.
1669 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1670 (let ((parent major-mode))
1671 (while (and (not (memq parent modes))
1672 (setq parent (get parent 'derived-mode-parent))))
1677 ;; If a minor mode is not defined with define-minor-mode,
1678 ;; add it here explicitly.
1679 ;; isearch-mode is deliberately excluded, since you should
1680 ;; not call it yourself.
1681 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1682 overwrite-mode view-mode
1684 "List of all minor mode functions.")
1686 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1687 "Register a new minor mode.
1689 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1691 TOGGLE is a symbol which is the name of a buffer-local variable that
1692 is toggled on or off to say whether the minor mode is active or not.
1694 NAME specifies what will appear in the mode line when the minor mode
1695 is active. NAME should be either a string starting with a space, or a
1696 symbol whose value is such a string.
1698 Optional KEYMAP is the keymap for the minor mode that will be added
1699 to `minor-mode-map-alist'.
1701 Optional AFTER specifies that TOGGLE should be added after AFTER
1702 in `minor-mode-alist'.
1704 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1705 It defaults to (and should by convention be) TOGGLE.
1707 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1708 included in the mode-line minor mode menu.
1709 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1710 (unless (memq toggle minor-mode-list)
1711 (push toggle minor-mode-list))
1713 (unless toggle-fun (setq toggle-fun toggle))
1714 (unless (eq toggle-fun toggle)
1715 (put toggle :minor-mode-function toggle-fun))
1716 ;; Add the name to the minor-mode-alist.
1718 (let ((existing (assq toggle minor-mode-alist)))
1720 (setcdr existing (list name))
1721 (let ((tail minor-mode-alist) found)
1722 (while (and tail (not found))
1723 (if (eq after (caar tail))
1725 (setq tail (cdr tail))))
1727 (let ((rest (cdr found)))
1729 (nconc found (list (list toggle name)) rest))
1730 (push (list toggle name) minor-mode-alist))))))
1731 ;; Add the toggle to the minor-modes menu if requested.
1732 (when (get toggle :included)
1733 (define-key mode-line-mode-menu
1737 (or (get toggle :menu-tag)
1738 (if (stringp name) name (symbol-name toggle)))
1739 (let ((mode-name (if (symbolp name) (symbol-value name))))
1740 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1741 (concat " (" (match-string 0 mode-name) ")"))))
1743 :button (cons :toggle toggle))))
1745 ;; Add the map to the minor-mode-map-alist.
1747 (let ((existing (assq toggle minor-mode-map-alist)))
1749 (setcdr existing keymap)
1750 (let ((tail minor-mode-map-alist) found)
1751 (while (and tail (not found))
1752 (if (eq after (caar tail))
1754 (setq tail (cdr tail))))
1756 (let ((rest (cdr found)))
1758 (nconc found (list (cons toggle keymap)) rest))
1759 (push (cons toggle keymap) minor-mode-map-alist)))))))
1763 (defsubst autoloadp (object)
1764 "Non-nil if OBJECT is an autoload."
1765 (eq 'autoload (car-safe object)))
1767 ;; (defun autoload-type (object)
1768 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1769 ;; OBJECT should be an autoload object."
1770 ;; (when (autoloadp object)
1771 ;; (let ((type (nth 3 object)))
1772 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1773 ;; ((eq 'keymap t) 'macro)
1776 ;; (defalias 'autoload-file #'cadr
1777 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1778 ;; \n\(fn AUTOLOAD)")
1780 (defun symbol-file (symbol &optional type)
1781 "Return the name of the file that defined SYMBOL.
1782 The value is normally an absolute file name. It can also be nil,
1783 if the definition is not associated with any file. If SYMBOL
1784 specifies an autoloaded function, the value can be a relative
1785 file name without extension.
1787 If TYPE is nil, then any kind of definition is acceptable. If
1788 TYPE is `defun', `defvar', or `defface', that specifies function
1789 definition, variable definition, or face definition only."
1790 (if (and (or (null type) (eq type 'defun))
1792 (autoloadp (symbol-function symbol)))
1793 (nth 1 (symbol-function symbol))
1794 (let ((files load-history)
1798 (if (eq type 'defvar)
1799 ;; Variables are present just as their names.
1800 (member symbol (cdr (car files)))
1801 ;; Other types are represented as (TYPE . NAME).
1802 (member (cons type symbol) (cdr (car files))))
1803 ;; We accept all types, so look for variable def
1804 ;; and then for any other kind.
1805 (or (member symbol (cdr (car files)))
1806 (rassq symbol (cdr (car files)))))
1807 (setq file (car (car files)) files nil))
1808 (setq files (cdr files)))
1811 (defun locate-library (library &optional nosuffix path interactive-call)
1812 "Show the precise file name of Emacs library LIBRARY.
1813 LIBRARY should be a relative file name of the library, a string.
1814 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1815 nil (which is the default, see below).
1816 This command searches the directories in `load-path' like `\\[load-library]'
1817 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1818 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1819 to the specified name LIBRARY.
1821 If the optional third arg PATH is specified, that list of directories
1822 is used instead of `load-path'.
1824 When called from a program, the file name is normally returned as a
1825 string. When run interactively, the argument INTERACTIVE-CALL is t,
1826 and the file name is displayed in the echo area."
1827 (interactive (list (completing-read "Locate library: "
1829 'locate-file-completion-table
1830 load-path (get-load-suffixes)))
1833 (let ((file (locate-file library
1835 (append (unless nosuffix (get-load-suffixes))
1836 load-file-rep-suffixes))))
1837 (if interactive-call
1839 (message "Library is file %s" (abbreviate-file-name file))
1840 (message "No library %s in search path" library)))
1844 (defmacro with-temp-buffer (&rest body)
1845 "Create a temporary buffer, and evaluate BODY there like `progn'.
1846 See also `with-temp-file' and `with-output-to-string'."
1847 (declare (indent 0) (debug t))
1848 (let ((temp-buffer (make-symbol "temp-buffer")))
1849 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
1850 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
1851 (with-current-buffer ,temp-buffer
1854 (and (buffer-name ,temp-buffer)
1855 (kill-buffer ,temp-buffer)))))))
1859 (defun process-lines (program &rest args)
1860 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1861 Signal an error if the program returns with a non-zero exit status."
1863 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1864 (unless (eq status 0)
1865 (error "%s exited with status %s" program status))
1866 (goto-char (point-min))
1869 (setq lines (cons (buffer-substring-no-properties
1870 (line-beginning-position)
1871 (line-end-position))
1874 (nreverse lines)))))
1876 (defun process-live-p (process)
1877 "Returns non-nil if PROCESS is alive.
1878 A process is considered alive if its status is `run', `open',
1879 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
1881 (and (processp process)
1882 (memq (process-status process)
1883 '(run open listen connect stop))))
1888 'process-kill-without-query
1889 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1891 (defun process-kill-without-query (process &optional _flag)
1892 "Say no query needed if PROCESS is running when Emacs is exited.
1893 Optional second argument if non-nil says to require a query.
1894 Value is t if a query was formerly required."
1895 (let ((old (process-query-on-exit-flag process)))
1896 (set-process-query-on-exit-flag process nil)
1899 (defun process-kill-buffer-query-function ()
1900 "Ask before killing a buffer that has a running process."
1901 (let ((process (get-buffer-process (current-buffer))))
1903 (not (memq (process-status process) '(run stop open listen)))
1904 (not (process-query-on-exit-flag process))
1906 (format "Buffer %S has a running process; kill it? "
1907 (buffer-name (current-buffer)))))))
1909 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1911 ;; process plist management
1913 (defun process-get (process propname)
1914 "Return the value of PROCESS' PROPNAME property.
1915 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1916 (plist-get (process-plist process) propname))
1918 (defun process-put (process propname value)
1919 "Change PROCESS' PROPNAME property to VALUE.
1920 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1921 (set-process-plist process
1922 (plist-put (process-plist process) propname value)))
1925 ;;;; Input and display facilities.
1927 (defconst read-key-empty-map (make-sparse-keymap))
1929 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
1931 (defun read-key (&optional prompt)
1932 "Read a key from the keyboard.
1933 Contrary to `read-event' this will not return a raw event but instead will
1934 obey the input decoding and translations usually done by `read-key-sequence'.
1935 So escape sequences and keyboard encoding are taken into account.
1936 When there's an ambiguity because the key looks like the prefix of
1937 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1938 ;; This overriding-terminal-local-map binding also happens to
1939 ;; disable quail's input methods, so although read-key-sequence
1940 ;; always inherits the input method, in practice read-key does not
1941 ;; inherit the input method (at least not if it's based on quail).
1942 (let ((overriding-terminal-local-map nil)
1943 (overriding-local-map read-key-empty-map)
1945 (old-global-map (current-global-map))
1946 (timer (run-with-idle-timer
1947 ;; Wait long enough that Emacs has the time to receive and
1948 ;; process all the raw events associated with the single-key.
1949 ;; But don't wait too long, or the user may find the delay
1950 ;; annoying (or keep hitting more keys which may then get
1951 ;; lost or misinterpreted).
1952 ;; This is only relevant for keys which Emacs perceives as
1953 ;; "prefixes", such as C-x (because of the C-x 8 map in
1954 ;; key-translate-table and the C-x @ map in function-key-map)
1955 ;; or ESC (because of terminal escape sequences in
1956 ;; input-decode-map).
1959 (let ((keys (this-command-keys-vector)))
1960 (unless (zerop (length keys))
1961 ;; `keys' is non-empty, so the user has hit at least
1962 ;; one key; there's no point waiting any longer, even
1963 ;; though read-key-sequence thinks we should wait
1964 ;; for more input to decide how to interpret the
1966 (throw 'read-key keys)))))))
1970 (let ((map (make-sparse-keymap)))
1971 ;; Don't hide the menu-bar and tool-bar entries.
1972 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
1973 (define-key map [tool-bar]
1974 ;; This hack avoids evaluating the :filter (Bug#9922).
1975 (or (cdr (assq 'tool-bar global-map))
1976 (lookup-key global-map [tool-bar])))
1978 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
1979 (cancel-timer timer)
1980 (use-global-map old-global-map))))
1982 (defmacro minibuffer-with-setup-hook (fun &rest body)
1983 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1984 BODY should use the minibuffer at most once.
1985 Recursive uses of the minibuffer are unaffected (FUN is not
1986 called additional times).
1988 This macro actually adds an auxiliary function that calls FUN,
1989 rather than FUN itself, to `minibuffer-setup-hook'."
1990 (declare (indent 1) (debug t))
1991 (let ((hook (make-symbol "setup-hook"))
1992 (funsym (make-symbol "fun")))
1993 `(let ((,funsym ,fun)
1997 ;; Clear out this hook so it does not interfere
1998 ;; with any recursive minibuffer usage.
1999 (remove-hook 'minibuffer-setup-hook ,hook)
2003 (add-hook 'minibuffer-setup-hook ,hook)
2005 (remove-hook 'minibuffer-setup-hook ,hook)))))
2007 (defmacro save-window-excursion (&rest body)
2008 "Execute BODY, then restore previous window configuration.
2009 This macro saves the window configuration on the selected frame,
2010 executes BODY, then calls `set-window-configuration' to restore
2011 the saved window configuration. The return value is the last
2012 form in BODY. The window configuration is also restored if BODY
2015 BEWARE: Most uses of this macro introduce bugs.
2016 E.g. it should not be used to try and prevent some code from opening
2017 a new window, since that window may sometimes appear in another frame,
2018 in which case `save-window-excursion' cannot help."
2019 (declare (indent 0) (debug t))
2020 (let ((c (make-symbol "wconfig")))
2021 `(let ((,c (current-window-configuration)))
2022 (unwind-protect (progn ,@body)
2023 (set-window-configuration ,c)))))
2025 (defvar read-passwd-map
2026 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2027 ;; minibuffer-local-map along the way!
2028 (let ((map (make-sparse-keymap)))
2029 (set-keymap-parent map minibuffer-local-map)
2030 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2032 "Keymap used while reading passwords.")
2034 (defun read-passwd (prompt &optional confirm default)
2035 "Read a password, prompting with PROMPT, and return it.
2036 If optional CONFIRM is non-nil, read the password twice to make sure.
2037 Optional DEFAULT is a default password to use instead of empty input.
2039 This function echoes `.' for each character that the user types.
2040 Note that in batch mode, the input is not hidden!
2042 Once the caller uses the password, it can erase the password
2043 by doing (clear-string STRING)."
2046 (while (not success)
2047 (let ((first (read-passwd prompt nil default))
2048 (second (read-passwd "Confirm password: " nil default)))
2049 (if (equal first second)
2051 (and (arrayp second) (clear-string second))
2052 (setq success first))
2053 (and (arrayp first) (clear-string first))
2054 (and (arrayp second) (clear-string second))
2055 (message "Password not repeated accurately; please start over")
2058 (let ((hide-chars-fun
2059 (lambda (beg end _len)
2060 (clear-this-command-keys)
2061 (setq beg (min end (max (minibuffer-prompt-end)
2063 (dotimes (i (- end beg))
2064 (put-text-property (+ i beg) (+ 1 i beg)
2065 'display (string ?.)))))
2067 (minibuffer-with-setup-hook
2069 (setq minibuf (current-buffer))
2070 ;; Turn off electricity.
2071 (setq-local post-self-insert-hook nil)
2072 (setq-local buffer-undo-list t)
2073 (setq-local select-active-regions nil)
2074 (use-local-map read-passwd-map)
2075 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2076 (setq-local show-paren-mode nil) ;bug#16091.
2077 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2079 (let ((enable-recursive-minibuffers t))
2082 (format "%s[INPUT WILL NOT BE HIDDEN!] " prompt) ; bug#17839
2084 nil t default)) ; t = "no history"
2085 (when (buffer-live-p minibuf)
2086 (with-current-buffer minibuf
2087 ;; Not sure why but it seems that there might be cases where the
2088 ;; minibuffer is not always properly reset later on, so undo
2089 ;; whatever we've done here (bug#11392).
2090 (remove-hook 'after-change-functions hide-chars-fun 'local)
2091 (kill-local-variable 'post-self-insert-hook)
2092 ;; And of course, don't keep the sensitive data around.
2093 (erase-buffer))))))))
2095 (defun read-number (prompt &optional default)
2096 "Read a numeric value in the minibuffer, prompting with PROMPT.
2097 DEFAULT specifies a default value to return if the user just types RET.
2098 The value of DEFAULT is inserted into PROMPT.
2099 This function is used by the `interactive' code letter `n'."
2101 (default1 (if (consp default) (car default) default)))
2104 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2105 (replace-match (format " (default %s)" default1) t t prompt 1)
2106 (replace-regexp-in-string "[ \t]*\\'"
2107 (format " (default %s) " default1)
2111 (let ((str (read-from-minibuffer
2112 prompt nil nil nil nil
2115 (mapcar 'number-to-string (delq nil default))
2116 (number-to-string default))))))
2119 ((zerop (length str)) default1)
2120 ((stringp str) (read str))))
2123 (message "Please enter a number.")
2128 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2129 "Read and return one of CHARS, prompting for PROMPT.
2130 Any input that is not one of CHARS is ignored.
2132 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2133 keyboard-quit events while waiting for a valid input."
2134 (unless (consp chars)
2135 (error "Called `read-char-choice' without valid char choices"))
2136 (let (char done show-help (helpbuf " *Char Help*"))
2137 (let ((cursor-in-echo-area t)
2138 (executing-kbd-macro executing-kbd-macro)
2140 (save-window-excursion ; in case we call help-form-show
2142 (unless (get-text-property 0 'face prompt)
2143 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2144 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2146 (and show-help (buffer-live-p (get-buffer helpbuf))
2147 (kill-buffer helpbuf))
2149 ((not (numberp char)))
2150 ;; If caller has set help-form, that's enough.
2151 ;; They don't explicitly have to add help-char to chars.
2158 ((and executing-kbd-macro (= char -1))
2159 ;; read-event returns -1 if we are in a kbd macro and
2160 ;; there are no more events in the macro. Attempt to
2161 ;; get an event interactively.
2162 (setq executing-kbd-macro nil))
2163 ((not inhibit-keyboard-quit)
2165 ((and (null esc-flag) (eq char ?\e))
2167 ((memq char '(?\C-g ?\e))
2168 (keyboard-quit))))))))
2169 ;; Display the question with the answer. But without cursor-in-echo-area.
2170 (message "%s%s" prompt (char-to-string char))
2173 (defun sit-for (seconds &optional nodisp obsolete)
2174 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2175 SECONDS may be a floating-point value.
2176 \(On operating systems that do not support waiting for fractions of a
2177 second, floating-point values are rounded down to the nearest integer.)
2179 If optional arg NODISP is t, don't redisplay, just wait for input.
2180 Redisplay does not happen if input is available before it starts.
2182 Value is t if waited the full time with no input arriving, and nil otherwise.
2184 An obsolete, but still supported form is
2185 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2186 where the optional arg MILLISECONDS specifies an additional wait period,
2187 in milliseconds; this was useful when Emacs was built without
2188 floating point support."
2189 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2190 ;; This used to be implemented in C until the following discussion:
2191 ;; http://lists.gnu.org/archive/html/emacs-devel/2006-07/msg00401.html
2192 ;; Then it was moved to C using an implementation based on an idle timer,
2193 ;; which was then replaced by the use of read-event.
2194 (if (numberp nodisp)
2195 (setq seconds (+ seconds (* 1e-3 nodisp))
2197 (if obsolete (setq nodisp obsolete)))
2202 ((input-pending-p t)
2205 (or nodisp (redisplay)))
2207 (or nodisp (redisplay))
2208 ;; FIXME: we should not read-event here at all, because it's much too
2209 ;; difficult to reliably "undo" a read-event by pushing it onto
2210 ;; unread-command-events.
2211 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2212 ;; decoding (hence non-nil as second arg under POSIX ttys).
2213 ;; For bug#15614, we need read-event not to inherit-input-method.
2214 ;; So we temporarily suspend input-method-function.
2215 (let ((read (let ((input-method-function nil))
2216 (read-event nil t seconds))))
2219 ;; https://lists.gnu.org/archive/html/emacs-devel/2006-10/msg00394.html
2220 ;; We want `read' appear in the next command's this-command-event
2221 ;; but not in the current one.
2222 ;; By pushing (cons t read), we indicate that `read' has not
2223 ;; yet been recorded in this-command-keys, so it will be recorded
2224 ;; next time it's read.
2225 ;; And indeed the `seconds' argument to read-event correctly
2226 ;; prevented recording this event in the current command's
2227 ;; this-command-keys.
2228 (push (cons t read) unread-command-events)
2231 ;; Behind display-popup-menus-p test.
2232 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2234 (defun y-or-n-p (prompt)
2235 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2236 PROMPT is the string to display to ask the question. It should
2237 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2239 No confirmation of the answer is requested; a single character is
2240 enough. SPC also means yes, and DEL means no.
2242 To be precise, this function translates user input into responses
2243 by consulting the bindings in `query-replace-map'; see the
2244 documentation of that variable for more information. In this
2245 case, the useful bindings are `act', `skip', `recenter',
2246 `scroll-up', `scroll-down', and `quit'.
2247 An `act' response means yes, and a `skip' response means no.
2248 A `quit' response means to invoke `keyboard-quit'.
2249 If the user enters `recenter', `scroll-up', or `scroll-down'
2250 responses, perform the requested window recentering or scrolling
2253 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2254 is nil and `use-dialog-box' is non-nil."
2255 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2256 ;; where all the keys were unbound (i.e. it somehow got triggered
2257 ;; within read-key, apparently). I had to kill it.
2258 (let ((answer 'recenter)
2259 (padded (lambda (prompt &optional dialog)
2260 (let ((l (length prompt)))
2262 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2264 (if dialog "" "(y or n) "))))))
2267 (setq prompt (funcall padded prompt))
2268 (let ((temp-prompt prompt))
2269 (while (not (memq answer '(act skip)))
2270 (let ((str (read-string temp-prompt)))
2271 (cond ((member str '("y" "Y")) (setq answer 'act))
2272 ((member str '("n" "N")) (setq answer 'skip))
2273 (t (setq temp-prompt (concat "Please answer y or n. "
2275 ((and (display-popup-menus-p)
2276 (listp last-nonmenu-event)
2278 (setq prompt (funcall padded prompt t)
2279 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2281 (setq prompt (funcall padded prompt))
2283 (let* ((scroll-actions '(recenter scroll-up scroll-down
2284 scroll-other-window scroll-other-window-down))
2286 (let ((cursor-in-echo-area t))
2287 (when minibuffer-auto-raise
2288 (raise-frame (window-frame (minibuffer-window))))
2289 (read-key (propertize (if (memq answer scroll-actions)
2291 (concat "Please answer y or n. "
2293 'face 'minibuffer-prompt)))))
2294 (setq answer (lookup-key query-replace-map (vector key) t))
2296 ((memq answer '(skip act)) nil)
2297 ((eq answer 'recenter)
2299 ((eq answer 'scroll-up)
2300 (ignore-errors (scroll-up-command)) t)
2301 ((eq answer 'scroll-down)
2302 (ignore-errors (scroll-down-command)) t)
2303 ((eq answer 'scroll-other-window)
2304 (ignore-errors (scroll-other-window)) t)
2305 ((eq answer 'scroll-other-window-down)
2306 (ignore-errors (scroll-other-window-down)) t)
2307 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2308 (signal 'quit nil) t)
2312 (let ((ret (eq answer 'act)))
2313 (unless noninteractive
2314 (message "%s%c" prompt (if ret ?y ?n)))
2318 ;;; Atomic change groups.
2320 (defmacro atomic-change-group (&rest body)
2321 "Perform BODY as an atomic change group.
2322 This means that if BODY exits abnormally,
2323 all of its changes to the current buffer are undone.
2324 This works regardless of whether undo is enabled in the buffer.
2326 This mechanism is transparent to ordinary use of undo;
2327 if undo is enabled in the buffer and BODY succeeds, the
2328 user can undo the change normally."
2329 (declare (indent 0) (debug t))
2330 (let ((handle (make-symbol "--change-group-handle--"))
2331 (success (make-symbol "--change-group-success--")))
2332 `(let ((,handle (prepare-change-group))
2333 ;; Don't truncate any undo data in the middle of this.
2334 (undo-outer-limit nil)
2335 (undo-limit most-positive-fixnum)
2336 (undo-strong-limit most-positive-fixnum)
2340 ;; This is inside the unwind-protect because
2341 ;; it enables undo if that was disabled; we need
2342 ;; to make sure that it gets disabled again.
2343 (activate-change-group ,handle)
2346 ;; Either of these functions will disable undo
2347 ;; if it was disabled before.
2349 (accept-change-group ,handle)
2350 (cancel-change-group ,handle))))))
2352 (defun prepare-change-group (&optional buffer)
2353 "Return a handle for the current buffer's state, for a change group.
2354 If you specify BUFFER, make a handle for BUFFER's state instead.
2356 Pass the handle to `activate-change-group' afterward to initiate
2357 the actual changes of the change group.
2359 To finish the change group, call either `accept-change-group' or
2360 `cancel-change-group' passing the same handle as argument. Call
2361 `accept-change-group' to accept the changes in the group as final;
2362 call `cancel-change-group' to undo them all. You should use
2363 `unwind-protect' to make sure the group is always finished. The call
2364 to `activate-change-group' should be inside the `unwind-protect'.
2365 Once you finish the group, don't use the handle again--don't try to
2366 finish the same group twice. For a simple example of correct use, see
2367 the source code of `atomic-change-group'.
2369 The handle records only the specified buffer. To make a multibuffer
2370 change group, call this function once for each buffer you want to
2371 cover, then use `nconc' to combine the returned values, like this:
2373 (nconc (prepare-change-group buffer-1)
2374 (prepare-change-group buffer-2))
2376 You can then activate that multibuffer change group with a single
2377 call to `activate-change-group' and finish it with a single call
2378 to `accept-change-group' or `cancel-change-group'."
2381 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2382 (list (cons (current-buffer) buffer-undo-list))))
2384 (defun activate-change-group (handle)
2385 "Activate a change group made with `prepare-change-group' (which see)."
2386 (dolist (elt handle)
2387 (with-current-buffer (car elt)
2388 (if (eq buffer-undo-list t)
2389 (setq buffer-undo-list nil)))))
2391 (defun accept-change-group (handle)
2392 "Finish a change group made with `prepare-change-group' (which see).
2393 This finishes the change group by accepting its changes as final."
2394 (dolist (elt handle)
2395 (with-current-buffer (car elt)
2396 (if (eq (cdr elt) t)
2397 (setq buffer-undo-list t)))))
2399 (defun cancel-change-group (handle)
2400 "Finish a change group made with `prepare-change-group' (which see).
2401 This finishes the change group by reverting all of its changes."
2402 (dolist (elt handle)
2403 (with-current-buffer (car elt)
2404 (setq elt (cdr elt))
2406 ;; Widen buffer temporarily so if the buffer was narrowed within
2407 ;; the body of `atomic-change-group' all changes can be undone.
2410 (if (consp elt) (car elt)))
2412 (if (consp elt) (cdr elt))))
2413 ;; Temporarily truncate the undo log at ELT.
2415 (setcar elt nil) (setcdr elt nil))
2416 (unless (eq last-command 'undo) (undo-start))
2417 ;; Make sure there's no confusion.
2418 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2419 (error "Undoing to some unrelated state"))
2422 (while (listp pending-undo-list) (undo-more 1)))
2423 ;; Reset the modified cons cell ELT to its original content.
2425 (setcar elt old-car)
2426 (setcdr elt old-cdr))
2427 ;; Revert the undo info to what it was when we grabbed the state.
2428 (setq buffer-undo-list elt))))))
2430 ;;;; Display-related functions.
2432 ;; For compatibility.
2433 (define-obsolete-function-alias 'redraw-modeline
2434 'force-mode-line-update "24.3")
2436 (defun momentary-string-display (string pos &optional exit-char message)
2437 "Momentarily display STRING in the buffer at POS.
2438 Display remains until next event is input.
2439 If POS is a marker, only its position is used; its buffer is ignored.
2440 Optional third arg EXIT-CHAR can be a character, event or event
2441 description list. EXIT-CHAR defaults to SPC. If the input is
2442 EXIT-CHAR it is swallowed; otherwise it is then available as
2443 input (as a command if nothing else).
2444 Display MESSAGE (optional fourth arg) in the echo area.
2445 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2446 (or exit-char (setq exit-char ?\s))
2447 (let ((ol (make-overlay pos pos))
2448 (str (copy-sequence string)))
2452 (overlay-put ol 'after-string str)
2454 ;; To avoid trouble with out-of-bounds position
2456 ;; If the string end is off screen, recenter now.
2457 (if (<= (window-end nil t) pos)
2458 (recenter (/ (window-height) 2))))
2459 (message (or message "Type %s to continue editing.")
2460 (single-key-description exit-char))
2461 (let ((event (read-key)))
2462 ;; `exit-char' can be an event, or an event description list.
2463 (or (eq event exit-char)
2464 (eq event (event-convert-list exit-char))
2465 (setq unread-command-events
2466 (append (this-single-command-raw-keys))))))
2467 (delete-overlay ol))))
2470 ;;;; Overlay operations
2472 (defun copy-overlay (o)
2473 "Return a copy of overlay O."
2474 (let ((o1 (if (overlay-buffer o)
2475 (make-overlay (overlay-start o) (overlay-end o)
2476 ;; FIXME: there's no easy way to find the
2477 ;; insertion-type of the two markers.
2479 (let ((o1 (make-overlay (point-min) (point-min))))
2482 (props (overlay-properties o)))
2484 (overlay-put o1 (pop props) (pop props)))
2487 (defun remove-overlays (&optional beg end name val)
2488 "Clear BEG and END of overlays whose property NAME has value VAL.
2489 Overlays might be moved and/or split.
2490 BEG and END default respectively to the beginning and end of buffer."
2491 ;; This speeds up the loops over overlays.
2492 (unless beg (setq beg (point-min)))
2493 (unless end (setq end (point-max)))
2494 (overlay-recenter end)
2496 (setq beg (prog1 end (setq end beg))))
2498 (dolist (o (overlays-in beg end))
2499 (when (eq (overlay-get o name) val)
2500 ;; Either push this overlay outside beg...end
2501 ;; or split it to exclude beg...end
2502 ;; or delete it entirely (if it is contained in beg...end).
2503 (if (< (overlay-start o) beg)
2504 (if (> (overlay-end o) end)
2506 (move-overlay (copy-overlay o)
2507 (overlay-start o) beg)
2508 (move-overlay o end (overlay-end o)))
2509 (move-overlay o (overlay-start o) beg))
2510 (if (> (overlay-end o) end)
2511 (move-overlay o end (overlay-end o))
2512 (delete-overlay o)))))))
2516 (defvar suspend-hook nil
2517 "Normal hook run by `suspend-emacs', before suspending.")
2519 (defvar suspend-resume-hook nil
2520 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2522 (defvar temp-buffer-show-hook nil
2523 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2524 When the hook runs, the temporary buffer is current, and the window it
2525 was displayed in is selected.")
2527 (defvar temp-buffer-setup-hook nil
2528 "Normal hook run by `with-output-to-temp-buffer' at the start.
2529 When the hook runs, the temporary buffer is current.
2530 This hook is normally set up with a function to put the buffer in Help
2533 (defconst user-emacs-directory
2534 (if (eq system-type 'ms-dos)
2535 ;; MS-DOS cannot have initial dot.
2538 "Directory beneath which additional per-user Emacs-specific files are placed.
2539 Various programs in Emacs store information in this directory.
2540 Note that this should end with a directory separator.
2541 See also `locate-user-emacs-file'.")
2543 ;;;; Misc. useful functions.
2545 (defsubst buffer-narrowed-p ()
2546 "Return non-nil if the current buffer is narrowed."
2547 (/= (- (point-max) (point-min)) (buffer-size)))
2549 (defun find-tag-default-bounds ()
2550 "Determine the boundaries of the default tag, based on text at point.
2551 Return a cons cell with the beginning and end of the found tag.
2552 If there is no plausible default, return nil."
2553 (let (from to bound)
2555 ;; Look at text around `point'.
2557 (skip-syntax-backward "w_") (setq from (point)))
2559 (skip-syntax-forward "w_") (setq to (point)))
2561 ;; Look between `line-beginning-position' and `point'.
2563 (and (setq bound (line-beginning-position))
2564 (skip-syntax-backward "^w_" bound)
2565 (> (setq to (point)) bound)
2566 (skip-syntax-backward "w_")
2567 (setq from (point))))
2568 ;; Look between `point' and `line-end-position'.
2570 (and (setq bound (line-end-position))
2571 (skip-syntax-forward "^w_" bound)
2572 (< (setq from (point)) bound)
2573 (skip-syntax-forward "w_")
2574 (setq to (point)))))
2577 (defun find-tag-default ()
2578 "Determine default tag to search for, based on text at point.
2579 If there is no plausible default, return nil."
2580 (let ((bounds (find-tag-default-bounds)))
2582 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2584 (defun find-tag-default-as-regexp ()
2585 "Return regexp that matches the default tag at point.
2586 If there is no tag at point, return nil.
2588 When in a major mode that does not provide its own
2589 `find-tag-default-function', return a regexp that matches the
2590 symbol at point exactly."
2591 (let ((tag (funcall (or find-tag-default-function
2592 (get major-mode 'find-tag-default-function)
2593 'find-tag-default))))
2594 (if tag (regexp-quote tag))))
2596 (defun find-tag-default-as-symbol-regexp ()
2597 "Return regexp that matches the default tag at point as symbol.
2598 If there is no tag at point, return nil.
2600 When in a major mode that does not provide its own
2601 `find-tag-default-function', return a regexp that matches the
2602 symbol at point exactly."
2603 (let ((tag-regexp (find-tag-default-as-regexp)))
2605 (eq (or find-tag-default-function
2606 (get major-mode 'find-tag-default-function)
2609 (format "\\_<%s\\_>" tag-regexp)
2612 (defun play-sound (sound)
2613 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2614 The following keywords are recognized:
2616 :file FILE - read sound data from FILE. If FILE isn't an
2617 absolute file name, it is searched in `data-directory'.
2619 :data DATA - read sound data from string DATA.
2621 Exactly one of :file or :data must be present.
2623 :volume VOL - set volume to VOL. VOL must an integer in the
2624 range 0..100 or a float in the range 0..1.0. If not specified,
2625 don't change the volume setting of the sound device.
2627 :device DEVICE - play sound on DEVICE. If not specified,
2628 a system-dependent default device name is used.
2630 Note: :data and :device are currently not supported on Windows."
2631 (if (fboundp 'play-sound-internal)
2632 (play-sound-internal sound)
2633 (error "This Emacs binary lacks sound support")))
2635 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2637 (defun shell-quote-argument (argument)
2638 "Quote ARGUMENT for passing as argument to an inferior shell."
2640 ((eq system-type 'ms-dos)
2641 ;; Quote using double quotes, but escape any existing quotes in
2642 ;; the argument with backslashes.
2646 (if (or (null (string-match "[^\"]" argument))
2647 (< (match-end 0) (length argument)))
2648 (while (string-match "[\"]" argument start)
2649 (setq end (match-beginning 0)
2650 result (concat result (substring argument start end)
2651 "\\" (substring argument end (1+ end)))
2653 (concat "\"" result (substring argument start) "\"")))
2655 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2657 ;; First, quote argument so that CommandLineToArgvW will
2658 ;; understand it. See
2659 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2660 ;; After we perform that level of quoting, escape shell
2661 ;; metacharacters so that cmd won't mangle our argument. If the
2662 ;; argument contains no double quote characters, we can just
2663 ;; surround it with double quotes. Otherwise, we need to prefix
2664 ;; each shell metacharacter with a caret.
2667 ;; escape backslashes at end of string
2668 (replace-regexp-in-string
2671 ;; escape backslashes and quotes in string body
2672 (replace-regexp-in-string
2677 (if (string-match "[%!\"]" argument)
2680 (replace-regexp-in-string
2681 "\\([%!()\"<>&|^]\\)"
2685 (concat "\"" argument "\"")))
2688 (if (equal argument "")
2690 ;; Quote everything except POSIX filename characters.
2691 ;; This should be safe enough even for really weird shells.
2692 (replace-regexp-in-string
2694 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2697 (defun string-or-null-p (object)
2698 "Return t if OBJECT is a string or nil.
2699 Otherwise, return nil."
2700 (or (stringp object) (null object)))
2702 (defun booleanp (object)
2703 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2704 Otherwise, return nil."
2705 (and (memq object '(nil t)) t))
2707 (defun special-form-p (object)
2708 "Non-nil if and only if OBJECT is a special form."
2709 (if (and (symbolp object) (fboundp object))
2710 (setq object (indirect-function object t)))
2711 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2713 (defun macrop (object)
2714 "Non-nil if and only if OBJECT is a macro."
2715 (let ((def (indirect-function object t)))
2717 (or (eq 'macro (car def))
2718 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2720 (defun field-at-pos (pos)
2721 "Return the field at position POS, taking stickiness etc into account."
2722 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2723 (if (eq raw-field 'boundary)
2724 (get-char-property (1- (field-end pos)) 'field)
2727 (defun sha1 (object &optional start end binary)
2728 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2729 OBJECT is either a string or a buffer. Optional arguments START and
2730 END are character positions specifying which portion of OBJECT for
2731 computing the hash. If BINARY is non-nil, return a string in binary
2733 (secure-hash 'sha1 object start end binary))
2735 (defun function-get (f prop &optional autoload)
2736 "Return the value of property PROP of function F.
2737 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2738 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2739 if it's an autoloaded macro."
2741 (while (and (symbolp f)
2742 (null (setq val (get f prop)))
2744 (let ((fundef (symbol-function f)))
2745 (if (and autoload (autoloadp fundef)
2747 (autoload-do-load fundef f
2748 (if (eq autoload 'macro)
2750 nil ;Re-try `get' on the same `f'.
2754 ;;;; Support for yanking and text properties.
2755 ;; Why here in subr.el rather than in simple.el? --Stef
2757 (defvar yank-handled-properties)
2758 (defvar yank-excluded-properties)
2760 (defun remove-yank-excluded-properties (start end)
2761 "Process text properties between START and END, inserted for a `yank'.
2762 Perform the handling specified by `yank-handled-properties', then
2763 remove properties specified by `yank-excluded-properties'."
2764 (let ((inhibit-read-only t))
2765 (dolist (handler yank-handled-properties)
2766 (let ((prop (car handler))
2769 (while (< run-start end)
2770 (let ((value (get-text-property run-start prop))
2771 (run-end (next-single-property-change
2772 run-start prop nil end)))
2773 (funcall fun value run-start run-end)
2774 (setq run-start run-end)))))
2775 (if (eq yank-excluded-properties t)
2776 (set-text-properties start end nil)
2777 (remove-list-of-text-properties start end yank-excluded-properties))))
2779 (defvar yank-undo-function)
2781 (defun insert-for-yank (string)
2782 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2784 See `insert-for-yank-1' for more details."
2786 (while (setq to (next-single-property-change 0 'yank-handler string))
2787 (insert-for-yank-1 (substring string 0 to))
2788 (setq string (substring string to))))
2789 (insert-for-yank-1 string))
2791 (defun insert-for-yank-1 (string)
2792 "Insert STRING at point for the `yank' command.
2793 This function is like `insert', except it honors the variables
2794 `yank-handled-properties' and `yank-excluded-properties', and the
2795 `yank-handler' text property.
2797 Properties listed in `yank-handled-properties' are processed,
2798 then those listed in `yank-excluded-properties' are discarded.
2800 If STRING has a non-nil `yank-handler' property on its first
2801 character, the normal insert behavior is altered. The value of
2802 the `yank-handler' property must be a list of one to four
2803 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2804 FUNCTION, if non-nil, should be a function of one argument, an
2805 object to insert; it is called instead of `insert'.
2806 PARAM, if present and non-nil, replaces STRING as the argument to
2807 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2808 may be a list of strings to insert as a rectangle.
2809 If NOEXCLUDE is present and non-nil, the normal removal of
2810 `yank-excluded-properties' is not performed; instead FUNCTION is
2811 responsible for the removal. This may be necessary if FUNCTION
2812 adjusts point before or after inserting the object.
2813 UNDO, if present and non-nil, should be a function to be called
2814 by `yank-pop' to undo the insertion of the current object. It is
2815 given two arguments, the start and end of the region. FUNCTION
2816 may set `yank-undo-function' to override UNDO."
2817 (let* ((handler (and (stringp string)
2818 (get-text-property 0 'yank-handler string)))
2819 (param (or (nth 1 handler) string))
2821 (inhibit-read-only inhibit-read-only)
2824 (setq yank-undo-function t)
2825 (if (nth 0 handler) ; FUNCTION
2826 (funcall (car handler) param)
2830 ;; Prevent read-only properties from interfering with the
2831 ;; following text property changes.
2832 (setq inhibit-read-only t)
2834 (unless (nth 2 handler) ; NOEXCLUDE
2835 (remove-yank-excluded-properties opoint end))
2837 ;; If last inserted char has properties, mark them as rear-nonsticky.
2838 (if (and (> end opoint)
2839 (text-properties-at (1- end)))
2840 (put-text-property (1- end) end 'rear-nonsticky t))
2842 (if (eq yank-undo-function t) ; not set by FUNCTION
2843 (setq yank-undo-function (nth 3 handler))) ; UNDO
2844 (if (nth 4 handler) ; COMMAND
2845 (setq this-command (nth 4 handler)))))
2847 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2848 "Insert before point a substring of BUFFER, without text properties.
2849 BUFFER may be a buffer or a buffer name.
2850 Arguments START and END are character positions specifying the substring.
2851 They default to the values of (point-min) and (point-max) in BUFFER."
2852 (let ((opoint (point)))
2853 (insert-buffer-substring buffer start end)
2854 (let ((inhibit-read-only t))
2855 (set-text-properties opoint (point) nil))))
2857 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2858 "Insert before point a part of BUFFER, stripping some text properties.
2859 BUFFER may be a buffer or a buffer name.
2860 Arguments START and END are character positions specifying the substring.
2861 They default to the values of (point-min) and (point-max) in BUFFER.
2862 Before insertion, process text properties according to
2863 `yank-handled-properties' and `yank-excluded-properties'."
2864 ;; Since the buffer text should not normally have yank-handler properties,
2865 ;; there is no need to handle them here.
2866 (let ((opoint (point)))
2867 (insert-buffer-substring buffer start end)
2868 (remove-yank-excluded-properties opoint (point))))
2870 (defun yank-handle-font-lock-face-property (face start end)
2871 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2872 START and END denote the start and end of the text to act on.
2873 Do nothing if FACE is nil."
2875 (null font-lock-defaults)
2876 (put-text-property start end 'face face)))
2878 ;; This removes `mouse-face' properties in *Help* buffer buttons:
2879 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2880 (defun yank-handle-category-property (category start end)
2881 "Apply property category CATEGORY's properties between START and END."
2883 (let ((start2 start))
2884 (while (< start2 end)
2885 (let ((end2 (next-property-change start2 nil end))
2886 (original (text-properties-at start2)))
2887 (set-text-properties start2 end2 (symbol-plist category))
2888 (add-text-properties start2 end2 original)
2889 (setq start2 end2))))))
2892 ;;;; Synchronous shell commands.
2894 (defun start-process-shell-command (name buffer &rest args)
2895 "Start a program in a subprocess. Return the process object for it.
2896 NAME is name for process. It is modified if necessary to make it unique.
2897 BUFFER is the buffer (or buffer name) to associate with the process.
2898 Process output goes at end of that buffer, unless you specify
2899 an output stream or filter function to handle the output.
2900 BUFFER may be also nil, meaning that this process is not associated
2902 COMMAND is the shell command to run.
2904 An old calling convention accepted any number of arguments after COMMAND,
2905 which were just concatenated to COMMAND. This is still supported but strongly
2907 ;; We used to use `exec' to replace the shell with the command,
2908 ;; but that failed to handle (...) and semicolon, etc.
2909 (start-process name buffer shell-file-name shell-command-switch
2910 (mapconcat 'identity args " ")))
2911 (set-advertised-calling-convention 'start-process-shell-command
2912 '(name buffer command) "23.1")
2914 (defun start-file-process-shell-command (name buffer &rest args)
2915 "Start a program in a subprocess. Return the process object for it.
2916 Similar to `start-process-shell-command', but calls `start-file-process'."
2919 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2920 (if (file-remote-p default-directory) "-c" shell-command-switch)
2921 (mapconcat 'identity args " ")))
2922 (set-advertised-calling-convention 'start-file-process-shell-command
2923 '(name buffer command) "23.1")
2925 (defun call-process-shell-command (command &optional infile buffer display
2927 "Execute the shell command COMMAND synchronously in separate process.
2928 The remaining arguments are optional.
2929 The program's input comes from file INFILE (nil means `/dev/null').
2930 Insert output in BUFFER before point; t means current buffer;
2931 nil for BUFFER means discard it; 0 means discard and don't wait.
2932 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2933 REAL-BUFFER says what to do with standard output, as above,
2934 while STDERR-FILE says what to do with standard error in the child.
2935 STDERR-FILE may be nil (discard standard error output),
2936 t (mix it with ordinary output), or a file name string.
2938 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2939 Remaining arguments are strings passed as additional arguments for COMMAND.
2940 Wildcards and redirection are handled as usual in the shell.
2942 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2943 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2944 status or a signal description string.
2945 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2946 ;; We used to use `exec' to replace the shell with the command,
2947 ;; but that failed to handle (...) and semicolon, etc.
2948 (call-process shell-file-name
2949 infile buffer display
2950 shell-command-switch
2951 (mapconcat 'identity (cons command args) " ")))
2953 (defun process-file-shell-command (command &optional infile buffer display
2955 "Process files synchronously in a separate process.
2956 Similar to `call-process-shell-command', but calls `process-file'."
2958 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2959 infile buffer display
2960 (if (file-remote-p default-directory) "-c" shell-command-switch)
2961 (mapconcat 'identity (cons command args) " ")))
2963 ;;;; Lisp macros to do various things temporarily.
2965 (defun internal--before-with-selected-window (window)
2966 (let ((other-frame (window-frame window)))
2967 (list window (selected-window)
2968 ;; Selecting a window on another frame also changes that
2969 ;; frame's frame-selected-window. We must save&restore it.
2970 (unless (eq (selected-frame) other-frame)
2971 (frame-selected-window other-frame))
2972 ;; Also remember the top-frame if on ttys.
2973 (unless (eq (selected-frame) other-frame)
2974 (tty-top-frame other-frame)))))
2976 (defun internal--after-with-selected-window (state)
2977 ;; First reset frame-selected-window.
2978 (when (window-live-p (nth 2 state))
2979 ;; We don't use set-frame-selected-window because it does not
2980 ;; pass the `norecord' argument to Fselect_window.
2981 (select-window (nth 2 state) 'norecord)
2982 (and (frame-live-p (nth 3 state))
2983 (not (eq (tty-top-frame) (nth 3 state)))
2984 (select-frame (nth 3 state) 'norecord)))
2985 ;; Then reset the actual selected-window.
2986 (when (window-live-p (nth 1 state))
2987 (select-window (nth 1 state) 'norecord)))
2989 (defmacro with-selected-window (window &rest body)
2990 "Execute the forms in BODY with WINDOW as the selected window.
2991 The value returned is the value of the last form in BODY.
2993 This macro saves and restores the selected window, as well as the
2994 selected window of each frame. It does not change the order of
2995 recently selected windows. If the previously selected window of
2996 some frame is no longer live at the end of BODY, that frame's
2997 selected window is left alone. If the selected window is no
2998 longer live, then whatever window is selected at the end of BODY
3001 This macro uses `save-current-buffer' to save and restore the
3002 current buffer, since otherwise its normal operation could
3003 potentially make a different buffer current. It does not alter
3004 the buffer list ordering."
3005 (declare (indent 1) (debug t))
3006 `(let ((save-selected-window--state
3007 (internal--before-with-selected-window ,window)))
3008 (save-current-buffer
3010 (progn (select-window (car save-selected-window--state) 'norecord)
3012 (internal--after-with-selected-window save-selected-window--state)))))
3014 (defmacro with-selected-frame (frame &rest body)
3015 "Execute the forms in BODY with FRAME as the selected frame.
3016 The value returned is the value of the last form in BODY.
3018 This macro saves and restores the selected frame, and changes the
3019 order of neither the recently selected windows nor the buffers in
3021 (declare (indent 1) (debug t))
3022 (let ((old-frame (make-symbol "old-frame"))
3023 (old-buffer (make-symbol "old-buffer")))
3024 `(let ((,old-frame (selected-frame))
3025 (,old-buffer (current-buffer)))
3027 (progn (select-frame ,frame 'norecord)
3029 (when (frame-live-p ,old-frame)
3030 (select-frame ,old-frame 'norecord))
3031 (when (buffer-live-p ,old-buffer)
3032 (set-buffer ,old-buffer))))))
3034 (defun internal-temp-output-buffer-show (buffer)
3035 "Internal function for `with-output-to-temp-buffer'."
3036 (with-current-buffer buffer
3037 (set-buffer-modified-p nil)
3038 (goto-char (point-min)))
3040 (if temp-buffer-show-function
3041 (funcall temp-buffer-show-function buffer)
3042 (with-current-buffer buffer
3044 (let ((window-combination-limit
3045 ;; When `window-combination-limit' equals
3046 ;; `temp-buffer' or `temp-buffer-resize' and
3047 ;; `temp-buffer-resize-mode' is enabled in this
3048 ;; buffer bind it to t so resizing steals space
3049 ;; preferably from the window that was split.
3050 (if (or (eq window-combination-limit 'temp-buffer)
3051 (and (eq window-combination-limit
3052 'temp-buffer-resize)
3053 temp-buffer-resize-mode))
3055 window-combination-limit)))
3056 (display-buffer buffer)))
3057 (frame (and window (window-frame window))))
3059 (unless (eq frame (selected-frame))
3060 (make-frame-visible frame))
3061 (setq minibuffer-scroll-window window)
3062 (set-window-hscroll window 0)
3063 ;; Don't try this with NOFORCE non-nil!
3064 (set-window-start window (point-min) t)
3065 ;; This should not be necessary.
3066 (set-window-point window (point-min))
3067 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3068 (with-selected-window window
3069 (run-hooks 'temp-buffer-show-hook))))))
3073 ;; Doc is very similar to with-temp-buffer-window.
3074 (defmacro with-output-to-temp-buffer (bufname &rest body)
3075 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3077 This construct makes buffer BUFNAME empty before running BODY.
3078 It does not make the buffer current for BODY.
3079 Instead it binds `standard-output' to that buffer, so that output
3080 generated with `prin1' and similar functions in BODY goes into
3083 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3084 it in a window, but does not select it. The normal way to do this is
3085 by calling `display-buffer', then running `temp-buffer-show-hook'.
3086 However, if `temp-buffer-show-function' is non-nil, it calls that
3087 function instead (and does not run `temp-buffer-show-hook'). The
3088 function gets one argument, the buffer to display.
3090 The return value of `with-output-to-temp-buffer' is the value of the
3091 last form in BODY. If BODY does not finish normally, the buffer
3092 BUFNAME is not displayed.
3094 This runs the hook `temp-buffer-setup-hook' before BODY,
3095 with the buffer BUFNAME temporarily current. It runs the hook
3096 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3097 buffer temporarily current, and the window that was used to display it
3098 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3099 if it uses `temp-buffer-show-function'.
3101 See the related form `with-temp-buffer-window'."
3103 (let ((old-dir (make-symbol "old-dir"))
3104 (buf (make-symbol "buf")))
3105 `(let* ((,old-dir default-directory)
3107 (with-current-buffer (get-buffer-create ,bufname)
3108 (prog1 (current-buffer)
3109 (kill-all-local-variables)
3110 ;; FIXME: delete_all_overlays
3111 (setq default-directory ,old-dir)
3112 (setq buffer-read-only nil)
3113 (setq buffer-file-name nil)
3114 (setq buffer-undo-list t)
3115 (let ((inhibit-read-only t)
3116 (inhibit-modification-hooks t))
3118 (run-hooks 'temp-buffer-setup-hook)))))
3119 (standard-output ,buf))
3120 (prog1 (progn ,@body)
3121 (internal-temp-output-buffer-show ,buf)))))
3123 (defmacro with-temp-file (file &rest body)
3124 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3125 The value returned is the value of the last form in BODY.
3126 See also `with-temp-buffer'."
3127 (declare (indent 1) (debug t))
3128 (let ((temp-file (make-symbol "temp-file"))
3129 (temp-buffer (make-symbol "temp-buffer")))
3130 `(let ((,temp-file ,file)
3132 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3135 (with-current-buffer ,temp-buffer
3137 (with-current-buffer ,temp-buffer
3138 (write-region nil nil ,temp-file nil 0)))
3139 (and (buffer-name ,temp-buffer)
3140 (kill-buffer ,temp-buffer))))))
3142 (defmacro with-temp-message (message &rest body)
3143 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3144 The original message is restored to the echo area after BODY has finished.
3145 The value returned is the value of the last form in BODY.
3146 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3147 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3148 Use a MESSAGE of \"\" to temporarily clear the echo area."
3149 (declare (debug t) (indent 1))
3150 (let ((current-message (make-symbol "current-message"))
3151 (temp-message (make-symbol "with-temp-message")))
3152 `(let ((,temp-message ,message)
3157 (setq ,current-message (current-message))
3158 (message "%s" ,temp-message))
3161 (if ,current-message
3162 (message "%s" ,current-message)
3165 (defmacro with-silent-modifications (&rest body)
3166 "Execute BODY, pretending it does not modify the buffer.
3167 If BODY performs real modifications to the buffer's text, other
3168 than cosmetic ones, undo data may become corrupted.
3170 This macro will run BODY normally, but doesn't count its buffer
3171 modifications as being buffer modifications. This affects things
3172 like `buffer-modified-p', checking whether the file is locked by
3173 someone else, running buffer modification hooks, and other things
3176 Typically used around modifications of text-properties which do
3177 not really affect the buffer's content."
3178 (declare (debug t) (indent 0))
3179 (let ((modified (make-symbol "modified")))
3180 `(let* ((,modified (buffer-modified-p))
3181 (buffer-undo-list t)
3182 (inhibit-read-only t)
3183 (inhibit-modification-hooks t))
3188 (restore-buffer-modified-p nil))))))
3190 (defmacro with-output-to-string (&rest body)
3191 "Execute BODY, return the text it sent to `standard-output', as a string."
3192 (declare (indent 0) (debug t))
3193 `(let ((standard-output
3194 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3197 (let ((standard-output standard-output))
3199 (with-current-buffer standard-output
3201 (kill-buffer standard-output))))
3203 (defmacro with-local-quit (&rest body)
3204 "Execute BODY, allowing quits to terminate BODY but not escape further.
3205 When a quit terminates BODY, `with-local-quit' returns nil but
3206 requests another quit. That quit will be processed as soon as quitting
3207 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3208 (declare (debug t) (indent 0))
3209 `(condition-case nil
3210 (let ((inhibit-quit nil))
3212 (quit (setq quit-flag t)
3213 ;; This call is to give a chance to handle quit-flag
3214 ;; in case inhibit-quit is nil.
3215 ;; Without this, it will not be handled until the next function
3216 ;; call, and that might allow it to exit thru a condition-case
3217 ;; that intends to handle the quit signal next time.
3218 (eval '(ignore nil)))))
3220 (defmacro while-no-input (&rest body)
3221 "Execute BODY only as long as there's no pending input.
3222 If input arrives, that ends the execution of BODY,
3223 and `while-no-input' returns t. Quitting makes it return nil.
3224 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3225 (declare (debug t) (indent 0))
3226 (let ((catch-sym (make-symbol "input")))
3229 (let ((throw-on-input ',catch-sym))
3230 (or (input-pending-p)
3231 (progn ,@body)))))))
3233 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3234 "Like `condition-case' except that it does not prevent debugging.
3235 More specifically if `debug-on-error' is set then the debugger will be invoked
3236 even if this catches the signal."
3237 (declare (debug condition-case) (indent 2))
3238 `(condition-case ,var
3240 ,@(mapcar (lambda (handler)
3241 `((debug ,@(if (listp (car handler)) (car handler)
3242 (list (car handler))))
3246 (define-obsolete-function-alias 'condition-case-no-debug
3247 'condition-case-unless-debug "24.1")
3249 (defmacro with-demoted-errors (format &rest body)
3250 "Run BODY and demote any errors to simple messages.
3251 FORMAT is a string passed to `message' to format any error message.
3252 It should contain a single %-sequence; e.g., \"Error: %S\".
3254 If `debug-on-error' is non-nil, run BODY without catching its errors.
3255 This is to be used around code which is not expected to signal an error
3256 but which should be robust in the unexpected case that an error is signaled.
3258 For backward compatibility, if FORMAT is not a constant string, it
3259 is assumed to be part of BODY, in which case the message format
3260 used is \"Error: %S\"."
3261 (declare (debug t) (indent 1))
3262 (let ((err (make-symbol "err"))
3263 (format (if (and (stringp format) body) format
3265 (if format (push format body))))))
3266 `(condition-case-unless-debug ,err
3268 (error (message ,format ,err) nil))))
3270 (defmacro combine-after-change-calls (&rest body)
3271 "Execute BODY, but don't call the after-change functions till the end.
3272 If BODY makes changes in the buffer, they are recorded
3273 and the functions on `after-change-functions' are called several times
3274 when BODY is finished.
3275 The return value is the value of the last form in BODY.
3277 If `before-change-functions' is non-nil, then calls to the after-change
3278 functions can't be deferred, so in that case this macro has no effect.
3280 Do not alter `after-change-functions' or `before-change-functions'
3282 (declare (indent 0) (debug t))
3284 (let ((combine-after-change-calls t))
3286 (combine-after-change-execute)))
3288 (defmacro with-case-table (table &rest body)
3289 "Execute the forms in BODY with TABLE as the current case table.
3290 The value returned is the value of the last form in BODY."
3291 (declare (indent 1) (debug t))
3292 (let ((old-case-table (make-symbol "table"))
3293 (old-buffer (make-symbol "buffer")))
3294 `(let ((,old-case-table (current-case-table))
3295 (,old-buffer (current-buffer)))
3297 (progn (set-case-table ,table)
3299 (with-current-buffer ,old-buffer
3300 (set-case-table ,old-case-table))))))
3302 (defmacro with-file-modes (modes &rest body)
3303 "Execute BODY with default file permissions temporarily set to MODES.
3304 MODES is as for `set-default-file-modes'."
3305 (declare (indent 1) (debug t))
3306 (let ((umask (make-symbol "umask")))
3307 `(let ((,umask (default-file-modes)))
3310 (set-default-file-modes ,modes)
3312 (set-default-file-modes ,umask)))))
3315 ;;; Matching and match data.
3317 (defvar save-match-data-internal)
3319 ;; We use save-match-data-internal as the local variable because
3320 ;; that works ok in practice (people should not use that variable elsewhere).
3321 ;; We used to use an uninterned symbol; the compiler handles that properly
3322 ;; now, but it generates slower code.
3323 (defmacro save-match-data (&rest body)
3324 "Execute the BODY forms, restoring the global value of the match data.
3325 The value returned is the value of the last form in BODY."
3326 ;; It is better not to use backquote here,
3327 ;; because that makes a bootstrapping problem
3328 ;; if you need to recompile all the Lisp files using interpreted code.
3329 (declare (indent 0) (debug t))
3331 '((save-match-data-internal (match-data)))
3332 (list 'unwind-protect
3334 ;; It is safe to free (evaporate) markers immediately here,
3335 ;; as Lisp programs should not copy from save-match-data-internal.
3336 '(set-match-data save-match-data-internal 'evaporate))))
3338 (defun match-string (num &optional string)
3339 "Return string of text matched by last search.
3340 NUM specifies which parenthesized expression in the last regexp.
3341 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3342 Zero means the entire text matched by the whole regexp or whole string.
3343 STRING should be given if the last search was by `string-match' on STRING.
3344 If STRING is nil, the current buffer should be the same buffer
3345 the search/match was performed in."
3346 (if (match-beginning num)
3348 (substring string (match-beginning num) (match-end num))
3349 (buffer-substring (match-beginning num) (match-end num)))))
3351 (defun match-string-no-properties (num &optional string)
3352 "Return string of text matched by last search, without text properties.
3353 NUM specifies which parenthesized expression in the last regexp.
3354 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3355 Zero means the entire text matched by the whole regexp or whole string.
3356 STRING should be given if the last search was by `string-match' on STRING.
3357 If STRING is nil, the current buffer should be the same buffer
3358 the search/match was performed in."
3359 (if (match-beginning num)
3361 (substring-no-properties string (match-beginning num)
3363 (buffer-substring-no-properties (match-beginning num)
3367 (defun match-substitute-replacement (replacement
3368 &optional fixedcase literal string subexp)
3369 "Return REPLACEMENT as it will be inserted by `replace-match'.
3370 In other words, all back-references in the form `\\&' and `\\N'
3371 are substituted with actual strings matched by the last search.
3372 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3373 meaning as for `replace-match'."
3374 (let ((match (match-string 0 string)))
3376 (set-match-data (mapcar (lambda (x)
3378 (- x (match-beginning 0))
3381 (replace-match replacement fixedcase literal match subexp))))
3384 (defun looking-back (regexp &optional limit greedy)
3385 "Return non-nil if text before point matches regular expression REGEXP.
3386 Like `looking-at' except matches before point, and is slower.
3387 LIMIT if non-nil speeds up the search by specifying a minimum
3388 starting position, to avoid checking matches that would start
3391 If GREEDY is non-nil, extend the match backwards as far as
3392 possible, stopping when a single additional previous character
3393 cannot be part of a match for REGEXP. When the match is
3394 extended, its starting position is allowed to occur before
3397 As a general recommendation, try to avoid using `looking-back'
3398 wherever possible, since it is slow."
3399 (let ((start (point))
3402 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3404 (if (and greedy pos)
3406 (narrow-to-region (point-min) start)
3407 (while (and (> pos (point-min))
3411 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3412 (setq pos (1- pos)))
3415 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3418 (defsubst looking-at-p (regexp)
3420 Same as `looking-at' except this function does not change the match data."
3421 (let ((inhibit-changing-match-data t))
3422 (looking-at regexp)))
3424 (defsubst string-match-p (regexp string &optional start)
3426 Same as `string-match' except this function does not change the match data."
3427 (let ((inhibit-changing-match-data t))
3428 (string-match regexp string start)))
3430 (defun subregexp-context-p (regexp pos &optional start)
3431 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3432 A subregexp context is one where a sub-regexp can appear.
3433 A non-subregexp context is for example within brackets, or within a
3434 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3435 If START is non-nil, it should be a position in REGEXP, smaller
3436 than POS, and known to be in a subregexp context."
3437 ;; Here's one possible implementation, with the great benefit that it
3438 ;; reuses the regexp-matcher's own parser, so it understands all the
3439 ;; details of the syntax. A disadvantage is that it needs to match the
3443 (string-match (substring regexp (or start 0) pos) "")
3446 (not (member (cadr err) '("Unmatched [ or [^"
3448 "Trailing backslash")))))
3449 ;; An alternative implementation:
3450 ;; (defconst re-context-re
3451 ;; (let* ((harmless-ch "[^\\[]")
3452 ;; (harmless-esc "\\\\[^{]")
3453 ;; (class-harmless-ch "[^][]")
3454 ;; (class-lb-harmless "[^]:]")
3455 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3456 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3457 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3459 ;; (concat "\\[^?]?"
3460 ;; "\\(" class-harmless-ch
3461 ;; "\\|" class-lb "\\)*"
3462 ;; "\\[?]")) ; special handling for bare [ at end of re
3463 ;; (braces "\\\\{[0-9,]+\\\\}"))
3464 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3465 ;; "\\|" class "\\|" braces "\\)*\\'"))
3466 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3467 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3472 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3473 "The default value of separators for `split-string'.
3475 A regexp matching strings of whitespace. May be locale-dependent
3476 \(as yet unimplemented). Should not match non-breaking spaces.
3478 Warning: binding this to a different value and using it as default is
3479 likely to have undesired semantics.")
3481 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3482 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3483 ;; expression leads to the equivalent implementation that if SEPARATORS
3484 ;; is defaulted, OMIT-NULLS is treated as t.
3485 (defun split-string (string &optional separators omit-nulls trim)
3486 "Split STRING into substrings bounded by matches for SEPARATORS.
3488 The beginning and end of STRING, and each match for SEPARATORS, are
3489 splitting points. The substrings matching SEPARATORS are removed, and
3490 the substrings between the splitting points are collected as a list,
3493 If SEPARATORS is non-nil, it should be a regular expression matching text
3494 which separates, but is not part of, the substrings. If nil it defaults to
3495 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3496 OMIT-NULLS is forced to t.
3498 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3499 that for the default value of SEPARATORS leading and trailing whitespace
3500 are effectively trimmed). If nil, all zero-length substrings are retained,
3501 which correctly parses CSV format, for example.
3503 If TRIM is non-nil, it should be a regular expression to match
3504 text to trim from the beginning and end of each substring. If trimming
3505 makes the substring empty, it is treated as null.
3507 If you want to trim whitespace from the substrings, the reliably correct
3508 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3509 results when there is whitespace at the start or end of STRING. If you
3510 see such calls to `split-string', please fix them.
3512 Note that the effect of `(split-string STRING)' is the same as
3513 `(split-string STRING split-string-default-separators t)'. In the rare
3514 case that you wish to retain zero-length substrings when splitting on
3515 whitespace, use `(split-string STRING split-string-default-separators)'.
3517 Modifies the match data; use `save-match-data' if necessary."
3518 (let* ((keep-nulls (not (if separators omit-nulls t)))
3519 (rexp (or separators split-string-default-separators))
3525 ;; Push the substring in range THIS-START to THIS-END
3526 ;; onto LIST, trimming it and perhaps discarding it.
3529 ;; Discard the trim from start of this substring.
3530 (let ((tem (string-match trim string this-start)))
3531 (and (eq tem this-start)
3532 (setq this-start (match-end 0)))))
3534 (when (or keep-nulls (< this-start this-end))
3535 (let ((this (substring string this-start this-end)))
3537 ;; Discard the trim from end of this substring.
3539 (let ((tem (string-match (concat trim "\\'") this 0)))
3540 (and tem (< tem (length this))
3541 (setq this (substring this 0 tem)))))
3543 ;; Trimming could make it empty; check again.
3544 (when (or keep-nulls (> (length this) 0))
3545 (push this list)))))))
3547 (while (and (string-match rexp string
3549 (= start (match-beginning 0))
3550 (< start (length string)))
3552 (< start (length string)))
3554 (setq this-start start this-end (match-beginning 0)
3555 start (match-end 0))
3559 ;; Handle the substring at the end of STRING.
3560 (setq this-start start this-end (length string))
3565 (defun combine-and-quote-strings (strings &optional separator)
3566 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3567 This tries to quote the strings to avoid ambiguity such that
3568 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3569 Only some SEPARATORs will work properly."
3570 (let* ((sep (or separator " "))
3571 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3574 (if (string-match re str)
3575 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3579 (defun split-string-and-unquote (string &optional separator)
3580 "Split the STRING into a list of strings.
3581 It understands Emacs Lisp quoting within STRING, such that
3582 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3583 The SEPARATOR regexp defaults to \"\\s-+\"."
3584 (let ((sep (or separator "\\s-+"))
3585 (i (string-match "\"" string)))
3587 (split-string string sep t) ; no quoting: easy
3588 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3589 (let ((rfs (read-from-string string i)))
3591 (split-string-and-unquote (substring string (cdr rfs))
3595 ;;;; Replacement in strings.
3597 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3598 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3599 Unless optional argument INPLACE is non-nil, return a new string."
3600 (let ((i (length string))
3601 (newstr (if inplace string (copy-sequence string))))
3604 (if (eq (aref newstr i) fromchar)
3605 (aset newstr i tochar)))
3608 (defun replace-regexp-in-string (regexp rep string &optional
3609 fixedcase literal subexp start)
3610 "Replace all matches for REGEXP with REP in STRING.
3612 Return a new string containing the replacements.
3614 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3615 arguments with the same names of function `replace-match'. If START
3616 is non-nil, start replacements at that index in STRING.
3618 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3619 function. If it is a function, it is called with the actual text of each
3620 match, and its value is used as the replacement text. When REP is called,
3621 the match data are the result of matching REGEXP against a substring
3624 To replace only the first match (if any), make REGEXP match up to \\'
3625 and replace a sub-expression, e.g.
3626 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3629 ;; To avoid excessive consing from multiple matches in long strings,
3630 ;; don't just call `replace-match' continually. Walk down the
3631 ;; string looking for matches of REGEXP and building up a (reversed)
3632 ;; list MATCHES. This comprises segments of STRING which weren't
3633 ;; matched interspersed with replacements for segments that were.
3634 ;; [For a `large' number of replacements it's more efficient to
3635 ;; operate in a temporary buffer; we can't tell from the function's
3636 ;; args whether to choose the buffer-based implementation, though it
3637 ;; might be reasonable to do so for long enough STRING.]
3638 (let ((l (length string))
3639 (start (or start 0))
3642 (while (and (< start l) (string-match regexp string start))
3643 (setq mb (match-beginning 0)
3645 ;; If we matched the empty string, make sure we advance by one char
3646 (when (= me mb) (setq me (min l (1+ mb))))
3647 ;; Generate a replacement for the matched substring.
3648 ;; Operate only on the substring to minimize string consing.
3649 ;; Set up match data for the substring for replacement;
3650 ;; presumably this is likely to be faster than munging the
3651 ;; match data directly in Lisp.
3652 (string-match regexp (setq str (substring string mb me)))
3654 (cons (replace-match (if (stringp rep)
3656 (funcall rep (match-string 0 str)))
3657 fixedcase literal str subexp)
3658 (cons (substring string start mb) ; unmatched prefix
3661 ;; Reconstruct a string from the pieces.
3662 (setq matches (cons (substring string start l) matches)) ; leftover
3663 (apply #'concat (nreverse matches)))))
3665 (defun string-prefix-p (prefix string &optional ignore-case)
3666 "Return non-nil if PREFIX is a prefix of STRING.
3667 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3668 to case differences."
3669 (let ((prefix-length (length prefix)))
3670 (if (> prefix-length (length string)) nil
3671 (eq t (compare-strings prefix 0 prefix-length string
3672 0 prefix-length ignore-case)))))
3674 (defun string-suffix-p (suffix string &optional ignore-case)
3675 "Return non-nil if SUFFIX is a suffix of STRING.
3676 If IGNORE-CASE is non-nil, the comparison is done without paying
3677 attention to case differences."
3678 (let ((start-pos (- (length string) (length suffix))))
3679 (and (>= start-pos 0)
3680 (eq t (compare-strings suffix nil nil
3681 string start-pos nil ignore-case)))))
3683 (defun bidi-string-mark-left-to-right (str)
3684 "Return a string that can be safely inserted in left-to-right text.
3686 Normally, inserting a string with right-to-left (RTL) script into
3687 a buffer may cause some subsequent text to be displayed as part
3688 of the RTL segment (usually this affects punctuation characters).
3689 This function returns a string which displays as STR but forces
3690 subsequent text to be displayed as left-to-right.
3692 If STR contains any RTL character, this function returns a string
3693 consisting of STR followed by an invisible left-to-right mark
3694 \(LRM) character. Otherwise, it returns STR."
3695 (unless (stringp str)
3696 (signal 'wrong-type-argument (list 'stringp str)))
3697 (if (string-match "\\cR" str)
3698 (concat str (propertize (string ?\x200e) 'invisible t))
3701 ;;;; Specifying things to do later.
3703 (defun load-history-regexp (file)
3704 "Form a regexp to find FILE in `load-history'.
3705 FILE, a string, is described in the function `eval-after-load'."
3706 (if (file-name-absolute-p file)
3707 (setq file (file-truename file)))
3708 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
3710 (if (file-name-extension file)
3712 ;; Note: regexp-opt can't be used here, since we need to call
3713 ;; this before Emacs has been fully started. 2006-05-21
3714 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
3715 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
3718 (defun load-history-filename-element (file-regexp)
3719 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
3720 Return nil if there isn't one."
3721 (let* ((loads load-history)
3722 (load-elt (and loads (car loads))))
3725 (or (null (car load-elt))
3726 (not (string-match file-regexp (car load-elt)))))
3727 (setq loads (cdr loads)
3728 load-elt (and loads (car loads)))))
3731 (put 'eval-after-load 'lisp-indent-function 1)
3732 (defun eval-after-load (file form)
3733 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
3734 If FILE is already loaded, evaluate FORM right now.
3735 FORM can be an Elisp expression (in which case it's passed to `eval'),
3736 or a function (in which case it's passed to `funcall' with no argument).
3738 If a matching file is loaded again, FORM will be evaluated again.
3740 If FILE is a string, it may be either an absolute or a relative file
3741 name, and may have an extension (e.g. \".el\") or may lack one, and
3742 additionally may or may not have an extension denoting a compressed
3743 format (e.g. \".gz\").
3745 When FILE is absolute, this first converts it to a true name by chasing
3746 symbolic links. Only a file of this name (see next paragraph regarding
3747 extensions) will trigger the evaluation of FORM. When FILE is relative,
3748 a file whose absolute true name ends in FILE will trigger evaluation.
3750 When FILE lacks an extension, a file name with any extension will trigger
3751 evaluation. Otherwise, its extension must match FILE's. A further
3752 extension for a compressed format (e.g. \".gz\") on FILE will not affect
3755 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
3756 is evaluated at the end of any file that `provide's this feature.
3757 If the feature is provided when evaluating code not associated with a
3758 file, FORM is evaluated immediately after the provide statement.
3760 Usually FILE is just a library name like \"font-lock\" or a feature name
3763 This function makes or adds to an entry on `after-load-alist'."
3764 (declare (compiler-macro
3766 (if (eq 'quote (car-safe form))
3767 ;; Quote with lambda so the compiler can look inside.
3768 `(eval-after-load ,file (lambda () ,(nth 1 form)))
3770 ;; Add this FORM into after-load-alist (regardless of whether we'll be
3771 ;; evaluating it now).
3772 (let* ((regexp-or-feature
3774 (setq file (purecopy (load-history-regexp file)))
3776 (elt (assoc regexp-or-feature after-load-alist))
3778 (if (functionp form) form
3779 ;; Try to use the "current" lexical/dynamic mode for `form'.
3780 (eval `(lambda () ,form) lexical-binding))))
3782 (setq elt (list regexp-or-feature))
3783 (push elt after-load-alist))
3784 ;; Is there an already loaded file whose name (or `provide' name)
3786 (prog1 (if (if (stringp file)
3787 (load-history-filename-element regexp-or-feature)
3791 (if (not (symbolp regexp-or-feature)) func
3792 ;; For features, the after-load-alist elements get run when
3793 ;; `provide' is called rather than at the end of the file.
3794 ;; So add an indirection to make sure that `func' is really run
3795 ;; "after-load" in case the provide call happens early.
3797 (if (not load-file-name)
3798 ;; Not being provided from a file, run func right now.
3800 (let ((lfn load-file-name)
3801 ;; Don't use letrec, because equal (in
3802 ;; add/remove-hook) would get trapped in a cycle.
3803 (fun (make-symbol "eval-after-load-helper")))
3804 (fset fun (lambda (file)
3805 (when (equal file lfn)
3806 (remove-hook 'after-load-functions fun)
3808 (add-hook 'after-load-functions fun 'append)))))))
3809 ;; Add FORM to the element unless it's already there.
3810 (unless (member delayed-func (cdr elt))
3811 (nconc elt (list delayed-func)))))))
3813 (defmacro with-eval-after-load (file &rest body)
3814 "Execute BODY after FILE is loaded.
3815 FILE is normally a feature name, but it can also be a file name,
3816 in case that file does not provide any feature."
3817 (declare (indent 1) (debug t))
3818 `(eval-after-load ,file (lambda () ,@body)))
3820 (defvar after-load-functions nil
3821 "Special hook run after loading a file.
3822 Each function there is called with a single argument, the absolute
3823 name of the file just loaded.")
3825 (defun do-after-load-evaluation (abs-file)
3826 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
3827 ABS-FILE, a string, should be the absolute true name of a file just loaded.
3828 This function is called directly from the C code."
3829 ;; Run the relevant eval-after-load forms.
3830 (dolist (a-l-element after-load-alist)
3831 (when (and (stringp (car a-l-element))
3832 (string-match-p (car a-l-element) abs-file))
3833 ;; discard the file name regexp
3834 (mapc #'funcall (cdr a-l-element))))
3835 ;; Complain when the user uses obsolete files.
3836 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
3837 ;; Maybe we should just use display-warning? This seems yucky...
3838 (let* ((file (file-name-nondirectory abs-file))
3839 (msg (format "Package %s is obsolete!"
3841 (string-match "\\.elc?\\>" file)))))
3842 ;; Cribbed from cl--compiling-file.
3843 (if (and (boundp 'byte-compile--outbuffer)
3844 (bufferp (symbol-value 'byte-compile--outbuffer))
3845 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
3846 " *Compiler Output*"))
3847 ;; Don't warn about obsolete files using other obsolete files.
3848 (unless (and (stringp byte-compile-current-file)
3849 (string-match-p "/obsolete/[^/]*\\'"
3851 byte-compile-current-file
3852 byte-compile-root-dir)))
3853 (byte-compile-log-warning msg))
3854 (run-with-timer 0 nil
3859 ;; Finally, run any other hook.
3860 (run-hook-with-args 'after-load-functions abs-file))
3862 (defun eval-next-after-load (file)
3863 "Read the following input sexp, and run it whenever FILE is loaded.
3864 This makes or adds to an entry on `after-load-alist'.
3865 FILE should be the name of a library, with no directory name."
3866 (declare (obsolete eval-after-load "23.2"))
3867 (eval-after-load file (read)))
3870 (defun display-delayed-warnings ()
3871 "Display delayed warnings from `delayed-warnings-list'.
3872 Used from `delayed-warnings-hook' (which see)."
3873 (dolist (warning (nreverse delayed-warnings-list))
3874 (apply 'display-warning warning))
3875 (setq delayed-warnings-list nil))
3877 (defun collapse-delayed-warnings ()
3878 "Remove duplicates from `delayed-warnings-list'.
3879 Collapse identical adjacent warnings into one (plus count).
3880 Used from `delayed-warnings-hook' (which see)."
3883 (while delayed-warnings-list
3884 (setq warning (pop delayed-warnings-list))
3885 (if (equal warning (car delayed-warnings-list))
3886 (setq count (1+ count))
3888 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
3891 (push warning collapsed)))
3892 (setq delayed-warnings-list (nreverse collapsed))))
3894 ;; At present this is only used for Emacs internals.
3895 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
3896 (defvar delayed-warnings-hook '(collapse-delayed-warnings
3897 display-delayed-warnings)
3898 "Normal hook run to process and display delayed warnings.
3899 By default, this hook contains functions to consolidate the
3900 warnings listed in `delayed-warnings-list', display them, and set
3901 `delayed-warnings-list' back to nil.")
3903 (defun delay-warning (type message &optional level buffer-name)
3904 "Display a delayed warning.
3905 Aside from going through `delayed-warnings-list', this is equivalent
3906 to `display-warning'."
3907 (push (list type message level buffer-name) delayed-warnings-list))
3910 ;;;; invisibility specs
3912 (defun add-to-invisibility-spec (element)
3913 "Add ELEMENT to `buffer-invisibility-spec'.
3914 See documentation for `buffer-invisibility-spec' for the kind of elements
3916 (if (eq buffer-invisibility-spec t)
3917 (setq buffer-invisibility-spec (list t)))
3918 (setq buffer-invisibility-spec
3919 (cons element buffer-invisibility-spec)))
3921 (defun remove-from-invisibility-spec (element)
3922 "Remove ELEMENT from `buffer-invisibility-spec'."
3923 (if (consp buffer-invisibility-spec)
3924 (setq buffer-invisibility-spec
3925 (delete element buffer-invisibility-spec))))
3929 (defmacro with-syntax-table (table &rest body)
3930 "Evaluate BODY with syntax table of current buffer set to TABLE.
3931 The syntax table of the current buffer is saved, BODY is evaluated, and the
3932 saved table is restored, even in case of an abnormal exit.
3933 Value is what BODY returns."
3934 (declare (debug t) (indent 1))
3935 (let ((old-table (make-symbol "table"))
3936 (old-buffer (make-symbol "buffer")))
3937 `(let ((,old-table (syntax-table))
3938 (,old-buffer (current-buffer)))
3941 (set-syntax-table ,table)
3943 (save-current-buffer
3944 (set-buffer ,old-buffer)
3945 (set-syntax-table ,old-table))))))
3947 (defun make-syntax-table (&optional oldtable)
3948 "Return a new syntax table.
3949 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3950 from `standard-syntax-table' otherwise."
3951 (let ((table (make-char-table 'syntax-table nil)))
3952 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3955 (defun syntax-after (pos)
3956 "Return the raw syntax descriptor for the char after POS.
3957 If POS is outside the buffer's accessible portion, return nil."
3958 (unless (or (< pos (point-min)) (>= pos (point-max)))
3959 (let ((st (if parse-sexp-lookup-properties
3960 (get-char-property pos 'syntax-table))))
3962 (aref (or st (syntax-table)) (char-after pos))))))
3964 (defun syntax-class (syntax)
3965 "Return the code for the syntax class described by SYNTAX.
3967 SYNTAX should be a raw syntax descriptor; the return value is a
3968 integer which encodes the corresponding syntax class. See Info
3969 node `(elisp)Syntax Table Internals' for a list of codes.
3971 If SYNTAX is nil, return nil."
3972 (and syntax (logand (car syntax) 65535)))
3974 ;; Utility motion commands
3978 (defun forward-whitespace (arg)
3979 "Move point to the end of the next sequence of whitespace chars.
3980 Each such sequence may be a single newline, or a sequence of
3981 consecutive space and/or tab characters.
3982 With prefix argument ARG, do it ARG times if positive, or move
3983 backwards ARG times if negative."
3986 (re-search-forward "[ \t]+\\|\n" nil 'move arg)
3988 (if (re-search-backward "[ \t]+\\|\n" nil 'move)
3989 (or (eq (char-after (match-beginning 0)) ?\n)
3990 (skip-chars-backward " \t")))
3991 (setq arg (1+ arg)))))
3995 (defun forward-symbol (arg)
3996 "Move point to the next position that is the end of a symbol.
3997 A symbol is any sequence of characters that are in either the
3998 word constituent or symbol constituent syntax class.
3999 With prefix argument ARG, do it ARG times if positive, or move
4000 backwards ARG times if negative."
4003 (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
4005 (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
4006 (skip-syntax-backward "w_"))
4007 (setq arg (1+ arg)))))
4011 (defun forward-same-syntax (&optional arg)
4012 "Move point past all characters with the same syntax class.
4013 With prefix argument ARG, do it ARG times if positive, or move
4014 backwards ARG times if negative."
4016 (or arg (setq arg 1))
4018 (skip-syntax-backward
4019 (char-to-string (char-syntax (char-before))))
4020 (setq arg (1+ arg)))
4022 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4023 (setq arg (1- arg))))
4028 (defvar text-clone--maintaining nil)
4030 (defun text-clone--maintain (ol1 after beg end &optional _len)
4031 "Propagate the changes made under the overlay OL1 to the other clones.
4032 This is used on the `modification-hooks' property of text clones."
4033 (when (and after (not undo-in-progress)
4034 (not text-clone--maintaining)
4035 (overlay-start ol1))
4036 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4037 (setq beg (max beg (+ (overlay-start ol1) margin)))
4038 (setq end (min end (- (overlay-end ol1) margin)))
4041 (when (overlay-get ol1 'text-clone-syntax)
4042 ;; Check content of the clone's text.
4043 (let ((cbeg (+ (overlay-start ol1) margin))
4044 (cend (- (overlay-end ol1) margin)))
4047 (if (not (re-search-forward
4048 (overlay-get ol1 'text-clone-syntax) cend t))
4049 ;; Mark the overlay for deletion.
4051 (when (< (match-end 0) cend)
4052 ;; Shrink the clone at its end.
4053 (setq end (min end (match-end 0)))
4054 (move-overlay ol1 (overlay-start ol1)
4055 (+ (match-end 0) margin)))
4056 (when (> (match-beginning 0) cbeg)
4057 ;; Shrink the clone at its beginning.
4058 (setq beg (max (match-beginning 0) beg))
4059 (move-overlay ol1 (- (match-beginning 0) margin)
4060 (overlay-end ol1)))))))
4061 ;; Now go ahead and update the clones.
4062 (let ((head (- beg (overlay-start ol1)))
4063 (tail (- (overlay-end ol1) end))
4064 (str (buffer-substring beg end))
4066 (text-clone--maintaining t))
4067 (dolist (ol2 (overlay-get ol1 'text-clones))
4068 (let ((oe (overlay-end ol2)))
4069 (unless (or (eq ol1 ol2) (null oe))
4070 (setq nothing-left nil)
4071 (let ((mod-beg (+ (overlay-start ol2) head)))
4072 ;;(overlay-put ol2 'modification-hooks nil)
4073 (goto-char (- (overlay-end ol2) tail))
4074 (unless (> mod-beg (point))
4075 (save-excursion (insert str))
4076 (delete-region mod-beg (point)))
4077 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4079 (if nothing-left (delete-overlay ol1))))))))
4081 (defun text-clone-create (start end &optional spreadp syntax)
4082 "Create a text clone of START...END at point.
4083 Text clones are chunks of text that are automatically kept identical:
4084 changes done to one of the clones will be immediately propagated to the other.
4086 The buffer's content at point is assumed to be already identical to
4087 the one between START and END.
4088 If SYNTAX is provided it's a regexp that describes the possible text of
4089 the clones; the clone will be shrunk or killed if necessary to ensure that
4090 its text matches the regexp.
4091 If SPREADP is non-nil it indicates that text inserted before/after the
4092 clone should be incorporated in the clone."
4093 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4094 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4095 ;; (with a one-char margin at each end) with `t nil'.
4096 ;; We opted for a larger overlay because it behaves better in the case
4097 ;; where the clone is reduced to the empty string (we want the overlay to
4098 ;; stay when the clone's content is the empty string and we want to use
4099 ;; `evaporate' to make sure those overlays get deleted when needed).
4101 (let* ((pt-end (+ (point) (- end start)))
4102 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4104 (end-margin (if (or (not spreadp)
4105 (>= pt-end (point-max))
4106 (>= start (point-max)))
4108 ;; FIXME: Reuse overlays at point to extend dups!
4109 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4110 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4111 (dups (list ol1 ol2)))
4112 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4113 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4114 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4115 ;;(overlay-put ol1 'face 'underline)
4116 (overlay-put ol1 'evaporate t)
4117 (overlay-put ol1 'text-clones dups)
4119 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4120 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4121 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4122 ;;(overlay-put ol2 'face 'underline)
4123 (overlay-put ol2 'evaporate t)
4124 (overlay-put ol2 'text-clones dups)))
4126 ;;;; Mail user agents.
4128 ;; Here we include just enough for other packages to be able
4131 (defun define-mail-user-agent (symbol composefunc sendfunc
4132 &optional abortfunc hookvar)
4133 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4135 SYMBOL can be any Lisp symbol. Its function definition and/or
4136 value as a variable do not matter for this usage; we use only certain
4137 properties on its property list, to encode the rest of the arguments.
4139 COMPOSEFUNC is program callable function that composes an outgoing
4140 mail message buffer. This function should set up the basics of the
4141 buffer without requiring user interaction. It should populate the
4142 standard mail headers, leaving the `to:' and `subject:' headers blank
4145 COMPOSEFUNC should accept several optional arguments--the same
4146 arguments that `compose-mail' takes. See that function's documentation.
4148 SENDFUNC is the command a user would run to send the message.
4150 Optional ABORTFUNC is the command a user would run to abort the
4151 message. For mail packages that don't have a separate abort function,
4152 this can be `kill-buffer' (the equivalent of omitting this argument).
4154 Optional HOOKVAR is a hook variable that gets run before the message
4155 is actually sent. Callers that use the `mail-user-agent' may
4156 install a hook function temporarily on this hook variable.
4157 If HOOKVAR is nil, `mail-send-hook' is used.
4159 The properties used on SYMBOL are `composefunc', `sendfunc',
4160 `abortfunc', and `hookvar'."
4161 (put symbol 'composefunc composefunc)
4162 (put symbol 'sendfunc sendfunc)
4163 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4164 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4166 ;;;; Progress reporters.
4168 ;; Progress reporter has the following structure:
4170 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4177 ;; This weirdness is for optimization reasons: we want
4178 ;; `progress-reporter-update' to be as fast as possible, so
4179 ;; `(car reporter)' is better than `(aref reporter 0)'.
4181 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4182 ;; digits of precision, it doesn't really matter here. On the other
4183 ;; hand, it greatly simplifies the code.
4185 (defsubst progress-reporter-update (reporter &optional value)
4186 "Report progress of an operation in the echo area.
4187 REPORTER should be the result of a call to `make-progress-reporter'.
4189 If REPORTER is a numerical progress reporter---i.e. if it was
4190 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4191 `make-progress-reporter'---then VALUE should be a number between
4192 MIN-VALUE and MAX-VALUE.
4194 If REPORTER is a non-numerical reporter, VALUE should be nil.
4196 This function is relatively inexpensive. If the change since
4197 last update is too small or insufficient time has passed, it does
4199 (when (or (not (numberp value)) ; For pulsing reporter
4200 (>= value (car reporter))) ; For numerical reporter
4201 (progress-reporter-do-update reporter value)))
4203 (defun make-progress-reporter (message &optional min-value max-value
4204 current-value min-change min-time)
4205 "Return progress reporter object for use with `progress-reporter-update'.
4207 MESSAGE is shown in the echo area, with a status indicator
4208 appended to the end. When you call `progress-reporter-done', the
4209 word \"done\" is printed after the MESSAGE. You can change the
4210 MESSAGE of an existing progress reporter by calling
4211 `progress-reporter-force-update'.
4213 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4214 and final (100% complete) states of operation; the latter should
4215 be larger. In this case, the status message shows the percentage
4218 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4219 message shows a \"spinning\", non-numeric indicator.
4221 Optional CURRENT-VALUE is the initial progress; the default is
4223 Optional MIN-CHANGE is the minimal change in percents to report;
4225 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4226 and/or MAX-VALUE are nil.
4228 Optional MIN-TIME specifies the minimum interval time between
4229 echo area updates (default is 0.2 seconds.) If the function
4230 `float-time' is not present, time is not tracked at all. If the
4231 OS is not capable of measuring fractions of seconds, this
4232 parameter is effectively rounded up."
4233 (when (string-match "[[:alnum:]]\\'" message)
4234 (setq message (concat message "...")))
4236 (setq min-time 0.2))
4238 ;; Force a call to `message' now
4239 (cons (or min-value 0)
4240 (vector (if (and (fboundp 'float-time)
4246 (if min-change (max (min min-change 50) 1) 1)
4248 (progress-reporter-update reporter (or current-value min-value))
4251 (defun progress-reporter-force-update (reporter &optional value new-message)
4252 "Report progress of an operation in the echo area unconditionally.
4254 The first two arguments are the same as in `progress-reporter-update'.
4255 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4256 (let ((parameters (cdr reporter)))
4258 (aset parameters 3 new-message))
4259 (when (aref parameters 0)
4260 (aset parameters 0 (float-time)))
4261 (progress-reporter-do-update reporter value)))
4263 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4264 "Characters to use for pulsing progress reporters.")
4266 (defun progress-reporter-do-update (reporter value)
4267 (let* ((parameters (cdr reporter))
4268 (update-time (aref parameters 0))
4269 (min-value (aref parameters 1))
4270 (max-value (aref parameters 2))
4271 (text (aref parameters 3))
4272 (current-time (float-time))
4274 ;; See if enough time has passed since the last update.
4275 (or (not update-time)
4276 (when (>= current-time update-time)
4277 ;; Calculate time for the next update
4278 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4279 (cond ((and min-value max-value)
4280 ;; Numerical indicator
4281 (let* ((one-percent (/ (- max-value min-value) 100.0))
4282 (percentage (if (= max-value min-value)
4284 (truncate (/ (- value min-value)
4286 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4287 ;; message because not enough time has passed, use 1
4288 ;; instead of MIN-CHANGE. This makes delays between echo
4289 ;; area updates closer to MIN-TIME.
4291 (min (+ min-value (* (+ percentage
4292 (if enough-time-passed
4298 (when (integerp value)
4299 (setcar reporter (ceiling (car reporter))))
4300 ;; Only print message if enough time has passed
4301 (when enough-time-passed
4302 (if (> percentage 0)
4303 (message "%s%d%%" text percentage)
4304 (message "%s" text)))))
4305 ;; Pulsing indicator
4307 (let ((index (mod (1+ (car reporter)) 4))
4308 (message-log-max nil))
4309 (setcar reporter index)
4312 (aref progress-reporter--pulse-characters
4315 (defun progress-reporter-done (reporter)
4316 "Print reporter's message followed by word \"done\" in echo area."
4317 (message "%sdone" (aref (cdr reporter) 3)))
4319 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4320 "Loop a certain number of times and report progress in the echo area.
4321 Evaluate BODY with VAR bound to successive integers running from
4322 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4323 the return value (nil if RESULT is omitted).
4325 At each iteration MESSAGE followed by progress percentage is
4326 printed in the echo area. After the loop is finished, MESSAGE
4327 followed by word \"done\" is printed. This macro is a
4328 convenience wrapper around `make-progress-reporter' and friends.
4330 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4331 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4332 (let ((temp (make-symbol "--dotimes-temp--"))
4333 (temp2 (make-symbol "--dotimes-temp2--"))
4337 (,(car spec) ,start)
4338 (,temp2 (make-progress-reporter ,message ,start ,end)))
4339 (while (< ,(car spec) ,temp)
4341 (progress-reporter-update ,temp2
4342 (setq ,(car spec) (1+ ,(car spec)))))
4343 (progress-reporter-done ,temp2)
4344 nil ,@(cdr (cdr spec)))))
4347 ;;;; Comparing version strings.
4349 (defconst version-separator "."
4350 "Specify the string used to separate the version elements.
4352 Usually the separator is \".\", but it can be any other string.")
4355 (defconst version-regexp-alist
4356 '(("^[-_+ ]?snapshot$" . -4)
4357 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4359 ;; treat "1.2.3-CVS" as snapshot release
4360 ("^[-_+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4)
4361 ("^[-_+ ]?alpha$" . -3)
4362 ("^[-_+ ]?beta$" . -2)
4363 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
4364 "Specify association between non-numeric version and its priority.
4366 This association is used to handle version string like \"1.0pre2\",
4367 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4368 non-numeric part of a version string to an integer. For example:
4370 String Version Integer List Version
4371 \"0.9snapshot\" (0 9 -4)
4372 \"1.0-git\" (1 0 -4)
4373 \"1.0pre2\" (1 0 -1 2)
4374 \"1.0PRE2\" (1 0 -1 2)
4375 \"22.8beta3\" (22 8 -2 3)
4376 \"22.8 Beta3\" (22 8 -2 3)
4377 \"0.9alpha1\" (0 9 -3 1)
4378 \"0.9AlphA1\" (0 9 -3 1)
4379 \"0.9 alpha\" (0 9 -3)
4381 Each element has the following form:
4387 REGEXP regexp used to match non-numeric part of a version string.
4388 It should begin with the `^' anchor and end with a `$' to
4389 prevent false hits. Letter-case is ignored while matching
4392 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4395 (defun version-to-list (ver)
4396 "Convert version string VER into a list of integers.
4398 The version syntax is given by the following EBNF:
4400 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4402 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4404 SEPARATOR ::= `version-separator' (which see)
4405 | `version-regexp-alist' (which see).
4407 The NUMBER part is optional if SEPARATOR is a match for an element
4408 in `version-regexp-alist'.
4410 Examples of valid version syntax:
4412 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4414 Examples of invalid version syntax:
4416 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4418 Examples of version conversion:
4420 Version String Version as a List of Integers
4421 \"1.0.7.5\" (1 0 7 5)
4422 \"1.0pre2\" (1 0 -1 2)
4423 \"1.0PRE2\" (1 0 -1 2)
4424 \"22.8beta3\" (22 8 -2 3)
4425 \"22.8Beta3\" (22 8 -2 3)
4426 \"0.9alpha1\" (0 9 -3 1)
4427 \"0.9AlphA1\" (0 9 -3 1)
4428 \"0.9alpha\" (0 9 -3)
4429 \"0.9snapshot\" (0 9 -4)
4430 \"1.0-git\" (1 0 -4)
4432 See documentation for `version-separator' and `version-regexp-alist'."
4433 (or (and (stringp ver) (> (length ver) 0))
4434 (error "Invalid version string: '%s'" ver))
4435 ;; Change .x.y to 0.x.y
4436 (if (and (>= (length ver) (length version-separator))
4437 (string-equal (substring ver 0 (length version-separator))
4439 (setq ver (concat "0" ver)))
4442 (case-fold-search t) ; ignore case in matching
4444 (while (and (setq s (string-match "[0-9]+" ver i))
4446 ;; handle numeric part
4447 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4450 ;; handle non-numeric part
4451 (when (and (setq s (string-match "[^0-9]+" ver i))
4453 (setq s (substring ver i (match-end 0))
4455 ;; handle alpha, beta, pre, etc. separator
4456 (unless (string= s version-separator)
4457 (setq al version-regexp-alist)
4458 (while (and al (not (string-match (caar al) s)))
4461 (push (cdar al) lst))
4462 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4463 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4464 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4466 (t (error "Invalid version syntax: '%s'" ver))))))
4468 (error "Invalid version syntax: '%s'" ver)
4472 (defun version-list-< (l1 l2)
4473 "Return t if L1, a list specification of a version, is lower than L2.
4475 Note that a version specified by the list (1) is equal to (1 0),
4476 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4477 Also, a version given by the list (1) is higher than (1 -1), which in
4478 turn is higher than (1 -2), which is higher than (1 -3)."
4479 (while (and l1 l2 (= (car l1) (car l2)))
4483 ;; l1 not null and l2 not null
4484 ((and l1 l2) (< (car l1) (car l2)))
4485 ;; l1 null and l2 null ==> l1 length = l2 length
4486 ((and (null l1) (null l2)) nil)
4487 ;; l1 not null and l2 null ==> l1 length > l2 length
4488 (l1 (< (version-list-not-zero l1) 0))
4489 ;; l1 null and l2 not null ==> l2 length > l1 length
4490 (t (< 0 (version-list-not-zero l2)))))
4493 (defun version-list-= (l1 l2)
4494 "Return t if L1, a list specification of a version, is equal to L2.
4496 Note that a version specified by the list (1) is equal to (1 0),
4497 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4498 Also, a version given by the list (1) is higher than (1 -1), which in
4499 turn is higher than (1 -2), which is higher than (1 -3)."
4500 (while (and l1 l2 (= (car l1) (car l2)))
4504 ;; l1 not null and l2 not null
4506 ;; l1 null and l2 null ==> l1 length = l2 length
4507 ((and (null l1) (null l2)))
4508 ;; l1 not null and l2 null ==> l1 length > l2 length
4509 (l1 (zerop (version-list-not-zero l1)))
4510 ;; l1 null and l2 not null ==> l2 length > l1 length
4511 (t (zerop (version-list-not-zero l2)))))
4514 (defun version-list-<= (l1 l2)
4515 "Return t if L1, a list specification of a version, is lower or equal to L2.
4517 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4518 etc. That is, the trailing zeroes are insignificant. Also, integer
4519 list (1) is greater than (1 -1) which is greater than (1 -2)
4520 which is greater than (1 -3)."
4521 (while (and l1 l2 (= (car l1) (car l2)))
4525 ;; l1 not null and l2 not null
4526 ((and l1 l2) (< (car l1) (car l2)))
4527 ;; l1 null and l2 null ==> l1 length = l2 length
4528 ((and (null l1) (null l2)))
4529 ;; l1 not null and l2 null ==> l1 length > l2 length
4530 (l1 (<= (version-list-not-zero l1) 0))
4531 ;; l1 null and l2 not null ==> l2 length > l1 length
4532 (t (<= 0 (version-list-not-zero l2)))))
4534 (defun version-list-not-zero (lst)
4535 "Return the first non-zero element of LST, which is a list of integers.
4537 If all LST elements are zeros or LST is nil, return zero."
4538 (while (and lst (zerop (car lst)))
4539 (setq lst (cdr lst)))
4542 ;; there is no element different of zero
4546 (defun version< (v1 v2)
4547 "Return t if version V1 is lower (older) than V2.
4549 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4550 etc. That is, the trailing \".0\"s are insignificant. Also, version
4551 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4552 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4553 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4554 (version-list-< (version-to-list v1) (version-to-list v2)))
4556 (defun version<= (v1 v2)
4557 "Return t if version V1 is lower (older) than or equal to V2.
4559 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4560 etc. That is, the trailing \".0\"s are insignificant. Also, version
4561 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4562 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4563 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4564 (version-list-<= (version-to-list v1) (version-to-list v2)))
4566 (defun version= (v1 v2)
4567 "Return t if version V1 is equal to V2.
4569 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4570 etc. That is, the trailing \".0\"s are insignificant. Also, version
4571 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4572 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4573 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4574 (version-list-= (version-to-list v1) (version-to-list v2)))
4578 (defconst menu-bar-separator '("--")
4579 "Separator for menus.")
4581 ;; The following statement ought to be in print.c, but `provide' can't
4583 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4584 (when (hash-table-p (car (read-from-string
4585 (prin1-to-string (make-hash-table)))))
4586 (provide 'hashtable-print-readable))
4588 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
4589 ;; generate file names for autoloads, custom-deps, and finder-data.
4590 (defun unmsys--file-name (file)
4591 "Produce the canonical file name for FILE from its MSYS form.
4593 On systems other than MS-Windows, just returns FILE.
4594 On MS-Windows, converts /d/foo/bar form of file names
4595 passed by MSYS Make into d:/foo/bar that Emacs can grok.
4597 This function is called from lisp/Makefile and leim/Makefile."
4598 (when (and (eq system-type 'windows-nt)
4599 (string-match "\\`/[a-zA-Z]/" file))
4600 (setq file (concat (substring file 1 2) ":" (substring file 2))))
4604 ;;; subr.el ends here