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, 2008 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
)
515 (funcall function
(car p
) (cdr p
))))
516 (map-keymap function keymap
)))
518 (put 'keyboard-translate-table
'char-table-extra-slots
0)
520 (defun keyboard-translate (from to
)
521 "Translate character FROM to TO at a low level.
522 This function creates a `keyboard-translate-table' if necessary
523 and then modifies one entry in it."
524 (or (char-table-p keyboard-translate-table
)
525 (setq keyboard-translate-table
526 (make-char-table 'keyboard-translate-table nil
)))
527 (aset keyboard-translate-table from to
))
529 ;;;; Key binding commands.
531 (defun global-set-key (key command
)
532 "Give KEY a global binding as COMMAND.
533 COMMAND is the command definition to use; usually it is
534 a symbol naming an interactively-callable function.
535 KEY is a key sequence; noninteractively, it is a string or vector
536 of characters or event types, and non-ASCII characters with codes
537 above 127 (such as ISO Latin-1) can be included if you use a vector.
539 Note that if KEY has a local binding in the current buffer,
540 that local binding will continue to shadow any global binding
541 that you make with this function."
542 (interactive "KSet key globally: \nCSet key %s to command: ")
543 (or (vectorp key
) (stringp key
)
544 (signal 'wrong-type-argument
(list 'arrayp key
)))
545 (define-key (current-global-map) key command
))
547 (defun local-set-key (key command
)
548 "Give KEY a local binding as COMMAND.
549 COMMAND is the command definition to use; usually it is
550 a symbol naming an interactively-callable function.
551 KEY is a key sequence; noninteractively, it is a string or vector
552 of characters or event types, and non-ASCII characters with codes
553 above 127 (such as ISO Latin-1) can be included if you use a vector.
555 The binding goes in the current buffer's local map,
556 which in most cases is shared with all other buffers in the same major mode."
557 (interactive "KSet key locally: \nCSet key %s locally to command: ")
558 (let ((map (current-local-map)))
560 (use-local-map (setq map
(make-sparse-keymap))))
561 (or (vectorp key
) (stringp key
)
562 (signal 'wrong-type-argument
(list 'arrayp key
)))
563 (define-key map key command
)))
565 (defun global-unset-key (key)
566 "Remove global binding of KEY.
567 KEY is a string or vector representing a sequence of keystrokes."
568 (interactive "kUnset key globally: ")
569 (global-set-key key nil
))
571 (defun local-unset-key (key)
572 "Remove local binding of KEY.
573 KEY is a string or vector representing a sequence of keystrokes."
574 (interactive "kUnset key locally: ")
575 (if (current-local-map)
576 (local-set-key key nil
))
579 ;;;; substitute-key-definition and its subroutines.
581 (defvar key-substitution-in-progress nil
582 "Used internally by `substitute-key-definition'.")
584 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
585 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
586 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
587 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
588 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
590 If you don't specify OLDMAP, you can usually get the same results
591 in a cleaner way with command remapping, like this:
592 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
593 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
594 ;; Don't document PREFIX in the doc string because we don't want to
595 ;; advertise it. It's meant for recursive calls only. Here's its
598 ;; If optional argument PREFIX is specified, it should be a key
599 ;; prefix, a string. Redefined bindings will then be bound to the
600 ;; original key, with PREFIX added at the front.
601 (or prefix
(setq prefix
""))
602 (let* ((scan (or oldmap keymap
))
603 (prefix1 (vconcat prefix
[nil]))
604 (key-substitution-in-progress
605 (cons scan key-substitution-in-progress)))
606 ;; Scan OLDMAP, finding each char or event-symbol that
607 ;; has any definition, and act on it with hack-key.
610 (aset prefix1 (length prefix) char)
611 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
614 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
615 (let (inner-def skipped menu-item)
616 ;; Find the actual command name within the binding.
617 (if (eq (car-safe defn) 'menu-item)
618 (setq menu-item defn defn (nth 2 defn))
619 ;; Skip past menu-prompt.
620 (while (stringp (car-safe defn))
621 (push (pop defn) skipped))
622 ;; Skip past cached key-equivalence data for menu items.
623 (if (consp (car-safe defn))
624 (setq defn (cdr defn))))
625 (if (or (eq defn olddef)
626 ;; Compare with equal if definition is a key sequence.
627 ;; That is useful for operating on function-key-map.
628 (and (or (stringp defn) (vectorp defn))
629 (equal defn olddef)))
630 (define-key keymap prefix
632 (let ((copy (copy-sequence menu-item)))
633 (setcar (nthcdr 2 copy) newdef)
635 (nconc (nreverse skipped) newdef)))
636 ;; Look past a symbol that names a keymap.
638 (or (indirect-function defn t) defn))
639 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
640 ;; avoid autoloading a keymap. This is mostly done to preserve the
641 ;; original non-autoloading behavior of pre-map-keymap times.
642 (if (and (keymapp inner-def)
643 ;; Avoid recursively scanning
644 ;; where KEYMAP does not have a submap.
645 (let ((elt (lookup-key keymap prefix)))
646 (or (null elt) (natnump elt) (keymapp elt)))
647 ;; Avoid recursively rescanning keymap being scanned.
648 (not (memq inner-def key-substitution-in-progress)))
649 ;; If this one isn't being scanned already, scan it now.
650 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
653 ;;;; The global keymap tree.
655 ;;; global-map, esc-map, and ctl-x-map have their values set up in
656 ;;; keymap.c; we just give them docstrings here.
658 (defvar global-map nil
659 "Default global keymap mapping Emacs keyboard input into commands.
660 The value is a keymap which is usually (but not necessarily) Emacs's
664 "Default keymap for ESC (meta) commands.
665 The normal global definition of the character ESC indirects to this keymap.")
667 (defvar ctl-x-map nil
668 "Default keymap for C-x commands.
669 The normal global definition of the character C-x indirects to this keymap.")
671 (defvar ctl-x-4-map (make-sparse-keymap)
672 "Keymap for subcommands of C-x 4.")
673 (defalias 'ctl-x-4-prefix ctl-x-4-map)
674 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
676 (defvar ctl-x-5-map (make-sparse-keymap)
677 "Keymap for frame commands.")
678 (defalias 'ctl-x-5-prefix ctl-x-5-map)
679 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
682 ;;;; Event manipulation functions.
684 ;; The call to `read' is to ensure that the value is computed at load time
685 ;; and not compiled into the .elc file. The value is negative on most
686 ;; machines, but not on all!
687 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
689 (defun listify-key-sequence (key)
690 "Convert a key sequence to a list of events."
693 (mapcar (function (lambda (c)
695 (logxor c listify-key-sequence-1)
699 (defsubst eventp (obj)
700 "True if the argument is an event object."
701 (or (and (integerp obj)
702 ;; Filter out integers too large to be events.
703 ;; M is the biggest modifier.
704 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
705 (char-valid-p (event-basic-type obj)))
707 (get obj 'event-symbol-elements))
710 (get (car obj) 'event-symbol-elements))))
712 (defun event-modifiers (event)
713 "Return a list of symbols representing the modifier keys in event EVENT.
714 The elements of the list may include `meta', `control',
715 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
717 EVENT may be an event or an event type. If EVENT is a symbol
718 that has never been used in an event that has been read as input
719 in the current Emacs session, then this function can return nil,
720 even when EVENT actually has modifiers."
723 (setq type (car type)))
725 (cdr (get type 'event-symbol-elements))
727 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
728 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
729 (if (not (zerop (logand type ?\M-\^@)))
731 (if (or (not (zerop (logand type ?\C-\^@)))
733 (push 'control list))
734 (if (or (not (zerop (logand type ?\S-\^@)))
735 (/= char (downcase char)))
737 (or (zerop (logand type ?\H-\^@))
739 (or (zerop (logand type ?\s-\^@))
741 (or (zerop (logand type ?\A-\^@))
745 (defun event-basic-type (event)
746 "Return the basic type of the given event (all modifiers removed).
747 The value is a printing character (not upper case) or a symbol.
748 EVENT may be an event or an event type. If EVENT is a symbol
749 that has never been used in an event that has been read as input
750 in the current Emacs session, then this function may return nil."
752 (setq event (car event)))
754 (car (get event 'event-symbol-elements))
755 (let* ((base (logand event (1- ?\A-\^@)))
756 (uncontrolled (if (< base 32) (logior base 64) base)))
757 ;; There are some numbers that are invalid characters and
758 ;; cause `downcase' to get an error.
760 (downcase uncontrolled)
761 (error uncontrolled)))))
763 (defsubst mouse-movement-p (object)
764 "Return non-nil if OBJECT is a mouse movement event."
765 (eq (car-safe object) 'mouse-movement))
767 (defsubst event-start (event)
768 "Return the starting position of EVENT.
769 If EVENT is a mouse or key press or a mouse click, this returns the location
771 If EVENT is a drag, this returns the drag's starting position.
772 The return value is of the form
773 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
774 IMAGE (DX . DY) (WIDTH . HEIGHT))
775 The `posn-' functions access elements of such lists."
776 (if (consp event) (nth 1 event)
777 (list (selected-window) (point) '(0 . 0) 0)))
779 (defsubst event-end (event)
780 "Return the ending location of EVENT.
781 EVENT should be a click, drag, or key press event.
782 If EVENT is a click event, this function is the same as `event-start'.
783 The return value is of the form
784 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
785 IMAGE (DX . DY) (WIDTH . HEIGHT))
786 The `posn-' functions access elements of such lists."
787 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
788 (list (selected-window) (point) '(0 . 0) 0)))
790 (defsubst event-click-count (event)
791 "Return the multi-click count of EVENT, a click or drag event.
792 The return value is a positive integer."
793 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
795 ;;;; Extracting fields of the positions in an event.
797 (defsubst posn-window (position)
798 "Return the window in POSITION.
799 POSITION should be a list of the form returned by the `event-start'
800 and `event-end' functions."
803 (defsubst posn-area (position)
804 "Return the window area recorded in POSITION, or nil for the text area.
805 POSITION should be a list of the form returned by the `event-start'
806 and `event-end' functions."
807 (let ((area (if (consp (nth 1 position))
808 (car (nth 1 position))
810 (and (symbolp area) area)))
812 (defsubst posn-point (position)
813 "Return the buffer location in POSITION.
814 POSITION should be a list of the form returned by the `event-start'
815 and `event-end' functions."
817 (if (consp (nth 1 position))
818 (car (nth 1 position))
821 (defun posn-set-point (position)
822 "Move point to POSITION.
823 Select the corresponding window as well."
824 (if (not (windowp (posn-window position)))
825 (error "Position not in text area of window"))
826 (select-window (posn-window position))
827 (if (numberp (posn-point position))
828 (goto-char (posn-point position))))
830 (defsubst posn-x-y (position)
831 "Return the x and y coordinates in POSITION.
832 POSITION should be a list of the form returned by the `event-start'
833 and `event-end' functions."
836 (defun posn-col-row (position)
837 "Return the nominal column and row in POSITION, measured in characters.
838 The column and row values are approximations calculated from the x
839 and y coordinates in POSITION and the frame's default character width
841 For a scroll-bar event, the result column is 0, and the row
842 corresponds to the vertical position of the click in the scroll bar.
843 POSITION should be a list of the form returned by the `event-start'
844 and `event-end' functions."
845 (let* ((pair (posn-x-y position))
846 (window (posn-window position))
847 (area (posn-area position)))
851 ((eq area 'vertical-scroll-bar)
852 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
853 ((eq area 'horizontal-scroll-bar)
854 (cons (scroll-bar-scale pair (window-width window)) 0))
856 (let* ((frame (if (framep window) window (window-frame window)))
857 (x (/ (car pair) (frame-char-width frame)))
858 (y (/ (cdr pair) (+ (frame-char-height frame)
859 (or (frame-parameter frame 'line-spacing)
864 (defun posn-actual-col-row (position)
865 "Return the actual column and row in POSITION, measured in characters.
866 These are the actual row number in the window and character number in that row.
867 Return nil if POSITION does not contain the actual position; in that case
868 `posn-col-row' can be used to get approximate values.
869 POSITION should be a list of the form returned by the `event-start'
870 and `event-end' functions."
873 (defsubst posn-timestamp (position)
874 "Return the timestamp of POSITION.
875 POSITION should be a list of the form returned by the `event-start'
876 and `event-end' functions."
879 (defsubst posn-string (position)
880 "Return the string object of POSITION.
881 Value is a cons (STRING . STRING-POS), or nil if not a string.
882 POSITION should be a list of the form returned by the `event-start'
883 and `event-end' functions."
886 (defsubst posn-image (position)
887 "Return the image object of POSITION.
888 Value is a list (image ...), or nil if not an image.
889 POSITION should be a list of the form returned by the `event-start'
890 and `event-end' functions."
893 (defsubst posn-object (position)
894 "Return the object (image or string) of POSITION.
895 Value is a list (image ...) for an image object, a cons cell
896 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
897 POSITION should be a list of the form returned by the `event-start'
898 and `event-end' functions."
899 (or (posn-image position) (posn-string position)))
901 (defsubst posn-object-x-y (position)
902 "Return the x and y coordinates relative to the object of POSITION.
903 POSITION should be a list of the form returned by the `event-start'
904 and `event-end' functions."
907 (defsubst posn-object-width-height (position)
908 "Return the pixel width and height of the object of POSITION.
909 POSITION should be a list of the form returned by the `event-start'
910 and `event-end' functions."
914 ;;;; Obsolescent names for functions.
916 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
917 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
918 (define-obsolete-function-alias 'read-input 'read-string "22.1")
919 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
920 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
921 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
923 (make-obsolete 'char-bytes "now always returns 1." "20.4")
925 (defun insert-string (&rest args)
926 "Mocklisp-compatibility insert function.
927 Like the function `insert' except that any argument that is a number
928 is converted into a string by expressing it in decimal."
930 (insert (if (integerp el) (number-to-string el) el))))
931 (make-obsolete 'insert-string 'insert "22.1")
933 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
934 (make-obsolete 'makehash 'make-hash-table "22.1")
936 ;; Some programs still use this as a function.
938 "Return the value of the `baud-rate' variable."
940 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
942 ;; These are used by VM and some old programs
943 (defalias 'focus-frame 'ignore "")
944 (make-obsolete 'focus-frame "it does nothing." "22.1")
945 (defalias 'unfocus-frame 'ignore "")
946 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
947 (make-obsolete 'make-variable-frame-local "use a frame-parameter instead." "22.2")
949 ;;;; Obsolescence declarations for variables, and aliases.
951 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
952 (make-obsolete-variable
953 'mode-line-inverse-video
954 "use the appropriate faces instead."
956 (make-obsolete-variable
958 "use `unread-command-events' instead. That variable is a list of events
959 to reread, so it now uses nil to mean `no event', instead of -1."
962 ;; Lisp manual only updated in 22.1.
963 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
966 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
967 (make-obsolete-variable 'x-lost-selection-hooks
968 'x-lost-selection-functions "22.1")
969 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
970 (make-obsolete-variable 'x-sent-selection-hooks
971 'x-sent-selection-functions "22.1")
973 (defvaralias 'messages-buffer-max-lines 'message-log-max)
975 ;;;; Alternate names for functions - these are not being phased out.
977 (defalias 'send-string 'process-send-string)
978 (defalias 'send-region 'process-send-region)
979 (defalias 'string= 'string-equal)
980 (defalias 'string< 'string-lessp)
981 (defalias 'move-marker 'set-marker)
982 (defalias 'rplaca 'setcar)
983 (defalias 'rplacd 'setcdr)
984 (defalias 'beep 'ding) ;preserve lingual purity
985 (defalias 'indent-to-column 'indent-to)
986 (defalias 'backward-delete-char 'delete-backward-char)
987 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
988 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
989 (defalias 'int-to-string 'number-to-string)
990 (defalias 'store-match-data 'set-match-data)
991 ;; These are the XEmacs names:
992 (defalias 'point-at-eol 'line-end-position)
993 (defalias 'point-at-bol 'line-beginning-position)
995 (defalias 'user-original-login-name 'user-login-name)
998 ;;;; Hook manipulation functions.
1000 (defun make-local-hook (hook)
1001 "Make the hook HOOK local to the current buffer.
1002 The return value is HOOK.
1004 You never need to call this function now that `add-hook' does it for you
1005 if its LOCAL argument is non-nil.
1007 When a hook is local, its local and global values
1008 work in concert: running the hook actually runs all the hook
1009 functions listed in *either* the local value *or* the global value
1010 of the hook variable.
1012 This function works by making t a member of the buffer-local value,
1013 which acts as a flag to run the hook functions in the default value as
1014 well. This works for all normal hooks, but does not work for most
1015 non-normal hooks yet. We will be changing the callers of non-normal
1016 hooks so that they can handle localness; this has to be done one by
1019 This function does nothing if HOOK is already local in the current
1022 Do not use `make-local-variable' to make a hook variable buffer-local."
1023 (if (local-variable-p hook)
1025 (or (boundp hook) (set hook nil))
1026 (make-local-variable hook)
1027 (set hook (list t)))
1029 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1031 (defun add-hook (hook function &optional append local)
1032 "Add to the value of HOOK the function FUNCTION.
1033 FUNCTION is not added if already present.
1034 FUNCTION is added (if necessary) at the beginning of the hook list
1035 unless the optional argument APPEND is non-nil, in which case
1036 FUNCTION is added at the end.
1038 The optional fourth argument, LOCAL, if non-nil, says to modify
1039 the hook's buffer-local value rather than its default value.
1040 This makes the hook buffer-local if needed, and it makes t a member
1041 of the buffer-local value. That acts as a flag to run the hook
1042 functions in the default value as well as in the local value.
1044 HOOK should be a symbol, and FUNCTION may be any valid function. If
1045 HOOK is void, it is first set to nil. If HOOK's value is a single
1046 function, it is changed to a list of functions."
1047 (or (boundp hook) (set hook nil))
1048 (or (default-boundp hook) (set-default hook nil))
1049 (if local (unless (local-variable-if-set-p hook)
1050 (set (make-local-variable hook) (list t)))
1051 ;; Detect the case where make-local-variable was used on a hook
1052 ;; and do what we used to do.
1053 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1055 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1056 ;; If the hook value is a single function, turn it into a list.
1057 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1058 (setq hook-value (list hook-value)))
1059 ;; Do the actual addition if necessary
1060 (unless (member function hook-value)
1063 (append hook-value (list function))
1064 (cons function hook-value))))
1065 ;; Set the actual variable
1066 (if local (set hook hook-value) (set-default hook hook-value))))
1068 (defun remove-hook (hook function &optional local)
1069 "Remove from the value of HOOK the function FUNCTION.
1070 HOOK should be a symbol, and FUNCTION may be any valid function. If
1071 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1072 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1074 The optional third argument, LOCAL, if non-nil, says to modify
1075 the hook's buffer-local value rather than its default value."
1076 (or (boundp hook) (set hook nil))
1077 (or (default-boundp hook) (set-default hook nil))
1078 ;; Do nothing if LOCAL is t but this hook has no local binding.
1079 (unless (and local (not (local-variable-p hook)))
1080 ;; Detect the case where make-local-variable was used on a hook
1081 ;; and do what we used to do.
1082 (when (and (local-variable-p hook)
1083 (not (and (consp (symbol-value hook))
1084 (memq t (symbol-value hook)))))
1086 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1087 ;; Remove the function, for both the list and the non-list cases.
1088 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1089 (if (equal hook-value function) (setq hook-value nil))
1090 (setq hook-value (delete function (copy-sequence hook-value))))
1091 ;; If the function is on the global hook, we need to shadow it locally
1092 ;;(when (and local (member function (default-value hook))
1093 ;; (not (member (cons 'not function) hook-value)))
1094 ;; (push (cons 'not function) hook-value))
1095 ;; Set the actual variable
1097 (set-default hook hook-value)
1098 (if (equal hook-value '(t))
1099 (kill-local-variable hook)
1100 (set hook hook-value))))))
1102 (defun add-to-list (list-var element &optional append compare-fn)
1103 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1104 The test for presence of ELEMENT is done with `equal',
1105 or with COMPARE-FN if that's non-nil.
1106 If ELEMENT is added, it is added at the beginning of the list,
1107 unless the optional argument APPEND is non-nil, in which case
1108 ELEMENT is added at the end.
1110 The return value is the new value of LIST-VAR.
1112 If you want to use `add-to-list' on a variable that is not defined
1113 until a certain package is loaded, you should put the call to `add-to-list'
1114 into a hook function that will be run only after loading the package.
1115 `eval-after-load' provides one way to do this. In some cases
1116 other hooks, such as major mode hooks, can do the job."
1119 (member element (symbol-value list-var)))
1120 ((eq compare-fn 'eq)
1121 (memq element (symbol-value list-var)))
1122 ((eq compare-fn 'eql)
1123 (memql element (symbol-value list-var)))
1125 (let ((lst (symbol-value list-var)))
1127 (not (funcall compare-fn element (car lst))))
1128 (setq lst (cdr lst)))
1130 (symbol-value list-var)
1133 (append (symbol-value list-var) (list element))
1134 (cons element (symbol-value list-var))))))
1137 (defun add-to-ordered-list (list-var element &optional order)
1138 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1139 The test for presence of ELEMENT is done with `eq'.
1141 The resulting list is reordered so that the elements are in the
1142 order given by each element's numeric list order. Elements
1143 without a numeric list order are placed at the end of the list.
1145 If the third optional argument ORDER is a number (integer or
1146 float), set the element's list order to the given value. If
1147 ORDER is nil or omitted, do not change the numeric order of
1148 ELEMENT. If ORDER has any other value, remove the numeric order
1149 of ELEMENT if it has one.
1151 The list order for each element is stored in LIST-VAR's
1152 `list-order' property.
1154 The return value is the new value of LIST-VAR."
1155 (let ((ordering (get list-var 'list-order)))
1157 (put list-var 'list-order
1158 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1160 (puthash element (and (numberp order) order) ordering))
1161 (unless (memq element (symbol-value list-var))
1162 (set list-var (cons element (symbol-value list-var))))
1163 (set list-var (sort (symbol-value list-var)
1165 (let ((oa (gethash a ordering))
1166 (ob (gethash b ordering)))
1171 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1172 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1173 Return the new history list.
1174 If MAXELT is non-nil, it specifies the maximum length of the history.
1175 Otherwise, the maximum history length is the value of the `history-length'
1176 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1178 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1179 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1180 if it is empty or a duplicate."
1182 (setq maxelt (or (get history-var 'history-length)
1184 (let ((history (symbol-value history-var))
1186 (when (and (listp history)
1188 (not (stringp newelt))
1189 (> (length newelt) 0))
1191 (not (equal (car history) newelt))))
1192 (if history-delete-duplicates
1193 (delete newelt history))
1194 (setq history (cons newelt history))
1195 (when (integerp maxelt)
1198 (setq tail (nthcdr (1- maxelt) history))
1200 (setcdr tail nil)))))
1201 (set history-var history)))
1206 (defvar delay-mode-hooks nil
1207 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1208 (defvar delayed-mode-hooks nil
1209 "List of delayed mode hooks waiting to be run.")
1210 (make-variable-buffer-local 'delayed-mode-hooks)
1211 (put 'delay-mode-hooks 'permanent-local t)
1213 (defvar after-change-major-mode-hook nil
1214 "Normal hook run at the very end of major mode functions.")
1216 (defun run-mode-hooks (&rest hooks)
1217 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1218 Execution is delayed if `delay-mode-hooks' is non-nil.
1219 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1220 after running the mode hooks.
1221 Major mode functions should use this."
1222 (if delay-mode-hooks
1224 (dolist (hook hooks)
1225 (push hook delayed-mode-hooks))
1226 ;; Normal case, just run the hook as before plus any delayed hooks.
1227 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1228 (setq delayed-mode-hooks nil)
1229 (apply 'run-hooks hooks)
1230 (run-hooks 'after-change-major-mode-hook)))
1232 (defmacro delay-mode-hooks (&rest body)
1233 "Execute BODY, but delay any `run-mode-hooks'.
1234 These hooks will be executed by the first following call to
1235 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1236 Only affects hooks run in the current buffer."
1237 (declare (debug t) (indent 0))
1239 (make-local-variable 'delay-mode-hooks)
1240 (let ((delay-mode-hooks t))
1243 ;; PUBLIC: find if the current mode derives from another.
1245 (defun derived-mode-p (&rest modes)
1246 "Non-nil if the current major mode is derived from one of MODES.
1247 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1248 (let ((parent major-mode))
1249 (while (and (not (memq parent modes))
1250 (setq parent (get parent 'derived-mode-parent))))
1255 ;; If a minor mode is not defined with define-minor-mode,
1256 ;; add it here explicitly.
1257 ;; isearch-mode is deliberately excluded, since you should
1258 ;; not call it yourself.
1259 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1260 overwrite-mode view-mode
1262 "List of all minor mode functions.")
1264 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1265 "Register a new minor mode.
1267 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1269 TOGGLE is a symbol which is the name of a buffer-local variable that
1270 is toggled on or off to say whether the minor mode is active or not.
1272 NAME specifies what will appear in the mode line when the minor mode
1273 is active. NAME should be either a string starting with a space, or a
1274 symbol whose value is such a string.
1276 Optional KEYMAP is the keymap for the minor mode that will be added
1277 to `minor-mode-map-alist'.
1279 Optional AFTER specifies that TOGGLE should be added after AFTER
1280 in `minor-mode-alist'.
1282 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1283 It defaults to (and should by convention be) TOGGLE.
1285 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1286 included in the mode-line minor mode menu.
1287 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1288 (unless (memq toggle minor-mode-list)
1289 (push toggle minor-mode-list))
1291 (unless toggle-fun (setq toggle-fun toggle))
1292 (unless (eq toggle-fun toggle)
1293 (put toggle :minor-mode-function toggle-fun))
1294 ;; Add the name to the minor-mode-alist.
1296 (let ((existing (assq toggle minor-mode-alist)))
1298 (setcdr existing (list name))
1299 (let ((tail minor-mode-alist) found)
1300 (while (and tail (not found))
1301 (if (eq after (caar tail))
1303 (setq tail (cdr tail))))
1305 (let ((rest (cdr found)))
1307 (nconc found (list (list toggle name)) rest))
1308 (setq minor-mode-alist (cons (list toggle name)
1309 minor-mode-alist)))))))
1310 ;; Add the toggle to the minor-modes menu if requested.
1311 (when (get toggle :included)
1312 (define-key mode-line-mode-menu
1316 (or (get toggle :menu-tag)
1317 (if (stringp name) name (symbol-name toggle)))
1318 (let ((mode-name (if (symbolp name) (symbol-value name))))
1319 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1320 (concat " (" (match-string 0 mode-name) ")"))))
1322 :button (cons :toggle toggle))))
1324 ;; Add the map to the minor-mode-map-alist.
1326 (let ((existing (assq toggle minor-mode-map-alist)))
1328 (setcdr existing keymap)
1329 (let ((tail minor-mode-map-alist) found)
1330 (while (and tail (not found))
1331 (if (eq after (caar tail))
1333 (setq tail (cdr tail))))
1335 (let ((rest (cdr found)))
1337 (nconc found (list (cons toggle keymap)) rest))
1338 (setq minor-mode-map-alist (cons (cons toggle keymap)
1339 minor-mode-map-alist))))))))
1343 ;; (defvar symbol-file-load-history-loaded nil
1344 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1345 ;; That file records the part of `load-history' for preloaded files,
1346 ;; which is cleared out before dumping to make Emacs smaller.")
1348 ;; (defun load-symbol-file-load-history ()
1349 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1350 ;; That file records the part of `load-history' for preloaded files,
1351 ;; which is cleared out before dumping to make Emacs smaller."
1352 ;; (unless symbol-file-load-history-loaded
1353 ;; (load (expand-file-name
1354 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1355 ;; (if (eq system-type 'ms-dos)
1357 ;; (format "fns-%s.el" emacs-version))
1359 ;; ;; The file name fns-%s.el already has a .el extension.
1361 ;; (setq symbol-file-load-history-loaded t)))
1363 (defun symbol-file (symbol &optional type)
1364 "Return the input source in which SYMBOL was defined.
1365 The value is an absolute file name.
1366 It can also be nil, if the definition is not associated with any file.
1368 If TYPE is nil, then any kind of definition is acceptable.
1369 If TYPE is `defun' or `defvar', that specifies function
1370 definition only or variable definition only.
1371 `defface' specifies a face definition only."
1372 (if (and (or (null type) (eq type 'defun))
1373 (symbolp symbol) (fboundp symbol)
1374 (eq 'autoload (car-safe (symbol-function symbol))))
1375 (nth 1 (symbol-function symbol))
1376 (let ((files load-history)
1380 (if (eq type 'defvar)
1381 ;; Variables are present just as their names.
1382 (member symbol (cdr (car files)))
1383 ;; Other types are represented as (TYPE . NAME).
1384 (member (cons type symbol) (cdr (car files))))
1385 ;; We accept all types, so look for variable def
1386 ;; and then for any other kind.
1387 (or (member symbol (cdr (car files)))
1388 (rassq symbol (cdr (car files)))))
1389 (setq file (car (car files)) files nil))
1390 (setq files (cdr files)))
1394 (defun locate-library (library &optional nosuffix path interactive-call)
1395 "Show the precise file name of Emacs library LIBRARY.
1396 This command searches the directories in `load-path' like `\\[load-library]'
1397 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1398 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1399 to the specified name LIBRARY.
1401 If the optional third arg PATH is specified, that list of directories
1402 is used instead of `load-path'.
1404 When called from a program, the file name is normally returned as a
1405 string. When run interactively, the argument INTERACTIVE-CALL is t,
1406 and the file name is displayed in the echo area."
1407 (interactive (list (completing-read "Locate library: "
1408 'locate-file-completion
1409 (cons load-path (get-load-suffixes)))
1412 (let ((file (locate-file library
1414 (append (unless nosuffix (get-load-suffixes))
1415 load-file-rep-suffixes))))
1416 (if interactive-call
1418 (message "Library is file %s" (abbreviate-file-name file))
1419 (message "No library %s in search path" library)))
1423 ;;;; Specifying things to do later.
1425 (defmacro eval-at-startup (&rest body)
1426 "Make arrangements to evaluate BODY when Emacs starts up.
1427 If this is run after Emacs startup, evaluate BODY immediately.
1430 This works by adding a function to `before-init-hook'.
1431 That function's doc string says which file created it."
1433 (if command-line-processed
1435 (add-hook 'before-init-hook
1436 '(lambda () ,(concat "From " (or load-file-name "no file"))
1441 (defun load-history-regexp (file)
1442 "Form a regexp to find FILE in `load-history'.
1443 FILE, a string, is described in the function `eval-after-load'."
1444 (if (file-name-absolute-p file)
1445 (setq file (file-truename file)))
1446 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1448 (if (file-name-extension file)
1450 ;; Note: regexp-opt can't be used here, since we need to call
1451 ;; this before Emacs has been fully started. 2006-05-21
1452 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1453 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1456 (defun load-history-filename-element (file-regexp)
1457 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1458 Return nil if there isn't one."
1459 (let* ((loads load-history)
1460 (load-elt (and loads (car loads))))
1463 (or (null (car load-elt))
1464 (not (string-match file-regexp (car load-elt)))))
1465 (setq loads (cdr loads)
1466 load-elt (and loads (car loads)))))
1469 (defun eval-after-load (file form)
1470 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1471 If FILE is already loaded, evaluate FORM right now.
1473 If a matching file is loaded again, FORM will be evaluated again.
1475 If FILE is a string, it may be either an absolute or a relative file
1476 name, and may have an extension \(e.g. \".el\") or may lack one, and
1477 additionally may or may not have an extension denoting a compressed
1478 format \(e.g. \".gz\").
1480 When FILE is absolute, this first converts it to a true name by chasing
1481 symbolic links. Only a file of this name \(see next paragraph regarding
1482 extensions) will trigger the evaluation of FORM. When FILE is relative,
1483 a file whose absolute true name ends in FILE will trigger evaluation.
1485 When FILE lacks an extension, a file name with any extension will trigger
1486 evaluation. Otherwise, its extension must match FILE's. A further
1487 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1490 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1491 is evaluated whenever that feature is `provide'd.
1493 Usually FILE is just a library name like \"font-lock\" or a feature name
1496 This function makes or adds to an entry on `after-load-alist'."
1497 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1498 ;; evaluating it now).
1499 (let* ((regexp-or-feature
1500 (if (stringp file) (load-history-regexp file) file))
1501 (elt (assoc regexp-or-feature after-load-alist)))
1503 (setq elt (list regexp-or-feature))
1504 (push elt after-load-alist))
1505 ;; Add FORM to the element unless it's already there.
1506 (unless (member form (cdr elt))
1507 (nconc elt (list form)))
1509 ;; Is there an already loaded file whose name (or `provide' name)
1511 (if (if (stringp file)
1512 (load-history-filename-element regexp-or-feature)
1516 (defun do-after-load-evaluation (abs-file)
1517 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1518 ABS-FILE, a string, should be the absolute true name of a file just loaded."
1519 (let ((after-load-elts after-load-alist)
1520 a-l-element file-elements file-element form)
1521 (while after-load-elts
1522 (setq a-l-element (car after-load-elts)
1523 after-load-elts (cdr after-load-elts))
1524 (when (and (stringp (car a-l-element))
1525 (string-match (car a-l-element) abs-file))
1526 (while (setq a-l-element (cdr a-l-element)) ; discard the file name
1527 (setq form (car a-l-element))
1530 (defun eval-next-after-load (file)
1531 "Read the following input sexp, and run it whenever FILE is loaded.
1532 This makes or adds to an entry on `after-load-alist'.
1533 FILE should be the name of a library, with no directory name."
1534 (eval-after-load file (read)))
1538 ;; open-network-stream is a wrapper around make-network-process.
1540 (when (featurep 'make-network-process)
1541 (defun open-network-stream (name buffer host service)
1542 "Open a TCP connection for a service to a host.
1543 Returns a subprocess-object to represent the connection.
1544 Input and output work as for subprocesses; `delete-process' closes it.
1546 Args are NAME BUFFER HOST SERVICE.
1547 NAME is name for process. It is modified if necessary to make it unique.
1548 BUFFER is the buffer (or buffer name) to associate with the process.
1549 Process output goes at end of that buffer, unless you specify
1550 an output stream or filter function to handle the output.
1551 BUFFER may be also nil, meaning that this process is not associated
1553 HOST is name of the host to connect to, or its IP address.
1554 SERVICE is name of the service desired, or an integer specifying
1555 a port number to connect to."
1556 (make-network-process :name name :buffer buffer
1557 :host host :service service)))
1562 'process-kill-without-query
1563 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1565 (defun process-kill-without-query (process &optional flag)
1566 "Say no query needed if PROCESS is running when Emacs is exited.
1567 Optional second argument if non-nil says to require a query.
1568 Value is t if a query was formerly required."
1569 (let ((old (process-query-on-exit-flag process)))
1570 (set-process-query-on-exit-flag process nil)
1573 ;; process plist management
1575 (defun process-get (process propname)
1576 "Return the value of PROCESS' PROPNAME property.
1577 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1578 (plist-get (process-plist process) propname))
1580 (defun process-put (process propname value)
1581 "Change PROCESS' PROPNAME property to VALUE.
1582 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1583 (set-process-plist process
1584 (plist-put (process-plist process) propname value)))
1587 ;;;; Input and display facilities.
1589 (defvar read-quoted-char-radix 8
1590 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1591 Legitimate radix values are 8, 10 and 16.")
1593 (custom-declare-variable-early
1594 'read-quoted-char-radix 8
1595 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1596 Legitimate radix values are 8, 10 and 16."
1597 :type '(choice (const 8) (const 10) (const 16))
1598 :group 'editing-basics)
1600 (defun read-quoted-char (&optional prompt)
1601 "Like `read-char', but do not allow quitting.
1602 Also, if the first character read is an octal digit,
1603 we read any number of octal digits and return the
1604 specified character code. Any nondigit terminates the sequence.
1605 If the terminator is RET, it is discarded;
1606 any other terminator is used itself as input.
1608 The optional argument PROMPT specifies a string to use to prompt the user.
1609 The variable `read-quoted-char-radix' controls which radix to use
1611 (let ((message-log-max nil) done (first t) (code 0) char translated)
1613 (let ((inhibit-quit first)
1614 ;; Don't let C-h get the help message--only help function keys.
1617 "Type the special character you want to use,
1618 or the octal character code.
1619 RET terminates the character code and is discarded;
1620 any other non-digit terminates the character code and is then used as input."))
1621 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1622 (if inhibit-quit (setq quit-flag nil)))
1623 ;; Translate TAB key into control-I ASCII character, and so on.
1624 ;; Note: `read-char' does it using the `ascii-character' property.
1625 ;; We could try and use read-key-sequence instead, but then C-q ESC
1626 ;; or C-q C-x might not return immediately since ESC or C-x might be
1627 ;; bound to some prefix in function-key-map or key-translation-map.
1628 (setq translated char)
1629 (let ((translation (lookup-key function-key-map (vector char))))
1630 (if (arrayp translation)
1631 (setq translated (aref translation 0))))
1632 (cond ((null translated))
1633 ((not (integerp translated))
1634 (setq unread-command-events (list char)
1636 ((/= (logand translated ?\M-\^@) 0)
1637 ;; Turn a meta-character into a character with the 0200 bit set.
1638 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1640 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1641 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1642 (and prompt (setq prompt (message "%s %c" prompt translated))))
1643 ((and (<= ?a (downcase translated))
1644 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1645 (setq code (+ (* code read-quoted-char-radix)
1646 (+ 10 (- (downcase translated) ?a))))
1647 (and prompt (setq prompt (message "%s %c" prompt translated))))
1648 ((and (not first) (eq translated ?\C-m))
1651 (setq unread-command-events (list char)
1653 (t (setq code translated
1658 (defun read-passwd (prompt &optional confirm default)
1659 "Read a password, prompting with PROMPT, and return it.
1660 If optional CONFIRM is non-nil, read the password twice to make sure.
1661 Optional DEFAULT is a default password to use instead of empty input.
1663 This function echoes `.' for each character that the user types.
1664 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1665 C-g quits; if `inhibit-quit' was non-nil around this function,
1666 then it returns nil if the user types C-g, but quit-flag remains set.
1668 Once the caller uses the password, it can erase the password
1669 by doing (clear-string STRING)."
1673 (while (not success)
1674 (let ((first (read-passwd prompt nil default))
1675 (second (read-passwd "Confirm password: " nil default)))
1676 (if (equal first second)
1678 (and (arrayp second) (clear-string second))
1679 (setq success first))
1680 (and (arrayp first) (clear-string first))
1681 (and (arrayp second) (clear-string second))
1682 (message "Password not repeated accurately; please start over")
1686 ;; Copy it so that add-text-properties won't modify
1687 ;; the object that was passed in by the caller.
1688 (prompt (copy-sequence prompt))
1691 (cursor-in-echo-area t)
1692 (message-log-max nil))
1693 (add-text-properties 0 (length prompt)
1694 minibuffer-prompt-properties prompt)
1695 (while (progn (message "%s%s"
1697 (make-string (length pass) ?.))
1698 (setq c (read-char-exclusive nil t))
1699 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1700 (clear-this-command-keys)
1703 (and (arrayp pass) (clear-string pass))
1705 (if (and (/= c ?\b) (/= c ?\177))
1706 (let* ((new-char (char-to-string c))
1707 (new-pass (concat pass new-char)))
1708 (and (arrayp pass) (clear-string pass))
1709 (clear-string new-char)
1711 (setq pass new-pass))
1712 (if (> (length pass) 0)
1713 (let ((new-pass (substring pass 0 -1)))
1714 (and (arrayp pass) (clear-string pass))
1715 (setq pass new-pass))))))
1717 (or pass default "")))))
1719 ;; This should be used by `call-interactively' for `n' specs.
1720 (defun read-number (prompt &optional default)
1721 "Read a numeric value in the minibuffer, prompting with PROMPT.
1722 DEFAULT specifies a default value to return if the user just types RET.
1723 The value of DEFAULT is inserted into PROMPT."
1727 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1728 (replace-match (format " (default %s)" default) t t prompt 1)
1729 (replace-regexp-in-string "[ \t]*\\'"
1730 (format " (default %s) " default)
1734 (let ((str (read-from-minibuffer prompt nil nil nil nil
1736 (number-to-string default)))))
1739 ((zerop (length str)) default)
1740 ((stringp str) (read str))))
1743 (message "Please enter a number.")
1748 (defun sit-for (seconds &optional nodisp obsolete)
1749 "Perform redisplay, then wait for SECONDS seconds or until input is available.
1750 SECONDS may be a floating-point value.
1751 \(On operating systems that do not support waiting for fractions of a
1752 second, floating-point values are rounded down to the nearest integer.)
1754 If optional arg NODISP is t, don't redisplay, just wait for input.
1755 Redisplay does not happen if input is available before it starts.
1757 Value is t if waited the full time with no input arriving, and nil otherwise.
1759 An obsolete, but still supported form is
1760 \(sit-for SECONDS &optional MILLISECONDS NODISP)
1761 where the optional arg MILLISECONDS specifies an additional wait period,
1762 in milliseconds; this was useful when Emacs was built without
1763 floating point support.
1765 \(fn SECONDS &optional NODISP)"
1766 (if (numberp nodisp)
1767 (setq seconds (+ seconds (* 1e-3 nodisp))
1769 (if obsolete (setq nodisp obsolete)))
1777 (or nodisp (redisplay)))
1779 (or nodisp (redisplay))
1780 (let ((read (read-event nil nil seconds)))
1783 ;; If last command was a prefix arg, e.g. C-u, push this event onto
1784 ;; unread-command-events as (t . EVENT) so it will be added to
1785 ;; this-command-keys by read-key-sequence.
1786 (if (eq overriding-terminal-local-map universal-argument-map)
1787 (setq read (cons t read)))
1788 (push read unread-command-events)
1791 ;;; Atomic change groups.
1793 (defmacro atomic-change-group (&rest body)
1794 "Perform BODY as an atomic change group.
1795 This means that if BODY exits abnormally,
1796 all of its changes to the current buffer are undone.
1797 This works regardless of whether undo is enabled in the buffer.
1799 This mechanism is transparent to ordinary use of undo;
1800 if undo is enabled in the buffer and BODY succeeds, the
1801 user can undo the change normally."
1802 (declare (indent 0) (debug t))
1803 (let ((handle (make-symbol "--change-group-handle--"))
1804 (success (make-symbol "--change-group-success--")))
1805 `(let ((,handle (prepare-change-group))
1806 ;; Don't truncate any undo data in the middle of this.
1807 (undo-outer-limit nil)
1808 (undo-limit most-positive-fixnum)
1809 (undo-strong-limit most-positive-fixnum)
1813 ;; This is inside the unwind-protect because
1814 ;; it enables undo if that was disabled; we need
1815 ;; to make sure that it gets disabled again.
1816 (activate-change-group ,handle)
1819 ;; Either of these functions will disable undo
1820 ;; if it was disabled before.
1822 (accept-change-group ,handle)
1823 (cancel-change-group ,handle))))))
1825 (defun prepare-change-group (&optional buffer)
1826 "Return a handle for the current buffer's state, for a change group.
1827 If you specify BUFFER, make a handle for BUFFER's state instead.
1829 Pass the handle to `activate-change-group' afterward to initiate
1830 the actual changes of the change group.
1832 To finish the change group, call either `accept-change-group' or
1833 `cancel-change-group' passing the same handle as argument. Call
1834 `accept-change-group' to accept the changes in the group as final;
1835 call `cancel-change-group' to undo them all. You should use
1836 `unwind-protect' to make sure the group is always finished. The call
1837 to `activate-change-group' should be inside the `unwind-protect'.
1838 Once you finish the group, don't use the handle again--don't try to
1839 finish the same group twice. For a simple example of correct use, see
1840 the source code of `atomic-change-group'.
1842 The handle records only the specified buffer. To make a multibuffer
1843 change group, call this function once for each buffer you want to
1844 cover, then use `nconc' to combine the returned values, like this:
1846 (nconc (prepare-change-group buffer-1)
1847 (prepare-change-group buffer-2))
1849 You can then activate that multibuffer change group with a single
1850 call to `activate-change-group' and finish it with a single call
1851 to `accept-change-group' or `cancel-change-group'."
1854 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
1855 (list (cons (current-buffer) buffer-undo-list))))
1857 (defun activate-change-group (handle)
1858 "Activate a change group made with `prepare-change-group' (which see)."
1859 (dolist (elt handle)
1860 (with-current-buffer (car elt)
1861 (if (eq buffer-undo-list t)
1862 (setq buffer-undo-list nil)))))
1864 (defun accept-change-group (handle)
1865 "Finish a change group made with `prepare-change-group' (which see).
1866 This finishes the change group by accepting its changes as final."
1867 (dolist (elt handle)
1868 (with-current-buffer (car elt)
1870 (setq buffer-undo-list t)))))
1872 (defun cancel-change-group (handle)
1873 "Finish a change group made with `prepare-change-group' (which see).
1874 This finishes the change group by reverting all of its changes."
1875 (dolist (elt handle)
1876 (with-current-buffer (car elt)
1877 (setq elt (cdr elt))
1879 (if (consp elt) (car elt)))
1881 (if (consp elt) (cdr elt))))
1882 ;; Temporarily truncate the undo log at ELT.
1884 (setcar elt nil) (setcdr elt nil))
1885 (unless (eq last-command 'undo) (undo-start))
1886 ;; Make sure there's no confusion.
1887 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
1888 (error "Undoing to some unrelated state"))
1891 (while (listp pending-undo-list) (undo-more 1)))
1892 ;; Reset the modified cons cell ELT to its original content.
1894 (setcar elt old-car)
1895 (setcdr elt old-cdr))
1896 ;; Revert the undo info to what it was when we grabbed the state.
1897 (setq buffer-undo-list elt)))))
1899 ;;;; Display-related functions.
1901 ;; For compatibility.
1902 (defalias 'redraw-modeline 'force-mode-line-update)
1904 (defun force-mode-line-update (&optional all)
1905 "Force redisplay of the current buffer's mode line and header line.
1906 With optional non-nil ALL, force redisplay of all mode lines and
1907 header lines. This function also forces recomputation of the
1908 menu bar menus and the frame title."
1909 (if all (save-excursion (set-buffer (other-buffer))))
1910 (set-buffer-modified-p (buffer-modified-p)))
1912 (defun momentary-string-display (string pos &optional exit-char message)
1913 "Momentarily display STRING in the buffer at POS.
1914 Display remains until next event is input.
1915 If POS is a marker, only its position is used; its buffer is ignored.
1916 Optional third arg EXIT-CHAR can be a character, event or event
1917 description list. EXIT-CHAR defaults to SPC. If the input is
1918 EXIT-CHAR it is swallowed; otherwise it is then available as
1919 input (as a command if nothing else).
1920 Display MESSAGE (optional fourth arg) in the echo area.
1921 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1922 (or exit-char (setq exit-char ?\s))
1923 (let ((inhibit-read-only t)
1924 ;; Don't modify the undo list at all.
1925 (buffer-undo-list t)
1926 (modified (buffer-modified-p))
1927 (name buffer-file-name)
1933 ;; To avoid trouble with out-of-bounds position
1935 ;; defeat file locking... don't try this at home, kids!
1936 (setq buffer-file-name nil)
1937 (insert-before-markers string)
1938 (setq insert-end (point))
1939 ;; If the message end is off screen, recenter now.
1940 (if (< (window-end nil t) insert-end)
1941 (recenter (/ (window-height) 2)))
1942 ;; If that pushed message start off the screen,
1943 ;; scroll to start it at the top of the screen.
1944 (move-to-window-line 0)
1949 (message (or message "Type %s to continue editing.")
1950 (single-key-description exit-char))
1952 (if (integerp exit-char)
1955 (setq char (read-char))
1956 (or (eq char exit-char)
1957 (setq unread-command-events (list char))))
1959 ;; `exit-char' is a character, hence it differs
1960 ;; from char, which is an event.
1961 (setq unread-command-events (list char))))
1962 ;; `exit-char' can be an event, or an event description
1964 (setq char (read-event))
1965 (or (eq char exit-char)
1966 (eq char (event-convert-list exit-char))
1967 (setq unread-command-events (list char))))))
1970 (delete-region pos insert-end)))
1971 (setq buffer-file-name name)
1972 (set-buffer-modified-p modified))))
1975 ;;;; Overlay operations
1977 (defun copy-overlay (o)
1978 "Return a copy of overlay O."
1979 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1980 ;; FIXME: there's no easy way to find the
1981 ;; insertion-type of the two markers.
1982 (overlay-buffer o)))
1983 (props (overlay-properties o)))
1985 (overlay-put o1 (pop props) (pop props)))
1988 (defun remove-overlays (&optional beg end name val)
1989 "Clear BEG and END of overlays whose property NAME has value VAL.
1990 Overlays might be moved and/or split.
1991 BEG and END default respectively to the beginning and end of buffer."
1992 ;; This speeds up the loops over overlays.
1993 (unless beg (setq beg (point-min)))
1994 (unless end (setq end (point-max)))
1995 (overlay-recenter end)
1997 (setq beg (prog1 end (setq end beg))))
1999 (dolist (o (overlays-in beg end))
2000 (when (eq (overlay-get o name) val)
2001 ;; Either push this overlay outside beg...end
2002 ;; or split it to exclude beg...end
2003 ;; or delete it entirely (if it is contained in beg...end).
2004 (if (< (overlay-start o) beg)
2005 (if (> (overlay-end o) end)
2007 (move-overlay (copy-overlay o)
2008 (overlay-start o) beg)
2009 (move-overlay o end (overlay-end o)))
2010 (move-overlay o (overlay-start o) beg))
2011 (if (> (overlay-end o) end)
2012 (move-overlay o end (overlay-end o))
2013 (delete-overlay o)))))))
2017 (defvar suspend-hook nil
2018 "Normal hook run by `suspend-emacs', before suspending.")
2020 (defvar suspend-resume-hook nil
2021 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2023 (defvar temp-buffer-show-hook nil
2024 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2025 When the hook runs, the temporary buffer is current, and the window it
2026 was displayed in is selected. This hook is normally set up with a
2027 function to make the buffer read only, and find function names and
2028 variable names in it, provided the major mode is still Help mode.")
2030 (defvar temp-buffer-setup-hook nil
2031 "Normal hook run by `with-output-to-temp-buffer' at the start.
2032 When the hook runs, the temporary buffer is current.
2033 This hook is normally set up with a function to put the buffer in Help
2036 ;; Avoid compiler warnings about this variable,
2037 ;; which has a special meaning on certain system types.
2038 (defvar buffer-file-type nil
2039 "Non-nil if the visited file is a binary file.
2040 This variable is meaningful on MS-DOG and Windows NT.
2041 On those systems, it is automatically local in every buffer.
2042 On other systems, this variable is normally always nil.")
2044 ;; The `assert' macro from the cl package signals
2045 ;; `cl-assertion-failed' at runtime so always define it.
2046 (put 'cl-assertion-failed 'error-conditions '(error))
2047 (put 'cl-assertion-failed 'error-message "Assertion failed")
2050 ;;;; Misc. useful functions.
2052 (defun find-tag-default ()
2053 "Determine default tag to search for, based on text at point.
2054 If there is no plausible default, return nil."
2056 (while (looking-at "\\sw\\|\\s_")
2058 (if (or (re-search-backward "\\sw\\|\\s_"
2059 (save-excursion (beginning-of-line) (point))
2061 (re-search-forward "\\(\\sw\\|\\s_\\)+"
2062 (save-excursion (end-of-line) (point))
2065 (goto-char (match-end 0))
2067 (buffer-substring-no-properties
2069 (progn (forward-sexp -1)
2070 (while (looking-at "\\s'")
2076 (defun play-sound (sound)
2077 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2078 The following keywords are recognized:
2080 :file FILE - read sound data from FILE. If FILE isn't an
2081 absolute file name, it is searched in `data-directory'.
2083 :data DATA - read sound data from string DATA.
2085 Exactly one of :file or :data must be present.
2087 :volume VOL - set volume to VOL. VOL must an integer in the
2088 range 0..100 or a float in the range 0..1.0. If not specified,
2089 don't change the volume setting of the sound device.
2091 :device DEVICE - play sound on DEVICE. If not specified,
2092 a system-dependent default device name is used."
2093 (if (fboundp 'play-sound-internal)
2094 (play-sound-internal sound)
2095 (error "This Emacs binary lacks sound support")))
2097 (defun shell-quote-argument (argument)
2098 "Quote an argument for passing as argument to an inferior shell."
2099 (if (or (eq system-type 'ms-dos)
2100 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2101 ;; Quote using double quotes, but escape any existing quotes in
2102 ;; the argument with backslashes.
2106 (if (or (null (string-match "[^\"]" argument))
2107 (< (match-end 0) (length argument)))
2108 (while (string-match "[\"]" argument start)
2109 (setq end (match-beginning 0)
2110 result (concat result (substring argument start end)
2111 "\\" (substring argument end (1+ end)))
2113 (concat "\"" result (substring argument start) "\""))
2114 (if (equal argument "")
2116 ;; Quote everything except POSIX filename characters.
2117 ;; This should be safe enough even for really weird shells.
2118 (let ((result "") (start 0) end)
2119 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2120 (setq end (match-beginning 0)
2121 result (concat result (substring argument start end)
2122 "\\" (substring argument end (1+ end)))
2124 (concat result (substring argument start))))))
2126 (defun string-or-null-p (object)
2127 "Return t if OBJECT is a string or nil.
2128 Otherwise, return nil."
2129 (or (stringp object) (null object)))
2131 (defun booleanp (object)
2132 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2133 (memq object '(nil t)))
2135 (defun field-at-pos (pos)
2136 "Return the field at position POS, taking stickiness etc into account"
2137 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2138 (if (eq raw-field 'boundary)
2139 (get-char-property (1- (field-end pos)) 'field)
2143 ;;;; Support for yanking and text properties.
2145 (defvar yank-excluded-properties)
2147 (defun remove-yank-excluded-properties (start end)
2148 "Remove `yank-excluded-properties' between START and END positions.
2149 Replaces `category' properties with their defined properties."
2150 (let ((inhibit-read-only t))
2151 ;; Replace any `category' property with the properties it stands for.
2152 (unless (memq yank-excluded-properties '(t nil))
2155 (while (< (point) end)
2156 (let ((cat (get-text-property (point) 'category))
2159 (next-single-property-change (point) 'category nil end))
2161 (let (run-end2 original)
2162 (remove-list-of-text-properties (point) run-end '(category))
2163 (while (< (point) run-end)
2164 (setq run-end2 (next-property-change (point) nil run-end))
2165 (setq original (text-properties-at (point)))
2166 (set-text-properties (point) run-end2 (symbol-plist cat))
2167 (add-text-properties (point) run-end2 original)
2168 (goto-char run-end2))))
2169 (goto-char run-end)))))
2170 (if (eq yank-excluded-properties t)
2171 (set-text-properties start end nil)
2172 (remove-list-of-text-properties start end yank-excluded-properties))))
2174 (defvar yank-undo-function)
2176 (defun insert-for-yank (string)
2177 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2179 See `insert-for-yank-1' for more details."
2181 (while (setq to (next-single-property-change 0 'yank-handler string))
2182 (insert-for-yank-1 (substring string 0 to))
2183 (setq string (substring string to))))
2184 (insert-for-yank-1 string))
2186 (defun insert-for-yank-1 (string)
2187 "Insert STRING at point, stripping some text properties.
2189 Strip text properties from the inserted text according to
2190 `yank-excluded-properties'. Otherwise just like (insert STRING).
2192 If STRING has a non-nil `yank-handler' property on the first character,
2193 the normal insert behavior is modified in various ways. The value of
2194 the yank-handler property must be a list with one to four elements
2195 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2196 When FUNCTION is present and non-nil, it is called instead of `insert'
2197 to insert the string. FUNCTION takes one argument--the object to insert.
2198 If PARAM is present and non-nil, it replaces STRING as the object
2199 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2200 `yank-rectangle', PARAM may be a list of strings to insert as a
2202 If NOEXCLUDE is present and non-nil, the normal removal of the
2203 yank-excluded-properties is not performed; instead FUNCTION is
2204 responsible for removing those properties. This may be necessary
2205 if FUNCTION adjusts point before or after inserting the object.
2206 If UNDO is present and non-nil, it is a function that will be called
2207 by `yank-pop' to undo the insertion of the current object. It is
2208 called with two arguments, the start and end of the current region.
2209 FUNCTION may set `yank-undo-function' to override the UNDO value."
2210 (let* ((handler (and (stringp string)
2211 (get-text-property 0 'yank-handler string)))
2212 (param (or (nth 1 handler) string))
2214 (inhibit-read-only inhibit-read-only)
2217 (setq yank-undo-function t)
2218 (if (nth 0 handler) ;; FUNCTION
2219 (funcall (car handler) param)
2223 ;; Prevent read-only properties from interfering with the
2224 ;; following text property changes.
2225 (setq inhibit-read-only t)
2227 ;; What should we do with `font-lock-face' properties?
2228 (if font-lock-defaults
2229 ;; No, just wipe them.
2230 (remove-list-of-text-properties opoint end '(font-lock-face))
2231 ;; Convert them to `face'.
2234 (while (< (point) end)
2235 (let ((face (get-text-property (point) 'font-lock-face))
2238 (next-single-property-change (point) 'font-lock-face nil end))
2240 (remove-text-properties (point) run-end '(font-lock-face nil))
2241 (put-text-property (point) run-end 'face face))
2242 (goto-char run-end)))))
2244 (unless (nth 2 handler) ;; NOEXCLUDE
2245 (remove-yank-excluded-properties opoint (point)))
2247 ;; If last inserted char has properties, mark them as rear-nonsticky.
2248 (if (and (> end opoint)
2249 (text-properties-at (1- end)))
2250 (put-text-property (1- end) end 'rear-nonsticky t))
2252 (if (eq yank-undo-function t) ;; not set by FUNCTION
2253 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2254 (if (nth 4 handler) ;; COMMAND
2255 (setq this-command (nth 4 handler)))))
2257 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2258 "Insert before point a substring of BUFFER, without text properties.
2259 BUFFER may be a buffer or a buffer name.
2260 Arguments START and END are character positions specifying the substring.
2261 They default to the values of (point-min) and (point-max) in BUFFER."
2262 (let ((opoint (point)))
2263 (insert-buffer-substring buffer start end)
2264 (let ((inhibit-read-only t))
2265 (set-text-properties opoint (point) nil))))
2267 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2268 "Insert before point a part of BUFFER, stripping some text properties.
2269 BUFFER may be a buffer or a buffer name.
2270 Arguments START and END are character positions specifying the substring.
2271 They default to the values of (point-min) and (point-max) in BUFFER.
2272 Strip text properties from the inserted text according to
2273 `yank-excluded-properties'."
2274 ;; Since the buffer text should not normally have yank-handler properties,
2275 ;; there is no need to handle them here.
2276 (let ((opoint (point)))
2277 (insert-buffer-substring buffer start end)
2278 (remove-yank-excluded-properties opoint (point))))
2281 ;;;; Synchronous shell commands.
2283 (defun start-process-shell-command (name buffer &rest args)
2284 "Start a program in a subprocess. Return the process object for it.
2285 NAME is name for process. It is modified if necessary to make it unique.
2286 BUFFER is the buffer (or buffer name) to associate with the process.
2287 Process output goes at end of that buffer, unless you specify
2288 an output stream or filter function to handle the output.
2289 BUFFER may be also nil, meaning that this process is not associated
2291 COMMAND is the name of a shell command.
2292 Remaining arguments are the arguments for the command; they are all
2293 spliced together with blanks separating between each two of them, before
2294 passing the command to the shell.
2295 Wildcards and redirection are handled as usual in the shell.
2297 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
2299 ((eq system-type 'vax-vms)
2300 (apply 'start-process name buffer args))
2301 ;; We used to use `exec' to replace the shell with the command,
2302 ;; but that failed to handle (...) and semicolon, etc.
2304 (start-process name buffer shell-file-name shell-command-switch
2305 (mapconcat 'identity args " ")))))
2307 (defun call-process-shell-command (command &optional infile buffer display
2309 "Execute the shell command COMMAND synchronously in separate process.
2310 The remaining arguments are optional.
2311 The program's input comes from file INFILE (nil means `/dev/null').
2312 Insert output in BUFFER before point; t means current buffer;
2313 nil for BUFFER means discard it; 0 means discard and don't wait.
2314 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2315 REAL-BUFFER says what to do with standard output, as above,
2316 while STDERR-FILE says what to do with standard error in the child.
2317 STDERR-FILE may be nil (discard standard error output),
2318 t (mix it with ordinary output), or a file name string.
2320 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2321 Remaining arguments are strings passed as additional arguments for COMMAND.
2322 Wildcards and redirection are handled as usual in the shell.
2324 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2325 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2326 status or a signal description string.
2327 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2329 ((eq system-type 'vax-vms)
2330 (apply 'call-process command infile buffer display args))
2331 ;; We used to use `exec' to replace the shell with the command,
2332 ;; but that failed to handle (...) and semicolon, etc.
2334 (call-process shell-file-name
2335 infile buffer display
2336 shell-command-switch
2337 (mapconcat 'identity (cons command args) " ")))))
2339 ;;;; Lisp macros to do various things temporarily.
2341 (defmacro with-current-buffer (buffer &rest body)
2342 "Execute the forms in BODY with BUFFER temporarily current.
2343 BUFFER can be a buffer or a buffer name.
2344 The value returned is the value of the last form in BODY.
2345 See also `with-temp-buffer'."
2346 (declare (indent 1) (debug t))
2347 `(save-current-buffer
2348 (set-buffer ,buffer)
2351 (defmacro with-selected-window (window &rest body)
2352 "Execute the forms in BODY with WINDOW as the selected window.
2353 The value returned is the value of the last form in BODY.
2355 This macro saves and restores the current buffer, since otherwise
2356 its normal operation could potentially make a different
2357 buffer current. It does not alter the buffer list ordering.
2359 This macro saves and restores the selected window, as well as
2360 the selected window in each frame. If the previously selected
2361 window of some frame is no longer live at the end of BODY, that
2362 frame's selected window is left alone. If the selected window is
2363 no longer live, then whatever window is selected at the end of
2364 BODY remains selected.
2365 See also `with-temp-buffer'."
2366 (declare (indent 1) (debug t))
2367 ;; Most of this code is a copy of save-selected-window.
2368 `(let ((save-selected-window-window (selected-window))
2369 ;; It is necessary to save all of these, because calling
2370 ;; select-window changes frame-selected-window for whatever
2371 ;; frame that window is in.
2372 (save-selected-window-alist
2373 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2375 (save-current-buffer
2377 (progn (select-window ,window 'norecord)
2379 (dolist (elt save-selected-window-alist)
2380 (and (frame-live-p (car elt))
2381 (window-live-p (cadr elt))
2382 (set-frame-selected-window (car elt) (cadr elt))))
2383 (if (window-live-p save-selected-window-window)
2384 (select-window save-selected-window-window 'norecord))))))
2386 (defmacro with-temp-file (file &rest body)
2387 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2388 The value returned is the value of the last form in BODY.
2389 See also `with-temp-buffer'."
2391 (let ((temp-file (make-symbol "temp-file"))
2392 (temp-buffer (make-symbol "temp-buffer")))
2393 `(let ((,temp-file ,file)
2395 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2398 (with-current-buffer ,temp-buffer
2400 (with-current-buffer ,temp-buffer
2402 (write-region (point-min) (point-max) ,temp-file nil 0)))
2403 (and (buffer-name ,temp-buffer)
2404 (kill-buffer ,temp-buffer))))))
2406 (defmacro with-temp-message (message &rest body)
2407 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2408 The original message is restored to the echo area after BODY has finished.
2409 The value returned is the value of the last form in BODY.
2410 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2411 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2412 Use a MESSAGE of \"\" to temporarily clear the echo area."
2414 (let ((current-message (make-symbol "current-message"))
2415 (temp-message (make-symbol "with-temp-message")))
2416 `(let ((,temp-message ,message)
2421 (setq ,current-message (current-message))
2422 (message "%s" ,temp-message))
2425 (if ,current-message
2426 (message "%s" ,current-message)
2429 (defmacro with-temp-buffer (&rest body)
2430 "Create a temporary buffer, and evaluate BODY there like `progn'.
2431 See also `with-temp-file' and `with-output-to-string'."
2432 (declare (indent 0) (debug t))
2433 (let ((temp-buffer (make-symbol "temp-buffer")))
2434 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2436 (with-current-buffer ,temp-buffer
2438 (and (buffer-name ,temp-buffer)
2439 (kill-buffer ,temp-buffer))))))
2441 (defmacro with-output-to-string (&rest body)
2442 "Execute BODY, return the text it sent to `standard-output', as a string."
2443 (declare (indent 0) (debug t))
2444 `(let ((standard-output
2445 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2446 (let ((standard-output standard-output))
2448 (with-current-buffer standard-output
2451 (kill-buffer nil)))))
2453 (defmacro with-local-quit (&rest body)
2454 "Execute BODY, allowing quits to terminate BODY but not escape further.
2455 When a quit terminates BODY, `with-local-quit' returns nil but
2456 requests another quit. That quit will be processed as soon as quitting
2457 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2458 (declare (debug t) (indent 0))
2459 `(condition-case nil
2460 (let ((inhibit-quit nil))
2462 (quit (setq quit-flag t)
2463 ;; This call is to give a chance to handle quit-flag
2464 ;; in case inhibit-quit is nil.
2465 ;; Without this, it will not be handled until the next function
2466 ;; call, and that might allow it to exit thru a condition-case
2467 ;; that intends to handle the quit signal next time.
2468 (eval '(ignore nil)))))
2470 (defmacro while-no-input (&rest body)
2471 "Execute BODY only as long as there's no pending input.
2472 If input arrives, that ends the execution of BODY,
2473 and `while-no-input' returns t. Quitting makes it return nil.
2474 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2475 (declare (debug t) (indent 0))
2476 (let ((catch-sym (make-symbol "input")))
2479 (let ((throw-on-input ',catch-sym))
2480 (or (input-pending-p)
2481 (progn ,@body)))))))
2483 (defmacro combine-after-change-calls (&rest body)
2484 "Execute BODY, but don't call the after-change functions till the end.
2485 If BODY makes changes in the buffer, they are recorded
2486 and the functions on `after-change-functions' are called several times
2487 when BODY is finished.
2488 The return value is the value of the last form in BODY.
2490 If `before-change-functions' is non-nil, then calls to the after-change
2491 functions can't be deferred, so in that case this macro has no effect.
2493 Do not alter `after-change-functions' or `before-change-functions'
2495 (declare (indent 0) (debug t))
2497 (let ((combine-after-change-calls t))
2499 (combine-after-change-execute)))
2501 (defmacro with-case-table (table &rest body)
2502 "Execute the forms in BODY with TABLE as the current case table.
2503 The value returned is the value of the last form in BODY."
2504 (declare (indent 1) (debug t))
2505 (let ((old-case-table (make-symbol "table"))
2506 (old-buffer (make-symbol "buffer")))
2507 `(let ((,old-case-table (current-case-table))
2508 (,old-buffer (current-buffer)))
2510 (progn (set-case-table ,table)
2512 (with-current-buffer ,old-buffer
2513 (set-case-table ,old-case-table))))))
2515 ;;;; Constructing completion tables.
2517 (defun complete-with-action (action table string pred)
2518 "Perform completion ACTION.
2519 STRING is the string to complete.
2520 TABLE is the completion table, which should not be a function.
2521 PRED is a completion predicate.
2522 ACTION can be one of nil, t or `lambda'."
2523 ;; (assert (not (functionp table)))
2526 ((null action) 'try-completion)
2527 ((eq action t) 'all-completions)
2528 (t 'test-completion))
2531 (defmacro dynamic-completion-table (fun)
2532 "Use function FUN as a dynamic completion table.
2533 FUN is called with one argument, the string for which completion is required,
2534 and it should return an alist containing all the intended possible
2535 completions. This alist may be a full list of possible completions so that FUN
2536 can ignore the value of its argument. If completion is performed in the
2537 minibuffer, FUN will be called in the buffer from which the minibuffer was
2540 The result of the `dynamic-completion-table' form is a function
2541 that can be used as the ALIST argument to `try-completion' and
2542 `all-completion'. See Info node `(elisp)Programmed Completion'."
2543 (declare (debug (lambda-expr)))
2544 (let ((win (make-symbol "window"))
2545 (string (make-symbol "string"))
2546 (predicate (make-symbol "predicate"))
2547 (mode (make-symbol "mode")))
2548 `(lambda (,string ,predicate ,mode)
2549 (with-current-buffer (let ((,win (minibuffer-selected-window)))
2550 (if (window-live-p ,win) (window-buffer ,win)
2552 (complete-with-action ,mode (,fun ,string) ,string ,predicate)))))
2554 (defmacro lazy-completion-table (var fun)
2555 ;; We used to have `&rest args' where `args' were evaluated late (at the
2556 ;; time of the call to `fun'), which was counter intuitive. But to get
2557 ;; them to be evaluated early, we have to either use lexical-let (which is
2558 ;; not available in subr.el) or use `(lambda (,str) ...) which prevents the use
2559 ;; of lexical-let in the callers.
2560 ;; So we just removed the argument. Callers can then simply use either of:
2561 ;; (lazy-completion-table var (lambda () (fun x y)))
2563 ;; (lazy-completion-table var `(lambda () (fun ',x ',y)))
2565 ;; (lexical-let ((x x)) ((y y))
2566 ;; (lazy-completion-table var (lambda () (fun x y))))
2567 ;; depending on the behavior they want.
2568 "Initialize variable VAR as a lazy completion table.
2569 If the completion table VAR is used for the first time (e.g., by passing VAR
2570 as an argument to `try-completion'), the function FUN is called with no
2571 arguments. FUN must return the completion table that will be stored in VAR.
2572 If completion is requested in the minibuffer, FUN will be called in the buffer
2573 from which the minibuffer was entered. The return value of
2574 `lazy-completion-table' must be used to initialize the value of VAR.
2576 You should give VAR a non-nil `risky-local-variable' property."
2577 (declare (debug (symbol lambda-expr)))
2578 (let ((str (make-symbol "string")))
2579 `(dynamic-completion-table
2581 (when (functionp ,var)
2585 (defmacro complete-in-turn (a b)
2586 "Create a completion table that first tries completion in A and then in B.
2587 A and B should not be costly (or side-effecting) expressions."
2588 (declare (debug (def-form def-form)))
2589 `(lambda (string predicate mode)
2592 (or (all-completions string ,a predicate)
2593 (all-completions string ,b predicate)))
2595 (or (try-completion string ,a predicate)
2596 (try-completion string ,b predicate)))
2598 (or (test-completion string ,a predicate)
2599 (test-completion string ,b predicate))))))
2601 ;;; Matching and match data.
2603 (defvar save-match-data-internal)
2605 ;; We use save-match-data-internal as the local variable because
2606 ;; that works ok in practice (people should not use that variable elsewhere).
2607 ;; We used to use an uninterned symbol; the compiler handles that properly
2608 ;; now, but it generates slower code.
2609 (defmacro save-match-data (&rest body)
2610 "Execute the BODY forms, restoring the global value of the match data.
2611 The value returned is the value of the last form in BODY."
2612 ;; It is better not to use backquote here,
2613 ;; because that makes a bootstrapping problem
2614 ;; if you need to recompile all the Lisp files using interpreted code.
2615 (declare (indent 0) (debug t))
2617 '((save-match-data-internal (match-data)))
2618 (list 'unwind-protect
2620 ;; It is safe to free (evaporate) markers immediately here,
2621 ;; as Lisp programs should not copy from save-match-data-internal.
2622 '(set-match-data save-match-data-internal 'evaporate))))
2624 (defun match-string (num &optional string)
2625 "Return string of text matched by last search.
2626 NUM specifies which parenthesized expression in the last regexp.
2627 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2628 Zero means the entire text matched by the whole regexp or whole string.
2629 STRING should be given if the last search was by `string-match' on STRING."
2630 (if (match-beginning num)
2632 (substring string (match-beginning num) (match-end num))
2633 (buffer-substring (match-beginning num) (match-end num)))))
2635 (defun match-string-no-properties (num &optional string)
2636 "Return string of text matched by last search, without text properties.
2637 NUM specifies which parenthesized expression in the last regexp.
2638 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2639 Zero means the entire text matched by the whole regexp or whole string.
2640 STRING should be given if the last search was by `string-match' on STRING."
2641 (if (match-beginning num)
2643 (substring-no-properties string (match-beginning num)
2645 (buffer-substring-no-properties (match-beginning num)
2648 (defun looking-back (regexp &optional limit greedy)
2649 "Return non-nil if text before point matches regular expression REGEXP.
2650 Like `looking-at' except matches before point, and is slower.
2651 LIMIT if non-nil speeds up the search by specifying a minimum
2652 starting position, to avoid checking matches that would start
2655 If GREEDY is non-nil, extend the match backwards as far as possible,
2656 stopping when a single additional previous character cannot be part
2657 of a match for REGEXP."
2658 (let ((start (point))
2661 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2663 (if (and greedy pos)
2665 (narrow-to-region (point-min) start)
2666 (while (and (> pos (point-min))
2670 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2671 (setq pos (1- pos)))
2674 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2677 (defun subregexp-context-p (regexp pos &optional start)
2678 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2679 A subregexp context is one where a sub-regexp can appear.
2680 A non-subregexp context is for example within brackets, or within a
2681 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2682 If START is non-nil, it should be a position in REGEXP, smaller
2683 than POS, and known to be in a subregexp context."
2684 ;; Here's one possible implementation, with the great benefit that it
2685 ;; reuses the regexp-matcher's own parser, so it understands all the
2686 ;; details of the syntax. A disadvantage is that it needs to match the
2690 (string-match (substring regexp (or start 0) pos) "")
2693 (not (member (cadr err) '("Unmatched [ or [^"
2695 "Trailing backslash")))))
2696 ;; An alternative implementation:
2697 ;; (defconst re-context-re
2698 ;; (let* ((harmless-ch "[^\\[]")
2699 ;; (harmless-esc "\\\\[^{]")
2700 ;; (class-harmless-ch "[^][]")
2701 ;; (class-lb-harmless "[^]:]")
2702 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2703 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2704 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2706 ;; (concat "\\[^?]?"
2707 ;; "\\(" class-harmless-ch
2708 ;; "\\|" class-lb "\\)*"
2709 ;; "\\[?]")) ; special handling for bare [ at end of re
2710 ;; (braces "\\\\{[0-9,]+\\\\}"))
2711 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2712 ;; "\\|" class "\\|" braces "\\)*\\'"))
2713 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2714 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2719 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2720 "The default value of separators for `split-string'.
2722 A regexp matching strings of whitespace. May be locale-dependent
2723 \(as yet unimplemented). Should not match non-breaking spaces.
2725 Warning: binding this to a different value and using it as default is
2726 likely to have undesired semantics.")
2728 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2729 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2730 ;; expression leads to the equivalent implementation that if SEPARATORS
2731 ;; is defaulted, OMIT-NULLS is treated as t.
2732 (defun split-string (string &optional separators omit-nulls)
2733 "Split STRING into substrings bounded by matches for SEPARATORS.
2735 The beginning and end of STRING, and each match for SEPARATORS, are
2736 splitting points. The substrings matching SEPARATORS are removed, and
2737 the substrings between the splitting points are collected as a list,
2740 If SEPARATORS is non-nil, it should be a regular expression matching text
2741 which separates, but is not part of, the substrings. If nil it defaults to
2742 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2743 OMIT-NULLS is forced to t.
2745 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2746 that for the default value of SEPARATORS leading and trailing whitespace
2747 are effectively trimmed). If nil, all zero-length substrings are retained,
2748 which correctly parses CSV format, for example.
2750 Note that the effect of `(split-string STRING)' is the same as
2751 `(split-string STRING split-string-default-separators t)'. In the rare
2752 case that you wish to retain zero-length substrings when splitting on
2753 whitespace, use `(split-string STRING split-string-default-separators)'.
2755 Modifies the match data; use `save-match-data' if necessary."
2756 (let ((keep-nulls (not (if separators omit-nulls t)))
2757 (rexp (or separators split-string-default-separators))
2761 (while (and (string-match rexp string
2763 (= start (match-beginning 0))
2764 (< start (length string)))
2766 (< start (length string)))
2768 (if (or keep-nulls (< start (match-beginning 0)))
2770 (cons (substring string start (match-beginning 0))
2772 (setq start (match-end 0)))
2773 (if (or keep-nulls (< start (length string)))
2775 (cons (substring string start)
2779 (defun combine-and-quote-strings (strings &optional separator)
2780 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
2781 This tries to quote the strings to avoid ambiguity such that
2782 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2783 Only some SEPARATORs will work properly."
2784 (let ((sep (or separator " ")))
2787 (if (string-match "[\\\"]" str)
2788 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
2792 (defun split-string-and-unquote (string &optional separator)
2793 "Split the STRING into a list of strings.
2794 It understands Emacs Lisp quoting within STRING, such that
2795 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
2796 The SEPARATOR regexp defaults to \"\\s-+\"."
2797 (let ((sep (or separator "\\s-+"))
2798 (i (string-match "[\"]" string)))
2800 (split-string string sep t) ; no quoting: easy
2801 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
2802 (let ((rfs (read-from-string string i)))
2804 (split-string-and-unquote (substring string (cdr rfs))
2808 ;;;; Replacement in strings.
2810 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2811 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2812 Unless optional argument INPLACE is non-nil, return a new string."
2813 (let ((i (length string))
2814 (newstr (if inplace string (copy-sequence string))))
2817 (if (eq (aref newstr i) fromchar)
2818 (aset newstr i tochar)))
2821 (defun replace-regexp-in-string (regexp rep string &optional
2822 fixedcase literal subexp start)
2823 "Replace all matches for REGEXP with REP in STRING.
2825 Return a new string containing the replacements.
2827 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2828 arguments with the same names of function `replace-match'. If START
2829 is non-nil, start replacements at that index in STRING.
2831 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2832 function. If it is a function, it is called with the actual text of each
2833 match, and its value is used as the replacement text. When REP is called,
2834 the match-data are the result of matching REGEXP against a substring
2837 To replace only the first match (if any), make REGEXP match up to \\'
2838 and replace a sub-expression, e.g.
2839 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2843 ;; To avoid excessive consing from multiple matches in long strings,
2844 ;; don't just call `replace-match' continually. Walk down the
2845 ;; string looking for matches of REGEXP and building up a (reversed)
2846 ;; list MATCHES. This comprises segments of STRING which weren't
2847 ;; matched interspersed with replacements for segments that were.
2848 ;; [For a `large' number of replacements it's more efficient to
2849 ;; operate in a temporary buffer; we can't tell from the function's
2850 ;; args whether to choose the buffer-based implementation, though it
2851 ;; might be reasonable to do so for long enough STRING.]
2852 (let ((l (length string))
2853 (start (or start 0))
2856 (while (and (< start l) (string-match regexp string start))
2857 (setq mb (match-beginning 0)
2859 ;; If we matched the empty string, make sure we advance by one char
2860 (when (= me mb) (setq me (min l (1+ mb))))
2861 ;; Generate a replacement for the matched substring.
2862 ;; Operate only on the substring to minimize string consing.
2863 ;; Set up match data for the substring for replacement;
2864 ;; presumably this is likely to be faster than munging the
2865 ;; match data directly in Lisp.
2866 (string-match regexp (setq str (substring string mb me)))
2868 (cons (replace-match (if (stringp rep)
2870 (funcall rep (match-string 0 str)))
2871 fixedcase literal str subexp)
2872 (cons (substring string start mb) ; unmatched prefix
2875 ;; Reconstruct a string from the pieces.
2876 (setq matches (cons (substring string start l) matches)) ; leftover
2877 (apply #'concat (nreverse matches)))))
2879 ;;;; invisibility specs
2881 (defun add-to-invisibility-spec (element)
2882 "Add ELEMENT to `buffer-invisibility-spec'.
2883 See documentation for `buffer-invisibility-spec' for the kind of elements
2885 (if (eq buffer-invisibility-spec t)
2886 (setq buffer-invisibility-spec (list t)))
2887 (setq buffer-invisibility-spec
2888 (cons element buffer-invisibility-spec)))
2890 (defun remove-from-invisibility-spec (element)
2891 "Remove ELEMENT from `buffer-invisibility-spec'."
2892 (if (consp buffer-invisibility-spec)
2893 (setq buffer-invisibility-spec
2894 (delete element buffer-invisibility-spec))))
2898 (defmacro with-syntax-table (table &rest body)
2899 "Evaluate BODY with syntax table of current buffer set to TABLE.
2900 The syntax table of the current buffer is saved, BODY is evaluated, and the
2901 saved table is restored, even in case of an abnormal exit.
2902 Value is what BODY returns."
2904 (let ((old-table (make-symbol "table"))
2905 (old-buffer (make-symbol "buffer")))
2906 `(let ((,old-table (syntax-table))
2907 (,old-buffer (current-buffer)))
2910 (set-syntax-table ,table)
2912 (save-current-buffer
2913 (set-buffer ,old-buffer)
2914 (set-syntax-table ,old-table))))))
2916 (defun make-syntax-table (&optional oldtable)
2917 "Return a new syntax table.
2918 Create a syntax table which inherits from OLDTABLE (if non-nil) or
2919 from `standard-syntax-table' otherwise."
2920 (let ((table (make-char-table 'syntax-table nil)))
2921 (set-char-table-parent table (or oldtable (standard-syntax-table)))
2924 (defun syntax-after (pos)
2925 "Return the raw syntax of the char after POS.
2926 If POS is outside the buffer's accessible portion, return nil."
2927 (unless (or (< pos (point-min)) (>= pos (point-max)))
2928 (let ((st (if parse-sexp-lookup-properties
2929 (get-char-property pos 'syntax-table))))
2931 (aref (or st (syntax-table)) (char-after pos))))))
2933 (defun syntax-class (syntax)
2934 "Return the syntax class part of the syntax descriptor SYNTAX.
2935 If SYNTAX is nil, return nil."
2936 (and syntax (logand (car syntax) 65535)))
2940 (defun text-clone-maintain (ol1 after beg end &optional len)
2941 "Propagate the changes made under the overlay OL1 to the other clones.
2942 This is used on the `modification-hooks' property of text clones."
2943 (when (and after (not undo-in-progress) (overlay-start ol1))
2944 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
2945 (setq beg (max beg (+ (overlay-start ol1) margin)))
2946 (setq end (min end (- (overlay-end ol1) margin)))
2949 (when (overlay-get ol1 'text-clone-syntax)
2950 ;; Check content of the clone's text.
2951 (let ((cbeg (+ (overlay-start ol1) margin))
2952 (cend (- (overlay-end ol1) margin)))
2955 (if (not (re-search-forward
2956 (overlay-get ol1 'text-clone-syntax) cend t))
2957 ;; Mark the overlay for deletion.
2958 (overlay-put ol1 'text-clones nil)
2959 (when (< (match-end 0) cend)
2960 ;; Shrink the clone at its end.
2961 (setq end (min end (match-end 0)))
2962 (move-overlay ol1 (overlay-start ol1)
2963 (+ (match-end 0) margin)))
2964 (when (> (match-beginning 0) cbeg)
2965 ;; Shrink the clone at its beginning.
2966 (setq beg (max (match-beginning 0) beg))
2967 (move-overlay ol1 (- (match-beginning 0) margin)
2968 (overlay-end ol1)))))))
2969 ;; Now go ahead and update the clones.
2970 (let ((head (- beg (overlay-start ol1)))
2971 (tail (- (overlay-end ol1) end))
2972 (str (buffer-substring beg end))
2974 (inhibit-modification-hooks t))
2975 (dolist (ol2 (overlay-get ol1 'text-clones))
2976 (let ((oe (overlay-end ol2)))
2977 (unless (or (eq ol1 ol2) (null oe))
2978 (setq nothing-left nil)
2979 (let ((mod-beg (+ (overlay-start ol2) head)))
2980 ;;(overlay-put ol2 'modification-hooks nil)
2981 (goto-char (- (overlay-end ol2) tail))
2982 (unless (> mod-beg (point))
2983 (save-excursion (insert str))
2984 (delete-region mod-beg (point)))
2985 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
2987 (if nothing-left (delete-overlay ol1))))))))
2989 (defun text-clone-create (start end &optional spreadp syntax)
2990 "Create a text clone of START...END at point.
2991 Text clones are chunks of text that are automatically kept identical:
2992 changes done to one of the clones will be immediately propagated to the other.
2994 The buffer's content at point is assumed to be already identical to
2995 the one between START and END.
2996 If SYNTAX is provided it's a regexp that describes the possible text of
2997 the clones; the clone will be shrunk or killed if necessary to ensure that
2998 its text matches the regexp.
2999 If SPREADP is non-nil it indicates that text inserted before/after the
3000 clone should be incorporated in the clone."
3001 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3002 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3003 ;; (with a one-char margin at each end) with `t nil'.
3004 ;; We opted for a larger overlay because it behaves better in the case
3005 ;; where the clone is reduced to the empty string (we want the overlay to
3006 ;; stay when the clone's content is the empty string and we want to use
3007 ;; `evaporate' to make sure those overlays get deleted when needed).
3009 (let* ((pt-end (+ (point) (- end start)))
3010 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3012 (end-margin (if (or (not spreadp)
3013 (>= pt-end (point-max))
3014 (>= start (point-max)))
3016 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3017 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3018 (dups (list ol1 ol2)))
3019 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3020 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3021 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3022 ;;(overlay-put ol1 'face 'underline)
3023 (overlay-put ol1 'evaporate t)
3024 (overlay-put ol1 'text-clones dups)
3026 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3027 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3028 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3029 ;;(overlay-put ol2 'face 'underline)
3030 (overlay-put ol2 'evaporate t)
3031 (overlay-put ol2 'text-clones dups)))
3033 ;;;; Mail user agents.
3035 ;; Here we include just enough for other packages to be able
3038 (defun define-mail-user-agent (symbol composefunc sendfunc
3039 &optional abortfunc hookvar)
3040 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3042 SYMBOL can be any Lisp symbol. Its function definition and/or
3043 value as a variable do not matter for this usage; we use only certain
3044 properties on its property list, to encode the rest of the arguments.
3046 COMPOSEFUNC is program callable function that composes an outgoing
3047 mail message buffer. This function should set up the basics of the
3048 buffer without requiring user interaction. It should populate the
3049 standard mail headers, leaving the `to:' and `subject:' headers blank
3052 COMPOSEFUNC should accept several optional arguments--the same
3053 arguments that `compose-mail' takes. See that function's documentation.
3055 SENDFUNC is the command a user would run to send the message.
3057 Optional ABORTFUNC is the command a user would run to abort the
3058 message. For mail packages that don't have a separate abort function,
3059 this can be `kill-buffer' (the equivalent of omitting this argument).
3061 Optional HOOKVAR is a hook variable that gets run before the message
3062 is actually sent. Callers that use the `mail-user-agent' may
3063 install a hook function temporarily on this hook variable.
3064 If HOOKVAR is nil, `mail-send-hook' is used.
3066 The properties used on SYMBOL are `composefunc', `sendfunc',
3067 `abortfunc', and `hookvar'."
3068 (put symbol 'composefunc composefunc)
3069 (put symbol 'sendfunc sendfunc)
3070 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3071 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3073 ;;;; Progress reporters.
3075 ;; Progress reporter has the following structure:
3077 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3084 ;; This weirdeness is for optimization reasons: we want
3085 ;; `progress-reporter-update' to be as fast as possible, so
3086 ;; `(car reporter)' is better than `(aref reporter 0)'.
3088 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3089 ;; digits of precision, it doesn't really matter here. On the other
3090 ;; hand, it greatly simplifies the code.
3092 (defsubst progress-reporter-update (reporter value)
3093 "Report progress of an operation in the echo area.
3094 However, if the change since last echo area update is too small
3095 or not enough time has passed, then do nothing (see
3096 `make-progress-reporter' for details).
3098 First parameter, REPORTER, should be the result of a call to
3099 `make-progress-reporter'. Second, VALUE, determines the actual
3100 progress of operation; it must be between MIN-VALUE and MAX-VALUE
3101 as passed to `make-progress-reporter'.
3103 This function is very inexpensive, you may not bother how often
3105 (when (>= value (car reporter))
3106 (progress-reporter-do-update reporter value)))
3108 (defun make-progress-reporter (message min-value max-value
3109 &optional current-value
3110 min-change min-time)
3111 "Return progress reporter object to be used with `progress-reporter-update'.
3113 MESSAGE is shown in the echo area. When at least 1% of operation
3114 is complete, the exact percentage will be appended to the
3115 MESSAGE. When you call `progress-reporter-done', word \"done\"
3116 is printed after the MESSAGE. You can change MESSAGE of an
3117 existing progress reporter with `progress-reporter-force-update'.
3119 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
3120 final (100% complete) states of operation. The latter should be
3121 larger; if this is not the case, then simply negate all values.
3122 Optional CURRENT-VALUE specifies the progress by the moment you
3123 call this function. You should omit it or set it to nil in most
3124 cases since it defaults to MIN-VALUE.
3126 Optional MIN-CHANGE determines the minimal change in percents to
3127 report (default is 1%.) Optional MIN-TIME specifies the minimal
3128 time before echo area updates (default is 0.2 seconds.) If
3129 `float-time' function is not present, then time is not tracked
3130 at all. If OS is not capable of measuring fractions of seconds,
3131 then this parameter is effectively rounded up."
3134 (setq min-time 0.2))
3136 (cons min-value ;; Force a call to `message' now
3137 (vector (if (and (fboundp 'float-time)
3143 (if min-change (max (min min-change 50) 1) 1)
3145 (progress-reporter-update reporter (or current-value min-value))
3148 (defun progress-reporter-force-update (reporter value &optional new-message)
3149 "Report progress of an operation in the echo area unconditionally.
3151 First two parameters are the same as for
3152 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
3153 change the displayed message."
3154 (let ((parameters (cdr reporter)))
3156 (aset parameters 3 new-message))
3157 (when (aref parameters 0)
3158 (aset parameters 0 (float-time)))
3159 (progress-reporter-do-update reporter value)))
3161 (defun progress-reporter-do-update (reporter value)
3162 (let* ((parameters (cdr reporter))
3163 (min-value (aref parameters 1))
3164 (max-value (aref parameters 2))
3165 (one-percent (/ (- max-value min-value) 100.0))
3166 (percentage (if (= max-value min-value)
3168 (truncate (/ (- value min-value) one-percent))))
3169 (update-time (aref parameters 0))
3170 (current-time (float-time))
3172 ;; See if enough time has passed since the last update.
3173 (or (not update-time)
3174 (when (>= current-time update-time)
3175 ;; Calculate time for the next update
3176 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3178 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
3179 ;; message this time because not enough time has passed, then use
3180 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
3181 ;; updates closer to MIN-TIME.
3183 (min (+ min-value (* (+ percentage
3184 (if enough-time-passed
3185 (aref parameters 4) ;; MIN-CHANGE
3189 (when (integerp value)
3190 (setcar reporter (ceiling (car reporter))))
3192 ;; Only print message if enough time has passed
3193 (when enough-time-passed
3194 (if (> percentage 0)
3195 (message "%s%d%%" (aref parameters 3) percentage)
3196 (message "%s" (aref parameters 3))))))
3198 (defun progress-reporter-done (reporter)
3199 "Print reporter's message followed by word \"done\" in echo area."
3200 (message "%sdone" (aref (cdr reporter) 3)))
3202 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3203 "Loop a certain number of times and report progress in the echo area.
3204 Evaluate BODY with VAR bound to successive integers running from
3205 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3206 the return value (nil if RESULT is omitted).
3208 At each iteration MESSAGE followed by progress percentage is
3209 printed in the echo area. After the loop is finished, MESSAGE
3210 followed by word \"done\" is printed. This macro is a
3211 convenience wrapper around `make-progress-reporter' and friends.
3213 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3214 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3215 (let ((temp (make-symbol "--dotimes-temp--"))
3216 (temp2 (make-symbol "--dotimes-temp2--"))
3220 (,(car spec) ,start)
3221 (,temp2 (make-progress-reporter ,message ,start ,end)))
3222 (while (< ,(car spec) ,temp)
3224 (progress-reporter-update ,temp2
3225 (setq ,(car spec) (1+ ,(car spec)))))
3226 (progress-reporter-done ,temp2)
3227 nil ,@(cdr (cdr spec)))))
3230 ;;;; Comparing version strings.
3232 (defvar version-separator "."
3233 "*Specify the string used to separate the version elements.
3235 Usually the separator is \".\", but it can be any other string.")
3238 (defvar version-regexp-alist
3239 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3240 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3241 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3242 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3243 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3244 "*Specify association between non-numeric version part and a priority.
3246 This association is used to handle version string like \"1.0pre2\",
3247 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3248 non-numeric part to an integer. For example:
3250 String Version Integer List Version
3251 \"1.0pre2\" (1 0 -1 2)
3252 \"1.0PRE2\" (1 0 -1 2)
3253 \"22.8beta3\" (22 8 -2 3)
3254 \"22.8 Beta3\" (22 8 -2 3)
3255 \"0.9alpha1\" (0 9 -3 1)
3256 \"0.9AlphA1\" (0 9 -3 1)
3257 \"0.9 alpha\" (0 9 -3)
3259 Each element has the following form:
3265 REGEXP regexp used to match non-numeric part of a version string.
3266 It should begin with a `^' anchor and end with a `$' to
3267 prevent false hits. Letter-case is ignored while matching
3270 PRIORITY negative integer which indicate the non-numeric priority.")
3273 (defun version-to-list (ver)
3274 "Convert version string VER into an integer list.
3276 The version syntax is given by the following EBNF:
3278 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3280 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3282 SEPARATOR ::= `version-separator' (which see)
3283 | `version-regexp-alist' (which see).
3285 The NUMBER part is optional if SEPARATOR is a match for an element
3286 in `version-regexp-alist'.
3288 As an example of valid version syntax:
3290 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3292 As an example of invalid version syntax:
3294 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3296 As an example of version convertion:
3298 String Version Integer List Version
3299 \"1.0.7.5\" (1 0 7 5)
3300 \"1.0pre2\" (1 0 -1 2)
3301 \"1.0PRE2\" (1 0 -1 2)
3302 \"22.8beta3\" (22 8 -2 3)
3303 \"22.8Beta3\" (22 8 -2 3)
3304 \"0.9alpha1\" (0 9 -3 1)
3305 \"0.9AlphA1\" (0 9 -3 1)
3306 \"0.9alpha\" (0 9 -3)
3308 See documentation for `version-separator' and `version-regexp-alist'."
3309 (or (and (stringp ver) (> (length ver) 0))
3310 (error "Invalid version string: '%s'" ver))
3311 ;; Change .x.y to 0.x.y
3312 (if (and (>= (length ver) (length version-separator))
3313 (string-equal (substring ver 0 (length version-separator))
3315 (setq ver (concat "0" ver)))
3318 (case-fold-search t) ; ignore case in matching
3320 (while (and (setq s (string-match "[0-9]+" ver i))
3322 ;; handle numeric part
3323 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3326 ;; handle non-numeric part
3327 (when (and (setq s (string-match "[^0-9]+" ver i))
3329 (setq s (substring ver i (match-end 0))
3331 ;; handle alpha, beta, pre, etc. separator
3332 (unless (string= s version-separator)
3333 (setq al version-regexp-alist)
3334 (while (and al (not (string-match (caar al) s)))
3336 (or al (error "Invalid version syntax: '%s'" ver))
3337 (setq lst (cons (cdar al) lst)))))
3339 (error "Invalid version syntax: '%s'" ver)
3343 (defun version-list-< (l1 l2)
3344 "Return t if integer list L1 is lesser than L2.
3346 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3347 etc. That is, the trailing zeroes are irrelevant. Also, integer
3348 list (1) is greater than (1 -1) which is greater than (1 -2)
3349 which is greater than (1 -3)."
3350 (while (and l1 l2 (= (car l1) (car l2)))
3354 ;; l1 not null and l2 not null
3355 ((and l1 l2) (< (car l1) (car l2)))
3356 ;; l1 null and l2 null ==> l1 length = l2 length
3357 ((and (null l1) (null l2)) nil)
3358 ;; l1 not null and l2 null ==> l1 length > l2 length
3359 (l1 (< (version-list-not-zero l1) 0))
3360 ;; l1 null and l2 not null ==> l2 length > l1 length
3361 (t (< 0 (version-list-not-zero l2)))))
3364 (defun version-list-= (l1 l2)
3365 "Return t if integer list L1 is equal to L2.
3367 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3368 etc. That is, the trailing zeroes are irrelevant. Also, integer
3369 list (1) is greater than (1 -1) which is greater than (1 -2)
3370 which is greater than (1 -3)."
3371 (while (and l1 l2 (= (car l1) (car l2)))
3375 ;; l1 not null and l2 not null
3377 ;; l1 null and l2 null ==> l1 length = l2 length
3378 ((and (null l1) (null l2)))
3379 ;; l1 not null and l2 null ==> l1 length > l2 length
3380 (l1 (zerop (version-list-not-zero l1)))
3381 ;; l1 null and l2 not null ==> l2 length > l1 length
3382 (t (zerop (version-list-not-zero l2)))))
3385 (defun version-list-<= (l1 l2)
3386 "Return t if integer list L1 is lesser than or equal to L2.
3388 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3389 etc. That is, the trailing zeroes are irrelevant. Also, integer
3390 list (1) is greater than (1 -1) which is greater than (1 -2)
3391 which is greater than (1 -3)."
3392 (while (and l1 l2 (= (car l1) (car l2)))
3396 ;; l1 not null and l2 not null
3397 ((and l1 l2) (< (car l1) (car l2)))
3398 ;; l1 null and l2 null ==> l1 length = l2 length
3399 ((and (null l1) (null l2)))
3400 ;; l1 not null and l2 null ==> l1 length > l2 length
3401 (l1 (<= (version-list-not-zero l1) 0))
3402 ;; l1 null and l2 not null ==> l2 length > l1 length
3403 (t (<= 0 (version-list-not-zero l2)))))
3405 (defun version-list-not-zero (lst)
3406 "Return the first non-zero element of integer list LST.
3408 If all LST elements are zeroes or LST is nil, return zero."
3409 (while (and lst (zerop (car lst)))
3410 (setq lst (cdr lst)))
3413 ;; there is no element different of zero
3417 (defun version< (v1 v2)
3418 "Return t if version V1 is lesser than V2.
3420 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3421 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3422 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3424 (version-list-< (version-to-list v1) (version-to-list v2)))
3427 (defun version<= (v1 v2)
3428 "Return t if version V1 is lesser than or equal to V2.
3430 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3431 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3432 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3434 (version-list-<= (version-to-list v1) (version-to-list v2)))
3436 (defun version= (v1 v2)
3437 "Return t if version V1 is equal to V2.
3439 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3440 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3441 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3443 (version-list-= (version-to-list v1) (version-to-list v2)))
3447 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3448 ;;; subr.el ends here