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
))
151 (eval `(let ((newelt ',newelt
)
153 (macroexp-let2 macroexp-copyable-p v newelt
154 (gv-letplace (getter setter
) place
155 (funcall setter
(list 'cons v getter
))))))))
157 (defmacro pop
(place)
158 "Return the first element of PLACE's value, and remove it from the list.
159 PLACE must be a generalized variable whose value is a list.
160 If the value is nil, `pop' returns nil but does not actually
162 (declare (debug (gv-place)))
163 ;; We use `car-safe' here instead of `car' because the behavior is the same
164 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
165 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
166 ;; result is not used.
169 ;; So we can use `pop' in the bootstrap before `gv' can be used.
170 (list 'prog1 place
(list 'setq place
(list 'cdr place
)))
171 (gv-letplace (getter setter
) place
172 `(prog1 ,getter
,(funcall setter
`(cdr ,getter
)))))))
174 (defmacro when
(cond &rest body
)
175 "If COND yields non-nil, do BODY, else return nil.
176 When COND yields non-nil, eval BODY forms sequentially and return
177 value of last one, or nil if there are none.
180 (declare (indent 1) (debug t
))
181 (list 'if cond
(cons 'progn body
)))
183 (defmacro unless
(cond &rest body
)
184 "If COND yields nil, do BODY, else return nil.
185 When COND yields nil, eval BODY forms sequentially and return
186 value of last one, or nil if there are none.
189 (declare (indent 1) (debug t
))
190 (cons 'if
(cons cond
(cons nil body
))))
192 (defmacro dotimes
(spec &rest body
)
193 "Loop a certain number of times.
194 Evaluate BODY with VAR bound to successive integers running from 0,
195 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
196 the return value (nil if RESULT is omitted).
198 \(fn (VAR COUNT [RESULT]) BODY...)"
199 (declare (indent 1) (debug dolist
))
200 ;; It would be cleaner to create an uninterned symbol,
201 ;; but that uses a lot more space when many functions in many files
203 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
204 (let ((temp '--dotimes-limit--
)
207 ;; This is not a reliable test, but it does not matter because both
208 ;; semantics are acceptable, tho one is slightly faster with dynamic
209 ;; scoping and the other has cleaner semantics.
211 (let ((counter '--dotimes-counter--
))
214 (while (< ,counter
,temp
)
215 (let ((,(car spec
) ,counter
))
217 (setq ,counter
(1+ ,counter
)))
219 ;; FIXME: This let often leads to "unused var" warnings.
220 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
222 (,(car spec
) ,start
))
223 (while (< ,(car spec
) ,temp
)
225 (setq ,(car spec
) (1+ ,(car spec
))))
226 ,@(cdr (cdr spec
))))))
228 (defmacro declare
(&rest _specs
)
229 "Do not evaluate any arguments, and return nil.
230 If a `declare' form appears as the first form in the body of a
231 `defun' or `defmacro' form, SPECS specifies various additional
232 information about the function or macro; these go into effect
233 during the evaluation of the `defun' or `defmacro' form.
235 The possible values of SPECS are specified by
236 `defun-declarations-alist' and `macro-declarations-alist'.
238 For more information, see info node `(elisp)Declare Form'."
239 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
242 (defmacro ignore-errors
(&rest body
)
243 "Execute BODY; if an error occurs, return nil.
244 Otherwise, return result of last form in BODY.
245 See also `with-demoted-errors' that does something similar
246 without silencing all errors."
247 (declare (debug t
) (indent 0))
248 `(condition-case nil
(progn ,@body
) (error nil
)))
250 ;;;; Basic Lisp functions.
252 (defun ignore (&rest _ignore
)
253 "Do nothing and return nil.
254 This function accepts any number of arguments, but ignores them."
258 ;; Signal a compile-error if the first arg is missing.
259 (defun error (&rest args
)
260 "Signal an error, making error message by passing all args to `format'.
261 In Emacs, the convention is that error messages start with a capital
262 letter but *do not* end with a period. Please follow this convention
263 for the sake of consistency."
264 (declare (advertised-calling-convention (string &rest args
) "23.1"))
265 (signal 'error
(list (apply 'format args
))))
267 (defun user-error (format &rest args
)
268 "Signal a pilot error, making error message by passing all args to `format'.
269 In Emacs, the convention is that error messages start with a capital
270 letter but *do not* end with a period. Please follow this convention
271 for the sake of consistency.
272 This is just like `error' except that `user-error's are expected to be the
273 result of an incorrect manipulation on the part of the user, rather than the
274 result of an actual problem."
275 (signal 'user-error
(list (apply #'format format args
))))
277 (defun define-error (name message
&optional parent
)
278 "Define NAME as a new error signal.
279 MESSAGE is a string that will be output to the echo area if such an error
280 is signaled without being caught by a `condition-case'.
281 PARENT is either a signal or a list of signals from which it inherits.
282 Defaults to `error'."
283 (unless parent
(setq parent
'error
))
287 (mapcar (lambda (parent)
289 (or (get parent
'error-conditions
)
290 (error "Unknown signal `%s'" parent
))))
292 (cons parent
(get parent
'error-conditions
)))))
293 (put name
'error-conditions
294 (delete-dups (copy-sequence (cons name conditions
))))
295 (when message
(put name
'error-message message
))))
297 ;; We put this here instead of in frame.el so that it's defined even on
298 ;; systems where frame.el isn't loaded.
299 (defun frame-configuration-p (object)
300 "Return non-nil if OBJECT seems to be a frame configuration.
301 Any list whose car is `frame-configuration' is assumed to be a frame
304 (eq (car object
) 'frame-configuration
)))
310 "Return the car of the car of X."
314 "Return the car of the cdr of X."
318 "Return the cdr of the car of X."
322 "Return the cdr of the cdr of X."
325 (defun last (list &optional n
)
326 "Return the last link of LIST. Its car is the last element.
327 If LIST is nil, return nil.
328 If N is non-nil, return the Nth-to-last link of LIST.
329 If N is bigger than the length of LIST, return LIST."
332 (let ((m (safe-length list
)))
333 (if (< n m
) (nthcdr (- m n
) list
) list
)))
335 (nthcdr (1- (safe-length list
)) list
))))
337 (defun butlast (list &optional n
)
338 "Return a copy of LIST with the last N elements removed.
339 If N is omitted or nil, the last element is removed from the
341 (if (and n
(<= n
0)) list
342 (nbutlast (copy-sequence list
) n
)))
344 (defun nbutlast (list &optional n
)
345 "Modifies LIST to remove the last N elements.
346 If N is omitted or nil, remove the last element."
347 (let ((m (length list
)))
351 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
354 (defun zerop (number)
355 "Return t if NUMBER is zero."
356 ;; Used to be in C, but it's pointless since (= 0 n) is faster anyway because
357 ;; = has a byte-code.
358 (declare (compiler-macro (lambda (_) `(= 0 ,number
))))
361 (defun delete-dups (list)
362 "Destructively remove `equal' duplicates from LIST.
363 Store the result in LIST and return it. LIST must be a proper list.
364 Of several `equal' occurrences of an element in LIST, the first
368 (setcdr tail
(delete (car tail
) (cdr tail
)))
369 (setq tail
(cdr tail
))))
372 ;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html
373 (defun delete-consecutive-dups (list &optional circular
)
374 "Destructively remove `equal' consecutive duplicates from LIST.
375 First and last elements are considered consecutive if CIRCULAR is
377 (let ((tail list
) last
)
379 (if (equal (car tail
) (cadr tail
))
380 (setcdr tail
(cddr tail
))
381 (setq last
(car tail
)
385 (equal last
(car list
)))
389 (defun number-sequence (from &optional to inc
)
390 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
391 INC is the increment used between numbers in the sequence and defaults to 1.
392 So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
393 zero. TO is only included if there is an N for which TO = FROM + N * INC.
394 If TO is nil or numerically equal to FROM, return (FROM).
395 If INC is positive and TO is less than FROM, or INC is negative
396 and TO is larger than FROM, return nil.
397 If INC is zero and TO is neither nil nor numerically equal to
398 FROM, signal an error.
400 This function is primarily designed for integer arguments.
401 Nevertheless, FROM, TO and INC can be integer or float. However,
402 floating point arithmetic is inexact. For instance, depending on
403 the machine, it may quite well happen that
404 \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
405 whereas (number-sequence 0.4 0.8 0.2) returns a list with three
406 elements. Thus, if some of the arguments are floats and one wants
407 to make sure that TO is included, one may have to explicitly write
408 TO as (+ FROM (* N INC)) or use a variable whose value was
409 computed with this exact expression. Alternatively, you can,
410 of course, also replace TO with a slightly larger value
411 \(or a slightly more negative value if INC is negative)."
412 (if (or (not to
) (= from to
))
414 (or inc
(setq inc
1))
415 (when (zerop inc
) (error "The increment can not be zero"))
416 (let (seq (n 0) (next from
))
419 (setq seq
(cons next seq
)
421 next
(+ from
(* n inc
))))
423 (setq seq
(cons next seq
)
425 next
(+ from
(* n inc
)))))
428 (defun copy-tree (tree &optional vecp
)
429 "Make a copy of TREE.
430 If TREE is a cons cell, this recursively copies both its car and its cdr.
431 Contrast to `copy-sequence', which copies only along the cdrs. With second
432 argument VECP, this copies vectors as well as conses."
436 (let ((newcar (car tree
)))
437 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
438 (setq newcar
(copy-tree (car tree
) vecp
)))
439 (push newcar result
))
440 (setq tree
(cdr tree
)))
441 (nconc (nreverse result
) tree
))
442 (if (and vecp
(vectorp tree
))
443 (let ((i (length (setq tree
(copy-sequence tree
)))))
444 (while (>= (setq i
(1- i
)) 0)
445 (aset tree i
(copy-tree (aref tree i
) vecp
)))
449 ;;;; Various list-search functions.
451 (defun assoc-default (key alist
&optional test default
)
452 "Find object KEY in a pseudo-alist ALIST.
453 ALIST is a list of conses or objects. Each element
454 (or the element's car, if it is a cons) is compared with KEY by
455 calling TEST, with two arguments: (i) the element or its car,
457 If that is non-nil, the element matches; then `assoc-default'
458 returns the element's cdr, if it is a cons, or DEFAULT if the
459 element is not a cons.
461 If no element matches, the value is nil.
462 If TEST is omitted or nil, `equal' is used."
463 (let (found (tail alist
) value
)
464 (while (and tail
(not found
))
465 (let ((elt (car tail
)))
466 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
467 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
468 (setq tail
(cdr tail
)))
471 (defun assoc-ignore-case (key alist
)
472 "Like `assoc', but ignores differences in case and text representation.
473 KEY must be a string. Upper-case and lower-case letters are treated as equal.
474 Unibyte strings are converted to multibyte for comparison."
475 (declare (obsolete assoc-string
"22.1"))
476 (assoc-string key alist t
))
478 (defun assoc-ignore-representation (key alist
)
479 "Like `assoc', but ignores differences in text representation.
480 KEY must be a string.
481 Unibyte strings are converted to multibyte for comparison."
482 (declare (obsolete assoc-string
"22.1"))
483 (assoc-string key alist nil
))
485 (defun member-ignore-case (elt list
)
486 "Like `member', but ignore differences in case and text representation.
487 ELT must be a string. Upper-case and lower-case letters are treated as equal.
488 Unibyte strings are converted to multibyte for comparison.
489 Non-strings in LIST are ignored."
491 (not (and (stringp (car list
))
492 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
493 (setq list
(cdr list
)))
496 (defun assq-delete-all (key alist
)
497 "Delete from ALIST all elements whose car is `eq' to KEY.
498 Return the modified alist.
499 Elements of ALIST that are not conses are ignored."
500 (while (and (consp (car alist
))
501 (eq (car (car alist
)) key
))
502 (setq alist
(cdr alist
)))
503 (let ((tail alist
) tail-cdr
)
504 (while (setq tail-cdr
(cdr tail
))
505 (if (and (consp (car tail-cdr
))
506 (eq (car (car tail-cdr
)) key
))
507 (setcdr tail
(cdr tail-cdr
))
508 (setq tail tail-cdr
))))
511 (defun rassq-delete-all (value alist
)
512 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
513 Return the modified alist.
514 Elements of ALIST that are not conses are ignored."
515 (while (and (consp (car alist
))
516 (eq (cdr (car alist
)) value
))
517 (setq alist
(cdr alist
)))
518 (let ((tail alist
) tail-cdr
)
519 (while (setq tail-cdr
(cdr tail
))
520 (if (and (consp (car tail-cdr
))
521 (eq (cdr (car tail-cdr
)) value
))
522 (setcdr tail
(cdr tail-cdr
))
523 (setq tail tail-cdr
))))
526 (defun remove (elt seq
)
527 "Return a copy of SEQ with all occurrences of ELT removed.
528 SEQ must be a list, vector, or string. The comparison is done with `equal'."
530 ;; If SEQ isn't a list, there's no need to copy SEQ because
531 ;; `delete' will return a new object.
533 (delete elt
(copy-sequence seq
))))
535 (defun remq (elt list
)
536 "Return LIST with all occurrences of ELT removed.
537 The comparison is done with `eq'. Contrary to `delq', this does not use
538 side-effects, and the argument LIST is not modified."
539 (while (and (eq elt
(car list
)) (setq list
(cdr list
))))
541 (delq elt
(copy-sequence list
))
547 "Convert KEYS to the internal Emacs key representation.
548 KEYS should be a string constant in the format used for
549 saving keyboard macros (see `edmacro-mode')."
550 ;; Don't use a defalias, since the `pure' property is only true for
551 ;; the calling convention of `kbd'.
552 (read-kbd-macro keys
))
556 "Beep to tell the user this binding is undefined."
559 (message "%s is undefined" (key-description (this-single-command-keys)))
560 (setq defining-kbd-macro nil
)
561 (force-mode-line-update)
562 ;; If this is a down-mouse event, don't reset prefix-arg;
563 ;; pass it to the command run by the up event.
565 (when (memq 'down
(event-modifiers last-command-event
))
566 current-prefix-arg
)))
568 ;; Prevent the \{...} documentation construct
569 ;; from mentioning keys that run this command.
570 (put 'undefined
'suppress-keymap t
)
572 (defun suppress-keymap (map &optional nodigits
)
573 "Make MAP override all normally self-inserting keys to be undefined.
574 Normally, as an exception, digits and minus-sign are set to make prefix args,
575 but optional second arg NODIGITS non-nil treats them like other chars."
576 (define-key map
[remap self-insert-command
] 'undefined
)
579 (define-key map
"-" 'negative-argument
)
580 ;; Make plain numbers do numeric args.
583 (define-key map
(char-to-string loop
) 'digit-argument
)
584 (setq loop
(1+ loop
))))))
586 (defun make-composed-keymap (maps &optional parent
)
587 "Construct a new keymap composed of MAPS and inheriting from PARENT.
588 When looking up a key in the returned map, the key is looked in each
589 keymap of MAPS in turn until a binding is found.
590 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
591 As always with keymap inheritance, a nil binding in MAPS overrides
592 any corresponding binding in PARENT, but it does not override corresponding
593 bindings in other keymaps of MAPS.
594 MAPS can be a list of keymaps or a single keymap.
595 PARENT if non-nil should be a keymap."
597 ,@(if (keymapp maps
) (list maps
) maps
)
600 (defun define-key-after (keymap key definition
&optional after
)
601 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
602 This is like `define-key' except that the binding for KEY is placed
603 just after the binding for the event AFTER, instead of at the beginning
604 of the map. Note that AFTER must be an event type (like KEY), NOT a command
607 If AFTER is t or omitted, the new binding goes at the end of the keymap.
608 AFTER should be a single event type--a symbol or a character, not a sequence.
610 Bindings are always added before any inherited map.
612 The order of bindings in a keymap only matters when it is used as
613 a menu, so this function is not useful for non-menu keymaps."
614 (unless after
(setq after t
))
616 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
618 (if (<= (length key
) 1) (aref key
0)
619 (setq keymap
(lookup-key keymap
621 (butlast (mapcar 'identity key
)))))
622 (aref key
(1- (length key
)))))
623 (let ((tail keymap
) done inserted
)
624 (while (and (not done
) tail
)
625 ;; Delete any earlier bindings for the same key.
626 (if (eq (car-safe (car (cdr tail
))) key
)
627 (setcdr tail
(cdr (cdr tail
))))
628 ;; If we hit an included map, go down that one.
629 (if (keymapp (car tail
)) (setq tail
(car tail
)))
630 ;; When we reach AFTER's binding, insert the new binding after.
631 ;; If we reach an inherited keymap, insert just before that.
632 ;; If we reach the end of this keymap, insert at the end.
633 (if (or (and (eq (car-safe (car tail
)) after
)
635 (eq (car (cdr tail
)) 'keymap
)
638 ;; Stop the scan only if we find a parent keymap.
639 ;; Keep going past the inserted element
640 ;; so we can delete any duplications that come later.
641 (if (eq (car (cdr tail
)) 'keymap
)
643 ;; Don't insert more than once.
645 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
647 (setq tail
(cdr tail
)))))
649 (defun map-keymap-sorted (function keymap
)
650 "Implement `map-keymap' with sorting.
651 Don't call this function; it is for internal use only."
653 (map-keymap (lambda (a b
) (push (cons a b
) list
))
655 (setq list
(sort list
657 (setq a
(car a
) b
(car b
))
659 (if (integerp b
) (< a b
)
662 ;; string< also accepts symbols.
665 (funcall function
(car p
) (cdr p
)))))
667 (defun keymap--menu-item-binding (val)
668 "Return the binding part of a menu-item."
670 ((not (consp val
)) val
) ;Not a menu-item.
671 ((eq 'menu-item
(car val
))
672 (let* ((binding (nth 2 val
))
673 (plist (nthcdr 3 val
))
674 (filter (plist-get plist
:filter
)))
675 (if filter
(funcall filter binding
)
677 ((and (consp (cdr val
)) (stringp (cadr val
)))
681 (t val
))) ;Not a menu-item either.
683 (defun keymap--menu-item-with-binding (item binding
)
684 "Build a menu-item like ITEM but with its binding changed to BINDING."
686 ((not (consp item
)) binding
) ;Not a menu-item.
687 ((eq 'menu-item
(car item
))
688 (setq item
(copy-sequence item
))
689 (let ((tail (nthcdr 2 item
)))
690 (setcar tail binding
)
691 ;; Remove any potential filter.
692 (if (plist-get (cdr tail
) :filter
)
693 (setcdr tail
(plist-put (cdr tail
) :filter nil
))))
695 ((and (consp (cdr item
)) (stringp (cadr item
)))
696 (cons (car item
) (cons (cadr item
) binding
)))
697 (t (cons (car item
) binding
))))
699 (defun keymap--merge-bindings (val1 val2
)
700 "Merge bindings VAL1 and VAL2."
701 (let ((map1 (keymap--menu-item-binding val1
))
702 (map2 (keymap--menu-item-binding val2
)))
703 (if (not (and (keymapp map1
) (keymapp map2
)))
704 ;; There's nothing to merge: val1 takes precedence.
706 (let ((map (list 'keymap map1 map2
))
707 (item (if (keymapp val1
) (if (keymapp val2
) nil val2
) val1
)))
708 (keymap--menu-item-with-binding item map
)))))
710 (defun keymap-canonicalize (map)
711 "Return a simpler equivalent keymap.
712 This resolves inheritance and redefinitions. The returned keymap
713 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
714 and use in active keymaps and menus.
715 Subkeymaps may be modified but are not canonicalized."
716 ;; FIXME: Problem with the difference between a nil binding
717 ;; that hides a binding in an inherited map and a nil binding that's ignored
718 ;; to let some further binding visible. Currently a nil binding hides all.
719 ;; FIXME: we may want to carefully (re)order elements in case they're
723 (prompt (keymap-prompt map
)))
725 (setq map
(map-keymap ;; -internal
728 ;; Treat char-ranges specially.
729 (push (cons key item
) ranges
)
730 (push (cons key item
) bindings
)))
732 ;; Create the new map.
733 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
734 (dolist (binding ranges
)
735 ;; Treat char-ranges specially. FIXME: need to merge as well.
736 (define-key map
(vector (car binding
)) (cdr binding
)))
737 ;; Process the bindings starting from the end.
738 (dolist (binding (prog1 bindings
(setq bindings
())))
739 (let* ((key (car binding
))
740 (oldbind (assq key bindings
)))
741 (push (if (not oldbind
)
742 ;; The normal case: no duplicate bindings.
744 ;; This is the second binding for this key.
745 (setq bindings
(delq oldbind bindings
))
746 (cons key
(keymap--merge-bindings (cdr binding
)
749 (nconc map bindings
)))
751 (put 'keyboard-translate-table
'char-table-extra-slots
0)
753 (defun keyboard-translate (from to
)
754 "Translate character FROM to TO on the current terminal.
755 This function creates a `keyboard-translate-table' if necessary
756 and then modifies one entry in it."
757 (or (char-table-p keyboard-translate-table
)
758 (setq keyboard-translate-table
759 (make-char-table 'keyboard-translate-table nil
)))
760 (aset keyboard-translate-table from to
))
762 ;;;; Key binding commands.
764 (defun global-set-key (key command
)
765 "Give KEY a global binding as COMMAND.
766 COMMAND is the command definition to use; usually it is
767 a symbol naming an interactively-callable function.
768 KEY is a key sequence; noninteractively, it is a string or vector
769 of characters or event types, and non-ASCII characters with codes
770 above 127 (such as ISO Latin-1) can be included if you use a vector.
772 Note that if KEY has a local binding in the current buffer,
773 that local binding will continue to shadow any global binding
774 that you make with this function."
775 (interactive "KSet key globally: \nCSet key %s to command: ")
776 (or (vectorp key
) (stringp key
)
777 (signal 'wrong-type-argument
(list 'arrayp key
)))
778 (define-key (current-global-map) key command
))
780 (defun local-set-key (key command
)
781 "Give KEY a local binding as COMMAND.
782 COMMAND is the command definition to use; usually it is
783 a symbol naming an interactively-callable function.
784 KEY is a key sequence; noninteractively, it is a string or vector
785 of characters or event types, and non-ASCII characters with codes
786 above 127 (such as ISO Latin-1) can be included if you use a vector.
788 The binding goes in the current buffer's local map, which in most
789 cases is shared with all other buffers in the same major mode."
790 (interactive "KSet key locally: \nCSet key %s locally to command: ")
791 (let ((map (current-local-map)))
793 (use-local-map (setq map
(make-sparse-keymap))))
794 (or (vectorp key
) (stringp key
)
795 (signal 'wrong-type-argument
(list 'arrayp key
)))
796 (define-key map key command
)))
798 (defun global-unset-key (key)
799 "Remove global binding of KEY.
800 KEY is a string or vector representing a sequence of keystrokes."
801 (interactive "kUnset key globally: ")
802 (global-set-key key nil
))
804 (defun local-unset-key (key)
805 "Remove local binding of KEY.
806 KEY is a string or vector representing a sequence of keystrokes."
807 (interactive "kUnset key locally: ")
808 (if (current-local-map)
809 (local-set-key key nil
))
812 ;;;; substitute-key-definition and its subroutines.
814 (defvar key-substitution-in-progress nil
815 "Used internally by `substitute-key-definition'.")
817 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
818 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
819 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
820 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
821 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
823 If you don't specify OLDMAP, you can usually get the same results
824 in a cleaner way with command remapping, like this:
825 (define-key KEYMAP [remap OLDDEF] NEWDEF)
826 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
827 ;; Don't document PREFIX in the doc string because we don't want to
828 ;; advertise it. It's meant for recursive calls only. Here's its
831 ;; If optional argument PREFIX is specified, it should be a key
832 ;; prefix, a string. Redefined bindings will then be bound to the
833 ;; original key, with PREFIX added at the front.
834 (or prefix
(setq prefix
""))
835 (let* ((scan (or oldmap keymap
))
836 (prefix1 (vconcat prefix
[nil]))
837 (key-substitution-in-progress
838 (cons scan key-substitution-in-progress)))
839 ;; Scan OLDMAP, finding each char or event-symbol that
840 ;; has any definition, and act on it with hack-key.
843 (aset prefix1 (length prefix) char)
844 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
847 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
848 (let (inner-def skipped menu-item)
849 ;; Find the actual command name within the binding.
850 (if (eq (car-safe defn) 'menu-item)
851 (setq menu-item defn defn (nth 2 defn))
852 ;; Skip past menu-prompt.
853 (while (stringp (car-safe defn))
854 (push (pop defn) skipped))
855 ;; Skip past cached key-equivalence data for menu items.
856 (if (consp (car-safe defn))
857 (setq defn (cdr defn))))
858 (if (or (eq defn olddef)
859 ;; Compare with equal if definition is a key sequence.
860 ;; That is useful for operating on function-key-map.
861 (and (or (stringp defn) (vectorp defn))
862 (equal defn olddef)))
863 (define-key keymap prefix
865 (let ((copy (copy-sequence menu-item)))
866 (setcar (nthcdr 2 copy) newdef)
868 (nconc (nreverse skipped) newdef)))
869 ;; Look past a symbol that names a keymap.
871 (or (indirect-function defn t) defn))
872 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
873 ;; avoid autoloading a keymap. This is mostly done to preserve the
874 ;; original non-autoloading behavior of pre-map-keymap times.
875 (if (and (keymapp inner-def)
876 ;; Avoid recursively scanning
877 ;; where KEYMAP does not have a submap.
878 (let ((elt (lookup-key keymap prefix)))
879 (or (null elt) (natnump elt) (keymapp elt)))
880 ;; Avoid recursively rescanning keymap being scanned.
881 (not (memq inner-def key-substitution-in-progress)))
882 ;; If this one isn't being scanned already, scan it now.
883 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
886 ;;;; The global keymap tree.
888 ;; global-map, esc-map, and ctl-x-map have their values set up in
889 ;; keymap.c; we just give them docstrings here.
891 (defvar global-map nil
892 "Default global keymap mapping Emacs keyboard input into commands.
893 The value is a keymap which is usually (but not necessarily) Emacs's
897 "Default keymap for ESC (meta) commands.
898 The normal global definition of the character ESC indirects to this keymap.")
900 (defvar ctl-x-map nil
901 "Default keymap for C-x commands.
902 The normal global definition of the character C-x indirects to this keymap.")
904 (defvar ctl-x-4-map (make-sparse-keymap)
905 "Keymap for subcommands of C-x 4.")
906 (defalias 'ctl-x-4-prefix ctl-x-4-map)
907 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
909 (defvar ctl-x-5-map (make-sparse-keymap)
910 "Keymap for frame commands.")
911 (defalias 'ctl-x-5-prefix ctl-x-5-map)
912 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
915 ;;;; Event manipulation functions.
917 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
919 (defun listify-key-sequence (key)
920 "Convert a key sequence to a list of events."
923 (mapcar (function (lambda (c)
925 (logxor c listify-key-sequence-1)
930 "True if the argument is an event object."
933 (and (symbolp obj) obj (not (keywordp obj)))
934 (and (consp obj) (symbolp (car obj))))))
936 (defun event-modifiers (event)
937 "Return a list of symbols representing the modifier keys in event EVENT.
938 The elements of the list may include `meta', `control',
939 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
941 EVENT may be an event or an event type. If EVENT is a symbol
942 that has never been used in an event that has been read as input
943 in the current Emacs session, then this function may fail to include
944 the `click' modifier."
947 (setq type (car type)))
949 ;; Don't read event-symbol-elements directly since we're not
950 ;; sure the symbol has already been parsed.
951 (cdr (internal-event-symbol-parse-modifiers type))
953 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
954 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
955 (if (not (zerop (logand type ?\M-\^@)))
957 (if (or (not (zerop (logand type ?\C-\^@)))
959 (push 'control list))
960 (if (or (not (zerop (logand type ?\S-\^@)))
961 (/= char (downcase char)))
963 (or (zerop (logand type ?\H-\^@))
965 (or (zerop (logand type ?\s-\^@))
967 (or (zerop (logand type ?\A-\^@))
971 (defun event-basic-type (event)
972 "Return the basic type of the given event (all modifiers removed).
973 The value is a printing character (not upper case) or a symbol.
974 EVENT may be an event or an event type. If EVENT is a symbol
975 that has never been used in an event that has been read as input
976 in the current Emacs session, then this function may return nil."
978 (setq event (car event)))
980 (car (get event 'event-symbol-elements))
981 (let* ((base (logand event (1- ?\A-\^@)))
982 (uncontrolled (if (< base 32) (logior base 64) base)))
983 ;; There are some numbers that are invalid characters and
984 ;; cause `downcase' to get an error.
986 (downcase uncontrolled)
987 (error uncontrolled)))))
989 (defsubst mouse-movement-p (object)
990 "Return non-nil if OBJECT is a mouse movement event."
991 (eq (car-safe object) 'mouse-movement))
993 (defun mouse-event-p (object)
994 "Return non-nil if OBJECT is a mouse click event."
995 ;; is this really correct? maybe remove mouse-movement?
996 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
998 (defun event-start (event)
999 "Return the starting position of EVENT.
1000 EVENT should be a mouse click, drag, or key press event. If
1001 EVENT is nil, the value of `posn-at-point' is used instead.
1003 The following accessor functions are used to access the elements
1006 `posn-window': The window the event is in.
1007 `posn-area': A symbol identifying the area the event occurred in,
1008 or nil if the event occurred in the text area.
1009 `posn-point': The buffer position of the event.
1010 `posn-x-y': The pixel-based coordinates of the event.
1011 `posn-col-row': The estimated column and row corresponding to the
1012 position of the event.
1013 `posn-actual-col-row': The actual column and row corresponding to the
1014 position of the event.
1015 `posn-string': The string object of the event, which is either
1016 nil or (STRING . POSITION)'.
1017 `posn-image': The image object of the event, if any.
1018 `posn-object': The image or string object of the event, if any.
1019 `posn-timestamp': The time the event occurred, in milliseconds.
1021 For more information, see Info node `(elisp)Click Events'."
1022 (if (consp event) (nth 1 event)
1024 (list (selected-window) (point) '(0 . 0) 0))))
1026 (defun event-end (event)
1027 "Return the ending position of EVENT.
1028 EVENT should be a click, drag, or key press event.
1030 See `event-start' for a description of the value returned."
1031 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1033 (list (selected-window) (point) '(0 . 0) 0))))
1035 (defsubst event-click-count (event)
1036 "Return the multi-click count of EVENT, a click or drag event.
1037 The return value is a positive integer."
1038 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1040 ;;;; Extracting fields of the positions in an event.
1043 "Return non-nil if OBJ appears to be a valid `posn' object."
1044 (and (windowp (car-safe obj))
1045 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1046 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1047 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1049 (defsubst posn-window (position)
1050 "Return the window in POSITION.
1051 POSITION should be a list of the form returned by the `event-start'
1052 and `event-end' functions."
1055 (defsubst posn-area (position)
1056 "Return the window area recorded in POSITION, or nil for the text area.
1057 POSITION should be a list of the form returned by the `event-start'
1058 and `event-end' functions."
1059 (let ((area (if (consp (nth 1 position))
1060 (car (nth 1 position))
1062 (and (symbolp area) area)))
1064 (defun posn-point (position)
1065 "Return the buffer location in POSITION.
1066 POSITION should be a list of the form returned by the `event-start'
1067 and `event-end' functions.
1068 Returns nil if POSITION does not correspond to any buffer location (e.g.
1069 a click on a scroll bar)."
1070 (or (nth 5 position)
1071 (let ((pt (nth 1 position)))
1073 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1074 (if (integerp pt) pt)))))
1076 (defun posn-set-point (position)
1077 "Move point to POSITION.
1078 Select the corresponding window as well."
1079 (if (not (windowp (posn-window position)))
1080 (error "Position not in text area of window"))
1081 (select-window (posn-window position))
1082 (if (numberp (posn-point position))
1083 (goto-char (posn-point position))))
1085 (defsubst posn-x-y (position)
1086 "Return the x and y coordinates in POSITION.
1087 The return value has the form (X . Y), where X and Y are given in
1088 pixels. POSITION should be a list of the form returned by
1089 `event-start' and `event-end'."
1092 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1094 (defmacro with-current-buffer (buffer-or-name &rest body)
1095 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
1096 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
1097 The value returned is the value of the last form in BODY. See
1098 also `with-temp-buffer'."
1099 (declare (indent 1) (debug t))
1100 `(save-current-buffer
1101 (set-buffer ,buffer-or-name)
1104 (defun posn-col-row (position)
1105 "Return the nominal column and row in POSITION, measured in characters.
1106 The column and row values are approximations calculated from the x
1107 and y coordinates in POSITION and the frame's default character width
1108 and default line height, including spacing.
1109 For a scroll-bar event, the result column is 0, and the row
1110 corresponds to the vertical position of the click in the scroll bar.
1111 POSITION should be a list of the form returned by the `event-start'
1112 and `event-end' functions."
1113 (let* ((pair (posn-x-y position))
1114 (window (posn-window position))
1115 (area (posn-area position)))
1119 ((eq area 'vertical-scroll-bar)
1120 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1121 ((eq area 'horizontal-scroll-bar)
1122 (cons (scroll-bar-scale pair (window-width window)) 0))
1124 (let* ((frame (if (framep window) window (window-frame window)))
1125 ;; FIXME: This should take line-spacing properties on
1126 ;; newlines into account.
1127 (spacing (when (display-graphic-p frame)
1128 (or (with-current-buffer (window-buffer window)
1130 (frame-parameter frame 'line-spacing)))))
1131 (cond ((floatp spacing)
1132 (setq spacing (truncate (* spacing
1133 (frame-char-height frame)))))
1136 (cons (/ (car pair) (frame-char-width frame))
1137 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1138 (if (null (with-current-buffer (window-buffer window)
1139 header-line-format))
1142 (defun posn-actual-col-row (position)
1143 "Return the actual column and row in POSITION, measured in characters.
1144 These are the actual row number in the window and character number in that row.
1145 Return nil if POSITION does not contain the actual position; in that case
1146 `posn-col-row' can be used to get approximate values.
1147 POSITION should be a list of the form returned by the `event-start'
1148 and `event-end' functions."
1151 (defsubst posn-timestamp (position)
1152 "Return the timestamp of POSITION.
1153 POSITION should be a list of the form returned by the `event-start'
1154 and `event-end' functions."
1157 (defun posn-string (position)
1158 "Return the string object of POSITION.
1159 Value is a cons (STRING . STRING-POS), or nil if not a string.
1160 POSITION should be a list of the form returned by the `event-start'
1161 and `event-end' functions."
1162 (let ((x (nth 4 position)))
1163 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1164 (when (consp x) x)))
1166 (defsubst posn-image (position)
1167 "Return the image object of POSITION.
1168 Value is a list (image ...), or nil if not an image.
1169 POSITION should be a list of the form returned by the `event-start'
1170 and `event-end' functions."
1173 (defsubst posn-object (position)
1174 "Return the object (image or string) of POSITION.
1175 Value is a list (image ...) for an image object, a cons cell
1176 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1177 POSITION should be a list of the form returned by the `event-start'
1178 and `event-end' functions."
1179 (or (posn-image position) (posn-string position)))
1181 (defsubst posn-object-x-y (position)
1182 "Return the x and y coordinates relative to the object of POSITION.
1183 The return value has the form (DX . DY), where DX and DY are
1184 given in pixels. POSITION should be a list of the form returned
1185 by `event-start' and `event-end'."
1188 (defsubst posn-object-width-height (position)
1189 "Return the pixel width and height of the object of POSITION.
1190 The return value has the form (WIDTH . HEIGHT). POSITION should
1191 be a list of the form returned by `event-start' and `event-end'."
1195 ;;;; Obsolescent names for functions.
1197 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1198 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1199 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1200 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1201 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1202 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1204 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1205 (make-obsolete 'buffer-has-markers-at nil "24.3")
1207 (defun insert-string (&rest args)
1208 "Mocklisp-compatibility insert function.
1209 Like the function `insert' except that any argument that is a number
1210 is converted into a string by expressing it in decimal."
1211 (declare (obsolete insert "22.1"))
1213 (insert (if (integerp el) (number-to-string el) el))))
1215 (defun makehash (&optional test)
1216 (declare (obsolete make-hash-table "22.1"))
1217 (make-hash-table :test (or test 'eql)))
1220 "Return (log X 10), the log base 10 of X."
1221 (declare (obsolete log "24.4"))
1224 ;; These are used by VM and some old programs
1225 (defalias 'focus-frame 'ignore "")
1226 (make-obsolete 'focus-frame "it does nothing." "22.1")
1227 (defalias 'unfocus-frame 'ignore "")
1228 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1229 (make-obsolete 'make-variable-frame-local
1230 "explicitly check for a frame-parameter instead." "22.2")
1231 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1232 (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
1233 (set-advertised-calling-convention 'decode-char '(ch charset) "21.4")
1234 (set-advertised-calling-convention 'encode-char '(ch charset) "21.4")
1236 ;;;; Obsolescence declarations for variables, and aliases.
1238 ;; Special "default-FOO" variables which contain the default value of
1239 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1240 ;; slows down several unrelated variable operations; furthermore, they
1241 ;; can lead to really odd behavior if you decide to make them
1244 ;; Not used at all in Emacs, last time I checked:
1245 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1246 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1247 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1248 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1249 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1250 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1251 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1252 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1253 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1254 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1255 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1256 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1257 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1258 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1259 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1260 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1261 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1262 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1263 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1264 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1265 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1266 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1267 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1268 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1269 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1270 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1271 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1272 (make-obsolete-variable 'default-enable-multibyte-characters
1273 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1275 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1276 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1277 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1278 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1279 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1280 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1282 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1283 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1285 ;; Lisp manual only updated in 22.1.
1286 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1289 (define-obsolete-variable-alias 'x-lost-selection-hooks
1290 'x-lost-selection-functions "22.1")
1291 (define-obsolete-variable-alias 'x-sent-selection-hooks
1292 'x-sent-selection-functions "22.1")
1294 ;; This was introduced in 21.4 for pre-unicode unification. That
1295 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1296 ;; Other uses are possible, so this variable is not _really_ obsolete,
1297 ;; but Stefan insists to mark it so.
1298 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1300 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1302 ;;;; Alternate names for functions - these are not being phased out.
1304 (defalias 'send-string 'process-send-string)
1305 (defalias 'send-region 'process-send-region)
1306 (defalias 'string= 'string-equal)
1307 (defalias 'string< 'string-lessp)
1308 (defalias 'move-marker 'set-marker)
1309 (defalias 'rplaca 'setcar)
1310 (defalias 'rplacd 'setcdr)
1311 (defalias 'beep 'ding) ;preserve lingual purity
1312 (defalias 'indent-to-column 'indent-to)
1313 (defalias 'backward-delete-char 'delete-backward-char)
1314 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1315 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1316 (defalias 'int-to-string 'number-to-string)
1317 (defalias 'store-match-data 'set-match-data)
1318 (defalias 'chmod 'set-file-modes)
1319 (defalias 'mkdir 'make-directory)
1320 ;; These are the XEmacs names:
1321 (defalias 'point-at-eol 'line-end-position)
1322 (defalias 'point-at-bol 'line-beginning-position)
1324 (defalias 'user-original-login-name 'user-login-name)
1327 ;;;; Hook manipulation functions.
1329 (defun add-hook (hook function &optional append local)
1330 "Add to the value of HOOK the function FUNCTION.
1331 FUNCTION is not added if already present.
1332 FUNCTION is added (if necessary) at the beginning of the hook list
1333 unless the optional argument APPEND is non-nil, in which case
1334 FUNCTION is added at the end.
1336 The optional fourth argument, LOCAL, if non-nil, says to modify
1337 the hook's buffer-local value rather than its global value.
1338 This makes the hook buffer-local, and it makes t a member of the
1339 buffer-local value. That acts as a flag to run the hook
1340 functions of the global value as well as in the local value.
1342 HOOK should be a symbol, and FUNCTION may be any valid function. If
1343 HOOK is void, it is first set to nil. If HOOK's value is a single
1344 function, it is changed to a list of functions."
1345 (or (boundp hook) (set hook nil))
1346 (or (default-boundp hook) (set-default hook nil))
1347 (if local (unless (local-variable-if-set-p hook)
1348 (set (make-local-variable hook) (list t)))
1349 ;; Detect the case where make-local-variable was used on a hook
1350 ;; and do what we used to do.
1351 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1353 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1354 ;; If the hook value is a single function, turn it into a list.
1355 (when (or (not (listp hook-value)) (functionp hook-value))
1356 (setq hook-value (list hook-value)))
1357 ;; Do the actual addition if necessary
1358 (unless (member function hook-value)
1359 (when (stringp function)
1360 (setq function (purecopy function)))
1363 (append hook-value (list function))
1364 (cons function hook-value))))
1365 ;; Set the actual variable
1368 ;; If HOOK isn't a permanent local,
1369 ;; but FUNCTION wants to survive a change of modes,
1370 ;; mark HOOK as partially permanent.
1371 (and (symbolp function)
1372 (get function 'permanent-local-hook)
1373 (not (get hook 'permanent-local))
1374 (put hook 'permanent-local 'permanent-local-hook))
1375 (set hook hook-value))
1376 (set-default hook hook-value))))
1378 (defun remove-hook (hook function &optional local)
1379 "Remove from the value of HOOK the function FUNCTION.
1380 HOOK should be a symbol, and FUNCTION may be any valid function. If
1381 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1382 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1384 The optional third argument, LOCAL, if non-nil, says to modify
1385 the hook's buffer-local value rather than its default value."
1386 (or (boundp hook) (set hook nil))
1387 (or (default-boundp hook) (set-default hook nil))
1388 ;; Do nothing if LOCAL is t but this hook has no local binding.
1389 (unless (and local (not (local-variable-p hook)))
1390 ;; Detect the case where make-local-variable was used on a hook
1391 ;; and do what we used to do.
1392 (when (and (local-variable-p hook)
1393 (not (and (consp (symbol-value hook))
1394 (memq t (symbol-value hook)))))
1396 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1397 ;; Remove the function, for both the list and the non-list cases.
1398 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1399 (if (equal hook-value function) (setq hook-value nil))
1400 (setq hook-value (delete function (copy-sequence hook-value))))
1401 ;; If the function is on the global hook, we need to shadow it locally
1402 ;;(when (and local (member function (default-value hook))
1403 ;; (not (member (cons 'not function) hook-value)))
1404 ;; (push (cons 'not function) hook-value))
1405 ;; Set the actual variable
1407 (set-default hook hook-value)
1408 (if (equal hook-value '(t))
1409 (kill-local-variable hook)
1410 (set hook hook-value))))))
1412 (defmacro letrec (binders &rest body)
1413 "Bind variables according to BINDERS then eval BODY.
1414 The value of the last form in BODY is returned.
1415 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1416 SYMBOL to the value of VALUEFORM.
1417 All symbols are bound before the VALUEFORMs are evalled."
1418 ;; Only useful in lexical-binding mode.
1419 ;; As a special-form, we could implement it more efficiently (and cleanly,
1420 ;; making the vars actually unbound during evaluation of the binders).
1421 (declare (debug let) (indent 1))
1422 `(let ,(mapcar #'car binders)
1423 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1426 (defmacro with-wrapper-hook (hook args &rest body)
1427 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1428 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1429 around the preceding ones, like a set of nested `around' advices.
1431 Each hook function should accept an argument list consisting of a
1432 function FUN, followed by the additional arguments in ARGS.
1434 The first hook function in HOOK is passed a FUN that, if it is called
1435 with arguments ARGS, performs BODY (i.e., the default operation).
1436 The FUN passed to each successive hook function is defined based
1437 on the preceding hook functions; if called with arguments ARGS,
1438 it does what the `with-wrapper-hook' call would do if the
1439 preceding hook functions were the only ones present in HOOK.
1441 Each hook function may call its FUN argument as many times as it wishes,
1442 including never. In that case, such a hook function acts to replace
1443 the default definition altogether, and any preceding hook functions.
1444 Of course, a subsequent hook function may do the same thing.
1446 Each hook function definition is used to construct the FUN passed
1447 to the next hook function, if any. The last (or \"outermost\")
1448 FUN is then called once."
1449 (declare (indent 2) (debug (form sexp body))
1450 (obsolete "use a <foo>-function variable modified by `add-function'."
1452 ;; We need those two gensyms because CL's lexical scoping is not available
1453 ;; for function arguments :-(
1454 (let ((funs (make-symbol "funs"))
1455 (global (make-symbol "global"))
1456 (argssym (make-symbol "args"))
1457 (runrestofhook (make-symbol "runrestofhook")))
1458 ;; Since the hook is a wrapper, the loop has to be done via
1459 ;; recursion: a given hook function will call its parameter in order to
1460 ;; continue looping.
1461 `(letrec ((,runrestofhook
1462 (lambda (,funs ,global ,argssym)
1463 ;; `funs' holds the functions left on the hook and `global'
1464 ;; holds the functions left on the global part of the hook
1465 ;; (in case the hook is local).
1467 (if (eq t (car ,funs))
1468 (funcall ,runrestofhook
1469 (append ,global (cdr ,funs)) nil ,argssym)
1472 (lambda (,funs ,global &rest ,argssym)
1473 (funcall ,runrestofhook ,funs ,global ,argssym))
1474 (cdr ,funs) ,global)
1476 ;; Once there are no more functions on the hook, run
1477 ;; the original body.
1478 (apply (lambda ,args ,@body) ,argssym)))))
1479 (funcall ,runrestofhook ,hook
1480 ;; The global part of the hook, if any.
1482 `(if (local-variable-p ',hook)
1483 (default-value ',hook)))
1486 (defun add-to-list (list-var element &optional append compare-fn)
1487 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1488 The test for presence of ELEMENT is done with `equal', or with
1489 COMPARE-FN if that's non-nil.
1490 If ELEMENT is added, it is added at the beginning of the list,
1491 unless the optional argument APPEND is non-nil, in which case
1492 ELEMENT is added at the end.
1494 The return value is the new value of LIST-VAR.
1496 This is handy to add some elements to configuration variables,
1497 but please do not abuse it in Elisp code, where you are usually
1498 better off using `push' or `cl-pushnew'.
1500 If you want to use `add-to-list' on a variable that is not
1501 defined until a certain package is loaded, you should put the
1502 call to `add-to-list' into a hook function that will be run only
1503 after loading the package. `eval-after-load' provides one way to
1504 do this. In some cases other hooks, such as major mode hooks,
1509 ;; FIXME: Something like this could be used for `set' as well.
1510 (if (or (not (eq 'quote (car-safe list-var)))
1511 (special-variable-p (cadr list-var))
1512 (not (macroexp-const-p append)))
1514 (let* ((sym (cadr list-var))
1515 (append (eval append))
1516 (msg (format "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1518 ;; Big ugly hack so we only output a warning during
1519 ;; byte-compilation, and so we can use
1520 ;; byte-compile-not-lexical-var-p to silence the warning
1521 ;; when a defvar has been seen but not yet executed.
1523 ;; FIXME: We should also emit a warning for let-bound
1524 ;; variables with dynamic binding.
1525 (when (assq sym byte-compile--lexical-environment)
1526 (byte-compile-log-warning msg t :error))))
1528 (macroexp-let2 macroexp-copyable-p x element
1529 `(if ,(if compare-fn
1532 `(cl-member ,x ,sym :test ,compare-fn))
1533 ;; For bootstrapping reasons, don't rely on
1534 ;; cl--compiler-macro-member for the base case.
1538 `(setq ,sym (append ,sym (list ,x)))
1539 `(push ,x ,sym))))))
1540 (if (not (macroexp--compiling-p))
1543 (macroexp--funcall-if-compiled ',warnfun)
1547 (member element (symbol-value list-var)))
1548 ((eq compare-fn 'eq)
1549 (memq element (symbol-value list-var)))
1550 ((eq compare-fn 'eql)
1551 (memql element (symbol-value list-var)))
1553 (let ((lst (symbol-value list-var)))
1555 (not (funcall compare-fn element (car lst))))
1556 (setq lst (cdr lst)))
1558 (symbol-value list-var)
1561 (append (symbol-value list-var) (list element))
1562 (cons element (symbol-value list-var))))))
1565 (defun add-to-ordered-list (list-var element &optional order)
1566 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1567 The test for presence of ELEMENT is done with `eq'.
1569 The resulting list is reordered so that the elements are in the
1570 order given by each element's numeric list order. Elements
1571 without a numeric list order are placed at the end of the list.
1573 If the third optional argument ORDER is a number (integer or
1574 float), set the element's list order to the given value. If
1575 ORDER is nil or omitted, do not change the numeric order of
1576 ELEMENT. If ORDER has any other value, remove the numeric order
1577 of ELEMENT if it has one.
1579 The list order for each element is stored in LIST-VAR's
1580 `list-order' property.
1582 The return value is the new value of LIST-VAR."
1583 (let ((ordering (get list-var 'list-order)))
1585 (put list-var 'list-order
1586 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1588 (puthash element (and (numberp order) order) ordering))
1589 (unless (memq element (symbol-value list-var))
1590 (set list-var (cons element (symbol-value list-var))))
1591 (set list-var (sort (symbol-value list-var)
1593 (let ((oa (gethash a ordering))
1594 (ob (gethash b ordering)))
1599 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1600 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1601 Return the new history list.
1602 If MAXELT is non-nil, it specifies the maximum length of the history.
1603 Otherwise, the maximum history length is the value of the `history-length'
1604 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1606 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1607 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1608 if it is empty or a duplicate."
1610 (setq maxelt (or (get history-var 'history-length)
1612 (let ((history (symbol-value history-var))
1614 (when (and (listp history)
1616 (not (stringp newelt))
1617 (> (length newelt) 0))
1619 (not (equal (car history) newelt))))
1620 (if history-delete-duplicates
1621 (setq history (delete newelt history)))
1622 (setq history (cons newelt history))
1623 (when (integerp maxelt)
1626 (setq tail (nthcdr (1- maxelt) history))
1628 (setcdr tail nil)))))
1629 (set history-var history)))
1634 (defvar delay-mode-hooks nil
1635 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1636 (defvar delayed-mode-hooks nil
1637 "List of delayed mode hooks waiting to be run.")
1638 (make-variable-buffer-local 'delayed-mode-hooks)
1639 (put 'delay-mode-hooks 'permanent-local t)
1641 (defvar change-major-mode-after-body-hook nil
1642 "Normal hook run in major mode functions, before the mode hooks.")
1644 (defvar after-change-major-mode-hook nil
1645 "Normal hook run at the very end of major mode functions.")
1647 (defun run-mode-hooks (&rest hooks)
1648 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1649 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1650 just adds the HOOKS to the list `delayed-mode-hooks'.
1651 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1652 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1653 `after-change-major-mode-hook'. Major mode functions should use
1654 this instead of `run-hooks' when running their FOO-mode-hook."
1655 (if delay-mode-hooks
1657 (dolist (hook hooks)
1658 (push hook delayed-mode-hooks))
1659 ;; Normal case, just run the hook as before plus any delayed hooks.
1660 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1661 (setq delayed-mode-hooks nil)
1662 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1663 (run-hooks 'after-change-major-mode-hook)))
1665 (defmacro delay-mode-hooks (&rest body)
1666 "Execute BODY, but delay any `run-mode-hooks'.
1667 These hooks will be executed by the first following call to
1668 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1669 Only affects hooks run in the current buffer."
1670 (declare (debug t) (indent 0))
1672 (make-local-variable 'delay-mode-hooks)
1673 (let ((delay-mode-hooks t))
1676 ;; PUBLIC: find if the current mode derives from another.
1678 (defun derived-mode-p (&rest modes)
1679 "Non-nil if the current major mode is derived from one of MODES.
1680 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1681 (let ((parent major-mode))
1682 (while (and (not (memq parent modes))
1683 (setq parent (get parent 'derived-mode-parent))))
1688 ;; If a minor mode is not defined with define-minor-mode,
1689 ;; add it here explicitly.
1690 ;; isearch-mode is deliberately excluded, since you should
1691 ;; not call it yourself.
1692 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1693 overwrite-mode view-mode
1695 "List of all minor mode functions.")
1697 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1698 "Register a new minor mode.
1700 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1702 TOGGLE is a symbol which is the name of a buffer-local variable that
1703 is toggled on or off to say whether the minor mode is active or not.
1705 NAME specifies what will appear in the mode line when the minor mode
1706 is active. NAME should be either a string starting with a space, or a
1707 symbol whose value is such a string.
1709 Optional KEYMAP is the keymap for the minor mode that will be added
1710 to `minor-mode-map-alist'.
1712 Optional AFTER specifies that TOGGLE should be added after AFTER
1713 in `minor-mode-alist'.
1715 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1716 It defaults to (and should by convention be) TOGGLE.
1718 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1719 included in the mode-line minor mode menu.
1720 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1721 (unless (memq toggle minor-mode-list)
1722 (push toggle minor-mode-list))
1724 (unless toggle-fun (setq toggle-fun toggle))
1725 (unless (eq toggle-fun toggle)
1726 (put toggle :minor-mode-function toggle-fun))
1727 ;; Add the name to the minor-mode-alist.
1729 (let ((existing (assq toggle minor-mode-alist)))
1731 (setcdr existing (list name))
1732 (let ((tail minor-mode-alist) found)
1733 (while (and tail (not found))
1734 (if (eq after (caar tail))
1736 (setq tail (cdr tail))))
1738 (let ((rest (cdr found)))
1740 (nconc found (list (list toggle name)) rest))
1741 (push (list toggle name) minor-mode-alist))))))
1742 ;; Add the toggle to the minor-modes menu if requested.
1743 (when (get toggle :included)
1744 (define-key mode-line-mode-menu
1748 (or (get toggle :menu-tag)
1749 (if (stringp name) name (symbol-name toggle)))
1750 (let ((mode-name (if (symbolp name) (symbol-value name))))
1751 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1752 (concat " (" (match-string 0 mode-name) ")"))))
1754 :button (cons :toggle toggle))))
1756 ;; Add the map to the minor-mode-map-alist.
1758 (let ((existing (assq toggle minor-mode-map-alist)))
1760 (setcdr existing keymap)
1761 (let ((tail minor-mode-map-alist) found)
1762 (while (and tail (not found))
1763 (if (eq after (caar tail))
1765 (setq tail (cdr tail))))
1767 (let ((rest (cdr found)))
1769 (nconc found (list (cons toggle keymap)) rest))
1770 (push (cons toggle keymap) minor-mode-map-alist)))))))
1774 (defsubst autoloadp (object)
1775 "Non-nil if OBJECT is an autoload."
1776 (eq 'autoload (car-safe object)))
1778 ;; (defun autoload-type (object)
1779 ;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1780 ;; OBJECT should be an autoload object."
1781 ;; (when (autoloadp object)
1782 ;; (let ((type (nth 3 object)))
1783 ;; (cond ((null type) (if (nth 2 object) 'command 'function))
1784 ;; ((eq 'keymap t) 'macro)
1787 ;; (defalias 'autoload-file #'cadr
1788 ;; "Return the name of the file from which AUTOLOAD will be loaded.
1789 ;; \n\(fn AUTOLOAD)")
1791 (defun symbol-file (symbol &optional type)
1792 "Return the name of the file that defined SYMBOL.
1793 The value is normally an absolute file name. It can also be nil,
1794 if the definition is not associated with any file. If SYMBOL
1795 specifies an autoloaded function, the value can be a relative
1796 file name without extension.
1798 If TYPE is nil, then any kind of definition is acceptable. If
1799 TYPE is `defun', `defvar', or `defface', that specifies function
1800 definition, variable definition, or face definition only."
1801 (if (and (or (null type) (eq type 'defun))
1803 (autoloadp (symbol-function symbol)))
1804 (nth 1 (symbol-function symbol))
1805 (let ((files load-history)
1809 (if (eq type 'defvar)
1810 ;; Variables are present just as their names.
1811 (member symbol (cdr (car files)))
1812 ;; Other types are represented as (TYPE . NAME).
1813 (member (cons type symbol) (cdr (car files))))
1814 ;; We accept all types, so look for variable def
1815 ;; and then for any other kind.
1816 (or (member symbol (cdr (car files)))
1817 (rassq symbol (cdr (car files)))))
1818 (setq file (car (car files)) files nil))
1819 (setq files (cdr files)))
1822 (defun locate-library (library &optional nosuffix path interactive-call)
1823 "Show the precise file name of Emacs library LIBRARY.
1824 LIBRARY should be a relative file name of the library, a string.
1825 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1826 nil (which is the default, see below).
1827 This command searches the directories in `load-path' like `\\[load-library]'
1828 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1829 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1830 to the specified name LIBRARY.
1832 If the optional third arg PATH is specified, that list of directories
1833 is used instead of `load-path'.
1835 When called from a program, the file name is normally returned as a
1836 string. When run interactively, the argument INTERACTIVE-CALL is t,
1837 and the file name is displayed in the echo area."
1838 (interactive (list (completing-read "Locate library: "
1840 'locate-file-completion-table
1841 load-path (get-load-suffixes)))
1844 (let ((file (locate-file library
1846 (append (unless nosuffix (get-load-suffixes))
1847 load-file-rep-suffixes))))
1848 (if interactive-call
1850 (message "Library is file %s" (abbreviate-file-name file))
1851 (message "No library %s in search path" library)))
1855 (defmacro with-temp-buffer (&rest body)
1856 "Create a temporary buffer, and evaluate BODY there like `progn'.
1857 See also `with-temp-file' and `with-output-to-string'."
1858 (declare (indent 0) (debug t))
1859 (let ((temp-buffer (make-symbol "temp-buffer")))
1860 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
1861 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
1862 (with-current-buffer ,temp-buffer
1865 (and (buffer-name ,temp-buffer)
1866 (kill-buffer ,temp-buffer)))))))
1870 (defun process-lines (program &rest args)
1871 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1872 Signal an error if the program returns with a non-zero exit status."
1874 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1875 (unless (eq status 0)
1876 (error "%s exited with status %s" program status))
1877 (goto-char (point-min))
1880 (setq lines (cons (buffer-substring-no-properties
1881 (line-beginning-position)
1882 (line-end-position))
1885 (nreverse lines)))))
1887 (defun process-live-p (process)
1888 "Returns non-nil if PROCESS is alive.
1889 A process is considered alive if its status is `run', `open',
1890 `listen', `connect' or `stop'. Value is nil if PROCESS is not a
1892 (and (processp process)
1893 (memq (process-status process)
1894 '(run open listen connect stop))))
1899 'process-kill-without-query
1900 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1902 (defun process-kill-without-query (process &optional _flag)
1903 "Say no query needed if PROCESS is running when Emacs is exited.
1904 Optional second argument if non-nil says to require a query.
1905 Value is t if a query was formerly required."
1906 (let ((old (process-query-on-exit-flag process)))
1907 (set-process-query-on-exit-flag process nil)
1910 (defun process-kill-buffer-query-function ()
1911 "Ask before killing a buffer that has a running process."
1912 (let ((process (get-buffer-process (current-buffer))))
1914 (not (memq (process-status process) '(run stop open listen)))
1915 (not (process-query-on-exit-flag process))
1917 (format "Buffer %S has a running process; kill it? "
1918 (buffer-name (current-buffer)))))))
1920 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1922 ;; process plist management
1924 (defun process-get (process propname)
1925 "Return the value of PROCESS' PROPNAME property.
1926 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1927 (plist-get (process-plist process) propname))
1929 (defun process-put (process propname value)
1930 "Change PROCESS' PROPNAME property to VALUE.
1931 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1932 (set-process-plist process
1933 (plist-put (process-plist process) propname value)))
1936 ;;;; Input and display facilities.
1938 (defconst read-key-empty-map (make-sparse-keymap))
1940 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
1942 (defun read-key (&optional prompt)
1943 "Read a key from the keyboard.
1944 Contrary to `read-event' this will not return a raw event but instead will
1945 obey the input decoding and translations usually done by `read-key-sequence'.
1946 So escape sequences and keyboard encoding are taken into account.
1947 When there's an ambiguity because the key looks like the prefix of
1948 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1949 ;; This overriding-terminal-local-map binding also happens to
1950 ;; disable quail's input methods, so although read-key-sequence
1951 ;; always inherits the input method, in practice read-key does not
1952 ;; inherit the input method (at least not if it's based on quail).
1953 (let ((overriding-terminal-local-map nil)
1954 (overriding-local-map read-key-empty-map)
1956 (old-global-map (current-global-map))
1957 (timer (run-with-idle-timer
1958 ;; Wait long enough that Emacs has the time to receive and
1959 ;; process all the raw events associated with the single-key.
1960 ;; But don't wait too long, or the user may find the delay
1961 ;; annoying (or keep hitting more keys which may then get
1962 ;; lost or misinterpreted).
1963 ;; This is only relevant for keys which Emacs perceives as
1964 ;; "prefixes", such as C-x (because of the C-x 8 map in
1965 ;; key-translate-table and the C-x @ map in function-key-map)
1966 ;; or ESC (because of terminal escape sequences in
1967 ;; input-decode-map).
1970 (let ((keys (this-command-keys-vector)))
1971 (unless (zerop (length keys))
1972 ;; `keys' is non-empty, so the user has hit at least
1973 ;; one key; there's no point waiting any longer, even
1974 ;; though read-key-sequence thinks we should wait
1975 ;; for more input to decide how to interpret the
1977 (throw 'read-key keys)))))))
1981 (let ((map (make-sparse-keymap)))
1982 ;; Don't hide the menu-bar and tool-bar entries.
1983 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
1984 (define-key map [tool-bar]
1985 ;; This hack avoids evaluating the :filter (Bug#9922).
1986 (or (cdr (assq 'tool-bar global-map))
1987 (lookup-key global-map [tool-bar])))
1989 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
1990 (cancel-timer timer)
1991 (use-global-map old-global-map))))
1993 (defmacro minibuffer-with-setup-hook (fun &rest body)
1994 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1995 BODY should use the minibuffer at most once.
1996 Recursive uses of the minibuffer are unaffected (FUN is not
1997 called additional times).
1999 This macro actually adds an auxiliary function that calls FUN,
2000 rather than FUN itself, to `minibuffer-setup-hook'."
2001 (declare (indent 1) (debug t))
2002 (let ((hook (make-symbol "setup-hook"))
2003 (funsym (make-symbol "fun")))
2004 `(let ((,funsym ,fun)
2008 ;; Clear out this hook so it does not interfere
2009 ;; with any recursive minibuffer usage.
2010 (remove-hook 'minibuffer-setup-hook ,hook)
2014 (add-hook 'minibuffer-setup-hook ,hook)
2016 (remove-hook 'minibuffer-setup-hook ,hook)))))
2018 (defmacro save-window-excursion (&rest body)
2019 "Execute BODY, then restore previous window configuration.
2020 This macro saves the window configuration on the selected frame,
2021 executes BODY, then calls `set-window-configuration' to restore
2022 the saved window configuration. The return value is the last
2023 form in BODY. The window configuration is also restored if BODY
2026 BEWARE: Most uses of this macro introduce bugs.
2027 E.g. it should not be used to try and prevent some code from opening
2028 a new window, since that window may sometimes appear in another frame,
2029 in which case `save-window-excursion' cannot help."
2030 (declare (indent 0) (debug t))
2031 (let ((c (make-symbol "wconfig")))
2032 `(let ((,c (current-window-configuration)))
2033 (unwind-protect (progn ,@body)
2034 (set-window-configuration ,c)))))
2036 (defvar read-passwd-map
2037 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
2038 ;; minibuffer-local-map along the way!
2039 (let ((map (make-sparse-keymap)))
2040 (set-keymap-parent map minibuffer-local-map)
2041 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2043 "Keymap used while reading passwords.")
2045 (defun read-passwd (prompt &optional confirm default)
2046 "Read a password, prompting with PROMPT, and return it.
2047 If optional CONFIRM is non-nil, read the password twice to make sure.
2048 Optional DEFAULT is a default password to use instead of empty input.
2050 This function echoes `.' for each character that the user types.
2051 Note that in batch mode, the input is not hidden!
2053 Once the caller uses the password, it can erase the password
2054 by doing (clear-string STRING)."
2057 (while (not success)
2058 (let ((first (read-passwd prompt nil default))
2059 (second (read-passwd "Confirm password: " nil default)))
2060 (if (equal first second)
2062 (and (arrayp second) (clear-string second))
2063 (setq success first))
2064 (and (arrayp first) (clear-string first))
2065 (and (arrayp second) (clear-string second))
2066 (message "Password not repeated accurately; please start over")
2069 (let ((hide-chars-fun
2070 (lambda (beg end _len)
2071 (clear-this-command-keys)
2072 (setq beg (min end (max (minibuffer-prompt-end)
2074 (dotimes (i (- end beg))
2075 (put-text-property (+ i beg) (+ 1 i beg)
2076 'display (string ?.)))))
2078 (minibuffer-with-setup-hook
2080 (setq minibuf (current-buffer))
2081 ;; Turn off electricity.
2082 (setq-local post-self-insert-hook nil)
2083 (setq-local buffer-undo-list t)
2084 (setq-local select-active-regions nil)
2085 (use-local-map read-passwd-map)
2086 (setq-local inhibit-modification-hooks nil) ;bug#15501.
2087 (setq-local show-paren-mode nil) ;bug#16091.
2088 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2090 (let ((enable-recursive-minibuffers t))
2093 (format "%s[INPUT WILL NOT BE HIDDEN!] " prompt) ; bug#17839
2095 nil t default)) ; t = "no history"
2096 (when (buffer-live-p minibuf)
2097 (with-current-buffer minibuf
2098 ;; Not sure why but it seems that there might be cases where the
2099 ;; minibuffer is not always properly reset later on, so undo
2100 ;; whatever we've done here (bug#11392).
2101 (remove-hook 'after-change-functions hide-chars-fun 'local)
2102 (kill-local-variable 'post-self-insert-hook)
2103 ;; And of course, don't keep the sensitive data around.
2104 (erase-buffer))))))))
2106 (defun read-number (prompt &optional default)
2107 "Read a numeric value in the minibuffer, prompting with PROMPT.
2108 DEFAULT specifies a default value to return if the user just types RET.
2109 The value of DEFAULT is inserted into PROMPT.
2110 This function is used by the `interactive' code letter `n'."
2112 (default1 (if (consp default) (car default) default)))
2115 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2116 (replace-match (format " (default %s)" default1) t t prompt 1)
2117 (replace-regexp-in-string "[ \t]*\\'"
2118 (format " (default %s) " default1)
2122 (let ((str (read-from-minibuffer
2123 prompt nil nil nil nil
2126 (mapcar 'number-to-string (delq nil default))
2127 (number-to-string default))))))
2130 ((zerop (length str)) default1)
2131 ((stringp str) (read str))))
2134 (message "Please enter a number.")
2139 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2140 "Read and return one of CHARS, prompting for PROMPT.
2141 Any input that is not one of CHARS is ignored.
2143 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2144 keyboard-quit events while waiting for a valid input."
2145 (unless (consp chars)
2146 (error "Called `read-char-choice' without valid char choices"))
2147 (let (char done show-help (helpbuf " *Char Help*"))
2148 (let ((cursor-in-echo-area t)
2149 (executing-kbd-macro executing-kbd-macro)
2151 (save-window-excursion ; in case we call help-form-show
2153 (unless (get-text-property 0 'face prompt)
2154 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2155 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2157 (and show-help (buffer-live-p (get-buffer helpbuf))
2158 (kill-buffer helpbuf))
2160 ((not (numberp char)))
2161 ;; If caller has set help-form, that's enough.
2162 ;; They don't explicitly have to add help-char to chars.
2169 ((and executing-kbd-macro (= char -1))
2170 ;; read-event returns -1 if we are in a kbd macro and
2171 ;; there are no more events in the macro. Attempt to
2172 ;; get an event interactively.
2173 (setq executing-kbd-macro nil))
2174 ((not inhibit-keyboard-quit)
2176 ((and (null esc-flag) (eq char ?\e))
2178 ((memq char '(?\C-g ?\e))
2179 (keyboard-quit))))))))
2180 ;; Display the question with the answer. But without cursor-in-echo-area.
2181 (message "%s%s" prompt (char-to-string char))
2184 (defun sit-for (seconds &optional nodisp obsolete)
2185 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2186 SECONDS may be a floating-point value.
2187 \(On operating systems that do not support waiting for fractions of a
2188 second, floating-point values are rounded down to the nearest integer.)
2190 If optional arg NODISP is t, don't redisplay, just wait for input.
2191 Redisplay does not happen if input is available before it starts.
2193 Value is t if waited the full time with no input arriving, and nil otherwise.
2195 An obsolete, but still supported form is
2196 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2197 where the optional arg MILLISECONDS specifies an additional wait period,
2198 in milliseconds; this was useful when Emacs was built without
2199 floating point support."
2200 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
2201 ;; This used to be implemented in C until the following discussion:
2202 ;; http://lists.gnu.org/archive/html/emacs-devel/2006-07/msg00401.html
2203 ;; Then it was moved to C using an implementation based on an idle timer,
2204 ;; which was then replaced by the use of read-event.
2205 (if (numberp nodisp)
2206 (setq seconds (+ seconds (* 1e-3 nodisp))
2208 (if obsolete (setq nodisp obsolete)))
2213 ((input-pending-p t)
2216 (or nodisp (redisplay)))
2218 (or nodisp (redisplay))
2219 ;; FIXME: we should not read-event here at all, because it's much too
2220 ;; difficult to reliably "undo" a read-event by pushing it onto
2221 ;; unread-command-events.
2222 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2223 ;; decoding (hence non-nil as second arg under POSIX ttys).
2224 ;; For bug#15614, we need read-event not to inherit-input-method.
2225 ;; So we temporarily suspend input-method-function.
2226 (let ((read (let ((input-method-function nil))
2227 (read-event nil t seconds))))
2230 ;; https://lists.gnu.org/archive/html/emacs-devel/2006-10/msg00394.html
2231 ;; We want `read' appear in the next command's this-command-event
2232 ;; but not in the current one.
2233 ;; By pushing (cons t read), we indicate that `read' has not
2234 ;; yet been recorded in this-command-keys, so it will be recorded
2235 ;; next time it's read.
2236 ;; And indeed the `seconds' argument to read-event correctly
2237 ;; prevented recording this event in the current command's
2238 ;; this-command-keys.
2239 (push (cons t read) unread-command-events)
2242 ;; Behind display-popup-menus-p test.
2243 (declare-function x-popup-dialog "menu.c" (position contents &optional header))
2245 (defun y-or-n-p (prompt)
2246 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2247 PROMPT is the string to display to ask the question. It should
2248 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2250 No confirmation of the answer is requested; a single character is
2251 enough. SPC also means yes, and DEL means no.
2253 To be precise, this function translates user input into responses
2254 by consulting the bindings in `query-replace-map'; see the
2255 documentation of that variable for more information. In this
2256 case, the useful bindings are `act', `skip', `recenter',
2257 `scroll-up', `scroll-down', and `quit'.
2258 An `act' response means yes, and a `skip' response means no.
2259 A `quit' response means to invoke `keyboard-quit'.
2260 If the user enters `recenter', `scroll-up', or `scroll-down'
2261 responses, perform the requested window recentering or scrolling
2264 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2265 is nil and `use-dialog-box' is non-nil."
2266 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2267 ;; where all the keys were unbound (i.e. it somehow got triggered
2268 ;; within read-key, apparently). I had to kill it.
2269 (let ((answer 'recenter)
2270 (padded (lambda (prompt &optional dialog)
2271 (let ((l (length prompt)))
2273 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2275 (if dialog "" "(y or n) "))))))
2278 (setq prompt (funcall padded prompt))
2279 (let ((temp-prompt prompt))
2280 (while (not (memq answer '(act skip)))
2281 (let ((str (read-string temp-prompt)))
2282 (cond ((member str '("y" "Y")) (setq answer 'act))
2283 ((member str '("n" "N")) (setq answer 'skip))
2284 (t (setq temp-prompt (concat "Please answer y or n. "
2286 ((and (display-popup-menus-p)
2287 (listp last-nonmenu-event)
2289 (setq prompt (funcall padded prompt t)
2290 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2292 (setq prompt (funcall padded prompt))
2294 (let* ((scroll-actions '(recenter scroll-up scroll-down
2295 scroll-other-window scroll-other-window-down))
2297 (let ((cursor-in-echo-area t))
2298 (when minibuffer-auto-raise
2299 (raise-frame (window-frame (minibuffer-window))))
2300 (read-key (propertize (if (memq answer scroll-actions)
2302 (concat "Please answer y or n. "
2304 'face 'minibuffer-prompt)))))
2305 (setq answer (lookup-key query-replace-map (vector key) t))
2307 ((memq answer '(skip act)) nil)
2308 ((eq answer 'recenter)
2310 ((eq answer 'scroll-up)
2311 (ignore-errors (scroll-up-command)) t)
2312 ((eq answer 'scroll-down)
2313 (ignore-errors (scroll-down-command)) t)
2314 ((eq answer 'scroll-other-window)
2315 (ignore-errors (scroll-other-window)) t)
2316 ((eq answer 'scroll-other-window-down)
2317 (ignore-errors (scroll-other-window-down)) t)
2318 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2319 (signal 'quit nil) t)
2323 (let ((ret (eq answer 'act)))
2324 (unless noninteractive
2325 (message "%s%c" prompt (if ret ?y ?n)))
2329 ;;; Atomic change groups.
2331 (defmacro atomic-change-group (&rest body)
2332 "Perform BODY as an atomic change group.
2333 This means that if BODY exits abnormally,
2334 all of its changes to the current buffer are undone.
2335 This works regardless of whether undo is enabled in the buffer.
2337 This mechanism is transparent to ordinary use of undo;
2338 if undo is enabled in the buffer and BODY succeeds, the
2339 user can undo the change normally."
2340 (declare (indent 0) (debug t))
2341 (let ((handle (make-symbol "--change-group-handle--"))
2342 (success (make-symbol "--change-group-success--")))
2343 `(let ((,handle (prepare-change-group))
2344 ;; Don't truncate any undo data in the middle of this.
2345 (undo-outer-limit nil)
2346 (undo-limit most-positive-fixnum)
2347 (undo-strong-limit most-positive-fixnum)
2351 ;; This is inside the unwind-protect because
2352 ;; it enables undo if that was disabled; we need
2353 ;; to make sure that it gets disabled again.
2354 (activate-change-group ,handle)
2357 ;; Either of these functions will disable undo
2358 ;; if it was disabled before.
2360 (accept-change-group ,handle)
2361 (cancel-change-group ,handle))))))
2363 (defun prepare-change-group (&optional buffer)
2364 "Return a handle for the current buffer's state, for a change group.
2365 If you specify BUFFER, make a handle for BUFFER's state instead.
2367 Pass the handle to `activate-change-group' afterward to initiate
2368 the actual changes of the change group.
2370 To finish the change group, call either `accept-change-group' or
2371 `cancel-change-group' passing the same handle as argument. Call
2372 `accept-change-group' to accept the changes in the group as final;
2373 call `cancel-change-group' to undo them all. You should use
2374 `unwind-protect' to make sure the group is always finished. The call
2375 to `activate-change-group' should be inside the `unwind-protect'.
2376 Once you finish the group, don't use the handle again--don't try to
2377 finish the same group twice. For a simple example of correct use, see
2378 the source code of `atomic-change-group'.
2380 The handle records only the specified buffer. To make a multibuffer
2381 change group, call this function once for each buffer you want to
2382 cover, then use `nconc' to combine the returned values, like this:
2384 (nconc (prepare-change-group buffer-1)
2385 (prepare-change-group buffer-2))
2387 You can then activate that multibuffer change group with a single
2388 call to `activate-change-group' and finish it with a single call
2389 to `accept-change-group' or `cancel-change-group'."
2392 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2393 (list (cons (current-buffer) buffer-undo-list))))
2395 (defun activate-change-group (handle)
2396 "Activate a change group made with `prepare-change-group' (which see)."
2397 (dolist (elt handle)
2398 (with-current-buffer (car elt)
2399 (if (eq buffer-undo-list t)
2400 (setq buffer-undo-list nil)))))
2402 (defun accept-change-group (handle)
2403 "Finish a change group made with `prepare-change-group' (which see).
2404 This finishes the change group by accepting its changes as final."
2405 (dolist (elt handle)
2406 (with-current-buffer (car elt)
2407 (if (eq (cdr elt) t)
2408 (setq buffer-undo-list t)))))
2410 (defun cancel-change-group (handle)
2411 "Finish a change group made with `prepare-change-group' (which see).
2412 This finishes the change group by reverting all of its changes."
2413 (dolist (elt handle)
2414 (with-current-buffer (car elt)
2415 (setq elt (cdr elt))
2417 ;; Widen buffer temporarily so if the buffer was narrowed within
2418 ;; the body of `atomic-change-group' all changes can be undone.
2421 (if (consp elt) (car elt)))
2423 (if (consp elt) (cdr elt))))
2424 ;; Temporarily truncate the undo log at ELT.
2426 (setcar elt nil) (setcdr elt nil))
2427 (unless (eq last-command 'undo) (undo-start))
2428 ;; Make sure there's no confusion.
2429 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2430 (error "Undoing to some unrelated state"))
2433 (while (listp pending-undo-list) (undo-more 1)))
2434 ;; Reset the modified cons cell ELT to its original content.
2436 (setcar elt old-car)
2437 (setcdr elt old-cdr))
2438 ;; Revert the undo info to what it was when we grabbed the state.
2439 (setq buffer-undo-list elt))))))
2441 ;;;; Display-related functions.
2443 ;; For compatibility.
2444 (define-obsolete-function-alias 'redraw-modeline
2445 'force-mode-line-update "24.3")
2447 (defun momentary-string-display (string pos &optional exit-char message)
2448 "Momentarily display STRING in the buffer at POS.
2449 Display remains until next event is input.
2450 If POS is a marker, only its position is used; its buffer is ignored.
2451 Optional third arg EXIT-CHAR can be a character, event or event
2452 description list. EXIT-CHAR defaults to SPC. If the input is
2453 EXIT-CHAR it is swallowed; otherwise it is then available as
2454 input (as a command if nothing else).
2455 Display MESSAGE (optional fourth arg) in the echo area.
2456 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2457 (or exit-char (setq exit-char ?\s))
2458 (let ((ol (make-overlay pos pos))
2459 (str (copy-sequence string)))
2463 (overlay-put ol 'after-string str)
2465 ;; To avoid trouble with out-of-bounds position
2467 ;; If the string end is off screen, recenter now.
2468 (if (<= (window-end nil t) pos)
2469 (recenter (/ (window-height) 2))))
2470 (message (or message "Type %s to continue editing.")
2471 (single-key-description exit-char))
2472 (let ((event (read-key)))
2473 ;; `exit-char' can be an event, or an event description list.
2474 (or (eq event exit-char)
2475 (eq event (event-convert-list exit-char))
2476 (setq unread-command-events
2477 (append (this-single-command-raw-keys))))))
2478 (delete-overlay ol))))
2481 ;;;; Overlay operations
2483 (defun copy-overlay (o)
2484 "Return a copy of overlay O."
2485 (let ((o1 (if (overlay-buffer o)
2486 (make-overlay (overlay-start o) (overlay-end o)
2487 ;; FIXME: there's no easy way to find the
2488 ;; insertion-type of the two markers.
2490 (let ((o1 (make-overlay (point-min) (point-min))))
2493 (props (overlay-properties o)))
2495 (overlay-put o1 (pop props) (pop props)))
2498 (defun remove-overlays (&optional beg end name val)
2499 "Clear BEG and END of overlays whose property NAME has value VAL.
2500 Overlays might be moved and/or split.
2501 BEG and END default respectively to the beginning and end of buffer."
2502 ;; This speeds up the loops over overlays.
2503 (unless beg (setq beg (point-min)))
2504 (unless end (setq end (point-max)))
2505 (overlay-recenter end)
2507 (setq beg (prog1 end (setq end beg))))
2509 (dolist (o (overlays-in beg end))
2510 (when (eq (overlay-get o name) val)
2511 ;; Either push this overlay outside beg...end
2512 ;; or split it to exclude beg...end
2513 ;; or delete it entirely (if it is contained in beg...end).
2514 (if (< (overlay-start o) beg)
2515 (if (> (overlay-end o) end)
2517 (move-overlay (copy-overlay o)
2518 (overlay-start o) beg)
2519 (move-overlay o end (overlay-end o)))
2520 (move-overlay o (overlay-start o) beg))
2521 (if (> (overlay-end o) end)
2522 (move-overlay o end (overlay-end o))
2523 (delete-overlay o)))))))
2527 (defvar suspend-hook nil
2528 "Normal hook run by `suspend-emacs', before suspending.")
2530 (defvar suspend-resume-hook nil
2531 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2533 (defvar temp-buffer-show-hook nil
2534 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2535 When the hook runs, the temporary buffer is current, and the window it
2536 was displayed in is selected.")
2538 (defvar temp-buffer-setup-hook nil
2539 "Normal hook run by `with-output-to-temp-buffer' at the start.
2540 When the hook runs, the temporary buffer is current.
2541 This hook is normally set up with a function to put the buffer in Help
2544 (defconst user-emacs-directory
2545 (if (eq system-type 'ms-dos)
2546 ;; MS-DOS cannot have initial dot.
2549 "Directory beneath which additional per-user Emacs-specific files are placed.
2550 Various programs in Emacs store information in this directory.
2551 Note that this should end with a directory separator.
2552 See also `locate-user-emacs-file'.")
2554 ;;;; Misc. useful functions.
2556 (defsubst buffer-narrowed-p ()
2557 "Return non-nil if the current buffer is narrowed."
2558 (/= (- (point-max) (point-min)) (buffer-size)))
2560 (defun find-tag-default-bounds ()
2561 "Determine the boundaries of the default tag, based on text at point.
2562 Return a cons cell with the beginning and end of the found tag.
2563 If there is no plausible default, return nil."
2564 (let (from to bound)
2566 ;; Look at text around `point'.
2568 (skip-syntax-backward "w_") (setq from (point)))
2570 (skip-syntax-forward "w_") (setq to (point)))
2572 ;; Look between `line-beginning-position' and `point'.
2574 (and (setq bound (line-beginning-position))
2575 (skip-syntax-backward "^w_" bound)
2576 (> (setq to (point)) bound)
2577 (skip-syntax-backward "w_")
2578 (setq from (point))))
2579 ;; Look between `point' and `line-end-position'.
2581 (and (setq bound (line-end-position))
2582 (skip-syntax-forward "^w_" bound)
2583 (< (setq from (point)) bound)
2584 (skip-syntax-forward "w_")
2585 (setq to (point)))))
2588 (defun find-tag-default ()
2589 "Determine default tag to search for, based on text at point.
2590 If there is no plausible default, return nil."
2591 (let ((bounds (find-tag-default-bounds)))
2593 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
2595 (defun find-tag-default-as-regexp ()
2596 "Return regexp that matches the default tag at point.
2597 If there is no tag at point, return nil.
2599 When in a major mode that does not provide its own
2600 `find-tag-default-function', return a regexp that matches the
2601 symbol at point exactly."
2602 (let ((tag (funcall (or find-tag-default-function
2603 (get major-mode 'find-tag-default-function)
2604 'find-tag-default))))
2605 (if tag (regexp-quote tag))))
2607 (defun find-tag-default-as-symbol-regexp ()
2608 "Return regexp that matches the default tag at point as symbol.
2609 If there is no tag at point, return nil.
2611 When in a major mode that does not provide its own
2612 `find-tag-default-function', return a regexp that matches the
2613 symbol at point exactly."
2614 (let ((tag-regexp (find-tag-default-as-regexp)))
2616 (eq (or find-tag-default-function
2617 (get major-mode 'find-tag-default-function)
2620 (format "\\_<%s\\_>" tag-regexp)
2623 (defun play-sound (sound)
2624 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2625 The following keywords are recognized:
2627 :file FILE - read sound data from FILE. If FILE isn't an
2628 absolute file name, it is searched in `data-directory'.
2630 :data DATA - read sound data from string DATA.
2632 Exactly one of :file or :data must be present.
2634 :volume VOL - set volume to VOL. VOL must an integer in the
2635 range 0..100 or a float in the range 0..1.0. If not specified,
2636 don't change the volume setting of the sound device.
2638 :device DEVICE - play sound on DEVICE. If not specified,
2639 a system-dependent default device name is used.
2641 Note: :data and :device are currently not supported on Windows."
2642 (if (fboundp 'play-sound-internal)
2643 (play-sound-internal sound)
2644 (error "This Emacs binary lacks sound support")))
2646 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2648 (defun shell-quote-argument (argument)
2649 "Quote ARGUMENT for passing as argument to an inferior shell."
2651 ((eq system-type 'ms-dos)
2652 ;; Quote using double quotes, but escape any existing quotes in
2653 ;; the argument with backslashes.
2657 (if (or (null (string-match "[^\"]" argument))
2658 (< (match-end 0) (length argument)))
2659 (while (string-match "[\"]" argument start)
2660 (setq end (match-beginning 0)
2661 result (concat result (substring argument start end)
2662 "\\" (substring argument end (1+ end)))
2664 (concat "\"" result (substring argument start) "\"")))
2666 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2668 ;; First, quote argument so that CommandLineToArgvW will
2669 ;; understand it. See
2670 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2671 ;; After we perform that level of quoting, escape shell
2672 ;; metacharacters so that cmd won't mangle our argument. If the
2673 ;; argument contains no double quote characters, we can just
2674 ;; surround it with double quotes. Otherwise, we need to prefix
2675 ;; each shell metacharacter with a caret.
2678 ;; escape backslashes at end of string
2679 (replace-regexp-in-string
2682 ;; escape backslashes and quotes in string body
2683 (replace-regexp-in-string
2688 (if (string-match "[%!\"]" argument)
2691 (replace-regexp-in-string
2692 "\\([%!()\"<>&|^]\\)"
2696 (concat "\"" argument "\"")))
2699 (if (equal argument "")
2701 ;; Quote everything except POSIX filename characters.
2702 ;; This should be safe enough even for really weird shells.
2703 (replace-regexp-in-string
2705 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2708 (defun string-or-null-p (object)
2709 "Return t if OBJECT is a string or nil.
2710 Otherwise, return nil."
2711 (or (stringp object) (null object)))
2713 (defun booleanp (object)
2714 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2715 Otherwise, return nil."
2716 (and (memq object '(nil t)) t))
2718 (defun special-form-p (object)
2719 "Non-nil if and only if OBJECT is a special form."
2720 (if (and (symbolp object) (fboundp object))
2721 (setq object (indirect-function object t)))
2722 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2724 (defun macrop (object)
2725 "Non-nil if and only if OBJECT is a macro."
2726 (let ((def (indirect-function object t)))
2728 (or (eq 'macro (car def))
2729 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
2731 (defun field-at-pos (pos)
2732 "Return the field at position POS, taking stickiness etc into account."
2733 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2734 (if (eq raw-field 'boundary)
2735 (get-char-property (1- (field-end pos)) 'field)
2738 (defun sha1 (object &optional start end binary)
2739 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2740 OBJECT is either a string or a buffer. Optional arguments START and
2741 END are character positions specifying which portion of OBJECT for
2742 computing the hash. If BINARY is non-nil, return a string in binary
2744 (secure-hash 'sha1 object start end binary))
2746 (defun function-get (f prop &optional autoload)
2747 "Return the value of property PROP of function F.
2748 If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2749 in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2750 if it's an autoloaded macro."
2752 (while (and (symbolp f)
2753 (null (setq val (get f prop)))
2755 (let ((fundef (symbol-function f)))
2756 (if (and autoload (autoloadp fundef)
2758 (autoload-do-load fundef f
2759 (if (eq autoload 'macro)
2761 nil ;Re-try `get' on the same `f'.
2765 ;;;; Support for yanking and text properties.
2766 ;; Why here in subr.el rather than in simple.el? --Stef
2768 (defvar yank-handled-properties)
2769 (defvar yank-excluded-properties)
2771 (defun remove-yank-excluded-properties (start end)
2772 "Process text properties between START and END, inserted for a `yank'.
2773 Perform the handling specified by `yank-handled-properties', then
2774 remove properties specified by `yank-excluded-properties'."
2775 (let ((inhibit-read-only t))
2776 (dolist (handler yank-handled-properties)
2777 (let ((prop (car handler))
2780 (while (< run-start end)
2781 (let ((value (get-text-property run-start prop))
2782 (run-end (next-single-property-change
2783 run-start prop nil end)))
2784 (funcall fun value run-start run-end)
2785 (setq run-start run-end)))))
2786 (if (eq yank-excluded-properties t)
2787 (set-text-properties start end nil)
2788 (remove-list-of-text-properties start end yank-excluded-properties))))
2790 (defvar yank-undo-function)
2792 (defun insert-for-yank (string)
2793 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2795 See `insert-for-yank-1' for more details."
2797 (while (setq to (next-single-property-change 0 'yank-handler string))
2798 (insert-for-yank-1 (substring string 0 to))
2799 (setq string (substring string to))))
2800 (insert-for-yank-1 string))
2802 (defun insert-for-yank-1 (string)
2803 "Insert STRING at point for the `yank' command.
2804 This function is like `insert', except it honors the variables
2805 `yank-handled-properties' and `yank-excluded-properties', and the
2806 `yank-handler' text property.
2808 Properties listed in `yank-handled-properties' are processed,
2809 then those listed in `yank-excluded-properties' are discarded.
2811 If STRING has a non-nil `yank-handler' property on its first
2812 character, the normal insert behavior is altered. The value of
2813 the `yank-handler' property must be a list of one to four
2814 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2815 FUNCTION, if non-nil, should be a function of one argument, an
2816 object to insert; it is called instead of `insert'.
2817 PARAM, if present and non-nil, replaces STRING as the argument to
2818 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2819 may be a list of strings to insert as a rectangle.
2820 If NOEXCLUDE is present and non-nil, the normal removal of
2821 `yank-excluded-properties' is not performed; instead FUNCTION is
2822 responsible for the removal. This may be necessary if FUNCTION
2823 adjusts point before or after inserting the object.
2824 UNDO, if present and non-nil, should be a function to be called
2825 by `yank-pop' to undo the insertion of the current object. It is
2826 given two arguments, the start and end of the region. FUNCTION
2827 may set `yank-undo-function' to override UNDO."
2828 (let* ((handler (and (stringp string)
2829 (get-text-property 0 'yank-handler string)))
2830 (param (or (nth 1 handler) string))
2832 (inhibit-read-only inhibit-read-only)
2835 (setq yank-undo-function t)
2836 (if (nth 0 handler) ; FUNCTION
2837 (funcall (car handler) param)
2841 ;; Prevent read-only properties from interfering with the
2842 ;; following text property changes.
2843 (setq inhibit-read-only t)
2845 (unless (nth 2 handler) ; NOEXCLUDE
2846 (remove-yank-excluded-properties opoint end))
2848 ;; If last inserted char has properties, mark them as rear-nonsticky.
2849 (if (and (> end opoint)
2850 (text-properties-at (1- end)))
2851 (put-text-property (1- end) end 'rear-nonsticky t))
2853 (if (eq yank-undo-function t) ; not set by FUNCTION
2854 (setq yank-undo-function (nth 3 handler))) ; UNDO
2855 (if (nth 4 handler) ; COMMAND
2856 (setq this-command (nth 4 handler)))))
2858 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2859 "Insert before point a substring of BUFFER, without text properties.
2860 BUFFER may be a buffer or a buffer name.
2861 Arguments START and END are character positions specifying the substring.
2862 They default to the values of (point-min) and (point-max) in BUFFER."
2863 (let ((opoint (point)))
2864 (insert-buffer-substring buffer start end)
2865 (let ((inhibit-read-only t))
2866 (set-text-properties opoint (point) nil))))
2868 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2869 "Insert before point a part of BUFFER, stripping some text properties.
2870 BUFFER may be a buffer or a buffer name.
2871 Arguments START and END are character positions specifying the substring.
2872 They default to the values of (point-min) and (point-max) in BUFFER.
2873 Before insertion, process text properties according to
2874 `yank-handled-properties' and `yank-excluded-properties'."
2875 ;; Since the buffer text should not normally have yank-handler properties,
2876 ;; there is no need to handle them here.
2877 (let ((opoint (point)))
2878 (insert-buffer-substring buffer start end)
2879 (remove-yank-excluded-properties opoint (point))))
2881 (defun yank-handle-font-lock-face-property (face start end)
2882 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2883 START and END denote the start and end of the text to act on.
2884 Do nothing if FACE is nil."
2886 (null font-lock-defaults)
2887 (put-text-property start end 'face face)))
2889 ;; This removes `mouse-face' properties in *Help* buffer buttons:
2890 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2891 (defun yank-handle-category-property (category start end)
2892 "Apply property category CATEGORY's properties between START and END."
2894 (let ((start2 start))
2895 (while (< start2 end)
2896 (let ((end2 (next-property-change start2 nil end))
2897 (original (text-properties-at start2)))
2898 (set-text-properties start2 end2 (symbol-plist category))
2899 (add-text-properties start2 end2 original)
2900 (setq start2 end2))))))
2903 ;;;; Synchronous shell commands.
2905 (defun start-process-shell-command (name buffer &rest args)
2906 "Start a program in a subprocess. Return the process object for it.
2907 NAME is name for process. It is modified if necessary to make it unique.
2908 BUFFER is the buffer (or buffer name) to associate with the process.
2909 Process output goes at end of that buffer, unless you specify
2910 an output stream or filter function to handle the output.
2911 BUFFER may be also nil, meaning that this process is not associated
2913 COMMAND is the shell command to run.
2915 An old calling convention accepted any number of arguments after COMMAND,
2916 which were just concatenated to COMMAND. This is still supported but strongly
2918 ;; We used to use `exec' to replace the shell with the command,
2919 ;; but that failed to handle (...) and semicolon, etc.
2920 (start-process name buffer shell-file-name shell-command-switch
2921 (mapconcat 'identity args " ")))
2922 (set-advertised-calling-convention 'start-process-shell-command
2923 '(name buffer command) "23.1")
2925 (defun start-file-process-shell-command (name buffer &rest args)
2926 "Start a program in a subprocess. Return the process object for it.
2927 Similar to `start-process-shell-command', but calls `start-file-process'."
2930 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2931 (if (file-remote-p default-directory) "-c" shell-command-switch)
2932 (mapconcat 'identity args " ")))
2933 (set-advertised-calling-convention 'start-file-process-shell-command
2934 '(name buffer command) "23.1")
2936 (defun call-process-shell-command (command &optional infile buffer display
2938 "Execute the shell command COMMAND synchronously in separate process.
2939 The remaining arguments are optional.
2940 The program's input comes from file INFILE (nil means `/dev/null').
2941 Insert output in BUFFER before point; t means current buffer;
2942 nil for BUFFER means discard it; 0 means discard and don't wait.
2943 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2944 REAL-BUFFER says what to do with standard output, as above,
2945 while STDERR-FILE says what to do with standard error in the child.
2946 STDERR-FILE may be nil (discard standard error output),
2947 t (mix it with ordinary output), or a file name string.
2949 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2950 Remaining arguments are strings passed as additional arguments for COMMAND.
2951 Wildcards and redirection are handled as usual in the shell.
2953 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2954 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2955 status or a signal description string.
2956 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2957 ;; We used to use `exec' to replace the shell with the command,
2958 ;; but that failed to handle (...) and semicolon, etc.
2959 (call-process shell-file-name
2960 infile buffer display
2961 shell-command-switch
2962 (mapconcat 'identity (cons command args) " ")))
2964 (defun process-file-shell-command (command &optional infile buffer display
2966 "Process files synchronously in a separate process.
2967 Similar to `call-process-shell-command', but calls `process-file'."
2969 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2970 infile buffer display
2971 (if (file-remote-p default-directory) "-c" shell-command-switch)
2972 (mapconcat 'identity (cons command args) " ")))
2974 ;;;; Lisp macros to do various things temporarily.
2976 (defun internal--before-with-selected-window (window)
2977 (let ((other-frame (window-frame window)))
2978 (list window (selected-window)
2979 ;; Selecting a window on another frame also changes that
2980 ;; frame's frame-selected-window. We must save&restore it.
2981 (unless (eq (selected-frame) other-frame)
2982 (frame-selected-window other-frame))
2983 ;; Also remember the top-frame if on ttys.
2984 (unless (eq (selected-frame) other-frame)
2985 (tty-top-frame other-frame)))))
2987 (defun internal--after-with-selected-window (state)
2988 ;; First reset frame-selected-window.
2989 (when (window-live-p (nth 2 state))
2990 ;; We don't use set-frame-selected-window because it does not
2991 ;; pass the `norecord' argument to Fselect_window.
2992 (select-window (nth 2 state) 'norecord)
2993 (and (frame-live-p (nth 3 state))
2994 (not (eq (tty-top-frame) (nth 3 state)))
2995 (select-frame (nth 3 state) 'norecord)))
2996 ;; Then reset the actual selected-window.
2997 (when (window-live-p (nth 1 state))
2998 (select-window (nth 1 state) 'norecord)))
3000 (defmacro with-selected-window (window &rest body)
3001 "Execute the forms in BODY with WINDOW as the selected window.
3002 The value returned is the value of the last form in BODY.
3004 This macro saves and restores the selected window, as well as the
3005 selected window of each frame. It does not change the order of
3006 recently selected windows. If the previously selected window of
3007 some frame is no longer live at the end of BODY, that frame's
3008 selected window is left alone. If the selected window is no
3009 longer live, then whatever window is selected at the end of BODY
3012 This macro uses `save-current-buffer' to save and restore the
3013 current buffer, since otherwise its normal operation could
3014 potentially make a different buffer current. It does not alter
3015 the buffer list ordering."
3016 (declare (indent 1) (debug t))
3017 `(let ((save-selected-window--state
3018 (internal--before-with-selected-window ,window)))
3019 (save-current-buffer
3021 (progn (select-window (car save-selected-window--state) 'norecord)
3023 (internal--after-with-selected-window save-selected-window--state)))))
3025 (defmacro with-selected-frame (frame &rest body)
3026 "Execute the forms in BODY with FRAME as the selected frame.
3027 The value returned is the value of the last form in BODY.
3029 This macro saves and restores the selected frame, and changes the
3030 order of neither the recently selected windows nor the buffers in
3032 (declare (indent 1) (debug t))
3033 (let ((old-frame (make-symbol "old-frame"))
3034 (old-buffer (make-symbol "old-buffer")))
3035 `(let ((,old-frame (selected-frame))
3036 (,old-buffer (current-buffer)))
3038 (progn (select-frame ,frame 'norecord)
3040 (when (frame-live-p ,old-frame)
3041 (select-frame ,old-frame 'norecord))
3042 (when (buffer-live-p ,old-buffer)
3043 (set-buffer ,old-buffer))))))
3045 (defun internal-temp-output-buffer-show (buffer)
3046 "Internal function for `with-output-to-temp-buffer'."
3047 (with-current-buffer buffer
3048 (set-buffer-modified-p nil)
3049 (goto-char (point-min)))
3051 (if temp-buffer-show-function
3052 (funcall temp-buffer-show-function buffer)
3053 (with-current-buffer buffer
3055 (let ((window-combination-limit
3056 ;; When `window-combination-limit' equals
3057 ;; `temp-buffer' or `temp-buffer-resize' and
3058 ;; `temp-buffer-resize-mode' is enabled in this
3059 ;; buffer bind it to t so resizing steals space
3060 ;; preferably from the window that was split.
3061 (if (or (eq window-combination-limit 'temp-buffer)
3062 (and (eq window-combination-limit
3063 'temp-buffer-resize)
3064 temp-buffer-resize-mode))
3066 window-combination-limit)))
3067 (display-buffer buffer)))
3068 (frame (and window (window-frame window))))
3070 (unless (eq frame (selected-frame))
3071 (make-frame-visible frame))
3072 (setq minibuffer-scroll-window window)
3073 (set-window-hscroll window 0)
3074 ;; Don't try this with NOFORCE non-nil!
3075 (set-window-start window (point-min) t)
3076 ;; This should not be necessary.
3077 (set-window-point window (point-min))
3078 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3079 (with-selected-window window
3080 (run-hooks 'temp-buffer-show-hook))))))
3084 ;; Doc is very similar to with-temp-buffer-window.
3085 (defmacro with-output-to-temp-buffer (bufname &rest body)
3086 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3088 This construct makes buffer BUFNAME empty before running BODY.
3089 It does not make the buffer current for BODY.
3090 Instead it binds `standard-output' to that buffer, so that output
3091 generated with `prin1' and similar functions in BODY goes into
3094 At the end of BODY, this marks buffer BUFNAME unmodified and displays
3095 it in a window, but does not select it. The normal way to do this is
3096 by calling `display-buffer', then running `temp-buffer-show-hook'.
3097 However, if `temp-buffer-show-function' is non-nil, it calls that
3098 function instead (and does not run `temp-buffer-show-hook'). The
3099 function gets one argument, the buffer to display.
3101 The return value of `with-output-to-temp-buffer' is the value of the
3102 last form in BODY. If BODY does not finish normally, the buffer
3103 BUFNAME is not displayed.
3105 This runs the hook `temp-buffer-setup-hook' before BODY,
3106 with the buffer BUFNAME temporarily current. It runs the hook
3107 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3108 buffer temporarily current, and the window that was used to display it
3109 temporarily selected. But it doesn't run `temp-buffer-show-hook'
3110 if it uses `temp-buffer-show-function'.
3112 See the related form `with-temp-buffer-window'."
3114 (let ((old-dir (make-symbol "old-dir"))
3115 (buf (make-symbol "buf")))
3116 `(let* ((,old-dir default-directory)
3118 (with-current-buffer (get-buffer-create ,bufname)
3119 (prog1 (current-buffer)
3120 (kill-all-local-variables)
3121 ;; FIXME: delete_all_overlays
3122 (setq default-directory ,old-dir)
3123 (setq buffer-read-only nil)
3124 (setq buffer-file-name nil)
3125 (setq buffer-undo-list t)
3126 (let ((inhibit-read-only t)
3127 (inhibit-modification-hooks t))
3129 (run-hooks 'temp-buffer-setup-hook)))))
3130 (standard-output ,buf))
3131 (prog1 (progn ,@body)
3132 (internal-temp-output-buffer-show ,buf)))))
3134 (defmacro with-temp-file (file &rest body)
3135 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3136 The value returned is the value of the last form in BODY.
3137 See also `with-temp-buffer'."
3138 (declare (indent 1) (debug t))
3139 (let ((temp-file (make-symbol "temp-file"))
3140 (temp-buffer (make-symbol "temp-buffer")))
3141 `(let ((,temp-file ,file)
3143 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3146 (with-current-buffer ,temp-buffer
3148 (with-current-buffer ,temp-buffer
3149 (write-region nil nil ,temp-file nil 0)))
3150 (and (buffer-name ,temp-buffer)
3151 (kill-buffer ,temp-buffer))))))
3153 (defmacro with-temp-message (message &rest body)
3154 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3155 The original message is restored to the echo area after BODY has finished.
3156 The value returned is the value of the last form in BODY.
3157 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3158 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3159 Use a MESSAGE of \"\" to temporarily clear the echo area."
3160 (declare (debug t) (indent 1))
3161 (let ((current-message (make-symbol "current-message"))
3162 (temp-message (make-symbol "with-temp-message")))
3163 `(let ((,temp-message ,message)
3168 (setq ,current-message (current-message))
3169 (message "%s" ,temp-message))
3172 (if ,current-message
3173 (message "%s" ,current-message)
3176 (defmacro with-silent-modifications (&rest body)
3177 "Execute BODY, pretending it does not modify the buffer.
3178 If BODY performs real modifications to the buffer's text, other
3179 than cosmetic ones, undo data may become corrupted.
3181 This macro will run BODY normally, but doesn't count its buffer
3182 modifications as being buffer modifications. This affects things
3183 like `buffer-modified-p', checking whether the file is locked by
3184 someone else, running buffer modification hooks, and other things
3187 Typically used around modifications of text-properties which do
3188 not really affect the buffer's content."
3189 (declare (debug t) (indent 0))
3190 (let ((modified (make-symbol "modified")))
3191 `(let* ((,modified (buffer-modified-p))
3192 (buffer-undo-list t)
3193 (inhibit-read-only t)
3194 (inhibit-modification-hooks t))
3199 (restore-buffer-modified-p nil))))))
3201 (defmacro with-output-to-string (&rest body)
3202 "Execute BODY, return the text it sent to `standard-output', as a string."
3203 (declare (indent 0) (debug t))
3204 `(let ((standard-output
3205 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3208 (let ((standard-output standard-output))
3210 (with-current-buffer standard-output
3212 (kill-buffer standard-output))))
3214 (defmacro with-local-quit (&rest body)
3215 "Execute BODY, allowing quits to terminate BODY but not escape further.
3216 When a quit terminates BODY, `with-local-quit' returns nil but
3217 requests another quit. That quit will be processed as soon as quitting
3218 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3219 (declare (debug t) (indent 0))
3220 `(condition-case nil
3221 (let ((inhibit-quit nil))
3223 (quit (setq quit-flag t)
3224 ;; This call is to give a chance to handle quit-flag
3225 ;; in case inhibit-quit is nil.
3226 ;; Without this, it will not be handled until the next function
3227 ;; call, and that might allow it to exit thru a condition-case
3228 ;; that intends to handle the quit signal next time.
3229 (eval '(ignore nil)))))
3231 (defmacro while-no-input (&rest body)
3232 "Execute BODY only as long as there's no pending input.
3233 If input arrives, that ends the execution of BODY,
3234 and `while-no-input' returns t. Quitting makes it return nil.
3235 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3236 (declare (debug t) (indent 0))
3237 (let ((catch-sym (make-symbol "input")))
3240 (let ((throw-on-input ',catch-sym))
3241 (or (input-pending-p)
3242 (progn ,@body)))))))
3244 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3245 "Like `condition-case' except that it does not prevent debugging.
3246 More specifically if `debug-on-error' is set then the debugger will be invoked
3247 even if this catches the signal."
3248 (declare (debug condition-case) (indent 2))
3249 `(condition-case ,var
3251 ,@(mapcar (lambda (handler)
3252 `((debug ,@(if (listp (car handler)) (car handler)
3253 (list (car handler))))
3257 (define-obsolete-function-alias 'condition-case-no-debug
3258 'condition-case-unless-debug "24.1")
3260 (defmacro with-demoted-errors (format &rest body)
3261 "Run BODY and demote any errors to simple messages.
3262 FORMAT is a string passed to `message' to format any error message.
3263 It should contain a single %-sequence; e.g., \"Error: %S\".
3265 If `debug-on-error' is non-nil, run BODY without catching its errors.
3266 This is to be used around code which is not expected to signal an error
3267 but which should be robust in the unexpected case that an error is signaled.
3269 For backward compatibility, if FORMAT is not a constant string, it
3270 is assumed to be part of BODY, in which case the message format
3271 used is \"Error: %S\"."
3272 (declare (debug t) (indent 1))
3273 (let ((err (make-symbol "err"))
3274 (format (if (and (stringp format) body) format
3276 (if format (push format body))))))
3277 `(condition-case-unless-debug ,err
3279 (error (message ,format ,err) nil))))
3281 (defmacro combine-after-change-calls (&rest body)
3282 "Execute BODY, but don't call the after-change functions till the end.
3283 If BODY makes changes in the buffer, they are recorded
3284 and the functions on `after-change-functions' are called several times
3285 when BODY is finished.
3286 The return value is the value of the last form in BODY.
3288 If `before-change-functions' is non-nil, then calls to the after-change
3289 functions can't be deferred, so in that case this macro has no effect.
3291 Do not alter `after-change-functions' or `before-change-functions'
3293 (declare (indent 0) (debug t))
3295 (let ((combine-after-change-calls t))
3297 (combine-after-change-execute)))
3299 (defmacro with-case-table (table &rest body)
3300 "Execute the forms in BODY with TABLE as the current case table.
3301 The value returned is the value of the last form in BODY."
3302 (declare (indent 1) (debug t))
3303 (let ((old-case-table (make-symbol "table"))
3304 (old-buffer (make-symbol "buffer")))
3305 `(let ((,old-case-table (current-case-table))
3306 (,old-buffer (current-buffer)))
3308 (progn (set-case-table ,table)
3310 (with-current-buffer ,old-buffer
3311 (set-case-table ,old-case-table))))))
3313 (defmacro with-file-modes (modes &rest body)
3314 "Execute BODY with default file permissions temporarily set to MODES.
3315 MODES is as for `set-default-file-modes'."
3316 (declare (indent 1) (debug t))
3317 (let ((umask (make-symbol "umask")))
3318 `(let ((,umask (default-file-modes)))
3321 (set-default-file-modes ,modes)
3323 (set-default-file-modes ,umask)))))
3326 ;;; Matching and match data.
3328 (defvar save-match-data-internal)
3330 ;; We use save-match-data-internal as the local variable because
3331 ;; that works ok in practice (people should not use that variable elsewhere).
3332 ;; We used to use an uninterned symbol; the compiler handles that properly
3333 ;; now, but it generates slower code.
3334 (defmacro save-match-data (&rest body)
3335 "Execute the BODY forms, restoring the global value of the match data.
3336 The value returned is the value of the last form in BODY."
3337 ;; It is better not to use backquote here,
3338 ;; because that makes a bootstrapping problem
3339 ;; if you need to recompile all the Lisp files using interpreted code.
3340 (declare (indent 0) (debug t))
3342 '((save-match-data-internal (match-data)))
3343 (list 'unwind-protect
3345 ;; It is safe to free (evaporate) markers immediately here,
3346 ;; as Lisp programs should not copy from save-match-data-internal.
3347 '(set-match-data save-match-data-internal 'evaporate))))
3349 (defun match-string (num &optional string)
3350 "Return string of text matched by last search.
3351 NUM specifies which parenthesized expression in the last regexp.
3352 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3353 Zero means the entire text matched by the whole regexp or whole string.
3354 STRING should be given if the last search was by `string-match' on STRING.
3355 If STRING is nil, the current buffer should be the same buffer
3356 the search/match was performed in."
3357 (if (match-beginning num)
3359 (substring string (match-beginning num) (match-end num))
3360 (buffer-substring (match-beginning num) (match-end num)))))
3362 (defun match-string-no-properties (num &optional string)
3363 "Return string of text matched by last search, without text properties.
3364 NUM specifies which parenthesized expression in the last regexp.
3365 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3366 Zero means the entire text matched by the whole regexp or whole string.
3367 STRING should be given if the last search was by `string-match' on STRING.
3368 If STRING is nil, the current buffer should be the same buffer
3369 the search/match was performed in."
3370 (if (match-beginning num)
3372 (substring-no-properties string (match-beginning num)
3374 (buffer-substring-no-properties (match-beginning num)
3378 (defun match-substitute-replacement (replacement
3379 &optional fixedcase literal string subexp)
3380 "Return REPLACEMENT as it will be inserted by `replace-match'.
3381 In other words, all back-references in the form `\\&' and `\\N'
3382 are substituted with actual strings matched by the last search.
3383 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3384 meaning as for `replace-match'."
3385 (let ((match (match-string 0 string)))
3387 (set-match-data (mapcar (lambda (x)
3389 (- x (match-beginning 0))
3392 (replace-match replacement fixedcase literal match subexp))))
3395 (defun looking-back (regexp &optional limit greedy)
3396 "Return non-nil if text before point matches regular expression REGEXP.
3397 Like `looking-at' except matches before point, and is slower.
3398 LIMIT if non-nil speeds up the search by specifying a minimum
3399 starting position, to avoid checking matches that would start
3402 If GREEDY is non-nil, extend the match backwards as far as
3403 possible, stopping when a single additional previous character
3404 cannot be part of a match for REGEXP. When the match is
3405 extended, its starting position is allowed to occur before
3408 As a general recommendation, try to avoid using `looking-back'
3409 wherever possible, since it is slow."
3410 (let ((start (point))
3413 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3415 (if (and greedy pos)
3417 (narrow-to-region (point-min) start)
3418 (while (and (> pos (point-min))
3422 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3423 (setq pos (1- pos)))
3426 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3429 (defsubst looking-at-p (regexp)
3431 Same as `looking-at' except this function does not change the match data."
3432 (let ((inhibit-changing-match-data t))
3433 (looking-at regexp)))
3435 (defsubst string-match-p (regexp string &optional start)
3437 Same as `string-match' except this function does not change the match data."
3438 (let ((inhibit-changing-match-data t))
3439 (string-match regexp string start)))
3441 (defun subregexp-context-p (regexp pos &optional start)
3442 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3443 A subregexp context is one where a sub-regexp can appear.
3444 A non-subregexp context is for example within brackets, or within a
3445 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3446 If START is non-nil, it should be a position in REGEXP, smaller
3447 than POS, and known to be in a subregexp context."
3448 ;; Here's one possible implementation, with the great benefit that it
3449 ;; reuses the regexp-matcher's own parser, so it understands all the
3450 ;; details of the syntax. A disadvantage is that it needs to match the
3454 (string-match (substring regexp (or start 0) pos) "")
3457 (not (member (cadr err) '("Unmatched [ or [^"
3459 "Trailing backslash")))))
3460 ;; An alternative implementation:
3461 ;; (defconst re-context-re
3462 ;; (let* ((harmless-ch "[^\\[]")
3463 ;; (harmless-esc "\\\\[^{]")
3464 ;; (class-harmless-ch "[^][]")
3465 ;; (class-lb-harmless "[^]:]")
3466 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3467 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3468 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3470 ;; (concat "\\[^?]?"
3471 ;; "\\(" class-harmless-ch
3472 ;; "\\|" class-lb "\\)*"
3473 ;; "\\[?]")) ; special handling for bare [ at end of re
3474 ;; (braces "\\\\{[0-9,]+\\\\}"))
3475 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3476 ;; "\\|" class "\\|" braces "\\)*\\'"))
3477 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3478 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3483 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3484 "The default value of separators for `split-string'.
3486 A regexp matching strings of whitespace. May be locale-dependent
3487 \(as yet unimplemented). Should not match non-breaking spaces.
3489 Warning: binding this to a different value and using it as default is
3490 likely to have undesired semantics.")
3492 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3493 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3494 ;; expression leads to the equivalent implementation that if SEPARATORS
3495 ;; is defaulted, OMIT-NULLS is treated as t.
3496 (defun split-string (string &optional separators omit-nulls trim)
3497 "Split STRING into substrings bounded by matches for SEPARATORS.
3499 The beginning and end of STRING, and each match for SEPARATORS, are
3500 splitting points. The substrings matching SEPARATORS are removed, and
3501 the substrings between the splitting points are collected as a list,
3504 If SEPARATORS is non-nil, it should be a regular expression matching text
3505 which separates, but is not part of, the substrings. If nil it defaults to
3506 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3507 OMIT-NULLS is forced to t.
3509 If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
3510 that for the default value of SEPARATORS leading and trailing whitespace
3511 are effectively trimmed). If nil, all zero-length substrings are retained,
3512 which correctly parses CSV format, for example.
3514 If TRIM is non-nil, it should be a regular expression to match
3515 text to trim from the beginning and end of each substring. If trimming
3516 makes the substring empty, it is treated as null.
3518 If you want to trim whitespace from the substrings, the reliably correct
3519 way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3520 results when there is whitespace at the start or end of STRING. If you
3521 see such calls to `split-string', please fix them.
3523 Note that the effect of `(split-string STRING)' is the same as
3524 `(split-string STRING split-string-default-separators t)'. In the rare
3525 case that you wish to retain zero-length substrings when splitting on
3526 whitespace, use `(split-string STRING split-string-default-separators)'.
3528 Modifies the match data; use `save-match-data' if necessary."
3529 (let* ((keep-nulls (not (if separators omit-nulls t)))
3530 (rexp (or separators split-string-default-separators))
3536 ;; Push the substring in range THIS-START to THIS-END
3537 ;; onto LIST, trimming it and perhaps discarding it.
3540 ;; Discard the trim from start of this substring.
3541 (let ((tem (string-match trim string this-start)))
3542 (and (eq tem this-start)
3543 (setq this-start (match-end 0)))))
3545 (when (or keep-nulls (< this-start this-end))
3546 (let ((this (substring string this-start this-end)))
3548 ;; Discard the trim from end of this substring.
3550 (let ((tem (string-match (concat trim "\\'") this 0)))
3551 (and tem (< tem (length this))
3552 (setq this (substring this 0 tem)))))
3554 ;; Trimming could make it empty; check again.
3555 (when (or keep-nulls (> (length this) 0))
3556 (push this list)))))))
3558 (while (and (string-match rexp string
3560 (= start (match-beginning 0))
3561 (< start (length string)))
3563 (< start (length string)))
3565 (setq this-start start this-end (match-beginning 0)
3566 start (match-end 0))
3570 ;; Handle the substring at the end of STRING.
3571 (setq this-start start this-end (length string))
3576 (defun combine-and-quote-strings (strings &optional separator)
3577 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3578 This tries to quote the strings to avoid ambiguity such that
3579 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3580 Only some SEPARATORs will work properly."
3581 (let* ((sep (or separator " "))
3582 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3585 (if (string-match re str)
3586 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3590 (defun split-string-and-unquote (string &optional separator)
3591 "Split the STRING into a list of strings.
3592 It understands Emacs Lisp quoting within STRING, such that
3593 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3594 The SEPARATOR regexp defaults to \"\\s-+\"."
3595 (let ((sep (or separator "\\s-+"))
3596 (i (string-match "\"" string)))
3598 (split-string string sep t) ; no quoting: easy
3599 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3600 (let ((rfs (read-from-string string i)))
3602 (split-string-and-unquote (substring string (cdr rfs))
3606 ;;;; Replacement in strings.
3608 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3609 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3610 Unless optional argument INPLACE is non-nil, return a new string."
3611 (let ((i (length string))
3612 (newstr (if inplace string (copy-sequence string))))
3615 (if (eq (aref newstr i) fromchar)
3616 (aset newstr i tochar)))
3619 (defun replace-regexp-in-string (regexp rep string &optional
3620 fixedcase literal subexp start)
3621 "Replace all matches for REGEXP with REP in STRING.
3623 Return a new string containing the replacements.
3625 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3626 arguments with the same names of function `replace-match'. If START
3627 is non-nil, start replacements at that index in STRING.
3629 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3630 function. If it is a function, it is called with the actual text of each
3631 match, and its value is used as the replacement text. When REP is called,
3632 the match data are the result of matching REGEXP against a substring
3635 To replace only the first match (if any), make REGEXP match up to \\'
3636 and replace a sub-expression, e.g.
3637 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3640 ;; To avoid excessive consing from multiple matches in long strings,
3641 ;; don't just call `replace-match' continually. Walk down the
3642 ;; string looking for matches of REGEXP and building up a (reversed)
3643 ;; list MATCHES. This comprises segments of STRING which weren't
3644 ;; matched interspersed with replacements for segments that were.
3645 ;; [For a `large' number of replacements it's more efficient to
3646 ;; operate in a temporary buffer; we can't tell from the function's
3647 ;; args whether to choose the buffer-based implementation, though it
3648 ;; might be reasonable to do so for long enough STRING.]
3649 (let ((l (length string))
3650 (start (or start 0))
3653 (while (and (< start l) (string-match regexp string start))
3654 (setq mb (match-beginning 0)
3656 ;; If we matched the empty string, make sure we advance by one char
3657 (when (= me mb) (setq me (min l (1+ mb))))
3658 ;; Generate a replacement for the matched substring.
3659 ;; Operate only on the substring to minimize string consing.
3660 ;; Set up match data for the substring for replacement;
3661 ;; presumably this is likely to be faster than munging the
3662 ;; match data directly in Lisp.
3663 (string-match regexp (setq str (substring string mb me)))
3665 (cons (replace-match (if (stringp rep)
3667 (funcall rep (match-string 0 str)))
3668 fixedcase literal str subexp)
3669 (cons (substring string start mb) ; unmatched prefix
3672 ;; Reconstruct a string from the pieces.
3673 (setq matches (cons (substring string start l) matches)) ; leftover
3674 (apply #'concat (nreverse matches)))))
3676 (defun string-prefix-p (prefix string &optional ignore-case)
3677 "Return non-nil if PREFIX is a prefix of STRING.
3678 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3679 to case differences."
3680 (let ((prefix-length (length prefix)))
3681 (if (> prefix-length (length string)) nil
3682 (eq t (compare-strings prefix 0 prefix-length string
3683 0 prefix-length ignore-case)))))
3685 (defun string-suffix-p (suffix string &optional ignore-case)
3686 "Return non-nil if SUFFIX is a suffix of STRING.
3687 If IGNORE-CASE is non-nil, the comparison is done without paying
3688 attention to case differences."
3689 (let ((start-pos (- (length string) (length suffix))))
3690 (and (>= start-pos 0)
3691 (eq t (compare-strings suffix nil nil
3692 string start-pos nil ignore-case)))))
3694 (defun bidi-string-mark-left-to-right (str)
3695 "Return a string that can be safely inserted in left-to-right text.
3697 Normally, inserting a string with right-to-left (RTL) script into
3698 a buffer may cause some subsequent text to be displayed as part
3699 of the RTL segment (usually this affects punctuation characters).
3700 This function returns a string which displays as STR but forces
3701 subsequent text to be displayed as left-to-right.
3703 If STR contains any RTL character, this function returns a string
3704 consisting of STR followed by an invisible left-to-right mark
3705 \(LRM) character. Otherwise, it returns STR."
3706 (unless (stringp str)
3707 (signal 'wrong-type-argument (list 'stringp str)))
3708 (if (string-match "\\cR" str)
3709 (concat str (propertize (string ?\x200e) 'invisible t))
3712 ;;;; Specifying things to do later.
3714 (defun load-history-regexp (file)
3715 "Form a regexp to find FILE in `load-history'.
3716 FILE, a string, is described in the function `eval-after-load'."
3717 (if (file-name-absolute-p file)
3718 (setq file (file-truename file)))
3719 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
3721 (if (file-name-extension file)
3723 ;; Note: regexp-opt can't be used here, since we need to call
3724 ;; this before Emacs has been fully started. 2006-05-21
3725 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
3726 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
3729 (defun load-history-filename-element (file-regexp)
3730 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
3731 Return nil if there isn't one."
3732 (let* ((loads load-history)
3733 (load-elt (and loads (car loads))))
3736 (or (null (car load-elt))
3737 (not (string-match file-regexp (car load-elt)))))
3738 (setq loads (cdr loads)
3739 load-elt (and loads (car loads)))))
3742 (put 'eval-after-load 'lisp-indent-function 1)
3743 (defun eval-after-load (file form)
3744 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
3745 If FILE is already loaded, evaluate FORM right now.
3746 FORM can be an Elisp expression (in which case it's passed to `eval'),
3747 or a function (in which case it's passed to `funcall' with no argument).
3749 If a matching file is loaded again, FORM will be evaluated again.
3751 If FILE is a string, it may be either an absolute or a relative file
3752 name, and may have an extension (e.g. \".el\") or may lack one, and
3753 additionally may or may not have an extension denoting a compressed
3754 format (e.g. \".gz\").
3756 When FILE is absolute, this first converts it to a true name by chasing
3757 symbolic links. Only a file of this name (see next paragraph regarding
3758 extensions) will trigger the evaluation of FORM. When FILE is relative,
3759 a file whose absolute true name ends in FILE will trigger evaluation.
3761 When FILE lacks an extension, a file name with any extension will trigger
3762 evaluation. Otherwise, its extension must match FILE's. A further
3763 extension for a compressed format (e.g. \".gz\") on FILE will not affect
3766 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
3767 is evaluated at the end of any file that `provide's this feature.
3768 If the feature is provided when evaluating code not associated with a
3769 file, FORM is evaluated immediately after the provide statement.
3771 Usually FILE is just a library name like \"font-lock\" or a feature name
3774 This function makes or adds to an entry on `after-load-alist'."
3775 (declare (compiler-macro
3777 (if (eq 'quote (car-safe form))
3778 ;; Quote with lambda so the compiler can look inside.
3779 `(eval-after-load ,file (lambda () ,(nth 1 form)))
3781 ;; Add this FORM into after-load-alist (regardless of whether we'll be
3782 ;; evaluating it now).
3783 (let* ((regexp-or-feature
3785 (setq file (purecopy (load-history-regexp file)))
3787 (elt (assoc regexp-or-feature after-load-alist))
3789 (if (functionp form) form
3790 ;; Try to use the "current" lexical/dynamic mode for `form'.
3791 (eval `(lambda () ,form) lexical-binding))))
3793 (setq elt (list regexp-or-feature))
3794 (push elt after-load-alist))
3795 ;; Is there an already loaded file whose name (or `provide' name)
3797 (prog1 (if (if (stringp file)
3798 (load-history-filename-element regexp-or-feature)
3802 (if (not (symbolp regexp-or-feature)) func
3803 ;; For features, the after-load-alist elements get run when
3804 ;; `provide' is called rather than at the end of the file.
3805 ;; So add an indirection to make sure that `func' is really run
3806 ;; "after-load" in case the provide call happens early.
3808 (if (not load-file-name)
3809 ;; Not being provided from a file, run func right now.
3811 (let ((lfn load-file-name)
3812 ;; Don't use letrec, because equal (in
3813 ;; add/remove-hook) would get trapped in a cycle.
3814 (fun (make-symbol "eval-after-load-helper")))
3815 (fset fun (lambda (file)
3816 (when (equal file lfn)
3817 (remove-hook 'after-load-functions fun)
3819 (add-hook 'after-load-functions fun 'append)))))))
3820 ;; Add FORM to the element unless it's already there.
3821 (unless (member delayed-func (cdr elt))
3822 (nconc elt (list delayed-func)))))))
3824 (defmacro with-eval-after-load (file &rest body)
3825 "Execute BODY after FILE is loaded.
3826 FILE is normally a feature name, but it can also be a file name,
3827 in case that file does not provide any feature."
3828 (declare (indent 1) (debug t))
3829 `(eval-after-load ,file (lambda () ,@body)))
3831 (defvar after-load-functions nil
3832 "Special hook run after loading a file.
3833 Each function there is called with a single argument, the absolute
3834 name of the file just loaded.")
3836 (defun do-after-load-evaluation (abs-file)
3837 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
3838 ABS-FILE, a string, should be the absolute true name of a file just loaded.
3839 This function is called directly from the C code."
3840 ;; Run the relevant eval-after-load forms.
3841 (dolist (a-l-element after-load-alist)
3842 (when (and (stringp (car a-l-element))
3843 (string-match-p (car a-l-element) abs-file))
3844 ;; discard the file name regexp
3845 (mapc #'funcall (cdr a-l-element))))
3846 ;; Complain when the user uses obsolete files.
3847 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
3848 ;; Maybe we should just use display-warning? This seems yucky...
3849 (let* ((file (file-name-nondirectory abs-file))
3850 (msg (format "Package %s is obsolete!"
3852 (string-match "\\.elc?\\>" file)))))
3853 ;; Cribbed from cl--compiling-file.
3854 (if (and (boundp 'byte-compile--outbuffer)
3855 (bufferp (symbol-value 'byte-compile--outbuffer))
3856 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
3857 " *Compiler Output*"))
3858 ;; Don't warn about obsolete files using other obsolete files.
3859 (unless (and (stringp byte-compile-current-file)
3860 (string-match-p "/obsolete/[^/]*\\'"
3862 byte-compile-current-file
3863 byte-compile-root-dir)))
3864 (byte-compile-log-warning msg))
3865 (run-with-timer 0 nil
3870 ;; Finally, run any other hook.
3871 (run-hook-with-args 'after-load-functions abs-file))
3873 (defun eval-next-after-load (file)
3874 "Read the following input sexp, and run it whenever FILE is loaded.
3875 This makes or adds to an entry on `after-load-alist'.
3876 FILE should be the name of a library, with no directory name."
3877 (declare (obsolete eval-after-load "23.2"))
3878 (eval-after-load file (read)))
3881 (defun display-delayed-warnings ()
3882 "Display delayed warnings from `delayed-warnings-list'.
3883 Used from `delayed-warnings-hook' (which see)."
3884 (dolist (warning (nreverse delayed-warnings-list))
3885 (apply 'display-warning warning))
3886 (setq delayed-warnings-list nil))
3888 (defun collapse-delayed-warnings ()
3889 "Remove duplicates from `delayed-warnings-list'.
3890 Collapse identical adjacent warnings into one (plus count).
3891 Used from `delayed-warnings-hook' (which see)."
3894 (while delayed-warnings-list
3895 (setq warning (pop delayed-warnings-list))
3896 (if (equal warning (car delayed-warnings-list))
3897 (setq count (1+ count))
3899 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
3902 (push warning collapsed)))
3903 (setq delayed-warnings-list (nreverse collapsed))))
3905 ;; At present this is only used for Emacs internals.
3906 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
3907 (defvar delayed-warnings-hook '(collapse-delayed-warnings
3908 display-delayed-warnings)
3909 "Normal hook run to process and display delayed warnings.
3910 By default, this hook contains functions to consolidate the
3911 warnings listed in `delayed-warnings-list', display them, and set
3912 `delayed-warnings-list' back to nil.")
3914 (defun delay-warning (type message &optional level buffer-name)
3915 "Display a delayed warning.
3916 Aside from going through `delayed-warnings-list', this is equivalent
3917 to `display-warning'."
3918 (push (list type message level buffer-name) delayed-warnings-list))
3921 ;;;; invisibility specs
3923 (defun add-to-invisibility-spec (element)
3924 "Add ELEMENT to `buffer-invisibility-spec'.
3925 See documentation for `buffer-invisibility-spec' for the kind of elements
3927 (if (eq buffer-invisibility-spec t)
3928 (setq buffer-invisibility-spec (list t)))
3929 (setq buffer-invisibility-spec
3930 (cons element buffer-invisibility-spec)))
3932 (defun remove-from-invisibility-spec (element)
3933 "Remove ELEMENT from `buffer-invisibility-spec'."
3934 (if (consp buffer-invisibility-spec)
3935 (setq buffer-invisibility-spec
3936 (delete element buffer-invisibility-spec))))
3940 (defmacro with-syntax-table (table &rest body)
3941 "Evaluate BODY with syntax table of current buffer set to TABLE.
3942 The syntax table of the current buffer is saved, BODY is evaluated, and the
3943 saved table is restored, even in case of an abnormal exit.
3944 Value is what BODY returns."
3945 (declare (debug t) (indent 1))
3946 (let ((old-table (make-symbol "table"))
3947 (old-buffer (make-symbol "buffer")))
3948 `(let ((,old-table (syntax-table))
3949 (,old-buffer (current-buffer)))
3952 (set-syntax-table ,table)
3954 (save-current-buffer
3955 (set-buffer ,old-buffer)
3956 (set-syntax-table ,old-table))))))
3958 (defun make-syntax-table (&optional oldtable)
3959 "Return a new syntax table.
3960 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3961 from `standard-syntax-table' otherwise."
3962 (let ((table (make-char-table 'syntax-table nil)))
3963 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3966 (defun syntax-after (pos)
3967 "Return the raw syntax descriptor for the char after POS.
3968 If POS is outside the buffer's accessible portion, return nil."
3969 (unless (or (< pos (point-min)) (>= pos (point-max)))
3970 (let ((st (if parse-sexp-lookup-properties
3971 (get-char-property pos 'syntax-table))))
3973 (aref (or st (syntax-table)) (char-after pos))))))
3975 (defun syntax-class (syntax)
3976 "Return the code for the syntax class described by SYNTAX.
3978 SYNTAX should be a raw syntax descriptor; the return value is a
3979 integer which encodes the corresponding syntax class. See Info
3980 node `(elisp)Syntax Table Internals' for a list of codes.
3982 If SYNTAX is nil, return nil."
3983 (and syntax (logand (car syntax) 65535)))
3985 ;; Utility motion commands
3989 (defun forward-whitespace (arg)
3990 "Move point to the end of the next sequence of whitespace chars.
3991 Each such sequence may be a single newline, or a sequence of
3992 consecutive space and/or tab characters.
3993 With prefix argument ARG, do it ARG times if positive, or move
3994 backwards ARG times if negative."
3997 (re-search-forward "[ \t]+\\|\n" nil 'move arg)
3999 (if (re-search-backward "[ \t]+\\|\n" nil 'move)
4000 (or (eq (char-after (match-beginning 0)) ?\n)
4001 (skip-chars-backward " \t")))
4002 (setq arg (1+ arg)))))
4006 (defun forward-symbol (arg)
4007 "Move point to the next position that is the end of a symbol.
4008 A symbol is any sequence of characters that are in either the
4009 word constituent or symbol constituent syntax class.
4010 With prefix argument ARG, do it ARG times if positive, or move
4011 backwards ARG times if negative."
4014 (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
4016 (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
4017 (skip-syntax-backward "w_"))
4018 (setq arg (1+ arg)))))
4022 (defun forward-same-syntax (&optional arg)
4023 "Move point past all characters with the same syntax class.
4024 With prefix argument ARG, do it ARG times if positive, or move
4025 backwards ARG times if negative."
4027 (or arg (setq arg 1))
4029 (skip-syntax-backward
4030 (char-to-string (char-syntax (char-before))))
4031 (setq arg (1+ arg)))
4033 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4034 (setq arg (1- arg))))
4039 (defvar text-clone--maintaining nil)
4041 (defun text-clone--maintain (ol1 after beg end &optional _len)
4042 "Propagate the changes made under the overlay OL1 to the other clones.
4043 This is used on the `modification-hooks' property of text clones."
4044 (when (and after (not undo-in-progress)
4045 (not text-clone--maintaining)
4046 (overlay-start ol1))
4047 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4048 (setq beg (max beg (+ (overlay-start ol1) margin)))
4049 (setq end (min end (- (overlay-end ol1) margin)))
4052 (when (overlay-get ol1 'text-clone-syntax)
4053 ;; Check content of the clone's text.
4054 (let ((cbeg (+ (overlay-start ol1) margin))
4055 (cend (- (overlay-end ol1) margin)))
4058 (if (not (re-search-forward
4059 (overlay-get ol1 'text-clone-syntax) cend t))
4060 ;; Mark the overlay for deletion.
4062 (when (< (match-end 0) cend)
4063 ;; Shrink the clone at its end.
4064 (setq end (min end (match-end 0)))
4065 (move-overlay ol1 (overlay-start ol1)
4066 (+ (match-end 0) margin)))
4067 (when (> (match-beginning 0) cbeg)
4068 ;; Shrink the clone at its beginning.
4069 (setq beg (max (match-beginning 0) beg))
4070 (move-overlay ol1 (- (match-beginning 0) margin)
4071 (overlay-end ol1)))))))
4072 ;; Now go ahead and update the clones.
4073 (let ((head (- beg (overlay-start ol1)))
4074 (tail (- (overlay-end ol1) end))
4075 (str (buffer-substring beg end))
4077 (text-clone--maintaining t))
4078 (dolist (ol2 (overlay-get ol1 'text-clones))
4079 (let ((oe (overlay-end ol2)))
4080 (unless (or (eq ol1 ol2) (null oe))
4081 (setq nothing-left nil)
4082 (let ((mod-beg (+ (overlay-start ol2) head)))
4083 ;;(overlay-put ol2 'modification-hooks nil)
4084 (goto-char (- (overlay-end ol2) tail))
4085 (unless (> mod-beg (point))
4086 (save-excursion (insert str))
4087 (delete-region mod-beg (point)))
4088 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
4090 (if nothing-left (delete-overlay ol1))))))))
4092 (defun text-clone-create (start end &optional spreadp syntax)
4093 "Create a text clone of START...END at point.
4094 Text clones are chunks of text that are automatically kept identical:
4095 changes done to one of the clones will be immediately propagated to the other.
4097 The buffer's content at point is assumed to be already identical to
4098 the one between START and END.
4099 If SYNTAX is provided it's a regexp that describes the possible text of
4100 the clones; the clone will be shrunk or killed if necessary to ensure that
4101 its text matches the regexp.
4102 If SPREADP is non-nil it indicates that text inserted before/after the
4103 clone should be incorporated in the clone."
4104 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4105 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4106 ;; (with a one-char margin at each end) with `t nil'.
4107 ;; We opted for a larger overlay because it behaves better in the case
4108 ;; where the clone is reduced to the empty string (we want the overlay to
4109 ;; stay when the clone's content is the empty string and we want to use
4110 ;; `evaporate' to make sure those overlays get deleted when needed).
4112 (let* ((pt-end (+ (point) (- end start)))
4113 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4115 (end-margin (if (or (not spreadp)
4116 (>= pt-end (point-max))
4117 (>= start (point-max)))
4119 ;; FIXME: Reuse overlays at point to extend dups!
4120 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4121 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4122 (dups (list ol1 ol2)))
4123 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
4124 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4125 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4126 ;;(overlay-put ol1 'face 'underline)
4127 (overlay-put ol1 'evaporate t)
4128 (overlay-put ol1 'text-clones dups)
4130 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
4131 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4132 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4133 ;;(overlay-put ol2 'face 'underline)
4134 (overlay-put ol2 'evaporate t)
4135 (overlay-put ol2 'text-clones dups)))
4137 ;;;; Mail user agents.
4139 ;; Here we include just enough for other packages to be able
4142 (defun define-mail-user-agent (symbol composefunc sendfunc
4143 &optional abortfunc hookvar)
4144 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4146 SYMBOL can be any Lisp symbol. Its function definition and/or
4147 value as a variable do not matter for this usage; we use only certain
4148 properties on its property list, to encode the rest of the arguments.
4150 COMPOSEFUNC is program callable function that composes an outgoing
4151 mail message buffer. This function should set up the basics of the
4152 buffer without requiring user interaction. It should populate the
4153 standard mail headers, leaving the `to:' and `subject:' headers blank
4156 COMPOSEFUNC should accept several optional arguments--the same
4157 arguments that `compose-mail' takes. See that function's documentation.
4159 SENDFUNC is the command a user would run to send the message.
4161 Optional ABORTFUNC is the command a user would run to abort the
4162 message. For mail packages that don't have a separate abort function,
4163 this can be `kill-buffer' (the equivalent of omitting this argument).
4165 Optional HOOKVAR is a hook variable that gets run before the message
4166 is actually sent. Callers that use the `mail-user-agent' may
4167 install a hook function temporarily on this hook variable.
4168 If HOOKVAR is nil, `mail-send-hook' is used.
4170 The properties used on SYMBOL are `composefunc', `sendfunc',
4171 `abortfunc', and `hookvar'."
4172 (put symbol 'composefunc composefunc)
4173 (put symbol 'sendfunc sendfunc)
4174 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4175 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
4177 ;;;; Progress reporters.
4179 ;; Progress reporter has the following structure:
4181 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4188 ;; This weirdness is for optimization reasons: we want
4189 ;; `progress-reporter-update' to be as fast as possible, so
4190 ;; `(car reporter)' is better than `(aref reporter 0)'.
4192 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4193 ;; digits of precision, it doesn't really matter here. On the other
4194 ;; hand, it greatly simplifies the code.
4196 (defsubst progress-reporter-update (reporter &optional value)
4197 "Report progress of an operation in the echo area.
4198 REPORTER should be the result of a call to `make-progress-reporter'.
4200 If REPORTER is a numerical progress reporter---i.e. if it was
4201 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4202 `make-progress-reporter'---then VALUE should be a number between
4203 MIN-VALUE and MAX-VALUE.
4205 If REPORTER is a non-numerical reporter, VALUE should be nil.
4207 This function is relatively inexpensive. If the change since
4208 last update is too small or insufficient time has passed, it does
4210 (when (or (not (numberp value)) ; For pulsing reporter
4211 (>= value (car reporter))) ; For numerical reporter
4212 (progress-reporter-do-update reporter value)))
4214 (defun make-progress-reporter (message &optional min-value max-value
4215 current-value min-change min-time)
4216 "Return progress reporter object for use with `progress-reporter-update'.
4218 MESSAGE is shown in the echo area, with a status indicator
4219 appended to the end. When you call `progress-reporter-done', the
4220 word \"done\" is printed after the MESSAGE. You can change the
4221 MESSAGE of an existing progress reporter by calling
4222 `progress-reporter-force-update'.
4224 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4225 and final (100% complete) states of operation; the latter should
4226 be larger. In this case, the status message shows the percentage
4229 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4230 message shows a \"spinning\", non-numeric indicator.
4232 Optional CURRENT-VALUE is the initial progress; the default is
4234 Optional MIN-CHANGE is the minimal change in percents to report;
4236 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4237 and/or MAX-VALUE are nil.
4239 Optional MIN-TIME specifies the minimum interval time between
4240 echo area updates (default is 0.2 seconds.) If the function
4241 `float-time' is not present, time is not tracked at all. If the
4242 OS is not capable of measuring fractions of seconds, this
4243 parameter is effectively rounded up."
4244 (when (string-match "[[:alnum:]]\\'" message)
4245 (setq message (concat message "...")))
4247 (setq min-time 0.2))
4249 ;; Force a call to `message' now
4250 (cons (or min-value 0)
4251 (vector (if (and (fboundp 'float-time)
4257 (if min-change (max (min min-change 50) 1) 1)
4259 (progress-reporter-update reporter (or current-value min-value))
4262 (defun progress-reporter-force-update (reporter &optional value new-message)
4263 "Report progress of an operation in the echo area unconditionally.
4265 The first two arguments are the same as in `progress-reporter-update'.
4266 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
4267 (let ((parameters (cdr reporter)))
4269 (aset parameters 3 new-message))
4270 (when (aref parameters 0)
4271 (aset parameters 0 (float-time)))
4272 (progress-reporter-do-update reporter value)))
4274 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4275 "Characters to use for pulsing progress reporters.")
4277 (defun progress-reporter-do-update (reporter value)
4278 (let* ((parameters (cdr reporter))
4279 (update-time (aref parameters 0))
4280 (min-value (aref parameters 1))
4281 (max-value (aref parameters 2))
4282 (text (aref parameters 3))
4283 (current-time (float-time))
4285 ;; See if enough time has passed since the last update.
4286 (or (not update-time)
4287 (when (>= current-time update-time)
4288 ;; Calculate time for the next update
4289 (aset parameters 0 (+ update-time (aref parameters 5)))))))
4290 (cond ((and min-value max-value)
4291 ;; Numerical indicator
4292 (let* ((one-percent (/ (- max-value min-value) 100.0))
4293 (percentage (if (= max-value min-value)
4295 (truncate (/ (- value min-value)
4297 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4298 ;; message because not enough time has passed, use 1
4299 ;; instead of MIN-CHANGE. This makes delays between echo
4300 ;; area updates closer to MIN-TIME.
4302 (min (+ min-value (* (+ percentage
4303 (if enough-time-passed
4309 (when (integerp value)
4310 (setcar reporter (ceiling (car reporter))))
4311 ;; Only print message if enough time has passed
4312 (when enough-time-passed
4313 (if (> percentage 0)
4314 (message "%s%d%%" text percentage)
4315 (message "%s" text)))))
4316 ;; Pulsing indicator
4318 (let ((index (mod (1+ (car reporter)) 4))
4319 (message-log-max nil))
4320 (setcar reporter index)
4323 (aref progress-reporter--pulse-characters
4326 (defun progress-reporter-done (reporter)
4327 "Print reporter's message followed by word \"done\" in echo area."
4328 (message "%sdone" (aref (cdr reporter) 3)))
4330 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4331 "Loop a certain number of times and report progress in the echo area.
4332 Evaluate BODY with VAR bound to successive integers running from
4333 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4334 the return value (nil if RESULT is omitted).
4336 At each iteration MESSAGE followed by progress percentage is
4337 printed in the echo area. After the loop is finished, MESSAGE
4338 followed by word \"done\" is printed. This macro is a
4339 convenience wrapper around `make-progress-reporter' and friends.
4341 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4342 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4343 (let ((temp (make-symbol "--dotimes-temp--"))
4344 (temp2 (make-symbol "--dotimes-temp2--"))
4348 (,(car spec) ,start)
4349 (,temp2 (make-progress-reporter ,message ,start ,end)))
4350 (while (< ,(car spec) ,temp)
4352 (progress-reporter-update ,temp2
4353 (setq ,(car spec) (1+ ,(car spec)))))
4354 (progress-reporter-done ,temp2)
4355 nil ,@(cdr (cdr spec)))))
4358 ;;;; Comparing version strings.
4360 (defconst version-separator "."
4361 "Specify the string used to separate the version elements.
4363 Usually the separator is \".\", but it can be any other string.")
4366 (defconst version-regexp-alist
4367 '(("^[-_+ ]?snapshot$" . -4)
4368 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4370 ;; treat "1.2.3-CVS" as snapshot release
4371 ("^[-_+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4)
4372 ("^[-_+ ]?alpha$" . -3)
4373 ("^[-_+ ]?beta$" . -2)
4374 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
4375 "Specify association between non-numeric version and its priority.
4377 This association is used to handle version string like \"1.0pre2\",
4378 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4379 non-numeric part of a version string to an integer. For example:
4381 String Version Integer List Version
4382 \"0.9snapshot\" (0 9 -4)
4383 \"1.0-git\" (1 0 -4)
4384 \"1.0pre2\" (1 0 -1 2)
4385 \"1.0PRE2\" (1 0 -1 2)
4386 \"22.8beta3\" (22 8 -2 3)
4387 \"22.8 Beta3\" (22 8 -2 3)
4388 \"0.9alpha1\" (0 9 -3 1)
4389 \"0.9AlphA1\" (0 9 -3 1)
4390 \"0.9 alpha\" (0 9 -3)
4392 Each element has the following form:
4398 REGEXP regexp used to match non-numeric part of a version string.
4399 It should begin with the `^' anchor and end with a `$' to
4400 prevent false hits. Letter-case is ignored while matching
4403 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4406 (defun version-to-list (ver)
4407 "Convert version string VER into a list of integers.
4409 The version syntax is given by the following EBNF:
4411 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4413 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4415 SEPARATOR ::= `version-separator' (which see)
4416 | `version-regexp-alist' (which see).
4418 The NUMBER part is optional if SEPARATOR is a match for an element
4419 in `version-regexp-alist'.
4421 Examples of valid version syntax:
4423 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4425 Examples of invalid version syntax:
4427 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4429 Examples of version conversion:
4431 Version String Version as a List of Integers
4432 \"1.0.7.5\" (1 0 7 5)
4433 \"1.0pre2\" (1 0 -1 2)
4434 \"1.0PRE2\" (1 0 -1 2)
4435 \"22.8beta3\" (22 8 -2 3)
4436 \"22.8Beta3\" (22 8 -2 3)
4437 \"0.9alpha1\" (0 9 -3 1)
4438 \"0.9AlphA1\" (0 9 -3 1)
4439 \"0.9alpha\" (0 9 -3)
4440 \"0.9snapshot\" (0 9 -4)
4441 \"1.0-git\" (1 0 -4)
4443 See documentation for `version-separator' and `version-regexp-alist'."
4444 (or (and (stringp ver) (> (length ver) 0))
4445 (error "Invalid version string: '%s'" ver))
4446 ;; Change .x.y to 0.x.y
4447 (if (and (>= (length ver) (length version-separator))
4448 (string-equal (substring ver 0 (length version-separator))
4450 (setq ver (concat "0" ver)))
4453 (case-fold-search t) ; ignore case in matching
4455 (while (and (setq s (string-match "[0-9]+" ver i))
4457 ;; handle numeric part
4458 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4461 ;; handle non-numeric part
4462 (when (and (setq s (string-match "[^0-9]+" ver i))
4464 (setq s (substring ver i (match-end 0))
4466 ;; handle alpha, beta, pre, etc. separator
4467 (unless (string= s version-separator)
4468 (setq al version-regexp-alist)
4469 (while (and al (not (string-match (caar al) s)))
4472 (push (cdar al) lst))
4473 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4474 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4475 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4477 (t (error "Invalid version syntax: '%s'" ver))))))
4479 (error "Invalid version syntax: '%s'" ver)
4483 (defun version-list-< (l1 l2)
4484 "Return t if L1, a list specification of a version, is lower than L2.
4486 Note that a version specified by the list (1) is equal to (1 0),
4487 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4488 Also, a version given by the list (1) is higher than (1 -1), which in
4489 turn is higher than (1 -2), which is higher than (1 -3)."
4490 (while (and l1 l2 (= (car l1) (car l2)))
4494 ;; l1 not null and l2 not null
4495 ((and l1 l2) (< (car l1) (car l2)))
4496 ;; l1 null and l2 null ==> l1 length = l2 length
4497 ((and (null l1) (null l2)) nil)
4498 ;; l1 not null and l2 null ==> l1 length > l2 length
4499 (l1 (< (version-list-not-zero l1) 0))
4500 ;; l1 null and l2 not null ==> l2 length > l1 length
4501 (t (< 0 (version-list-not-zero l2)))))
4504 (defun version-list-= (l1 l2)
4505 "Return t if L1, a list specification of a version, is equal to L2.
4507 Note that a version specified by the list (1) is equal to (1 0),
4508 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4509 Also, a version given by the list (1) is higher than (1 -1), which in
4510 turn is higher than (1 -2), which is higher than (1 -3)."
4511 (while (and l1 l2 (= (car l1) (car l2)))
4515 ;; l1 not null and l2 not null
4517 ;; l1 null and l2 null ==> l1 length = l2 length
4518 ((and (null l1) (null l2)))
4519 ;; l1 not null and l2 null ==> l1 length > l2 length
4520 (l1 (zerop (version-list-not-zero l1)))
4521 ;; l1 null and l2 not null ==> l2 length > l1 length
4522 (t (zerop (version-list-not-zero l2)))))
4525 (defun version-list-<= (l1 l2)
4526 "Return t if L1, a list specification of a version, is lower or equal to L2.
4528 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4529 etc. That is, the trailing zeroes are insignificant. Also, integer
4530 list (1) is greater than (1 -1) which is greater than (1 -2)
4531 which is greater than (1 -3)."
4532 (while (and l1 l2 (= (car l1) (car l2)))
4536 ;; l1 not null and l2 not null
4537 ((and l1 l2) (< (car l1) (car l2)))
4538 ;; l1 null and l2 null ==> l1 length = l2 length
4539 ((and (null l1) (null l2)))
4540 ;; l1 not null and l2 null ==> l1 length > l2 length
4541 (l1 (<= (version-list-not-zero l1) 0))
4542 ;; l1 null and l2 not null ==> l2 length > l1 length
4543 (t (<= 0 (version-list-not-zero l2)))))
4545 (defun version-list-not-zero (lst)
4546 "Return the first non-zero element of LST, which is a list of integers.
4548 If all LST elements are zeros or LST is nil, return zero."
4549 (while (and lst (zerop (car lst)))
4550 (setq lst (cdr lst)))
4553 ;; there is no element different of zero
4557 (defun version< (v1 v2)
4558 "Return t if version V1 is lower (older) than V2.
4560 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4561 etc. That is, the trailing \".0\"s are insignificant. Also, version
4562 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4563 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4564 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4565 (version-list-< (version-to-list v1) (version-to-list v2)))
4567 (defun version<= (v1 v2)
4568 "Return t if version V1 is lower (older) than or equal to V2.
4570 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4571 etc. That is, the trailing \".0\"s are insignificant. Also, version
4572 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4573 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4574 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4575 (version-list-<= (version-to-list v1) (version-to-list v2)))
4577 (defun version= (v1 v2)
4578 "Return t if version V1 is equal to V2.
4580 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4581 etc. That is, the trailing \".0\"s are insignificant. Also, version
4582 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4583 which is higher than \"1alpha\", which is higher than \"1snapshot\".
4584 Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
4585 (version-list-= (version-to-list v1) (version-to-list v2)))
4589 (defconst menu-bar-separator '("--")
4590 "Separator for menus.")
4592 ;; The following statement ought to be in print.c, but `provide' can't
4594 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4595 (when (hash-table-p (car (read-from-string
4596 (prin1-to-string (make-hash-table)))))
4597 (provide 'hashtable-print-readable))
4599 ;; This is used in lisp/Makefile.in and in leim/Makefile.in to
4600 ;; generate file names for autoloads, custom-deps, and finder-data.
4601 (defun unmsys--file-name (file)
4602 "Produce the canonical file name for FILE from its MSYS form.
4604 On systems other than MS-Windows, just returns FILE.
4605 On MS-Windows, converts /d/foo/bar form of file names
4606 passed by MSYS Make into d:/foo/bar that Emacs can grok.
4608 This function is called from lisp/Makefile and leim/Makefile."
4609 (when (and (eq system-type 'windows-nt)
4610 (string-match "\\`/[a-zA-Z]/" file))
4611 (setq file (concat (substring file 1 2) ":" (substring file 2))))
4615 ;;; subr.el ends here