1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
29 (defvar custom-declare-variable-list nil
30 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
31 Each element of this list holds the arguments to one call to `defcustom'.")
33 ;; Use this, rather than defcustom, in subr.el and other files loaded
35 (defun custom-declare-variable-early (&rest arguments
)
36 (setq custom-declare-variable-list
37 (cons arguments custom-declare-variable-list
)))
40 ;;;; Basic Lisp macros.
44 (defmacro noreturn
(form)
45 "Evaluate FORM, expecting it not to return.
46 If FORM does return, signal an error."
48 (error "Form marked with `noreturn' did return")))
50 (defmacro 1value
(form)
51 "Evaluate FORM, expecting a constant return value.
52 This is the global do-nothing version. There is also `testcover-1value'
53 that complains if FORM ever does return differing values."
56 (defmacro def-edebug-spec
(symbol spec
)
57 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
58 Both SYMBOL and SPEC are unevaluated. The SPEC can be 0, t, a symbol
59 \(naming a function), or a list."
60 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
62 (defmacro lambda
(&rest cdr
)
63 "Return a lambda expression.
64 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
65 self-quoting; the result of evaluating the lambda expression is the
66 expression itself. The lambda expression may then be treated as a
67 function, i.e., stored as the function value of a symbol, passed to
68 `funcall' or `mapcar', etc.
70 ARGS should take the same form as an argument list for a `defun'.
71 DOCSTRING is an optional documentation string.
72 If present, it should describe how to call the function.
73 But documentation strings are usually not useful in nameless functions.
74 INTERACTIVE should be a call to the function `interactive', which see.
75 It may also be omitted.
76 BODY should be a list of Lisp expressions.
78 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
79 ;; Note that this definition should not use backquotes; subr.el should not
80 ;; depend on backquote.el.
81 (list 'function
(cons 'lambda cdr
)))
83 (defmacro push
(newelt listname
)
84 "Add NEWELT to the list stored in the symbol LISTNAME.
85 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
86 LISTNAME must be a symbol."
87 (declare (debug (form sexp
)))
89 (list 'cons newelt listname
)))
91 (defmacro pop
(listname)
92 "Return the first element of LISTNAME's value, and remove it from the list.
93 LISTNAME must be a symbol whose value is a list.
94 If the value is nil, `pop' returns nil but does not actually
96 (declare (debug (sexp)))
99 (list 'setq listname
(list 'cdr listname
)))))
101 (defmacro when
(cond &rest body
)
102 "If COND yields non-nil, do BODY, else return nil.
103 When COND yields non-nil, eval BODY forms sequentially and return
104 value of last one, or nil if there are none.
107 (declare (indent 1) (debug t
))
108 (list 'if cond
(cons 'progn body
)))
110 (defmacro unless
(cond &rest body
)
111 "If COND yields nil, do BODY, else return nil.
112 When COND yields nil, eval BODY forms sequentially and return
113 value of last one, or nil if there are none.
116 (declare (indent 1) (debug t
))
117 (cons 'if
(cons cond
(cons nil body
))))
119 (defvar --dolist-tail-- nil
120 "Temporary variable used in `dolist' expansion.")
122 (defmacro dolist
(spec &rest body
)
124 Evaluate BODY with VAR bound to each car from LIST, in turn.
125 Then evaluate RESULT to get return value, default nil.
127 \(fn (VAR LIST [RESULT]) BODY...)"
128 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
129 ;; It would be cleaner to create an uninterned symbol,
130 ;; but that uses a lot more space when many functions in many files
132 (let ((temp '--dolist-tail--
))
133 `(let ((,temp
,(nth 1 spec
))
136 (setq ,(car spec
) (car ,temp
))
138 (setq ,temp
(cdr ,temp
)))
139 ,@(if (cdr (cdr spec
))
140 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
)))))))
142 (defvar --dotimes-limit-- nil
143 "Temporary variable used in `dotimes' expansion.")
145 (defmacro dotimes
(spec &rest body
)
146 "Loop a certain number of times.
147 Evaluate BODY with VAR bound to successive integers running from 0,
148 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
149 the return value (nil if RESULT is omitted).
151 \(fn (VAR COUNT [RESULT]) BODY...)"
152 (declare (indent 1) (debug dolist
))
153 ;; It would be cleaner to create an uninterned symbol,
154 ;; but that uses a lot more space when many functions in many files
156 (let ((temp '--dotimes-limit--
)
160 (,(car spec
) ,start
))
161 (while (< ,(car spec
) ,temp
)
163 (setq ,(car spec
) (1+ ,(car spec
))))
164 ,@(cdr (cdr spec
)))))
166 (defmacro declare
(&rest specs
)
167 "Do not evaluate any arguments and return nil.
168 Treated as a declaration when used at the right place in a
169 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
172 ;;;; Basic Lisp functions.
174 (defun ignore (&rest ignore
)
175 "Do nothing and return nil.
176 This function accepts any number of arguments, but ignores them."
180 (defun error (&rest args
)
181 "Signal an error, making error message by passing all args to `format'.
182 In Emacs, the convention is that error messages start with a capital
183 letter but *do not* end with a period. Please follow this convention
184 for the sake of consistency."
186 (signal 'error
(list (apply 'format args
)))))
188 ;; We put this here instead of in frame.el so that it's defined even on
189 ;; systems where frame.el isn't loaded.
190 (defun frame-configuration-p (object)
191 "Return non-nil if OBJECT seems to be a frame configuration.
192 Any list whose car is `frame-configuration' is assumed to be a frame
195 (eq (car object
) 'frame-configuration
)))
197 (defun functionp (object)
198 "Non-nil if OBJECT is any kind of function or a special form.
199 Also non-nil if OBJECT is a symbol and its function definition is
200 \(recursively) a function or special form. This does not include
202 (or (and (symbolp object
) (fboundp object
)
204 (setq object
(indirect-function object
))
206 (eq (car-safe object
) 'autoload
)
207 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object
)))))))
208 (subrp object
) (byte-code-function-p object
)
209 (eq (car-safe object
) 'lambda
)))
214 "Return the car of the car of X."
218 "Return the car of the cdr of X."
222 "Return the cdr of the car of X."
226 "Return the cdr of the cdr of X."
229 (defun last (list &optional n
)
230 "Return the last link of LIST. Its car is the last element.
231 If LIST is nil, return nil.
232 If N is non-nil, return the Nth-to-last link of LIST.
233 If N is bigger than the length of LIST, return LIST."
235 (let ((m 0) (p list
))
237 (setq m
(1+ m
) p
(cdr p
)))
239 (if (< n m
) (nthcdr (- m n
) list
) list
)))
240 (while (consp (cdr list
))
241 (setq list
(cdr list
)))
244 (defun butlast (list &optional n
)
245 "Return a copy of LIST with the last N elements removed."
246 (if (and n
(<= n
0)) list
247 (nbutlast (copy-sequence list
) n
)))
249 (defun nbutlast (list &optional n
)
250 "Modifies LIST to remove the last N elements."
251 (let ((m (length list
)))
255 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
258 (defun delete-dups (list)
259 "Destructively remove `equal' duplicates from LIST.
260 Store the result in LIST and return it. LIST must be a proper list.
261 Of several `equal' occurrences of an element in LIST, the first
265 (setcdr tail
(delete (car tail
) (cdr tail
)))
266 (setq tail
(cdr tail
))))
269 (defun number-sequence (from &optional to inc
)
270 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
271 INC is the increment used between numbers in the sequence and defaults to 1.
272 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
273 zero. TO is only included if there is an N for which TO = FROM + N * INC.
274 If TO is nil or numerically equal to FROM, return \(FROM).
275 If INC is positive and TO is less than FROM, or INC is negative
276 and TO is larger than FROM, return nil.
277 If INC is zero and TO is neither nil nor numerically equal to
278 FROM, signal an error.
280 This function is primarily designed for integer arguments.
281 Nevertheless, FROM, TO and INC can be integer or float. However,
282 floating point arithmetic is inexact. For instance, depending on
283 the machine, it may quite well happen that
284 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
285 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
286 elements. Thus, if some of the arguments are floats and one wants
287 to make sure that TO is included, one may have to explicitly write
288 TO as \(+ FROM \(* N INC)) or use a variable whose value was
289 computed with this exact expression. Alternatively, you can,
290 of course, also replace TO with a slightly larger value
291 \(or a slightly more negative value if INC is negative)."
292 (if (or (not to
) (= from to
))
294 (or inc
(setq inc
1))
295 (when (zerop inc
) (error "The increment can not be zero"))
296 (let (seq (n 0) (next from
))
299 (setq seq
(cons next seq
)
301 next
(+ from
(* n inc
))))
303 (setq seq
(cons next seq
)
305 next
(+ from
(* n inc
)))))
308 (defun copy-tree (tree &optional vecp
)
309 "Make a copy of TREE.
310 If TREE is a cons cell, this recursively copies both its car and its cdr.
311 Contrast to `copy-sequence', which copies only along the cdrs. With second
312 argument VECP, this copies vectors as well as conses."
316 (let ((newcar (car tree
)))
317 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
318 (setq newcar
(copy-tree (car tree
) vecp
)))
319 (push newcar result
))
320 (setq tree
(cdr tree
)))
321 (nconc (nreverse result
) tree
))
322 (if (and vecp
(vectorp tree
))
323 (let ((i (length (setq tree
(copy-sequence tree
)))))
324 (while (>= (setq i
(1- i
)) 0)
325 (aset tree i
(copy-tree (aref tree i
) vecp
)))
329 ;;;; Various list-search functions.
331 (defun assoc-default (key alist
&optional test default
)
332 "Find object KEY in a pseudo-alist ALIST.
333 ALIST is a list of conses or objects. Each element (or the element's car,
334 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
335 If that is non-nil, the element matches;
336 then `assoc-default' returns the element's cdr, if it is a cons,
337 or DEFAULT if the element is not a cons.
339 If no element matches, the value is nil.
340 If TEST is omitted or nil, `equal' is used."
341 (let (found (tail alist
) value
)
342 (while (and tail
(not found
))
343 (let ((elt (car tail
)))
344 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
345 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
346 (setq tail
(cdr tail
)))
349 (make-obsolete 'assoc-ignore-case
'assoc-string
)
350 (defun assoc-ignore-case (key alist
)
351 "Like `assoc', but ignores differences in case and text representation.
352 KEY must be a string. Upper-case and lower-case letters are treated as equal.
353 Unibyte strings are converted to multibyte for comparison."
354 (assoc-string key alist t
))
356 (make-obsolete 'assoc-ignore-representation
'assoc-string
)
357 (defun assoc-ignore-representation (key alist
)
358 "Like `assoc', but ignores differences in text representation.
359 KEY must be a string.
360 Unibyte strings are converted to multibyte for comparison."
361 (assoc-string key alist nil
))
363 (defun member-ignore-case (elt list
)
364 "Like `member', but ignores differences in case and text representation.
365 ELT must be a string. Upper-case and lower-case letters are treated as equal.
366 Unibyte strings are converted to multibyte for comparison.
367 Non-strings in LIST are ignored."
369 (not (and (stringp (car list
))
370 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
371 (setq list
(cdr list
)))
374 (defun assq-delete-all (key alist
)
375 "Delete from ALIST all elements whose car is `eq' to KEY.
376 Return the modified alist.
377 Elements of ALIST that are not conses are ignored."
378 (while (and (consp (car alist
))
379 (eq (car (car alist
)) key
))
380 (setq alist
(cdr alist
)))
381 (let ((tail alist
) tail-cdr
)
382 (while (setq tail-cdr
(cdr tail
))
383 (if (and (consp (car tail-cdr
))
384 (eq (car (car tail-cdr
)) key
))
385 (setcdr tail
(cdr tail-cdr
))
386 (setq tail tail-cdr
))))
389 (defun rassq-delete-all (value alist
)
390 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
391 Return the modified alist.
392 Elements of ALIST that are not conses are ignored."
393 (while (and (consp (car alist
))
394 (eq (cdr (car alist
)) value
))
395 (setq alist
(cdr alist
)))
396 (let ((tail alist
) tail-cdr
)
397 (while (setq tail-cdr
(cdr tail
))
398 (if (and (consp (car tail-cdr
))
399 (eq (cdr (car tail-cdr
)) value
))
400 (setcdr tail
(cdr tail-cdr
))
401 (setq tail tail-cdr
))))
404 (defun remove (elt seq
)
405 "Return a copy of SEQ with all occurrences of ELT removed.
406 SEQ must be a list, vector, or string. The comparison is done with `equal'."
408 ;; If SEQ isn't a list, there's no need to copy SEQ because
409 ;; `delete' will return a new object.
411 (delete elt
(copy-sequence seq
))))
413 (defun remq (elt list
)
414 "Return LIST with all occurrences of ELT removed.
415 The comparison is done with `eq'. Contrary to `delq', this does not use
416 side-effects, and the argument LIST is not modified."
418 (delq elt
(copy-sequence list
))
424 "Convert KEYS to the internal Emacs key representation.
425 KEYS should be a string constant in the format used for
426 saving keyboard macros (see `edmacro-mode')."
427 (read-kbd-macro keys
))
433 ;; Prevent the \{...} documentation construct
434 ;; from mentioning keys that run this command.
435 (put 'undefined
'suppress-keymap t
)
437 (defun suppress-keymap (map &optional nodigits
)
438 "Make MAP override all normally self-inserting keys to be undefined.
439 Normally, as an exception, digits and minus-sign are set to make prefix args,
440 but optional second arg NODIGITS non-nil treats them like other chars."
441 (define-key map
[remap self-insert-command
] 'undefined
)
444 (define-key map
"-" 'negative-argument
)
445 ;; Make plain numbers do numeric args.
448 (define-key map
(char-to-string loop
) 'digit-argument
)
449 (setq loop
(1+ loop
))))))
451 (defun define-key-after (keymap key definition
&optional after
)
452 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
453 This is like `define-key' except that the binding for KEY is placed
454 just after the binding for the event AFTER, instead of at the beginning
455 of the map. Note that AFTER must be an event type (like KEY), NOT a command
458 If AFTER is t or omitted, the new binding goes at the end of the keymap.
459 AFTER should be a single event type--a symbol or a character, not a sequence.
461 Bindings are always added before any inherited map.
463 The order of bindings in a keymap matters when it is used as a menu."
464 (unless after
(setq after t
))
466 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
468 (if (<= (length key
) 1) (aref key
0)
469 (setq keymap
(lookup-key keymap
471 (butlast (mapcar 'identity key
)))))
472 (aref key
(1- (length key
)))))
473 (let ((tail keymap
) done inserted
)
474 (while (and (not done
) tail
)
475 ;; Delete any earlier bindings for the same key.
476 (if (eq (car-safe (car (cdr tail
))) key
)
477 (setcdr tail
(cdr (cdr tail
))))
478 ;; If we hit an included map, go down that one.
479 (if (keymapp (car tail
)) (setq tail
(car tail
)))
480 ;; When we reach AFTER's binding, insert the new binding after.
481 ;; If we reach an inherited keymap, insert just before that.
482 ;; If we reach the end of this keymap, insert at the end.
483 (if (or (and (eq (car-safe (car tail
)) after
)
485 (eq (car (cdr tail
)) 'keymap
)
488 ;; Stop the scan only if we find a parent keymap.
489 ;; Keep going past the inserted element
490 ;; so we can delete any duplications that come later.
491 (if (eq (car (cdr tail
)) 'keymap
)
493 ;; Don't insert more than once.
495 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
497 (setq tail
(cdr tail
)))))
499 (defun map-keymap-internal (function keymap
&optional sort-first
)
500 "Implement `map-keymap' with sorting.
501 Don't call this function; it is for internal use only."
504 (map-keymap (lambda (a b
) (push (cons a b
) list
))
506 (setq list
(sort list
508 (setq a
(car a
) b
(car b
))
510 (if (integerp b
) (< a b
)
513 ;; string< also accepts symbols.
516 (funcall function
(car p
) (cdr p
))))
517 (map-keymap function keymap
)))
519 (put 'keyboard-translate-table
'char-table-extra-slots
0)
521 (defun keyboard-translate (from to
)
522 "Translate character FROM to TO at a low level.
523 This function creates a `keyboard-translate-table' if necessary
524 and then modifies one entry in it."
525 (or (char-table-p keyboard-translate-table
)
526 (setq keyboard-translate-table
527 (make-char-table 'keyboard-translate-table nil
)))
528 (aset keyboard-translate-table from to
))
530 ;;;; Key binding commands.
532 (defun global-set-key (key command
)
533 "Give KEY a global binding as COMMAND.
534 COMMAND is the command definition to use; usually it is
535 a symbol naming an interactively-callable function.
536 KEY is a key sequence; noninteractively, it is a string or vector
537 of characters or event types, and non-ASCII characters with codes
538 above 127 (such as ISO Latin-1) can be included if you use a vector.
540 Note that if KEY has a local binding in the current buffer,
541 that local binding will continue to shadow any global binding
542 that you make with this function."
543 (interactive "KSet key globally: \nCSet key %s to command: ")
544 (or (vectorp key
) (stringp key
)
545 (signal 'wrong-type-argument
(list 'arrayp key
)))
546 (define-key (current-global-map) key command
))
548 (defun local-set-key (key command
)
549 "Give KEY a local binding as COMMAND.
550 COMMAND is the command definition to use; usually it is
551 a symbol naming an interactively-callable function.
552 KEY is a key sequence; noninteractively, it is a string or vector
553 of characters or event types, and non-ASCII characters with codes
554 above 127 (such as ISO Latin-1) can be included if you use a vector.
556 The binding goes in the current buffer's local map,
557 which in most cases is shared with all other buffers in the same major mode."
558 (interactive "KSet key locally: \nCSet key %s locally to command: ")
559 (let ((map (current-local-map)))
561 (use-local-map (setq map
(make-sparse-keymap))))
562 (or (vectorp key
) (stringp key
)
563 (signal 'wrong-type-argument
(list 'arrayp key
)))
564 (define-key map key command
)))
566 (defun global-unset-key (key)
567 "Remove global binding of KEY.
568 KEY is a string or vector representing a sequence of keystrokes."
569 (interactive "kUnset key globally: ")
570 (global-set-key key nil
))
572 (defun local-unset-key (key)
573 "Remove local binding of KEY.
574 KEY is a string or vector representing a sequence of keystrokes."
575 (interactive "kUnset key locally: ")
576 (if (current-local-map)
577 (local-set-key key nil
))
580 ;;;; substitute-key-definition and its subroutines.
582 (defvar key-substitution-in-progress nil
583 "Used internally by `substitute-key-definition'.")
585 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
586 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
587 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
588 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
589 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
591 If you don't specify OLDMAP, you can usually get the same results
592 in a cleaner way with command remapping, like this:
593 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
594 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
595 ;; Don't document PREFIX in the doc string because we don't want to
596 ;; advertise it. It's meant for recursive calls only. Here's its
599 ;; If optional argument PREFIX is specified, it should be a key
600 ;; prefix, a string. Redefined bindings will then be bound to the
601 ;; original key, with PREFIX added at the front.
602 (or prefix
(setq prefix
""))
603 (let* ((scan (or oldmap keymap
))
604 (prefix1 (vconcat prefix
[nil]))
605 (key-substitution-in-progress
606 (cons scan key-substitution-in-progress)))
607 ;; Scan OLDMAP, finding each char or event-symbol that
608 ;; has any definition, and act on it with hack-key.
611 (aset prefix1 (length prefix) char)
612 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
615 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
616 (let (inner-def skipped menu-item)
617 ;; Find the actual command name within the binding.
618 (if (eq (car-safe defn) 'menu-item)
619 (setq menu-item defn defn (nth 2 defn))
620 ;; Skip past menu-prompt.
621 (while (stringp (car-safe defn))
622 (push (pop defn) skipped))
623 ;; Skip past cached key-equivalence data for menu items.
624 (if (consp (car-safe defn))
625 (setq defn (cdr defn))))
626 (if (or (eq defn olddef)
627 ;; Compare with equal if definition is a key sequence.
628 ;; That is useful for operating on function-key-map.
629 (and (or (stringp defn) (vectorp defn))
630 (equal defn olddef)))
631 (define-key keymap prefix
633 (let ((copy (copy-sequence menu-item)))
634 (setcar (nthcdr 2 copy) newdef)
636 (nconc (nreverse skipped) newdef)))
637 ;; Look past a symbol that names a keymap.
639 (or (indirect-function defn t) defn))
640 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
641 ;; avoid autoloading a keymap. This is mostly done to preserve the
642 ;; original non-autoloading behavior of pre-map-keymap times.
643 (if (and (keymapp inner-def)
644 ;; Avoid recursively scanning
645 ;; where KEYMAP does not have a submap.
646 (let ((elt (lookup-key keymap prefix)))
647 (or (null elt) (natnump elt) (keymapp elt)))
648 ;; Avoid recursively rescanning keymap being scanned.
649 (not (memq inner-def key-substitution-in-progress)))
650 ;; If this one isn't being scanned already, scan it now.
651 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
654 ;;;; The global keymap tree.
656 ;;; global-map, esc-map, and ctl-x-map have their values set up in
657 ;;; keymap.c; we just give them docstrings here.
659 (defvar global-map nil
660 "Default global keymap mapping Emacs keyboard input into commands.
661 The value is a keymap which is usually (but not necessarily) Emacs's
665 "Default keymap for ESC (meta) commands.
666 The normal global definition of the character ESC indirects to this keymap.")
668 (defvar ctl-x-map nil
669 "Default keymap for C-x commands.
670 The normal global definition of the character C-x indirects to this keymap.")
672 (defvar ctl-x-4-map (make-sparse-keymap)
673 "Keymap for subcommands of C-x 4.")
674 (defalias 'ctl-x-4-prefix ctl-x-4-map)
675 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
677 (defvar ctl-x-5-map (make-sparse-keymap)
678 "Keymap for frame commands.")
679 (defalias 'ctl-x-5-prefix ctl-x-5-map)
680 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
683 ;;;; Event manipulation functions.
685 ;; The call to `read' is to ensure that the value is computed at load time
686 ;; and not compiled into the .elc file. The value is negative on most
687 ;; machines, but not on all!
688 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
690 (defun listify-key-sequence (key)
691 "Convert a key sequence to a list of events."
694 (mapcar (function (lambda (c)
696 (logxor c listify-key-sequence-1)
700 (defsubst eventp (obj)
701 "True if the argument is an event object."
702 (or (and (integerp obj)
703 ;; Filter out integers too large to be events.
704 ;; M is the biggest modifier.
705 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
706 (char-valid-p (event-basic-type obj)))
708 (get obj 'event-symbol-elements))
711 (get (car obj) 'event-symbol-elements))))
713 (defun event-modifiers (event)
714 "Return a list of symbols representing the modifier keys in event EVENT.
715 The elements of the list may include `meta', `control',
716 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
718 EVENT may be an event or an event type. If EVENT is a symbol
719 that has never been used in an event that has been read as input
720 in the current Emacs session, then this function can return nil,
721 even when EVENT actually has modifiers."
724 (setq type (car type)))
726 (cdr (get type 'event-symbol-elements))
728 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
729 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
730 (if (not (zerop (logand type ?\M-\^@)))
732 (if (or (not (zerop (logand type ?\C-\^@)))
734 (push 'control list))
735 (if (or (not (zerop (logand type ?\S-\^@)))
736 (/= char (downcase char)))
738 (or (zerop (logand type ?\H-\^@))
740 (or (zerop (logand type ?\s-\^@))
742 (or (zerop (logand type ?\A-\^@))
746 (defun event-basic-type (event)
747 "Return the basic type of the given event (all modifiers removed).
748 The value is a printing character (not upper case) or a symbol.
749 EVENT may be an event or an event type. If EVENT is a symbol
750 that has never been used in an event that has been read as input
751 in the current Emacs session, then this function may return nil."
753 (setq event (car event)))
755 (car (get event 'event-symbol-elements))
756 (let* ((base (logand event (1- ?\A-\^@)))
757 (uncontrolled (if (< base 32) (logior base 64) base)))
758 ;; There are some numbers that are invalid characters and
759 ;; cause `downcase' to get an error.
761 (downcase uncontrolled)
762 (error uncontrolled)))))
764 (defsubst mouse-movement-p (object)
765 "Return non-nil if OBJECT is a mouse movement event."
766 (eq (car-safe object) 'mouse-movement))
768 (defsubst event-start (event)
769 "Return the starting position of EVENT.
770 If EVENT is a mouse or key press or a mouse click, this returns the location
772 If EVENT is a drag, this returns the drag's starting position.
773 The return value is of the form
774 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
775 IMAGE (DX . DY) (WIDTH . HEIGHT))
776 The `posn-' functions access elements of such lists."
777 (if (consp event) (nth 1 event)
778 (list (selected-window) (point) '(0 . 0) 0)))
780 (defsubst event-end (event)
781 "Return the ending location of EVENT.
782 EVENT should be a click, drag, or key press event.
783 If EVENT is a click event, this function is the same as `event-start'.
784 The return value is of the form
785 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
786 IMAGE (DX . DY) (WIDTH . HEIGHT))
787 The `posn-' functions access elements of such lists."
788 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
789 (list (selected-window) (point) '(0 . 0) 0)))
791 (defsubst event-click-count (event)
792 "Return the multi-click count of EVENT, a click or drag event.
793 The return value is a positive integer."
794 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
796 ;;;; Extracting fields of the positions in an event.
798 (defsubst posn-window (position)
799 "Return the window in POSITION.
800 POSITION should be a list of the form returned by the `event-start'
801 and `event-end' functions."
804 (defsubst posn-area (position)
805 "Return the window area recorded in POSITION, or nil for the text area.
806 POSITION should be a list of the form returned by the `event-start'
807 and `event-end' functions."
808 (let ((area (if (consp (nth 1 position))
809 (car (nth 1 position))
811 (and (symbolp area) area)))
813 (defsubst posn-point (position)
814 "Return the buffer location in POSITION.
815 POSITION should be a list of the form returned by the `event-start'
816 and `event-end' functions."
818 (if (consp (nth 1 position))
819 (car (nth 1 position))
822 (defun posn-set-point (position)
823 "Move point to POSITION.
824 Select the corresponding window as well."
825 (if (not (windowp (posn-window position)))
826 (error "Position not in text area of window"))
827 (select-window (posn-window position))
828 (if (numberp (posn-point position))
829 (goto-char (posn-point position))))
831 (defsubst posn-x-y (position)
832 "Return the x and y coordinates in POSITION.
833 POSITION should be a list of the form returned by the `event-start'
834 and `event-end' functions."
837 (defun posn-col-row (position)
838 "Return the nominal column and row in POSITION, measured in characters.
839 The column and row values are approximations calculated from the x
840 and y coordinates in POSITION and the frame's default character width
842 For a scroll-bar event, the result column is 0, and the row
843 corresponds to the vertical position of the click in the scroll bar.
844 POSITION should be a list of the form returned by the `event-start'
845 and `event-end' functions."
846 (let* ((pair (posn-x-y position))
847 (window (posn-window position))
848 (area (posn-area position)))
852 ((eq area 'vertical-scroll-bar)
853 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
854 ((eq area 'horizontal-scroll-bar)
855 (cons (scroll-bar-scale pair (window-width window)) 0))
857 (let* ((frame (if (framep window) window (window-frame window)))
858 (x (/ (car pair) (frame-char-width frame)))
859 (y (/ (cdr pair) (+ (frame-char-height frame)
860 (or (frame-parameter frame 'line-spacing)
865 (defun posn-actual-col-row (position)
866 "Return the actual column and row in POSITION, measured in characters.
867 These are the actual row number in the window and character number in that row.
868 Return nil if POSITION does not contain the actual position; in that case
869 `posn-col-row' can be used to get approximate values.
870 POSITION should be a list of the form returned by the `event-start'
871 and `event-end' functions."
874 (defsubst posn-timestamp (position)
875 "Return the timestamp of POSITION.
876 POSITION should be a list of the form returned by the `event-start'
877 and `event-end' functions."
880 (defsubst posn-string (position)
881 "Return the string object of POSITION.
882 Value is a cons (STRING . STRING-POS), or nil if not a string.
883 POSITION should be a list of the form returned by the `event-start'
884 and `event-end' functions."
887 (defsubst posn-image (position)
888 "Return the image object of POSITION.
889 Value is a list (image ...), or nil if not an image.
890 POSITION should be a list of the form returned by the `event-start'
891 and `event-end' functions."
894 (defsubst posn-object (position)
895 "Return the object (image or string) of POSITION.
896 Value is a list (image ...) for an image object, a cons cell
897 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
898 POSITION should be a list of the form returned by the `event-start'
899 and `event-end' functions."
900 (or (posn-image position) (posn-string position)))
902 (defsubst posn-object-x-y (position)
903 "Return the x and y coordinates relative to the object of POSITION.
904 POSITION should be a list of the form returned by the `event-start'
905 and `event-end' functions."
908 (defsubst posn-object-width-height (position)
909 "Return the pixel width and height of the object of POSITION.
910 POSITION should be a list of the form returned by the `event-start'
911 and `event-end' functions."
915 ;;;; Obsolescent names for functions.
917 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
918 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
919 (define-obsolete-function-alias 'read-input 'read-string "22.1")
920 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
921 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
922 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
924 (make-obsolete 'char-bytes "now always returns 1." "20.4")
926 (defun insert-string (&rest args)
927 "Mocklisp-compatibility insert function.
928 Like the function `insert' except that any argument that is a number
929 is converted into a string by expressing it in decimal."
931 (insert (if (integerp el) (number-to-string el) el))))
932 (make-obsolete 'insert-string 'insert "22.1")
934 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
935 (make-obsolete 'makehash 'make-hash-table "22.1")
937 ;; Some programs still use this as a function.
939 "Return the value of the `baud-rate' variable."
941 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
943 ;; These are used by VM and some old programs
944 (defalias 'focus-frame 'ignore "")
945 (make-obsolete 'focus-frame "it does nothing." "22.1")
946 (defalias 'unfocus-frame 'ignore "")
947 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
948 (make-obsolete 'make-variable-frame-local "use a frame-parameter instead" "22.2")
950 ;;;; Obsolescence declarations for variables, and aliases.
952 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
953 (make-obsolete-variable
954 'mode-line-inverse-video
955 "use the appropriate faces instead."
957 (make-obsolete-variable
959 "use `unread-command-events' instead. That variable is a list of events
960 to reread, so it now uses nil to mean `no event', instead of -1."
963 ;; Lisp manual only updated in 22.1.
964 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
967 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
968 (make-obsolete-variable 'x-lost-selection-hooks
969 'x-lost-selection-functions "22.1")
970 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
971 (make-obsolete-variable 'x-sent-selection-hooks
972 'x-sent-selection-functions "22.1")
974 (defvaralias 'messages-buffer-max-lines 'message-log-max)
976 ;;;; Alternate names for functions - these are not being phased out.
978 (defalias 'send-string 'process-send-string)
979 (defalias 'send-region 'process-send-region)
980 (defalias 'string= 'string-equal)
981 (defalias 'string< 'string-lessp)
982 (defalias 'move-marker 'set-marker)
983 (defalias 'rplaca 'setcar)
984 (defalias 'rplacd 'setcdr)
985 (defalias 'beep 'ding) ;preserve lingual purity
986 (defalias 'indent-to-column 'indent-to)
987 (defalias 'backward-delete-char 'delete-backward-char)
988 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
989 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
990 (defalias 'int-to-string 'number-to-string)
991 (defalias 'store-match-data 'set-match-data)
992 ;; These are the XEmacs names:
993 (defalias 'point-at-eol 'line-end-position)
994 (defalias 'point-at-bol 'line-beginning-position)
996 (defalias 'user-original-login-name 'user-login-name)
999 ;;;; Hook manipulation functions.
1001 (defun make-local-hook (hook)
1002 "Make the hook HOOK local to the current buffer.
1003 The return value is HOOK.
1005 You never need to call this function now that `add-hook' does it for you
1006 if its LOCAL argument is non-nil.
1008 When a hook is local, its local and global values
1009 work in concert: running the hook actually runs all the hook
1010 functions listed in *either* the local value *or* the global value
1011 of the hook variable.
1013 This function works by making t a member of the buffer-local value,
1014 which acts as a flag to run the hook functions in the default value as
1015 well. This works for all normal hooks, but does not work for most
1016 non-normal hooks yet. We will be changing the callers of non-normal
1017 hooks so that they can handle localness; this has to be done one by
1020 This function does nothing if HOOK is already local in the current
1023 Do not use `make-local-variable' to make a hook variable buffer-local."
1024 (if (local-variable-p hook)
1026 (or (boundp hook) (set hook nil))
1027 (make-local-variable hook)
1028 (set hook (list t)))
1030 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1032 (defun add-hook (hook function &optional append local)
1033 "Add to the value of HOOK the function FUNCTION.
1034 FUNCTION is not added if already present.
1035 FUNCTION is added (if necessary) at the beginning of the hook list
1036 unless the optional argument APPEND is non-nil, in which case
1037 FUNCTION is added at the end.
1039 The optional fourth argument, LOCAL, if non-nil, says to modify
1040 the hook's buffer-local value rather than its default value.
1041 This makes the hook buffer-local if needed, and it makes t a member
1042 of the buffer-local value. That acts as a flag to run the hook
1043 functions in the default value as well as in the local value.
1045 HOOK should be a symbol, and FUNCTION may be any valid function. If
1046 HOOK is void, it is first set to nil. If HOOK's value is a single
1047 function, it is changed to a list of functions."
1048 (or (boundp hook) (set hook nil))
1049 (or (default-boundp hook) (set-default hook nil))
1050 (if local (unless (local-variable-if-set-p hook)
1051 (set (make-local-variable hook) (list t)))
1052 ;; Detect the case where make-local-variable was used on a hook
1053 ;; and do what we used to do.
1054 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1056 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1057 ;; If the hook value is a single function, turn it into a list.
1058 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1059 (setq hook-value (list hook-value)))
1060 ;; Do the actual addition if necessary
1061 (unless (member function hook-value)
1064 (append hook-value (list function))
1065 (cons function hook-value))))
1066 ;; Set the actual variable
1067 (if local (set hook hook-value) (set-default hook hook-value))))
1069 (defun remove-hook (hook function &optional local)
1070 "Remove from the value of HOOK the function FUNCTION.
1071 HOOK should be a symbol, and FUNCTION may be any valid function. If
1072 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1073 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1075 The optional third argument, LOCAL, if non-nil, says to modify
1076 the hook's buffer-local value rather than its default value."
1077 (or (boundp hook) (set hook nil))
1078 (or (default-boundp hook) (set-default hook nil))
1079 ;; Do nothing if LOCAL is t but this hook has no local binding.
1080 (unless (and local (not (local-variable-p hook)))
1081 ;; Detect the case where make-local-variable was used on a hook
1082 ;; and do what we used to do.
1083 (when (and (local-variable-p hook)
1084 (not (and (consp (symbol-value hook))
1085 (memq t (symbol-value hook)))))
1087 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1088 ;; Remove the function, for both the list and the non-list cases.
1089 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1090 (if (equal hook-value function) (setq hook-value nil))
1091 (setq hook-value (delete function (copy-sequence hook-value))))
1092 ;; If the function is on the global hook, we need to shadow it locally
1093 ;;(when (and local (member function (default-value hook))
1094 ;; (not (member (cons 'not function) hook-value)))
1095 ;; (push (cons 'not function) hook-value))
1096 ;; Set the actual variable
1098 (set-default hook hook-value)
1099 (if (equal hook-value '(t))
1100 (kill-local-variable hook)
1101 (set hook hook-value))))))
1103 (defun add-to-list (list-var element &optional append compare-fn)
1104 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1105 The test for presence of ELEMENT is done with `equal',
1106 or with COMPARE-FN if that's non-nil.
1107 If ELEMENT is added, it is added at the beginning of the list,
1108 unless the optional argument APPEND is non-nil, in which case
1109 ELEMENT is added at the end.
1111 The return value is the new value of LIST-VAR.
1113 If you want to use `add-to-list' on a variable that is not defined
1114 until a certain package is loaded, you should put the call to `add-to-list'
1115 into a hook function that will be run only after loading the package.
1116 `eval-after-load' provides one way to do this. In some cases
1117 other hooks, such as major mode hooks, can do the job."
1120 (member element (symbol-value list-var)))
1121 ((eq compare-fn 'eq)
1122 (memq element (symbol-value list-var)))
1123 ((eq compare-fn 'eql)
1124 (memql element (symbol-value list-var)))
1126 (let ((lst (symbol-value list-var)))
1128 (not (funcall compare-fn element (car lst))))
1129 (setq lst (cdr lst)))
1131 (symbol-value list-var)
1134 (append (symbol-value list-var) (list element))
1135 (cons element (symbol-value list-var))))))
1138 (defun add-to-ordered-list (list-var element &optional order)
1139 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1140 The test for presence of ELEMENT is done with `eq'.
1142 The resulting list is reordered so that the elements are in the
1143 order given by each element's numeric list order. Elements
1144 without a numeric list order are placed at the end of the list.
1146 If the third optional argument ORDER is a number (integer or
1147 float), set the element's list order to the given value. If
1148 ORDER is nil or omitted, do not change the numeric order of
1149 ELEMENT. If ORDER has any other value, remove the numeric order
1150 of ELEMENT if it has one.
1152 The list order for each element is stored in LIST-VAR's
1153 `list-order' property.
1155 The return value is the new value of LIST-VAR."
1156 (let ((ordering (get list-var 'list-order)))
1158 (put list-var 'list-order
1159 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1161 (puthash element (and (numberp order) order) ordering))
1162 (unless (memq element (symbol-value list-var))
1163 (set list-var (cons element (symbol-value list-var))))
1164 (set list-var (sort (symbol-value list-var)
1166 (let ((oa (gethash a ordering))
1167 (ob (gethash b ordering)))
1172 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1173 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1174 Return the new history list.
1175 If MAXELT is non-nil, it specifies the maximum length of the history.
1176 Otherwise, the maximum history length is the value of the `history-length'
1177 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1179 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1180 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1181 if it is empty or a duplicate."
1183 (setq maxelt (or (get history-var 'history-length)
1185 (let ((history (symbol-value history-var))
1187 (when (and (listp history)
1189 (not (stringp newelt))
1190 (> (length newelt) 0))
1192 (not (equal (car history) newelt))))
1193 (if history-delete-duplicates
1194 (delete newelt history))
1195 (setq history (cons newelt history))
1196 (when (integerp maxelt)
1199 (setq tail (nthcdr (1- maxelt) history))
1201 (setcdr tail nil)))))
1202 (set history-var history)))
1207 (defvar delay-mode-hooks nil
1208 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1209 (defvar delayed-mode-hooks nil
1210 "List of delayed mode hooks waiting to be run.")
1211 (make-variable-buffer-local 'delayed-mode-hooks)
1212 (put 'delay-mode-hooks 'permanent-local t)
1214 (defvar after-change-major-mode-hook nil
1215 "Normal hook run at the very end of major mode functions.")
1217 (defun run-mode-hooks (&rest hooks)
1218 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1219 Execution is delayed if `delay-mode-hooks' is non-nil.
1220 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1221 after running the mode hooks.
1222 Major mode functions should use this instead of `run-hooks' when running their
1224 (if delay-mode-hooks
1226 (dolist (hook hooks)
1227 (push hook delayed-mode-hooks))
1228 ;; Normal case, just run the hook as before plus any delayed hooks.
1229 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1230 (setq delayed-mode-hooks nil)
1231 (apply 'run-hooks hooks)
1232 (run-hooks 'after-change-major-mode-hook)))
1234 (defmacro delay-mode-hooks (&rest body)
1235 "Execute BODY, but delay any `run-mode-hooks'.
1236 These hooks will be executed by the first following call to
1237 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1238 Only affects hooks run in the current buffer."
1239 (declare (debug t) (indent 0))
1241 (make-local-variable 'delay-mode-hooks)
1242 (let ((delay-mode-hooks t))
1245 ;; PUBLIC: find if the current mode derives from another.
1247 (defun derived-mode-p (&rest modes)
1248 "Non-nil if the current major mode is derived from one of MODES.
1249 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1250 (let ((parent major-mode))
1251 (while (and (not (memq parent modes))
1252 (setq parent (get parent 'derived-mode-parent))))
1257 ;; If a minor mode is not defined with define-minor-mode,
1258 ;; add it here explicitly.
1259 ;; isearch-mode is deliberately excluded, since you should
1260 ;; not call it yourself.
1261 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1262 overwrite-mode view-mode
1264 "List of all minor mode functions.")
1266 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1267 "Register a new minor mode.
1269 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1271 TOGGLE is a symbol which is the name of a buffer-local variable that
1272 is toggled on or off to say whether the minor mode is active or not.
1274 NAME specifies what will appear in the mode line when the minor mode
1275 is active. NAME should be either a string starting with a space, or a
1276 symbol whose value is such a string.
1278 Optional KEYMAP is the keymap for the minor mode that will be added
1279 to `minor-mode-map-alist'.
1281 Optional AFTER specifies that TOGGLE should be added after AFTER
1282 in `minor-mode-alist'.
1284 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1285 It defaults to (and should by convention be) TOGGLE.
1287 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1288 included in the mode-line minor mode menu.
1289 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1290 (unless (memq toggle minor-mode-list)
1291 (push toggle minor-mode-list))
1293 (unless toggle-fun (setq toggle-fun toggle))
1294 (unless (eq toggle-fun toggle)
1295 (put toggle :minor-mode-function toggle-fun))
1296 ;; Add the name to the minor-mode-alist.
1298 (let ((existing (assq toggle minor-mode-alist)))
1300 (setcdr existing (list name))
1301 (let ((tail minor-mode-alist) found)
1302 (while (and tail (not found))
1303 (if (eq after (caar tail))
1305 (setq tail (cdr tail))))
1307 (let ((rest (cdr found)))
1309 (nconc found (list (list toggle name)) rest))
1310 (setq minor-mode-alist (cons (list toggle name)
1311 minor-mode-alist)))))))
1312 ;; Add the toggle to the minor-modes menu if requested.
1313 (when (get toggle :included)
1314 (define-key mode-line-mode-menu
1318 (or (get toggle :menu-tag)
1319 (if (stringp name) name (symbol-name toggle)))
1320 (let ((mode-name (if (symbolp name) (symbol-value name))))
1321 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1322 (concat " (" (match-string 0 mode-name) ")"))))
1324 :button (cons :toggle toggle))))
1326 ;; Add the map to the minor-mode-map-alist.
1328 (let ((existing (assq toggle minor-mode-map-alist)))
1330 (setcdr existing keymap)
1331 (let ((tail minor-mode-map-alist) found)
1332 (while (and tail (not found))
1333 (if (eq after (caar tail))
1335 (setq tail (cdr tail))))
1337 (let ((rest (cdr found)))
1339 (nconc found (list (cons toggle keymap)) rest))
1340 (setq minor-mode-map-alist (cons (cons toggle keymap)
1341 minor-mode-map-alist))))))))
1345 ;; (defvar symbol-file-load-history-loaded nil
1346 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1347 ;; That file records the part of `load-history' for preloaded files,
1348 ;; which is cleared out before dumping to make Emacs smaller.")
1350 ;; (defun load-symbol-file-load-history ()
1351 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1352 ;; That file records the part of `load-history' for preloaded files,
1353 ;; which is cleared out before dumping to make Emacs smaller."
1354 ;; (unless symbol-file-load-history-loaded
1355 ;; (load (expand-file-name
1356 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1357 ;; (if (eq system-type 'ms-dos)
1359 ;; (format "fns-%s.el" emacs-version))
1361 ;; ;; The file name fns-%s.el already has a .el extension.
1363 ;; (setq symbol-file-load-history-loaded t)))
1365 (defun symbol-file (symbol &optional type)
1366 "Return the input source in which SYMBOL was defined.
1367 The value is an absolute file name.
1368 It can also be nil, if the definition is not associated with any file.
1370 If TYPE is nil, then any kind of definition is acceptable.
1371 If TYPE is `defun' or `defvar', that specifies function
1372 definition only or variable definition only.
1373 `defface' specifies a face definition only."
1374 (if (and (or (null type) (eq type 'defun))
1375 (symbolp symbol) (fboundp symbol)
1376 (eq 'autoload (car-safe (symbol-function symbol))))
1377 (nth 1 (symbol-function symbol))
1378 (let ((files load-history)
1382 (if (eq type 'defvar)
1383 ;; Variables are present just as their names.
1384 (member symbol (cdr (car files)))
1385 ;; Other types are represented as (TYPE . NAME).
1386 (member (cons type symbol) (cdr (car files))))
1387 ;; We accept all types, so look for variable def
1388 ;; and then for any other kind.
1389 (or (member symbol (cdr (car files)))
1390 (rassq symbol (cdr (car files)))))
1391 (setq file (car (car files)) files nil))
1392 (setq files (cdr files)))
1396 (defun locate-library (library &optional nosuffix path interactive-call)
1397 "Show the precise file name of Emacs library LIBRARY.
1398 This command searches the directories in `load-path' like `\\[load-library]'
1399 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1400 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1401 to the specified name LIBRARY.
1403 If the optional third arg PATH is specified, that list of directories
1404 is used instead of `load-path'.
1406 When called from a program, the file name is normaly returned as a
1407 string. When run interactively, the argument INTERACTIVE-CALL is t,
1408 and the file name is displayed in the echo area."
1409 (interactive (list (completing-read "Locate library: "
1410 'locate-file-completion
1411 (cons load-path (get-load-suffixes)))
1414 (let ((file (locate-file library
1416 (append (unless nosuffix (get-load-suffixes))
1417 load-file-rep-suffixes))))
1418 (if interactive-call
1420 (message "Library is file %s" (abbreviate-file-name file))
1421 (message "No library %s in search path" library)))
1425 ;;;; Specifying things to do later.
1427 (defmacro eval-at-startup (&rest body)
1428 "Make arrangements to evaluate BODY when Emacs starts up.
1429 If this is run after Emacs startup, evaluate BODY immediately.
1432 This works by adding a function to `before-init-hook'.
1433 That function's doc string says which file created it."
1435 (if command-line-processed
1437 (add-hook 'before-init-hook
1438 '(lambda () ,(concat "From " (or load-file-name "no file"))
1443 (defun load-history-regexp (file)
1444 "Form a regexp to find FILE in `load-history'.
1445 FILE, a string, is described in the function `eval-after-load'."
1446 (if (file-name-absolute-p file)
1447 (setq file (file-truename file)))
1448 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1450 (if (file-name-extension file)
1452 ;; Note: regexp-opt can't be used here, since we need to call
1453 ;; this before Emacs has been fully started. 2006-05-21
1454 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1455 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1458 (defun load-history-filename-element (file-regexp)
1459 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1460 Return nil if there isn't one."
1461 (let* ((loads load-history)
1462 (load-elt (and loads (car loads))))
1465 (or (null (car load-elt))
1466 (not (string-match file-regexp (car load-elt)))))
1467 (setq loads (cdr loads)
1468 load-elt (and loads (car loads)))))
1471 (defun eval-after-load (file form)
1472 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1473 If FILE is already loaded, evaluate FORM right now.
1475 If a matching file is loaded again, FORM will be evaluated again.
1477 If FILE is a string, it may be either an absolute or a relative file
1478 name, and may have an extension \(e.g. \".el\") or may lack one, and
1479 additionally may or may not have an extension denoting a compressed
1480 format \(e.g. \".gz\").
1482 When FILE is absolute, this first converts it to a true name by chasing
1483 symbolic links. Only a file of this name \(see next paragraph regarding
1484 extensions) will trigger the evaluation of FORM. When FILE is relative,
1485 a file whose absolute true name ends in FILE will trigger evaluation.
1487 When FILE lacks an extension, a file name with any extension will trigger
1488 evaluation. Otherwise, its extension must match FILE's. A further
1489 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1492 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1493 is evaluated whenever that feature is `provide'd.
1495 Usually FILE is just a library name like \"font-lock\" or a feature name
1498 This function makes or adds to an entry on `after-load-alist'."
1499 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1500 ;; evaluating it now).
1501 (let* ((regexp-or-feature
1502 (if (stringp file) (load-history-regexp file) file))
1503 (elt (assoc regexp-or-feature after-load-alist)))
1505 (setq elt (list regexp-or-feature))
1506 (push elt after-load-alist))
1507 ;; Add FORM to the element unless it's already there.
1508 (unless (member form (cdr elt))
1509 (nconc elt (list form)))
1511 ;; Is there an already loaded file whose name (or `provide' name)
1513 (if (if (stringp file)
1514 (load-history-filename-element regexp-or-feature)
1518 (defun do-after-load-evaluation (abs-file)
1519 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1520 ABS-FILE, a string, should be the absolute true name of a file just loaded."
1521 (let ((after-load-elts after-load-alist)
1522 a-l-element file-elements file-element form)
1523 (while after-load-elts
1524 (setq a-l-element (car after-load-elts)
1525 after-load-elts (cdr after-load-elts))
1526 (when (and (stringp (car a-l-element))
1527 (string-match (car a-l-element) abs-file))
1528 (while (setq a-l-element (cdr a-l-element)) ; discard the file name
1529 (setq form (car a-l-element))
1532 (defun eval-next-after-load (file)
1533 "Read the following input sexp, and run it whenever FILE is loaded.
1534 This makes or adds to an entry on `after-load-alist'.
1535 FILE should be the name of a library, with no directory name."
1536 (eval-after-load file (read)))
1540 ;; open-network-stream is a wrapper around make-network-process.
1542 (when (featurep 'make-network-process)
1543 (defun open-network-stream (name buffer host service)
1544 "Open a TCP connection for a service to a host.
1545 Returns a subprocess-object to represent the connection.
1546 Input and output work as for subprocesses; `delete-process' closes it.
1548 Args are NAME BUFFER HOST SERVICE.
1549 NAME is name for process. It is modified if necessary to make it unique.
1550 BUFFER is the buffer (or buffer name) to associate with the process.
1551 Process output goes at end of that buffer, unless you specify
1552 an output stream or filter function to handle the output.
1553 BUFFER may be also nil, meaning that this process is not associated
1555 HOST is name of the host to connect to, or its IP address.
1556 SERVICE is name of the service desired, or an integer specifying
1557 a port number to connect to."
1558 (make-network-process :name name :buffer buffer
1559 :host host :service service)))
1564 'process-kill-without-query
1565 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1567 (defun process-kill-without-query (process &optional flag)
1568 "Say no query needed if PROCESS is running when Emacs is exited.
1569 Optional second argument if non-nil says to require a query.
1570 Value is t if a query was formerly required."
1571 (let ((old (process-query-on-exit-flag process)))
1572 (set-process-query-on-exit-flag process nil)
1575 ;; process plist management
1577 (defun process-get (process propname)
1578 "Return the value of PROCESS' PROPNAME property.
1579 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1580 (plist-get (process-plist process) propname))
1582 (defun process-put (process propname value)
1583 "Change PROCESS' PROPNAME property to VALUE.
1584 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1585 (set-process-plist process
1586 (plist-put (process-plist process) propname value)))
1589 ;;;; Input and display facilities.
1591 (defvar read-quoted-char-radix 8
1592 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1593 Legitimate radix values are 8, 10 and 16.")
1595 (custom-declare-variable-early
1596 'read-quoted-char-radix 8
1597 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1598 Legitimate radix values are 8, 10 and 16."
1599 :type '(choice (const 8) (const 10) (const 16))
1600 :group 'editing-basics)
1602 (defun read-quoted-char (&optional prompt)
1603 "Like `read-char', but do not allow quitting.
1604 Also, if the first character read is an octal digit,
1605 we read any number of octal digits and return the
1606 specified character code. Any nondigit terminates the sequence.
1607 If the terminator is RET, it is discarded;
1608 any other terminator is used itself as input.
1610 The optional argument PROMPT specifies a string to use to prompt the user.
1611 The variable `read-quoted-char-radix' controls which radix to use
1613 (let ((message-log-max nil) done (first t) (code 0) char translated)
1615 (let ((inhibit-quit first)
1616 ;; Don't let C-h get the help message--only help function keys.
1619 "Type the special character you want to use,
1620 or the octal character code.
1621 RET terminates the character code and is discarded;
1622 any other non-digit terminates the character code and is then used as input."))
1623 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1624 (if inhibit-quit (setq quit-flag nil)))
1625 ;; Translate TAB key into control-I ASCII character, and so on.
1626 ;; Note: `read-char' does it using the `ascii-character' property.
1627 ;; We could try and use read-key-sequence instead, but then C-q ESC
1628 ;; or C-q C-x might not return immediately since ESC or C-x might be
1629 ;; bound to some prefix in function-key-map or key-translation-map.
1630 (setq translated char)
1631 (let ((translation (lookup-key local-function-key-map (vector char))))
1632 (if (arrayp translation)
1633 (setq translated (aref translation 0))))
1634 (cond ((null translated))
1635 ((not (integerp translated))
1636 (setq unread-command-events (list char)
1638 ((/= (logand translated ?\M-\^@) 0)
1639 ;; Turn a meta-character into a character with the 0200 bit set.
1640 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1642 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1643 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1644 (and prompt (setq prompt (message "%s %c" prompt translated))))
1645 ((and (<= ?a (downcase translated))
1646 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1647 (setq code (+ (* code read-quoted-char-radix)
1648 (+ 10 (- (downcase translated) ?a))))
1649 (and prompt (setq prompt (message "%s %c" prompt translated))))
1650 ((and (not first) (eq translated ?\C-m))
1653 (setq unread-command-events (list char)
1655 (t (setq code translated
1660 (defun read-passwd (prompt &optional confirm default)
1661 "Read a password, prompting with PROMPT, and return it.
1662 If optional CONFIRM is non-nil, read the password twice to make sure.
1663 Optional DEFAULT is a default password to use instead of empty input.
1665 This function echoes `.' for each character that the user types.
1666 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1667 C-g quits; if `inhibit-quit' was non-nil around this function,
1668 then it returns nil if the user types C-g, but quit-flag remains set.
1670 Once the caller uses the password, it can erase the password
1671 by doing (clear-string STRING)."
1675 (while (not success)
1676 (let ((first (read-passwd prompt nil default))
1677 (second (read-passwd "Confirm password: " nil default)))
1678 (if (equal first second)
1680 (and (arrayp second) (clear-string second))
1681 (setq success first))
1682 (and (arrayp first) (clear-string first))
1683 (and (arrayp second) (clear-string second))
1684 (message "Password not repeated accurately; please start over")
1688 ;; Copy it so that add-text-properties won't modify
1689 ;; the object that was passed in by the caller.
1690 (prompt (copy-sequence prompt))
1693 (cursor-in-echo-area t)
1694 (message-log-max nil))
1695 (add-text-properties 0 (length prompt)
1696 minibuffer-prompt-properties prompt)
1697 (while (progn (message "%s%s"
1699 (make-string (length pass) ?.))
1700 (setq c (read-char-exclusive nil t))
1701 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1702 (clear-this-command-keys)
1705 (and (arrayp pass) (clear-string pass))
1707 (if (and (/= c ?\b) (/= c ?\177))
1708 (let* ((new-char (char-to-string c))
1709 (new-pass (concat pass new-char)))
1710 (and (arrayp pass) (clear-string pass))
1711 (clear-string new-char)
1713 (setq pass new-pass))
1714 (if (> (length pass) 0)
1715 (let ((new-pass (substring pass 0 -1)))
1716 (and (arrayp pass) (clear-string pass))
1717 (setq pass new-pass))))))
1719 (or pass default "")))))
1721 ;; This should be used by `call-interactively' for `n' specs.
1722 (defun read-number (prompt &optional default)
1723 "Read a numeric value in the minibuffer, prompting with PROMPT.
1724 DEFAULT specifies a default value to return if the user just types RET.
1725 The value of DEFAULT is inserted into PROMPT."
1729 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1730 (replace-match (format " (default %s)" default) t t prompt 1)
1731 (replace-regexp-in-string "[ \t]*\\'"
1732 (format " (default %s) " default)
1736 (let ((str (read-from-minibuffer prompt nil nil nil nil
1738 (number-to-string default)))))
1741 ((zerop (length str)) default)
1742 ((stringp str) (read str))))
1745 (message "Please enter a number.")
1750 (defun sit-for (seconds &optional nodisp obsolete)
1751 "Perform redisplay, then wait for SECONDS seconds or until input is available.
1752 SECONDS may be a floating-point value.
1753 \(On operating systems that do not support waiting for fractions of a
1754 second, floating-point values are rounded down to the nearest integer.)
1756 If optional arg NODISP is t, don't redisplay, just wait for input.
1757 Redisplay does not happen if input is available before it starts.
1759 Value is t if waited the full time with no input arriving, and nil otherwise.
1761 An obsolete, but still supported form is
1762 \(sit-for SECONDS &optional MILLISECONDS NODISP)
1763 where the optional arg MILLISECONDS specifies an additional wait period,
1764 in milliseconds; this was useful when Emacs was built without
1765 floating point support.
1767 \(fn SECONDS &optional NODISP)"
1768 (when (or obsolete (numberp nodisp))
1769 (setq seconds (+ seconds (* 1e-3 nodisp)))
1770 (setq nodisp obsolete))
1778 (or nodisp (redisplay)))
1780 (or nodisp (redisplay))
1781 (let ((read (read-event nil nil seconds)))
1784 ;; If last command was a prefix arg, e.g. C-u, push this event onto
1785 ;; unread-command-events as (t . EVENT) so it will be added to
1786 ;; this-command-keys by read-key-sequence.
1787 (if (eq overriding-terminal-local-map universal-argument-map)
1788 (setq read (cons t read)))
1789 (push read unread-command-events)
1792 ;;; Atomic change groups.
1794 (defmacro atomic-change-group (&rest body)
1795 "Perform BODY as an atomic change group.
1796 This means that if BODY exits abnormally,
1797 all of its changes to the current buffer are undone.
1798 This works regardless of whether undo is enabled in the buffer.
1800 This mechanism is transparent to ordinary use of undo;
1801 if undo is enabled in the buffer and BODY succeeds, the
1802 user can undo the change normally."
1803 (declare (indent 0) (debug t))
1804 (let ((handle (make-symbol "--change-group-handle--"))
1805 (success (make-symbol "--change-group-success--")))
1806 `(let ((,handle (prepare-change-group))
1810 ;; This is inside the unwind-protect because
1811 ;; it enables undo if that was disabled; we need
1812 ;; to make sure that it gets disabled again.
1813 (activate-change-group ,handle)
1816 ;; Either of these functions will disable undo
1817 ;; if it was disabled before.
1819 (accept-change-group ,handle)
1820 (cancel-change-group ,handle))))))
1822 (defun prepare-change-group (&optional buffer)
1823 "Return a handle for the current buffer's state, for a change group.
1824 If you specify BUFFER, make a handle for BUFFER's state instead.
1826 Pass the handle to `activate-change-group' afterward to initiate
1827 the actual changes of the change group.
1829 To finish the change group, call either `accept-change-group' or
1830 `cancel-change-group' passing the same handle as argument. Call
1831 `accept-change-group' to accept the changes in the group as final;
1832 call `cancel-change-group' to undo them all. You should use
1833 `unwind-protect' to make sure the group is always finished. The call
1834 to `activate-change-group' should be inside the `unwind-protect'.
1835 Once you finish the group, don't use the handle again--don't try to
1836 finish the same group twice. For a simple example of correct use, see
1837 the source code of `atomic-change-group'.
1839 The handle records only the specified buffer. To make a multibuffer
1840 change group, call this function once for each buffer you want to
1841 cover, then use `nconc' to combine the returned values, like this:
1843 (nconc (prepare-change-group buffer-1)
1844 (prepare-change-group buffer-2))
1846 You can then activate that multibuffer change group with a single
1847 call to `activate-change-group' and finish it with a single call
1848 to `accept-change-group' or `cancel-change-group'."
1851 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
1852 (list (cons (current-buffer) buffer-undo-list))))
1854 (defun activate-change-group (handle)
1855 "Activate a change group made with `prepare-change-group' (which see)."
1856 (dolist (elt handle)
1857 (with-current-buffer (car elt)
1858 (if (eq buffer-undo-list t)
1859 (setq buffer-undo-list nil)))))
1861 (defun accept-change-group (handle)
1862 "Finish a change group made with `prepare-change-group' (which see).
1863 This finishes the change group by accepting its changes as final."
1864 (dolist (elt handle)
1865 (with-current-buffer (car elt)
1867 (setq buffer-undo-list t)))))
1869 (defun cancel-change-group (handle)
1870 "Finish a change group made with `prepare-change-group' (which see).
1871 This finishes the change group by reverting all of its changes."
1872 (dolist (elt handle)
1873 (with-current-buffer (car elt)
1874 (setq elt (cdr elt))
1876 (if (consp elt) (car elt)))
1878 (if (consp elt) (cdr elt))))
1879 ;; Temporarily truncate the undo log at ELT.
1881 (setcar elt nil) (setcdr elt nil))
1882 (unless (eq last-command 'undo) (undo-start))
1883 ;; Make sure there's no confusion.
1884 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
1885 (error "Undoing to some unrelated state"))
1887 (while (listp pending-undo-list) (undo-more 1))
1888 ;; Reset the modified cons cell ELT to its original content.
1890 (setcar elt old-car)
1891 (setcdr elt old-cdr))
1892 ;; Revert the undo info to what it was when we grabbed the state.
1893 (setq buffer-undo-list elt)))))
1895 ;;;; Display-related functions.
1897 ;; For compatibility.
1898 (defalias 'redraw-modeline 'force-mode-line-update)
1900 (defun force-mode-line-update (&optional all)
1901 "Force redisplay of the current buffer's mode line and header line.
1902 With optional non-nil ALL, force redisplay of all mode lines and
1903 header lines. This function also forces recomputation of the
1904 menu bar menus and the frame title."
1905 (if all (save-excursion (set-buffer (other-buffer))))
1906 (set-buffer-modified-p (buffer-modified-p)))
1908 (defun momentary-string-display (string pos &optional exit-char message)
1909 "Momentarily display STRING in the buffer at POS.
1910 Display remains until next event is input.
1911 If POS is a marker, only its position is used; its buffer is ignored.
1912 Optional third arg EXIT-CHAR can be a character, event or event
1913 description list. EXIT-CHAR defaults to SPC. If the input is
1914 EXIT-CHAR it is swallowed; otherwise it is then available as
1915 input (as a command if nothing else).
1916 Display MESSAGE (optional fourth arg) in the echo area.
1917 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1918 (or exit-char (setq exit-char ?\s))
1919 (let ((inhibit-read-only t)
1920 ;; Don't modify the undo list at all.
1921 (buffer-undo-list t)
1922 (modified (buffer-modified-p))
1923 (name buffer-file-name)
1929 ;; To avoid trouble with out-of-bounds position
1931 ;; defeat file locking... don't try this at home, kids!
1932 (setq buffer-file-name nil)
1933 (insert-before-markers string)
1934 (setq insert-end (point))
1935 ;; If the message end is off screen, recenter now.
1936 (if (< (window-end nil t) insert-end)
1937 (recenter (/ (window-height) 2)))
1938 ;; If that pushed message start off the screen,
1939 ;; scroll to start it at the top of the screen.
1940 (move-to-window-line 0)
1945 (message (or message "Type %s to continue editing.")
1946 (single-key-description exit-char))
1948 (if (integerp exit-char)
1951 (setq char (read-char))
1952 (or (eq char exit-char)
1953 (setq unread-command-events (list char))))
1955 ;; `exit-char' is a character, hence it differs
1956 ;; from char, which is an event.
1957 (setq unread-command-events (list char))))
1958 ;; `exit-char' can be an event, or an event description
1960 (setq char (read-event))
1961 (or (eq char exit-char)
1962 (eq char (event-convert-list exit-char))
1963 (setq unread-command-events (list char))))))
1966 (delete-region pos insert-end)))
1967 (setq buffer-file-name name)
1968 (set-buffer-modified-p modified))))
1971 ;;;; Overlay operations
1973 (defun copy-overlay (o)
1974 "Return a copy of overlay O."
1975 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1976 ;; FIXME: there's no easy way to find the
1977 ;; insertion-type of the two markers.
1978 (overlay-buffer o)))
1979 (props (overlay-properties o)))
1981 (overlay-put o1 (pop props) (pop props)))
1984 (defun remove-overlays (&optional beg end name val)
1985 "Clear BEG and END of overlays whose property NAME has value VAL.
1986 Overlays might be moved and/or split.
1987 BEG and END default respectively to the beginning and end of buffer."
1988 ;; This speeds up the loops over overlays.
1989 (unless beg (setq beg (point-min)))
1990 (unless end (setq end (point-max)))
1991 (overlay-recenter end)
1993 (setq beg (prog1 end (setq end beg))))
1995 (dolist (o (overlays-in beg end))
1996 (when (eq (overlay-get o name) val)
1997 ;; Either push this overlay outside beg...end
1998 ;; or split it to exclude beg...end
1999 ;; or delete it entirely (if it is contained in beg...end).
2000 (if (< (overlay-start o) beg)
2001 (if (> (overlay-end o) end)
2003 (move-overlay (copy-overlay o)
2004 (overlay-start o) beg)
2005 (move-overlay o end (overlay-end o)))
2006 (move-overlay o (overlay-start o) beg))
2007 (if (> (overlay-end o) end)
2008 (move-overlay o end (overlay-end o))
2009 (delete-overlay o)))))))
2013 (defvar suspend-hook nil
2014 "Normal hook run by `suspend-emacs', before suspending.")
2016 (defvar suspend-resume-hook nil
2017 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2019 (defvar temp-buffer-show-hook nil
2020 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2021 When the hook runs, the temporary buffer is current, and the window it
2022 was displayed in is selected. This hook is normally set up with a
2023 function to make the buffer read only, and find function names and
2024 variable names in it, provided the major mode is still Help mode.")
2026 (defvar temp-buffer-setup-hook nil
2027 "Normal hook run by `with-output-to-temp-buffer' at the start.
2028 When the hook runs, the temporary buffer is current.
2029 This hook is normally set up with a function to put the buffer in Help
2032 ;; Avoid compiler warnings about this variable,
2033 ;; which has a special meaning on certain system types.
2034 (defvar buffer-file-type nil
2035 "Non-nil if the visited file is a binary file.
2036 This variable is meaningful on MS-DOG and Windows NT.
2037 On those systems, it is automatically local in every buffer.
2038 On other systems, this variable is normally always nil.")
2040 ;; The `assert' macro from the cl package signals
2041 ;; `cl-assertion-failed' at runtime so always define it.
2042 (put 'cl-assertion-failed 'error-conditions '(error))
2043 (put 'cl-assertion-failed 'error-message "Assertion failed")
2045 (defconst user-emacs-directory
2046 (if (eq system-type 'ms-dos)
2047 ;; MS-DOS cannot have initial dot.
2050 "Directory beneath which additional per-user Emacs-specific files are placed.
2051 Various programs in Emacs store information in this directory.
2052 Note that this should end with a directory separator.")
2055 ;;;; Misc. useful functions.
2057 (defun find-tag-default ()
2058 "Determine default tag to search for, based on text at point.
2059 If there is no plausible default, return nil."
2061 (while (looking-at "\\sw\\|\\s_")
2063 (if (or (re-search-backward "\\sw\\|\\s_"
2064 (save-excursion (beginning-of-line) (point))
2066 (re-search-forward "\\(\\sw\\|\\s_\\)+"
2067 (save-excursion (end-of-line) (point))
2070 (goto-char (match-end 0))
2072 (buffer-substring-no-properties
2074 (progn (forward-sexp -1)
2075 (while (looking-at "\\s'")
2081 (defun play-sound (sound)
2082 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2083 The following keywords are recognized:
2085 :file FILE - read sound data from FILE. If FILE isn't an
2086 absolute file name, it is searched in `data-directory'.
2088 :data DATA - read sound data from string DATA.
2090 Exactly one of :file or :data must be present.
2092 :volume VOL - set volume to VOL. VOL must an integer in the
2093 range 0..100 or a float in the range 0..1.0. If not specified,
2094 don't change the volume setting of the sound device.
2096 :device DEVICE - play sound on DEVICE. If not specified,
2097 a system-dependent default device name is used."
2098 (if (fboundp 'play-sound-internal)
2099 (play-sound-internal sound)
2100 (error "This Emacs binary lacks sound support")))
2102 (defun shell-quote-argument (argument)
2103 "Quote an argument for passing as argument to an inferior shell."
2104 (if (or (eq system-type 'ms-dos)
2105 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2106 ;; Quote using double quotes, but escape any existing quotes in
2107 ;; the argument with backslashes.
2111 (if (or (null (string-match "[^\"]" argument))
2112 (< (match-end 0) (length argument)))
2113 (while (string-match "[\"]" argument start)
2114 (setq end (match-beginning 0)
2115 result (concat result (substring argument start end)
2116 "\\" (substring argument end (1+ end)))
2118 (concat "\"" result (substring argument start) "\""))
2119 (if (equal argument "")
2121 ;; Quote everything except POSIX filename characters.
2122 ;; This should be safe enough even for really weird shells.
2123 (let ((result "") (start 0) end)
2124 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2125 (setq end (match-beginning 0)
2126 result (concat result (substring argument start end)
2127 "\\" (substring argument end (1+ end)))
2129 (concat result (substring argument start))))))
2131 (defun string-or-null-p (object)
2132 "Return t if OBJECT is a string or nil.
2133 Otherwise, return nil."
2134 (or (stringp object) (null object)))
2136 (defun booleanp (object)
2137 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2138 (memq object '(nil t)))
2140 (defun field-at-pos (pos)
2141 "Return the field at position POS, taking stickiness etc into account"
2142 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2143 (if (eq raw-field 'boundary)
2144 (get-char-property (1- (field-end pos)) 'field)
2148 ;;;; Support for yanking and text properties.
2150 (defvar yank-excluded-properties)
2152 (defun remove-yank-excluded-properties (start end)
2153 "Remove `yank-excluded-properties' between START and END positions.
2154 Replaces `category' properties with their defined properties."
2155 (let ((inhibit-read-only t))
2156 ;; Replace any `category' property with the properties it stands for.
2157 (unless (memq yank-excluded-properties '(t nil))
2160 (while (< (point) end)
2161 (let ((cat (get-text-property (point) 'category))
2164 (next-single-property-change (point) 'category nil end))
2166 (let (run-end2 original)
2167 (remove-list-of-text-properties (point) run-end '(category))
2168 (while (< (point) run-end)
2169 (setq run-end2 (next-property-change (point) nil run-end))
2170 (setq original (text-properties-at (point)))
2171 (set-text-properties (point) run-end2 (symbol-plist cat))
2172 (add-text-properties (point) run-end2 original)
2173 (goto-char run-end2))))
2174 (goto-char run-end)))))
2175 (if (eq yank-excluded-properties t)
2176 (set-text-properties start end nil)
2177 (remove-list-of-text-properties start end yank-excluded-properties))))
2179 (defvar yank-undo-function)
2181 (defun insert-for-yank (string)
2182 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2184 See `insert-for-yank-1' for more details."
2186 (while (setq to (next-single-property-change 0 'yank-handler string))
2187 (insert-for-yank-1 (substring string 0 to))
2188 (setq string (substring string to))))
2189 (insert-for-yank-1 string))
2191 (defun insert-for-yank-1 (string)
2192 "Insert STRING at point, stripping some text properties.
2194 Strip text properties from the inserted text according to
2195 `yank-excluded-properties'. Otherwise just like (insert STRING).
2197 If STRING has a non-nil `yank-handler' property on the first character,
2198 the normal insert behavior is modified in various ways. The value of
2199 the yank-handler property must be a list with one to four elements
2200 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2201 When FUNCTION is present and non-nil, it is called instead of `insert'
2202 to insert the string. FUNCTION takes one argument--the object to insert.
2203 If PARAM is present and non-nil, it replaces STRING as the object
2204 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2205 `yank-rectangle', PARAM may be a list of strings to insert as a
2207 If NOEXCLUDE is present and non-nil, the normal removal of the
2208 yank-excluded-properties is not performed; instead FUNCTION is
2209 responsible for removing those properties. This may be necessary
2210 if FUNCTION adjusts point before or after inserting the object.
2211 If UNDO is present and non-nil, it is a function that will be called
2212 by `yank-pop' to undo the insertion of the current object. It is
2213 called with two arguments, the start and end of the current region.
2214 FUNCTION may set `yank-undo-function' to override the UNDO value."
2215 (let* ((handler (and (stringp string)
2216 (get-text-property 0 'yank-handler string)))
2217 (param (or (nth 1 handler) string))
2219 (inhibit-read-only inhibit-read-only)
2222 (setq yank-undo-function t)
2223 (if (nth 0 handler) ;; FUNCTION
2224 (funcall (car handler) param)
2228 ;; Prevent read-only properties from interfering with the
2229 ;; following text property changes.
2230 (setq inhibit-read-only t)
2232 ;; What should we do with `font-lock-face' properties?
2233 (if font-lock-defaults
2234 ;; No, just wipe them.
2235 (remove-list-of-text-properties opoint end '(font-lock-face))
2236 ;; Convert them to `face'.
2239 (while (< (point) end)
2240 (let ((face (get-text-property (point) 'font-lock-face))
2243 (next-single-property-change (point) 'font-lock-face nil end))
2245 (remove-text-properties (point) run-end '(font-lock-face nil))
2246 (put-text-property (point) run-end 'face face))
2247 (goto-char run-end)))))
2249 (unless (nth 2 handler) ;; NOEXCLUDE
2250 (remove-yank-excluded-properties opoint (point)))
2252 ;; If last inserted char has properties, mark them as rear-nonsticky.
2253 (if (and (> end opoint)
2254 (text-properties-at (1- end)))
2255 (put-text-property (1- end) end 'rear-nonsticky t))
2257 (if (eq yank-undo-function t) ;; not set by FUNCTION
2258 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2259 (if (nth 4 handler) ;; COMMAND
2260 (setq this-command (nth 4 handler)))))
2262 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2263 "Insert before point a substring of BUFFER, without text properties.
2264 BUFFER may be a buffer or a buffer name.
2265 Arguments START and END are character positions specifying the substring.
2266 They default to the values of (point-min) and (point-max) in BUFFER."
2267 (let ((opoint (point)))
2268 (insert-buffer-substring buffer start end)
2269 (let ((inhibit-read-only t))
2270 (set-text-properties opoint (point) nil))))
2272 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2273 "Insert before point a part of BUFFER, stripping some text properties.
2274 BUFFER may be a buffer or a buffer name.
2275 Arguments START and END are character positions specifying the substring.
2276 They default to the values of (point-min) and (point-max) in BUFFER.
2277 Strip text properties from the inserted text according to
2278 `yank-excluded-properties'."
2279 ;; Since the buffer text should not normally have yank-handler properties,
2280 ;; there is no need to handle them here.
2281 (let ((opoint (point)))
2282 (insert-buffer-substring buffer start end)
2283 (remove-yank-excluded-properties opoint (point))))
2286 ;;;; Synchronous shell commands.
2288 (defun start-process-shell-command (name buffer &rest args)
2289 "Start a program in a subprocess. Return the process object for it.
2290 NAME is name for process. It is modified if necessary to make it unique.
2291 BUFFER is the buffer (or buffer name) to associate with the process.
2292 Process output goes at end of that buffer, unless you specify
2293 an output stream or filter function to handle the output.
2294 BUFFER may be also nil, meaning that this process is not associated
2296 COMMAND is the name of a shell command.
2297 Remaining arguments are the arguments for the command; they are all
2298 spliced together with blanks separating between each two of them, before
2299 passing the command to the shell.
2300 Wildcards and redirection are handled as usual in the shell.
2302 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
2304 ((eq system-type 'vax-vms)
2305 (apply 'start-process name buffer args))
2306 ;; We used to use `exec' to replace the shell with the command,
2307 ;; but that failed to handle (...) and semicolon, etc.
2309 (start-process name buffer shell-file-name shell-command-switch
2310 (mapconcat 'identity args " ")))))
2312 (defun start-file-process-shell-command (name buffer &rest args)
2313 "Start a program in a subprocess. Return the process object for it.
2314 Similar to `start-process-shell-command', but calls `start-file-process'."
2317 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2318 (if (file-remote-p default-directory) "-c" shell-command-switch)
2319 (mapconcat 'identity args " ")))
2321 (defun call-process-shell-command (command &optional infile buffer display
2323 "Execute the shell command COMMAND synchronously in separate process.
2324 The remaining arguments are optional.
2325 The program's input comes from file INFILE (nil means `/dev/null').
2326 Insert output in BUFFER before point; t means current buffer;
2327 nil for BUFFER means discard it; 0 means discard and don't wait.
2328 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2329 REAL-BUFFER says what to do with standard output, as above,
2330 while STDERR-FILE says what to do with standard error in the child.
2331 STDERR-FILE may be nil (discard standard error output),
2332 t (mix it with ordinary output), or a file name string.
2334 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2335 Remaining arguments are strings passed as additional arguments for COMMAND.
2336 Wildcards and redirection are handled as usual in the shell.
2338 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2339 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2340 status or a signal description string.
2341 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2343 ((eq system-type 'vax-vms)
2344 (apply 'call-process command infile buffer display args))
2345 ;; We used to use `exec' to replace the shell with the command,
2346 ;; but that failed to handle (...) and semicolon, etc.
2348 (call-process shell-file-name
2349 infile buffer display
2350 shell-command-switch
2351 (mapconcat 'identity (cons command args) " ")))))
2353 (defun process-file-shell-command (command &optional infile buffer display
2355 "Process files synchronously in a separate process.
2356 Similar to `call-process-shell-command', but calls `process-file'."
2358 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2359 infile buffer display
2360 (if (file-remote-p default-directory) "-c" shell-command-switch)
2361 (mapconcat 'identity (cons command args) " ")))
2363 ;;;; Lisp macros to do various things temporarily.
2365 (defmacro with-current-buffer (buffer &rest body)
2366 "Execute the forms in BODY with BUFFER temporarily current.
2367 BUFFER can be a buffer or a buffer name.
2368 The value returned is the value of the last form in BODY.
2369 See also `with-temp-buffer'."
2370 (declare (indent 1) (debug t))
2371 `(save-current-buffer
2372 (set-buffer ,buffer)
2375 (defmacro with-selected-window (window &rest body)
2376 "Execute the forms in BODY with WINDOW as the selected window.
2377 The value returned is the value of the last form in BODY.
2379 This macro saves and restores the current buffer, since otherwise
2380 its normal operation could potentially make a different
2381 buffer current. It does not alter the buffer list ordering.
2383 This macro saves and restores the selected window, as well as
2384 the selected window in each frame. If the previously selected
2385 window of some frame is no longer live at the end of BODY, that
2386 frame's selected window is left alone. If the selected window is
2387 no longer live, then whatever window is selected at the end of
2388 BODY remains selected.
2389 See also `with-temp-buffer'."
2390 (declare (indent 1) (debug t))
2391 ;; Most of this code is a copy of save-selected-window.
2392 `(let ((save-selected-window-window (selected-window))
2393 ;; It is necessary to save all of these, because calling
2394 ;; select-window changes frame-selected-window for whatever
2395 ;; frame that window is in.
2396 (save-selected-window-alist
2397 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2399 (save-current-buffer
2401 (progn (select-window ,window 'norecord)
2403 (dolist (elt save-selected-window-alist)
2404 (and (frame-live-p (car elt))
2405 (window-live-p (cadr elt))
2406 (set-frame-selected-window (car elt) (cadr elt))))
2407 (if (window-live-p save-selected-window-window)
2408 (select-window save-selected-window-window 'norecord))))))
2410 (defmacro with-selected-frame (frame &rest body)
2411 "Execute the forms in BODY with FRAME as the selected frame.
2412 The value returned is the value of the last form in BODY.
2413 See also `with-temp-buffer'."
2414 (declare (indent 1) (debug t))
2415 (let ((old-frame (make-symbol "old-frame"))
2416 (old-buffer (make-symbol "old-buffer")))
2417 `(let ((,old-frame (selected-frame))
2418 (,old-buffer (current-buffer)))
2420 (progn (select-frame ,frame)
2422 (if (frame-live-p ,old-frame)
2423 (select-frame ,old-frame))
2424 (if (buffer-live-p ,old-buffer)
2425 (set-buffer ,old-buffer))))))
2427 (defmacro with-temp-file (file &rest body)
2428 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2429 The value returned is the value of the last form in BODY.
2430 See also `with-temp-buffer'."
2432 (let ((temp-file (make-symbol "temp-file"))
2433 (temp-buffer (make-symbol "temp-buffer")))
2434 `(let ((,temp-file ,file)
2436 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2439 (with-current-buffer ,temp-buffer
2441 (with-current-buffer ,temp-buffer
2443 (write-region (point-min) (point-max) ,temp-file nil 0)))
2444 (and (buffer-name ,temp-buffer)
2445 (kill-buffer ,temp-buffer))))))
2447 (defmacro with-temp-message (message &rest body)
2448 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2449 The original message is restored to the echo area after BODY has finished.
2450 The value returned is the value of the last form in BODY.
2451 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2452 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2453 Use a MESSAGE of \"\" to temporarily clear the echo area."
2455 (let ((current-message (make-symbol "current-message"))
2456 (temp-message (make-symbol "with-temp-message")))
2457 `(let ((,temp-message ,message)
2462 (setq ,current-message (current-message))
2463 (message "%s" ,temp-message))
2466 (if ,current-message
2467 (message "%s" ,current-message)
2470 (defmacro with-temp-buffer (&rest body)
2471 "Create a temporary buffer, and evaluate BODY there like `progn'.
2472 See also `with-temp-file' and `with-output-to-string'."
2473 (declare (indent 0) (debug t))
2474 (let ((temp-buffer (make-symbol "temp-buffer")))
2475 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2477 (with-current-buffer ,temp-buffer
2479 (and (buffer-name ,temp-buffer)
2480 (kill-buffer ,temp-buffer))))))
2482 (defmacro with-output-to-string (&rest body)
2483 "Execute BODY, return the text it sent to `standard-output', as a string."
2484 (declare (indent 0) (debug t))
2485 `(let ((standard-output
2486 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2487 (let ((standard-output standard-output))
2489 (with-current-buffer standard-output
2492 (kill-buffer nil)))))
2494 (defmacro with-local-quit (&rest body)
2495 "Execute BODY, allowing quits to terminate BODY but not escape further.
2496 When a quit terminates BODY, `with-local-quit' returns nil but
2497 requests another quit. That quit will be processed as soon as quitting
2498 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2499 (declare (debug t) (indent 0))
2500 `(condition-case nil
2501 (let ((inhibit-quit nil))
2503 (quit (setq quit-flag t)
2504 ;; This call is to give a chance to handle quit-flag
2505 ;; in case inhibit-quit is nil.
2506 ;; Without this, it will not be handled until the next function
2507 ;; call, and that might allow it to exit thru a condition-case
2508 ;; that intends to handle the quit signal next time.
2509 (eval '(ignore nil)))))
2511 (defmacro while-no-input (&rest body)
2512 "Execute BODY only as long as there's no pending input.
2513 If input arrives, that ends the execution of BODY,
2514 and `while-no-input' returns t. Quitting makes it return nil.
2515 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2516 (declare (debug t) (indent 0))
2517 (let ((catch-sym (make-symbol "input")))
2520 (let ((throw-on-input ',catch-sym))
2521 (or (input-pending-p)
2524 (defmacro condition-case-no-debug (var bodyform &rest handlers)
2525 "Like `condition-case' except that it does not catch anything when debugging.
2526 More specifically if `debug-on-error' is set, then it does not catch any signal."
2527 (declare (debug condition-case) (indent 2))
2528 (let ((bodysym (make-symbol "body")))
2529 `(let ((,bodysym (lambda () ,bodyform)))
2532 (condition-case ,var
2536 (defmacro with-demoted-errors (&rest body)
2537 "Run BODY and demote any errors to simple messages.
2538 If `debug-on-error' is non-nil, run BODY without catching its errors.
2539 This is to be used around code which is not expected to signal an error
2540 but which should be robust in the unexpected case that an error is signalled."
2541 (declare (debug t) (indent 0))
2542 (let ((err (make-symbol "err")))
2543 `(condition-case-no-debug ,err
2545 (error (message "Error: %s" ,err) nil))))
2547 (defmacro combine-after-change-calls (&rest body)
2548 "Execute BODY, but don't call the after-change functions till the end.
2549 If BODY makes changes in the buffer, they are recorded
2550 and the functions on `after-change-functions' are called several times
2551 when BODY is finished.
2552 The return value is the value of the last form in BODY.
2554 If `before-change-functions' is non-nil, then calls to the after-change
2555 functions can't be deferred, so in that case this macro has no effect.
2557 Do not alter `after-change-functions' or `before-change-functions'
2559 (declare (indent 0) (debug t))
2561 (let ((combine-after-change-calls t))
2563 (combine-after-change-execute)))
2565 (defmacro with-case-table (table &rest body)
2566 "Execute the forms in BODY with TABLE as the current case table.
2567 The value returned is the value of the last form in BODY."
2568 (declare (indent 1) (debug t))
2569 (let ((old-case-table (make-symbol "table"))
2570 (old-buffer (make-symbol "buffer")))
2571 `(let ((,old-case-table (current-case-table))
2572 (,old-buffer (current-buffer)))
2574 (progn (set-case-table ,table)
2576 (with-current-buffer ,old-buffer
2577 (set-case-table ,old-case-table))))))
2579 ;;;; Constructing completion tables.
2581 (defun complete-with-action (action table string pred)
2582 "Perform completion ACTION.
2583 STRING is the string to complete.
2584 TABLE is the completion table, which should not be a function.
2585 PRED is a completion predicate.
2586 ACTION can be one of nil, t or `lambda'."
2587 ;; (assert (not (functionp table)))
2590 ((null action) 'try-completion)
2591 ((eq action t) 'all-completions)
2592 (t 'test-completion))
2595 (defmacro dynamic-completion-table (fun)
2596 "Use function FUN as a dynamic completion table.
2597 FUN is called with one argument, the string for which completion is required,
2598 and it should return an alist containing all the intended possible
2599 completions. This alist may be a full list of possible completions so that FUN
2600 can ignore the value of its argument. If completion is performed in the
2601 minibuffer, FUN will be called in the buffer from which the minibuffer was
2604 The result of the `dynamic-completion-table' form is a function
2605 that can be used as the ALIST argument to `try-completion' and
2606 `all-completion'. See Info node `(elisp)Programmed Completion'."
2607 (declare (debug (lambda-expr)))
2608 (let ((win (make-symbol "window"))
2609 (string (make-symbol "string"))
2610 (predicate (make-symbol "predicate"))
2611 (mode (make-symbol "mode")))
2612 `(lambda (,string ,predicate ,mode)
2613 (with-current-buffer (let ((,win (minibuffer-selected-window)))
2614 (if (window-live-p ,win) (window-buffer ,win)
2616 (complete-with-action ,mode (,fun ,string) ,string ,predicate)))))
2618 (defmacro lazy-completion-table (var fun)
2619 ;; We used to have `&rest args' where `args' were evaluated late (at the
2620 ;; time of the call to `fun'), which was counter intuitive. But to get
2621 ;; them to be evaluated early, we have to either use lexical-let (which is
2622 ;; not available in subr.el) or use `(lambda (,str) ...) which prevents the use
2623 ;; of lexical-let in the callers.
2624 ;; So we just removed the argument. Callers can then simply use either of:
2625 ;; (lazy-completion-table var (lambda () (fun x y)))
2627 ;; (lazy-completion-table var `(lambda () (fun ',x ',y)))
2629 ;; (lexical-let ((x x)) ((y y))
2630 ;; (lazy-completion-table var (lambda () (fun x y))))
2631 ;; depending on the behavior they want.
2632 "Initialize variable VAR as a lazy completion table.
2633 If the completion table VAR is used for the first time (e.g., by passing VAR
2634 as an argument to `try-completion'), the function FUN is called with no
2635 arguments. FUN must return the completion table that will be stored in VAR.
2636 If completion is requested in the minibuffer, FUN will be called in the buffer
2637 from which the minibuffer was entered. The return value of
2638 `lazy-completion-table' must be used to initialize the value of VAR.
2640 You should give VAR a non-nil `risky-local-variable' property."
2641 (declare (debug (symbol lambda-expr)))
2642 (let ((str (make-symbol "string")))
2643 `(dynamic-completion-table
2645 (when (functionp ,var)
2649 (defmacro complete-in-turn (a b)
2650 "Create a completion table that first tries completion in A and then in B.
2651 A and B should not be costly (or side-effecting) expressions."
2652 (declare (debug (def-form def-form)))
2653 `(lambda (string predicate mode)
2656 (or (all-completions string ,a predicate)
2657 (all-completions string ,b predicate)))
2659 (or (try-completion string ,a predicate)
2660 (try-completion string ,b predicate)))
2662 (or (test-completion string ,a predicate)
2663 (test-completion string ,b predicate))))))
2665 ;;; Matching and match data.
2667 (defvar save-match-data-internal)
2669 ;; We use save-match-data-internal as the local variable because
2670 ;; that works ok in practice (people should not use that variable elsewhere).
2671 ;; We used to use an uninterned symbol; the compiler handles that properly
2672 ;; now, but it generates slower code.
2673 (defmacro save-match-data (&rest body)
2674 "Execute the BODY forms, restoring the global value of the match data.
2675 The value returned is the value of the last form in BODY."
2676 ;; It is better not to use backquote here,
2677 ;; because that makes a bootstrapping problem
2678 ;; if you need to recompile all the Lisp files using interpreted code.
2679 (declare (indent 0) (debug t))
2681 '((save-match-data-internal (match-data)))
2682 (list 'unwind-protect
2684 ;; It is safe to free (evaporate) markers immediately here,
2685 ;; as Lisp programs should not copy from save-match-data-internal.
2686 '(set-match-data save-match-data-internal 'evaporate))))
2688 (defun match-string (num &optional string)
2689 "Return string of text matched by last search.
2690 NUM specifies which parenthesized expression in the last regexp.
2691 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2692 Zero means the entire text matched by the whole regexp or whole string.
2693 STRING should be given if the last search was by `string-match' on STRING."
2694 (if (match-beginning num)
2696 (substring string (match-beginning num) (match-end num))
2697 (buffer-substring (match-beginning num) (match-end num)))))
2699 (defun match-string-no-properties (num &optional string)
2700 "Return string of text matched by last search, without text properties.
2701 NUM specifies which parenthesized expression in the last regexp.
2702 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2703 Zero means the entire text matched by the whole regexp or whole string.
2704 STRING should be given if the last search was by `string-match' on STRING."
2705 (if (match-beginning num)
2707 (substring-no-properties string (match-beginning num)
2709 (buffer-substring-no-properties (match-beginning num)
2712 (defun looking-back (regexp &optional limit greedy)
2713 "Return non-nil if text before point matches regular expression REGEXP.
2714 Like `looking-at' except matches before point, and is slower.
2715 LIMIT if non-nil speeds up the search by specifying a minimum
2716 starting position, to avoid checking matches that would start
2719 If GREEDY is non-nil, extend the match backwards as far as possible,
2720 stopping when a single additional previous character cannot be part
2721 of a match for REGEXP."
2722 (let ((start (point))
2725 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2727 (if (and greedy pos)
2729 (narrow-to-region (point-min) start)
2730 (while (and (> pos (point-min))
2734 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2735 (setq pos (1- pos)))
2738 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2741 (defsubst looking-at-p (regexp)
2743 Same as `looking-at' except this function does not change the match data."
2744 (let ((inhibit-changing-match-data t))
2745 (looking-at regexp)))
2747 (defsubst string-match-p (regexp string &optional start)
2749 Same as `string-match' except this function does not change the match data."
2750 (let ((inhibit-changing-match-data t))
2751 (string-match regexp string start)))
2753 (defun subregexp-context-p (regexp pos &optional start)
2754 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2755 A subregexp context is one where a sub-regexp can appear.
2756 A non-subregexp context is for example within brackets, or within a
2757 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2758 If START is non-nil, it should be a position in REGEXP, smaller
2759 than POS, and known to be in a subregexp context."
2760 ;; Here's one possible implementation, with the great benefit that it
2761 ;; reuses the regexp-matcher's own parser, so it understands all the
2762 ;; details of the syntax. A disadvantage is that it needs to match the
2766 (string-match (substring regexp (or start 0) pos) "")
2769 (not (member (cadr err) '("Unmatched [ or [^"
2771 "Trailing backslash")))))
2772 ;; An alternative implementation:
2773 ;; (defconst re-context-re
2774 ;; (let* ((harmless-ch "[^\\[]")
2775 ;; (harmless-esc "\\\\[^{]")
2776 ;; (class-harmless-ch "[^][]")
2777 ;; (class-lb-harmless "[^]:]")
2778 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2779 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2780 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2782 ;; (concat "\\[^?]?"
2783 ;; "\\(" class-harmless-ch
2784 ;; "\\|" class-lb "\\)*"
2785 ;; "\\[?]")) ; special handling for bare [ at end of re
2786 ;; (braces "\\\\{[0-9,]+\\\\}"))
2787 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2788 ;; "\\|" class "\\|" braces "\\)*\\'"))
2789 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2790 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2795 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2796 "The default value of separators for `split-string'.
2798 A regexp matching strings of whitespace. May be locale-dependent
2799 \(as yet unimplemented). Should not match non-breaking spaces.
2801 Warning: binding this to a different value and using it as default is
2802 likely to have undesired semantics.")
2804 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2805 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2806 ;; expression leads to the equivalent implementation that if SEPARATORS
2807 ;; is defaulted, OMIT-NULLS is treated as t.
2808 (defun split-string (string &optional separators omit-nulls)
2809 "Split STRING into substrings bounded by matches for SEPARATORS.
2811 The beginning and end of STRING, and each match for SEPARATORS, are
2812 splitting points. The substrings matching SEPARATORS are removed, and
2813 the substrings between the splitting points are collected as a list,
2816 If SEPARATORS is non-nil, it should be a regular expression matching text
2817 which separates, but is not part of, the substrings. If nil it defaults to
2818 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2819 OMIT-NULLS is forced to t.
2821 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2822 that for the default value of SEPARATORS leading and trailing whitespace
2823 are effectively trimmed). If nil, all zero-length substrings are retained,
2824 which correctly parses CSV format, for example.
2826 Note that the effect of `(split-string STRING)' is the same as
2827 `(split-string STRING split-string-default-separators t)'. In the rare
2828 case that you wish to retain zero-length substrings when splitting on
2829 whitespace, use `(split-string STRING split-string-default-separators)'.
2831 Modifies the match data; use `save-match-data' if necessary."
2832 (let ((keep-nulls (not (if separators omit-nulls t)))
2833 (rexp (or separators split-string-default-separators))
2837 (while (and (string-match rexp string
2839 (= start (match-beginning 0))
2840 (< start (length string)))
2842 (< start (length string)))
2844 (if (or keep-nulls (< start (match-beginning 0)))
2846 (cons (substring string start (match-beginning 0))
2848 (setq start (match-end 0)))
2849 (if (or keep-nulls (< start (length string)))
2851 (cons (substring string start)
2855 (defun combine-and-quote-strings (strings &optional separator)
2856 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
2857 This tries to quote the strings to avoid ambiguity such that
2858 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2859 Only some SEPARATORs will work properly."
2860 (let ((sep (or separator " ")))
2863 (if (string-match "[\\\"]" str)
2864 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
2868 (defun split-string-and-unquote (string &optional separator)
2869 "Split the STRING into a list of strings.
2870 It understands Emacs Lisp quoting within STRING, such that
2871 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2872 The SEPARATOR regexp defaults to \"\\s-+\"."
2873 (let ((sep (or separator "\\s-+"))
2874 (i (string-match "[\"]" string)))
2876 (split-string string sep t) ; no quoting: easy
2877 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
2878 (let ((rfs (read-from-string string i)))
2880 (split-string-and-unquote (substring string (cdr rfs))
2884 ;;;; Replacement in strings.
2886 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2887 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2888 Unless optional argument INPLACE is non-nil, return a new string."
2889 (let ((i (length string))
2890 (newstr (if inplace string (copy-sequence string))))
2893 (if (eq (aref newstr i) fromchar)
2894 (aset newstr i tochar)))
2897 (defun replace-regexp-in-string (regexp rep string &optional
2898 fixedcase literal subexp start)
2899 "Replace all matches for REGEXP with REP in STRING.
2901 Return a new string containing the replacements.
2903 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2904 arguments with the same names of function `replace-match'. If START
2905 is non-nil, start replacements at that index in STRING.
2907 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2908 function. If it is a function, it is called with the actual text of each
2909 match, and its value is used as the replacement text. When REP is called,
2910 the match-data are the result of matching REGEXP against a substring
2913 To replace only the first match (if any), make REGEXP match up to \\'
2914 and replace a sub-expression, e.g.
2915 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2919 ;; To avoid excessive consing from multiple matches in long strings,
2920 ;; don't just call `replace-match' continually. Walk down the
2921 ;; string looking for matches of REGEXP and building up a (reversed)
2922 ;; list MATCHES. This comprises segments of STRING which weren't
2923 ;; matched interspersed with replacements for segments that were.
2924 ;; [For a `large' number of replacements it's more efficient to
2925 ;; operate in a temporary buffer; we can't tell from the function's
2926 ;; args whether to choose the buffer-based implementation, though it
2927 ;; might be reasonable to do so for long enough STRING.]
2928 (let ((l (length string))
2929 (start (or start 0))
2932 (while (and (< start l) (string-match regexp string start))
2933 (setq mb (match-beginning 0)
2935 ;; If we matched the empty string, make sure we advance by one char
2936 (when (= me mb) (setq me (min l (1+ mb))))
2937 ;; Generate a replacement for the matched substring.
2938 ;; Operate only on the substring to minimize string consing.
2939 ;; Set up match data for the substring for replacement;
2940 ;; presumably this is likely to be faster than munging the
2941 ;; match data directly in Lisp.
2942 (string-match regexp (setq str (substring string mb me)))
2944 (cons (replace-match (if (stringp rep)
2946 (funcall rep (match-string 0 str)))
2947 fixedcase literal str subexp)
2948 (cons (substring string start mb) ; unmatched prefix
2951 ;; Reconstruct a string from the pieces.
2952 (setq matches (cons (substring string start l) matches)) ; leftover
2953 (apply #'concat (nreverse matches)))))
2955 ;;;; invisibility specs
2957 (defun add-to-invisibility-spec (element)
2958 "Add ELEMENT to `buffer-invisibility-spec'.
2959 See documentation for `buffer-invisibility-spec' for the kind of elements
2961 (if (eq buffer-invisibility-spec t)
2962 (setq buffer-invisibility-spec (list t)))
2963 (setq buffer-invisibility-spec
2964 (cons element buffer-invisibility-spec)))
2966 (defun remove-from-invisibility-spec (element)
2967 "Remove ELEMENT from `buffer-invisibility-spec'."
2968 (if (consp buffer-invisibility-spec)
2969 (setq buffer-invisibility-spec
2970 (delete element buffer-invisibility-spec))))
2974 (defmacro with-syntax-table (table &rest body)
2975 "Evaluate BODY with syntax table of current buffer set to TABLE.
2976 The syntax table of the current buffer is saved, BODY is evaluated, and the
2977 saved table is restored, even in case of an abnormal exit.
2978 Value is what BODY returns."
2980 (let ((old-table (make-symbol "table"))
2981 (old-buffer (make-symbol "buffer")))
2982 `(let ((,old-table (syntax-table))
2983 (,old-buffer (current-buffer)))
2986 (set-syntax-table ,table)
2988 (save-current-buffer
2989 (set-buffer ,old-buffer)
2990 (set-syntax-table ,old-table))))))
2992 (defun make-syntax-table (&optional oldtable)
2993 "Return a new syntax table.
2994 Create a syntax table which inherits from OLDTABLE (if non-nil) or
2995 from `standard-syntax-table' otherwise."
2996 (let ((table (make-char-table 'syntax-table nil)))
2997 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3000 (defun syntax-after (pos)
3001 "Return the raw syntax of the char after POS.
3002 If POS is outside the buffer's accessible portion, return nil."
3003 (unless (or (< pos (point-min)) (>= pos (point-max)))
3004 (let ((st (if parse-sexp-lookup-properties
3005 (get-char-property pos 'syntax-table))))
3007 (aref (or st (syntax-table)) (char-after pos))))))
3009 (defun syntax-class (syntax)
3010 "Return the syntax class part of the syntax descriptor SYNTAX.
3011 If SYNTAX is nil, return nil."
3012 (and syntax (logand (car syntax) 65535)))
3016 (defun text-clone-maintain (ol1 after beg end &optional len)
3017 "Propagate the changes made under the overlay OL1 to the other clones.
3018 This is used on the `modification-hooks' property of text clones."
3019 (when (and after (not undo-in-progress) (overlay-start ol1))
3020 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3021 (setq beg (max beg (+ (overlay-start ol1) margin)))
3022 (setq end (min end (- (overlay-end ol1) margin)))
3025 (when (overlay-get ol1 'text-clone-syntax)
3026 ;; Check content of the clone's text.
3027 (let ((cbeg (+ (overlay-start ol1) margin))
3028 (cend (- (overlay-end ol1) margin)))
3031 (if (not (re-search-forward
3032 (overlay-get ol1 'text-clone-syntax) cend t))
3033 ;; Mark the overlay for deletion.
3034 (overlay-put ol1 'text-clones nil)
3035 (when (< (match-end 0) cend)
3036 ;; Shrink the clone at its end.
3037 (setq end (min end (match-end 0)))
3038 (move-overlay ol1 (overlay-start ol1)
3039 (+ (match-end 0) margin)))
3040 (when (> (match-beginning 0) cbeg)
3041 ;; Shrink the clone at its beginning.
3042 (setq beg (max (match-beginning 0) beg))
3043 (move-overlay ol1 (- (match-beginning 0) margin)
3044 (overlay-end ol1)))))))
3045 ;; Now go ahead and update the clones.
3046 (let ((head (- beg (overlay-start ol1)))
3047 (tail (- (overlay-end ol1) end))
3048 (str (buffer-substring beg end))
3050 (inhibit-modification-hooks t))
3051 (dolist (ol2 (overlay-get ol1 'text-clones))
3052 (let ((oe (overlay-end ol2)))
3053 (unless (or (eq ol1 ol2) (null oe))
3054 (setq nothing-left nil)
3055 (let ((mod-beg (+ (overlay-start ol2) head)))
3056 ;;(overlay-put ol2 'modification-hooks nil)
3057 (goto-char (- (overlay-end ol2) tail))
3058 (unless (> mod-beg (point))
3059 (save-excursion (insert str))
3060 (delete-region mod-beg (point)))
3061 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3063 (if nothing-left (delete-overlay ol1))))))))
3065 (defun text-clone-create (start end &optional spreadp syntax)
3066 "Create a text clone of START...END at point.
3067 Text clones are chunks of text that are automatically kept identical:
3068 changes done to one of the clones will be immediately propagated to the other.
3070 The buffer's content at point is assumed to be already identical to
3071 the one between START and END.
3072 If SYNTAX is provided it's a regexp that describes the possible text of
3073 the clones; the clone will be shrunk or killed if necessary to ensure that
3074 its text matches the regexp.
3075 If SPREADP is non-nil it indicates that text inserted before/after the
3076 clone should be incorporated in the clone."
3077 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3078 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3079 ;; (with a one-char margin at each end) with `t nil'.
3080 ;; We opted for a larger overlay because it behaves better in the case
3081 ;; where the clone is reduced to the empty string (we want the overlay to
3082 ;; stay when the clone's content is the empty string and we want to use
3083 ;; `evaporate' to make sure those overlays get deleted when needed).
3085 (let* ((pt-end (+ (point) (- end start)))
3086 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3088 (end-margin (if (or (not spreadp)
3089 (>= pt-end (point-max))
3090 (>= start (point-max)))
3092 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3093 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3094 (dups (list ol1 ol2)))
3095 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3096 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3097 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3098 ;;(overlay-put ol1 'face 'underline)
3099 (overlay-put ol1 'evaporate t)
3100 (overlay-put ol1 'text-clones dups)
3102 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3103 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3104 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3105 ;;(overlay-put ol2 'face 'underline)
3106 (overlay-put ol2 'evaporate t)
3107 (overlay-put ol2 'text-clones dups)))
3109 ;;;; Mail user agents.
3111 ;; Here we include just enough for other packages to be able
3114 (defun define-mail-user-agent (symbol composefunc sendfunc
3115 &optional abortfunc hookvar)
3116 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3118 SYMBOL can be any Lisp symbol. Its function definition and/or
3119 value as a variable do not matter for this usage; we use only certain
3120 properties on its property list, to encode the rest of the arguments.
3122 COMPOSEFUNC is program callable function that composes an outgoing
3123 mail message buffer. This function should set up the basics of the
3124 buffer without requiring user interaction. It should populate the
3125 standard mail headers, leaving the `to:' and `subject:' headers blank
3128 COMPOSEFUNC should accept several optional arguments--the same
3129 arguments that `compose-mail' takes. See that function's documentation.
3131 SENDFUNC is the command a user would run to send the message.
3133 Optional ABORTFUNC is the command a user would run to abort the
3134 message. For mail packages that don't have a separate abort function,
3135 this can be `kill-buffer' (the equivalent of omitting this argument).
3137 Optional HOOKVAR is a hook variable that gets run before the message
3138 is actually sent. Callers that use the `mail-user-agent' may
3139 install a hook function temporarily on this hook variable.
3140 If HOOKVAR is nil, `mail-send-hook' is used.
3142 The properties used on SYMBOL are `composefunc', `sendfunc',
3143 `abortfunc', and `hookvar'."
3144 (put symbol 'composefunc composefunc)
3145 (put symbol 'sendfunc sendfunc)
3146 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3147 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3149 ;;;; Progress reporters.
3151 ;; Progress reporter has the following structure:
3153 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3160 ;; This weirdeness is for optimization reasons: we want
3161 ;; `progress-reporter-update' to be as fast as possible, so
3162 ;; `(car reporter)' is better than `(aref reporter 0)'.
3164 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3165 ;; digits of precision, it doesn't really matter here. On the other
3166 ;; hand, it greatly simplifies the code.
3168 (defsubst progress-reporter-update (reporter value)
3169 "Report progress of an operation in the echo area.
3170 However, if the change since last echo area update is too small
3171 or not enough time has passed, then do nothing (see
3172 `make-progress-reporter' for details).
3174 First parameter, REPORTER, should be the result of a call to
3175 `make-progress-reporter'. Second, VALUE, determines the actual
3176 progress of operation; it must be between MIN-VALUE and MAX-VALUE
3177 as passed to `make-progress-reporter'.
3179 This function is very inexpensive, you may not bother how often
3181 (when (>= value (car reporter))
3182 (progress-reporter-do-update reporter value)))
3184 (defun make-progress-reporter (message min-value max-value
3185 &optional current-value
3186 min-change min-time)
3187 "Return progress reporter object to be used with `progress-reporter-update'.
3189 MESSAGE is shown in the echo area. When at least 1% of operation
3190 is complete, the exact percentage will be appended to the
3191 MESSAGE. When you call `progress-reporter-done', word \"done\"
3192 is printed after the MESSAGE. You can change MESSAGE of an
3193 existing progress reporter with `progress-reporter-force-update'.
3195 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
3196 final (100% complete) states of operation. The latter should be
3197 larger; if this is not the case, then simply negate all values.
3198 Optional CURRENT-VALUE specifies the progress by the moment you
3199 call this function. You should omit it or set it to nil in most
3200 cases since it defaults to MIN-VALUE.
3202 Optional MIN-CHANGE determines the minimal change in percents to
3203 report (default is 1%.) Optional MIN-TIME specifies the minimal
3204 time before echo area updates (default is 0.2 seconds.) If
3205 `float-time' function is not present, then time is not tracked
3206 at all. If OS is not capable of measuring fractions of seconds,
3207 then this parameter is effectively rounded up."
3210 (setq min-time 0.2))
3212 (cons min-value ;; Force a call to `message' now
3213 (vector (if (and (fboundp 'float-time)
3219 (if min-change (max (min min-change 50) 1) 1)
3221 (progress-reporter-update reporter (or current-value min-value))
3224 (defun progress-reporter-force-update (reporter value &optional new-message)
3225 "Report progress of an operation in the echo area unconditionally.
3227 First two parameters are the same as for
3228 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
3229 change the displayed message."
3230 (let ((parameters (cdr reporter)))
3232 (aset parameters 3 new-message))
3233 (when (aref parameters 0)
3234 (aset parameters 0 (float-time)))
3235 (progress-reporter-do-update reporter value)))
3237 (defun progress-reporter-do-update (reporter value)
3238 (let* ((parameters (cdr reporter))
3239 (min-value (aref parameters 1))
3240 (max-value (aref parameters 2))
3241 (one-percent (/ (- max-value min-value) 100.0))
3242 (percentage (if (= max-value min-value)
3244 (truncate (/ (- value min-value) one-percent))))
3245 (update-time (aref parameters 0))
3246 (current-time (float-time))
3248 ;; See if enough time has passed since the last update.
3249 (or (not update-time)
3250 (when (>= current-time update-time)
3251 ;; Calculate time for the next update
3252 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3254 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
3255 ;; message this time because not enough time has passed, then use
3256 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
3257 ;; updates closer to MIN-TIME.
3259 (min (+ min-value (* (+ percentage
3260 (if enough-time-passed
3261 (aref parameters 4) ;; MIN-CHANGE
3265 (when (integerp value)
3266 (setcar reporter (ceiling (car reporter))))
3268 ;; Only print message if enough time has passed
3269 (when enough-time-passed
3270 (if (> percentage 0)
3271 (message "%s%d%%" (aref parameters 3) percentage)
3272 (message "%s" (aref parameters 3))))))
3274 (defun progress-reporter-done (reporter)
3275 "Print reporter's message followed by word \"done\" in echo area."
3276 (message "%sdone" (aref (cdr reporter) 3)))
3278 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3279 "Loop a certain number of times and report progress in the echo area.
3280 Evaluate BODY with VAR bound to successive integers running from
3281 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3282 the return value (nil if RESULT is omitted).
3284 At each iteration MESSAGE followed by progress percentage is
3285 printed in the echo area. After the loop is finished, MESSAGE
3286 followed by word \"done\" is printed. This macro is a
3287 convenience wrapper around `make-progress-reporter' and friends.
3289 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3290 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3291 (let ((temp (make-symbol "--dotimes-temp--"))
3292 (temp2 (make-symbol "--dotimes-temp2--"))
3296 (,(car spec) ,start)
3297 (,temp2 (make-progress-reporter ,message ,start ,end)))
3298 (while (< ,(car spec) ,temp)
3300 (progress-reporter-update ,temp2
3301 (setq ,(car spec) (1+ ,(car spec)))))
3302 (progress-reporter-done ,temp2)
3303 nil ,@(cdr (cdr spec)))))
3306 ;;;; Comparing version strings.
3308 (defvar version-separator "."
3309 "*Specify the string used to separate the version elements.
3311 Usually the separator is \".\", but it can be any other string.")
3314 (defvar version-regexp-alist
3315 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3316 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3317 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3318 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3319 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3320 "*Specify association between non-numeric version part and a priority.
3322 This association is used to handle version string like \"1.0pre2\",
3323 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3324 non-numeric part to an integer. For example:
3326 String Version Integer List Version
3327 \"1.0pre2\" (1 0 -1 2)
3328 \"1.0PRE2\" (1 0 -1 2)
3329 \"22.8beta3\" (22 8 -2 3)
3330 \"22.8 Beta3\" (22 8 -2 3)
3331 \"0.9alpha1\" (0 9 -3 1)
3332 \"0.9AlphA1\" (0 9 -3 1)
3333 \"0.9 alpha\" (0 9 -3)
3335 Each element has the following form:
3341 REGEXP regexp used to match non-numeric part of a version string.
3342 It should begin with a `^' anchor and end with a `$' to
3343 prevent false hits. Letter-case is ignored while matching
3346 PRIORITY negative integer which indicate the non-numeric priority.")
3349 (defun version-to-list (ver)
3350 "Convert version string VER into an integer list.
3352 The version syntax is given by the following EBNF:
3354 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3356 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3358 SEPARATOR ::= `version-separator' (which see)
3359 | `version-regexp-alist' (which see).
3361 The NUMBER part is optional if SEPARATOR is a match for an element
3362 in `version-regexp-alist'.
3364 As an example of valid version syntax:
3366 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3368 As an example of invalid version syntax:
3370 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3372 As an example of version convertion:
3374 String Version Integer List Version
3375 \"1.0.7.5\" (1 0 7 5)
3376 \"1.0pre2\" (1 0 -1 2)
3377 \"1.0PRE2\" (1 0 -1 2)
3378 \"22.8beta3\" (22 8 -2 3)
3379 \"22.8Beta3\" (22 8 -2 3)
3380 \"0.9alpha1\" (0 9 -3 1)
3381 \"0.9AlphA1\" (0 9 -3 1)
3382 \"0.9alpha\" (0 9 -3)
3384 See documentation for `version-separator' and `version-regexp-alist'."
3385 (or (and (stringp ver) (> (length ver) 0))
3386 (error "Invalid version string: '%s'" ver))
3387 ;; Change .x.y to 0.x.y
3388 (if (and (>= (length ver) (length version-separator))
3389 (string-equal (substring ver 0 (length version-separator))
3391 (setq ver (concat "0" ver)))
3394 (case-fold-search t) ; ignore case in matching
3396 (while (and (setq s (string-match "[0-9]+" ver i))
3398 ;; handle numeric part
3399 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3402 ;; handle non-numeric part
3403 (when (and (setq s (string-match "[^0-9]+" ver i))
3405 (setq s (substring ver i (match-end 0))
3407 ;; handle alpha, beta, pre, etc. separator
3408 (unless (string= s version-separator)
3409 (setq al version-regexp-alist)
3410 (while (and al (not (string-match (caar al) s)))
3412 (or al (error "Invalid version syntax: '%s'" ver))
3413 (setq lst (cons (cdar al) lst)))))
3415 (error "Invalid version syntax: '%s'" ver)
3419 (defun version-list-< (l1 l2)
3420 "Return t if integer list L1 is lesser than L2.
3422 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3423 etc. That is, the trailing zeroes are irrelevant. Also, integer
3424 list (1) is greater than (1 -1) which is greater than (1 -2)
3425 which is greater than (1 -3)."
3426 (while (and l1 l2 (= (car l1) (car l2)))
3430 ;; l1 not null and l2 not null
3431 ((and l1 l2) (< (car l1) (car l2)))
3432 ;; l1 null and l2 null ==> l1 length = l2 length
3433 ((and (null l1) (null l2)) nil)
3434 ;; l1 not null and l2 null ==> l1 length > l2 length
3435 (l1 (< (version-list-not-zero l1) 0))
3436 ;; l1 null and l2 not null ==> l2 length > l1 length
3437 (t (< 0 (version-list-not-zero l2)))))
3440 (defun version-list-= (l1 l2)
3441 "Return t if integer list L1 is equal to L2.
3443 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3444 etc. That is, the trailing zeroes are irrelevant. Also, integer
3445 list (1) is greater than (1 -1) which is greater than (1 -2)
3446 which is greater than (1 -3)."
3447 (while (and l1 l2 (= (car l1) (car l2)))
3451 ;; l1 not null and l2 not null
3453 ;; l1 null and l2 null ==> l1 length = l2 length
3454 ((and (null l1) (null l2)))
3455 ;; l1 not null and l2 null ==> l1 length > l2 length
3456 (l1 (zerop (version-list-not-zero l1)))
3457 ;; l1 null and l2 not null ==> l2 length > l1 length
3458 (t (zerop (version-list-not-zero l2)))))
3461 (defun version-list-<= (l1 l2)
3462 "Return t if integer list L1 is lesser than or equal to L2.
3464 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3465 etc. That is, the trailing zeroes are irrelevant. Also, integer
3466 list (1) is greater than (1 -1) which is greater than (1 -2)
3467 which is greater than (1 -3)."
3468 (while (and l1 l2 (= (car l1) (car l2)))
3472 ;; l1 not null and l2 not null
3473 ((and l1 l2) (< (car l1) (car l2)))
3474 ;; l1 null and l2 null ==> l1 length = l2 length
3475 ((and (null l1) (null l2)))
3476 ;; l1 not null and l2 null ==> l1 length > l2 length
3477 (l1 (<= (version-list-not-zero l1) 0))
3478 ;; l1 null and l2 not null ==> l2 length > l1 length
3479 (t (<= 0 (version-list-not-zero l2)))))
3481 (defun version-list-not-zero (lst)
3482 "Return the first non-zero element of integer list LST.
3484 If all LST elements are zeroes or LST is nil, return zero."
3485 (while (and lst (zerop (car lst)))
3486 (setq lst (cdr lst)))
3489 ;; there is no element different of zero
3493 (defun version< (v1 v2)
3494 "Return t if version V1 is lesser than V2.
3496 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3497 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3498 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3500 (version-list-< (version-to-list v1) (version-to-list v2)))
3503 (defun version<= (v1 v2)
3504 "Return t if version V1 is lesser than or equal to V2.
3506 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3507 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3508 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3510 (version-list-<= (version-to-list v1) (version-to-list v2)))
3512 (defun version= (v1 v2)
3513 "Return t if version V1 is equal to V2.
3515 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3516 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3517 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3519 (version-list-= (version-to-list v1) (version-to-list v2)))
3523 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3524 ;;; subr.el ends here