1 ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2012
4 ;; Free Software Foundation, Inc.
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 (defvar custom-declare-variable-list nil
33 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
34 Each element of this list holds the arguments to one call to `defcustom'.")
36 ;; Use this, rather than defcustom, in subr.el and other files loaded
38 (defun custom-declare-variable-early (&rest arguments)
39 (setq custom-declare-variable-list
40 (cons arguments custom-declare-variable-list)))
42 (defmacro declare-function (fn file &optional arglist fileonly)
43 "Tell the byte-compiler that function FN is defined, in FILE.
44 Optional ARGLIST is the argument list used by the function. The
45 FILE argument is not used by the byte-compiler, but by the
46 `check-declare' package, which checks that FILE contains a
47 definition for FN. ARGLIST is used by both the byte-compiler and
48 `check-declare' to check for consistency.
50 FILE can be either a Lisp file (in which case the \".el\"
51 extension is optional), or a C file. C files are expanded
52 relative to the Emacs \"src/\" directory. Lisp files are
53 searched for using `locate-library', and if that fails they are
54 expanded relative to the location of the file containing the
55 declaration. A FILE with an \"ext:\" prefix is an external file.
56 `check-declare' will check such files if they are found, and skip
57 them without error if they are not.
59 FILEONLY non-nil means that `check-declare' will only check that
60 FILE exists, not that it defines FN. This is intended for
61 function-definitions that `check-declare' does not recognize, e.g.
64 To specify a value for FILEONLY without passing an argument list,
65 set ARGLIST to t. This is necessary because nil means an
66 empty argument list, rather than an unspecified one.
68 Note that for the purposes of `check-declare', this statement
69 must be the first non-whitespace on a line.
71 For more information, see Info node `(elisp)Declaring Functions'."
72 ;; Does nothing - byte-compile-declare-function does the work.
76 ;;;; Basic Lisp macros.
80 (defmacro noreturn (form)
81 "Evaluate FORM, expecting it not to return.
82 If FORM does return, signal an error."
84 (error "Form marked with `noreturn' did return")))
86 (defmacro 1value (form)
87 "Evaluate FORM, expecting a constant return value.
88 This is the global do-nothing version. There is also `testcover-1value'
89 that complains if FORM ever does return differing values."
92 (defmacro def-edebug-spec (symbol spec)
93 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
94 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
95 0 (instrument no arguments); t (instrument all arguments);
96 a symbol (naming a function with an Edebug specification); or a list.
97 The elements of the list describe the argument types; see
98 Info node `(elisp)Specification List' for details."
99 `(put (quote ,symbol) 'edebug-form-spec (quote ,spec)))
101 (defmacro lambda (&rest cdr)
102 "Return a lambda expression.
103 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
104 self-quoting; the result of evaluating the lambda expression is the
105 expression itself. The lambda expression may then be treated as a
106 function, i.e., stored as the function value of a symbol, passed to
107 `funcall' or `mapcar', etc.
109 ARGS should take the same form as an argument list for a `defun'.
110 DOCSTRING is an optional documentation string.
111 If present, it should describe how to call the function.
112 But documentation strings are usually not useful in nameless functions.
113 INTERACTIVE should be a call to the function `interactive', which see.
114 It may also be omitted.
115 BODY should be a list of Lisp expressions.
117 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
118 (declare (doc-string 2) (indent defun)
119 (debug (&define lambda-list
121 [&optional ("interactive" interactive)]
123 ;; Note that this definition should not use backquotes; subr.el should not
124 ;; depend on backquote.el.
125 (list 'function (cons 'lambda cdr)))
127 (defmacro setq-local (var val)
128 "Set variable VAR to value VAL in current buffer."
129 ;; Can't use backquote here, it's too early in the bootstrap.
130 (list 'set (list 'make-local-variable (list 'quote var)) val))
132 (defmacro defvar-local (var val &optional docstring)
133 "Define VAR as a buffer-local variable with default value VAL.
134 Like `defvar' but additionally marks the variable as being automatically
135 buffer-local wherever it is set."
136 (declare (debug defvar) (doc-string 3))
137 ;; Can't use backquote here, it's too early in the bootstrap.
138 (list 'progn (list 'defvar var val docstring)
139 (list 'make-variable-buffer-local (list 'quote var))))
141 (defun apply-partially (fun &rest args)
142 "Return a function that is a partial application of FUN to ARGS.
143 ARGS is a list of the first N arguments to pass to FUN.
144 The result is a new function which does the same as FUN, except that
145 the first N arguments are fixed at the values with which this function
147 `(closure (t) (&rest args)
148 (apply ',fun ,@(mapcar (lambda (arg) `',arg) args) args)))
150 (defmacro push (newelt place)
151 "Add NEWELT to the list stored in the generalized variable PLACE.
152 This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
153 except that PLACE is only evaluated once (after NEWELT)."
154 (declare (debug (form gv-place)))
156 ;; Important special case, to avoid triggering GV too early in
159 (list 'cons newelt place))
161 (macroexp-let2 macroexp-copyable-p v newelt
162 (gv-letplace (getter setter) place
163 (funcall setter `(cons ,v ,getter))))))
165 (defmacro pop (place)
166 "Return the first element of PLACE's value, and remove it from the list.
167 PLACE must be a generalized variable whose value is a list.
168 If the value is nil, `pop' returns nil but does not actually
170 (declare (debug (gv-place)))
173 ;; So we can use `pop' in the bootstrap before `gv' can be used.
174 (list 'prog1 place (list 'setq place (list 'cdr place)))
175 (gv-letplace (getter setter) place
176 `(prog1 ,getter ,(funcall setter `(cdr ,getter)))))))
178 (defmacro when (cond &rest body)
179 "If COND yields non-nil, do BODY, else return nil.
180 When COND yields non-nil, eval BODY forms sequentially and return
181 value of last one, or nil if there are none.
184 (declare (indent 1) (debug t))
185 (list 'if cond (cons 'progn body)))
187 (defmacro unless (cond &rest body)
188 "If COND yields nil, do BODY, else return nil.
189 When COND yields nil, eval BODY forms sequentially and return
190 value of last one, or nil if there are none.
193 (declare (indent 1) (debug t))
194 (cons 'if (cons cond (cons nil body))))
196 (if (null (featurep 'cl))
198 ;; If we reload subr.el after having loaded CL, be careful not to
199 ;; overwrite CL's extended definition of `dolist', `dotimes', `declare'.
201 (defmacro dolist (spec &rest body)
203 Evaluate BODY with VAR bound to each car from LIST, in turn.
204 Then evaluate RESULT to get return value, default nil.
206 \(fn (VAR LIST [RESULT]) BODY...)"
207 (declare (indent 1) (debug ((symbolp form &optional form) body)))
208 ;; It would be cleaner to create an uninterned symbol,
209 ;; but that uses a lot more space when many functions in many files
211 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
212 (let ((temp '--dolist-tail--))
213 ;; This is not a reliable test, but it does not matter because both
214 ;; semantics are acceptable, tho one is slightly faster with dynamic
215 ;; scoping and the other is slightly faster (and has cleaner semantics)
216 ;; with lexical scoping.
218 `(let ((,temp ,(nth 1 spec)))
220 (let ((,(car spec) (car ,temp)))
222 (setq ,temp (cdr ,temp))))
223 ,@(if (cdr (cdr spec))
224 ;; FIXME: This let often leads to "unused var" warnings.
225 `((let ((,(car spec) nil)) ,@(cdr (cdr spec))))))
226 `(let ((,temp ,(nth 1 spec))
229 (setq ,(car spec) (car ,temp))
231 (setq ,temp (cdr ,temp)))
232 ,@(if (cdr (cdr spec))
233 `((setq ,(car spec) nil) ,@(cdr (cdr spec))))))))
235 (defmacro dotimes (spec &rest body)
236 "Loop a certain number of times.
237 Evaluate BODY with VAR bound to successive integers running from 0,
238 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
239 the return value (nil if RESULT is omitted).
241 \(fn (VAR COUNT [RESULT]) BODY...)"
242 (declare (indent 1) (debug dolist))
243 ;; It would be cleaner to create an uninterned symbol,
244 ;; but that uses a lot more space when many functions in many files
246 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
247 (let ((temp '--dotimes-limit--)
250 ;; This is not a reliable test, but it does not matter because both
251 ;; semantics are acceptable, tho one is slightly faster with dynamic
252 ;; scoping and the other has cleaner semantics.
254 (let ((counter '--dotimes-counter--))
257 (while (< ,counter ,temp)
258 (let ((,(car spec) ,counter))
260 (setq ,counter (1+ ,counter)))
262 ;; FIXME: This let often leads to "unused var" warnings.
263 `((let ((,(car spec) ,counter)) ,@(cddr spec))))))
265 (,(car spec) ,start))
266 (while (< ,(car spec) ,temp)
268 (setq ,(car spec) (1+ ,(car spec))))
269 ,@(cdr (cdr spec))))))
271 (defmacro declare (&rest _specs)
272 "Do not evaluate any arguments and return nil.
273 Treated as a declaration when used at the right place in a
274 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
278 (defmacro ignore-errors (&rest body)
279 "Execute BODY; if an error occurs, return nil.
280 Otherwise, return result of last form in BODY."
281 (declare (debug t) (indent 0))
282 `(condition-case nil (progn ,@body) (error nil)))
284 ;;;; Basic Lisp functions.
286 (defun ignore (&rest _ignore)
287 "Do nothing and return nil.
288 This function accepts any number of arguments, but ignores them."
292 ;; Signal a compile-error if the first arg is missing.
293 (defun error (&rest args)
294 "Signal an error, making error message by passing all args to `format'.
295 In Emacs, the convention is that error messages start with a capital
296 letter but *do not* end with a period. Please follow this convention
297 for the sake of consistency."
299 (signal 'error (list (apply 'format args)))))
300 (set-advertised-calling-convention 'error '(string &rest args) "23.1")
302 (defun user-error (format &rest args)
303 "Signal a pilot error, making error message by passing all args to `format'.
304 In Emacs, the convention is that error messages start with a capital
305 letter but *do not* end with a period. Please follow this convention
306 for the sake of consistency.
307 This is just like `error' except that `user-error's are expected to be the
308 result of an incorrect manipulation on the part of the user, rather than the
309 result of an actual problem."
311 (signal 'user-error (list (apply #'format format args)))))
313 ;; We put this here instead of in frame.el so that it's defined even on
314 ;; systems where frame.el isn't loaded.
315 (defun frame-configuration-p (object)
316 "Return non-nil if OBJECT seems to be a frame configuration.
317 Any list whose car is `frame-configuration' is assumed to be a frame
320 (eq (car object) 'frame-configuration)))
325 "Return the car of the car of X."
329 "Return the car of the cdr of X."
333 "Return the cdr of the car of X."
337 "Return the cdr of the cdr of X."
340 (defun last (list &optional n)
341 "Return the last link of LIST. Its car is the last element.
342 If LIST is nil, return nil.
343 If N is non-nil, return the Nth-to-last link of LIST.
344 If N is bigger than the length of LIST, return LIST."
347 (let ((m (safe-length list)))
348 (if (< n m) (nthcdr (- m n) list) list)))
350 (nthcdr (1- (safe-length list)) list))))
352 (defun butlast (list &optional n)
353 "Return a copy of LIST with the last N elements removed."
354 (if (and n (<= n 0)) list
355 (nbutlast (copy-sequence list) n)))
357 (defun nbutlast (list &optional n)
358 "Modifies LIST to remove the last N elements."
359 (let ((m (length list)))
363 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
366 (defun delete-dups (list)
367 "Destructively remove `equal' duplicates from LIST.
368 Store the result in LIST and return it. LIST must be a proper list.
369 Of several `equal' occurrences of an element in LIST, the first
373 (setcdr tail (delete (car tail) (cdr tail)))
374 (setq tail (cdr tail))))
377 (defun number-sequence (from &optional to inc)
378 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
379 INC is the increment used between numbers in the sequence and defaults to 1.
380 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
381 zero. TO is only included if there is an N for which TO = FROM + N * INC.
382 If TO is nil or numerically equal to FROM, return \(FROM).
383 If INC is positive and TO is less than FROM, or INC is negative
384 and TO is larger than FROM, return nil.
385 If INC is zero and TO is neither nil nor numerically equal to
386 FROM, signal an error.
388 This function is primarily designed for integer arguments.
389 Nevertheless, FROM, TO and INC can be integer or float. However,
390 floating point arithmetic is inexact. For instance, depending on
391 the machine, it may quite well happen that
392 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
393 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
394 elements. Thus, if some of the arguments are floats and one wants
395 to make sure that TO is included, one may have to explicitly write
396 TO as \(+ FROM \(* N INC)) or use a variable whose value was
397 computed with this exact expression. Alternatively, you can,
398 of course, also replace TO with a slightly larger value
399 \(or a slightly more negative value if INC is negative)."
400 (if (or (not to) (= from to))
402 (or inc (setq inc 1))
403 (when (zerop inc) (error "The increment can not be zero"))
404 (let (seq (n 0) (next from))
407 (setq seq (cons next seq)
409 next (+ from (* n inc))))
411 (setq seq (cons next seq)
413 next (+ from (* n inc)))))
416 (defun copy-tree (tree &optional vecp)
417 "Make a copy of TREE.
418 If TREE is a cons cell, this recursively copies both its car and its cdr.
419 Contrast to `copy-sequence', which copies only along the cdrs. With second
420 argument VECP, this copies vectors as well as conses."
424 (let ((newcar (car tree)))
425 (if (or (consp (car tree)) (and vecp (vectorp (car tree))))
426 (setq newcar (copy-tree (car tree) vecp)))
427 (push newcar result))
428 (setq tree (cdr tree)))
429 (nconc (nreverse result) tree))
430 (if (and vecp (vectorp tree))
431 (let ((i (length (setq tree (copy-sequence tree)))))
432 (while (>= (setq i (1- i)) 0)
433 (aset tree i (copy-tree (aref tree i) vecp)))
437 ;;;; Various list-search functions.
439 (defun assoc-default (key alist &optional test default)
440 "Find object KEY in a pseudo-alist ALIST.
441 ALIST is a list of conses or objects. Each element
442 (or the element's car, if it is a cons) is compared with KEY by
443 calling TEST, with two arguments: (i) the element or its car,
445 If that is non-nil, the element matches; then `assoc-default'
446 returns the element's cdr, if it is a cons, or DEFAULT if the
447 element is not a cons.
449 If no element matches, the value is nil.
450 If TEST is omitted or nil, `equal' is used."
451 (let (found (tail alist) value)
452 (while (and tail (not found))
453 (let ((elt (car tail)))
454 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
455 (setq found t value (if (consp elt) (cdr elt) default))))
456 (setq tail (cdr tail)))
459 (make-obsolete 'assoc-ignore-case 'assoc-string "22.1")
460 (defun assoc-ignore-case (key alist)
461 "Like `assoc', but ignores differences in case and text representation.
462 KEY must be a string. Upper-case and lower-case letters are treated as equal.
463 Unibyte strings are converted to multibyte for comparison."
464 (assoc-string key alist t))
466 (make-obsolete 'assoc-ignore-representation 'assoc-string "22.1")
467 (defun assoc-ignore-representation (key alist)
468 "Like `assoc', but ignores differences in text representation.
469 KEY must be a string.
470 Unibyte strings are converted to multibyte for comparison."
471 (assoc-string key alist nil))
473 (defun member-ignore-case (elt list)
474 "Like `member', but ignore differences in case and text representation.
475 ELT must be a string. Upper-case and lower-case letters are treated as equal.
476 Unibyte strings are converted to multibyte for comparison.
477 Non-strings in LIST are ignored."
479 (not (and (stringp (car list))
480 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
481 (setq list (cdr list)))
484 (defun assq-delete-all (key alist)
485 "Delete from ALIST all elements whose car is `eq' to KEY.
486 Return the modified alist.
487 Elements of ALIST that are not conses are ignored."
488 (while (and (consp (car alist))
489 (eq (car (car alist)) key))
490 (setq alist (cdr alist)))
491 (let ((tail alist) tail-cdr)
492 (while (setq tail-cdr (cdr tail))
493 (if (and (consp (car tail-cdr))
494 (eq (car (car tail-cdr)) key))
495 (setcdr tail (cdr tail-cdr))
496 (setq tail tail-cdr))))
499 (defun rassq-delete-all (value alist)
500 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
501 Return the modified alist.
502 Elements of ALIST that are not conses are ignored."
503 (while (and (consp (car alist))
504 (eq (cdr (car alist)) value))
505 (setq alist (cdr alist)))
506 (let ((tail alist) tail-cdr)
507 (while (setq tail-cdr (cdr tail))
508 (if (and (consp (car tail-cdr))
509 (eq (cdr (car tail-cdr)) value))
510 (setcdr tail (cdr tail-cdr))
511 (setq tail tail-cdr))))
514 (defun remove (elt seq)
515 "Return a copy of SEQ with all occurrences of ELT removed.
516 SEQ must be a list, vector, or string. The comparison is done with `equal'."
518 ;; If SEQ isn't a list, there's no need to copy SEQ because
519 ;; `delete' will return a new object.
521 (delete elt (copy-sequence seq))))
523 (defun remq (elt list)
524 "Return LIST with all occurrences of ELT removed.
525 The comparison is done with `eq'. Contrary to `delq', this does not use
526 side-effects, and the argument LIST is not modified."
527 (while (and (eq elt (car list)) (setq list (cdr list))))
529 (delq elt (copy-sequence list))
535 "Convert KEYS to the internal Emacs key representation.
536 KEYS should be a string constant in the format used for
537 saving keyboard macros (see `edmacro-mode')."
538 ;; Don't use a defalias, since the `pure' property is only true for
539 ;; the calling convention of `kbd'.
540 (read-kbd-macro keys))
544 "Beep to tell the user this binding is undefined."
548 ;; Prevent the \{...} documentation construct
549 ;; from mentioning keys that run this command.
550 (put 'undefined 'suppress-keymap t)
552 (defun suppress-keymap (map &optional nodigits)
553 "Make MAP override all normally self-inserting keys to be undefined.
554 Normally, as an exception, digits and minus-sign are set to make prefix args,
555 but optional second arg NODIGITS non-nil treats them like other chars."
556 (define-key map [remap self-insert-command] 'undefined)
559 (define-key map "-" 'negative-argument)
560 ;; Make plain numbers do numeric args.
563 (define-key map (char-to-string loop) 'digit-argument)
564 (setq loop (1+ loop))))))
566 (defun make-composed-keymap (maps &optional parent)
567 "Construct a new keymap composed of MAPS and inheriting from PARENT.
568 When looking up a key in the returned map, the key is looked in each
569 keymap of MAPS in turn until a binding is found.
570 If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
571 As always with keymap inheritance, a nil binding in MAPS overrides
572 any corresponding binding in PARENT, but it does not override corresponding
573 bindings in other keymaps of MAPS.
574 MAPS can be a list of keymaps or a single keymap.
575 PARENT if non-nil should be a keymap."
577 ,@(if (keymapp maps) (list maps) maps)
580 (defun define-key-after (keymap key definition &optional after)
581 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
582 This is like `define-key' except that the binding for KEY is placed
583 just after the binding for the event AFTER, instead of at the beginning
584 of the map. Note that AFTER must be an event type (like KEY), NOT a command
587 If AFTER is t or omitted, the new binding goes at the end of the keymap.
588 AFTER should be a single event type--a symbol or a character, not a sequence.
590 Bindings are always added before any inherited map.
592 The order of bindings in a keymap only matters when it is used as
593 a menu, so this function is not useful for non-menu keymaps."
594 (unless after (setq after t))
596 (signal 'wrong-type-argument (list 'keymapp keymap)))
598 (if (<= (length key) 1) (aref key 0)
599 (setq keymap (lookup-key keymap
601 (butlast (mapcar 'identity key)))))
602 (aref key (1- (length key)))))
603 (let ((tail keymap) done inserted)
604 (while (and (not done) tail)
605 ;; Delete any earlier bindings for the same key.
606 (if (eq (car-safe (car (cdr tail))) key)
607 (setcdr tail (cdr (cdr tail))))
608 ;; If we hit an included map, go down that one.
609 (if (keymapp (car tail)) (setq tail (car tail)))
610 ;; When we reach AFTER's binding, insert the new binding after.
611 ;; If we reach an inherited keymap, insert just before that.
612 ;; If we reach the end of this keymap, insert at the end.
613 (if (or (and (eq (car-safe (car tail)) after)
615 (eq (car (cdr tail)) 'keymap)
618 ;; Stop the scan only if we find a parent keymap.
619 ;; Keep going past the inserted element
620 ;; so we can delete any duplications that come later.
621 (if (eq (car (cdr tail)) 'keymap)
623 ;; Don't insert more than once.
625 (setcdr tail (cons (cons key definition) (cdr tail))))
627 (setq tail (cdr tail)))))
629 (defun map-keymap-sorted (function keymap)
630 "Implement `map-keymap' with sorting.
631 Don't call this function; it is for internal use only."
633 (map-keymap (lambda (a b) (push (cons a b) list))
635 (setq list (sort list
637 (setq a (car a) b (car b))
639 (if (integerp b) (< a b)
642 ;; string< also accepts symbols.
645 (funcall function (car p) (cdr p)))))
647 (defun keymap--menu-item-binding (val)
648 "Return the binding part of a menu-item."
650 ((not (consp val)) val) ;Not a menu-item.
651 ((eq 'menu-item (car val))
652 (let* ((binding (nth 2 val))
653 (plist (nthcdr 3 val))
654 (filter (plist-get plist :filter)))
655 (if filter (funcall filter binding)
657 ((and (consp (cdr val)) (stringp (cadr val)))
661 (t val))) ;Not a menu-item either.
663 (defun keymap--menu-item-with-binding (item binding)
664 "Build a menu-item like ITEM but with its binding changed to BINDING."
666 ((not (consp item)) binding) ;Not a menu-item.
667 ((eq 'menu-item (car item))
668 (setq item (copy-sequence item))
669 (let ((tail (nthcdr 2 item)))
670 (setcar tail binding)
671 ;; Remove any potential filter.
672 (if (plist-get (cdr tail) :filter)
673 (setcdr tail (plist-put (cdr tail) :filter nil))))
675 ((and (consp (cdr item)) (stringp (cadr item)))
676 (cons (car item) (cons (cadr item) binding)))
677 (t (cons (car item) binding))))
679 (defun keymap--merge-bindings (val1 val2)
680 "Merge bindings VAL1 and VAL2."
681 (let ((map1 (keymap--menu-item-binding val1))
682 (map2 (keymap--menu-item-binding val2)))
683 (if (not (and (keymapp map1) (keymapp map2)))
684 ;; There's nothing to merge: val1 takes precedence.
686 (let ((map (list 'keymap map1 map2))
687 (item (if (keymapp val1) (if (keymapp val2) nil val2) val1)))
688 (keymap--menu-item-with-binding item map)))))
690 (defun keymap-canonicalize (map)
691 "Return a simpler equivalent keymap.
692 This resolves inheritance and redefinitions. The returned keymap
693 should behave identically to a copy of KEYMAP w.r.t `lookup-key'
694 and use in active keymaps and menus.
695 Subkeymaps may be modified but are not canonicalized."
696 ;; FIXME: Problem with the difference between a nil binding
697 ;; that hides a binding in an inherited map and a nil binding that's ignored
698 ;; to let some further binding visible. Currently a nil binding hides all.
699 ;; FIXME: we may want to carefully (re)order elements in case they're
703 (prompt (keymap-prompt map)))
705 (setq map (map-keymap ;; -internal
708 ;; Treat char-ranges specially.
709 (push (cons key item) ranges)
710 (push (cons key item) bindings)))
712 ;; Create the new map.
713 (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt))
714 (dolist (binding ranges)
715 ;; Treat char-ranges specially. FIXME: need to merge as well.
716 (define-key map (vector (car binding)) (cdr binding)))
717 ;; Process the bindings starting from the end.
718 (dolist (binding (prog1 bindings (setq bindings ())))
719 (let* ((key (car binding))
720 (oldbind (assq key bindings)))
721 (push (if (not oldbind)
722 ;; The normal case: no duplicate bindings.
724 ;; This is the second binding for this key.
725 (setq bindings (delq oldbind bindings))
726 (cons key (keymap--merge-bindings (cdr binding)
729 (nconc map bindings)))
731 (put 'keyboard-translate-table 'char-table-extra-slots 0)
733 (defun keyboard-translate (from to)
734 "Translate character FROM to TO at a low level.
735 This function creates a `keyboard-translate-table' if necessary
736 and then modifies one entry in it."
737 (or (char-table-p keyboard-translate-table)
738 (setq keyboard-translate-table
739 (make-char-table 'keyboard-translate-table nil)))
740 (aset keyboard-translate-table from to))
742 ;;;; Key binding commands.
744 (defun global-set-key (key command)
745 "Give KEY a global binding as COMMAND.
746 COMMAND is the command definition to use; usually it is
747 a symbol naming an interactively-callable function.
748 KEY is a key sequence; noninteractively, it is a string or vector
749 of characters or event types, and non-ASCII characters with codes
750 above 127 (such as ISO Latin-1) can be included if you use a vector.
752 Note that if KEY has a local binding in the current buffer,
753 that local binding will continue to shadow any global binding
754 that you make with this function."
755 (interactive "KSet key globally: \nCSet key %s to command: ")
756 (or (vectorp key) (stringp key)
757 (signal 'wrong-type-argument (list 'arrayp key)))
758 (define-key (current-global-map) key command))
760 (defun local-set-key (key command)
761 "Give KEY a local binding as COMMAND.
762 COMMAND is the command definition to use; usually it is
763 a symbol naming an interactively-callable function.
764 KEY is a key sequence; noninteractively, it is a string or vector
765 of characters or event types, and non-ASCII characters with codes
766 above 127 (such as ISO Latin-1) can be included if you use a vector.
768 The binding goes in the current buffer's local map,
769 which in most cases is shared with all other buffers in the same major mode."
770 (interactive "KSet key locally: \nCSet key %s locally to command: ")
771 (let ((map (current-local-map)))
773 (use-local-map (setq map (make-sparse-keymap))))
774 (or (vectorp key) (stringp key)
775 (signal 'wrong-type-argument (list 'arrayp key)))
776 (define-key map key command)))
778 (defun global-unset-key (key)
779 "Remove global binding of KEY.
780 KEY is a string or vector representing a sequence of keystrokes."
781 (interactive "kUnset key globally: ")
782 (global-set-key key nil))
784 (defun local-unset-key (key)
785 "Remove local binding of KEY.
786 KEY is a string or vector representing a sequence of keystrokes."
787 (interactive "kUnset key locally: ")
788 (if (current-local-map)
789 (local-set-key key nil))
792 ;;;; substitute-key-definition and its subroutines.
794 (defvar key-substitution-in-progress nil
795 "Used internally by `substitute-key-definition'.")
797 (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
798 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
799 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
800 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
801 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
803 If you don't specify OLDMAP, you can usually get the same results
804 in a cleaner way with command remapping, like this:
805 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
806 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
807 ;; Don't document PREFIX in the doc string because we don't want to
808 ;; advertise it. It's meant for recursive calls only. Here's its
811 ;; If optional argument PREFIX is specified, it should be a key
812 ;; prefix, a string. Redefined bindings will then be bound to the
813 ;; original key, with PREFIX added at the front.
814 (or prefix (setq prefix ""))
815 (let* ((scan (or oldmap keymap))
816 (prefix1 (vconcat prefix [nil]))
817 (key-substitution-in-progress
818 (cons scan key-substitution-in-progress)))
819 ;; Scan OLDMAP, finding each char or event-symbol that
820 ;; has any definition, and act on it with hack-key.
823 (aset prefix1 (length prefix) char)
824 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
827 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
828 (let (inner-def skipped menu-item)
829 ;; Find the actual command name within the binding.
830 (if (eq (car-safe defn) 'menu-item)
831 (setq menu-item defn defn (nth 2 defn))
832 ;; Skip past menu-prompt.
833 (while (stringp (car-safe defn))
834 (push (pop defn) skipped))
835 ;; Skip past cached key-equivalence data for menu items.
836 (if (consp (car-safe defn))
837 (setq defn (cdr defn))))
838 (if (or (eq defn olddef)
839 ;; Compare with equal if definition is a key sequence.
840 ;; That is useful for operating on function-key-map.
841 (and (or (stringp defn) (vectorp defn))
842 (equal defn olddef)))
843 (define-key keymap prefix
845 (let ((copy (copy-sequence menu-item)))
846 (setcar (nthcdr 2 copy) newdef)
848 (nconc (nreverse skipped) newdef)))
849 ;; Look past a symbol that names a keymap.
851 (or (indirect-function defn t) defn))
852 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
853 ;; avoid autoloading a keymap. This is mostly done to preserve the
854 ;; original non-autoloading behavior of pre-map-keymap times.
855 (if (and (keymapp inner-def)
856 ;; Avoid recursively scanning
857 ;; where KEYMAP does not have a submap.
858 (let ((elt (lookup-key keymap prefix)))
859 (or (null elt) (natnump elt) (keymapp elt)))
860 ;; Avoid recursively rescanning keymap being scanned.
861 (not (memq inner-def key-substitution-in-progress)))
862 ;; If this one isn't being scanned already, scan it now.
863 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
866 ;;;; The global keymap tree.
868 ;; global-map, esc-map, and ctl-x-map have their values set up in
869 ;; keymap.c; we just give them docstrings here.
871 (defvar global-map nil
872 "Default global keymap mapping Emacs keyboard input into commands.
873 The value is a keymap which is usually (but not necessarily) Emacs's
877 "Default keymap for ESC (meta) commands.
878 The normal global definition of the character ESC indirects to this keymap.")
880 (defvar ctl-x-map nil
881 "Default keymap for C-x commands.
882 The normal global definition of the character C-x indirects to this keymap.")
884 (defvar ctl-x-4-map (make-sparse-keymap)
885 "Keymap for subcommands of C-x 4.")
886 (defalias 'ctl-x-4-prefix ctl-x-4-map)
887 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
889 (defvar ctl-x-5-map (make-sparse-keymap)
890 "Keymap for frame commands.")
891 (defalias 'ctl-x-5-prefix ctl-x-5-map)
892 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
895 ;;;; Event manipulation functions.
897 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
899 (defun listify-key-sequence (key)
900 "Convert a key sequence to a list of events."
903 (mapcar (function (lambda (c)
905 (logxor c listify-key-sequence-1)
909 (defsubst eventp (obj)
910 "True if the argument is an event object."
911 (or (and (integerp obj)
912 ;; FIXME: Why bother?
913 ;; Filter out integers too large to be events.
914 ;; M is the biggest modifier.
915 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
916 (characterp (event-basic-type obj)))
918 (get obj 'event-symbol-elements))
921 (get (car obj) 'event-symbol-elements))))
923 (defun event-modifiers (event)
924 "Return a list of symbols representing the modifier keys in event EVENT.
925 The elements of the list may include `meta', `control',
926 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
928 EVENT may be an event or an event type. If EVENT is a symbol
929 that has never been used in an event that has been read as input
930 in the current Emacs session, then this function may fail to include
931 the `click' modifier."
934 (setq type (car type)))
936 ;; Don't read event-symbol-elements directly since we're not
937 ;; sure the symbol has already been parsed.
938 (cdr (internal-event-symbol-parse-modifiers type))
940 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
941 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
942 (if (not (zerop (logand type ?\M-\^@)))
944 (if (or (not (zerop (logand type ?\C-\^@)))
946 (push 'control list))
947 (if (or (not (zerop (logand type ?\S-\^@)))
948 (/= char (downcase char)))
950 (or (zerop (logand type ?\H-\^@))
952 (or (zerop (logand type ?\s-\^@))
954 (or (zerop (logand type ?\A-\^@))
958 (defun event-basic-type (event)
959 "Return the basic type of the given event (all modifiers removed).
960 The value is a printing character (not upper case) or a symbol.
961 EVENT may be an event or an event type. If EVENT is a symbol
962 that has never been used in an event that has been read as input
963 in the current Emacs session, then this function may return nil."
965 (setq event (car event)))
967 (car (get event 'event-symbol-elements))
968 (let* ((base (logand event (1- ?\A-\^@)))
969 (uncontrolled (if (< base 32) (logior base 64) base)))
970 ;; There are some numbers that are invalid characters and
971 ;; cause `downcase' to get an error.
973 (downcase uncontrolled)
974 (error uncontrolled)))))
976 (defsubst mouse-movement-p (object)
977 "Return non-nil if OBJECT is a mouse movement event."
978 (eq (car-safe object) 'mouse-movement))
980 (defun mouse-event-p (object)
981 "Return non-nil if OBJECT is a mouse click event."
982 ;; is this really correct? maybe remove mouse-movement?
983 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
985 (defsubst event-start (event)
986 "Return the starting position of EVENT.
987 EVENT should be a click, drag, or key press event.
988 If it is a key press event, the return value has the form
989 (WINDOW POS (0 . 0) 0)
990 If it is a click or drag event, it has the form
991 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
992 IMAGE (DX . DY) (WIDTH . HEIGHT))
993 The `posn-' functions access elements of such lists.
994 For more information, see Info node `(elisp)Click Events'.
996 If EVENT is a mouse or key press or a mouse click, this is the
997 position of the event. If EVENT is a drag, this is the starting
998 position of the drag."
999 (if (consp event) (nth 1 event)
1000 (list (selected-window) (point) '(0 . 0) 0)))
1002 (defsubst event-end (event)
1003 "Return the ending location of EVENT.
1004 EVENT should be a click, drag, or key press event.
1005 If EVENT is a key press event, the return value has the form
1006 (WINDOW POS (0 . 0) 0)
1007 If EVENT is a click event, this function is the same as
1008 `event-start'. For click and drag events, the return value has
1010 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
1011 IMAGE (DX . DY) (WIDTH . HEIGHT))
1012 The `posn-' functions access elements of such lists.
1013 For more information, see Info node `(elisp)Click Events'.
1015 If EVENT is a mouse or key press or a mouse click, this is the
1016 position of the event. If EVENT is a drag, this is the starting
1017 position of the drag."
1018 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
1019 (list (selected-window) (point) '(0 . 0) 0)))
1021 (defsubst event-click-count (event)
1022 "Return the multi-click count of EVENT, a click or drag event.
1023 The return value is a positive integer."
1024 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
1026 ;;;; Extracting fields of the positions in an event.
1028 (defsubst posn-window (position)
1029 "Return the window in POSITION.
1030 POSITION should be a list of the form returned by the `event-start'
1031 and `event-end' functions."
1034 (defsubst posn-area (position)
1035 "Return the window area recorded in POSITION, or nil for the text area.
1036 POSITION should be a list of the form returned by the `event-start'
1037 and `event-end' functions."
1038 (let ((area (if (consp (nth 1 position))
1039 (car (nth 1 position))
1041 (and (symbolp area) area)))
1043 (defsubst posn-point (position)
1044 "Return the buffer location in POSITION.
1045 POSITION should be a list of the form returned by the `event-start'
1046 and `event-end' functions."
1047 (or (nth 5 position)
1048 (if (consp (nth 1 position))
1049 (car (nth 1 position))
1052 (defun posn-set-point (position)
1053 "Move point to POSITION.
1054 Select the corresponding window as well."
1055 (if (not (windowp (posn-window position)))
1056 (error "Position not in text area of window"))
1057 (select-window (posn-window position))
1058 (if (numberp (posn-point position))
1059 (goto-char (posn-point position))))
1061 (defsubst posn-x-y (position)
1062 "Return the x and y coordinates in POSITION.
1063 The return value has the form (X . Y), where X and Y are given in
1064 pixels. POSITION should be a list of the form returned by
1065 `event-start' and `event-end'."
1068 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1070 (defun posn-col-row (position)
1071 "Return the nominal column and row in POSITION, measured in characters.
1072 The column and row values are approximations calculated from the x
1073 and y coordinates in POSITION and the frame's default character width
1075 For a scroll-bar event, the result column is 0, and the row
1076 corresponds to the vertical position of the click in the scroll bar.
1077 POSITION should be a list of the form returned by the `event-start'
1078 and `event-end' functions."
1079 (let* ((pair (posn-x-y position))
1080 (window (posn-window position))
1081 (area (posn-area position)))
1085 ((eq area 'vertical-scroll-bar)
1086 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1087 ((eq area 'horizontal-scroll-bar)
1088 (cons (scroll-bar-scale pair (window-width window)) 0))
1090 (let* ((frame (if (framep window) window (window-frame window)))
1091 ;; FIXME: This should take line-spacing properties on
1092 ;; newlines into account.
1093 (spacing (when (display-graphic-p frame)
1094 (or (with-current-buffer (window-buffer window)
1096 (frame-parameter frame 'line-spacing)))))
1097 (cond ((floatp spacing)
1098 (setq spacing (truncate (* spacing
1099 (frame-char-height frame)))))
1102 (cons (/ (car pair) (frame-char-width frame))
1103 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
1104 (if (null (with-current-buffer (window-buffer window)
1105 header-line-format))
1108 (defun posn-actual-col-row (position)
1109 "Return the actual column and row in POSITION, measured in characters.
1110 These are the actual row number in the window and character number in that row.
1111 Return nil if POSITION does not contain the actual position; in that case
1112 `posn-col-row' can be used to get approximate values.
1113 POSITION should be a list of the form returned by the `event-start'
1114 and `event-end' functions."
1117 (defsubst posn-timestamp (position)
1118 "Return the timestamp of POSITION.
1119 POSITION should be a list of the form returned by the `event-start'
1120 and `event-end' functions."
1123 (defsubst posn-string (position)
1124 "Return the string object of POSITION.
1125 Value is a cons (STRING . STRING-POS), or nil if not a string.
1126 POSITION should be a list of the form returned by the `event-start'
1127 and `event-end' functions."
1130 (defsubst posn-image (position)
1131 "Return the image object of POSITION.
1132 Value is a list (image ...), or nil if not an image.
1133 POSITION should be a list of the form returned by the `event-start'
1134 and `event-end' functions."
1137 (defsubst posn-object (position)
1138 "Return the object (image or string) of POSITION.
1139 Value is a list (image ...) for an image object, a cons cell
1140 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
1141 POSITION should be a list of the form returned by the `event-start'
1142 and `event-end' functions."
1143 (or (posn-image position) (posn-string position)))
1145 (defsubst posn-object-x-y (position)
1146 "Return the x and y coordinates relative to the object of POSITION.
1147 The return value has the form (DX . DY), where DX and DY are
1148 given in pixels. POSITION should be a list of the form returned
1149 by `event-start' and `event-end'."
1152 (defsubst posn-object-width-height (position)
1153 "Return the pixel width and height of the object of POSITION.
1154 The return value has the form (WIDTH . HEIGHT). POSITION should
1155 be a list of the form returned by `event-start' and `event-end'."
1159 ;;;; Obsolescent names for functions.
1161 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1162 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1163 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1164 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1165 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1166 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1168 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1169 (make-obsolete 'buffer-has-markers-at nil "24.2")
1171 (defun insert-string (&rest args)
1172 "Mocklisp-compatibility insert function.
1173 Like the function `insert' except that any argument that is a number
1174 is converted into a string by expressing it in decimal."
1176 (insert (if (integerp el) (number-to-string el) el))))
1177 (make-obsolete 'insert-string 'insert "22.1")
1179 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1180 (make-obsolete 'makehash 'make-hash-table "22.1")
1182 ;; These are used by VM and some old programs
1183 (defalias 'focus-frame 'ignore "")
1184 (make-obsolete 'focus-frame "it does nothing." "22.1")
1185 (defalias 'unfocus-frame 'ignore "")
1186 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1187 (make-obsolete 'make-variable-frame-local
1188 "explicitly check for a frame-parameter instead." "22.2")
1189 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1190 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
1191 (set-advertised-calling-convention
1192 'all-completions '(string collection &optional predicate) "23.1")
1193 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1195 ;;;; Obsolescence declarations for variables, and aliases.
1197 ;; Special "default-FOO" variables which contain the default value of
1198 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1199 ;; slows down several unrelated variable operations; furthermore, they
1200 ;; can lead to really odd behavior if you decide to make them
1203 ;; Not used at all in Emacs, last time I checked:
1204 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1205 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1206 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1207 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1208 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1209 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1210 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1211 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1212 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1213 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1214 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1215 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1216 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1217 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1218 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1219 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1220 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1221 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1222 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1223 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1224 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1225 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1226 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1227 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1228 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1229 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1230 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1231 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1232 (make-obsolete-variable 'default-enable-multibyte-characters
1233 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1235 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1236 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1237 (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1238 (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
1239 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1240 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1242 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1243 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1245 (make-obsolete-variable
1246 'mode-line-inverse-video
1247 "use the appropriate faces instead."
1249 (make-obsolete-variable
1250 'unread-command-char
1251 "use `unread-command-events' instead. That variable is a list of events
1252 to reread, so it now uses nil to mean `no event', instead of -1."
1255 ;; Lisp manual only updated in 22.1.
1256 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1259 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1260 (make-obsolete-variable 'x-lost-selection-hooks
1261 'x-lost-selection-functions "22.1")
1262 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1263 (make-obsolete-variable 'x-sent-selection-hooks
1264 'x-sent-selection-functions "22.1")
1266 ;; This was introduced in 21.4 for pre-unicode unification. That
1267 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1268 ;; Other uses are possible, so this variable is not _really_ obsolete,
1269 ;; but Stefan insists to mark it so.
1270 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1272 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1274 ;; These aliases exist in Emacs 19.34, and probably before, but were
1275 ;; only marked as obsolete in 23.1.
1276 ;; The lisp manual (since at least Emacs 21) describes them as
1277 ;; existing "for compatibility with Emacs version 18".
1278 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1280 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1284 ;;;; Alternate names for functions - these are not being phased out.
1286 (defalias 'send-string 'process-send-string)
1287 (defalias 'send-region 'process-send-region)
1288 (defalias 'string= 'string-equal)
1289 (defalias 'string< 'string-lessp)
1290 (defalias 'move-marker 'set-marker)
1291 (defalias 'rplaca 'setcar)
1292 (defalias 'rplacd 'setcdr)
1293 (defalias 'beep 'ding) ;preserve lingual purity
1294 (defalias 'indent-to-column 'indent-to)
1295 (defalias 'backward-delete-char 'delete-backward-char)
1296 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1297 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1298 (defalias 'int-to-string 'number-to-string)
1299 (defalias 'store-match-data 'set-match-data)
1300 (defalias 'chmod 'set-file-modes)
1301 (defalias 'mkdir 'make-directory)
1302 ;; These are the XEmacs names:
1303 (defalias 'point-at-eol 'line-end-position)
1304 (defalias 'point-at-bol 'line-beginning-position)
1306 (defalias 'user-original-login-name 'user-login-name)
1309 ;;;; Hook manipulation functions.
1311 (defun add-hook (hook function &optional append local)
1312 "Add to the value of HOOK the function FUNCTION.
1313 FUNCTION is not added if already present.
1314 FUNCTION is added (if necessary) at the beginning of the hook list
1315 unless the optional argument APPEND is non-nil, in which case
1316 FUNCTION is added at the end.
1318 The optional fourth argument, LOCAL, if non-nil, says to modify
1319 the hook's buffer-local value rather than its global value.
1320 This makes the hook buffer-local, and it makes t a member of the
1321 buffer-local value. That acts as a flag to run the hook
1322 functions of the global value as well as in the local value.
1324 HOOK should be a symbol, and FUNCTION may be any valid function. If
1325 HOOK is void, it is first set to nil. If HOOK's value is a single
1326 function, it is changed to a list of functions."
1327 (or (boundp hook) (set hook nil))
1328 (or (default-boundp hook) (set-default hook nil))
1329 (if local (unless (local-variable-if-set-p hook)
1330 (set (make-local-variable hook) (list t)))
1331 ;; Detect the case where make-local-variable was used on a hook
1332 ;; and do what we used to do.
1333 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1335 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1336 ;; If the hook value is a single function, turn it into a list.
1337 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1338 (setq hook-value (list hook-value)))
1339 ;; Do the actual addition if necessary
1340 (unless (member function hook-value)
1341 (when (stringp function)
1342 (setq function (purecopy function)))
1345 (append hook-value (list function))
1346 (cons function hook-value))))
1347 ;; Set the actual variable
1350 ;; If HOOK isn't a permanent local,
1351 ;; but FUNCTION wants to survive a change of modes,
1352 ;; mark HOOK as partially permanent.
1353 (and (symbolp function)
1354 (get function 'permanent-local-hook)
1355 (not (get hook 'permanent-local))
1356 (put hook 'permanent-local 'permanent-local-hook))
1357 (set hook hook-value))
1358 (set-default hook hook-value))))
1360 (defun remove-hook (hook function &optional local)
1361 "Remove from the value of HOOK the function FUNCTION.
1362 HOOK should be a symbol, and FUNCTION may be any valid function. If
1363 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1364 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1366 The optional third argument, LOCAL, if non-nil, says to modify
1367 the hook's buffer-local value rather than its default value."
1368 (or (boundp hook) (set hook nil))
1369 (or (default-boundp hook) (set-default hook nil))
1370 ;; Do nothing if LOCAL is t but this hook has no local binding.
1371 (unless (and local (not (local-variable-p hook)))
1372 ;; Detect the case where make-local-variable was used on a hook
1373 ;; and do what we used to do.
1374 (when (and (local-variable-p hook)
1375 (not (and (consp (symbol-value hook))
1376 (memq t (symbol-value hook)))))
1378 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1379 ;; Remove the function, for both the list and the non-list cases.
1380 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1381 (if (equal hook-value function) (setq hook-value nil))
1382 (setq hook-value (delete function (copy-sequence hook-value))))
1383 ;; If the function is on the global hook, we need to shadow it locally
1384 ;;(when (and local (member function (default-value hook))
1385 ;; (not (member (cons 'not function) hook-value)))
1386 ;; (push (cons 'not function) hook-value))
1387 ;; Set the actual variable
1389 (set-default hook hook-value)
1390 (if (equal hook-value '(t))
1391 (kill-local-variable hook)
1392 (set hook hook-value))))))
1394 (defmacro letrec (binders &rest body)
1395 "Bind variables according to BINDERS then eval BODY.
1396 The value of the last form in BODY is returned.
1397 Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1398 SYMBOL to the value of VALUEFORM.
1399 All symbols are bound before the VALUEFORMs are evalled."
1400 ;; Only useful in lexical-binding mode.
1401 ;; As a special-form, we could implement it more efficiently (and cleanly,
1402 ;; making the vars actually unbound during evaluation of the binders).
1403 (declare (debug let) (indent 1))
1404 `(let ,(mapcar #'car binders)
1405 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1408 (defmacro with-wrapper-hook (hook args &rest body)
1409 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1410 HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1411 around the preceding ones, like a set of nested `around' advices.
1413 Each hook function should accept an argument list consisting of a
1414 function FUN, followed by the additional arguments in ARGS.
1416 The first hook function in HOOK is passed a FUN that, if it is called
1417 with arguments ARGS, performs BODY (i.e., the default operation).
1418 The FUN passed to each successive hook function is defined based
1419 on the preceding hook functions; if called with arguments ARGS,
1420 it does what the `with-wrapper-hook' call would do if the
1421 preceding hook functions were the only ones present in HOOK.
1423 Each hook function may call its FUN argument as many times as it wishes,
1424 including never. In that case, such a hook function acts to replace
1425 the default definition altogether, and any preceding hook functions.
1426 Of course, a subsequent hook function may do the same thing.
1428 Each hook function definition is used to construct the FUN passed
1429 to the next hook function, if any. The last (or \"outermost\")
1430 FUN is then called once."
1431 (declare (indent 2) (debug (form sexp body)))
1432 ;; We need those two gensyms because CL's lexical scoping is not available
1433 ;; for function arguments :-(
1434 (let ((funs (make-symbol "funs"))
1435 (global (make-symbol "global"))
1436 (argssym (make-symbol "args"))
1437 (runrestofhook (make-symbol "runrestofhook")))
1438 ;; Since the hook is a wrapper, the loop has to be done via
1439 ;; recursion: a given hook function will call its parameter in order to
1440 ;; continue looping.
1441 `(letrec ((,runrestofhook
1442 (lambda (,funs ,global ,argssym)
1443 ;; `funs' holds the functions left on the hook and `global'
1444 ;; holds the functions left on the global part of the hook
1445 ;; (in case the hook is local).
1447 (if (eq t (car ,funs))
1448 (funcall ,runrestofhook
1449 (append ,global (cdr ,funs)) nil ,argssym)
1452 (lambda (,funs ,global &rest ,argssym)
1453 (funcall ,runrestofhook ,funs ,global ,argssym))
1454 (cdr ,funs) ,global)
1456 ;; Once there are no more functions on the hook, run
1457 ;; the original body.
1458 (apply (lambda ,args ,@body) ,argssym)))))
1459 (funcall ,runrestofhook ,hook
1460 ;; The global part of the hook, if any.
1462 `(if (local-variable-p ',hook)
1463 (default-value ',hook)))
1466 (defun add-to-list (list-var element &optional append compare-fn)
1467 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1468 The test for presence of ELEMENT is done with `equal',
1469 or with COMPARE-FN if that's non-nil.
1470 If ELEMENT is added, it is added at the beginning of the list,
1471 unless the optional argument APPEND is non-nil, in which case
1472 ELEMENT is added at the end.
1474 The return value is the new value of LIST-VAR.
1476 If you want to use `add-to-list' on a variable that is not defined
1477 until a certain package is loaded, you should put the call to `add-to-list'
1478 into a hook function that will be run only after loading the package.
1479 `eval-after-load' provides one way to do this. In some cases
1480 other hooks, such as major mode hooks, can do the job."
1483 (member element (symbol-value list-var)))
1484 ((eq compare-fn 'eq)
1485 (memq element (symbol-value list-var)))
1486 ((eq compare-fn 'eql)
1487 (memql element (symbol-value list-var)))
1489 (let ((lst (symbol-value list-var)))
1491 (not (funcall compare-fn element (car lst))))
1492 (setq lst (cdr lst)))
1494 (symbol-value list-var)
1497 (append (symbol-value list-var) (list element))
1498 (cons element (symbol-value list-var))))))
1501 (defun add-to-ordered-list (list-var element &optional order)
1502 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1503 The test for presence of ELEMENT is done with `eq'.
1505 The resulting list is reordered so that the elements are in the
1506 order given by each element's numeric list order. Elements
1507 without a numeric list order are placed at the end of the list.
1509 If the third optional argument ORDER is a number (integer or
1510 float), set the element's list order to the given value. If
1511 ORDER is nil or omitted, do not change the numeric order of
1512 ELEMENT. If ORDER has any other value, remove the numeric order
1513 of ELEMENT if it has one.
1515 The list order for each element is stored in LIST-VAR's
1516 `list-order' property.
1518 The return value is the new value of LIST-VAR."
1519 (let ((ordering (get list-var 'list-order)))
1521 (put list-var 'list-order
1522 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1524 (puthash element (and (numberp order) order) ordering))
1525 (unless (memq element (symbol-value list-var))
1526 (set list-var (cons element (symbol-value list-var))))
1527 (set list-var (sort (symbol-value list-var)
1529 (let ((oa (gethash a ordering))
1530 (ob (gethash b ordering)))
1535 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1536 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1537 Return the new history list.
1538 If MAXELT is non-nil, it specifies the maximum length of the history.
1539 Otherwise, the maximum history length is the value of the `history-length'
1540 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1542 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1543 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1544 if it is empty or a duplicate."
1546 (setq maxelt (or (get history-var 'history-length)
1548 (let ((history (symbol-value history-var))
1550 (when (and (listp history)
1552 (not (stringp newelt))
1553 (> (length newelt) 0))
1555 (not (equal (car history) newelt))))
1556 (if history-delete-duplicates
1557 (delete newelt history))
1558 (setq history (cons newelt history))
1559 (when (integerp maxelt)
1562 (setq tail (nthcdr (1- maxelt) history))
1564 (setcdr tail nil)))))
1565 (set history-var history)))
1570 (defvar delay-mode-hooks nil
1571 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1572 (defvar delayed-mode-hooks nil
1573 "List of delayed mode hooks waiting to be run.")
1574 (make-variable-buffer-local 'delayed-mode-hooks)
1575 (put 'delay-mode-hooks 'permanent-local t)
1577 (defvar change-major-mode-after-body-hook nil
1578 "Normal hook run in major mode functions, before the mode hooks.")
1580 (defvar after-change-major-mode-hook nil
1581 "Normal hook run at the very end of major mode functions.")
1583 (defun run-mode-hooks (&rest hooks)
1584 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1585 If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1586 just adds the HOOKS to the list `delayed-mode-hooks'.
1587 Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1588 `delayed-mode-hooks' (in reverse order), HOOKS, and finally
1589 `after-change-major-mode-hook'. Major mode functions should use
1590 this instead of `run-hooks' when running their FOO-mode-hook."
1591 (if delay-mode-hooks
1593 (dolist (hook hooks)
1594 (push hook delayed-mode-hooks))
1595 ;; Normal case, just run the hook as before plus any delayed hooks.
1596 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1597 (setq delayed-mode-hooks nil)
1598 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
1599 (run-hooks 'after-change-major-mode-hook)))
1601 (defmacro delay-mode-hooks (&rest body)
1602 "Execute BODY, but delay any `run-mode-hooks'.
1603 These hooks will be executed by the first following call to
1604 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1605 Only affects hooks run in the current buffer."
1606 (declare (debug t) (indent 0))
1608 (make-local-variable 'delay-mode-hooks)
1609 (let ((delay-mode-hooks t))
1612 ;; PUBLIC: find if the current mode derives from another.
1614 (defun derived-mode-p (&rest modes)
1615 "Non-nil if the current major mode is derived from one of MODES.
1616 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1617 (let ((parent major-mode))
1618 (while (and (not (memq parent modes))
1619 (setq parent (get parent 'derived-mode-parent))))
1624 ;; If a minor mode is not defined with define-minor-mode,
1625 ;; add it here explicitly.
1626 ;; isearch-mode is deliberately excluded, since you should
1627 ;; not call it yourself.
1628 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1629 overwrite-mode view-mode
1631 "List of all minor mode functions.")
1633 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1634 "Register a new minor mode.
1636 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1638 TOGGLE is a symbol which is the name of a buffer-local variable that
1639 is toggled on or off to say whether the minor mode is active or not.
1641 NAME specifies what will appear in the mode line when the minor mode
1642 is active. NAME should be either a string starting with a space, or a
1643 symbol whose value is such a string.
1645 Optional KEYMAP is the keymap for the minor mode that will be added
1646 to `minor-mode-map-alist'.
1648 Optional AFTER specifies that TOGGLE should be added after AFTER
1649 in `minor-mode-alist'.
1651 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1652 It defaults to (and should by convention be) TOGGLE.
1654 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1655 included in the mode-line minor mode menu.
1656 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1657 (unless (memq toggle minor-mode-list)
1658 (push toggle minor-mode-list))
1660 (unless toggle-fun (setq toggle-fun toggle))
1661 (unless (eq toggle-fun toggle)
1662 (put toggle :minor-mode-function toggle-fun))
1663 ;; Add the name to the minor-mode-alist.
1665 (let ((existing (assq toggle minor-mode-alist)))
1667 (setcdr existing (list name))
1668 (let ((tail minor-mode-alist) found)
1669 (while (and tail (not found))
1670 (if (eq after (caar tail))
1672 (setq tail (cdr tail))))
1674 (let ((rest (cdr found)))
1676 (nconc found (list (list toggle name)) rest))
1677 (push (list toggle name) minor-mode-alist))))))
1678 ;; Add the toggle to the minor-modes menu if requested.
1679 (when (get toggle :included)
1680 (define-key mode-line-mode-menu
1684 (or (get toggle :menu-tag)
1685 (if (stringp name) name (symbol-name toggle)))
1686 (let ((mode-name (if (symbolp name) (symbol-value name))))
1687 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1688 (concat " (" (match-string 0 mode-name) ")"))))
1690 :button (cons :toggle toggle))))
1692 ;; Add the map to the minor-mode-map-alist.
1694 (let ((existing (assq toggle minor-mode-map-alist)))
1696 (setcdr existing keymap)
1697 (let ((tail minor-mode-map-alist) found)
1698 (while (and tail (not found))
1699 (if (eq after (caar tail))
1701 (setq tail (cdr tail))))
1703 (let ((rest (cdr found)))
1705 (nconc found (list (cons toggle keymap)) rest))
1706 (push (cons toggle keymap) minor-mode-map-alist)))))))
1710 (defun symbol-file (symbol &optional type)
1711 "Return the name of the file that defined SYMBOL.
1712 The value is normally an absolute file name. It can also be nil,
1713 if the definition is not associated with any file. If SYMBOL
1714 specifies an autoloaded function, the value can be a relative
1715 file name without extension.
1717 If TYPE is nil, then any kind of definition is acceptable. If
1718 TYPE is `defun', `defvar', or `defface', that specifies function
1719 definition, variable definition, or face definition only."
1720 (if (and (or (null type) (eq type 'defun))
1721 (symbolp symbol) (fboundp symbol)
1722 (eq 'autoload (car-safe (symbol-function symbol))))
1723 (nth 1 (symbol-function symbol))
1724 (let ((files load-history)
1728 (if (eq type 'defvar)
1729 ;; Variables are present just as their names.
1730 (member symbol (cdr (car files)))
1731 ;; Other types are represented as (TYPE . NAME).
1732 (member (cons type symbol) (cdr (car files))))
1733 ;; We accept all types, so look for variable def
1734 ;; and then for any other kind.
1735 (or (member symbol (cdr (car files)))
1736 (rassq symbol (cdr (car files)))))
1737 (setq file (car (car files)) files nil))
1738 (setq files (cdr files)))
1741 (defun locate-library (library &optional nosuffix path interactive-call)
1742 "Show the precise file name of Emacs library LIBRARY.
1743 LIBRARY should be a relative file name of the library, a string.
1744 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1745 nil (which is the default, see below).
1746 This command searches the directories in `load-path' like `\\[load-library]'
1747 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1748 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1749 to the specified name LIBRARY.
1751 If the optional third arg PATH is specified, that list of directories
1752 is used instead of `load-path'.
1754 When called from a program, the file name is normally returned as a
1755 string. When run interactively, the argument INTERACTIVE-CALL is t,
1756 and the file name is displayed in the echo area."
1757 (interactive (list (completing-read "Locate library: "
1759 'locate-file-completion-table
1760 load-path (get-load-suffixes)))
1763 (let ((file (locate-file library
1765 (append (unless nosuffix (get-load-suffixes))
1766 load-file-rep-suffixes))))
1767 (if interactive-call
1769 (message "Library is file %s" (abbreviate-file-name file))
1770 (message "No library %s in search path" library)))
1774 ;;;; Specifying things to do later.
1776 (defun load-history-regexp (file)
1777 "Form a regexp to find FILE in `load-history'.
1778 FILE, a string, is described in the function `eval-after-load'."
1779 (if (file-name-absolute-p file)
1780 (setq file (file-truename file)))
1781 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1783 (if (file-name-extension file)
1785 ;; Note: regexp-opt can't be used here, since we need to call
1786 ;; this before Emacs has been fully started. 2006-05-21
1787 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1788 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1791 (defun load-history-filename-element (file-regexp)
1792 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1793 Return nil if there isn't one."
1794 (let* ((loads load-history)
1795 (load-elt (and loads (car loads))))
1798 (or (null (car load-elt))
1799 (not (string-match file-regexp (car load-elt)))))
1800 (setq loads (cdr loads)
1801 load-elt (and loads (car loads)))))
1804 (put 'eval-after-load 'lisp-indent-function 1)
1805 (defun eval-after-load (file form)
1806 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
1807 If FILE is already loaded, evaluate FORM right now.
1809 If a matching file is loaded again, FORM will be evaluated again.
1811 If FILE is a string, it may be either an absolute or a relative file
1812 name, and may have an extension \(e.g. \".el\") or may lack one, and
1813 additionally may or may not have an extension denoting a compressed
1814 format \(e.g. \".gz\").
1816 When FILE is absolute, this first converts it to a true name by chasing
1817 symbolic links. Only a file of this name \(see next paragraph regarding
1818 extensions) will trigger the evaluation of FORM. When FILE is relative,
1819 a file whose absolute true name ends in FILE will trigger evaluation.
1821 When FILE lacks an extension, a file name with any extension will trigger
1822 evaluation. Otherwise, its extension must match FILE's. A further
1823 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1826 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1827 is evaluated at the end of any file that `provide's this feature.
1828 If the feature is provided when evaluating code not associated with a
1829 file, FORM is evaluated immediately after the provide statement.
1831 Usually FILE is just a library name like \"font-lock\" or a feature name
1834 This function makes or adds to an entry on `after-load-alist'."
1835 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1836 ;; evaluating it now).
1837 (let* ((regexp-or-feature
1839 (setq file (purecopy (load-history-regexp file)))
1841 (elt (assoc regexp-or-feature after-load-alist)))
1843 (setq elt (list regexp-or-feature))
1844 (push elt after-load-alist))
1845 ;; Make sure `form' is evalled in the current lexical/dynamic code.
1846 (setq form `(funcall ',(eval `(lambda () ,form) lexical-binding)))
1847 ;; Is there an already loaded file whose name (or `provide' name)
1849 (prog1 (if (if (stringp file)
1850 (load-history-filename-element regexp-or-feature)
1853 (when (symbolp regexp-or-feature)
1854 ;; For features, the after-load-alist elements get run when `provide' is
1855 ;; called rather than at the end of the file. So add an indirection to
1856 ;; make sure that `form' is really run "after-load" in case the provide
1857 ;; call happens early.
1860 (let ((fun (make-symbol "eval-after-load-helper")))
1861 (fset fun `(lambda (file)
1862 (if (not (equal file ',load-file-name))
1864 (remove-hook 'after-load-functions ',fun)
1866 (add-hook 'after-load-functions fun))
1867 ;; Not being provided from a file, run form right now.
1869 ;; Add FORM to the element unless it's already there.
1870 (unless (member form (cdr elt))
1871 (nconc elt (purecopy (list form)))))))
1873 (defvar after-load-functions nil
1874 "Special hook run after loading a file.
1875 Each function there is called with a single argument, the absolute
1876 name of the file just loaded.")
1878 (defun do-after-load-evaluation (abs-file)
1879 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1880 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1881 This function is called directly from the C code."
1882 ;; Run the relevant eval-after-load forms.
1883 (mapc #'(lambda (a-l-element)
1884 (when (and (stringp (car a-l-element))
1885 (string-match-p (car a-l-element) abs-file))
1886 ;; discard the file name regexp
1887 (mapc #'eval (cdr a-l-element))))
1889 ;; Complain when the user uses obsolete files.
1890 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1891 (run-with-timer 0 nil
1893 (message "Package %s is obsolete!"
1895 (string-match "\\.elc?\\>" file))))
1896 (file-name-nondirectory abs-file)))
1897 ;; Finally, run any other hook.
1898 (run-hook-with-args 'after-load-functions abs-file))
1900 (defun eval-next-after-load (file)
1901 "Read the following input sexp, and run it whenever FILE is loaded.
1902 This makes or adds to an entry on `after-load-alist'.
1903 FILE should be the name of a library, with no directory name."
1904 (eval-after-load file (read)))
1905 (make-obsolete 'eval-next-after-load `eval-after-load "23.2")
1907 (defun display-delayed-warnings ()
1908 "Display delayed warnings from `delayed-warnings-list'.
1909 Used from `delayed-warnings-hook' (which see)."
1910 (dolist (warning (nreverse delayed-warnings-list))
1911 (apply 'display-warning warning))
1912 (setq delayed-warnings-list nil))
1914 (defun collapse-delayed-warnings ()
1915 "Remove duplicates from `delayed-warnings-list'.
1916 Collapse identical adjacent warnings into one (plus count).
1917 Used from `delayed-warnings-hook' (which see)."
1920 (while delayed-warnings-list
1921 (setq warning (pop delayed-warnings-list))
1922 (if (equal warning (car delayed-warnings-list))
1923 (setq count (1+ count))
1925 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
1928 (push warning collapsed)))
1929 (setq delayed-warnings-list (nreverse collapsed))))
1931 ;; At present this is only used for Emacs internals.
1932 ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
1933 (defvar delayed-warnings-hook '(collapse-delayed-warnings
1934 display-delayed-warnings)
1935 "Normal hook run to process and display delayed warnings.
1936 By default, this hook contains functions to consolidate the
1937 warnings listed in `delayed-warnings-list', display them, and set
1938 `delayed-warnings-list' back to nil.")
1943 (defun process-lines (program &rest args)
1944 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1945 Signal an error if the program returns with a non-zero exit status."
1947 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1948 (unless (eq status 0)
1949 (error "%s exited with status %s" program status))
1950 (goto-char (point-min))
1953 (setq lines (cons (buffer-substring-no-properties
1954 (line-beginning-position)
1955 (line-end-position))
1958 (nreverse lines)))))
1960 (defun process-live-p (process)
1961 "Returns non-nil if PROCESS is alive.
1962 A process is considered alive if its status is `run', `open',
1963 `listen', `connect' or `stop'."
1964 (memq (process-status process)
1965 '(run open listen connect stop)))
1970 'process-kill-without-query
1971 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1973 (defun process-kill-without-query (process &optional _flag)
1974 "Say no query needed if PROCESS is running when Emacs is exited.
1975 Optional second argument if non-nil says to require a query.
1976 Value is t if a query was formerly required."
1977 (let ((old (process-query-on-exit-flag process)))
1978 (set-process-query-on-exit-flag process nil)
1981 (defun process-kill-buffer-query-function ()
1982 "Ask before killing a buffer that has a running process."
1983 (let ((process (get-buffer-process (current-buffer))))
1985 (not (memq (process-status process) '(run stop open listen)))
1986 (not (process-query-on-exit-flag process))
1988 (format "Buffer %S has a running process; kill it? "
1989 (buffer-name (current-buffer)))))))
1991 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1993 ;; process plist management
1995 (defun process-get (process propname)
1996 "Return the value of PROCESS' PROPNAME property.
1997 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1998 (plist-get (process-plist process) propname))
2000 (defun process-put (process propname value)
2001 "Change PROCESS' PROPNAME property to VALUE.
2002 It can be retrieved with `(process-get PROCESS PROPNAME)'."
2003 (set-process-plist process
2004 (plist-put (process-plist process) propname value)))
2007 ;;;; Input and display facilities.
2009 (defvar read-quoted-char-radix 8
2010 "Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2011 Legitimate radix values are 8, 10 and 16.")
2013 (custom-declare-variable-early
2014 'read-quoted-char-radix 8
2015 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
2016 Legitimate radix values are 8, 10 and 16."
2017 :type '(choice (const 8) (const 10) (const 16))
2018 :group 'editing-basics)
2020 (defconst read-key-empty-map (make-sparse-keymap))
2022 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
2024 (defun read-key (&optional prompt)
2025 "Read a key from the keyboard.
2026 Contrary to `read-event' this will not return a raw event but instead will
2027 obey the input decoding and translations usually done by `read-key-sequence'.
2028 So escape sequences and keyboard encoding are taken into account.
2029 When there's an ambiguity because the key looks like the prefix of
2030 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
2031 ;; This overriding-terminal-local-map binding also happens to
2032 ;; disable quail's input methods, so although read-key-sequence
2033 ;; always inherits the input method, in practice read-key does not
2034 ;; inherit the input method (at least not if it's based on quail).
2035 (let ((overriding-terminal-local-map read-key-empty-map)
2036 (overriding-local-map nil)
2038 (old-global-map (current-global-map))
2039 (timer (run-with-idle-timer
2040 ;; Wait long enough that Emacs has the time to receive and
2041 ;; process all the raw events associated with the single-key.
2042 ;; But don't wait too long, or the user may find the delay
2043 ;; annoying (or keep hitting more keys which may then get
2044 ;; lost or misinterpreted).
2045 ;; This is only relevant for keys which Emacs perceives as
2046 ;; "prefixes", such as C-x (because of the C-x 8 map in
2047 ;; key-translate-table and the C-x @ map in function-key-map)
2048 ;; or ESC (because of terminal escape sequences in
2049 ;; input-decode-map).
2052 (let ((keys (this-command-keys-vector)))
2053 (unless (zerop (length keys))
2054 ;; `keys' is non-empty, so the user has hit at least
2055 ;; one key; there's no point waiting any longer, even
2056 ;; though read-key-sequence thinks we should wait
2057 ;; for more input to decide how to interpret the
2059 (throw 'read-key keys)))))))
2063 (let ((map (make-sparse-keymap)))
2064 ;; Don't hide the menu-bar and tool-bar entries.
2065 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
2066 (define-key map [tool-bar]
2067 ;; This hack avoids evaluating the :filter (Bug#9922).
2068 (or (cdr (assq 'tool-bar global-map))
2069 (lookup-key global-map [tool-bar])))
2071 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
2072 (cancel-timer timer)
2073 (use-global-map old-global-map))))
2075 (defun read-quoted-char (&optional prompt)
2076 "Like `read-char', but do not allow quitting.
2077 Also, if the first character read is an octal digit,
2078 we read any number of octal digits and return the
2079 specified character code. Any nondigit terminates the sequence.
2080 If the terminator is RET, it is discarded;
2081 any other terminator is used itself as input.
2083 The optional argument PROMPT specifies a string to use to prompt the user.
2084 The variable `read-quoted-char-radix' controls which radix to use
2086 (let ((message-log-max nil) done (first t) (code 0) char translated)
2088 (let ((inhibit-quit first)
2089 ;; Don't let C-h get the help message--only help function keys.
2092 "Type the special character you want to use,
2093 or the octal character code.
2094 RET terminates the character code and is discarded;
2095 any other non-digit terminates the character code and is then used as input."))
2096 (setq char (read-event (and prompt (format "%s-" prompt)) t))
2097 (if inhibit-quit (setq quit-flag nil)))
2098 ;; Translate TAB key into control-I ASCII character, and so on.
2099 ;; Note: `read-char' does it using the `ascii-character' property.
2100 ;; We should try and use read-key instead.
2101 (let ((translation (lookup-key local-function-key-map (vector char))))
2102 (setq translated (if (arrayp translation)
2103 (aref translation 0)
2105 (if (integerp translated)
2106 (setq translated (char-resolve-modifiers translated)))
2107 (cond ((null translated))
2108 ((not (integerp translated))
2109 (setq unread-command-events (list char)
2111 ((/= (logand translated ?\M-\^@) 0)
2112 ;; Turn a meta-character into a character with the 0200 bit set.
2113 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
2115 ((and (<= ?0 translated)
2116 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
2117 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
2118 (and prompt (setq prompt (message "%s %c" prompt translated))))
2119 ((and (<= ?a (downcase translated))
2120 (< (downcase translated)
2121 (+ ?a -10 (min 36 read-quoted-char-radix))))
2122 (setq code (+ (* code read-quoted-char-radix)
2123 (+ 10 (- (downcase translated) ?a))))
2124 (and prompt (setq prompt (message "%s %c" prompt translated))))
2125 ((and (not first) (eq translated ?\C-m))
2128 (setq unread-command-events (list char)
2130 (t (setq code translated
2135 (defun read-passwd (prompt &optional confirm default)
2136 "Read a password, prompting with PROMPT, and return it.
2137 If optional CONFIRM is non-nil, read the password twice to make sure.
2138 Optional DEFAULT is a default password to use instead of empty input.
2140 This function echoes `.' for each character that the user types.
2142 Once the caller uses the password, it can erase the password
2143 by doing (clear-string STRING)."
2146 (while (not success)
2147 (let ((first (read-passwd prompt nil default))
2148 (second (read-passwd "Confirm password: " nil default)))
2149 (if (equal first second)
2151 (and (arrayp second) (clear-string second))
2152 (setq success first))
2153 (and (arrayp first) (clear-string first))
2154 (and (arrayp second) (clear-string second))
2155 (message "Password not repeated accurately; please start over")
2158 (let ((hide-chars-fun
2159 (lambda (beg end _len)
2160 (clear-this-command-keys)
2161 (setq beg (min end (max (minibuffer-prompt-end)
2163 (dotimes (i (- end beg))
2164 (put-text-property (+ i beg) (+ 1 i beg)
2165 'display (string ?.)))))
2167 (minibuffer-with-setup-hook
2169 (setq minibuf (current-buffer))
2170 ;; Turn off electricity.
2171 (set (make-local-variable 'post-self-insert-hook) nil)
2172 (add-hook 'after-change-functions hide-chars-fun nil 'local))
2174 (read-string prompt nil
2175 (let ((sym (make-symbol "forget-history")))
2179 (when (buffer-live-p minibuf)
2180 (with-current-buffer minibuf
2181 ;; Not sure why but it seems that there might be cases where the
2182 ;; minibuffer is not always properly reset later on, so undo
2183 ;; whatever we've done here (bug#11392).
2184 (remove-hook 'after-change-functions hide-chars-fun 'local)
2185 (kill-local-variable 'post-self-insert-hook)
2186 ;; And of course, don't keep the sensitive data around.
2187 (erase-buffer))))))))
2189 ;; This should be used by `call-interactively' for `n' specs.
2190 (defun read-number (prompt &optional default)
2191 "Read a numeric value in the minibuffer, prompting with PROMPT.
2192 DEFAULT specifies a default value to return if the user just types RET.
2193 The value of DEFAULT is inserted into PROMPT."
2197 (if (string-match "\\(\\):[ \t]*\\'" prompt)
2198 (replace-match (format " (default %s)" default) t t prompt 1)
2199 (replace-regexp-in-string "[ \t]*\\'"
2200 (format " (default %s) " default)
2204 (let ((str (read-from-minibuffer prompt nil nil nil nil
2206 (number-to-string default)))))
2209 ((zerop (length str)) default)
2210 ((stringp str) (read str))))
2213 (message "Please enter a number.")
2218 (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2219 "Read and return one of CHARS, prompting for PROMPT.
2220 Any input that is not one of CHARS is ignored.
2222 If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2223 keyboard-quit events while waiting for a valid input."
2224 (unless (consp chars)
2225 (error "Called `read-char-choice' without valid char choices"))
2226 (let (char done show-help (helpbuf " *Char Help*"))
2227 (let ((cursor-in-echo-area t)
2228 (executing-kbd-macro executing-kbd-macro))
2229 (save-window-excursion ; in case we call help-form-show
2231 (unless (get-text-property 0 'face prompt)
2232 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2233 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2235 (and show-help (buffer-live-p (get-buffer helpbuf))
2236 (kill-buffer helpbuf))
2238 ((not (numberp char)))
2239 ;; If caller has set help-form, that's enough.
2240 ;; They don't explicitly have to add help-char to chars.
2247 ((and executing-kbd-macro (= char -1))
2248 ;; read-event returns -1 if we are in a kbd macro and
2249 ;; there are no more events in the macro. Attempt to
2250 ;; get an event interactively.
2251 (setq executing-kbd-macro nil))
2252 ((and (not inhibit-keyboard-quit) (eq char ?\C-g))
2253 (keyboard-quit))))))
2254 ;; Display the question with the answer. But without cursor-in-echo-area.
2255 (message "%s%s" prompt (char-to-string char))
2258 (defun sit-for (seconds &optional nodisp obsolete)
2259 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2260 SECONDS may be a floating-point value.
2261 \(On operating systems that do not support waiting for fractions of a
2262 second, floating-point values are rounded down to the nearest integer.)
2264 If optional arg NODISP is t, don't redisplay, just wait for input.
2265 Redisplay does not happen if input is available before it starts.
2267 Value is t if waited the full time with no input arriving, and nil otherwise.
2269 An obsolete, but still supported form is
2270 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2271 where the optional arg MILLISECONDS specifies an additional wait period,
2272 in milliseconds; this was useful when Emacs was built without
2273 floating point support."
2274 (if (numberp nodisp)
2275 (setq seconds (+ seconds (* 1e-3 nodisp))
2277 (if obsolete (setq nodisp obsolete)))
2285 (or nodisp (redisplay)))
2287 (or nodisp (redisplay))
2288 (let ((read (read-event nil nil seconds)))
2291 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2292 ;; unread-command-events as (t . EVENT) so it will be added to
2293 ;; this-command-keys by read-key-sequence.
2294 (if (eq overriding-terminal-local-map universal-argument-map)
2295 (setq read (cons t read)))
2296 (push read unread-command-events)
2298 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2300 (defun y-or-n-p (prompt)
2301 "Ask user a \"y or n\" question. Return t if answer is \"y\".
2302 PROMPT is the string to display to ask the question. It should
2303 end in a space; `y-or-n-p' adds \"(y or n) \" to it.
2305 No confirmation of the answer is requested; a single character is enough.
2306 Also accepts Space to mean yes, or Delete to mean no. \(Actually, it uses
2307 the bindings in `query-replace-map'; see the documentation of that variable
2308 for more information. In this case, the useful bindings are `act', `skip',
2309 `recenter', and `quit'.\)
2311 Under a windowing system a dialog box will be used if `last-nonmenu-event'
2312 is nil and `use-dialog-box' is non-nil."
2313 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2314 ;; where all the keys were unbound (i.e. it somehow got triggered
2315 ;; within read-key, apparently). I had to kill it.
2316 (let ((answer 'recenter))
2319 (setq prompt (concat prompt
2320 (if (eq ?\s (aref prompt (1- (length prompt))))
2323 (let ((temp-prompt prompt))
2324 (while (not (memq answer '(act skip)))
2325 (let ((str (read-string temp-prompt)))
2326 (cond ((member str '("y" "Y")) (setq answer 'act))
2327 ((member str '("n" "N")) (setq answer 'skip))
2328 (t (setq temp-prompt (concat "Please answer y or n. "
2330 ((and (display-popup-menus-p)
2331 (listp last-nonmenu-event)
2334 (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
2336 (setq prompt (concat prompt
2337 (if (eq ?\s (aref prompt (1- (length prompt))))
2342 (let ((cursor-in-echo-area t))
2343 (when minibuffer-auto-raise
2344 (raise-frame (window-frame (minibuffer-window))))
2345 (read-key (propertize (if (eq answer 'recenter)
2347 (concat "Please answer y or n. "
2349 'face 'minibuffer-prompt)))))
2350 (setq answer (lookup-key query-replace-map (vector key) t))
2352 ((memq answer '(skip act)) nil)
2353 ((eq answer 'recenter) (recenter) t)
2354 ((memq answer '(exit-prefix quit)) (signal 'quit nil) t)
2358 (let ((ret (eq answer 'act)))
2359 (unless noninteractive
2360 ;; FIXME this prints one too many spaces, since prompt
2361 ;; already ends in a space. Eg "... (y or n) y".
2362 (message "%s %s" prompt (if ret "y" "n")))
2366 ;;; Atomic change groups.
2368 (defmacro atomic-change-group (&rest body)
2369 "Perform BODY as an atomic change group.
2370 This means that if BODY exits abnormally,
2371 all of its changes to the current buffer are undone.
2372 This works regardless of whether undo is enabled in the buffer.
2374 This mechanism is transparent to ordinary use of undo;
2375 if undo is enabled in the buffer and BODY succeeds, the
2376 user can undo the change normally."
2377 (declare (indent 0) (debug t))
2378 (let ((handle (make-symbol "--change-group-handle--"))
2379 (success (make-symbol "--change-group-success--")))
2380 `(let ((,handle (prepare-change-group))
2381 ;; Don't truncate any undo data in the middle of this.
2382 (undo-outer-limit nil)
2383 (undo-limit most-positive-fixnum)
2384 (undo-strong-limit most-positive-fixnum)
2388 ;; This is inside the unwind-protect because
2389 ;; it enables undo if that was disabled; we need
2390 ;; to make sure that it gets disabled again.
2391 (activate-change-group ,handle)
2394 ;; Either of these functions will disable undo
2395 ;; if it was disabled before.
2397 (accept-change-group ,handle)
2398 (cancel-change-group ,handle))))))
2400 (defun prepare-change-group (&optional buffer)
2401 "Return a handle for the current buffer's state, for a change group.
2402 If you specify BUFFER, make a handle for BUFFER's state instead.
2404 Pass the handle to `activate-change-group' afterward to initiate
2405 the actual changes of the change group.
2407 To finish the change group, call either `accept-change-group' or
2408 `cancel-change-group' passing the same handle as argument. Call
2409 `accept-change-group' to accept the changes in the group as final;
2410 call `cancel-change-group' to undo them all. You should use
2411 `unwind-protect' to make sure the group is always finished. The call
2412 to `activate-change-group' should be inside the `unwind-protect'.
2413 Once you finish the group, don't use the handle again--don't try to
2414 finish the same group twice. For a simple example of correct use, see
2415 the source code of `atomic-change-group'.
2417 The handle records only the specified buffer. To make a multibuffer
2418 change group, call this function once for each buffer you want to
2419 cover, then use `nconc' to combine the returned values, like this:
2421 (nconc (prepare-change-group buffer-1)
2422 (prepare-change-group buffer-2))
2424 You can then activate that multibuffer change group with a single
2425 call to `activate-change-group' and finish it with a single call
2426 to `accept-change-group' or `cancel-change-group'."
2429 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2430 (list (cons (current-buffer) buffer-undo-list))))
2432 (defun activate-change-group (handle)
2433 "Activate a change group made with `prepare-change-group' (which see)."
2434 (dolist (elt handle)
2435 (with-current-buffer (car elt)
2436 (if (eq buffer-undo-list t)
2437 (setq buffer-undo-list nil)))))
2439 (defun accept-change-group (handle)
2440 "Finish a change group made with `prepare-change-group' (which see).
2441 This finishes the change group by accepting its changes as final."
2442 (dolist (elt handle)
2443 (with-current-buffer (car elt)
2444 (if (eq (cdr elt) t)
2445 (setq buffer-undo-list t)))))
2447 (defun cancel-change-group (handle)
2448 "Finish a change group made with `prepare-change-group' (which see).
2449 This finishes the change group by reverting all of its changes."
2450 (dolist (elt handle)
2451 (with-current-buffer (car elt)
2452 (setq elt (cdr elt))
2454 ;; Widen buffer temporarily so if the buffer was narrowed within
2455 ;; the body of `atomic-change-group' all changes can be undone.
2458 (if (consp elt) (car elt)))
2460 (if (consp elt) (cdr elt))))
2461 ;; Temporarily truncate the undo log at ELT.
2463 (setcar elt nil) (setcdr elt nil))
2464 (unless (eq last-command 'undo) (undo-start))
2465 ;; Make sure there's no confusion.
2466 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2467 (error "Undoing to some unrelated state"))
2470 (while (listp pending-undo-list) (undo-more 1)))
2471 ;; Reset the modified cons cell ELT to its original content.
2473 (setcar elt old-car)
2474 (setcdr elt old-cdr))
2475 ;; Revert the undo info to what it was when we grabbed the state.
2476 (setq buffer-undo-list elt))))))
2478 ;;;; Display-related functions.
2480 ;; For compatibility.
2481 (define-obsolete-function-alias 'redraw-modeline
2482 'force-mode-line-update "24.2")
2484 (defun force-mode-line-update (&optional all)
2485 "Force redisplay of the current buffer's mode line and header line.
2486 With optional non-nil ALL, force redisplay of all mode lines and
2487 header lines. This function also forces recomputation of the
2488 menu bar menus and the frame title."
2489 (if all (with-current-buffer (other-buffer)))
2490 (set-buffer-modified-p (buffer-modified-p)))
2492 (defun momentary-string-display (string pos &optional exit-char message)
2493 "Momentarily display STRING in the buffer at POS.
2494 Display remains until next event is input.
2495 If POS is a marker, only its position is used; its buffer is ignored.
2496 Optional third arg EXIT-CHAR can be a character, event or event
2497 description list. EXIT-CHAR defaults to SPC. If the input is
2498 EXIT-CHAR it is swallowed; otherwise it is then available as
2499 input (as a command if nothing else).
2500 Display MESSAGE (optional fourth arg) in the echo area.
2501 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2502 (or exit-char (setq exit-char ?\s))
2503 (let ((ol (make-overlay pos pos))
2504 (str (copy-sequence string)))
2508 (overlay-put ol 'after-string str)
2510 ;; To avoid trouble with out-of-bounds position
2512 ;; If the string end is off screen, recenter now.
2513 (if (<= (window-end nil t) pos)
2514 (recenter (/ (window-height) 2))))
2515 (message (or message "Type %s to continue editing.")
2516 (single-key-description exit-char))
2517 (let ((event (read-event)))
2518 ;; `exit-char' can be an event, or an event description list.
2519 (or (eq event exit-char)
2520 (eq event (event-convert-list exit-char))
2521 (setq unread-command-events (list event)))))
2522 (delete-overlay ol))))
2525 ;;;; Overlay operations
2527 (defun copy-overlay (o)
2528 "Return a copy of overlay O."
2529 (let ((o1 (if (overlay-buffer o)
2530 (make-overlay (overlay-start o) (overlay-end o)
2531 ;; FIXME: there's no easy way to find the
2532 ;; insertion-type of the two markers.
2534 (let ((o1 (make-overlay (point-min) (point-min))))
2537 (props (overlay-properties o)))
2539 (overlay-put o1 (pop props) (pop props)))
2542 (defun remove-overlays (&optional beg end name val)
2543 "Clear BEG and END of overlays whose property NAME has value VAL.
2544 Overlays might be moved and/or split.
2545 BEG and END default respectively to the beginning and end of buffer."
2546 ;; This speeds up the loops over overlays.
2547 (unless beg (setq beg (point-min)))
2548 (unless end (setq end (point-max)))
2549 (overlay-recenter end)
2551 (setq beg (prog1 end (setq end beg))))
2553 (dolist (o (overlays-in beg end))
2554 (when (eq (overlay-get o name) val)
2555 ;; Either push this overlay outside beg...end
2556 ;; or split it to exclude beg...end
2557 ;; or delete it entirely (if it is contained in beg...end).
2558 (if (< (overlay-start o) beg)
2559 (if (> (overlay-end o) end)
2561 (move-overlay (copy-overlay o)
2562 (overlay-start o) beg)
2563 (move-overlay o end (overlay-end o)))
2564 (move-overlay o (overlay-start o) beg))
2565 (if (> (overlay-end o) end)
2566 (move-overlay o end (overlay-end o))
2567 (delete-overlay o)))))))
2571 (defvar suspend-hook nil
2572 "Normal hook run by `suspend-emacs', before suspending.")
2574 (defvar suspend-resume-hook nil
2575 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2577 (defvar temp-buffer-show-hook nil
2578 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2579 When the hook runs, the temporary buffer is current, and the window it
2580 was displayed in is selected.")
2582 (defvar temp-buffer-setup-hook nil
2583 "Normal hook run by `with-output-to-temp-buffer' at the start.
2584 When the hook runs, the temporary buffer is current.
2585 This hook is normally set up with a function to put the buffer in Help
2588 ;; Avoid compiler warnings about this variable,
2589 ;; which has a special meaning on certain system types.
2590 (defvar buffer-file-type nil
2591 "Non-nil if the visited file is a binary file.
2592 This variable is meaningful on MS-DOG and Windows NT.
2593 On those systems, it is automatically local in every buffer.
2594 On other systems, this variable is normally always nil.")
2596 ;; The `assert' macro from the cl package signals
2597 ;; `cl-assertion-failed' at runtime so always define it.
2598 (put 'cl-assertion-failed 'error-conditions '(error))
2599 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2601 (defconst user-emacs-directory
2602 (if (eq system-type 'ms-dos)
2603 ;; MS-DOS cannot have initial dot.
2606 "Directory beneath which additional per-user Emacs-specific files are placed.
2607 Various programs in Emacs store information in this directory.
2608 Note that this should end with a directory separator.
2609 See also `locate-user-emacs-file'.")
2611 (defun locate-user-emacs-file (new-name &optional old-name)
2612 "Return an absolute per-user Emacs-specific file name.
2613 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2614 Else return NEW-NAME in `user-emacs-directory', creating the
2615 directory if it does not exist."
2616 (convert-standard-filename
2617 (let* ((home (concat "~" (or init-file-user "")))
2618 (at-home (and old-name (expand-file-name old-name home))))
2619 (if (and at-home (file-readable-p at-home))
2621 ;; Make sure `user-emacs-directory' exists,
2622 ;; unless we're in batch mode or dumping Emacs
2625 (file-accessible-directory-p
2626 (directory-file-name user-emacs-directory))
2627 (let ((umask (default-file-modes)))
2630 (set-default-file-modes ?\700)
2631 (make-directory user-emacs-directory))
2632 (set-default-file-modes umask))))
2633 (abbreviate-file-name
2634 (expand-file-name new-name user-emacs-directory))))))
2636 ;;;; Misc. useful functions.
2638 (defun find-tag-default ()
2639 "Determine default tag to search for, based on text at point.
2640 If there is no plausible default, return nil."
2641 (let (from to bound)
2643 ;; Look at text around `point'.
2645 (skip-syntax-backward "w_") (setq from (point)))
2647 (skip-syntax-forward "w_") (setq to (point)))
2649 ;; Look between `line-beginning-position' and `point'.
2651 (and (setq bound (line-beginning-position))
2652 (skip-syntax-backward "^w_" bound)
2653 (> (setq to (point)) bound)
2654 (skip-syntax-backward "w_")
2655 (setq from (point))))
2656 ;; Look between `point' and `line-end-position'.
2658 (and (setq bound (line-end-position))
2659 (skip-syntax-forward "^w_" bound)
2660 (< (setq from (point)) bound)
2661 (skip-syntax-forward "w_")
2662 (setq to (point)))))
2663 (buffer-substring-no-properties from to))))
2665 (defun play-sound (sound)
2666 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2667 The following keywords are recognized:
2669 :file FILE - read sound data from FILE. If FILE isn't an
2670 absolute file name, it is searched in `data-directory'.
2672 :data DATA - read sound data from string DATA.
2674 Exactly one of :file or :data must be present.
2676 :volume VOL - set volume to VOL. VOL must an integer in the
2677 range 0..100 or a float in the range 0..1.0. If not specified,
2678 don't change the volume setting of the sound device.
2680 :device DEVICE - play sound on DEVICE. If not specified,
2681 a system-dependent default device name is used.
2683 Note: :data and :device are currently not supported on Windows."
2684 (if (fboundp 'play-sound-internal)
2685 (play-sound-internal sound)
2686 (error "This Emacs binary lacks sound support")))
2688 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2690 (defun shell-quote-argument (argument)
2691 "Quote ARGUMENT for passing as argument to an inferior shell."
2693 ((eq system-type 'ms-dos)
2694 ;; Quote using double quotes, but escape any existing quotes in
2695 ;; the argument with backslashes.
2699 (if (or (null (string-match "[^\"]" argument))
2700 (< (match-end 0) (length argument)))
2701 (while (string-match "[\"]" argument start)
2702 (setq end (match-beginning 0)
2703 result (concat result (substring argument start end)
2704 "\\" (substring argument end (1+ end)))
2706 (concat "\"" result (substring argument start) "\"")))
2708 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
2710 ;; First, quote argument so that CommandLineToArgvW will
2711 ;; understand it. See
2712 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2713 ;; After we perform that level of quoting, escape shell
2714 ;; metacharacters so that cmd won't mangle our argument. If the
2715 ;; argument contains no double quote characters, we can just
2716 ;; surround it with double quotes. Otherwise, we need to prefix
2717 ;; each shell metacharacter with a caret.
2720 ;; escape backslashes at end of string
2721 (replace-regexp-in-string
2724 ;; escape backslashes and quotes in string body
2725 (replace-regexp-in-string
2730 (if (string-match "[%!\"]" argument)
2733 (replace-regexp-in-string
2734 "\\([%!()\"<>&|^]\\)"
2738 (concat "\"" argument "\"")))
2741 (if (equal argument "")
2743 ;; Quote everything except POSIX filename characters.
2744 ;; This should be safe enough even for really weird shells.
2745 (replace-regexp-in-string
2747 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2750 (defun string-or-null-p (object)
2751 "Return t if OBJECT is a string or nil.
2752 Otherwise, return nil."
2753 (or (stringp object) (null object)))
2755 (defun booleanp (object)
2756 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2757 Otherwise, return nil."
2758 (and (memq object '(nil t)) t))
2760 (defun field-at-pos (pos)
2761 "Return the field at position POS, taking stickiness etc into account."
2762 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2763 (if (eq raw-field 'boundary)
2764 (get-char-property (1- (field-end pos)) 'field)
2767 (defun sha1 (object &optional start end binary)
2768 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2769 OBJECT is either a string or a buffer. Optional arguments START and
2770 END are character positions specifying which portion of OBJECT for
2771 computing the hash. If BINARY is non-nil, return a string in binary
2773 (secure-hash 'sha1 object start end binary))
2776 ;;;; Support for yanking and text properties.
2778 (defvar yank-excluded-properties)
2780 (defun remove-yank-excluded-properties (start end)
2781 "Remove `yank-excluded-properties' between START and END positions.
2782 Replaces `category' properties with their defined properties."
2783 (let ((inhibit-read-only t))
2784 ;; Replace any `category' property with the properties it stands
2785 ;; for. This is to remove `mouse-face' properties that are placed
2786 ;; on categories in *Help* buffers' buttons. See
2787 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2789 (unless (memq yank-excluded-properties '(t nil))
2792 (while (< (point) end)
2793 (let ((cat (get-text-property (point) 'category))
2796 (next-single-property-change (point) 'category nil end))
2798 (let (run-end2 original)
2799 (remove-list-of-text-properties (point) run-end '(category))
2800 (while (< (point) run-end)
2801 (setq run-end2 (next-property-change (point) nil run-end))
2802 (setq original (text-properties-at (point)))
2803 (set-text-properties (point) run-end2 (symbol-plist cat))
2804 (add-text-properties (point) run-end2 original)
2805 (goto-char run-end2))))
2806 (goto-char run-end)))))
2807 (if (eq yank-excluded-properties t)
2808 (set-text-properties start end nil)
2809 (remove-list-of-text-properties start end yank-excluded-properties))))
2811 (defvar yank-undo-function)
2813 (defun insert-for-yank (string)
2814 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
2816 See `insert-for-yank-1' for more details."
2818 (while (setq to (next-single-property-change 0 'yank-handler string))
2819 (insert-for-yank-1 (substring string 0 to))
2820 (setq string (substring string to))))
2821 (insert-for-yank-1 string))
2823 (defun insert-for-yank-1 (string)
2824 "Insert STRING at point, stripping some text properties.
2826 Strip text properties from the inserted text according to
2827 `yank-excluded-properties'. Otherwise just like (insert STRING).
2829 If STRING has a non-nil `yank-handler' property on the first character,
2830 the normal insert behavior is modified in various ways. The value of
2831 the yank-handler property must be a list with one to four elements
2832 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2833 When FUNCTION is present and non-nil, it is called instead of `insert'
2834 to insert the string. FUNCTION takes one argument--the object to insert.
2835 If PARAM is present and non-nil, it replaces STRING as the object
2836 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2837 `yank-rectangle', PARAM may be a list of strings to insert as a
2839 If NOEXCLUDE is present and non-nil, the normal removal of the
2840 `yank-excluded-properties' is not performed; instead FUNCTION is
2841 responsible for removing those properties. This may be necessary
2842 if FUNCTION adjusts point before or after inserting the object.
2843 If UNDO is present and non-nil, it is a function that will be called
2844 by `yank-pop' to undo the insertion of the current object. It is
2845 called with two arguments, the start and end of the current region.
2846 FUNCTION may set `yank-undo-function' to override the UNDO value."
2847 (let* ((handler (and (stringp string)
2848 (get-text-property 0 'yank-handler string)))
2849 (param (or (nth 1 handler) string))
2851 (inhibit-read-only inhibit-read-only)
2854 (setq yank-undo-function t)
2855 (if (nth 0 handler) ;; FUNCTION
2856 (funcall (car handler) param)
2860 ;; Prevent read-only properties from interfering with the
2861 ;; following text property changes.
2862 (setq inhibit-read-only t)
2864 ;; What should we do with `font-lock-face' properties?
2865 (if font-lock-defaults
2866 ;; No, just wipe them.
2867 (remove-list-of-text-properties opoint end '(font-lock-face))
2868 ;; Convert them to `face'.
2871 (while (< (point) end)
2872 (let ((face (get-text-property (point) 'font-lock-face))
2875 (next-single-property-change (point) 'font-lock-face nil end))
2877 (remove-text-properties (point) run-end '(font-lock-face nil))
2878 (put-text-property (point) run-end 'face face))
2879 (goto-char run-end)))))
2881 (unless (nth 2 handler) ;; NOEXCLUDE
2882 (remove-yank-excluded-properties opoint (point)))
2884 ;; If last inserted char has properties, mark them as rear-nonsticky.
2885 (if (and (> end opoint)
2886 (text-properties-at (1- end)))
2887 (put-text-property (1- end) end 'rear-nonsticky t))
2889 (if (eq yank-undo-function t) ;; not set by FUNCTION
2890 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2891 (if (nth 4 handler) ;; COMMAND
2892 (setq this-command (nth 4 handler)))))
2894 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2895 "Insert before point a substring of BUFFER, without text properties.
2896 BUFFER may be a buffer or a buffer name.
2897 Arguments START and END are character positions specifying the substring.
2898 They default to the values of (point-min) and (point-max) in BUFFER."
2899 (let ((opoint (point)))
2900 (insert-buffer-substring buffer start end)
2901 (let ((inhibit-read-only t))
2902 (set-text-properties opoint (point) nil))))
2904 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2905 "Insert before point a part of BUFFER, stripping some text properties.
2906 BUFFER may be a buffer or a buffer name.
2907 Arguments START and END are character positions specifying the substring.
2908 They default to the values of (point-min) and (point-max) in BUFFER.
2909 Strip text properties from the inserted text according to
2910 `yank-excluded-properties'."
2911 ;; Since the buffer text should not normally have yank-handler properties,
2912 ;; there is no need to handle them here.
2913 (let ((opoint (point)))
2914 (insert-buffer-substring buffer start end)
2915 (remove-yank-excluded-properties opoint (point))))
2918 ;;;; Synchronous shell commands.
2920 (defun start-process-shell-command (name buffer &rest args)
2921 "Start a program in a subprocess. Return the process object for it.
2922 NAME is name for process. It is modified if necessary to make it unique.
2923 BUFFER is the buffer (or buffer name) to associate with the process.
2924 Process output goes at end of that buffer, unless you specify
2925 an output stream or filter function to handle the output.
2926 BUFFER may be also nil, meaning that this process is not associated
2928 COMMAND is the shell command to run.
2930 An old calling convention accepted any number of arguments after COMMAND,
2931 which were just concatenated to COMMAND. This is still supported but strongly
2933 ;; We used to use `exec' to replace the shell with the command,
2934 ;; but that failed to handle (...) and semicolon, etc.
2935 (start-process name buffer shell-file-name shell-command-switch
2936 (mapconcat 'identity args " ")))
2937 (set-advertised-calling-convention 'start-process-shell-command
2938 '(name buffer command) "23.1")
2940 (defun start-file-process-shell-command (name buffer &rest args)
2941 "Start a program in a subprocess. Return the process object for it.
2942 Similar to `start-process-shell-command', but calls `start-file-process'."
2945 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2946 (if (file-remote-p default-directory) "-c" shell-command-switch)
2947 (mapconcat 'identity args " ")))
2948 (set-advertised-calling-convention 'start-file-process-shell-command
2949 '(name buffer command) "23.1")
2951 (defun call-process-shell-command (command &optional infile buffer display
2953 "Execute the shell command COMMAND synchronously in separate process.
2954 The remaining arguments are optional.
2955 The program's input comes from file INFILE (nil means `/dev/null').
2956 Insert output in BUFFER before point; t means current buffer;
2957 nil for BUFFER means discard it; 0 means discard and don't wait.
2958 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2959 REAL-BUFFER says what to do with standard output, as above,
2960 while STDERR-FILE says what to do with standard error in the child.
2961 STDERR-FILE may be nil (discard standard error output),
2962 t (mix it with ordinary output), or a file name string.
2964 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2965 Remaining arguments are strings passed as additional arguments for COMMAND.
2966 Wildcards and redirection are handled as usual in the shell.
2968 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2969 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2970 status or a signal description string.
2971 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2972 ;; We used to use `exec' to replace the shell with the command,
2973 ;; but that failed to handle (...) and semicolon, etc.
2974 (call-process shell-file-name
2975 infile buffer display
2976 shell-command-switch
2977 (mapconcat 'identity (cons command args) " ")))
2979 (defun process-file-shell-command (command &optional infile buffer display
2981 "Process files synchronously in a separate process.
2982 Similar to `call-process-shell-command', but calls `process-file'."
2984 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2985 infile buffer display
2986 (if (file-remote-p default-directory) "-c" shell-command-switch)
2987 (mapconcat 'identity (cons command args) " ")))
2989 ;;;; Lisp macros to do various things temporarily.
2991 (defmacro with-current-buffer (buffer-or-name &rest body)
2992 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2993 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2994 The value returned is the value of the last form in BODY. See
2995 also `with-temp-buffer'."
2996 (declare (indent 1) (debug t))
2997 `(save-current-buffer
2998 (set-buffer ,buffer-or-name)
3001 (defmacro with-selected-window (window &rest body)
3002 "Execute the forms in BODY with WINDOW as the selected window.
3003 The value returned is the value of the last form in BODY.
3005 This macro saves and restores the selected window, as well as the
3006 selected window of each frame. It does not change the order of
3007 recently selected windows. If the previously selected window of
3008 some frame is no longer live at the end of BODY, that frame's
3009 selected window is left alone. If the selected window is no
3010 longer live, then whatever window is selected at the end of BODY
3013 This macro uses `save-current-buffer' to save and restore the
3014 current buffer, since otherwise its normal operation could
3015 potentially make a different buffer current. It does not alter
3016 the buffer list ordering."
3017 (declare (indent 1) (debug t))
3018 ;; Most of this code is a copy of save-selected-window.
3019 `(let* ((save-selected-window-destination ,window)
3020 (save-selected-window-frame
3021 (window-frame save-selected-window-destination))
3022 (save-selected-window-window (selected-window))
3023 ;; Selecting a window on another frame also changes that
3024 ;; frame's frame-selected-window. We must save&restore it.
3025 (save-selected-window-other-frame
3026 (unless (eq (selected-frame) save-selected-window-frame)
3027 (frame-selected-window save-selected-window-frame)))
3028 (save-selected-window-top-frame
3029 (unless (eq (selected-frame) save-selected-window-frame)
3030 (tty-top-frame save-selected-window-frame))))
3031 (save-current-buffer
3033 (progn (select-window save-selected-window-destination 'norecord)
3035 ;; First reset frame-selected-window.
3036 (when (window-live-p save-selected-window-other-frame)
3037 ;; We don't use set-frame-selected-window because it does not
3038 ;; pass the `norecord' argument to Fselect_window.
3039 (select-window save-selected-window-other-frame 'norecord)
3040 (and (frame-live-p save-selected-window-top-frame)
3041 (not (eq (tty-top-frame) save-selected-window-top-frame))
3042 (select-frame save-selected-window-top-frame 'norecord)))
3043 ;; Then reset the actual selected-window.
3044 (when (window-live-p save-selected-window-window)
3045 (select-window save-selected-window-window 'norecord))))))
3047 (defmacro with-selected-frame (frame &rest body)
3048 "Execute the forms in BODY with FRAME as the selected frame.
3049 The value returned is the value of the last form in BODY.
3051 This macro saves and restores the selected frame, and changes the
3052 order of neither the recently selected windows nor the buffers in
3054 (declare (indent 1) (debug t))
3055 (let ((old-frame (make-symbol "old-frame"))
3056 (old-buffer (make-symbol "old-buffer")))
3057 `(let ((,old-frame (selected-frame))
3058 (,old-buffer (current-buffer)))
3060 (progn (select-frame ,frame 'norecord)
3062 (when (frame-live-p ,old-frame)
3063 (select-frame ,old-frame 'norecord))
3064 (when (buffer-live-p ,old-buffer)
3065 (set-buffer ,old-buffer))))))
3067 (defmacro save-window-excursion (&rest body)
3068 "Execute BODY, then restore previous window configuration.
3069 This macro saves the window configuration on the selected frame,
3070 executes BODY, then calls `set-window-configuration' to restore
3071 the saved window configuration. The return value is the last
3072 form in BODY. The window configuration is also restored if BODY
3075 BEWARE: Most uses of this macro introduce bugs.
3076 E.g. it should not be used to try and prevent some code from opening
3077 a new window, since that window may sometimes appear in another frame,
3078 in which case `save-window-excursion' cannot help."
3079 (declare (indent 0) (debug t))
3080 (let ((c (make-symbol "wconfig")))
3081 `(let ((,c (current-window-configuration)))
3082 (unwind-protect (progn ,@body)
3083 (set-window-configuration ,c)))))
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 (let ((old-dir (make-symbol "old-dir"))
3113 (buf (make-symbol "buf")))
3114 `(let* ((,old-dir default-directory)
3116 (with-current-buffer (get-buffer-create ,bufname)
3117 (prog1 (current-buffer)
3118 (kill-all-local-variables)
3119 ;; FIXME: delete_all_overlays
3120 (setq default-directory ,old-dir)
3121 (setq buffer-read-only nil)
3122 (setq buffer-file-name nil)
3123 (setq buffer-undo-list t)
3124 (let ((inhibit-read-only t)
3125 (inhibit-modification-hooks t))
3127 (run-hooks 'temp-buffer-setup-hook)))))
3128 (standard-output ,buf))
3129 (prog1 (progn ,@body)
3130 (internal-temp-output-buffer-show ,buf)))))
3132 (defmacro with-temp-file (file &rest body)
3133 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3134 The value returned is the value of the last form in BODY.
3135 See also `with-temp-buffer'."
3136 (declare (indent 1) (debug t))
3137 (let ((temp-file (make-symbol "temp-file"))
3138 (temp-buffer (make-symbol "temp-buffer")))
3139 `(let ((,temp-file ,file)
3141 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3144 (with-current-buffer ,temp-buffer
3146 (with-current-buffer ,temp-buffer
3147 (write-region nil nil ,temp-file nil 0)))
3148 (and (buffer-name ,temp-buffer)
3149 (kill-buffer ,temp-buffer))))))
3151 (defmacro with-temp-message (message &rest body)
3152 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
3153 The original message is restored to the echo area after BODY has finished.
3154 The value returned is the value of the last form in BODY.
3155 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3156 If MESSAGE is nil, the echo area and message log buffer are unchanged.
3157 Use a MESSAGE of \"\" to temporarily clear the echo area."
3158 (declare (debug t) (indent 1))
3159 (let ((current-message (make-symbol "current-message"))
3160 (temp-message (make-symbol "with-temp-message")))
3161 `(let ((,temp-message ,message)
3166 (setq ,current-message (current-message))
3167 (message "%s" ,temp-message))
3170 (if ,current-message
3171 (message "%s" ,current-message)
3174 (defmacro with-temp-buffer (&rest body)
3175 "Create a temporary buffer, and evaluate BODY there like `progn'.
3176 See also `with-temp-file' and `with-output-to-string'."
3177 (declare (indent 0) (debug t))
3178 (let ((temp-buffer (make-symbol "temp-buffer")))
3179 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
3180 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3181 (with-current-buffer ,temp-buffer
3184 (and (buffer-name ,temp-buffer)
3185 (kill-buffer ,temp-buffer)))))))
3187 (defmacro with-silent-modifications (&rest body)
3188 "Execute BODY, pretending it does not modify the buffer.
3189 If BODY performs real modifications to the buffer's text, other
3190 than cosmetic ones, undo data may become corrupted.
3192 This macro will run BODY normally, but doesn't count its buffer
3193 modifications as being buffer modifications. This affects things
3194 like buffer-modified-p, checking whether the file is locked by
3195 someone else, running buffer modification hooks, and other things
3198 Typically used around modifications of text-properties which do
3199 not really affect the buffer's content."
3200 (declare (debug t) (indent 0))
3201 (let ((modified (make-symbol "modified")))
3202 `(let* ((,modified (buffer-modified-p))
3203 (buffer-undo-list t)
3204 (inhibit-read-only t)
3205 (inhibit-modification-hooks t)
3207 ;; Avoid setting and removing file locks and checking
3208 ;; buffer's uptodate-ness w.r.t the underlying file.
3210 buffer-file-truename)
3215 (restore-buffer-modified-p nil))))))
3217 (defmacro with-output-to-string (&rest body)
3218 "Execute BODY, return the text it sent to `standard-output', as a string."
3219 (declare (indent 0) (debug t))
3220 `(let ((standard-output
3221 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
3224 (let ((standard-output standard-output))
3226 (with-current-buffer standard-output
3228 (kill-buffer standard-output))))
3230 (defmacro with-local-quit (&rest body)
3231 "Execute BODY, allowing quits to terminate BODY but not escape further.
3232 When a quit terminates BODY, `with-local-quit' returns nil but
3233 requests another quit. That quit will be processed as soon as quitting
3234 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
3235 (declare (debug t) (indent 0))
3236 `(condition-case nil
3237 (let ((inhibit-quit nil))
3239 (quit (setq quit-flag t)
3240 ;; This call is to give a chance to handle quit-flag
3241 ;; in case inhibit-quit is nil.
3242 ;; Without this, it will not be handled until the next function
3243 ;; call, and that might allow it to exit thru a condition-case
3244 ;; that intends to handle the quit signal next time.
3245 (eval '(ignore nil)))))
3247 (defmacro while-no-input (&rest body)
3248 "Execute BODY only as long as there's no pending input.
3249 If input arrives, that ends the execution of BODY,
3250 and `while-no-input' returns t. Quitting makes it return nil.
3251 If BODY finishes, `while-no-input' returns whatever value BODY produced."
3252 (declare (debug t) (indent 0))
3253 (let ((catch-sym (make-symbol "input")))
3256 (let ((throw-on-input ',catch-sym))
3257 (or (input-pending-p)
3258 (progn ,@body)))))))
3260 (defmacro condition-case-unless-debug (var bodyform &rest handlers)
3261 "Like `condition-case' except that it does not catch anything when debugging.
3262 More specifically if `debug-on-error' is set, then it does not catch any signal."
3263 (declare (debug condition-case) (indent 2))
3264 (let ((bodysym (make-symbol "body")))
3265 `(let ((,bodysym (lambda () ,bodyform)))
3268 (condition-case ,var
3272 (define-obsolete-function-alias 'condition-case-no-debug
3273 'condition-case-unless-debug "24.1")
3275 (defmacro with-demoted-errors (&rest body)
3276 "Run BODY and demote any errors to simple messages.
3277 If `debug-on-error' is non-nil, run BODY without catching its errors.
3278 This is to be used around code which is not expected to signal an error
3279 but which should be robust in the unexpected case that an error is signaled."
3280 (declare (debug t) (indent 0))
3281 (let ((err (make-symbol "err")))
3282 `(condition-case-unless-debug ,err
3284 (error (message "Error: %S" ,err) nil))))
3286 (defmacro combine-after-change-calls (&rest body)
3287 "Execute BODY, but don't call the after-change functions till the end.
3288 If BODY makes changes in the buffer, they are recorded
3289 and the functions on `after-change-functions' are called several times
3290 when BODY is finished.
3291 The return value is the value of the last form in BODY.
3293 If `before-change-functions' is non-nil, then calls to the after-change
3294 functions can't be deferred, so in that case this macro has no effect.
3296 Do not alter `after-change-functions' or `before-change-functions'
3298 (declare (indent 0) (debug t))
3300 (let ((combine-after-change-calls t))
3302 (combine-after-change-execute)))
3304 (defmacro with-case-table (table &rest body)
3305 "Execute the forms in BODY with TABLE as the current case table.
3306 The value returned is the value of the last form in BODY."
3307 (declare (indent 1) (debug t))
3308 (let ((old-case-table (make-symbol "table"))
3309 (old-buffer (make-symbol "buffer")))
3310 `(let ((,old-case-table (current-case-table))
3311 (,old-buffer (current-buffer)))
3313 (progn (set-case-table ,table)
3315 (with-current-buffer ,old-buffer
3316 (set-case-table ,old-case-table))))))
3318 ;;; Matching and match data.
3320 (defvar save-match-data-internal)
3322 ;; We use save-match-data-internal as the local variable because
3323 ;; that works ok in practice (people should not use that variable elsewhere).
3324 ;; We used to use an uninterned symbol; the compiler handles that properly
3325 ;; now, but it generates slower code.
3326 (defmacro save-match-data (&rest body)
3327 "Execute the BODY forms, restoring the global value of the match data.
3328 The value returned is the value of the last form in BODY."
3329 ;; It is better not to use backquote here,
3330 ;; because that makes a bootstrapping problem
3331 ;; if you need to recompile all the Lisp files using interpreted code.
3332 (declare (indent 0) (debug t))
3334 '((save-match-data-internal (match-data)))
3335 (list 'unwind-protect
3337 ;; It is safe to free (evaporate) markers immediately here,
3338 ;; as Lisp programs should not copy from save-match-data-internal.
3339 '(set-match-data save-match-data-internal 'evaporate))))
3341 (defun match-string (num &optional string)
3342 "Return string of text matched by last search.
3343 NUM specifies which parenthesized expression in the last regexp.
3344 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3345 Zero means the entire text matched by the whole regexp or whole string.
3346 STRING should be given if the last search was by `string-match' on STRING.
3347 If STRING is nil, the current buffer should be the same buffer
3348 the search/match was performed in."
3349 (if (match-beginning num)
3351 (substring string (match-beginning num) (match-end num))
3352 (buffer-substring (match-beginning num) (match-end num)))))
3354 (defun match-string-no-properties (num &optional string)
3355 "Return string of text matched by last search, without text properties.
3356 NUM specifies which parenthesized expression in the last regexp.
3357 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3358 Zero means the entire text matched by the whole regexp or whole string.
3359 STRING should be given if the last search was by `string-match' on STRING.
3360 If STRING is nil, the current buffer should be the same buffer
3361 the search/match was performed in."
3362 (if (match-beginning num)
3364 (substring-no-properties string (match-beginning num)
3366 (buffer-substring-no-properties (match-beginning num)
3370 (defun match-substitute-replacement (replacement
3371 &optional fixedcase literal string subexp)
3372 "Return REPLACEMENT as it will be inserted by `replace-match'.
3373 In other words, all back-references in the form `\\&' and `\\N'
3374 are substituted with actual strings matched by the last search.
3375 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3376 meaning as for `replace-match'."
3377 (let ((match (match-string 0 string)))
3379 (set-match-data (mapcar (lambda (x)
3381 (- x (match-beginning 0))
3384 (replace-match replacement fixedcase literal match subexp))))
3387 (defun looking-back (regexp &optional limit greedy)
3388 "Return non-nil if text before point matches regular expression REGEXP.
3389 Like `looking-at' except matches before point, and is slower.
3390 LIMIT if non-nil speeds up the search by specifying a minimum
3391 starting position, to avoid checking matches that would start
3394 If GREEDY is non-nil, extend the match backwards as far as
3395 possible, stopping when a single additional previous character
3396 cannot be part of a match for REGEXP. When the match is
3397 extended, its starting position is allowed to occur before
3399 (let ((start (point))
3402 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3404 (if (and greedy pos)
3406 (narrow-to-region (point-min) start)
3407 (while (and (> pos (point-min))
3411 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3412 (setq pos (1- pos)))
3415 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3418 (defsubst looking-at-p (regexp)
3420 Same as `looking-at' except this function does not change the match data."
3421 (let ((inhibit-changing-match-data t))
3422 (looking-at regexp)))
3424 (defsubst string-match-p (regexp string &optional start)
3426 Same as `string-match' except this function does not change the match data."
3427 (let ((inhibit-changing-match-data t))
3428 (string-match regexp string start)))
3430 (defun subregexp-context-p (regexp pos &optional start)
3431 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3432 A subregexp context is one where a sub-regexp can appear.
3433 A non-subregexp context is for example within brackets, or within a
3434 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3435 If START is non-nil, it should be a position in REGEXP, smaller
3436 than POS, and known to be in a subregexp context."
3437 ;; Here's one possible implementation, with the great benefit that it
3438 ;; reuses the regexp-matcher's own parser, so it understands all the
3439 ;; details of the syntax. A disadvantage is that it needs to match the
3443 (string-match (substring regexp (or start 0) pos) "")
3446 (not (member (cadr err) '("Unmatched [ or [^"
3448 "Trailing backslash")))))
3449 ;; An alternative implementation:
3450 ;; (defconst re-context-re
3451 ;; (let* ((harmless-ch "[^\\[]")
3452 ;; (harmless-esc "\\\\[^{]")
3453 ;; (class-harmless-ch "[^][]")
3454 ;; (class-lb-harmless "[^]:]")
3455 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3456 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3457 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3459 ;; (concat "\\[^?]?"
3460 ;; "\\(" class-harmless-ch
3461 ;; "\\|" class-lb "\\)*"
3462 ;; "\\[?]")) ; special handling for bare [ at end of re
3463 ;; (braces "\\\\{[0-9,]+\\\\}"))
3464 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3465 ;; "\\|" class "\\|" braces "\\)*\\'"))
3466 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3467 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3472 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3473 "The default value of separators for `split-string'.
3475 A regexp matching strings of whitespace. May be locale-dependent
3476 \(as yet unimplemented). Should not match non-breaking spaces.
3478 Warning: binding this to a different value and using it as default is
3479 likely to have undesired semantics.")
3481 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3482 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3483 ;; expression leads to the equivalent implementation that if SEPARATORS
3484 ;; is defaulted, OMIT-NULLS is treated as t.
3485 (defun split-string (string &optional separators omit-nulls)
3486 "Split STRING into substrings bounded by matches for SEPARATORS.
3488 The beginning and end of STRING, and each match for SEPARATORS, are
3489 splitting points. The substrings matching SEPARATORS are removed, and
3490 the substrings between the splitting points are collected as a list,
3493 If SEPARATORS is non-nil, it should be a regular expression matching text
3494 which separates, but is not part of, the substrings. If nil it defaults to
3495 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3496 OMIT-NULLS is forced to t.
3498 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3499 that for the default value of SEPARATORS leading and trailing whitespace
3500 are effectively trimmed). If nil, all zero-length substrings are retained,
3501 which correctly parses CSV format, for example.
3503 Note that the effect of `(split-string STRING)' is the same as
3504 `(split-string STRING split-string-default-separators t)'. In the rare
3505 case that you wish to retain zero-length substrings when splitting on
3506 whitespace, use `(split-string STRING split-string-default-separators)'.
3508 Modifies the match data; use `save-match-data' if necessary."
3509 (let ((keep-nulls (not (if separators omit-nulls t)))
3510 (rexp (or separators split-string-default-separators))
3514 (while (and (string-match rexp string
3516 (= start (match-beginning 0))
3517 (< start (length string)))
3519 (< start (length string)))
3521 (if (or keep-nulls (< start (match-beginning 0)))
3523 (cons (substring string start (match-beginning 0))
3525 (setq start (match-end 0)))
3526 (if (or keep-nulls (< start (length string)))
3528 (cons (substring string start)
3532 (defun combine-and-quote-strings (strings &optional separator)
3533 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3534 This tries to quote the strings to avoid ambiguity such that
3535 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3536 Only some SEPARATORs will work properly."
3537 (let* ((sep (or separator " "))
3538 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3541 (if (string-match re str)
3542 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3546 (defun split-string-and-unquote (string &optional separator)
3547 "Split the STRING into a list of strings.
3548 It understands Emacs Lisp quoting within STRING, such that
3549 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3550 The SEPARATOR regexp defaults to \"\\s-+\"."
3551 (let ((sep (or separator "\\s-+"))
3552 (i (string-match "\"" string)))
3554 (split-string string sep t) ; no quoting: easy
3555 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3556 (let ((rfs (read-from-string string i)))
3558 (split-string-and-unquote (substring string (cdr rfs))
3562 ;;;; Replacement in strings.
3564 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3565 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3566 Unless optional argument INPLACE is non-nil, return a new string."
3567 (let ((i (length string))
3568 (newstr (if inplace string (copy-sequence string))))
3571 (if (eq (aref newstr i) fromchar)
3572 (aset newstr i tochar)))
3575 (defun replace-regexp-in-string (regexp rep string &optional
3576 fixedcase literal subexp start)
3577 "Replace all matches for REGEXP with REP in STRING.
3579 Return a new string containing the replacements.
3581 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3582 arguments with the same names of function `replace-match'. If START
3583 is non-nil, start replacements at that index in STRING.
3585 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3586 function. If it is a function, it is called with the actual text of each
3587 match, and its value is used as the replacement text. When REP is called,
3588 the match data are the result of matching REGEXP against a substring
3591 To replace only the first match (if any), make REGEXP match up to \\'
3592 and replace a sub-expression, e.g.
3593 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3596 ;; To avoid excessive consing from multiple matches in long strings,
3597 ;; don't just call `replace-match' continually. Walk down the
3598 ;; string looking for matches of REGEXP and building up a (reversed)
3599 ;; list MATCHES. This comprises segments of STRING which weren't
3600 ;; matched interspersed with replacements for segments that were.
3601 ;; [For a `large' number of replacements it's more efficient to
3602 ;; operate in a temporary buffer; we can't tell from the function's
3603 ;; args whether to choose the buffer-based implementation, though it
3604 ;; might be reasonable to do so for long enough STRING.]
3605 (let ((l (length string))
3606 (start (or start 0))
3609 (while (and (< start l) (string-match regexp string start))
3610 (setq mb (match-beginning 0)
3612 ;; If we matched the empty string, make sure we advance by one char
3613 (when (= me mb) (setq me (min l (1+ mb))))
3614 ;; Generate a replacement for the matched substring.
3615 ;; Operate only on the substring to minimize string consing.
3616 ;; Set up match data for the substring for replacement;
3617 ;; presumably this is likely to be faster than munging the
3618 ;; match data directly in Lisp.
3619 (string-match regexp (setq str (substring string mb me)))
3621 (cons (replace-match (if (stringp rep)
3623 (funcall rep (match-string 0 str)))
3624 fixedcase literal str subexp)
3625 (cons (substring string start mb) ; unmatched prefix
3628 ;; Reconstruct a string from the pieces.
3629 (setq matches (cons (substring string start l) matches)) ; leftover
3630 (apply #'concat (nreverse matches)))))
3632 (defun string-prefix-p (str1 str2 &optional ignore-case)
3633 "Return non-nil if STR1 is a prefix of STR2.
3634 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3635 to case differences."
3636 (eq t (compare-strings str1 nil nil
3637 str2 0 (length str1) ignore-case)))
3639 (defun bidi-string-mark-left-to-right (str)
3640 "Return a string that can be safely inserted in left-to-right text.
3642 Normally, inserting a string with right-to-left (RTL) script into
3643 a buffer may cause some subsequent text to be displayed as part
3644 of the RTL segment (usually this affects punctuation characters).
3645 This function returns a string which displays as STR but forces
3646 subsequent text to be displayed as left-to-right.
3648 If STR contains any RTL character, this function returns a string
3649 consisting of STR followed by an invisible left-to-right mark
3650 \(LRM) character. Otherwise, it returns STR."
3651 (unless (stringp str)
3652 (signal 'wrong-type-argument (list 'stringp str)))
3653 (if (string-match "\\cR" str)
3654 (concat str (propertize (string ?\x200e) 'invisible t))
3657 ;;;; invisibility specs
3659 (defun add-to-invisibility-spec (element)
3660 "Add ELEMENT to `buffer-invisibility-spec'.
3661 See documentation for `buffer-invisibility-spec' for the kind of elements
3663 (if (eq buffer-invisibility-spec t)
3664 (setq buffer-invisibility-spec (list t)))
3665 (setq buffer-invisibility-spec
3666 (cons element buffer-invisibility-spec)))
3668 (defun remove-from-invisibility-spec (element)
3669 "Remove ELEMENT from `buffer-invisibility-spec'."
3670 (if (consp buffer-invisibility-spec)
3671 (setq buffer-invisibility-spec
3672 (delete element buffer-invisibility-spec))))
3676 (defmacro with-syntax-table (table &rest body)
3677 "Evaluate BODY with syntax table of current buffer set to TABLE.
3678 The syntax table of the current buffer is saved, BODY is evaluated, and the
3679 saved table is restored, even in case of an abnormal exit.
3680 Value is what BODY returns."
3681 (declare (debug t) (indent 1))
3682 (let ((old-table (make-symbol "table"))
3683 (old-buffer (make-symbol "buffer")))
3684 `(let ((,old-table (syntax-table))
3685 (,old-buffer (current-buffer)))
3688 (set-syntax-table ,table)
3690 (save-current-buffer
3691 (set-buffer ,old-buffer)
3692 (set-syntax-table ,old-table))))))
3694 (defun make-syntax-table (&optional oldtable)
3695 "Return a new syntax table.
3696 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3697 from `standard-syntax-table' otherwise."
3698 (let ((table (make-char-table 'syntax-table nil)))
3699 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3702 (defun syntax-after (pos)
3703 "Return the raw syntax of the char after POS.
3704 If POS is outside the buffer's accessible portion, return nil."
3705 (unless (or (< pos (point-min)) (>= pos (point-max)))
3706 (let ((st (if parse-sexp-lookup-properties
3707 (get-char-property pos 'syntax-table))))
3709 (aref (or st (syntax-table)) (char-after pos))))))
3711 (defun syntax-class (syntax)
3712 "Return the syntax class part of the syntax descriptor SYNTAX.
3713 If SYNTAX is nil, return nil."
3714 (and syntax (logand (car syntax) 65535)))
3718 (defun text-clone-maintain (ol1 after beg end &optional _len)
3719 "Propagate the changes made under the overlay OL1 to the other clones.
3720 This is used on the `modification-hooks' property of text clones."
3721 (when (and after (not undo-in-progress) (overlay-start ol1))
3722 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3723 (setq beg (max beg (+ (overlay-start ol1) margin)))
3724 (setq end (min end (- (overlay-end ol1) margin)))
3727 (when (overlay-get ol1 'text-clone-syntax)
3728 ;; Check content of the clone's text.
3729 (let ((cbeg (+ (overlay-start ol1) margin))
3730 (cend (- (overlay-end ol1) margin)))
3733 (if (not (re-search-forward
3734 (overlay-get ol1 'text-clone-syntax) cend t))
3735 ;; Mark the overlay for deletion.
3736 (overlay-put ol1 'text-clones nil)
3737 (when (< (match-end 0) cend)
3738 ;; Shrink the clone at its end.
3739 (setq end (min end (match-end 0)))
3740 (move-overlay ol1 (overlay-start ol1)
3741 (+ (match-end 0) margin)))
3742 (when (> (match-beginning 0) cbeg)
3743 ;; Shrink the clone at its beginning.
3744 (setq beg (max (match-beginning 0) beg))
3745 (move-overlay ol1 (- (match-beginning 0) margin)
3746 (overlay-end ol1)))))))
3747 ;; Now go ahead and update the clones.
3748 (let ((head (- beg (overlay-start ol1)))
3749 (tail (- (overlay-end ol1) end))
3750 (str (buffer-substring beg end))
3752 (inhibit-modification-hooks t))
3753 (dolist (ol2 (overlay-get ol1 'text-clones))
3754 (let ((oe (overlay-end ol2)))
3755 (unless (or (eq ol1 ol2) (null oe))
3756 (setq nothing-left nil)
3757 (let ((mod-beg (+ (overlay-start ol2) head)))
3758 ;;(overlay-put ol2 'modification-hooks nil)
3759 (goto-char (- (overlay-end ol2) tail))
3760 (unless (> mod-beg (point))
3761 (save-excursion (insert str))
3762 (delete-region mod-beg (point)))
3763 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3765 (if nothing-left (delete-overlay ol1))))))))
3767 (defun text-clone-create (start end &optional spreadp syntax)
3768 "Create a text clone of START...END at point.
3769 Text clones are chunks of text that are automatically kept identical:
3770 changes done to one of the clones will be immediately propagated to the other.
3772 The buffer's content at point is assumed to be already identical to
3773 the one between START and END.
3774 If SYNTAX is provided it's a regexp that describes the possible text of
3775 the clones; the clone will be shrunk or killed if necessary to ensure that
3776 its text matches the regexp.
3777 If SPREADP is non-nil it indicates that text inserted before/after the
3778 clone should be incorporated in the clone."
3779 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3780 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3781 ;; (with a one-char margin at each end) with `t nil'.
3782 ;; We opted for a larger overlay because it behaves better in the case
3783 ;; where the clone is reduced to the empty string (we want the overlay to
3784 ;; stay when the clone's content is the empty string and we want to use
3785 ;; `evaporate' to make sure those overlays get deleted when needed).
3787 (let* ((pt-end (+ (point) (- end start)))
3788 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3790 (end-margin (if (or (not spreadp)
3791 (>= pt-end (point-max))
3792 (>= start (point-max)))
3794 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3795 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3796 (dups (list ol1 ol2)))
3797 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3798 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3799 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3800 ;;(overlay-put ol1 'face 'underline)
3801 (overlay-put ol1 'evaporate t)
3802 (overlay-put ol1 'text-clones dups)
3804 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3805 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3806 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3807 ;;(overlay-put ol2 'face 'underline)
3808 (overlay-put ol2 'evaporate t)
3809 (overlay-put ol2 'text-clones dups)))
3811 ;;;; Mail user agents.
3813 ;; Here we include just enough for other packages to be able
3816 (defun define-mail-user-agent (symbol composefunc sendfunc
3817 &optional abortfunc hookvar)
3818 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3820 SYMBOL can be any Lisp symbol. Its function definition and/or
3821 value as a variable do not matter for this usage; we use only certain
3822 properties on its property list, to encode the rest of the arguments.
3824 COMPOSEFUNC is program callable function that composes an outgoing
3825 mail message buffer. This function should set up the basics of the
3826 buffer without requiring user interaction. It should populate the
3827 standard mail headers, leaving the `to:' and `subject:' headers blank
3830 COMPOSEFUNC should accept several optional arguments--the same
3831 arguments that `compose-mail' takes. See that function's documentation.
3833 SENDFUNC is the command a user would run to send the message.
3835 Optional ABORTFUNC is the command a user would run to abort the
3836 message. For mail packages that don't have a separate abort function,
3837 this can be `kill-buffer' (the equivalent of omitting this argument).
3839 Optional HOOKVAR is a hook variable that gets run before the message
3840 is actually sent. Callers that use the `mail-user-agent' may
3841 install a hook function temporarily on this hook variable.
3842 If HOOKVAR is nil, `mail-send-hook' is used.
3844 The properties used on SYMBOL are `composefunc', `sendfunc',
3845 `abortfunc', and `hookvar'."
3846 (put symbol 'composefunc composefunc)
3847 (put symbol 'sendfunc sendfunc)
3848 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3849 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3851 (defun set-temporary-overlay-map (map &optional keep-pred)
3852 (let* ((clearfunsym (make-symbol "clear-temporary-overlay-map"))
3853 (overlaysym (make-symbol "t"))
3854 (alist (list (cons overlaysym map)))
3856 ;; FIXME: Use lexical-binding.
3858 (unless ,(cond ((null keep-pred) nil)
3862 (this-command-keys-vector))))
3863 (t `(funcall ',keep-pred)))
3864 (remove-hook 'pre-command-hook ',clearfunsym)
3865 (setq emulation-mode-map-alists
3866 (delq ',alist emulation-mode-map-alists))))))
3867 (set overlaysym overlaysym)
3868 (fset clearfunsym clearfun)
3869 (add-hook 'pre-command-hook clearfunsym)
3870 ;; FIXME: That's the keymaps with highest precedence, except for
3871 ;; the `keymap' text-property ;-(
3872 (push alist emulation-mode-map-alists)))
3874 ;;;; Progress reporters.
3876 ;; Progress reporter has the following structure:
3878 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3885 ;; This weirdness is for optimization reasons: we want
3886 ;; `progress-reporter-update' to be as fast as possible, so
3887 ;; `(car reporter)' is better than `(aref reporter 0)'.
3889 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3890 ;; digits of precision, it doesn't really matter here. On the other
3891 ;; hand, it greatly simplifies the code.
3893 (defsubst progress-reporter-update (reporter &optional value)
3894 "Report progress of an operation in the echo area.
3895 REPORTER should be the result of a call to `make-progress-reporter'.
3897 If REPORTER is a numerical progress reporter---i.e. if it was
3898 made using non-nil MIN-VALUE and MAX-VALUE arguments to
3899 `make-progress-reporter'---then VALUE should be a number between
3900 MIN-VALUE and MAX-VALUE.
3902 If REPORTER is a non-numerical reporter, VALUE should be nil.
3904 This function is relatively inexpensive. If the change since
3905 last update is too small or insufficient time has passed, it does
3907 (when (or (not (numberp value)) ; For pulsing reporter
3908 (>= value (car reporter))) ; For numerical reporter
3909 (progress-reporter-do-update reporter value)))
3911 (defun make-progress-reporter (message &optional min-value max-value
3912 current-value min-change min-time)
3913 "Return progress reporter object for use with `progress-reporter-update'.
3915 MESSAGE is shown in the echo area, with a status indicator
3916 appended to the end. When you call `progress-reporter-done', the
3917 word \"done\" is printed after the MESSAGE. You can change the
3918 MESSAGE of an existing progress reporter by calling
3919 `progress-reporter-force-update'.
3921 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
3922 and final (100% complete) states of operation; the latter should
3923 be larger. In this case, the status message shows the percentage
3926 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
3927 message shows a \"spinning\", non-numeric indicator.
3929 Optional CURRENT-VALUE is the initial progress; the default is
3931 Optional MIN-CHANGE is the minimal change in percents to report;
3933 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
3934 and/or MAX-VALUE are nil.
3936 Optional MIN-TIME specifies the minimum interval time between
3937 echo area updates (default is 0.2 seconds.) If the function
3938 `float-time' is not present, time is not tracked at all. If the
3939 OS is not capable of measuring fractions of seconds, this
3940 parameter is effectively rounded up."
3941 (when (string-match "[[:alnum:]]\\'" message)
3942 (setq message (concat message "...")))
3944 (setq min-time 0.2))
3946 ;; Force a call to `message' now
3947 (cons (or min-value 0)
3948 (vector (if (and (fboundp 'float-time)
3954 (if min-change (max (min min-change 50) 1) 1)
3956 (progress-reporter-update reporter (or current-value min-value))
3959 (defun progress-reporter-force-update (reporter &optional value new-message)
3960 "Report progress of an operation in the echo area unconditionally.
3962 The first two arguments are the same as in `progress-reporter-update'.
3963 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
3964 (let ((parameters (cdr reporter)))
3966 (aset parameters 3 new-message))
3967 (when (aref parameters 0)
3968 (aset parameters 0 (float-time)))
3969 (progress-reporter-do-update reporter value)))
3971 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
3972 "Characters to use for pulsing progress reporters.")
3974 (defun progress-reporter-do-update (reporter value)
3975 (let* ((parameters (cdr reporter))
3976 (update-time (aref parameters 0))
3977 (min-value (aref parameters 1))
3978 (max-value (aref parameters 2))
3979 (text (aref parameters 3))
3980 (current-time (float-time))
3982 ;; See if enough time has passed since the last update.
3983 (or (not update-time)
3984 (when (>= current-time update-time)
3985 ;; Calculate time for the next update
3986 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3987 (cond ((and min-value max-value)
3988 ;; Numerical indicator
3989 (let* ((one-percent (/ (- max-value min-value) 100.0))
3990 (percentage (if (= max-value min-value)
3992 (truncate (/ (- value min-value)
3994 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
3995 ;; message because not enough time has passed, use 1
3996 ;; instead of MIN-CHANGE. This makes delays between echo
3997 ;; area updates closer to MIN-TIME.
3999 (min (+ min-value (* (+ percentage
4000 (if enough-time-passed
4006 (when (integerp value)
4007 (setcar reporter (ceiling (car reporter))))
4008 ;; Only print message if enough time has passed
4009 (when enough-time-passed
4010 (if (> percentage 0)
4011 (message "%s%d%%" text percentage)
4012 (message "%s" text)))))
4013 ;; Pulsing indicator
4015 (let ((index (mod (1+ (car reporter)) 4))
4016 (message-log-max nil))
4017 (setcar reporter index)
4020 (aref progress-reporter--pulse-characters
4023 (defun progress-reporter-done (reporter)
4024 "Print reporter's message followed by word \"done\" in echo area."
4025 (message "%sdone" (aref (cdr reporter) 3)))
4027 (defmacro dotimes-with-progress-reporter (spec message &rest body)
4028 "Loop a certain number of times and report progress in the echo area.
4029 Evaluate BODY with VAR bound to successive integers running from
4030 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4031 the return value (nil if RESULT is omitted).
4033 At each iteration MESSAGE followed by progress percentage is
4034 printed in the echo area. After the loop is finished, MESSAGE
4035 followed by word \"done\" is printed. This macro is a
4036 convenience wrapper around `make-progress-reporter' and friends.
4038 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4039 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4040 (let ((temp (make-symbol "--dotimes-temp--"))
4041 (temp2 (make-symbol "--dotimes-temp2--"))
4045 (,(car spec) ,start)
4046 (,temp2 (make-progress-reporter ,message ,start ,end)))
4047 (while (< ,(car spec) ,temp)
4049 (progress-reporter-update ,temp2
4050 (setq ,(car spec) (1+ ,(car spec)))))
4051 (progress-reporter-done ,temp2)
4052 nil ,@(cdr (cdr spec)))))
4055 ;;;; Comparing version strings.
4057 (defconst version-separator "."
4058 "Specify the string used to separate the version elements.
4060 Usually the separator is \".\", but it can be any other string.")
4063 (defconst version-regexp-alist
4064 '(("^[-_+ ]?alpha$" . -3)
4065 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
4066 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
4067 ("^[-_+ ]?beta$" . -2)
4068 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
4069 "Specify association between non-numeric version and its priority.
4071 This association is used to handle version string like \"1.0pre2\",
4072 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
4073 non-numeric part of a version string to an integer. For example:
4075 String Version Integer List Version
4076 \"1.0pre2\" (1 0 -1 2)
4077 \"1.0PRE2\" (1 0 -1 2)
4078 \"22.8beta3\" (22 8 -2 3)
4079 \"22.8 Beta3\" (22 8 -2 3)
4080 \"0.9alpha1\" (0 9 -3 1)
4081 \"0.9AlphA1\" (0 9 -3 1)
4082 \"0.9 alpha\" (0 9 -3)
4084 Each element has the following form:
4090 REGEXP regexp used to match non-numeric part of a version string.
4091 It should begin with the `^' anchor and end with a `$' to
4092 prevent false hits. Letter-case is ignored while matching
4095 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
4098 (defun version-to-list (ver)
4099 "Convert version string VER into a list of integers.
4101 The version syntax is given by the following EBNF:
4103 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4105 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4107 SEPARATOR ::= `version-separator' (which see)
4108 | `version-regexp-alist' (which see).
4110 The NUMBER part is optional if SEPARATOR is a match for an element
4111 in `version-regexp-alist'.
4113 Examples of valid version syntax:
4115 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
4117 Examples of invalid version syntax:
4119 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4121 Examples of version conversion:
4123 Version String Version as a List of Integers
4124 \"1.0.7.5\" (1 0 7 5)
4125 \"1.0pre2\" (1 0 -1 2)
4126 \"1.0PRE2\" (1 0 -1 2)
4127 \"22.8beta3\" (22 8 -2 3)
4128 \"22.8Beta3\" (22 8 -2 3)
4129 \"0.9alpha1\" (0 9 -3 1)
4130 \"0.9AlphA1\" (0 9 -3 1)
4131 \"0.9alpha\" (0 9 -3)
4133 See documentation for `version-separator' and `version-regexp-alist'."
4134 (or (and (stringp ver) (> (length ver) 0))
4135 (error "Invalid version string: '%s'" ver))
4136 ;; Change .x.y to 0.x.y
4137 (if (and (>= (length ver) (length version-separator))
4138 (string-equal (substring ver 0 (length version-separator))
4140 (setq ver (concat "0" ver)))
4143 (case-fold-search t) ; ignore case in matching
4145 (while (and (setq s (string-match "[0-9]+" ver i))
4147 ;; handle numeric part
4148 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4151 ;; handle non-numeric part
4152 (when (and (setq s (string-match "[^0-9]+" ver i))
4154 (setq s (substring ver i (match-end 0))
4156 ;; handle alpha, beta, pre, etc. separator
4157 (unless (string= s version-separator)
4158 (setq al version-regexp-alist)
4159 (while (and al (not (string-match (caar al) s)))
4162 (push (cdar al) lst))
4163 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
4164 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4165 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4167 (t (error "Invalid version syntax: '%s'" ver))))))
4169 (error "Invalid version syntax: '%s'" ver)
4173 (defun version-list-< (l1 l2)
4174 "Return t if L1, a list specification of a version, is lower than L2.
4176 Note that a version specified by the list (1) is equal to (1 0),
4177 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4178 Also, a version given by the list (1) is higher than (1 -1), which in
4179 turn is higher than (1 -2), which is higher than (1 -3)."
4180 (while (and l1 l2 (= (car l1) (car l2)))
4184 ;; l1 not null and l2 not null
4185 ((and l1 l2) (< (car l1) (car l2)))
4186 ;; l1 null and l2 null ==> l1 length = l2 length
4187 ((and (null l1) (null l2)) nil)
4188 ;; l1 not null and l2 null ==> l1 length > l2 length
4189 (l1 (< (version-list-not-zero l1) 0))
4190 ;; l1 null and l2 not null ==> l2 length > l1 length
4191 (t (< 0 (version-list-not-zero l2)))))
4194 (defun version-list-= (l1 l2)
4195 "Return t if L1, a list specification of a version, is equal to L2.
4197 Note that a version specified by the list (1) is equal to (1 0),
4198 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4199 Also, a version given by the list (1) is higher than (1 -1), which in
4200 turn is higher than (1 -2), which is higher than (1 -3)."
4201 (while (and l1 l2 (= (car l1) (car l2)))
4205 ;; l1 not null and l2 not null
4207 ;; l1 null and l2 null ==> l1 length = l2 length
4208 ((and (null l1) (null l2)))
4209 ;; l1 not null and l2 null ==> l1 length > l2 length
4210 (l1 (zerop (version-list-not-zero l1)))
4211 ;; l1 null and l2 not null ==> l2 length > l1 length
4212 (t (zerop (version-list-not-zero l2)))))
4215 (defun version-list-<= (l1 l2)
4216 "Return t if L1, a list specification of a version, is lower or equal to L2.
4218 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
4219 etc. That is, the trailing zeroes are insignificant. Also, integer
4220 list (1) is greater than (1 -1) which is greater than (1 -2)
4221 which is greater than (1 -3)."
4222 (while (and l1 l2 (= (car l1) (car l2)))
4226 ;; l1 not null and l2 not null
4227 ((and l1 l2) (< (car l1) (car l2)))
4228 ;; l1 null and l2 null ==> l1 length = l2 length
4229 ((and (null l1) (null l2)))
4230 ;; l1 not null and l2 null ==> l1 length > l2 length
4231 (l1 (<= (version-list-not-zero l1) 0))
4232 ;; l1 null and l2 not null ==> l2 length > l1 length
4233 (t (<= 0 (version-list-not-zero l2)))))
4235 (defun version-list-not-zero (lst)
4236 "Return the first non-zero element of LST, which is a list of integers.
4238 If all LST elements are zeros or LST is nil, return zero."
4239 (while (and lst (zerop (car lst)))
4240 (setq lst (cdr lst)))
4243 ;; there is no element different of zero
4247 (defun version< (v1 v2)
4248 "Return t if version V1 is lower (older) than V2.
4250 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4251 etc. That is, the trailing \".0\"s are insignificant. Also, version
4252 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4253 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4255 (version-list-< (version-to-list v1) (version-to-list v2)))
4258 (defun version<= (v1 v2)
4259 "Return t if version V1 is lower (older) than or equal to V2.
4261 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4262 etc. That is, the trailing \".0\"s are insignificant. Also, version
4263 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4264 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4266 (version-list-<= (version-to-list v1) (version-to-list v2)))
4268 (defun version= (v1 v2)
4269 "Return t if version V1 is equal to V2.
4271 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
4272 etc. That is, the trailing \".0\"s are insignificant. Also, version
4273 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
4274 which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated
4276 (version-list-= (version-to-list v1) (version-to-list v2)))
4280 (defconst menu-bar-separator '("--")
4281 "Separator for menus.")
4283 ;; The following statement ought to be in print.c, but `provide' can't
4285 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
4286 (when (hash-table-p (car (read-from-string
4287 (prin1-to-string (make-hash-table)))))
4288 (provide 'hashtable-print-readable))
4290 ;;; subr.el ends here