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 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 2, 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 (declare (indent 1) (debug t
))
104 (list 'if cond
(cons 'progn body
)))
106 (defmacro unless
(cond &rest body
)
107 "If COND yields nil, do BODY, else return nil."
108 (declare (indent 1) (debug t
))
109 (cons 'if
(cons cond
(cons nil body
))))
111 (defvar --dolist-tail-- nil
112 "Temporary variable used in `dolist' expansion.")
114 (defmacro dolist
(spec &rest body
)
116 Evaluate BODY with VAR bound to each car from LIST, in turn.
117 Then evaluate RESULT to get return value, default nil.
119 \(fn (VAR LIST [RESULT]) BODY...)"
120 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
121 ;; It would be cleaner to create an uninterned symbol,
122 ;; but that uses a lot more space when many functions in many files
124 (let ((temp '--dolist-tail--
))
125 `(let ((,temp
,(nth 1 spec
))
128 (setq ,(car spec
) (car ,temp
))
130 (setq ,temp
(cdr ,temp
)))
131 ,@(if (cdr (cdr spec
))
132 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
)))))))
134 (defvar --dotimes-limit-- nil
135 "Temporary variable used in `dotimes' expansion.")
137 (defmacro dotimes
(spec &rest body
)
138 "Loop a certain number of times.
139 Evaluate BODY with VAR bound to successive integers running from 0,
140 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
141 the return value (nil if RESULT is omitted).
143 \(fn (VAR COUNT [RESULT]) BODY...)"
144 (declare (indent 1) (debug dolist
))
145 ;; It would be cleaner to create an uninterned symbol,
146 ;; but that uses a lot more space when many functions in many files
148 (let ((temp '--dotimes-limit--
)
152 (,(car spec
) ,start
))
153 (while (< ,(car spec
) ,temp
)
155 (setq ,(car spec
) (1+ ,(car spec
))))
156 ,@(cdr (cdr spec
)))))
158 (defmacro declare
(&rest specs
)
159 "Do not evaluate any arguments and return nil.
160 Treated as a declaration when used at the right place in a
161 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
164 ;;;; Basic Lisp functions.
166 (defun ignore (&rest ignore
)
167 "Do nothing and return nil.
168 This function accepts any number of arguments, but ignores them."
172 (defun error (&rest args
)
173 "Signal an error, making error message by passing all args to `format'.
174 In Emacs, the convention is that error messages start with a capital
175 letter but *do not* end with a period. Please follow this convention
176 for the sake of consistency."
178 (signal 'error
(list (apply 'format args
)))))
180 ;; We put this here instead of in frame.el so that it's defined even on
181 ;; systems where frame.el isn't loaded.
182 (defun frame-configuration-p (object)
183 "Return non-nil if OBJECT seems to be a frame configuration.
184 Any list whose car is `frame-configuration' is assumed to be a frame
187 (eq (car object
) 'frame-configuration
)))
189 (defun functionp (object)
190 "Non-nil if OBJECT is any kind of function or a special form.
191 Also non-nil if OBJECT is a symbol and its function definition is
192 \(recursively) a function or special form. This does not include
194 (or (and (symbolp object
) (fboundp object
)
196 (setq object
(indirect-function object
))
198 (eq (car-safe object
) 'autoload
)
199 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object
)))))))
200 (subrp object
) (byte-code-function-p object
)
201 (eq (car-safe object
) 'lambda
)))
206 "Return the car of the car of X."
210 "Return the car of the cdr of X."
214 "Return the cdr of the car of X."
218 "Return the cdr of the cdr of X."
221 (defun last (list &optional n
)
222 "Return the last link of LIST. Its car is the last element.
223 If LIST is nil, return nil.
224 If N is non-nil, return the Nth-to-last link of LIST.
225 If N is bigger than the length of LIST, return LIST."
227 (let ((m 0) (p list
))
229 (setq m
(1+ m
) p
(cdr p
)))
231 (if (< n m
) (nthcdr (- m n
) list
) list
)))
232 (while (consp (cdr list
))
233 (setq list
(cdr list
)))
236 (defun butlast (list &optional n
)
237 "Return a copy of LIST with the last N elements removed."
238 (if (and n
(<= n
0)) list
239 (nbutlast (copy-sequence list
) n
)))
241 (defun nbutlast (list &optional n
)
242 "Modifies LIST to remove the last N elements."
243 (let ((m (length list
)))
247 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
250 (defun delete-dups (list)
251 "Destructively remove `equal' duplicates from LIST.
252 Store the result in LIST and return it. LIST must be a proper list.
253 Of several `equal' occurrences of an element in LIST, the first
257 (setcdr tail
(delete (car tail
) (cdr tail
)))
258 (setq tail
(cdr tail
))))
261 (defun number-sequence (from &optional to inc
)
262 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
263 INC is the increment used between numbers in the sequence and defaults to 1.
264 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
265 zero. TO is only included if there is an N for which TO = FROM + N * INC.
266 If TO is nil or numerically equal to FROM, return \(FROM).
267 If INC is positive and TO is less than FROM, or INC is negative
268 and TO is larger than FROM, return nil.
269 If INC is zero and TO is neither nil nor numerically equal to
270 FROM, signal an error.
272 This function is primarily designed for integer arguments.
273 Nevertheless, FROM, TO and INC can be integer or float. However,
274 floating point arithmetic is inexact. For instance, depending on
275 the machine, it may quite well happen that
276 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
277 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
278 elements. Thus, if some of the arguments are floats and one wants
279 to make sure that TO is included, one may have to explicitly write
280 TO as \(+ FROM \(* N INC)) or use a variable whose value was
281 computed with this exact expression. Alternatively, you can,
282 of course, also replace TO with a slightly larger value
283 \(or a slightly more negative value if INC is negative)."
284 (if (or (not to
) (= from to
))
286 (or inc
(setq inc
1))
287 (when (zerop inc
) (error "The increment can not be zero"))
288 (let (seq (n 0) (next from
))
291 (setq seq
(cons next seq
)
293 next
(+ from
(* n inc
))))
295 (setq seq
(cons next seq
)
297 next
(+ from
(* n inc
)))))
300 (defun copy-tree (tree &optional vecp
)
301 "Make a copy of TREE.
302 If TREE is a cons cell, this recursively copies both its car and its cdr.
303 Contrast to `copy-sequence', which copies only along the cdrs. With second
304 argument VECP, this copies vectors as well as conses."
308 (let ((newcar (car tree
)))
309 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
310 (setq newcar
(copy-tree (car tree
) vecp
)))
311 (push newcar result
))
312 (setq tree
(cdr tree
)))
313 (nconc (nreverse result
) tree
))
314 (if (and vecp
(vectorp tree
))
315 (let ((i (length (setq tree
(copy-sequence tree
)))))
316 (while (>= (setq i
(1- i
)) 0)
317 (aset tree i
(copy-tree (aref tree i
) vecp
)))
321 ;;;; Various list-search functions.
323 (defun assoc-default (key alist
&optional test default
)
324 "Find object KEY in a pseudo-alist ALIST.
325 ALIST is a list of conses or objects. Each element (or the element's car,
326 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
327 If that is non-nil, the element matches;
328 then `assoc-default' returns the element's cdr, if it is a cons,
329 or DEFAULT if the element is not a cons.
331 If no element matches, the value is nil.
332 If TEST is omitted or nil, `equal' is used."
333 (let (found (tail alist
) value
)
334 (while (and tail
(not found
))
335 (let ((elt (car tail
)))
336 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
337 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
338 (setq tail
(cdr tail
)))
341 (make-obsolete 'assoc-ignore-case
'assoc-string
)
342 (defun assoc-ignore-case (key alist
)
343 "Like `assoc', but ignores differences in case and text representation.
344 KEY must be a string. Upper-case and lower-case letters are treated as equal.
345 Unibyte strings are converted to multibyte for comparison."
346 (assoc-string key alist t
))
348 (make-obsolete 'assoc-ignore-representation
'assoc-string
)
349 (defun assoc-ignore-representation (key alist
)
350 "Like `assoc', but ignores differences in text representation.
351 KEY must be a string.
352 Unibyte strings are converted to multibyte for comparison."
353 (assoc-string key alist nil
))
355 (defun member-ignore-case (elt list
)
356 "Like `member', but ignores differences in case and text representation.
357 ELT must be a string. Upper-case and lower-case letters are treated as equal.
358 Unibyte strings are converted to multibyte for comparison.
359 Non-strings in LIST are ignored."
361 (not (and (stringp (car list
))
362 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
363 (setq list
(cdr list
)))
366 (defun assq-delete-all (key alist
)
367 "Delete from ALIST all elements whose car is `eq' to KEY.
368 Return the modified alist.
369 Elements of ALIST that are not conses are ignored."
370 (while (and (consp (car alist
))
371 (eq (car (car alist
)) key
))
372 (setq alist
(cdr alist
)))
373 (let ((tail alist
) tail-cdr
)
374 (while (setq tail-cdr
(cdr tail
))
375 (if (and (consp (car tail-cdr
))
376 (eq (car (car tail-cdr
)) key
))
377 (setcdr tail
(cdr tail-cdr
))
378 (setq tail tail-cdr
))))
381 (defun rassq-delete-all (value alist
)
382 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
383 Return the modified alist.
384 Elements of ALIST that are not conses are ignored."
385 (while (and (consp (car alist
))
386 (eq (cdr (car alist
)) value
))
387 (setq alist
(cdr alist
)))
388 (let ((tail alist
) tail-cdr
)
389 (while (setq tail-cdr
(cdr tail
))
390 (if (and (consp (car tail-cdr
))
391 (eq (cdr (car tail-cdr
)) value
))
392 (setcdr tail
(cdr tail-cdr
))
393 (setq tail tail-cdr
))))
396 (defun remove (elt seq
)
397 "Return a copy of SEQ with all occurrences of ELT removed.
398 SEQ must be a list, vector, or string. The comparison is done with `equal'."
400 ;; If SEQ isn't a list, there's no need to copy SEQ because
401 ;; `delete' will return a new object.
403 (delete elt
(copy-sequence seq
))))
405 (defun remq (elt list
)
406 "Return LIST with all occurrences of ELT removed.
407 The comparison is done with `eq'. Contrary to `delq', this does not use
408 side-effects, and the argument LIST is not modified."
410 (delq elt
(copy-sequence list
))
416 "Convert KEYS to the internal Emacs key representation.
417 KEYS should be a string constant in the format used for
418 saving keyboard macros (see `edmacro-mode')."
419 (read-kbd-macro keys
))
425 ;; Prevent the \{...} documentation construct
426 ;; from mentioning keys that run this command.
427 (put 'undefined
'suppress-keymap t
)
429 (defun suppress-keymap (map &optional nodigits
)
430 "Make MAP override all normally self-inserting keys to be undefined.
431 Normally, as an exception, digits and minus-sign are set to make prefix args,
432 but optional second arg NODIGITS non-nil treats them like other chars."
433 (define-key map
[remap self-insert-command
] 'undefined
)
436 (define-key map
"-" 'negative-argument
)
437 ;; Make plain numbers do numeric args.
440 (define-key map
(char-to-string loop
) 'digit-argument
)
441 (setq loop
(1+ loop
))))))
443 (defun define-key-after (keymap key definition
&optional after
)
444 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
445 This is like `define-key' except that the binding for KEY is placed
446 just after the binding for the event AFTER, instead of at the beginning
447 of the map. Note that AFTER must be an event type (like KEY), NOT a command
450 If AFTER is t or omitted, the new binding goes at the end of the keymap.
451 AFTER should be a single event type--a symbol or a character, not a sequence.
453 Bindings are always added before any inherited map.
455 The order of bindings in a keymap matters when it is used as a menu."
456 (unless after
(setq after t
))
458 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
460 (if (<= (length key
) 1) (aref key
0)
461 (setq keymap
(lookup-key keymap
463 (butlast (mapcar 'identity key
)))))
464 (aref key
(1- (length key
)))))
465 (let ((tail keymap
) done inserted
)
466 (while (and (not done
) tail
)
467 ;; Delete any earlier bindings for the same key.
468 (if (eq (car-safe (car (cdr tail
))) key
)
469 (setcdr tail
(cdr (cdr tail
))))
470 ;; If we hit an included map, go down that one.
471 (if (keymapp (car tail
)) (setq tail
(car tail
)))
472 ;; When we reach AFTER's binding, insert the new binding after.
473 ;; If we reach an inherited keymap, insert just before that.
474 ;; If we reach the end of this keymap, insert at the end.
475 (if (or (and (eq (car-safe (car tail
)) after
)
477 (eq (car (cdr tail
)) 'keymap
)
480 ;; Stop the scan only if we find a parent keymap.
481 ;; Keep going past the inserted element
482 ;; so we can delete any duplications that come later.
483 (if (eq (car (cdr tail
)) 'keymap
)
485 ;; Don't insert more than once.
487 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
489 (setq tail
(cdr tail
)))))
491 (defun map-keymap-internal (function keymap
&optional sort-first
)
492 "Implement `map-keymap' with sorting.
493 Don't call this function; it is for internal use only."
496 (map-keymap (lambda (a b
) (push (cons a b
) list
))
498 (setq list
(sort list
500 (setq a
(car a
) b
(car b
))
502 (if (integerp b
) (< a b
)
507 (funcall function
(car p
) (cdr p
))))
508 (map-keymap function keymap
)))
510 (put 'keyboard-translate-table
'char-table-extra-slots
0)
512 (defun keyboard-translate (from to
)
513 "Translate character FROM to TO at a low level.
514 This function creates a `keyboard-translate-table' if necessary
515 and then modifies one entry in it."
516 (or (char-table-p keyboard-translate-table
)
517 (setq keyboard-translate-table
518 (make-char-table 'keyboard-translate-table nil
)))
519 (aset keyboard-translate-table from to
))
521 ;;;; Key binding commands.
523 (defun global-set-key (key command
)
524 "Give KEY a global binding as COMMAND.
525 COMMAND is the command definition to use; usually it is
526 a symbol naming an interactively-callable function.
527 KEY is a key sequence; noninteractively, it is a string or vector
528 of characters or event types, and non-ASCII characters with codes
529 above 127 (such as ISO Latin-1) can be included if you use a vector.
531 Note that if KEY has a local binding in the current buffer,
532 that local binding will continue to shadow any global binding
533 that you make with this function."
534 (interactive "KSet key globally: \nCSet key %s to command: ")
535 (or (vectorp key
) (stringp key
)
536 (signal 'wrong-type-argument
(list 'arrayp key
)))
537 (define-key (current-global-map) key command
))
539 (defun local-set-key (key command
)
540 "Give KEY a local binding as COMMAND.
541 COMMAND is the command definition to use; usually it is
542 a symbol naming an interactively-callable function.
543 KEY is a key sequence; noninteractively, it is a string or vector
544 of characters or event types, and non-ASCII characters with codes
545 above 127 (such as ISO Latin-1) can be included if you use a vector.
547 The binding goes in the current buffer's local map,
548 which in most cases is shared with all other buffers in the same major mode."
549 (interactive "KSet key locally: \nCSet key %s locally to command: ")
550 (let ((map (current-local-map)))
552 (use-local-map (setq map
(make-sparse-keymap))))
553 (or (vectorp key
) (stringp key
)
554 (signal 'wrong-type-argument
(list 'arrayp key
)))
555 (define-key map key command
)))
557 (defun global-unset-key (key)
558 "Remove global binding of KEY.
559 KEY is a string or vector representing a sequence of keystrokes."
560 (interactive "kUnset key globally: ")
561 (global-set-key key nil
))
563 (defun local-unset-key (key)
564 "Remove local binding of KEY.
565 KEY is a string or vector representing a sequence of keystrokes."
566 (interactive "kUnset key locally: ")
567 (if (current-local-map)
568 (local-set-key key nil
))
571 ;;;; substitute-key-definition and its subroutines.
573 (defvar key-substitution-in-progress nil
574 "Used internally by `substitute-key-definition'.")
576 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
577 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
578 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
579 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
580 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
582 If you don't specify OLDMAP, you can usually get the same results
583 in a cleaner way with command remapping, like this:
584 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
585 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
586 ;; Don't document PREFIX in the doc string because we don't want to
587 ;; advertise it. It's meant for recursive calls only. Here's its
590 ;; If optional argument PREFIX is specified, it should be a key
591 ;; prefix, a string. Redefined bindings will then be bound to the
592 ;; original key, with PREFIX added at the front.
593 (or prefix
(setq prefix
""))
594 (let* ((scan (or oldmap keymap
))
595 (prefix1 (vconcat prefix
[nil]))
596 (key-substitution-in-progress
597 (cons scan key-substitution-in-progress)))
598 ;; Scan OLDMAP, finding each char or event-symbol that
599 ;; has any definition, and act on it with hack-key.
602 (aset prefix1 (length prefix) char)
603 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
606 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
607 (let (inner-def skipped menu-item)
608 ;; Find the actual command name within the binding.
609 (if (eq (car-safe defn) 'menu-item)
610 (setq menu-item defn defn (nth 2 defn))
611 ;; Skip past menu-prompt.
612 (while (stringp (car-safe defn))
613 (push (pop defn) skipped))
614 ;; Skip past cached key-equivalence data for menu items.
615 (if (consp (car-safe defn))
616 (setq defn (cdr defn))))
617 (if (or (eq defn olddef)
618 ;; Compare with equal if definition is a key sequence.
619 ;; That is useful for operating on function-key-map.
620 (and (or (stringp defn) (vectorp defn))
621 (equal defn olddef)))
622 (define-key keymap prefix
624 (let ((copy (copy-sequence menu-item)))
625 (setcar (nthcdr 2 copy) newdef)
627 (nconc (nreverse skipped) newdef)))
628 ;; Look past a symbol that names a keymap.
630 (or (indirect-function defn t) defn))
631 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
632 ;; avoid autoloading a keymap. This is mostly done to preserve the
633 ;; original non-autoloading behavior of pre-map-keymap times.
634 (if (and (keymapp inner-def)
635 ;; Avoid recursively scanning
636 ;; where KEYMAP does not have a submap.
637 (let ((elt (lookup-key keymap prefix)))
638 (or (null elt) (natnump elt) (keymapp elt)))
639 ;; Avoid recursively rescanning keymap being scanned.
640 (not (memq inner-def key-substitution-in-progress)))
641 ;; If this one isn't being scanned already, scan it now.
642 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
645 ;;;; The global keymap tree.
647 ;;; global-map, esc-map, and ctl-x-map have their values set up in
648 ;;; keymap.c; we just give them docstrings here.
650 (defvar global-map nil
651 "Default global keymap mapping Emacs keyboard input into commands.
652 The value is a keymap which is usually (but not necessarily) Emacs's
656 "Default keymap for ESC (meta) commands.
657 The normal global definition of the character ESC indirects to this keymap.")
659 (defvar ctl-x-map nil
660 "Default keymap for C-x commands.
661 The normal global definition of the character C-x indirects to this keymap.")
663 (defvar ctl-x-4-map (make-sparse-keymap)
664 "Keymap for subcommands of C-x 4.")
665 (defalias 'ctl-x-4-prefix ctl-x-4-map)
666 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
668 (defvar ctl-x-5-map (make-sparse-keymap)
669 "Keymap for frame commands.")
670 (defalias 'ctl-x-5-prefix ctl-x-5-map)
671 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
674 ;;;; Event manipulation functions.
676 ;; The call to `read' is to ensure that the value is computed at load time
677 ;; and not compiled into the .elc file. The value is negative on most
678 ;; machines, but not on all!
679 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
681 (defun listify-key-sequence (key)
682 "Convert a key sequence to a list of events."
685 (mapcar (function (lambda (c)
687 (logxor c listify-key-sequence-1)
691 (defsubst eventp (obj)
692 "True if the argument is an event object."
693 (or (and (integerp obj)
694 ;; Filter out integers too large to be events.
695 ;; M is the biggest modifier.
696 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
697 (char-valid-p (event-basic-type obj)))
699 (get obj 'event-symbol-elements))
702 (get (car obj) 'event-symbol-elements))))
704 (defun event-modifiers (event)
705 "Return a list of symbols representing the modifier keys in event EVENT.
706 The elements of the list may include `meta', `control',
707 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
709 EVENT may be an event or an event type. If EVENT is a symbol
710 that has never been used in an event that has been read as input
711 in the current Emacs session, then this function can return nil,
712 even when EVENT actually has modifiers."
715 (setq type (car type)))
717 (cdr (get type 'event-symbol-elements))
719 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
720 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
721 (if (not (zerop (logand type ?\M-\^@)))
723 (if (or (not (zerop (logand type ?\C-\^@)))
725 (push 'control list))
726 (if (or (not (zerop (logand type ?\S-\^@)))
727 (/= char (downcase char)))
729 (or (zerop (logand type ?\H-\^@))
731 (or (zerop (logand type ?\s-\^@))
733 (or (zerop (logand type ?\A-\^@))
737 (defun event-basic-type (event)
738 "Return the basic type of the given event (all modifiers removed).
739 The value is a printing character (not upper case) or a symbol.
740 EVENT may be an event or an event type. If EVENT is a symbol
741 that has never been used in an event that has been read as input
742 in the current Emacs session, then this function may return nil."
744 (setq event (car event)))
746 (car (get event 'event-symbol-elements))
747 (let* ((base (logand event (1- ?\A-\^@)))
748 (uncontrolled (if (< base 32) (logior base 64) base)))
749 ;; There are some numbers that are invalid characters and
750 ;; cause `downcase' to get an error.
752 (downcase uncontrolled)
753 (error uncontrolled)))))
755 (defsubst mouse-movement-p (object)
756 "Return non-nil if OBJECT is a mouse movement event."
757 (eq (car-safe object) 'mouse-movement))
759 (defsubst event-start (event)
760 "Return the starting position of EVENT.
761 If EVENT is a mouse or key press or a mouse click, this returns the location
763 If EVENT is a drag, this returns the drag's starting position.
764 The return value is of the form
765 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
766 IMAGE (DX . DY) (WIDTH . HEIGHT))
767 The `posn-' functions access elements of such lists."
768 (if (consp event) (nth 1 event)
769 (list (selected-window) (point) '(0 . 0) 0)))
771 (defsubst event-end (event)
772 "Return the ending location of EVENT.
773 EVENT should be a click, drag, or key press event.
774 If EVENT is a click event, this function is the same as `event-start'.
775 The return value is of the form
776 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
777 IMAGE (DX . DY) (WIDTH . HEIGHT))
778 The `posn-' functions access elements of such lists."
779 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
780 (list (selected-window) (point) '(0 . 0) 0)))
782 (defsubst event-click-count (event)
783 "Return the multi-click count of EVENT, a click or drag event.
784 The return value is a positive integer."
785 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
787 ;;;; Extracting fields of the positions in an event.
789 (defsubst posn-window (position)
790 "Return the window in POSITION.
791 POSITION should be a list of the form returned by the `event-start'
792 and `event-end' functions."
795 (defsubst posn-area (position)
796 "Return the window area recorded in POSITION, or nil for the text area.
797 POSITION should be a list of the form returned by the `event-start'
798 and `event-end' functions."
799 (let ((area (if (consp (nth 1 position))
800 (car (nth 1 position))
802 (and (symbolp area) area)))
804 (defsubst posn-point (position)
805 "Return the buffer location in POSITION.
806 POSITION should be a list of the form returned by the `event-start'
807 and `event-end' functions."
809 (if (consp (nth 1 position))
810 (car (nth 1 position))
813 (defun posn-set-point (position)
814 "Move point to POSITION.
815 Select the corresponding window as well."
816 (if (not (windowp (posn-window position)))
817 (error "Position not in text area of window"))
818 (select-window (posn-window position))
819 (if (numberp (posn-point position))
820 (goto-char (posn-point position))))
822 (defsubst posn-x-y (position)
823 "Return the x and y coordinates in POSITION.
824 POSITION should be a list of the form returned by the `event-start'
825 and `event-end' functions."
828 (defun posn-col-row (position)
829 "Return the nominal column and row in POSITION, measured in characters.
830 The column and row values are approximations calculated from the x
831 and y coordinates in POSITION and the frame's default character width
833 For a scroll-bar event, the result column is 0, and the row
834 corresponds to the vertical position of the click in the scroll bar.
835 POSITION should be a list of the form returned by the `event-start'
836 and `event-end' functions."
837 (let* ((pair (posn-x-y position))
838 (window (posn-window position))
839 (area (posn-area position)))
843 ((eq area 'vertical-scroll-bar)
844 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
845 ((eq area 'horizontal-scroll-bar)
846 (cons (scroll-bar-scale pair (window-width window)) 0))
848 (let* ((frame (if (framep window) window (window-frame window)))
849 (x (/ (car pair) (frame-char-width frame)))
850 (y (/ (cdr pair) (+ (frame-char-height frame)
851 (or (frame-parameter frame 'line-spacing)
856 (defun posn-actual-col-row (position)
857 "Return the actual column and row in POSITION, measured in characters.
858 These are the actual row number in the window and character number in that row.
859 Return nil if POSITION does not contain the actual position; in that case
860 `posn-col-row' can be used to get approximate values.
861 POSITION should be a list of the form returned by the `event-start'
862 and `event-end' functions."
865 (defsubst posn-timestamp (position)
866 "Return the timestamp of POSITION.
867 POSITION should be a list of the form returned by the `event-start'
868 and `event-end' functions."
871 (defsubst posn-string (position)
872 "Return the string object of POSITION.
873 Value is a cons (STRING . STRING-POS), or nil if not a string.
874 POSITION should be a list of the form returned by the `event-start'
875 and `event-end' functions."
878 (defsubst posn-image (position)
879 "Return the image object of POSITION.
880 Value is an list (image ...), or nil if not an image.
881 POSITION should be a list of the form returned by the `event-start'
882 and `event-end' functions."
885 (defsubst posn-object (position)
886 "Return the object (image or string) of POSITION.
887 Value is a list (image ...) for an image object, a cons cell
888 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
889 POSITION should be a list of the form returned by the `event-start'
890 and `event-end' functions."
891 (or (posn-image position) (posn-string position)))
893 (defsubst posn-object-x-y (position)
894 "Return the x and y coordinates relative to the object of POSITION.
895 POSITION should be a list of the form returned by the `event-start'
896 and `event-end' functions."
899 (defsubst posn-object-width-height (position)
900 "Return the pixel width and height of the object of POSITION.
901 POSITION should be a list of the form returned by the `event-start'
902 and `event-end' functions."
906 ;;;; Obsolescent names for functions.
908 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
909 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
910 (define-obsolete-function-alias 'read-input 'read-string "22.1")
911 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
912 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
913 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
915 (make-obsolete 'char-bytes "now always returns 1." "20.4")
917 (defun insert-string (&rest args)
918 "Mocklisp-compatibility insert function.
919 Like the function `insert' except that any argument that is a number
920 is converted into a string by expressing it in decimal."
922 (insert (if (integerp el) (number-to-string el) el))))
923 (make-obsolete 'insert-string 'insert "22.1")
925 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
926 (make-obsolete 'makehash 'make-hash-table "22.1")
928 ;; Some programs still use this as a function.
930 "Return the value of the `baud-rate' variable."
932 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
934 ;; These are used by VM and some old programs
935 (defalias 'focus-frame 'ignore "")
936 (make-obsolete 'focus-frame "it does nothing." "22.1")
937 (defalias 'unfocus-frame 'ignore "")
938 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
941 ;;;; Obsolescence declarations for variables, and aliases.
943 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
944 (make-obsolete-variable 'mode-line-inverse-video "use the appropriate faces instead." "21.1")
945 (make-obsolete-variable 'unread-command-char
946 "use `unread-command-events' instead. That variable is a list of events to reread, so it now uses nil to mean `no event', instead of -1."
949 ;; Lisp manual only updated in 22.1.
950 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
953 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
954 (make-obsolete-variable 'x-lost-selection-hooks 'x-lost-selection-functions "22.1")
955 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
956 (make-obsolete-variable 'x-sent-selection-hooks 'x-sent-selection-functions "22.1")
958 (defvaralias 'messages-buffer-max-lines 'message-log-max)
960 ;;;; Alternate names for functions - these are not being phased out.
962 (defalias 'send-string 'process-send-string)
963 (defalias 'send-region 'process-send-region)
964 (defalias 'string= 'string-equal)
965 (defalias 'string< 'string-lessp)
966 (defalias 'move-marker 'set-marker)
967 (defalias 'rplaca 'setcar)
968 (defalias 'rplacd 'setcdr)
969 (defalias 'beep 'ding) ;preserve lingual purity
970 (defalias 'indent-to-column 'indent-to)
971 (defalias 'backward-delete-char 'delete-backward-char)
972 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
973 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
974 (defalias 'int-to-string 'number-to-string)
975 (defalias 'store-match-data 'set-match-data)
976 (defalias 'make-variable-frame-localizable 'make-variable-frame-local)
977 ;; These are the XEmacs names:
978 (defalias 'point-at-eol 'line-end-position)
979 (defalias 'point-at-bol 'line-beginning-position)
981 (defalias 'user-original-login-name 'user-login-name)
984 ;;;; Hook manipulation functions.
986 (defun make-local-hook (hook)
987 "Make the hook HOOK local to the current buffer.
988 The return value is HOOK.
990 You never need to call this function now that `add-hook' does it for you
991 if its LOCAL argument is non-nil.
993 When a hook is local, its local and global values
994 work in concert: running the hook actually runs all the hook
995 functions listed in *either* the local value *or* the global value
996 of the hook variable.
998 This function works by making t a member of the buffer-local value,
999 which acts as a flag to run the hook functions in the default value as
1000 well. This works for all normal hooks, but does not work for most
1001 non-normal hooks yet. We will be changing the callers of non-normal
1002 hooks so that they can handle localness; this has to be done one by
1005 This function does nothing if HOOK is already local in the current
1008 Do not use `make-local-variable' to make a hook variable buffer-local."
1009 (if (local-variable-p hook)
1011 (or (boundp hook) (set hook nil))
1012 (make-local-variable hook)
1013 (set hook (list t)))
1015 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1017 (defun add-hook (hook function &optional append local)
1018 "Add to the value of HOOK the function FUNCTION.
1019 FUNCTION is not added if already present.
1020 FUNCTION is added (if necessary) at the beginning of the hook list
1021 unless the optional argument APPEND is non-nil, in which case
1022 FUNCTION is added at the end.
1024 The optional fourth argument, LOCAL, if non-nil, says to modify
1025 the hook's buffer-local value rather than its default value.
1026 This makes the hook buffer-local if needed, and it makes t a member
1027 of the buffer-local value. That acts as a flag to run the hook
1028 functions in the default value as well as in the local value.
1030 HOOK should be a symbol, and FUNCTION may be any valid function. If
1031 HOOK is void, it is first set to nil. If HOOK's value is a single
1032 function, it is changed to a list of functions."
1033 (or (boundp hook) (set hook nil))
1034 (or (default-boundp hook) (set-default hook nil))
1035 (if local (unless (local-variable-if-set-p hook)
1036 (set (make-local-variable hook) (list t)))
1037 ;; Detect the case where make-local-variable was used on a hook
1038 ;; and do what we used to do.
1039 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1041 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1042 ;; If the hook value is a single function, turn it into a list.
1043 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1044 (setq hook-value (list hook-value)))
1045 ;; Do the actual addition if necessary
1046 (unless (member function hook-value)
1049 (append hook-value (list function))
1050 (cons function hook-value))))
1051 ;; Set the actual variable
1052 (if local (set hook hook-value) (set-default hook hook-value))))
1054 (defun remove-hook (hook function &optional local)
1055 "Remove from the value of HOOK the function FUNCTION.
1056 HOOK should be a symbol, and FUNCTION may be any valid function. If
1057 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1058 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1060 The optional third argument, LOCAL, if non-nil, says to modify
1061 the hook's buffer-local value rather than its default value."
1062 (or (boundp hook) (set hook nil))
1063 (or (default-boundp hook) (set-default hook nil))
1064 ;; Do nothing if LOCAL is t but this hook has no local binding.
1065 (unless (and local (not (local-variable-p hook)))
1066 ;; Detect the case where make-local-variable was used on a hook
1067 ;; and do what we used to do.
1068 (when (and (local-variable-p hook)
1069 (not (and (consp (symbol-value hook))
1070 (memq t (symbol-value hook)))))
1072 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1073 ;; Remove the function, for both the list and the non-list cases.
1074 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1075 (if (equal hook-value function) (setq hook-value nil))
1076 (setq hook-value (delete function (copy-sequence hook-value))))
1077 ;; If the function is on the global hook, we need to shadow it locally
1078 ;;(when (and local (member function (default-value hook))
1079 ;; (not (member (cons 'not function) hook-value)))
1080 ;; (push (cons 'not function) hook-value))
1081 ;; Set the actual variable
1083 (set-default hook hook-value)
1084 (if (equal hook-value '(t))
1085 (kill-local-variable hook)
1086 (set hook hook-value))))))
1088 (defun add-to-list (list-var element &optional append compare-fn)
1089 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1090 The test for presence of ELEMENT is done with `equal',
1091 or with COMPARE-FN if that's non-nil.
1092 If ELEMENT is added, it is added at the beginning of the list,
1093 unless the optional argument APPEND is non-nil, in which case
1094 ELEMENT is added at the end.
1096 The return value is the new value of LIST-VAR.
1098 If you want to use `add-to-list' on a variable that is not defined
1099 until a certain package is loaded, you should put the call to `add-to-list'
1100 into a hook function that will be run only after loading the package.
1101 `eval-after-load' provides one way to do this. In some cases
1102 other hooks, such as major mode hooks, can do the job."
1105 (member element (symbol-value list-var)))
1106 ((eq compare-fn 'eq)
1107 (memq element (symbol-value list-var)))
1108 ((eq compare-fn 'eql)
1109 (memql element (symbol-value list-var)))
1111 (let ((lst (symbol-value list-var)))
1113 (not (funcall compare-fn element (car lst))))
1114 (setq lst (cdr lst)))
1116 (symbol-value list-var)
1119 (append (symbol-value list-var) (list element))
1120 (cons element (symbol-value list-var))))))
1123 (defun add-to-ordered-list (list-var element &optional order)
1124 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1125 The test for presence of ELEMENT is done with `eq'.
1127 The resulting list is reordered so that the elements are in the
1128 order given by each element's numeric list order. Elements
1129 without a numeric list order are placed at the end of the list.
1131 If the third optional argument ORDER is a number (integer or
1132 float), set the element's list order to the given value. If
1133 ORDER is nil or omitted, do not change the numeric order of
1134 ELEMENT. If ORDER has any other value, remove the numeric order
1135 of ELEMENT if it has one.
1137 The list order for each element is stored in LIST-VAR's
1138 `list-order' property.
1140 The return value is the new value of LIST-VAR."
1141 (let ((ordering (get list-var 'list-order)))
1143 (put list-var 'list-order
1144 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1146 (puthash element (and (numberp order) order) ordering))
1147 (unless (memq element (symbol-value list-var))
1148 (set list-var (cons element (symbol-value list-var))))
1149 (set list-var (sort (symbol-value list-var)
1151 (let ((oa (gethash a ordering))
1152 (ob (gethash b ordering)))
1157 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1158 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1159 Return the new history list.
1160 If MAXELT is non-nil, it specifies the maximum length of the history.
1161 Otherwise, the maximum history length is the value of the `history-length'
1162 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1164 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1165 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1166 if it is empty or a duplicate."
1168 (setq maxelt (or (get history-var 'history-length)
1170 (let ((history (symbol-value history-var))
1172 (when (and (listp history)
1174 (not (stringp newelt))
1175 (> (length newelt) 0))
1177 (not (equal (car history) newelt))))
1178 (if history-delete-duplicates
1179 (delete newelt history))
1180 (setq history (cons newelt history))
1181 (when (integerp maxelt)
1184 (setq tail (nthcdr (1- maxelt) history))
1186 (setcdr tail nil)))))
1187 (set history-var history)))
1192 (defvar delay-mode-hooks nil
1193 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1194 (defvar delayed-mode-hooks nil
1195 "List of delayed mode hooks waiting to be run.")
1196 (make-variable-buffer-local 'delayed-mode-hooks)
1197 (put 'delay-mode-hooks 'permanent-local t)
1199 (defvar after-change-major-mode-hook nil
1200 "Normal hook run at the very end of major mode functions.")
1202 (defun run-mode-hooks (&rest hooks)
1203 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1204 Execution is delayed if `delay-mode-hooks' is non-nil.
1205 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1206 after running the mode hooks.
1207 Major mode functions should use this."
1208 (if delay-mode-hooks
1210 (dolist (hook hooks)
1211 (push hook delayed-mode-hooks))
1212 ;; Normal case, just run the hook as before plus any delayed hooks.
1213 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1214 (setq delayed-mode-hooks nil)
1215 (apply 'run-hooks hooks)
1216 (run-hooks 'after-change-major-mode-hook)))
1218 (defmacro delay-mode-hooks (&rest body)
1219 "Execute BODY, but delay any `run-mode-hooks'.
1220 These hooks will be executed by the first following call to
1221 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1222 Only affects hooks run in the current buffer."
1223 (declare (debug t) (indent 0))
1225 (make-local-variable 'delay-mode-hooks)
1226 (let ((delay-mode-hooks t))
1229 ;; PUBLIC: find if the current mode derives from another.
1231 (defun derived-mode-p (&rest modes)
1232 "Non-nil if the current major mode is derived from one of MODES.
1233 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1234 (let ((parent major-mode))
1235 (while (and (not (memq parent modes))
1236 (setq parent (get parent 'derived-mode-parent))))
1241 ;; If a minor mode is not defined with define-minor-mode,
1242 ;; add it here explicitly.
1243 ;; isearch-mode is deliberately excluded, since you should
1244 ;; not call it yourself.
1245 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1246 overwrite-mode view-mode
1248 "List of all minor mode functions.")
1250 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1251 "Register a new minor mode.
1253 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1255 TOGGLE is a symbol which is the name of a buffer-local variable that
1256 is toggled on or off to say whether the minor mode is active or not.
1258 NAME specifies what will appear in the mode line when the minor mode
1259 is active. NAME should be either a string starting with a space, or a
1260 symbol whose value is such a string.
1262 Optional KEYMAP is the keymap for the minor mode that will be added
1263 to `minor-mode-map-alist'.
1265 Optional AFTER specifies that TOGGLE should be added after AFTER
1266 in `minor-mode-alist'.
1268 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1269 It defaults to (and should by convention be) TOGGLE.
1271 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1272 included in the mode-line minor mode menu.
1273 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1274 (unless (memq toggle minor-mode-list)
1275 (push toggle minor-mode-list))
1277 (unless toggle-fun (setq toggle-fun toggle))
1278 (unless (eq toggle-fun toggle)
1279 (put toggle :minor-mode-function toggle-fun))
1280 ;; Add the name to the minor-mode-alist.
1282 (let ((existing (assq toggle minor-mode-alist)))
1284 (setcdr existing (list name))
1285 (let ((tail minor-mode-alist) found)
1286 (while (and tail (not found))
1287 (if (eq after (caar tail))
1289 (setq tail (cdr tail))))
1291 (let ((rest (cdr found)))
1293 (nconc found (list (list toggle name)) rest))
1294 (setq minor-mode-alist (cons (list toggle name)
1295 minor-mode-alist)))))))
1296 ;; Add the toggle to the minor-modes menu if requested.
1297 (when (get toggle :included)
1298 (define-key mode-line-mode-menu
1302 (or (get toggle :menu-tag)
1303 (if (stringp name) name (symbol-name toggle)))
1304 (let ((mode-name (if (symbolp name) (symbol-value name))))
1305 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1306 (concat " (" (match-string 0 mode-name) ")"))))
1308 :button (cons :toggle toggle))))
1310 ;; Add the map to the minor-mode-map-alist.
1312 (let ((existing (assq toggle minor-mode-map-alist)))
1314 (setcdr existing keymap)
1315 (let ((tail minor-mode-map-alist) found)
1316 (while (and tail (not found))
1317 (if (eq after (caar tail))
1319 (setq tail (cdr tail))))
1321 (let ((rest (cdr found)))
1323 (nconc found (list (cons toggle keymap)) rest))
1324 (setq minor-mode-map-alist (cons (cons toggle keymap)
1325 minor-mode-map-alist))))))))
1329 ;; (defvar symbol-file-load-history-loaded nil
1330 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1331 ;; That file records the part of `load-history' for preloaded files,
1332 ;; which is cleared out before dumping to make Emacs smaller.")
1334 ;; (defun load-symbol-file-load-history ()
1335 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1336 ;; That file records the part of `load-history' for preloaded files,
1337 ;; which is cleared out before dumping to make Emacs smaller."
1338 ;; (unless symbol-file-load-history-loaded
1339 ;; (load (expand-file-name
1340 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1341 ;; (if (eq system-type 'ms-dos)
1343 ;; (format "fns-%s.el" emacs-version))
1345 ;; ;; The file name fns-%s.el already has a .el extension.
1347 ;; (setq symbol-file-load-history-loaded t)))
1349 (defun symbol-file (symbol &optional type)
1350 "Return the input source in which SYMBOL was defined.
1351 The value is an absolute file name.
1352 It can also be nil, if the definition is not associated with any file.
1354 If TYPE is nil, then any kind of definition is acceptable.
1355 If TYPE is `defun' or `defvar', that specifies function
1356 definition only or variable definition only.
1357 `defface' specifies a face definition only."
1358 (if (and (or (null type) (eq type 'defun))
1359 (symbolp symbol) (fboundp symbol)
1360 (eq 'autoload (car-safe (symbol-function symbol))))
1361 (nth 1 (symbol-function symbol))
1362 (let ((files load-history)
1366 (if (eq type 'defvar)
1367 ;; Variables are present just as their names.
1368 (member symbol (cdr (car files)))
1369 ;; Other types are represented as (TYPE . NAME).
1370 (member (cons type symbol) (cdr (car files))))
1371 ;; We accept all types, so look for variable def
1372 ;; and then for any other kind.
1373 (or (member symbol (cdr (car files)))
1374 (rassq symbol (cdr (car files)))))
1375 (setq file (car (car files)) files nil))
1376 (setq files (cdr files)))
1380 (defun locate-library (library &optional nosuffix path interactive-call)
1381 "Show the precise file name of Emacs library LIBRARY.
1382 This command searches the directories in `load-path' like `\\[load-library]'
1383 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1384 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1385 to the specified name LIBRARY.
1387 If the optional third arg PATH is specified, that list of directories
1388 is used instead of `load-path'.
1390 When called from a program, the file name is normaly returned as a
1391 string. When run interactively, the argument INTERACTIVE-CALL is t,
1392 and the file name is displayed in the echo area."
1393 (interactive (list (completing-read "Locate library: "
1394 'locate-file-completion
1395 (cons load-path (get-load-suffixes)))
1398 (let ((file (locate-file library
1400 (append (unless nosuffix (get-load-suffixes))
1401 load-file-rep-suffixes))))
1402 (if interactive-call
1404 (message "Library is file %s" (abbreviate-file-name file))
1405 (message "No library %s in search path" library)))
1409 ;;;; Specifying things to do later.
1411 (defmacro eval-at-startup (&rest body)
1412 "Make arrangements to evaluate BODY when Emacs starts up.
1413 If this is run after Emacs startup, evaluate BODY immediately.
1416 This works by adding a function to `before-init-hook'.
1417 That function's doc string says which file created it."
1419 (if command-line-processed
1421 (add-hook 'before-init-hook
1422 '(lambda () ,(concat "From " (or load-file-name "no file"))
1427 (defun load-history-regexp (file)
1428 "Form a regexp to find FILE in `load-history'.
1429 FILE, a string, is described in the function `eval-after-load'."
1430 (if (file-name-absolute-p file)
1431 (setq file (file-truename file)))
1432 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1434 (if (file-name-extension file)
1436 ;; Note: regexp-opt can't be used here, since we need to call
1437 ;; this before Emacs has been fully started. 2006-05-21
1438 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1439 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1442 (defun load-history-filename-element (file-regexp)
1443 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1444 Return nil if there isn't one."
1445 (let* ((loads load-history)
1446 (load-elt (and loads (car loads))))
1449 (or (null (car load-elt))
1450 (not (string-match file-regexp (car load-elt)))))
1451 (setq loads (cdr loads)
1452 load-elt (and loads (car loads)))))
1455 (defun eval-after-load (file form)
1456 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1457 If FILE is already loaded, evaluate FORM right now.
1459 If a matching file is loaded again, FORM will be evaluated again.
1461 If FILE is a string, it may be either an absolute or a relative file
1462 name, and may have an extension \(e.g. \".el\") or may lack one, and
1463 additionally may or may not have an extension denoting a compressed
1464 format \(e.g. \".gz\").
1466 When FILE is absolute, this first converts it to a true name by chasing
1467 symbolic links. Only a file of this name \(see next paragraph regarding
1468 extensions) will trigger the evaluation of FORM. When FILE is relative,
1469 a file whose absolute true name ends in FILE will trigger evaluation.
1471 When FILE lacks an extension, a file name with any extension will trigger
1472 evaluation. Otherwise, its extension must match FILE's. A further
1473 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1476 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1477 is evaluated whenever that feature is `provide'd.
1479 Usually FILE is just a library name like \"font-lock\" or a feature name
1482 This function makes or adds to an entry on `after-load-alist'."
1483 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1484 ;; evaluating it now).
1485 (let* ((regexp-or-feature
1486 (if (stringp file) (load-history-regexp file) file))
1487 (elt (assoc regexp-or-feature after-load-alist)))
1489 (setq elt (list regexp-or-feature))
1490 (push elt after-load-alist))
1491 ;; Add FORM to the element unless it's already there.
1492 (unless (member form (cdr elt))
1493 (nconc elt (list form)))
1495 ;; Is there an already loaded file whose name (or `provide' name)
1497 (if (if (stringp file)
1498 (load-history-filename-element regexp-or-feature)
1502 (defun do-after-load-evaluation (abs-file)
1503 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1504 ABS-FILE, a string, should be the absolute true name of a file just loaded."
1505 (let ((after-load-elts after-load-alist)
1506 a-l-element file-elements file-element form)
1507 (while after-load-elts
1508 (setq a-l-element (car after-load-elts)
1509 after-load-elts (cdr after-load-elts))
1510 (when (and (stringp (car a-l-element))
1511 (string-match (car a-l-element) abs-file))
1512 (while (setq a-l-element (cdr a-l-element)) ; discard the file name
1513 (setq form (car a-l-element))
1516 (defun eval-next-after-load (file)
1517 "Read the following input sexp, and run it whenever FILE is loaded.
1518 This makes or adds to an entry on `after-load-alist'.
1519 FILE should be the name of a library, with no directory name."
1520 (eval-after-load file (read)))
1524 ;; open-network-stream is a wrapper around make-network-process.
1526 (when (featurep 'make-network-process)
1527 (defun open-network-stream (name buffer host service)
1528 "Open a TCP connection for a service to a host.
1529 Returns a subprocess-object to represent the connection.
1530 Input and output work as for subprocesses; `delete-process' closes it.
1532 Args are NAME BUFFER HOST SERVICE.
1533 NAME is name for process. It is modified if necessary to make it unique.
1534 BUFFER is the buffer (or buffer name) to associate with the process.
1535 Process output goes at end of that buffer, unless you specify
1536 an output stream or filter function to handle the output.
1537 BUFFER may be also nil, meaning that this process is not associated
1539 HOST is name of the host to connect to, or its IP address.
1540 SERVICE is name of the service desired, or an integer specifying
1541 a port number to connect to."
1542 (make-network-process :name name :buffer buffer
1543 :host host :service service)))
1547 (make-obsolete 'process-kill-without-query
1548 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1550 (defun process-kill-without-query (process &optional flag)
1551 "Say no query needed if PROCESS is running when Emacs is exited.
1552 Optional second argument if non-nil says to require a query.
1553 Value is t if a query was formerly required."
1554 (let ((old (process-query-on-exit-flag process)))
1555 (set-process-query-on-exit-flag process nil)
1558 ;; process plist management
1560 (defun process-get (process propname)
1561 "Return the value of PROCESS' PROPNAME property.
1562 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1563 (plist-get (process-plist process) propname))
1565 (defun process-put (process propname value)
1566 "Change PROCESS' PROPNAME property to VALUE.
1567 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1568 (set-process-plist process
1569 (plist-put (process-plist process) propname value)))
1572 ;;;; Input and display facilities.
1574 (defvar read-quoted-char-radix 8
1575 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1576 Legitimate radix values are 8, 10 and 16.")
1578 (custom-declare-variable-early
1579 'read-quoted-char-radix 8
1580 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1581 Legitimate radix values are 8, 10 and 16."
1582 :type '(choice (const 8) (const 10) (const 16))
1583 :group 'editing-basics)
1585 (defun read-quoted-char (&optional prompt)
1586 "Like `read-char', but do not allow quitting.
1587 Also, if the first character read is an octal digit,
1588 we read any number of octal digits and return the
1589 specified character code. Any nondigit terminates the sequence.
1590 If the terminator is RET, it is discarded;
1591 any other terminator is used itself as input.
1593 The optional argument PROMPT specifies a string to use to prompt the user.
1594 The variable `read-quoted-char-radix' controls which radix to use
1596 (let ((message-log-max nil) done (first t) (code 0) char translated)
1598 (let ((inhibit-quit first)
1599 ;; Don't let C-h get the help message--only help function keys.
1602 "Type the special character you want to use,
1603 or the octal character code.
1604 RET terminates the character code and is discarded;
1605 any other non-digit terminates the character code and is then used as input."))
1606 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1607 (if inhibit-quit (setq quit-flag nil)))
1608 ;; Translate TAB key into control-I ASCII character, and so on.
1609 ;; Note: `read-char' does it using the `ascii-character' property.
1610 ;; We could try and use read-key-sequence instead, but then C-q ESC
1611 ;; or C-q C-x might not return immediately since ESC or C-x might be
1612 ;; bound to some prefix in function-key-map or key-translation-map.
1613 (setq translated char)
1614 (let ((translation (lookup-key function-key-map (vector char))))
1615 (if (arrayp translation)
1616 (setq translated (aref translation 0))))
1617 (cond ((null translated))
1618 ((not (integerp translated))
1619 (setq unread-command-events (list char)
1621 ((/= (logand translated ?\M-\^@) 0)
1622 ;; Turn a meta-character into a character with the 0200 bit set.
1623 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1625 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1626 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1627 (and prompt (setq prompt (message "%s %c" prompt translated))))
1628 ((and (<= ?a (downcase translated))
1629 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1630 (setq code (+ (* code read-quoted-char-radix)
1631 (+ 10 (- (downcase translated) ?a))))
1632 (and prompt (setq prompt (message "%s %c" prompt translated))))
1633 ((and (not first) (eq translated ?\C-m))
1636 (setq unread-command-events (list char)
1638 (t (setq code translated
1643 (defun read-passwd (prompt &optional confirm default)
1644 "Read a password, prompting with PROMPT, and return it.
1645 If optional CONFIRM is non-nil, read the password twice to make sure.
1646 Optional DEFAULT is a default password to use instead of empty input.
1648 This function echoes `.' for each character that the user types.
1649 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1650 C-g quits; if `inhibit-quit' was non-nil around this function,
1651 then it returns nil if the user types C-g, but quit-flag remains set.
1653 Once the caller uses the password, it can erase the password
1654 by doing (clear-string STRING)."
1658 (while (not success)
1659 (let ((first (read-passwd prompt nil default))
1660 (second (read-passwd "Confirm password: " nil default)))
1661 (if (equal first second)
1663 (and (arrayp second) (clear-string second))
1664 (setq success first))
1665 (and (arrayp first) (clear-string first))
1666 (and (arrayp second) (clear-string second))
1667 (message "Password not repeated accurately; please start over")
1671 ;; Copy it so that add-text-properties won't modify
1672 ;; the object that was passed in by the caller.
1673 (prompt (copy-sequence prompt))
1676 (cursor-in-echo-area t)
1677 (message-log-max nil))
1678 (add-text-properties 0 (length prompt)
1679 minibuffer-prompt-properties prompt)
1680 (while (progn (message "%s%s"
1682 (make-string (length pass) ?.))
1683 (setq c (read-char-exclusive nil t))
1684 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1685 (clear-this-command-keys)
1688 (and (arrayp pass) (clear-string pass))
1690 (if (and (/= c ?\b) (/= c ?\177))
1691 (let* ((new-char (char-to-string c))
1692 (new-pass (concat pass new-char)))
1693 (and (arrayp pass) (clear-string pass))
1694 (clear-string new-char)
1696 (setq pass new-pass))
1697 (if (> (length pass) 0)
1698 (let ((new-pass (substring pass 0 -1)))
1699 (and (arrayp pass) (clear-string pass))
1700 (setq pass new-pass))))))
1702 (or pass default "")))))
1704 ;; This should be used by `call-interactively' for `n' specs.
1705 (defun read-number (prompt &optional default)
1709 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1710 (replace-match (format " (default %s)" default) t t prompt 1)
1711 (replace-regexp-in-string "[ \t]*\\'"
1712 (format " (default %s) " default)
1716 (let ((str (read-from-minibuffer prompt nil nil nil nil
1718 (number-to-string default)))))
1720 ((zerop (length str)) default)
1721 ((stringp str) (read str)))))
1723 (message "Please enter a number.")
1728 (defun sit-for (seconds &optional nodisp obsolete)
1729 "Perform redisplay, then wait for SECONDS seconds or until input is available.
1730 SECONDS may be a floating-point value.
1731 \(On operating systems that do not support waiting for fractions of a
1732 second, floating-point values are rounded down to the nearest integer.)
1734 If optional arg NODISP is t, don't redisplay, just wait for input.
1735 Redisplay does not happen if input is available before it starts.
1737 Value is t if waited the full time with no input arriving, and nil otherwise.
1739 An obsolete, but still supported form is
1740 \(sit-for SECONDS &optional MILLISECONDS NODISP)
1741 where the optional arg MILLISECONDS specifies an additional wait period,
1742 in milliseconds; this was useful when Emacs was built without
1743 floating point support.
1745 \(fn SECONDS &optional NODISP)"
1746 (when (or obsolete (numberp nodisp))
1747 (setq seconds (+ seconds (* 1e-3 nodisp)))
1748 (setq nodisp obsolete))
1756 (or nodisp (redisplay)))
1758 (or nodisp (redisplay))
1759 (let ((read (read-event nil nil seconds)))
1762 ;; If last command was a prefix arg, e.g. C-u, push this event onto
1763 ;; unread-command-events as (t . EVENT) so it will be added to
1764 ;; this-command-keys by read-key-sequence.
1765 (if (eq overriding-terminal-local-map universal-argument-map)
1766 (setq read (cons t read)))
1767 (push read unread-command-events)
1770 ;;; Atomic change groups.
1772 (defmacro atomic-change-group (&rest body)
1773 "Perform BODY as an atomic change group.
1774 This means that if BODY exits abnormally,
1775 all of its changes to the current buffer are undone.
1776 This works regardless of whether undo is enabled in the buffer.
1778 This mechanism is transparent to ordinary use of undo;
1779 if undo is enabled in the buffer and BODY succeeds, the
1780 user can undo the change normally."
1781 (declare (indent 0) (debug t))
1782 (let ((handle (make-symbol "--change-group-handle--"))
1783 (success (make-symbol "--change-group-success--")))
1784 `(let ((,handle (prepare-change-group))
1788 ;; This is inside the unwind-protect because
1789 ;; it enables undo if that was disabled; we need
1790 ;; to make sure that it gets disabled again.
1791 (activate-change-group ,handle)
1794 ;; Either of these functions will disable undo
1795 ;; if it was disabled before.
1797 (accept-change-group ,handle)
1798 (cancel-change-group ,handle))))))
1800 (defun prepare-change-group (&optional buffer)
1801 "Return a handle for the current buffer's state, for a change group.
1802 If you specify BUFFER, make a handle for BUFFER's state instead.
1804 Pass the handle to `activate-change-group' afterward to initiate
1805 the actual changes of the change group.
1807 To finish the change group, call either `accept-change-group' or
1808 `cancel-change-group' passing the same handle as argument. Call
1809 `accept-change-group' to accept the changes in the group as final;
1810 call `cancel-change-group' to undo them all. You should use
1811 `unwind-protect' to make sure the group is always finished. The call
1812 to `activate-change-group' should be inside the `unwind-protect'.
1813 Once you finish the group, don't use the handle again--don't try to
1814 finish the same group twice. For a simple example of correct use, see
1815 the source code of `atomic-change-group'.
1817 The handle records only the specified buffer. To make a multibuffer
1818 change group, call this function once for each buffer you want to
1819 cover, then use `nconc' to combine the returned values, like this:
1821 (nconc (prepare-change-group buffer-1)
1822 (prepare-change-group buffer-2))
1824 You can then activate that multibuffer change group with a single
1825 call to `activate-change-group' and finish it with a single call
1826 to `accept-change-group' or `cancel-change-group'."
1829 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
1830 (list (cons (current-buffer) buffer-undo-list))))
1832 (defun activate-change-group (handle)
1833 "Activate a change group made with `prepare-change-group' (which see)."
1834 (dolist (elt handle)
1835 (with-current-buffer (car elt)
1836 (if (eq buffer-undo-list t)
1837 (setq buffer-undo-list nil)))))
1839 (defun accept-change-group (handle)
1840 "Finish a change group made with `prepare-change-group' (which see).
1841 This finishes the change group by accepting its changes as final."
1842 (dolist (elt handle)
1843 (with-current-buffer (car elt)
1845 (setq buffer-undo-list t)))))
1847 (defun cancel-change-group (handle)
1848 "Finish a change group made with `prepare-change-group' (which see).
1849 This finishes the change group by reverting all of its changes."
1850 (dolist (elt handle)
1851 (with-current-buffer (car elt)
1852 (setq elt (cdr elt))
1854 (if (consp elt) (car elt)))
1856 (if (consp elt) (cdr elt))))
1857 ;; Temporarily truncate the undo log at ELT.
1859 (setcar elt nil) (setcdr elt nil))
1860 (unless (eq last-command 'undo) (undo-start))
1861 ;; Make sure there's no confusion.
1862 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
1863 (error "Undoing to some unrelated state"))
1865 (while (listp pending-undo-list) (undo-more 1))
1866 ;; Reset the modified cons cell ELT to its original content.
1868 (setcar elt old-car)
1869 (setcdr elt old-cdr))
1870 ;; Revert the undo info to what it was when we grabbed the state.
1871 (setq buffer-undo-list elt)))))
1873 ;;;; Display-related functions.
1875 ;; For compatibility.
1876 (defalias 'redraw-modeline 'force-mode-line-update)
1878 (defun force-mode-line-update (&optional all)
1879 "Force redisplay of the current buffer's mode line and header line.
1880 With optional non-nil ALL, force redisplay of all mode lines and
1881 header lines. This function also forces recomputation of the
1882 menu bar menus and the frame title."
1883 (if all (save-excursion (set-buffer (other-buffer))))
1884 (set-buffer-modified-p (buffer-modified-p)))
1886 (defun momentary-string-display (string pos &optional exit-char message)
1887 "Momentarily display STRING in the buffer at POS.
1888 Display remains until next event is input.
1889 Optional third arg EXIT-CHAR can be a character, event or event
1890 description list. EXIT-CHAR defaults to SPC. If the input is
1891 EXIT-CHAR it is swallowed; otherwise it is then available as
1892 input (as a command if nothing else).
1893 Display MESSAGE (optional fourth arg) in the echo area.
1894 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1895 (or exit-char (setq exit-char ?\ ))
1896 (let ((inhibit-read-only t)
1897 ;; Don't modify the undo list at all.
1898 (buffer-undo-list t)
1899 (modified (buffer-modified-p))
1900 (name buffer-file-name)
1906 ;; defeat file locking... don't try this at home, kids!
1907 (setq buffer-file-name nil)
1908 (insert-before-markers string)
1909 (setq insert-end (point))
1910 ;; If the message end is off screen, recenter now.
1911 (if (< (window-end nil t) insert-end)
1912 (recenter (/ (window-height) 2)))
1913 ;; If that pushed message start off the screen,
1914 ;; scroll to start it at the top of the screen.
1915 (move-to-window-line 0)
1920 (message (or message "Type %s to continue editing.")
1921 (single-key-description exit-char))
1923 (if (integerp exit-char)
1926 (setq char (read-char))
1927 (or (eq char exit-char)
1928 (setq unread-command-events (list char))))
1930 ;; `exit-char' is a character, hence it differs
1931 ;; from char, which is an event.
1932 (setq unread-command-events (list char))))
1933 ;; `exit-char' can be an event, or an event description
1935 (setq char (read-event))
1936 (or (eq char exit-char)
1937 (eq char (event-convert-list exit-char))
1938 (setq unread-command-events (list char))))))
1941 (delete-region pos insert-end)))
1942 (setq buffer-file-name name)
1943 (set-buffer-modified-p modified))))
1946 ;;;; Overlay operations
1948 (defun copy-overlay (o)
1949 "Return a copy of overlay O."
1950 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1951 ;; FIXME: there's no easy way to find the
1952 ;; insertion-type of the two markers.
1953 (overlay-buffer o)))
1954 (props (overlay-properties o)))
1956 (overlay-put o1 (pop props) (pop props)))
1959 (defun remove-overlays (&optional beg end name val)
1960 "Clear BEG and END of overlays whose property NAME has value VAL.
1961 Overlays might be moved and/or split.
1962 BEG and END default respectively to the beginning and end of buffer."
1963 ;; This speeds up the loops over overlays.
1964 (overlay-recenter (point-max))
1965 (unless beg (setq beg (point-min)))
1966 (unless end (setq end (point-max)))
1968 (setq beg (prog1 end (setq end beg))))
1970 (dolist (o (overlays-in beg end))
1971 (when (eq (overlay-get o name) val)
1972 ;; Either push this overlay outside beg...end
1973 ;; or split it to exclude beg...end
1974 ;; or delete it entirely (if it is contained in beg...end).
1975 (if (< (overlay-start o) beg)
1976 (if (> (overlay-end o) end)
1978 (move-overlay (copy-overlay o)
1979 (overlay-start o) beg)
1980 (move-overlay o end (overlay-end o)))
1981 (move-overlay o (overlay-start o) beg))
1982 (if (> (overlay-end o) end)
1983 (move-overlay o end (overlay-end o))
1984 (delete-overlay o)))))))
1988 (defvar suspend-hook nil
1989 "Normal hook run by `suspend-emacs', before suspending.")
1991 (defvar suspend-resume-hook nil
1992 "Normal hook run by `suspend-emacs', after Emacs is continued.")
1994 (defvar temp-buffer-show-hook nil
1995 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
1996 When the hook runs, the temporary buffer is current, and the window it
1997 was displayed in is selected. This hook is normally set up with a
1998 function to make the buffer read only, and find function names and
1999 variable names in it, provided the major mode is still Help mode.")
2001 (defvar temp-buffer-setup-hook nil
2002 "Normal hook run by `with-output-to-temp-buffer' at the start.
2003 When the hook runs, the temporary buffer is current.
2004 This hook is normally set up with a function to put the buffer in Help
2007 ;; Avoid compiler warnings about this variable,
2008 ;; which has a special meaning on certain system types.
2009 (defvar buffer-file-type nil
2010 "Non-nil if the visited file is a binary file.
2011 This variable is meaningful on MS-DOG and Windows NT.
2012 On those systems, it is automatically local in every buffer.
2013 On other systems, this variable is normally always nil.")
2015 ;; The `assert' macro from the cl package signals
2016 ;; `cl-assertion-failed' at runtime so always define it.
2017 (put 'cl-assertion-failed 'error-conditions '(error))
2018 (put 'cl-assertion-failed 'error-message "Assertion failed")
2021 ;;;; Misc. useful functions.
2023 (defun find-tag-default ()
2024 "Determine default tag to search for, based on text at point.
2025 If there is no plausible default, return nil."
2027 (while (looking-at "\\sw\\|\\s_")
2029 (if (or (re-search-backward "\\sw\\|\\s_"
2030 (save-excursion (beginning-of-line) (point))
2032 (re-search-forward "\\(\\sw\\|\\s_\\)+"
2033 (save-excursion (end-of-line) (point))
2036 (goto-char (match-end 0))
2038 (buffer-substring-no-properties
2040 (progn (forward-sexp -1)
2041 (while (looking-at "\\s'")
2047 (defun play-sound (sound)
2048 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2049 The following keywords are recognized:
2051 :file FILE - read sound data from FILE. If FILE isn't an
2052 absolute file name, it is searched in `data-directory'.
2054 :data DATA - read sound data from string DATA.
2056 Exactly one of :file or :data must be present.
2058 :volume VOL - set volume to VOL. VOL must an integer in the
2059 range 0..100 or a float in the range 0..1.0. If not specified,
2060 don't change the volume setting of the sound device.
2062 :device DEVICE - play sound on DEVICE. If not specified,
2063 a system-dependent default device name is used."
2064 (if (fboundp 'play-sound-internal)
2065 (play-sound-internal sound)
2066 (error "This Emacs binary lacks sound support")))
2068 (defun shell-quote-argument (argument)
2069 "Quote an argument for passing as argument to an inferior shell."
2070 (if (or (eq system-type 'ms-dos)
2071 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2072 ;; Quote using double quotes, but escape any existing quotes in
2073 ;; the argument with backslashes.
2077 (if (or (null (string-match "[^\"]" argument))
2078 (< (match-end 0) (length argument)))
2079 (while (string-match "[\"]" argument start)
2080 (setq end (match-beginning 0)
2081 result (concat result (substring argument start end)
2082 "\\" (substring argument end (1+ end)))
2084 (concat "\"" result (substring argument start) "\""))
2085 (if (equal argument "")
2087 ;; Quote everything except POSIX filename characters.
2088 ;; This should be safe enough even for really weird shells.
2089 (let ((result "") (start 0) end)
2090 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2091 (setq end (match-beginning 0)
2092 result (concat result (substring argument start end)
2093 "\\" (substring argument end (1+ end)))
2095 (concat result (substring argument start))))))
2097 (defun string-or-null-p (object)
2098 "Return t if OBJECT is a string or nil.
2099 Otherwise, return nil."
2100 (or (stringp object) (null object)))
2102 (defun booleanp (object)
2103 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2104 (memq object '(nil t)))
2106 (defun field-at-pos (pos)
2107 "Return the field at position POS, taking stickiness etc into account"
2108 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2109 (if (eq raw-field 'boundary)
2110 (get-char-property (1- (field-end pos)) 'field)
2114 ;;;; Support for yanking and text properties.
2116 (defvar yank-excluded-properties)
2118 (defun remove-yank-excluded-properties (start end)
2119 "Remove `yank-excluded-properties' between START and END positions.
2120 Replaces `category' properties with their defined properties."
2121 (let ((inhibit-read-only t))
2122 ;; Replace any `category' property with the properties it stands for.
2123 (unless (memq yank-excluded-properties '(t nil))
2126 (while (< (point) end)
2127 (let ((cat (get-text-property (point) 'category))
2130 (next-single-property-change (point) 'category nil end))
2132 (let (run-end2 original)
2133 (remove-list-of-text-properties (point) run-end '(category))
2134 (while (< (point) run-end)
2135 (setq run-end2 (next-property-change (point) nil run-end))
2136 (setq original (text-properties-at (point)))
2137 (set-text-properties (point) run-end2 (symbol-plist cat))
2138 (add-text-properties (point) run-end2 original)
2139 (goto-char run-end2))))
2140 (goto-char run-end)))))
2141 (if (eq yank-excluded-properties t)
2142 (set-text-properties start end nil)
2143 (remove-list-of-text-properties start end yank-excluded-properties))))
2145 (defvar yank-undo-function)
2147 (defun insert-for-yank (string)
2148 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2150 See `insert-for-yank-1' for more details."
2152 (while (setq to (next-single-property-change 0 'yank-handler string))
2153 (insert-for-yank-1 (substring string 0 to))
2154 (setq string (substring string to))))
2155 (insert-for-yank-1 string))
2157 (defun insert-for-yank-1 (string)
2158 "Insert STRING at point, stripping some text properties.
2160 Strip text properties from the inserted text according to
2161 `yank-excluded-properties'. Otherwise just like (insert STRING).
2163 If STRING has a non-nil `yank-handler' property on the first character,
2164 the normal insert behavior is modified in various ways. The value of
2165 the yank-handler property must be a list with one to four elements
2166 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2167 When FUNCTION is present and non-nil, it is called instead of `insert'
2168 to insert the string. FUNCTION takes one argument--the object to insert.
2169 If PARAM is present and non-nil, it replaces STRING as the object
2170 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2171 `yank-rectangle', PARAM may be a list of strings to insert as a
2173 If NOEXCLUDE is present and non-nil, the normal removal of the
2174 yank-excluded-properties is not performed; instead FUNCTION is
2175 responsible for removing those properties. This may be necessary
2176 if FUNCTION adjusts point before or after inserting the object.
2177 If UNDO is present and non-nil, it is a function that will be called
2178 by `yank-pop' to undo the insertion of the current object. It is
2179 called with two arguments, the start and end of the current region.
2180 FUNCTION may set `yank-undo-function' to override the UNDO value."
2181 (let* ((handler (and (stringp string)
2182 (get-text-property 0 'yank-handler string)))
2183 (param (or (nth 1 handler) string))
2187 (setq yank-undo-function t)
2188 (if (nth 0 handler) ;; FUNCTION
2189 (funcall (car handler) param)
2193 ;; What should we do with `font-lock-face' properties?
2194 (if font-lock-defaults
2195 ;; No, just wipe them.
2196 (remove-list-of-text-properties opoint end '(font-lock-face))
2197 ;; Convert them to `face'.
2200 (while (< (point) end)
2201 (let ((face (get-text-property (point) 'font-lock-face))
2204 (next-single-property-change (point) 'font-lock-face nil end))
2206 (remove-text-properties (point) run-end '(font-lock-face nil))
2207 (put-text-property (point) run-end 'face face))
2208 (goto-char run-end)))))
2210 (unless (nth 2 handler) ;; NOEXCLUDE
2211 (remove-yank-excluded-properties opoint (point)))
2213 ;; If last inserted char has properties, mark them as rear-nonsticky.
2214 (if (and (> end opoint)
2215 (text-properties-at (1- end)))
2216 (put-text-property (1- end) end 'rear-nonsticky t))
2218 (if (eq yank-undo-function t) ;; not set by FUNCTION
2219 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2220 (if (nth 4 handler) ;; COMMAND
2221 (setq this-command (nth 4 handler)))))
2223 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2224 "Insert before point a substring of BUFFER, without text properties.
2225 BUFFER may be a buffer or a buffer name.
2226 Arguments START and END are character positions specifying the substring.
2227 They default to the values of (point-min) and (point-max) in BUFFER."
2228 (let ((opoint (point)))
2229 (insert-buffer-substring buffer start end)
2230 (let ((inhibit-read-only t))
2231 (set-text-properties opoint (point) nil))))
2233 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2234 "Insert before point a part of BUFFER, stripping some text properties.
2235 BUFFER may be a buffer or a buffer name.
2236 Arguments START and END are character positions specifying the substring.
2237 They default to the values of (point-min) and (point-max) in BUFFER.
2238 Strip text properties from the inserted text according to
2239 `yank-excluded-properties'."
2240 ;; Since the buffer text should not normally have yank-handler properties,
2241 ;; there is no need to handle them here.
2242 (let ((opoint (point)))
2243 (insert-buffer-substring buffer start end)
2244 (remove-yank-excluded-properties opoint (point))))
2247 ;;;; Synchronous shell commands.
2249 (defun start-process-shell-command (name buffer &rest args)
2250 "Start a program in a subprocess. Return the process object for it.
2251 NAME is name for process. It is modified if necessary to make it unique.
2252 BUFFER is the buffer (or buffer name) to associate with the process.
2253 Process output goes at end of that buffer, unless you specify
2254 an output stream or filter function to handle the output.
2255 BUFFER may be also nil, meaning that this process is not associated
2257 COMMAND is the name of a shell command.
2258 Remaining arguments are the arguments for the command; they are all
2259 spliced together with blanks separating between each two of them, before
2260 passing the command to the shell.
2261 Wildcards and redirection are handled as usual in the shell.
2263 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
2265 ((eq system-type 'vax-vms)
2266 (apply 'start-process name buffer args))
2267 ;; We used to use `exec' to replace the shell with the command,
2268 ;; but that failed to handle (...) and semicolon, etc.
2270 (start-process name buffer shell-file-name shell-command-switch
2271 (mapconcat 'identity args " ")))))
2273 (defun call-process-shell-command (command &optional infile buffer display
2275 "Execute the shell command COMMAND synchronously in separate process.
2276 The remaining arguments are optional.
2277 The program's input comes from file INFILE (nil means `/dev/null').
2278 Insert output in BUFFER before point; t means current buffer;
2279 nil for BUFFER means discard it; 0 means discard and don't wait.
2280 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2281 REAL-BUFFER says what to do with standard output, as above,
2282 while STDERR-FILE says what to do with standard error in the child.
2283 STDERR-FILE may be nil (discard standard error output),
2284 t (mix it with ordinary output), or a file name string.
2286 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2287 Remaining arguments are strings passed as additional arguments for COMMAND.
2288 Wildcards and redirection are handled as usual in the shell.
2290 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2291 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2292 status or a signal description string.
2293 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2295 ((eq system-type 'vax-vms)
2296 (apply 'call-process command infile buffer display args))
2297 ;; We used to use `exec' to replace the shell with the command,
2298 ;; but that failed to handle (...) and semicolon, etc.
2300 (call-process shell-file-name
2301 infile buffer display
2302 shell-command-switch
2303 (mapconcat 'identity (cons command args) " ")))))
2305 ;;;; Lisp macros to do various things temporarily.
2307 (defmacro with-current-buffer (buffer &rest body)
2308 "Execute the forms in BODY with BUFFER temporarily current.
2309 BUFFER can be a buffer or a buffer name.
2310 The value returned is the value of the last form in BODY.
2311 See also `with-temp-buffer'."
2312 (declare (indent 1) (debug t))
2313 `(save-current-buffer
2314 (set-buffer ,buffer)
2317 (defmacro with-selected-window (window &rest body)
2318 "Execute the forms in BODY with WINDOW as the selected window.
2319 The value returned is the value of the last form in BODY.
2321 This macro saves and restores the current buffer, since otherwise
2322 its normal operation could potentially make a different
2323 buffer current. It does not alter the buffer list ordering.
2325 This macro saves and restores the selected window, as well as
2326 the selected window in each frame. If the previously selected
2327 window of some frame is no longer live at the end of BODY, that
2328 frame's selected window is left alone. If the selected window is
2329 no longer live, then whatever window is selected at the end of
2330 BODY remains selected.
2331 See also `with-temp-buffer'."
2332 (declare (indent 1) (debug t))
2333 ;; Most of this code is a copy of save-selected-window.
2334 `(let ((save-selected-window-window (selected-window))
2335 ;; It is necessary to save all of these, because calling
2336 ;; select-window changes frame-selected-window for whatever
2337 ;; frame that window is in.
2338 (save-selected-window-alist
2339 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2341 (save-current-buffer
2343 (progn (select-window ,window 'norecord)
2345 (dolist (elt save-selected-window-alist)
2346 (and (frame-live-p (car elt))
2347 (window-live-p (cadr elt))
2348 (set-frame-selected-window (car elt) (cadr elt))))
2349 (if (window-live-p save-selected-window-window)
2350 (select-window save-selected-window-window 'norecord))))))
2352 (defmacro with-temp-file (file &rest body)
2353 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2354 The value returned is the value of the last form in BODY.
2355 See also `with-temp-buffer'."
2357 (let ((temp-file (make-symbol "temp-file"))
2358 (temp-buffer (make-symbol "temp-buffer")))
2359 `(let ((,temp-file ,file)
2361 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2364 (with-current-buffer ,temp-buffer
2366 (with-current-buffer ,temp-buffer
2368 (write-region (point-min) (point-max) ,temp-file nil 0)))
2369 (and (buffer-name ,temp-buffer)
2370 (kill-buffer ,temp-buffer))))))
2372 (defmacro with-temp-message (message &rest body)
2373 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2374 The original message is restored to the echo area after BODY has finished.
2375 The value returned is the value of the last form in BODY.
2376 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2377 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2378 Use a MESSAGE of \"\" to temporarily clear the echo area."
2380 (let ((current-message (make-symbol "current-message"))
2381 (temp-message (make-symbol "with-temp-message")))
2382 `(let ((,temp-message ,message)
2387 (setq ,current-message (current-message))
2388 (message "%s" ,temp-message))
2391 (if ,current-message
2392 (message "%s" ,current-message)
2395 (defmacro with-temp-buffer (&rest body)
2396 "Create a temporary buffer, and evaluate BODY there like `progn'.
2397 See also `with-temp-file' and `with-output-to-string'."
2398 (declare (indent 0) (debug t))
2399 (let ((temp-buffer (make-symbol "temp-buffer")))
2400 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2402 (with-current-buffer ,temp-buffer
2404 (and (buffer-name ,temp-buffer)
2405 (kill-buffer ,temp-buffer))))))
2407 (defmacro with-output-to-string (&rest body)
2408 "Execute BODY, return the text it sent to `standard-output', as a string."
2409 (declare (indent 0) (debug t))
2410 `(let ((standard-output
2411 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2412 (let ((standard-output standard-output))
2414 (with-current-buffer standard-output
2417 (kill-buffer nil)))))
2419 (defmacro with-local-quit (&rest body)
2420 "Execute BODY, allowing quits to terminate BODY but not escape further.
2421 When a quit terminates BODY, `with-local-quit' returns nil but
2422 requests another quit. That quit will be processed as soon as quitting
2423 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2424 (declare (debug t) (indent 0))
2425 `(condition-case nil
2426 (let ((inhibit-quit nil))
2428 (quit (setq quit-flag t)
2429 ;; This call is to give a chance to handle quit-flag
2430 ;; in case inhibit-quit is nil.
2431 ;; Without this, it will not be handled until the next function
2432 ;; call, and that might allow it to exit thru a condition-case
2433 ;; that intends to handle the quit signal next time.
2434 (eval '(ignore nil)))))
2436 (defmacro while-no-input (&rest body)
2437 "Execute BODY only as long as there's no pending input.
2438 If input arrives, that ends the execution of BODY,
2439 and `while-no-input' returns t. Quitting makes it return nil.
2440 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2441 (declare (debug t) (indent 0))
2442 (let ((catch-sym (make-symbol "input")))
2445 (let ((throw-on-input ',catch-sym))
2446 (or (input-pending-p)
2449 (defmacro combine-after-change-calls (&rest body)
2450 "Execute BODY, but don't call the after-change functions till the end.
2451 If BODY makes changes in the buffer, they are recorded
2452 and the functions on `after-change-functions' are called several times
2453 when BODY is finished.
2454 The return value is the value of the last form in BODY.
2456 If `before-change-functions' is non-nil, then calls to the after-change
2457 functions can't be deferred, so in that case this macro has no effect.
2459 Do not alter `after-change-functions' or `before-change-functions'
2461 (declare (indent 0) (debug t))
2463 (let ((combine-after-change-calls t))
2465 (combine-after-change-execute)))
2467 ;;;; Constructing completion tables.
2469 (defmacro dynamic-completion-table (fun)
2470 "Use function FUN as a dynamic completion table.
2471 FUN is called with one argument, the string for which completion is required,
2472 and it should return an alist containing all the intended possible
2473 completions. This alist may be a full list of possible completions so that FUN
2474 can ignore the value of its argument. If completion is performed in the
2475 minibuffer, FUN will be called in the buffer from which the minibuffer was
2478 The result of the `dynamic-completion-table' form is a function
2479 that can be used as the ALIST argument to `try-completion' and
2480 `all-completion'. See Info node `(elisp)Programmed Completion'."
2481 (declare (debug (lambda-expr)))
2482 (let ((win (make-symbol "window"))
2483 (string (make-symbol "string"))
2484 (predicate (make-symbol "predicate"))
2485 (mode (make-symbol "mode")))
2486 `(lambda (,string ,predicate ,mode)
2487 (with-current-buffer (let ((,win (minibuffer-selected-window)))
2488 (if (window-live-p ,win) (window-buffer ,win)
2491 ((eq ,mode t) (all-completions ,string (,fun ,string) ,predicate))
2492 ((not ,mode) (try-completion ,string (,fun ,string) ,predicate))
2493 (t (test-completion ,string (,fun ,string) ,predicate)))))))
2495 (defmacro lazy-completion-table (var fun)
2496 ;; We used to have `&rest args' where `args' were evaluated late (at the
2497 ;; time of the call to `fun'), which was counter intuitive. But to get
2498 ;; them to be evaluated early, we have to either use lexical-let (which is
2499 ;; not available in subr.el) or use `(lambda (,str) ...) which prevents the use
2500 ;; of lexical-let in the callers.
2501 ;; So we just removed the argument. Callers can then simply use either of:
2502 ;; (lazy-completion-table var (lambda () (fun x y)))
2504 ;; (lazy-completion-table var `(lambda () (fun ',x ',y)))
2506 ;; (lexical-let ((x x)) ((y y))
2507 ;; (lazy-completion-table var (lambda () (fun x y))))
2508 ;; depending on the behavior they want.
2509 "Initialize variable VAR as a lazy completion table.
2510 If the completion table VAR is used for the first time (e.g., by passing VAR
2511 as an argument to `try-completion'), the function FUN is called with no
2512 arguments. FUN must return the completion table that will be stored in VAR.
2513 If completion is requested in the minibuffer, FUN will be called in the buffer
2514 from which the minibuffer was entered. The return value of
2515 `lazy-completion-table' must be used to initialize the value of VAR.
2517 You should give VAR a non-nil `risky-local-variable' property."
2518 (declare (debug (symbol lambda-expr)))
2519 (let ((str (make-symbol "string")))
2520 `(dynamic-completion-table
2522 (when (functionp ,var)
2526 (defmacro complete-in-turn (a b)
2527 "Create a completion table that first tries completion in A and then in B.
2528 A and B should not be costly (or side-effecting) expressions."
2529 (declare (debug (def-form def-form)))
2530 `(lambda (string predicate mode)
2533 (or (all-completions string ,a predicate)
2534 (all-completions string ,b predicate)))
2536 (or (try-completion string ,a predicate)
2537 (try-completion string ,b predicate)))
2539 (or (test-completion string ,a predicate)
2540 (test-completion string ,b predicate))))))
2542 ;;; Matching and match data.
2544 (defvar save-match-data-internal)
2546 ;; We use save-match-data-internal as the local variable because
2547 ;; that works ok in practice (people should not use that variable elsewhere).
2548 ;; We used to use an uninterned symbol; the compiler handles that properly
2549 ;; now, but it generates slower code.
2550 (defmacro save-match-data (&rest body)
2551 "Execute the BODY forms, restoring the global value of the match data.
2552 The value returned is the value of the last form in BODY."
2553 ;; It is better not to use backquote here,
2554 ;; because that makes a bootstrapping problem
2555 ;; if you need to recompile all the Lisp files using interpreted code.
2556 (declare (indent 0) (debug t))
2558 '((save-match-data-internal (match-data)))
2559 (list 'unwind-protect
2561 ;; It is safe to free (evaporate) markers immediately here,
2562 ;; as Lisp programs should not copy from save-match-data-internal.
2563 '(set-match-data save-match-data-internal 'evaporate))))
2565 (defun match-string (num &optional string)
2566 "Return string of text matched by last search.
2567 NUM specifies which parenthesized expression in the last regexp.
2568 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2569 Zero means the entire text matched by the whole regexp or whole string.
2570 STRING should be given if the last search was by `string-match' on STRING."
2571 (if (match-beginning num)
2573 (substring string (match-beginning num) (match-end num))
2574 (buffer-substring (match-beginning num) (match-end num)))))
2576 (defun match-string-no-properties (num &optional string)
2577 "Return string of text matched by last search, without text properties.
2578 NUM specifies which parenthesized expression in the last regexp.
2579 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2580 Zero means the entire text matched by the whole regexp or whole string.
2581 STRING should be given if the last search was by `string-match' on STRING."
2582 (if (match-beginning num)
2584 (substring-no-properties string (match-beginning num)
2586 (buffer-substring-no-properties (match-beginning num)
2589 (defun looking-back (regexp &optional limit greedy)
2590 "Return non-nil if text before point matches regular expression REGEXP.
2591 Like `looking-at' except matches before point, and is slower.
2592 LIMIT if non-nil speeds up the search by specifying a minimum
2593 starting position, to avoid checking matches that would start
2596 If GREEDY is non-nil, extend the match backwards as far as possible,
2597 stopping when a single additional previous character cannot be part
2598 of a match for REGEXP."
2599 (let ((start (point))
2602 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2604 (if (and greedy pos)
2606 (narrow-to-region (point-min) start)
2607 (while (and (> pos (point-min))
2611 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2612 (setq pos (1- pos)))
2615 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2618 (defun subregexp-context-p (regexp pos &optional start)
2619 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2620 A subregexp context is one where a sub-regexp can appear.
2621 A non-subregexp context is for example within brackets, or within a
2622 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2623 If START is non-nil, it should be a position in REGEXP, smaller
2624 than POS, and known to be in a subregexp context."
2625 ;; Here's one possible implementation, with the great benefit that it
2626 ;; reuses the regexp-matcher's own parser, so it understands all the
2627 ;; details of the syntax. A disadvantage is that it needs to match the
2631 (string-match (substring regexp (or start 0) pos) "")
2634 (not (member (cadr err) '("Unmatched [ or [^"
2636 "Trailing backslash")))))
2637 ;; An alternative implementation:
2638 ;; (defconst re-context-re
2639 ;; (let* ((harmless-ch "[^\\[]")
2640 ;; (harmless-esc "\\\\[^{]")
2641 ;; (class-harmless-ch "[^][]")
2642 ;; (class-lb-harmless "[^]:]")
2643 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2644 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2645 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2647 ;; (concat "\\[^?]?"
2648 ;; "\\(" class-harmless-ch
2649 ;; "\\|" class-lb "\\)*"
2650 ;; "\\[?]")) ; special handling for bare [ at end of re
2651 ;; (braces "\\\\{[0-9,]+\\\\}"))
2652 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2653 ;; "\\|" class "\\|" braces "\\)*\\'"))
2654 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2655 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2660 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2661 "The default value of separators for `split-string'.
2663 A regexp matching strings of whitespace. May be locale-dependent
2664 \(as yet unimplemented). Should not match non-breaking spaces.
2666 Warning: binding this to a different value and using it as default is
2667 likely to have undesired semantics.")
2669 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2670 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2671 ;; expression leads to the equivalent implementation that if SEPARATORS
2672 ;; is defaulted, OMIT-NULLS is treated as t.
2673 (defun split-string (string &optional separators omit-nulls)
2674 "Split STRING into substrings bounded by matches for SEPARATORS.
2676 The beginning and end of STRING, and each match for SEPARATORS, are
2677 splitting points. The substrings matching SEPARATORS are removed, and
2678 the substrings between the splitting points are collected as a list,
2681 If SEPARATORS is non-nil, it should be a regular expression matching text
2682 which separates, but is not part of, the substrings. If nil it defaults to
2683 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2684 OMIT-NULLS is forced to t.
2686 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2687 that for the default value of SEPARATORS leading and trailing whitespace
2688 are effectively trimmed). If nil, all zero-length substrings are retained,
2689 which correctly parses CSV format, for example.
2691 Note that the effect of `(split-string STRING)' is the same as
2692 `(split-string STRING split-string-default-separators t)'). In the rare
2693 case that you wish to retain zero-length substrings when splitting on
2694 whitespace, use `(split-string STRING split-string-default-separators)'.
2696 Modifies the match data; use `save-match-data' if necessary."
2697 (let ((keep-nulls (not (if separators omit-nulls t)))
2698 (rexp (or separators split-string-default-separators))
2702 (while (and (string-match rexp string
2704 (= start (match-beginning 0))
2705 (< start (length string)))
2707 (< start (length string)))
2709 (if (or keep-nulls (< start (match-beginning 0)))
2711 (cons (substring string start (match-beginning 0))
2713 (setq start (match-end 0)))
2714 (if (or keep-nulls (< start (length string)))
2716 (cons (substring string start)
2720 ;;;; Replacement in strings.
2722 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2723 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2724 Unless optional argument INPLACE is non-nil, return a new string."
2725 (let ((i (length string))
2726 (newstr (if inplace string (copy-sequence string))))
2729 (if (eq (aref newstr i) fromchar)
2730 (aset newstr i tochar)))
2733 (defun replace-regexp-in-string (regexp rep string &optional
2734 fixedcase literal subexp start)
2735 "Replace all matches for REGEXP with REP in STRING.
2737 Return a new string containing the replacements.
2739 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2740 arguments with the same names of function `replace-match'. If START
2741 is non-nil, start replacements at that index in STRING.
2743 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2744 function. If it is a function, it is called with the actual text of each
2745 match, and its value is used as the replacement text. When REP is called,
2746 the match-data are the result of matching REGEXP against a substring
2749 To replace only the first match (if any), make REGEXP match up to \\'
2750 and replace a sub-expression, e.g.
2751 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2755 ;; To avoid excessive consing from multiple matches in long strings,
2756 ;; don't just call `replace-match' continually. Walk down the
2757 ;; string looking for matches of REGEXP and building up a (reversed)
2758 ;; list MATCHES. This comprises segments of STRING which weren't
2759 ;; matched interspersed with replacements for segments that were.
2760 ;; [For a `large' number of replacements it's more efficient to
2761 ;; operate in a temporary buffer; we can't tell from the function's
2762 ;; args whether to choose the buffer-based implementation, though it
2763 ;; might be reasonable to do so for long enough STRING.]
2764 (let ((l (length string))
2765 (start (or start 0))
2768 (while (and (< start l) (string-match regexp string start))
2769 (setq mb (match-beginning 0)
2771 ;; If we matched the empty string, make sure we advance by one char
2772 (when (= me mb) (setq me (min l (1+ mb))))
2773 ;; Generate a replacement for the matched substring.
2774 ;; Operate only on the substring to minimize string consing.
2775 ;; Set up match data for the substring for replacement;
2776 ;; presumably this is likely to be faster than munging the
2777 ;; match data directly in Lisp.
2778 (string-match regexp (setq str (substring string mb me)))
2780 (cons (replace-match (if (stringp rep)
2782 (funcall rep (match-string 0 str)))
2783 fixedcase literal str subexp)
2784 (cons (substring string start mb) ; unmatched prefix
2787 ;; Reconstruct a string from the pieces.
2788 (setq matches (cons (substring string start l) matches)) ; leftover
2789 (apply #'concat (nreverse matches)))))
2791 ;;;; invisibility specs
2793 (defun add-to-invisibility-spec (element)
2794 "Add ELEMENT to `buffer-invisibility-spec'.
2795 See documentation for `buffer-invisibility-spec' for the kind of elements
2797 (if (eq buffer-invisibility-spec t)
2798 (setq buffer-invisibility-spec (list t)))
2799 (setq buffer-invisibility-spec
2800 (cons element buffer-invisibility-spec)))
2802 (defun remove-from-invisibility-spec (element)
2803 "Remove ELEMENT from `buffer-invisibility-spec'."
2804 (if (consp buffer-invisibility-spec)
2805 (setq buffer-invisibility-spec (delete element buffer-invisibility-spec))))
2809 (defmacro with-syntax-table (table &rest body)
2810 "Evaluate BODY with syntax table of current buffer set to TABLE.
2811 The syntax table of the current buffer is saved, BODY is evaluated, and the
2812 saved table is restored, even in case of an abnormal exit.
2813 Value is what BODY returns."
2815 (let ((old-table (make-symbol "table"))
2816 (old-buffer (make-symbol "buffer")))
2817 `(let ((,old-table (syntax-table))
2818 (,old-buffer (current-buffer)))
2821 (set-syntax-table ,table)
2823 (save-current-buffer
2824 (set-buffer ,old-buffer)
2825 (set-syntax-table ,old-table))))))
2827 (defun make-syntax-table (&optional oldtable)
2828 "Return a new syntax table.
2829 Create a syntax table which inherits from OLDTABLE (if non-nil) or
2830 from `standard-syntax-table' otherwise."
2831 (let ((table (make-char-table 'syntax-table nil)))
2832 (set-char-table-parent table (or oldtable (standard-syntax-table)))
2835 (defun syntax-after (pos)
2836 "Return the raw syntax of the char after POS.
2837 If POS is outside the buffer's accessible portion, return nil."
2838 (unless (or (< pos (point-min)) (>= pos (point-max)))
2839 (let ((st (if parse-sexp-lookup-properties
2840 (get-char-property pos 'syntax-table))))
2842 (aref (or st (syntax-table)) (char-after pos))))))
2844 (defun syntax-class (syntax)
2845 "Return the syntax class part of the syntax descriptor SYNTAX.
2846 If SYNTAX is nil, return nil."
2847 (and syntax (logand (car syntax) 65535)))
2851 (defun text-clone-maintain (ol1 after beg end &optional len)
2852 "Propagate the changes made under the overlay OL1 to the other clones.
2853 This is used on the `modification-hooks' property of text clones."
2854 (when (and after (not undo-in-progress) (overlay-start ol1))
2855 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
2856 (setq beg (max beg (+ (overlay-start ol1) margin)))
2857 (setq end (min end (- (overlay-end ol1) margin)))
2860 (when (overlay-get ol1 'text-clone-syntax)
2861 ;; Check content of the clone's text.
2862 (let ((cbeg (+ (overlay-start ol1) margin))
2863 (cend (- (overlay-end ol1) margin)))
2866 (if (not (re-search-forward
2867 (overlay-get ol1 'text-clone-syntax) cend t))
2868 ;; Mark the overlay for deletion.
2869 (overlay-put ol1 'text-clones nil)
2870 (when (< (match-end 0) cend)
2871 ;; Shrink the clone at its end.
2872 (setq end (min end (match-end 0)))
2873 (move-overlay ol1 (overlay-start ol1)
2874 (+ (match-end 0) margin)))
2875 (when (> (match-beginning 0) cbeg)
2876 ;; Shrink the clone at its beginning.
2877 (setq beg (max (match-beginning 0) beg))
2878 (move-overlay ol1 (- (match-beginning 0) margin)
2879 (overlay-end ol1)))))))
2880 ;; Now go ahead and update the clones.
2881 (let ((head (- beg (overlay-start ol1)))
2882 (tail (- (overlay-end ol1) end))
2883 (str (buffer-substring beg end))
2885 (inhibit-modification-hooks t))
2886 (dolist (ol2 (overlay-get ol1 'text-clones))
2887 (let ((oe (overlay-end ol2)))
2888 (unless (or (eq ol1 ol2) (null oe))
2889 (setq nothing-left nil)
2890 (let ((mod-beg (+ (overlay-start ol2) head)))
2891 ;;(overlay-put ol2 'modification-hooks nil)
2892 (goto-char (- (overlay-end ol2) tail))
2893 (unless (> mod-beg (point))
2894 (save-excursion (insert str))
2895 (delete-region mod-beg (point)))
2896 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
2898 (if nothing-left (delete-overlay ol1))))))))
2900 (defun text-clone-create (start end &optional spreadp syntax)
2901 "Create a text clone of START...END at point.
2902 Text clones are chunks of text that are automatically kept identical:
2903 changes done to one of the clones will be immediately propagated to the other.
2905 The buffer's content at point is assumed to be already identical to
2906 the one between START and END.
2907 If SYNTAX is provided it's a regexp that describes the possible text of
2908 the clones; the clone will be shrunk or killed if necessary to ensure that
2909 its text matches the regexp.
2910 If SPREADP is non-nil it indicates that text inserted before/after the
2911 clone should be incorporated in the clone."
2912 ;; To deal with SPREADP we can either use an overlay with `nil t' along
2913 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
2914 ;; (with a one-char margin at each end) with `t nil'.
2915 ;; We opted for a larger overlay because it behaves better in the case
2916 ;; where the clone is reduced to the empty string (we want the overlay to
2917 ;; stay when the clone's content is the empty string and we want to use
2918 ;; `evaporate' to make sure those overlays get deleted when needed).
2920 (let* ((pt-end (+ (point) (- end start)))
2921 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
2923 (end-margin (if (or (not spreadp)
2924 (>= pt-end (point-max))
2925 (>= start (point-max)))
2927 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
2928 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
2929 (dups (list ol1 ol2)))
2930 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
2931 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
2932 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
2933 ;;(overlay-put ol1 'face 'underline)
2934 (overlay-put ol1 'evaporate t)
2935 (overlay-put ol1 'text-clones dups)
2937 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
2938 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
2939 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
2940 ;;(overlay-put ol2 'face 'underline)
2941 (overlay-put ol2 'evaporate t)
2942 (overlay-put ol2 'text-clones dups)))
2944 ;;;; Mail user agents.
2946 ;; Here we include just enough for other packages to be able
2949 (defun define-mail-user-agent (symbol composefunc sendfunc
2950 &optional abortfunc hookvar)
2951 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
2953 SYMBOL can be any Lisp symbol. Its function definition and/or
2954 value as a variable do not matter for this usage; we use only certain
2955 properties on its property list, to encode the rest of the arguments.
2957 COMPOSEFUNC is program callable function that composes an outgoing
2958 mail message buffer. This function should set up the basics of the
2959 buffer without requiring user interaction. It should populate the
2960 standard mail headers, leaving the `to:' and `subject:' headers blank
2963 COMPOSEFUNC should accept several optional arguments--the same
2964 arguments that `compose-mail' takes. See that function's documentation.
2966 SENDFUNC is the command a user would run to send the message.
2968 Optional ABORTFUNC is the command a user would run to abort the
2969 message. For mail packages that don't have a separate abort function,
2970 this can be `kill-buffer' (the equivalent of omitting this argument).
2972 Optional HOOKVAR is a hook variable that gets run before the message
2973 is actually sent. Callers that use the `mail-user-agent' may
2974 install a hook function temporarily on this hook variable.
2975 If HOOKVAR is nil, `mail-send-hook' is used.
2977 The properties used on SYMBOL are `composefunc', `sendfunc',
2978 `abortfunc', and `hookvar'."
2979 (put symbol 'composefunc composefunc)
2980 (put symbol 'sendfunc sendfunc)
2981 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
2982 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
2984 ;;;; Progress reporters.
2986 ;; Progress reporter has the following structure:
2988 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
2995 ;; This weirdeness is for optimization reasons: we want
2996 ;; `progress-reporter-update' to be as fast as possible, so
2997 ;; `(car reporter)' is better than `(aref reporter 0)'.
2999 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3000 ;; digits of precision, it doesn't really matter here. On the other
3001 ;; hand, it greatly simplifies the code.
3003 (defsubst progress-reporter-update (reporter value)
3004 "Report progress of an operation in the echo area.
3005 However, if the change since last echo area update is too small
3006 or not enough time has passed, then do nothing (see
3007 `make-progress-reporter' for details).
3009 First parameter, REPORTER, should be the result of a call to
3010 `make-progress-reporter'. Second, VALUE, determines the actual
3011 progress of operation; it must be between MIN-VALUE and MAX-VALUE
3012 as passed to `make-progress-reporter'.
3014 This function is very inexpensive, you may not bother how often
3016 (when (>= value (car reporter))
3017 (progress-reporter-do-update reporter value)))
3019 (defun make-progress-reporter (message min-value max-value
3020 &optional current-value
3021 min-change min-time)
3022 "Return progress reporter object to be used with `progress-reporter-update'.
3024 MESSAGE is shown in the echo area. When at least 1% of operation
3025 is complete, the exact percentage will be appended to the
3026 MESSAGE. When you call `progress-reporter-done', word \"done\"
3027 is printed after the MESSAGE. You can change MESSAGE of an
3028 existing progress reporter with `progress-reporter-force-update'.
3030 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
3031 final (100% complete) states of operation. The latter should be
3032 larger; if this is not the case, then simply negate all values.
3033 Optional CURRENT-VALUE specifies the progress by the moment you
3034 call this function. You should omit it or set it to nil in most
3035 cases since it defaults to MIN-VALUE.
3037 Optional MIN-CHANGE determines the minimal change in percents to
3038 report (default is 1%.) Optional MIN-TIME specifies the minimal
3039 time before echo area updates (default is 0.2 seconds.) If
3040 `float-time' function is not present, then time is not tracked
3041 at all. If OS is not capable of measuring fractions of seconds,
3042 then this parameter is effectively rounded up."
3045 (setq min-time 0.2))
3047 (cons min-value ;; Force a call to `message' now
3048 (vector (if (and (fboundp 'float-time)
3054 (if min-change (max (min min-change 50) 1) 1)
3056 (progress-reporter-update reporter (or current-value min-value))
3059 (defun progress-reporter-force-update (reporter value &optional new-message)
3060 "Report progress of an operation in the echo area unconditionally.
3062 First two parameters are the same as for
3063 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
3064 change the displayed message."
3065 (let ((parameters (cdr reporter)))
3067 (aset parameters 3 new-message))
3068 (when (aref parameters 0)
3069 (aset parameters 0 (float-time)))
3070 (progress-reporter-do-update reporter value)))
3072 (defun progress-reporter-do-update (reporter value)
3073 (let* ((parameters (cdr reporter))
3074 (min-value (aref parameters 1))
3075 (max-value (aref parameters 2))
3076 (one-percent (/ (- max-value min-value) 100.0))
3077 (percentage (if (= max-value min-value)
3079 (truncate (/ (- value min-value) one-percent))))
3080 (update-time (aref parameters 0))
3081 (current-time (float-time))
3083 ;; See if enough time has passed since the last update.
3084 (or (not update-time)
3085 (when (>= current-time update-time)
3086 ;; Calculate time for the next update
3087 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3089 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
3090 ;; message this time because not enough time has passed, then use
3091 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
3092 ;; updates closer to MIN-TIME.
3094 (min (+ min-value (* (+ percentage
3095 (if enough-time-passed
3096 (aref parameters 4) ;; MIN-CHANGE
3100 (when (integerp value)
3101 (setcar reporter (ceiling (car reporter))))
3103 ;; Only print message if enough time has passed
3104 (when enough-time-passed
3105 (if (> percentage 0)
3106 (message "%s%d%%" (aref parameters 3) percentage)
3107 (message "%s" (aref parameters 3))))))
3109 (defun progress-reporter-done (reporter)
3110 "Print reporter's message followed by word \"done\" in echo area."
3111 (message "%sdone" (aref (cdr reporter) 3)))
3113 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3114 "Loop a certain number of times and report progress in the echo area.
3115 Evaluate BODY with VAR bound to successive integers running from
3116 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3117 the return value (nil if RESULT is omitted).
3119 At each iteration MESSAGE followed by progress percentage is
3120 printed in the echo area. After the loop is finished, MESSAGE
3121 followed by word \"done\" is printed. This macro is a
3122 convenience wrapper around `make-progress-reporter' and friends.
3124 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3125 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3126 (let ((temp (make-symbol "--dotimes-temp--"))
3127 (temp2 (make-symbol "--dotimes-temp2--"))
3131 (,(car spec) ,start)
3132 (,temp2 (make-progress-reporter ,message ,start ,end)))
3133 (while (< ,(car spec) ,temp)
3135 (progress-reporter-update ,temp2
3136 (setq ,(car spec) (1+ ,(car spec)))))
3137 (progress-reporter-done ,temp2)
3138 nil ,@(cdr (cdr spec)))))
3141 ;;;; Comparing version strings.
3143 (defvar version-separator "."
3144 "*Specify the string used to separate the version elements.
3146 Usually the separator is \".\", but it can be any other string.")
3149 (defvar version-regexp-alist
3150 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3151 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3152 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3153 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3154 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3155 "*Specify association between non-numeric version part and a priority.
3157 This association is used to handle version string like \"1.0pre2\",
3158 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3159 non-numeric part to an integer. For example:
3161 String Version Integer List Version
3162 \"1.0pre2\" (1 0 -1 2)
3163 \"1.0PRE2\" (1 0 -1 2)
3164 \"22.8beta3\" (22 8 -2 3)
3165 \"22.8 Beta3\" (22 8 -2 3)
3166 \"0.9alpha1\" (0 9 -3 1)
3167 \"0.9AlphA1\" (0 9 -3 1)
3168 \"0.9 alpha\" (0 9 -3)
3170 Each element has the following form:
3176 REGEXP regexp used to match non-numeric part of a version string.
3177 It should begin with a `^' anchor and end with a `$' to
3178 prevent false hits. Letter-case is ignored while matching
3181 PRIORITY negative integer which indicate the non-numeric priority.")
3184 (defun version-to-list (ver)
3185 "Convert version string VER into an integer list.
3187 The version syntax is given by the following EBNF:
3189 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3191 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3193 SEPARATOR ::= `version-separator' (which see)
3194 | `version-regexp-alist' (which see).
3196 The NUMBER part is optional if SEPARATOR is a match for an element
3197 in `version-regexp-alist'.
3199 As an example of valid version syntax:
3201 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3203 As an example of invalid version syntax:
3205 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3207 As an example of version convertion:
3209 String Version Integer List Version
3210 \"1.0.7.5\" (1 0 7 5)
3211 \"1.0pre2\" (1 0 -1 2)
3212 \"1.0PRE2\" (1 0 -1 2)
3213 \"22.8beta3\" (22 8 -2 3)
3214 \"22.8Beta3\" (22 8 -2 3)
3215 \"0.9alpha1\" (0 9 -3 1)
3216 \"0.9AlphA1\" (0 9 -3 1)
3217 \"0.9alpha\" (0 9 -3)
3219 See documentation for `version-separator' and `version-regexp-alist'."
3220 (or (and (stringp ver) (> (length ver) 0))
3221 (error "Invalid version string: '%s'" ver))
3222 ;; Change .x.y to 0.x.y
3223 (if (and (>= (length ver) (length version-separator))
3224 (string-equal (substring ver 0 (length version-separator))
3226 (setq ver (concat "0" ver)))
3229 (case-fold-search t) ; ignore case in matching
3231 (while (and (setq s (string-match "[0-9]+" ver i))
3233 ;; handle numeric part
3234 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3237 ;; handle non-numeric part
3238 (when (and (setq s (string-match "[^0-9]+" ver i))
3240 (setq s (substring ver i (match-end 0))
3242 ;; handle alpha, beta, pre, etc. separator
3243 (unless (string= s version-separator)
3244 (setq al version-regexp-alist)
3245 (while (and al (not (string-match (caar al) s)))
3247 (or al (error "Invalid version syntax: '%s'" ver))
3248 (setq lst (cons (cdar al) lst)))))
3250 (error "Invalid version syntax: '%s'" ver)
3254 (defun version-list-< (l1 l2)
3255 "Return t if integer list L1 is lesser than L2.
3257 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3258 etc. That is, the trailing zeroes are irrelevant. Also, integer
3259 list (1) is greater than (1 -1) which is greater than (1 -2)
3260 which is greater than (1 -3)."
3261 (while (and l1 l2 (= (car l1) (car l2)))
3265 ;; l1 not null and l2 not null
3266 ((and l1 l2) (< (car l1) (car l2)))
3267 ;; l1 null and l2 null ==> l1 length = l2 length
3268 ((and (null l1) (null l2)) nil)
3269 ;; l1 not null and l2 null ==> l1 length > l2 length
3270 (l1 (< (version-list-not-zero l1) 0))
3271 ;; l1 null and l2 not null ==> l2 length > l1 length
3272 (t (< 0 (version-list-not-zero l2)))))
3275 (defun version-list-= (l1 l2)
3276 "Return t if integer list L1 is equal to L2.
3278 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3279 etc. That is, the trailing zeroes are irrelevant. Also, integer
3280 list (1) is greater than (1 -1) which is greater than (1 -2)
3281 which is greater than (1 -3)."
3282 (while (and l1 l2 (= (car l1) (car l2)))
3286 ;; l1 not null and l2 not null
3288 ;; l1 null and l2 null ==> l1 length = l2 length
3289 ((and (null l1) (null l2)))
3290 ;; l1 not null and l2 null ==> l1 length > l2 length
3291 (l1 (zerop (version-list-not-zero l1)))
3292 ;; l1 null and l2 not null ==> l2 length > l1 length
3293 (t (zerop (version-list-not-zero l2)))))
3296 (defun version-list-<= (l1 l2)
3297 "Return t if integer list L1 is lesser than or equal to L2.
3299 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3300 etc. That is, the trailing zeroes are irrelevant. Also, integer
3301 list (1) is greater than (1 -1) which is greater than (1 -2)
3302 which is greater than (1 -3)."
3303 (while (and l1 l2 (= (car l1) (car l2)))
3307 ;; l1 not null and l2 not null
3308 ((and l1 l2) (< (car l1) (car l2)))
3309 ;; l1 null and l2 null ==> l1 length = l2 length
3310 ((and (null l1) (null l2)))
3311 ;; l1 not null and l2 null ==> l1 length > l2 length
3312 (l1 (<= (version-list-not-zero l1) 0))
3313 ;; l1 null and l2 not null ==> l2 length > l1 length
3314 (t (<= 0 (version-list-not-zero l2)))))
3316 (defun version-list-not-zero (lst)
3317 "Return the first non-zero element of integer list LST.
3319 If all LST elements are zeroes or LST is nil, return zero."
3320 (while (and lst (zerop (car lst)))
3321 (setq lst (cdr lst)))
3324 ;; there is no element different of zero
3328 (defun version< (v1 v2)
3329 "Return t if version V1 is lesser than V2.
3331 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3332 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3333 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3335 (version-list-< (version-to-list v1) (version-to-list v2)))
3338 (defun version<= (v1 v2)
3339 "Return t if version V1 is lesser than or equal to V2.
3341 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3342 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3343 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3345 (version-list-<= (version-to-list v1) (version-to-list v2)))
3347 (defun version= (v1 v2)
3348 "Return t if version V1 is equal to V2.
3350 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3351 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3352 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3354 (version-list-= (version-to-list v1) (version-to-list v2)))
3358 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3359 ;;; subr.el ends here