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 (defmacro dolist
(spec &rest body
)
113 Evaluate BODY with VAR bound to each car from LIST, in turn.
114 Then evaluate RESULT to get return value, default nil.
116 \(fn (VAR LIST [RESULT]) BODY...)"
117 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
118 (let ((temp (make-symbol "--dolist-temp--")))
119 `(let ((,temp
,(nth 1 spec
))
122 (setq ,(car spec
) (car ,temp
))
123 (setq ,temp
(cdr ,temp
))
125 ,@(if (cdr (cdr spec
))
126 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
)))))))
128 (defmacro dotimes
(spec &rest body
)
129 "Loop a certain number of times.
130 Evaluate BODY with VAR bound to successive integers running from 0,
131 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
132 the return value (nil if RESULT is omitted).
134 \(fn (VAR COUNT [RESULT]) BODY...)"
135 (declare (indent 1) (debug dolist
))
136 (let ((temp (make-symbol "--dotimes-temp--"))
140 (,(car spec
) ,start
))
141 (while (< ,(car spec
) ,temp
)
143 (setq ,(car spec
) (1+ ,(car spec
))))
144 ,@(cdr (cdr spec
)))))
146 (defmacro declare
(&rest specs
)
147 "Do not evaluate any arguments and return nil.
148 Treated as a declaration when used at the right place in a
149 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
152 ;;;; Basic Lisp functions.
154 (defun ignore (&rest ignore
)
155 "Do nothing and return nil.
156 This function accepts any number of arguments, but ignores them."
160 (defun error (&rest args
)
161 "Signal an error, making error message by passing all args to `format'.
162 In Emacs, the convention is that error messages start with a capital
163 letter but *do not* end with a period. Please follow this convention
164 for the sake of consistency."
166 (signal 'error
(list (apply 'format args
)))))
168 ;; We put this here instead of in frame.el so that it's defined even on
169 ;; systems where frame.el isn't loaded.
170 (defun frame-configuration-p (object)
171 "Return non-nil if OBJECT seems to be a frame configuration.
172 Any list whose car is `frame-configuration' is assumed to be a frame
175 (eq (car object
) 'frame-configuration
)))
177 (defun functionp (object)
178 "Non-nil if OBJECT is any kind of function or a special form.
179 Also non-nil if OBJECT is a symbol and its function definition is
180 \(recursively) a function or special form. This does not include
182 (or (and (symbolp object
) (fboundp object
)
184 (setq object
(indirect-function object
))
186 (eq (car-safe object
) 'autoload
)
187 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object
)))))))
188 (subrp object
) (byte-code-function-p object
)
189 (eq (car-safe object
) 'lambda
)))
194 "Return the car of the car of X."
198 "Return the car of the cdr of X."
202 "Return the cdr of the car of X."
206 "Return the cdr of the cdr of X."
209 (defun last (list &optional n
)
210 "Return the last link of LIST. Its car is the last element.
211 If LIST is nil, return nil.
212 If N is non-nil, return the Nth-to-last link of LIST.
213 If N is bigger than the length of LIST, return LIST."
215 (let ((m 0) (p list
))
217 (setq m
(1+ m
) p
(cdr p
)))
219 (if (< n m
) (nthcdr (- m n
) list
) list
)))
220 (while (consp (cdr list
))
221 (setq list
(cdr list
)))
224 (defun butlast (list &optional n
)
225 "Return a copy of LIST with the last N elements removed."
226 (if (and n
(<= n
0)) list
227 (nbutlast (copy-sequence list
) n
)))
229 (defun nbutlast (list &optional n
)
230 "Modifies LIST to remove the last N elements."
231 (let ((m (length list
)))
235 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
238 (defun delete-dups (list)
239 "Destructively remove `equal' duplicates from LIST.
240 Store the result in LIST and return it. LIST must be a proper list.
241 Of several `equal' occurrences of an element in LIST, the first
245 (setcdr tail
(delete (car tail
) (cdr tail
)))
246 (setq tail
(cdr tail
))))
249 (defun number-sequence (from &optional to inc
)
250 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
251 INC is the increment used between numbers in the sequence and defaults to 1.
252 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
253 zero. TO is only included if there is an N for which TO = FROM + N * INC.
254 If TO is nil or numerically equal to FROM, return \(FROM).
255 If INC is positive and TO is less than FROM, or INC is negative
256 and TO is larger than FROM, return nil.
257 If INC is zero and TO is neither nil nor numerically equal to
258 FROM, signal an error.
260 This function is primarily designed for integer arguments.
261 Nevertheless, FROM, TO and INC can be integer or float. However,
262 floating point arithmetic is inexact. For instance, depending on
263 the machine, it may quite well happen that
264 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
265 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
266 elements. Thus, if some of the arguments are floats and one wants
267 to make sure that TO is included, one may have to explicitly write
268 TO as \(+ FROM \(* N INC)) or use a variable whose value was
269 computed with this exact expression. Alternatively, you can,
270 of course, also replace TO with a slightly larger value
271 \(or a slightly more negative value if INC is negative)."
272 (if (or (not to
) (= from to
))
274 (or inc
(setq inc
1))
275 (when (zerop inc
) (error "The increment can not be zero"))
276 (let (seq (n 0) (next from
))
279 (setq seq
(cons next seq
)
281 next
(+ from
(* n inc
))))
283 (setq seq
(cons next seq
)
285 next
(+ from
(* n inc
)))))
288 (defun copy-tree (tree &optional vecp
)
289 "Make a copy of TREE.
290 If TREE is a cons cell, this recursively copies both its car and its cdr.
291 Contrast to `copy-sequence', which copies only along the cdrs. With second
292 argument VECP, this copies vectors as well as conses."
296 (let ((newcar (car tree
)))
297 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
298 (setq newcar
(copy-tree (car tree
) vecp
)))
299 (push newcar result
))
300 (setq tree
(cdr tree
)))
301 (nconc (nreverse result
) tree
))
302 (if (and vecp
(vectorp tree
))
303 (let ((i (length (setq tree
(copy-sequence tree
)))))
304 (while (>= (setq i
(1- i
)) 0)
305 (aset tree i
(copy-tree (aref tree i
) vecp
)))
309 ;;;; Various list-search functions.
311 (defun assoc-default (key alist
&optional test default
)
312 "Find object KEY in a pseudo-alist ALIST.
313 ALIST is a list of conses or objects. Each element (or the element's car,
314 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
315 If that is non-nil, the element matches;
316 then `assoc-default' returns the element's cdr, if it is a cons,
317 or DEFAULT if the element is not a cons.
319 If no element matches, the value is nil.
320 If TEST is omitted or nil, `equal' is used."
321 (let (found (tail alist
) value
)
322 (while (and tail
(not found
))
323 (let ((elt (car tail
)))
324 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
325 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
326 (setq tail
(cdr tail
)))
329 (make-obsolete 'assoc-ignore-case
'assoc-string
)
330 (defun assoc-ignore-case (key alist
)
331 "Like `assoc', but ignores differences in case and text representation.
332 KEY must be a string. Upper-case and lower-case letters are treated as equal.
333 Unibyte strings are converted to multibyte for comparison."
334 (assoc-string key alist t
))
336 (make-obsolete 'assoc-ignore-representation
'assoc-string
)
337 (defun assoc-ignore-representation (key alist
)
338 "Like `assoc', but ignores differences in text representation.
339 KEY must be a string.
340 Unibyte strings are converted to multibyte for comparison."
341 (assoc-string key alist nil
))
343 (defun member-ignore-case (elt list
)
344 "Like `member', but ignores differences in case and text representation.
345 ELT must be a string. Upper-case and lower-case letters are treated as equal.
346 Unibyte strings are converted to multibyte for comparison.
347 Non-strings in LIST are ignored."
349 (not (and (stringp (car list
))
350 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
351 (setq list
(cdr list
)))
354 (defun assq-delete-all (key alist
)
355 "Delete from ALIST all elements whose car is `eq' to KEY.
356 Return the modified alist.
357 Elements of ALIST that are not conses are ignored."
358 (while (and (consp (car alist
))
359 (eq (car (car alist
)) key
))
360 (setq alist
(cdr alist
)))
361 (let ((tail alist
) tail-cdr
)
362 (while (setq tail-cdr
(cdr tail
))
363 (if (and (consp (car tail-cdr
))
364 (eq (car (car tail-cdr
)) key
))
365 (setcdr tail
(cdr tail-cdr
))
366 (setq tail tail-cdr
))))
369 (defun rassq-delete-all (value alist
)
370 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
371 Return the modified alist.
372 Elements of ALIST that are not conses are ignored."
373 (while (and (consp (car alist
))
374 (eq (cdr (car alist
)) value
))
375 (setq alist
(cdr alist
)))
376 (let ((tail alist
) tail-cdr
)
377 (while (setq tail-cdr
(cdr tail
))
378 (if (and (consp (car tail-cdr
))
379 (eq (cdr (car tail-cdr
)) value
))
380 (setcdr tail
(cdr tail-cdr
))
381 (setq tail tail-cdr
))))
384 (defun remove (elt seq
)
385 "Return a copy of SEQ with all occurrences of ELT removed.
386 SEQ must be a list, vector, or string. The comparison is done with `equal'."
388 ;; If SEQ isn't a list, there's no need to copy SEQ because
389 ;; `delete' will return a new object.
391 (delete elt
(copy-sequence seq
))))
393 (defun remq (elt list
)
394 "Return LIST with all occurrences of ELT removed.
395 The comparison is done with `eq'. Contrary to `delq', this does not use
396 side-effects, and the argument LIST is not modified."
398 (delq elt
(copy-sequence list
))
404 "Convert KEYS to the internal Emacs key representation.
405 KEYS should be a string constant in the format used for
406 saving keyboard macros (see `edmacro-mode')."
407 (read-kbd-macro keys
))
413 ;; Prevent the \{...} documentation construct
414 ;; from mentioning keys that run this command.
415 (put 'undefined
'suppress-keymap t
)
417 (defun suppress-keymap (map &optional nodigits
)
418 "Make MAP override all normally self-inserting keys to be undefined.
419 Normally, as an exception, digits and minus-sign are set to make prefix args,
420 but optional second arg NODIGITS non-nil treats them like other chars."
421 (define-key map
[remap self-insert-command
] 'undefined
)
424 (define-key map
"-" 'negative-argument
)
425 ;; Make plain numbers do numeric args.
428 (define-key map
(char-to-string loop
) 'digit-argument
)
429 (setq loop
(1+ loop
))))))
431 (defun define-key-after (keymap key definition
&optional after
)
432 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
433 This is like `define-key' except that the binding for KEY is placed
434 just after the binding for the event AFTER, instead of at the beginning
435 of the map. Note that AFTER must be an event type (like KEY), NOT a command
438 If AFTER is t or omitted, the new binding goes at the end of the keymap.
439 AFTER should be a single event type--a symbol or a character, not a sequence.
441 Bindings are always added before any inherited map.
443 The order of bindings in a keymap matters when it is used as a menu."
444 (unless after
(setq after t
))
446 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
448 (if (<= (length key
) 1) (aref key
0)
449 (setq keymap
(lookup-key keymap
451 (butlast (mapcar 'identity key
)))))
452 (aref key
(1- (length key
)))))
453 (let ((tail keymap
) done inserted
)
454 (while (and (not done
) tail
)
455 ;; Delete any earlier bindings for the same key.
456 (if (eq (car-safe (car (cdr tail
))) key
)
457 (setcdr tail
(cdr (cdr tail
))))
458 ;; If we hit an included map, go down that one.
459 (if (keymapp (car tail
)) (setq tail
(car tail
)))
460 ;; When we reach AFTER's binding, insert the new binding after.
461 ;; If we reach an inherited keymap, insert just before that.
462 ;; If we reach the end of this keymap, insert at the end.
463 (if (or (and (eq (car-safe (car tail
)) after
)
465 (eq (car (cdr tail
)) 'keymap
)
468 ;; Stop the scan only if we find a parent keymap.
469 ;; Keep going past the inserted element
470 ;; so we can delete any duplications that come later.
471 (if (eq (car (cdr tail
)) 'keymap
)
473 ;; Don't insert more than once.
475 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
477 (setq tail
(cdr tail
)))))
479 (defun map-keymap-internal (function keymap
&optional sort-first
)
480 "Implement `map-keymap' with sorting.
481 Don't call this function; it is for internal use only."
484 (map-keymap (lambda (a b
) (push (cons a b
) list
))
486 (setq list
(sort list
488 (setq a
(car a
) b
(car b
))
490 (if (integerp b
) (< a b
)
495 (funcall function
(car p
) (cdr p
))))
496 (map-keymap function keymap
)))
498 (put 'keyboard-translate-table
'char-table-extra-slots
0)
500 (defun keyboard-translate (from to
)
501 "Translate character FROM to TO at a low level.
502 This function creates a `keyboard-translate-table' if necessary
503 and then modifies one entry in it."
504 (or (char-table-p keyboard-translate-table
)
505 (setq keyboard-translate-table
506 (make-char-table 'keyboard-translate-table nil
)))
507 (aset keyboard-translate-table from to
))
509 ;;;; Key binding commands.
511 (defun global-set-key (key command
)
512 "Give KEY a global binding as COMMAND.
513 COMMAND is the command definition to use; usually it is
514 a symbol naming an interactively-callable function.
515 KEY is a key sequence; noninteractively, it is a string or vector
516 of characters or event types, and non-ASCII characters with codes
517 above 127 (such as ISO Latin-1) can be included if you use a vector.
519 Note that if KEY has a local binding in the current buffer,
520 that local binding will continue to shadow any global binding
521 that you make with this function."
522 (interactive "KSet key globally: \nCSet key %s to command: ")
523 (or (vectorp key
) (stringp key
)
524 (signal 'wrong-type-argument
(list 'arrayp key
)))
525 (define-key (current-global-map) key command
))
527 (defun local-set-key (key command
)
528 "Give KEY a local binding as COMMAND.
529 COMMAND is the command definition to use; usually it is
530 a symbol naming an interactively-callable function.
531 KEY is a key sequence; noninteractively, it is a string or vector
532 of characters or event types, and non-ASCII characters with codes
533 above 127 (such as ISO Latin-1) can be included if you use a vector.
535 The binding goes in the current buffer's local map,
536 which in most cases is shared with all other buffers in the same major mode."
537 (interactive "KSet key locally: \nCSet key %s locally to command: ")
538 (let ((map (current-local-map)))
540 (use-local-map (setq map
(make-sparse-keymap))))
541 (or (vectorp key
) (stringp key
)
542 (signal 'wrong-type-argument
(list 'arrayp key
)))
543 (define-key map key command
)))
545 (defun global-unset-key (key)
546 "Remove global binding of KEY.
547 KEY is a string or vector representing a sequence of keystrokes."
548 (interactive "kUnset key globally: ")
549 (global-set-key key nil
))
551 (defun local-unset-key (key)
552 "Remove local binding of KEY.
553 KEY is a string or vector representing a sequence of keystrokes."
554 (interactive "kUnset key locally: ")
555 (if (current-local-map)
556 (local-set-key key nil
))
559 ;;;; substitute-key-definition and its subroutines.
561 (defvar key-substitution-in-progress nil
562 "Used internally by `substitute-key-definition'.")
564 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
565 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
566 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
567 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
568 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
570 If you don't specify OLDMAP, you can usually get the same results
571 in a cleaner way with command remapping, like this:
572 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
573 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
574 ;; Don't document PREFIX in the doc string because we don't want to
575 ;; advertise it. It's meant for recursive calls only. Here's its
578 ;; If optional argument PREFIX is specified, it should be a key
579 ;; prefix, a string. Redefined bindings will then be bound to the
580 ;; original key, with PREFIX added at the front.
581 (or prefix
(setq prefix
""))
582 (let* ((scan (or oldmap keymap
))
583 (prefix1 (vconcat prefix
[nil]))
584 (key-substitution-in-progress
585 (cons scan key-substitution-in-progress)))
586 ;; Scan OLDMAP, finding each char or event-symbol that
587 ;; has any definition, and act on it with hack-key.
590 (aset prefix1 (length prefix) char)
591 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
594 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
595 (let (inner-def skipped menu-item)
596 ;; Find the actual command name within the binding.
597 (if (eq (car-safe defn) 'menu-item)
598 (setq menu-item defn defn (nth 2 defn))
599 ;; Skip past menu-prompt.
600 (while (stringp (car-safe defn))
601 (push (pop defn) skipped))
602 ;; Skip past cached key-equivalence data for menu items.
603 (if (consp (car-safe defn))
604 (setq defn (cdr defn))))
605 (if (or (eq defn olddef)
606 ;; Compare with equal if definition is a key sequence.
607 ;; That is useful for operating on function-key-map.
608 (and (or (stringp defn) (vectorp defn))
609 (equal defn olddef)))
610 (define-key keymap prefix
612 (let ((copy (copy-sequence menu-item)))
613 (setcar (nthcdr 2 copy) newdef)
615 (nconc (nreverse skipped) newdef)))
616 ;; Look past a symbol that names a keymap.
618 (or (indirect-function defn t) defn))
619 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
620 ;; avoid autoloading a keymap. This is mostly done to preserve the
621 ;; original non-autoloading behavior of pre-map-keymap times.
622 (if (and (keymapp inner-def)
623 ;; Avoid recursively scanning
624 ;; where KEYMAP does not have a submap.
625 (let ((elt (lookup-key keymap prefix)))
626 (or (null elt) (natnump elt) (keymapp elt)))
627 ;; Avoid recursively rescanning keymap being scanned.
628 (not (memq inner-def key-substitution-in-progress)))
629 ;; If this one isn't being scanned already, scan it now.
630 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
633 ;;;; The global keymap tree.
635 ;;; global-map, esc-map, and ctl-x-map have their values set up in
636 ;;; keymap.c; we just give them docstrings here.
638 (defvar global-map nil
639 "Default global keymap mapping Emacs keyboard input into commands.
640 The value is a keymap which is usually (but not necessarily) Emacs's
644 "Default keymap for ESC (meta) commands.
645 The normal global definition of the character ESC indirects to this keymap.")
647 (defvar ctl-x-map nil
648 "Default keymap for C-x commands.
649 The normal global definition of the character C-x indirects to this keymap.")
651 (defvar ctl-x-4-map (make-sparse-keymap)
652 "Keymap for subcommands of C-x 4.")
653 (defalias 'ctl-x-4-prefix ctl-x-4-map)
654 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
656 (defvar ctl-x-5-map (make-sparse-keymap)
657 "Keymap for frame commands.")
658 (defalias 'ctl-x-5-prefix ctl-x-5-map)
659 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
662 ;;;; Event manipulation functions.
664 ;; The call to `read' is to ensure that the value is computed at load time
665 ;; and not compiled into the .elc file. The value is negative on most
666 ;; machines, but not on all!
667 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
669 (defun listify-key-sequence (key)
670 "Convert a key sequence to a list of events."
673 (mapcar (function (lambda (c)
675 (logxor c listify-key-sequence-1)
679 (defsubst eventp (obj)
680 "True if the argument is an event object."
681 (or (and (integerp obj)
682 ;; Filter out integers too large to be events.
683 ;; M is the biggest modifier.
684 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
685 (char-valid-p (event-basic-type obj)))
687 (get obj 'event-symbol-elements))
690 (get (car obj) 'event-symbol-elements))))
692 (defun event-modifiers (event)
693 "Return a list of symbols representing the modifier keys in event EVENT.
694 The elements of the list may include `meta', `control',
695 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
697 EVENT may be an event or an event type. If EVENT is a symbol
698 that has never been used in an event that has been read as input
699 in the current Emacs session, then this function can return nil,
700 even when EVENT actually has modifiers."
703 (setq type (car type)))
705 (cdr (get type 'event-symbol-elements))
707 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
708 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
709 (if (not (zerop (logand type ?\M-\^@)))
711 (if (or (not (zerop (logand type ?\C-\^@)))
713 (push 'control list))
714 (if (or (not (zerop (logand type ?\S-\^@)))
715 (/= char (downcase char)))
717 (or (zerop (logand type ?\H-\^@))
719 (or (zerop (logand type ?\s-\^@))
721 (or (zerop (logand type ?\A-\^@))
725 (defun event-basic-type (event)
726 "Return the basic type of the given event (all modifiers removed).
727 The value is a printing character (not upper case) or a symbol.
728 EVENT may be an event or an event type. If EVENT is a symbol
729 that has never been used in an event that has been read as input
730 in the current Emacs session, then this function may return nil."
732 (setq event (car event)))
734 (car (get event 'event-symbol-elements))
735 (let* ((base (logand event (1- ?\A-\^@)))
736 (uncontrolled (if (< base 32) (logior base 64) base)))
737 ;; There are some numbers that are invalid characters and
738 ;; cause `downcase' to get an error.
740 (downcase uncontrolled)
741 (error uncontrolled)))))
743 (defsubst mouse-movement-p (object)
744 "Return non-nil if OBJECT is a mouse movement event."
745 (eq (car-safe object) 'mouse-movement))
747 (defsubst event-start (event)
748 "Return the starting position of EVENT.
749 If EVENT is a mouse or key press or a mouse click, this returns the location
751 If EVENT is a drag, this returns the drag's starting position.
752 The return value is of the form
753 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
754 IMAGE (DX . DY) (WIDTH . HEIGHT))
755 The `posn-' functions access elements of such lists."
756 (if (consp event) (nth 1 event)
757 (list (selected-window) (point) '(0 . 0) 0)))
759 (defsubst event-end (event)
760 "Return the ending location of EVENT.
761 EVENT should be a click, drag, or key press event.
762 If EVENT is a click event, this function is the same as `event-start'.
763 The return value is of the form
764 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
765 IMAGE (DX . DY) (WIDTH . HEIGHT))
766 The `posn-' functions access elements of such lists."
767 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
768 (list (selected-window) (point) '(0 . 0) 0)))
770 (defsubst event-click-count (event)
771 "Return the multi-click count of EVENT, a click or drag event.
772 The return value is a positive integer."
773 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
775 ;;;; Extracting fields of the positions in an event.
777 (defsubst posn-window (position)
778 "Return the window in POSITION.
779 POSITION should be a list of the form returned by the `event-start'
780 and `event-end' functions."
783 (defsubst posn-area (position)
784 "Return the window area recorded in POSITION, or nil for the text area.
785 POSITION should be a list of the form returned by the `event-start'
786 and `event-end' functions."
787 (let ((area (if (consp (nth 1 position))
788 (car (nth 1 position))
790 (and (symbolp area) area)))
792 (defsubst posn-point (position)
793 "Return the buffer location in POSITION.
794 POSITION should be a list of the form returned by the `event-start'
795 and `event-end' functions."
797 (if (consp (nth 1 position))
798 (car (nth 1 position))
801 (defun posn-set-point (position)
802 "Move point to POSITION.
803 Select the corresponding window as well."
804 (if (not (windowp (posn-window position)))
805 (error "Position not in text area of window"))
806 (select-window (posn-window position))
807 (if (numberp (posn-point position))
808 (goto-char (posn-point position))))
810 (defsubst posn-x-y (position)
811 "Return the x and y coordinates in POSITION.
812 POSITION should be a list of the form returned by the `event-start'
813 and `event-end' functions."
816 (defun posn-col-row (position)
817 "Return the nominal column and row in POSITION, measured in characters.
818 The column and row values are approximations calculated from the x
819 and y coordinates in POSITION and the frame's default character width
821 For a scroll-bar event, the result column is 0, and the row
822 corresponds to the vertical position of the click in the scroll bar.
823 POSITION should be a list of the form returned by the `event-start'
824 and `event-end' functions."
825 (let* ((pair (posn-x-y position))
826 (window (posn-window position))
827 (area (posn-area position)))
831 ((eq area 'vertical-scroll-bar)
832 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
833 ((eq area 'horizontal-scroll-bar)
834 (cons (scroll-bar-scale pair (window-width window)) 0))
836 (let* ((frame (if (framep window) window (window-frame window)))
837 (x (/ (car pair) (frame-char-width frame)))
838 (y (/ (cdr pair) (+ (frame-char-height frame)
839 (or (frame-parameter frame 'line-spacing)
844 (defun posn-actual-col-row (position)
845 "Return the actual column and row in POSITION, measured in characters.
846 These are the actual row number in the window and character number in that row.
847 Return nil if POSITION does not contain the actual position; in that case
848 `posn-col-row' can be used to get approximate values.
849 POSITION should be a list of the form returned by the `event-start'
850 and `event-end' functions."
853 (defsubst posn-timestamp (position)
854 "Return the timestamp of POSITION.
855 POSITION should be a list of the form returned by the `event-start'
856 and `event-end' functions."
859 (defsubst posn-string (position)
860 "Return the string object of POSITION.
861 Value is a cons (STRING . STRING-POS), or nil if not a string.
862 POSITION should be a list of the form returned by the `event-start'
863 and `event-end' functions."
866 (defsubst posn-image (position)
867 "Return the image object of POSITION.
868 Value is an list (image ...), or nil if not an image.
869 POSITION should be a list of the form returned by the `event-start'
870 and `event-end' functions."
873 (defsubst posn-object (position)
874 "Return the object (image or string) of POSITION.
875 Value is a list (image ...) for an image object, a cons cell
876 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
877 POSITION should be a list of the form returned by the `event-start'
878 and `event-end' functions."
879 (or (posn-image position) (posn-string position)))
881 (defsubst posn-object-x-y (position)
882 "Return the x and y coordinates relative to the object of POSITION.
883 POSITION should be a list of the form returned by the `event-start'
884 and `event-end' functions."
887 (defsubst posn-object-width-height (position)
888 "Return the pixel width and height of the object of POSITION.
889 POSITION should be a list of the form returned by the `event-start'
890 and `event-end' functions."
894 ;;;; Obsolescent names for functions.
896 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
897 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
898 (define-obsolete-function-alias 'read-input 'read-string "22.1")
899 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
900 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
901 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
903 (make-obsolete 'char-bytes "now always returns 1." "20.4")
905 (defun insert-string (&rest args)
906 "Mocklisp-compatibility insert function.
907 Like the function `insert' except that any argument that is a number
908 is converted into a string by expressing it in decimal."
910 (insert (if (integerp el) (number-to-string el) el))))
911 (make-obsolete 'insert-string 'insert "22.1")
913 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
914 (make-obsolete 'makehash 'make-hash-table "22.1")
916 ;; Some programs still use this as a function.
918 "Return the value of the `baud-rate' variable."
920 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
922 ;; These are used by VM and some old programs
923 (defalias 'focus-frame 'ignore "")
924 (make-obsolete 'focus-frame "it does nothing." "22.1")
925 (defalias 'unfocus-frame 'ignore "")
926 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
929 ;;;; Obsolescence declarations for variables, and aliases.
931 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
932 (make-obsolete-variable 'mode-line-inverse-video "use the appropriate faces instead." "21.1")
933 (make-obsolete-variable 'unread-command-char
934 "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."
937 ;; Lisp manual only updated in 22.1.
938 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
941 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
942 (make-obsolete-variable 'x-lost-selection-hooks 'x-lost-selection-functions "22.1")
943 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
944 (make-obsolete-variable 'x-sent-selection-hooks 'x-sent-selection-functions "22.1")
946 (defvaralias 'messages-buffer-max-lines 'message-log-max)
948 ;;;; Alternate names for functions - these are not being phased out.
950 (defalias 'send-string 'process-send-string)
951 (defalias 'send-region 'process-send-region)
952 (defalias 'string= 'string-equal)
953 (defalias 'string< 'string-lessp)
954 (defalias 'move-marker 'set-marker)
955 (defalias 'rplaca 'setcar)
956 (defalias 'rplacd 'setcdr)
957 (defalias 'beep 'ding) ;preserve lingual purity
958 (defalias 'indent-to-column 'indent-to)
959 (defalias 'backward-delete-char 'delete-backward-char)
960 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
961 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
962 (defalias 'int-to-string 'number-to-string)
963 (defalias 'store-match-data 'set-match-data)
964 (defalias 'make-variable-frame-localizable 'make-variable-frame-local)
965 ;; These are the XEmacs names:
966 (defalias 'point-at-eol 'line-end-position)
967 (defalias 'point-at-bol 'line-beginning-position)
969 (defalias 'user-original-login-name 'user-login-name)
972 ;;;; Hook manipulation functions.
974 (defun make-local-hook (hook)
975 "Make the hook HOOK local to the current buffer.
976 The return value is HOOK.
978 You never need to call this function now that `add-hook' does it for you
979 if its LOCAL argument is non-nil.
981 When a hook is local, its local and global values
982 work in concert: running the hook actually runs all the hook
983 functions listed in *either* the local value *or* the global value
984 of the hook variable.
986 This function works by making t a member of the buffer-local value,
987 which acts as a flag to run the hook functions in the default value as
988 well. This works for all normal hooks, but does not work for most
989 non-normal hooks yet. We will be changing the callers of non-normal
990 hooks so that they can handle localness; this has to be done one by
993 This function does nothing if HOOK is already local in the current
996 Do not use `make-local-variable' to make a hook variable buffer-local."
997 (if (local-variable-p hook)
999 (or (boundp hook) (set hook nil))
1000 (make-local-variable hook)
1001 (set hook (list t)))
1003 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1005 (defun add-hook (hook function &optional append local)
1006 "Add to the value of HOOK the function FUNCTION.
1007 FUNCTION is not added if already present.
1008 FUNCTION is added (if necessary) at the beginning of the hook list
1009 unless the optional argument APPEND is non-nil, in which case
1010 FUNCTION is added at the end.
1012 The optional fourth argument, LOCAL, if non-nil, says to modify
1013 the hook's buffer-local value rather than its default value.
1014 This makes the hook buffer-local if needed, and it makes t a member
1015 of the buffer-local value. That acts as a flag to run the hook
1016 functions in the default value as well as in the local value.
1018 HOOK should be a symbol, and FUNCTION may be any valid function. If
1019 HOOK is void, it is first set to nil. If HOOK's value is a single
1020 function, it is changed to a list of functions."
1021 (or (boundp hook) (set hook nil))
1022 (or (default-boundp hook) (set-default hook nil))
1023 (if local (unless (local-variable-if-set-p hook)
1024 (set (make-local-variable hook) (list t)))
1025 ;; Detect the case where make-local-variable was used on a hook
1026 ;; and do what we used to do.
1027 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1029 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1030 ;; If the hook value is a single function, turn it into a list.
1031 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1032 (setq hook-value (list hook-value)))
1033 ;; Do the actual addition if necessary
1034 (unless (member function hook-value)
1037 (append hook-value (list function))
1038 (cons function hook-value))))
1039 ;; Set the actual variable
1040 (if local (set hook hook-value) (set-default hook hook-value))))
1042 (defun remove-hook (hook function &optional local)
1043 "Remove from the value of HOOK the function FUNCTION.
1044 HOOK should be a symbol, and FUNCTION may be any valid function. If
1045 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1046 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1048 The optional third argument, LOCAL, if non-nil, says to modify
1049 the hook's buffer-local value rather than its default value."
1050 (or (boundp hook) (set hook nil))
1051 (or (default-boundp hook) (set-default hook nil))
1052 ;; Do nothing if LOCAL is t but this hook has no local binding.
1053 (unless (and local (not (local-variable-p hook)))
1054 ;; Detect the case where make-local-variable was used on a hook
1055 ;; and do what we used to do.
1056 (when (and (local-variable-p hook)
1057 (not (and (consp (symbol-value hook))
1058 (memq t (symbol-value hook)))))
1060 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1061 ;; Remove the function, for both the list and the non-list cases.
1062 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1063 (if (equal hook-value function) (setq hook-value nil))
1064 (setq hook-value (delete function (copy-sequence hook-value))))
1065 ;; If the function is on the global hook, we need to shadow it locally
1066 ;;(when (and local (member function (default-value hook))
1067 ;; (not (member (cons 'not function) hook-value)))
1068 ;; (push (cons 'not function) hook-value))
1069 ;; Set the actual variable
1071 (set-default hook hook-value)
1072 (if (equal hook-value '(t))
1073 (kill-local-variable hook)
1074 (set hook hook-value))))))
1076 (defun add-to-list (list-var element &optional append)
1077 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1078 The test for presence of ELEMENT is done with `equal'.
1079 If ELEMENT is added, it is added at the beginning of the list,
1080 unless the optional argument APPEND is non-nil, in which case
1081 ELEMENT is added at the end.
1083 The return value is the new value of LIST-VAR.
1085 If you want to use `add-to-list' on a variable that is not defined
1086 until a certain package is loaded, you should put the call to `add-to-list'
1087 into a hook function that will be run only after loading the package.
1088 `eval-after-load' provides one way to do this. In some cases
1089 other hooks, such as major mode hooks, can do the job."
1090 (if (member element (symbol-value list-var))
1091 (symbol-value list-var)
1094 (append (symbol-value list-var) (list element))
1095 (cons element (symbol-value list-var))))))
1098 (defun add-to-ordered-list (list-var element &optional order)
1099 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1100 The test for presence of ELEMENT is done with `eq'.
1102 The resulting list is reordered so that the elements are in the
1103 order given by each element's numeric list order. Elements
1104 without a numeric list order are placed at the end of the list.
1106 If the third optional argument ORDER is a number (integer or
1107 float), set the element's list order to the given value. If
1108 ORDER is nil or omitted, do not change the numeric order of
1109 ELEMENT. If ORDER has any other value, remove the numeric order
1110 of ELEMENT if it has one.
1112 The list order for each element is stored in LIST-VAR's
1113 `list-order' property.
1115 The return value is the new value of LIST-VAR."
1116 (let ((ordering (get list-var 'list-order)))
1118 (put list-var 'list-order
1119 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1121 (puthash element (and (numberp order) order) ordering))
1122 (unless (memq element (symbol-value list-var))
1123 (set list-var (cons element (symbol-value list-var))))
1124 (set list-var (sort (symbol-value list-var)
1126 (let ((oa (gethash a ordering))
1127 (ob (gethash b ordering)))
1132 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1133 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1134 Return the new history list.
1135 If MAXELT is non-nil, it specifies the maximum length of the history.
1136 Otherwise, the maximum history length is the value of the `history-length'
1137 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1139 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1140 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1141 if it is empty or a duplicate."
1143 (setq maxelt (or (get history-var 'history-length)
1145 (let ((history (symbol-value history-var))
1147 (when (and (listp history)
1149 (not (stringp newelt))
1150 (> (length newelt) 0))
1152 (not (equal (car history) newelt))))
1153 (if history-delete-duplicates
1154 (delete newelt history))
1155 (setq history (cons newelt history))
1156 (when (integerp maxelt)
1159 (setq tail (nthcdr (1- maxelt) history))
1161 (setcdr tail nil)))))
1162 (set history-var history)))
1167 (defvar delay-mode-hooks nil
1168 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1169 (defvar delayed-mode-hooks nil
1170 "List of delayed mode hooks waiting to be run.")
1171 (make-variable-buffer-local 'delayed-mode-hooks)
1172 (put 'delay-mode-hooks 'permanent-local t)
1174 (defvar after-change-major-mode-hook nil
1175 "Normal hook run at the very end of major mode functions.")
1177 (defun run-mode-hooks (&rest hooks)
1178 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1179 Execution is delayed if `delay-mode-hooks' is non-nil.
1180 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1181 after running the mode hooks.
1182 Major mode functions should use this."
1183 (if delay-mode-hooks
1185 (dolist (hook hooks)
1186 (push hook delayed-mode-hooks))
1187 ;; Normal case, just run the hook as before plus any delayed hooks.
1188 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1189 (setq delayed-mode-hooks nil)
1190 (apply 'run-hooks hooks)
1191 (run-hooks 'after-change-major-mode-hook)))
1193 (defmacro delay-mode-hooks (&rest body)
1194 "Execute BODY, but delay any `run-mode-hooks'.
1195 These hooks will be executed by the first following call to
1196 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1197 Only affects hooks run in the current buffer."
1198 (declare (debug t) (indent 0))
1200 (make-local-variable 'delay-mode-hooks)
1201 (let ((delay-mode-hooks t))
1204 ;; PUBLIC: find if the current mode derives from another.
1206 (defun derived-mode-p (&rest modes)
1207 "Non-nil if the current major mode is derived from one of MODES.
1208 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1209 (let ((parent major-mode))
1210 (while (and (not (memq parent modes))
1211 (setq parent (get parent 'derived-mode-parent))))
1216 ;; If a minor mode is not defined with define-minor-mode,
1217 ;; add it here explicitly.
1218 ;; isearch-mode is deliberately excluded, since you should
1219 ;; not call it yourself.
1220 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1221 overwrite-mode view-mode
1223 "List of all minor mode functions.")
1225 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1226 "Register a new minor mode.
1228 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1230 TOGGLE is a symbol which is the name of a buffer-local variable that
1231 is toggled on or off to say whether the minor mode is active or not.
1233 NAME specifies what will appear in the mode line when the minor mode
1234 is active. NAME should be either a string starting with a space, or a
1235 symbol whose value is such a string.
1237 Optional KEYMAP is the keymap for the minor mode that will be added
1238 to `minor-mode-map-alist'.
1240 Optional AFTER specifies that TOGGLE should be added after AFTER
1241 in `minor-mode-alist'.
1243 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1244 It defaults to (and should by convention be) TOGGLE.
1246 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1247 included in the mode-line minor mode menu.
1248 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1249 (unless (memq toggle minor-mode-list)
1250 (push toggle minor-mode-list))
1252 (unless toggle-fun (setq toggle-fun toggle))
1253 (unless (eq toggle-fun toggle)
1254 (put toggle :minor-mode-function toggle-fun))
1255 ;; Add the name to the minor-mode-alist.
1257 (let ((existing (assq toggle minor-mode-alist)))
1259 (setcdr existing (list name))
1260 (let ((tail minor-mode-alist) found)
1261 (while (and tail (not found))
1262 (if (eq after (caar tail))
1264 (setq tail (cdr tail))))
1266 (let ((rest (cdr found)))
1268 (nconc found (list (list toggle name)) rest))
1269 (setq minor-mode-alist (cons (list toggle name)
1270 minor-mode-alist)))))))
1271 ;; Add the toggle to the minor-modes menu if requested.
1272 (when (get toggle :included)
1273 (define-key mode-line-mode-menu
1277 (or (get toggle :menu-tag)
1278 (if (stringp name) name (symbol-name toggle)))
1279 (let ((mode-name (if (symbolp name) (symbol-value name))))
1280 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1281 (concat " (" (match-string 0 mode-name) ")"))))
1283 :button (cons :toggle toggle))))
1285 ;; Add the map to the minor-mode-map-alist.
1287 (let ((existing (assq toggle minor-mode-map-alist)))
1289 (setcdr existing keymap)
1290 (let ((tail minor-mode-map-alist) found)
1291 (while (and tail (not found))
1292 (if (eq after (caar tail))
1294 (setq tail (cdr tail))))
1296 (let ((rest (cdr found)))
1298 (nconc found (list (cons toggle keymap)) rest))
1299 (setq minor-mode-map-alist (cons (cons toggle keymap)
1300 minor-mode-map-alist))))))))
1304 ;; (defvar symbol-file-load-history-loaded nil
1305 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1306 ;; That file records the part of `load-history' for preloaded files,
1307 ;; which is cleared out before dumping to make Emacs smaller.")
1309 ;; (defun load-symbol-file-load-history ()
1310 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1311 ;; That file records the part of `load-history' for preloaded files,
1312 ;; which is cleared out before dumping to make Emacs smaller."
1313 ;; (unless symbol-file-load-history-loaded
1314 ;; (load (expand-file-name
1315 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1316 ;; (if (eq system-type 'ms-dos)
1318 ;; (format "fns-%s.el" emacs-version))
1320 ;; ;; The file name fns-%s.el already has a .el extension.
1322 ;; (setq symbol-file-load-history-loaded t)))
1324 (defun symbol-file (symbol &optional type)
1325 "Return the input source in which SYMBOL was defined.
1326 The value is an absolute file name.
1327 It can also be nil, if the definition is not associated with any file.
1329 If TYPE is nil, then any kind of definition is acceptable.
1330 If TYPE is `defun' or `defvar', that specifies function
1331 definition only or variable definition only.
1332 `defface' specifies a face definition only."
1333 (if (and (or (null type) (eq type 'defun))
1334 (symbolp symbol) (fboundp symbol)
1335 (eq 'autoload (car-safe (symbol-function symbol))))
1336 (nth 1 (symbol-function symbol))
1337 (let ((files load-history)
1341 (if (eq type 'defvar)
1342 ;; Variables are present just as their names.
1343 (member symbol (cdr (car files)))
1344 ;; Other types are represented as (TYPE . NAME).
1345 (member (cons type symbol) (cdr (car files))))
1346 ;; We accept all types, so look for variable def
1347 ;; and then for any other kind.
1348 (or (member symbol (cdr (car files)))
1349 (rassq symbol (cdr (car files)))))
1350 (setq file (car (car files)) files nil))
1351 (setq files (cdr files)))
1355 (defun locate-library (library &optional nosuffix path interactive-call)
1356 "Show the precise file name of Emacs library LIBRARY.
1357 This command searches the directories in `load-path' like `\\[load-library]'
1358 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1359 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1360 to the specified name LIBRARY.
1362 If the optional third arg PATH is specified, that list of directories
1363 is used instead of `load-path'.
1365 When called from a program, the file name is normaly returned as a
1366 string. When run interactively, the argument INTERACTIVE-CALL is t,
1367 and the file name is displayed in the echo area."
1368 (interactive (list (completing-read "Locate library: "
1369 'locate-file-completion
1370 (cons load-path (get-load-suffixes)))
1373 (let ((file (locate-file library
1375 (append (unless nosuffix (get-load-suffixes))
1376 load-file-rep-suffixes))))
1377 (if interactive-call
1379 (message "Library is file %s" (abbreviate-file-name file))
1380 (message "No library %s in search path" library)))
1384 ;;;; Specifying things to do later.
1386 (defmacro eval-at-startup (&rest body)
1387 "Make arrangements to evaluate BODY when Emacs starts up.
1388 If this is run after Emacs startup, evaluate BODY immediately.
1391 This works by adding a function to `before-init-hook'.
1392 That function's doc string says which file created it."
1394 (if command-line-processed
1396 (add-hook 'before-init-hook
1397 '(lambda () ,(concat "From " (or load-file-name "no file"))
1402 (defun load-history-regexp (file)
1403 "Form a regexp to find FILE in `load-history'.
1404 FILE, a string, is described in the function `eval-after-load'."
1405 (if (file-name-absolute-p file)
1406 (setq file (file-truename file)))
1407 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1409 (if (file-name-extension file)
1411 ;; Note: regexp-opt can't be used here, since we need to call
1412 ;; this before Emacs has been fully started. 2006-05-21
1413 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1414 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1417 (defun load-history-filename-element (file-regexp)
1418 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1419 Return nil if there isn't one."
1420 (let* ((loads load-history)
1421 (load-elt (and loads (car loads))))
1424 (or (null (car load-elt))
1425 (not (string-match file-regexp (car load-elt)))))
1426 (setq loads (cdr loads)
1427 load-elt (and loads (car loads)))))
1430 (defun eval-after-load (file form)
1431 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1432 If FILE is already loaded, evaluate FORM right now.
1434 If a matching file is loaded again, FORM will be evaluated again.
1436 If FILE is a string, it may be either an absolute or a relative file
1437 name, and may have an extension \(e.g. \".el\") or may lack one, and
1438 additionally may or may not have an extension denoting a compressed
1439 format \(e.g. \".gz\").
1441 When FILE is absolute, this first converts it to a true name by chasing
1442 symbolic links. Only a file of this name \(see next paragraph regarding
1443 extensions) will trigger the evaluation of FORM. When FILE is relative,
1444 a file whose absolute true name ends in FILE will trigger evaluation.
1446 When FILE lacks an extension, a file name with any extension will trigger
1447 evaluation. Otherwise, its extension must match FILE's. A further
1448 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1451 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1452 is evaluated whenever that feature is `provide'd.
1454 Usually FILE is just a library name like \"font-lock\" or a feature name
1457 This function makes or adds to an entry on `after-load-alist'."
1458 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1459 ;; evaluating it now).
1460 (let* ((regexp-or-feature
1461 (if (stringp file) (load-history-regexp file) file))
1462 (elt (assoc regexp-or-feature after-load-alist)))
1464 (setq elt (list regexp-or-feature))
1465 (push elt after-load-alist))
1466 ;; Add FORM to the element unless it's already there.
1467 (unless (member form (cdr elt))
1468 (nconc elt (list form)))
1470 ;; Is there an already loaded file whose name (or `provide' name)
1472 (if (if (stringp file)
1473 (load-history-filename-element regexp-or-feature)
1477 (defun do-after-load-evaluation (abs-file)
1478 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1479 ABS-FILE, a string, should be the absolute true name of a file just loaded."
1480 (let ((after-load-elts after-load-alist)
1481 a-l-element file-elements file-element form)
1482 (while after-load-elts
1483 (setq a-l-element (car after-load-elts)
1484 after-load-elts (cdr after-load-elts))
1485 (when (and (stringp (car a-l-element))
1486 (string-match (car a-l-element) abs-file))
1487 (while (setq a-l-element (cdr a-l-element)) ; discard the file name
1488 (setq form (car a-l-element))
1491 (defun eval-next-after-load (file)
1492 "Read the following input sexp, and run it whenever FILE is loaded.
1493 This makes or adds to an entry on `after-load-alist'.
1494 FILE should be the name of a library, with no directory name."
1495 (eval-after-load file (read)))
1499 ;; open-network-stream is a wrapper around make-network-process.
1501 (when (featurep 'make-network-process)
1502 (defun open-network-stream (name buffer host service)
1503 "Open a TCP connection for a service to a host.
1504 Returns a subprocess-object to represent the connection.
1505 Input and output work as for subprocesses; `delete-process' closes it.
1507 Args are NAME BUFFER HOST SERVICE.
1508 NAME is name for process. It is modified if necessary to make it unique.
1509 BUFFER is the buffer (or buffer name) to associate with the process.
1510 Process output goes at end of that buffer, unless you specify
1511 an output stream or filter function to handle the output.
1512 BUFFER may be also nil, meaning that this process is not associated
1514 HOST is name of the host to connect to, or its IP address.
1515 SERVICE is name of the service desired, or an integer specifying
1516 a port number to connect to."
1517 (make-network-process :name name :buffer buffer
1518 :host host :service service)))
1522 (make-obsolete 'process-kill-without-query
1523 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1525 (defun process-kill-without-query (process &optional flag)
1526 "Say no query needed if PROCESS is running when Emacs is exited.
1527 Optional second argument if non-nil says to require a query.
1528 Value is t if a query was formerly required."
1529 (let ((old (process-query-on-exit-flag process)))
1530 (set-process-query-on-exit-flag process nil)
1533 ;; process plist management
1535 (defun process-get (process propname)
1536 "Return the value of PROCESS' PROPNAME property.
1537 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1538 (plist-get (process-plist process) propname))
1540 (defun process-put (process propname value)
1541 "Change PROCESS' PROPNAME property to VALUE.
1542 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1543 (set-process-plist process
1544 (plist-put (process-plist process) propname value)))
1547 ;;;; Input and display facilities.
1549 (defvar read-quoted-char-radix 8
1550 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1551 Legitimate radix values are 8, 10 and 16.")
1553 (custom-declare-variable-early
1554 'read-quoted-char-radix 8
1555 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1556 Legitimate radix values are 8, 10 and 16."
1557 :type '(choice (const 8) (const 10) (const 16))
1558 :group 'editing-basics)
1560 (defun read-quoted-char (&optional prompt)
1561 "Like `read-char', but do not allow quitting.
1562 Also, if the first character read is an octal digit,
1563 we read any number of octal digits and return the
1564 specified character code. Any nondigit terminates the sequence.
1565 If the terminator is RET, it is discarded;
1566 any other terminator is used itself as input.
1568 The optional argument PROMPT specifies a string to use to prompt the user.
1569 The variable `read-quoted-char-radix' controls which radix to use
1571 (let ((message-log-max nil) done (first t) (code 0) char translated)
1573 (let ((inhibit-quit first)
1574 ;; Don't let C-h get the help message--only help function keys.
1577 "Type the special character you want to use,
1578 or the octal character code.
1579 RET terminates the character code and is discarded;
1580 any other non-digit terminates the character code and is then used as input."))
1581 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1582 (if inhibit-quit (setq quit-flag nil)))
1583 ;; Translate TAB key into control-I ASCII character, and so on.
1584 ;; Note: `read-char' does it using the `ascii-character' property.
1585 ;; We could try and use read-key-sequence instead, but then C-q ESC
1586 ;; or C-q C-x might not return immediately since ESC or C-x might be
1587 ;; bound to some prefix in function-key-map or key-translation-map.
1588 (setq translated char)
1589 (let ((translation (lookup-key function-key-map (vector char))))
1590 (if (arrayp translation)
1591 (setq translated (aref translation 0))))
1592 (cond ((null translated))
1593 ((not (integerp translated))
1594 (setq unread-command-events (list char)
1596 ((/= (logand translated ?\M-\^@) 0)
1597 ;; Turn a meta-character into a character with the 0200 bit set.
1598 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1600 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1601 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1602 (and prompt (setq prompt (message "%s %c" prompt translated))))
1603 ((and (<= ?a (downcase translated))
1604 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1605 (setq code (+ (* code read-quoted-char-radix)
1606 (+ 10 (- (downcase translated) ?a))))
1607 (and prompt (setq prompt (message "%s %c" prompt translated))))
1608 ((and (not first) (eq translated ?\C-m))
1611 (setq unread-command-events (list char)
1613 (t (setq code translated
1618 (defun read-passwd (prompt &optional confirm default)
1619 "Read a password, prompting with PROMPT, and return it.
1620 If optional CONFIRM is non-nil, read the password twice to make sure.
1621 Optional DEFAULT is a default password to use instead of empty input.
1623 This function echoes `.' for each character that the user types.
1624 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1625 C-g quits; if `inhibit-quit' was non-nil around this function,
1626 then it returns nil if the user types C-g, but quit-flag remains set.
1628 Once the caller uses the password, it can erase the password
1629 by doing (clear-string STRING)."
1633 (while (not success)
1634 (let ((first (read-passwd prompt nil default))
1635 (second (read-passwd "Confirm password: " nil default)))
1636 (if (equal first second)
1638 (and (arrayp second) (clear-string second))
1639 (setq success first))
1640 (and (arrayp first) (clear-string first))
1641 (and (arrayp second) (clear-string second))
1642 (message "Password not repeated accurately; please start over")
1646 ;; Copy it so that add-text-properties won't modify
1647 ;; the object that was passed in by the caller.
1648 (prompt (copy-sequence prompt))
1651 (cursor-in-echo-area t)
1652 (message-log-max nil))
1653 (add-text-properties 0 (length prompt)
1654 minibuffer-prompt-properties prompt)
1655 (while (progn (message "%s%s"
1657 (make-string (length pass) ?.))
1658 (setq c (read-char-exclusive nil t))
1659 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1660 (clear-this-command-keys)
1663 (and (arrayp pass) (clear-string pass))
1665 (if (and (/= c ?\b) (/= c ?\177))
1666 (let* ((new-char (char-to-string c))
1667 (new-pass (concat pass new-char)))
1668 (and (arrayp pass) (clear-string pass))
1669 (clear-string new-char)
1671 (setq pass new-pass))
1672 (if (> (length pass) 0)
1673 (let ((new-pass (substring pass 0 -1)))
1674 (and (arrayp pass) (clear-string pass))
1675 (setq pass new-pass))))))
1677 (or pass default "")))))
1679 ;; This should be used by `call-interactively' for `n' specs.
1680 (defun read-number (prompt &optional default)
1684 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1685 (replace-match (format " (default %s)" default) t t prompt 1)
1686 (replace-regexp-in-string "[ \t]*\\'"
1687 (format " (default %s) " default)
1691 (let ((str (read-from-minibuffer prompt nil nil nil nil
1693 (number-to-string default)))))
1695 ((zerop (length str)) default)
1696 ((stringp str) (read str)))))
1698 (message "Please enter a number.")
1703 ;;; Atomic change groups.
1705 (defmacro atomic-change-group (&rest body)
1706 "Perform BODY as an atomic change group.
1707 This means that if BODY exits abnormally,
1708 all of its changes to the current buffer are undone.
1709 This works regardless of whether undo is enabled in the buffer.
1711 This mechanism is transparent to ordinary use of undo;
1712 if undo is enabled in the buffer and BODY succeeds, the
1713 user can undo the change normally."
1714 (declare (indent 0) (debug t))
1715 (let ((handle (make-symbol "--change-group-handle--"))
1716 (success (make-symbol "--change-group-success--")))
1717 `(let ((,handle (prepare-change-group))
1721 ;; This is inside the unwind-protect because
1722 ;; it enables undo if that was disabled; we need
1723 ;; to make sure that it gets disabled again.
1724 (activate-change-group ,handle)
1727 ;; Either of these functions will disable undo
1728 ;; if it was disabled before.
1730 (accept-change-group ,handle)
1731 (cancel-change-group ,handle))))))
1733 (defun prepare-change-group (&optional buffer)
1734 "Return a handle for the current buffer's state, for a change group.
1735 If you specify BUFFER, make a handle for BUFFER's state instead.
1737 Pass the handle to `activate-change-group' afterward to initiate
1738 the actual changes of the change group.
1740 To finish the change group, call either `accept-change-group' or
1741 `cancel-change-group' passing the same handle as argument. Call
1742 `accept-change-group' to accept the changes in the group as final;
1743 call `cancel-change-group' to undo them all. You should use
1744 `unwind-protect' to make sure the group is always finished. The call
1745 to `activate-change-group' should be inside the `unwind-protect'.
1746 Once you finish the group, don't use the handle again--don't try to
1747 finish the same group twice. For a simple example of correct use, see
1748 the source code of `atomic-change-group'.
1750 The handle records only the specified buffer. To make a multibuffer
1751 change group, call this function once for each buffer you want to
1752 cover, then use `nconc' to combine the returned values, like this:
1754 (nconc (prepare-change-group buffer-1)
1755 (prepare-change-group buffer-2))
1757 You can then activate that multibuffer change group with a single
1758 call to `activate-change-group' and finish it with a single call
1759 to `accept-change-group' or `cancel-change-group'."
1762 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
1763 (list (cons (current-buffer) buffer-undo-list))))
1765 (defun activate-change-group (handle)
1766 "Activate a change group made with `prepare-change-group' (which see)."
1767 (dolist (elt handle)
1768 (with-current-buffer (car elt)
1769 (if (eq buffer-undo-list t)
1770 (setq buffer-undo-list nil)))))
1772 (defun accept-change-group (handle)
1773 "Finish a change group made with `prepare-change-group' (which see).
1774 This finishes the change group by accepting its changes as final."
1775 (dolist (elt handle)
1776 (with-current-buffer (car elt)
1778 (setq buffer-undo-list t)))))
1780 (defun cancel-change-group (handle)
1781 "Finish a change group made with `prepare-change-group' (which see).
1782 This finishes the change group by reverting all of its changes."
1783 (dolist (elt handle)
1784 (with-current-buffer (car elt)
1785 (setq elt (cdr elt))
1787 (if (consp elt) (car elt)))
1789 (if (consp elt) (cdr elt))))
1790 ;; Temporarily truncate the undo log at ELT.
1792 (setcar elt nil) (setcdr elt nil))
1793 (unless (eq last-command 'undo) (undo-start))
1794 ;; Make sure there's no confusion.
1795 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
1796 (error "Undoing to some unrelated state"))
1798 (while (listp pending-undo-list) (undo-more 1))
1799 ;; Reset the modified cons cell ELT to its original content.
1801 (setcar elt old-car)
1802 (setcdr elt old-cdr))
1803 ;; Revert the undo info to what it was when we grabbed the state.
1804 (setq buffer-undo-list elt)))))
1806 ;;;; Display-related functions.
1808 ;; For compatibility.
1809 (defalias 'redraw-modeline 'force-mode-line-update)
1811 (defun force-mode-line-update (&optional all)
1812 "Force redisplay of the current buffer's mode line and header line.
1813 With optional non-nil ALL, force redisplay of all mode lines and
1814 header lines. This function also forces recomputation of the
1815 menu bar menus and the frame title."
1816 (if all (save-excursion (set-buffer (other-buffer))))
1817 (set-buffer-modified-p (buffer-modified-p)))
1819 (defun momentary-string-display (string pos &optional exit-char message)
1820 "Momentarily display STRING in the buffer at POS.
1821 Display remains until next event is input.
1822 Optional third arg EXIT-CHAR can be a character, event or event
1823 description list. EXIT-CHAR defaults to SPC. If the input is
1824 EXIT-CHAR it is swallowed; otherwise it is then available as
1825 input (as a command if nothing else).
1826 Display MESSAGE (optional fourth arg) in the echo area.
1827 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1828 (or exit-char (setq exit-char ?\ ))
1829 (let ((inhibit-read-only t)
1830 ;; Don't modify the undo list at all.
1831 (buffer-undo-list t)
1832 (modified (buffer-modified-p))
1833 (name buffer-file-name)
1839 ;; defeat file locking... don't try this at home, kids!
1840 (setq buffer-file-name nil)
1841 (insert-before-markers string)
1842 (setq insert-end (point))
1843 ;; If the message end is off screen, recenter now.
1844 (if (< (window-end nil t) insert-end)
1845 (recenter (/ (window-height) 2)))
1846 ;; If that pushed message start off the screen,
1847 ;; scroll to start it at the top of the screen.
1848 (move-to-window-line 0)
1853 (message (or message "Type %s to continue editing.")
1854 (single-key-description exit-char))
1856 (if (integerp exit-char)
1859 (setq char (read-char))
1860 (or (eq char exit-char)
1861 (setq unread-command-events (list char))))
1863 ;; `exit-char' is a character, hence it differs
1864 ;; from char, which is an event.
1865 (setq unread-command-events (list char))))
1866 ;; `exit-char' can be an event, or an event description
1868 (setq char (read-event))
1869 (or (eq char exit-char)
1870 (eq char (event-convert-list exit-char))
1871 (setq unread-command-events (list char))))))
1874 (delete-region pos insert-end)))
1875 (setq buffer-file-name name)
1876 (set-buffer-modified-p modified))))
1879 ;;;; Overlay operations
1881 (defun copy-overlay (o)
1882 "Return a copy of overlay O."
1883 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1884 ;; FIXME: there's no easy way to find the
1885 ;; insertion-type of the two markers.
1886 (overlay-buffer o)))
1887 (props (overlay-properties o)))
1889 (overlay-put o1 (pop props) (pop props)))
1892 (defun remove-overlays (&optional beg end name val)
1893 "Clear BEG and END of overlays whose property NAME has value VAL.
1894 Overlays might be moved and/or split.
1895 BEG and END default respectively to the beginning and end of buffer."
1896 (unless beg (setq beg (point-min)))
1897 (unless end (setq end (point-max)))
1899 (setq beg (prog1 end (setq end beg))))
1901 (dolist (o (overlays-in beg end))
1902 (when (eq (overlay-get o name) val)
1903 ;; Either push this overlay outside beg...end
1904 ;; or split it to exclude beg...end
1905 ;; or delete it entirely (if it is contained in beg...end).
1906 (if (< (overlay-start o) beg)
1907 (if (> (overlay-end o) end)
1909 (move-overlay (copy-overlay o)
1910 (overlay-start o) beg)
1911 (move-overlay o end (overlay-end o)))
1912 (move-overlay o (overlay-start o) beg))
1913 (if (> (overlay-end o) end)
1914 (move-overlay o end (overlay-end o))
1915 (delete-overlay o)))))))
1919 (defvar suspend-hook nil
1920 "Normal hook run by `suspend-emacs', before suspending.")
1922 (defvar suspend-resume-hook nil
1923 "Normal hook run by `suspend-emacs', after Emacs is continued.")
1925 (defvar temp-buffer-show-hook nil
1926 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
1927 When the hook runs, the temporary buffer is current, and the window it
1928 was displayed in is selected. This hook is normally set up with a
1929 function to make the buffer read only, and find function names and
1930 variable names in it, provided the major mode is still Help mode.")
1932 (defvar temp-buffer-setup-hook nil
1933 "Normal hook run by `with-output-to-temp-buffer' at the start.
1934 When the hook runs, the temporary buffer is current.
1935 This hook is normally set up with a function to put the buffer in Help
1938 ;; Avoid compiler warnings about this variable,
1939 ;; which has a special meaning on certain system types.
1940 (defvar buffer-file-type nil
1941 "Non-nil if the visited file is a binary file.
1942 This variable is meaningful on MS-DOG and Windows NT.
1943 On those systems, it is automatically local in every buffer.
1944 On other systems, this variable is normally always nil.")
1946 ;; The `assert' macro from the cl package signals
1947 ;; `cl-assertion-failed' at runtime so always define it.
1948 (put 'cl-assertion-failed 'error-conditions '(error))
1949 (put 'cl-assertion-failed 'error-message "Assertion failed")
1952 ;;;; Misc. useful functions.
1954 (defun find-tag-default ()
1955 "Determine default tag to search for, based on text at point.
1956 If there is no plausible default, return nil."
1958 (while (looking-at "\\sw\\|\\s_")
1960 (if (or (re-search-backward "\\sw\\|\\s_"
1961 (save-excursion (beginning-of-line) (point))
1963 (re-search-forward "\\(\\sw\\|\\s_\\)+"
1964 (save-excursion (end-of-line) (point))
1967 (goto-char (match-end 0))
1969 (buffer-substring-no-properties
1971 (progn (forward-sexp -1)
1972 (while (looking-at "\\s'")
1978 (defun play-sound (sound)
1979 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
1980 The following keywords are recognized:
1982 :file FILE - read sound data from FILE. If FILE isn't an
1983 absolute file name, it is searched in `data-directory'.
1985 :data DATA - read sound data from string DATA.
1987 Exactly one of :file or :data must be present.
1989 :volume VOL - set volume to VOL. VOL must an integer in the
1990 range 0..100 or a float in the range 0..1.0. If not specified,
1991 don't change the volume setting of the sound device.
1993 :device DEVICE - play sound on DEVICE. If not specified,
1994 a system-dependent default device name is used."
1995 (if (fboundp 'play-sound-internal)
1996 (play-sound-internal sound)
1997 (error "This Emacs binary lacks sound support")))
1999 (defun shell-quote-argument (argument)
2000 "Quote an argument for passing as argument to an inferior shell."
2001 (if (eq system-type 'ms-dos)
2002 ;; Quote using double quotes, but escape any existing quotes in
2003 ;; the argument with backslashes.
2007 (if (or (null (string-match "[^\"]" argument))
2008 (< (match-end 0) (length argument)))
2009 (while (string-match "[\"]" argument start)
2010 (setq end (match-beginning 0)
2011 result (concat result (substring argument start end)
2012 "\\" (substring argument end (1+ end)))
2014 (concat "\"" result (substring argument start) "\""))
2015 (if (eq system-type 'windows-nt)
2016 (concat "\"" argument "\"")
2017 (if (equal argument "")
2019 ;; Quote everything except POSIX filename characters.
2020 ;; This should be safe enough even for really weird shells.
2021 (let ((result "") (start 0) end)
2022 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2023 (setq end (match-beginning 0)
2024 result (concat result (substring argument start end)
2025 "\\" (substring argument end (1+ end)))
2027 (concat result (substring argument start)))))))
2029 (defun string-or-null-p (object)
2030 "Return t if OBJECT is a string or nil.
2031 Otherwise, return nil."
2032 (or (stringp object) (null object)))
2034 (defun booleanp (object)
2035 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2036 (memq object '(nil t)))
2038 (defun field-at-pos (pos)
2039 "Return the field at position POS, taking stickiness etc into account"
2040 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2041 (if (eq raw-field 'boundary)
2042 (get-char-property (1- (field-end pos)) 'field)
2046 ;;;; Support for yanking and text properties.
2048 (defvar yank-excluded-properties)
2050 (defun remove-yank-excluded-properties (start end)
2051 "Remove `yank-excluded-properties' between START and END positions.
2052 Replaces `category' properties with their defined properties."
2053 (let ((inhibit-read-only t))
2054 ;; Replace any `category' property with the properties it stands for.
2055 (unless (memq yank-excluded-properties '(t nil))
2058 (while (< (point) end)
2059 (let ((cat (get-text-property (point) 'category))
2062 (next-single-property-change (point) 'category nil end))
2064 (let (run-end2 original)
2065 (remove-list-of-text-properties (point) run-end '(category))
2066 (while (< (point) run-end)
2067 (setq run-end2 (next-property-change (point) nil run-end))
2068 (setq original (text-properties-at (point)))
2069 (set-text-properties (point) run-end2 (symbol-plist cat))
2070 (add-text-properties (point) run-end2 original)
2071 (goto-char run-end2))))
2072 (goto-char run-end)))))
2073 (if (eq yank-excluded-properties t)
2074 (set-text-properties start end nil)
2075 (remove-list-of-text-properties start end yank-excluded-properties))))
2077 (defvar yank-undo-function)
2079 (defun insert-for-yank (string)
2080 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2082 See `insert-for-yank-1' for more details."
2084 (while (setq to (next-single-property-change 0 'yank-handler string))
2085 (insert-for-yank-1 (substring string 0 to))
2086 (setq string (substring string to))))
2087 (insert-for-yank-1 string))
2089 (defun insert-for-yank-1 (string)
2090 "Insert STRING at point, stripping some text properties.
2092 Strip text properties from the inserted text according to
2093 `yank-excluded-properties'. Otherwise just like (insert STRING).
2095 If STRING has a non-nil `yank-handler' property on the first character,
2096 the normal insert behavior is modified in various ways. The value of
2097 the yank-handler property must be a list with one to four elements
2098 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2099 When FUNCTION is present and non-nil, it is called instead of `insert'
2100 to insert the string. FUNCTION takes one argument--the object to insert.
2101 If PARAM is present and non-nil, it replaces STRING as the object
2102 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2103 `yank-rectangle', PARAM may be a list of strings to insert as a
2105 If NOEXCLUDE is present and non-nil, the normal removal of the
2106 yank-excluded-properties is not performed; instead FUNCTION is
2107 responsible for removing those properties. This may be necessary
2108 if FUNCTION adjusts point before or after inserting the object.
2109 If UNDO is present and non-nil, it is a function that will be called
2110 by `yank-pop' to undo the insertion of the current object. It is
2111 called with two arguments, the start and end of the current region.
2112 FUNCTION may set `yank-undo-function' to override the UNDO value."
2113 (let* ((handler (and (stringp string)
2114 (get-text-property 0 'yank-handler string)))
2115 (param (or (nth 1 handler) string))
2117 (setq yank-undo-function t)
2118 (if (nth 0 handler) ;; FUNCTION
2119 (funcall (car handler) param)
2121 (unless (nth 2 handler) ;; NOEXCLUDE
2122 (remove-yank-excluded-properties opoint (point)))
2123 (if (eq yank-undo-function t) ;; not set by FUNCTION
2124 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2125 (if (nth 4 handler) ;; COMMAND
2126 (setq this-command (nth 4 handler)))))
2128 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2129 "Insert before point a substring of BUFFER, without text properties.
2130 BUFFER may be a buffer or a buffer name.
2131 Arguments START and END are character positions specifying the substring.
2132 They default to the values of (point-min) and (point-max) in BUFFER."
2133 (let ((opoint (point)))
2134 (insert-buffer-substring buffer start end)
2135 (let ((inhibit-read-only t))
2136 (set-text-properties opoint (point) nil))))
2138 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2139 "Insert before point a part of BUFFER, stripping some text properties.
2140 BUFFER may be a buffer or a buffer name.
2141 Arguments START and END are character positions specifying the substring.
2142 They default to the values of (point-min) and (point-max) in BUFFER.
2143 Strip text properties from the inserted text according to
2144 `yank-excluded-properties'."
2145 ;; Since the buffer text should not normally have yank-handler properties,
2146 ;; there is no need to handle them here.
2147 (let ((opoint (point)))
2148 (insert-buffer-substring buffer start end)
2149 (remove-yank-excluded-properties opoint (point))))
2152 ;;;; Synchronous shell commands.
2154 (defun start-process-shell-command (name buffer &rest args)
2155 "Start a program in a subprocess. Return the process object for it.
2156 NAME is name for process. It is modified if necessary to make it unique.
2157 BUFFER is the buffer (or buffer name) to associate with the process.
2158 Process output goes at end of that buffer, unless you specify
2159 an output stream or filter function to handle the output.
2160 BUFFER may be also nil, meaning that this process is not associated
2162 COMMAND is the name of a shell command.
2163 Remaining arguments are the arguments for the command.
2164 Wildcards and redirection are handled as usual in the shell.
2166 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
2168 ((eq system-type 'vax-vms)
2169 (apply 'start-process name buffer args))
2170 ;; We used to use `exec' to replace the shell with the command,
2171 ;; but that failed to handle (...) and semicolon, etc.
2173 (start-process name buffer shell-file-name shell-command-switch
2174 (mapconcat 'identity args " ")))))
2176 (defun call-process-shell-command (command &optional infile buffer display
2178 "Execute the shell command COMMAND synchronously in separate process.
2179 The remaining arguments are optional.
2180 The program's input comes from file INFILE (nil means `/dev/null').
2181 Insert output in BUFFER before point; t means current buffer;
2182 nil for BUFFER means discard it; 0 means discard and don't wait.
2183 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2184 REAL-BUFFER says what to do with standard output, as above,
2185 while STDERR-FILE says what to do with standard error in the child.
2186 STDERR-FILE may be nil (discard standard error output),
2187 t (mix it with ordinary output), or a file name string.
2189 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2190 Remaining arguments are strings passed as additional arguments for COMMAND.
2191 Wildcards and redirection are handled as usual in the shell.
2193 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2194 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2195 status or a signal description string.
2196 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2198 ((eq system-type 'vax-vms)
2199 (apply 'call-process command infile buffer display args))
2200 ;; We used to use `exec' to replace the shell with the command,
2201 ;; but that failed to handle (...) and semicolon, etc.
2203 (call-process shell-file-name
2204 infile buffer display
2205 shell-command-switch
2206 (mapconcat 'identity (cons command args) " ")))))
2208 ;;;; Lisp macros to do various things temporarily.
2210 (defmacro with-current-buffer (buffer &rest body)
2211 "Execute the forms in BODY with BUFFER temporarily current.
2212 BUFFER can be a buffer or a buffer name.
2213 The value returned is the value of the last form in BODY.
2214 See also `with-temp-buffer'."
2215 (declare (indent 1) (debug t))
2216 `(save-current-buffer
2217 (set-buffer ,buffer)
2220 (defmacro with-selected-window (window &rest body)
2221 "Execute the forms in BODY with WINDOW as the selected window.
2222 The value returned is the value of the last form in BODY.
2224 This macro saves and restores the current buffer, since otherwise
2225 its normal operation could potentially make a different
2226 buffer current. It does not alter the buffer list ordering.
2228 This macro saves and restores the selected window, as well as
2229 the selected window in each frame. If the previously selected
2230 window of some frame is no longer live at the end of BODY, that
2231 frame's selected window is left alone. If the selected window is
2232 no longer live, then whatever window is selected at the end of
2233 BODY remains selected.
2234 See also `with-temp-buffer'."
2235 (declare (indent 1) (debug t))
2236 ;; Most of this code is a copy of save-selected-window.
2237 `(let ((save-selected-window-window (selected-window))
2238 ;; It is necessary to save all of these, because calling
2239 ;; select-window changes frame-selected-window for whatever
2240 ;; frame that window is in.
2241 (save-selected-window-alist
2242 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2244 (save-current-buffer
2246 (progn (select-window ,window 'norecord)
2248 (dolist (elt save-selected-window-alist)
2249 (and (frame-live-p (car elt))
2250 (window-live-p (cadr elt))
2251 (set-frame-selected-window (car elt) (cadr elt))))
2252 (if (window-live-p save-selected-window-window)
2253 (select-window save-selected-window-window 'norecord))))))
2255 (defmacro with-temp-file (file &rest body)
2256 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2257 The value returned is the value of the last form in BODY.
2258 See also `with-temp-buffer'."
2260 (let ((temp-file (make-symbol "temp-file"))
2261 (temp-buffer (make-symbol "temp-buffer")))
2262 `(let ((,temp-file ,file)
2264 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2267 (with-current-buffer ,temp-buffer
2269 (with-current-buffer ,temp-buffer
2271 (write-region (point-min) (point-max) ,temp-file nil 0)))
2272 (and (buffer-name ,temp-buffer)
2273 (kill-buffer ,temp-buffer))))))
2275 (defmacro with-temp-message (message &rest body)
2276 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2277 The original message is restored to the echo area after BODY has finished.
2278 The value returned is the value of the last form in BODY.
2279 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2280 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2281 Use a MESSAGE of \"\" to temporarily clear the echo area."
2283 (let ((current-message (make-symbol "current-message"))
2284 (temp-message (make-symbol "with-temp-message")))
2285 `(let ((,temp-message ,message)
2290 (setq ,current-message (current-message))
2291 (message "%s" ,temp-message))
2294 (if ,current-message
2295 (message "%s" ,current-message)
2298 (defmacro with-temp-buffer (&rest body)
2299 "Create a temporary buffer, and evaluate BODY there like `progn'.
2300 See also `with-temp-file' and `with-output-to-string'."
2301 (declare (indent 0) (debug t))
2302 (let ((temp-buffer (make-symbol "temp-buffer")))
2303 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2305 (with-current-buffer ,temp-buffer
2307 (and (buffer-name ,temp-buffer)
2308 (kill-buffer ,temp-buffer))))))
2310 (defmacro with-output-to-string (&rest body)
2311 "Execute BODY, return the text it sent to `standard-output', as a string."
2312 (declare (indent 0) (debug t))
2313 `(let ((standard-output
2314 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2315 (let ((standard-output standard-output))
2317 (with-current-buffer standard-output
2320 (kill-buffer nil)))))
2322 (defmacro with-local-quit (&rest body)
2323 "Execute BODY, allowing quits to terminate BODY but not escape further.
2324 When a quit terminates BODY, `with-local-quit' returns nil but
2325 requests another quit. That quit will be processed as soon as quitting
2326 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2327 (declare (debug t) (indent 0))
2328 `(condition-case nil
2329 (let ((inhibit-quit nil))
2331 (quit (setq quit-flag t)
2332 ;; This call is to give a chance to handle quit-flag
2333 ;; in case inhibit-quit is nil.
2334 ;; Without this, it will not be handled until the next function
2335 ;; call, and that might allow it to exit thru a condition-case
2336 ;; that intends to handle the quit signal next time.
2337 (eval '(ignore nil)))))
2339 (defmacro while-no-input (&rest body)
2340 "Execute BODY only as long as there's no pending input.
2341 If input arrives, that ends the execution of BODY,
2342 and `while-no-input' returns t. Quitting makes it return nil.
2343 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2344 (declare (debug t) (indent 0))
2345 (let ((catch-sym (make-symbol "input")))
2348 (let ((throw-on-input ',catch-sym))
2349 (or (not (sit-for 0 0 t))
2352 (defmacro combine-after-change-calls (&rest body)
2353 "Execute BODY, but don't call the after-change functions till the end.
2354 If BODY makes changes in the buffer, they are recorded
2355 and the functions on `after-change-functions' are called several times
2356 when BODY is finished.
2357 The return value is the value of the last form in BODY.
2359 If `before-change-functions' is non-nil, then calls to the after-change
2360 functions can't be deferred, so in that case this macro has no effect.
2362 Do not alter `after-change-functions' or `before-change-functions'
2364 (declare (indent 0) (debug t))
2366 (let ((combine-after-change-calls t))
2368 (combine-after-change-execute)))
2370 ;;;; Constructing completion tables.
2372 (defmacro dynamic-completion-table (fun)
2373 "Use function FUN as a dynamic completion table.
2374 FUN is called with one argument, the string for which completion is required,
2375 and it should return an alist containing all the intended possible
2376 completions. This alist may be a full list of possible completions so that FUN
2377 can ignore the value of its argument. If completion is performed in the
2378 minibuffer, FUN will be called in the buffer from which the minibuffer was
2381 The result of the `dynamic-completion-table' form is a function
2382 that can be used as the ALIST argument to `try-completion' and
2383 `all-completion'. See Info node `(elisp)Programmed Completion'."
2384 (declare (debug (lambda-expr)))
2385 (let ((win (make-symbol "window"))
2386 (string (make-symbol "string"))
2387 (predicate (make-symbol "predicate"))
2388 (mode (make-symbol "mode")))
2389 `(lambda (,string ,predicate ,mode)
2390 (with-current-buffer (let ((,win (minibuffer-selected-window)))
2391 (if (window-live-p ,win) (window-buffer ,win)
2394 ((eq ,mode t) (all-completions ,string (,fun ,string) ,predicate))
2395 ((not ,mode) (try-completion ,string (,fun ,string) ,predicate))
2396 (t (test-completion ,string (,fun ,string) ,predicate)))))))
2398 (defmacro lazy-completion-table (var fun)
2399 ;; We used to have `&rest args' where `args' were evaluated late (at the
2400 ;; time of the call to `fun'), which was counter intuitive. But to get
2401 ;; them to be evaluated early, we have to either use lexical-let (which is
2402 ;; not available in subr.el) or use `(lambda (,str) ...) which prevents the use
2403 ;; of lexical-let in the callers.
2404 ;; So we just removed the argument. Callers can then simply use either of:
2405 ;; (lazy-completion-table var (lambda () (fun x y)))
2407 ;; (lazy-completion-table var `(lambda () (fun ',x ',y)))
2409 ;; (lexical-let ((x x)) ((y y))
2410 ;; (lazy-completion-table var (lambda () (fun x y))))
2411 ;; depending on the behavior they want.
2412 "Initialize variable VAR as a lazy completion table.
2413 If the completion table VAR is used for the first time (e.g., by passing VAR
2414 as an argument to `try-completion'), the function FUN is called with no
2415 arguments. FUN must return the completion table that will be stored in VAR.
2416 If completion is requested in the minibuffer, FUN will be called in the buffer
2417 from which the minibuffer was entered. The return value of
2418 `lazy-completion-table' must be used to initialize the value of VAR.
2420 You should give VAR a non-nil `risky-local-variable' property."
2421 (declare (debug (symbol lambda-expr)))
2422 (let ((str (make-symbol "string")))
2423 `(dynamic-completion-table
2425 (when (functionp ,var)
2429 (defmacro complete-in-turn (a b)
2430 "Create a completion table that first tries completion in A and then in B.
2431 A and B should not be costly (or side-effecting) expressions."
2432 (declare (debug (def-form def-form)))
2433 `(lambda (string predicate mode)
2436 (or (all-completions string ,a predicate)
2437 (all-completions string ,b predicate)))
2439 (or (try-completion string ,a predicate)
2440 (try-completion string ,b predicate)))
2442 (or (test-completion string ,a predicate)
2443 (test-completion string ,b predicate))))))
2445 ;;; Matching and match data.
2447 (defvar save-match-data-internal)
2449 ;; We use save-match-data-internal as the local variable because
2450 ;; that works ok in practice (people should not use that variable elsewhere).
2451 ;; We used to use an uninterned symbol; the compiler handles that properly
2452 ;; now, but it generates slower code.
2453 (defmacro save-match-data (&rest body)
2454 "Execute the BODY forms, restoring the global value of the match data.
2455 The value returned is the value of the last form in BODY."
2456 ;; It is better not to use backquote here,
2457 ;; because that makes a bootstrapping problem
2458 ;; if you need to recompile all the Lisp files using interpreted code.
2459 (declare (indent 0) (debug t))
2461 '((save-match-data-internal (match-data)))
2462 (list 'unwind-protect
2464 ;; It is safe to free (evaporate) markers immediately here,
2465 ;; as Lisp programs should not copy from save-match-data-internal.
2466 '(set-match-data save-match-data-internal 'evaporate))))
2468 (defun match-string (num &optional string)
2469 "Return string of text matched by last search.
2470 NUM specifies which parenthesized expression in the last regexp.
2471 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2472 Zero means the entire text matched by the whole regexp or whole string.
2473 STRING should be given if the last search was by `string-match' on STRING."
2474 (if (match-beginning num)
2476 (substring string (match-beginning num) (match-end num))
2477 (buffer-substring (match-beginning num) (match-end num)))))
2479 (defun match-string-no-properties (num &optional string)
2480 "Return string of text matched by last search, without text properties.
2481 NUM specifies which parenthesized expression in the last regexp.
2482 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2483 Zero means the entire text matched by the whole regexp or whole string.
2484 STRING should be given if the last search was by `string-match' on STRING."
2485 (if (match-beginning num)
2487 (substring-no-properties string (match-beginning num)
2489 (buffer-substring-no-properties (match-beginning num)
2492 (defun looking-back (regexp &optional limit greedy)
2493 "Return non-nil if text before point matches regular expression REGEXP.
2494 Like `looking-at' except matches before point, and is slower.
2495 LIMIT if non-nil speeds up the search by specifying how far back the
2498 If GREEDY is non-nil, extend the match backwards as far as possible,
2499 stopping when a single additional previous character cannot be part
2500 of a match for REGEXP."
2501 (let ((start (point))
2504 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2506 (if (and greedy pos)
2508 (narrow-to-region (point-min) start)
2509 (while (and (> pos (point-min))
2513 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2514 (setq pos (1- pos)))
2517 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2520 (defun subregexp-context-p (regexp pos &optional start)
2521 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2522 A subregexp context is one where a sub-regexp can appear.
2523 A non-subregexp context is for example within brackets, or within a
2524 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2525 If START is non-nil, it should be a position in REGEXP, smaller
2526 than POS, and known to be in a subregexp context."
2527 ;; Here's one possible implementation, with the great benefit that it
2528 ;; reuses the regexp-matcher's own parser, so it understands all the
2529 ;; details of the syntax. A disadvantage is that it needs to match the
2533 (string-match (substring regexp (or start 0) pos) "")
2536 (not (member (cadr err) '("Unmatched [ or [^"
2538 "Trailing backslash")))))
2539 ;; An alternative implementation:
2540 ;; (defconst re-context-re
2541 ;; (let* ((harmless-ch "[^\\[]")
2542 ;; (harmless-esc "\\\\[^{]")
2543 ;; (class-harmless-ch "[^][]")
2544 ;; (class-lb-harmless "[^]:]")
2545 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2546 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2547 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2549 ;; (concat "\\[^?]?"
2550 ;; "\\(" class-harmless-ch
2551 ;; "\\|" class-lb "\\)*"
2552 ;; "\\[?]")) ; special handling for bare [ at end of re
2553 ;; (braces "\\\\{[0-9,]+\\\\}"))
2554 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2555 ;; "\\|" class "\\|" braces "\\)*\\'"))
2556 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2557 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2562 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2563 "The default value of separators for `split-string'.
2565 A regexp matching strings of whitespace. May be locale-dependent
2566 \(as yet unimplemented). Should not match non-breaking spaces.
2568 Warning: binding this to a different value and using it as default is
2569 likely to have undesired semantics.")
2571 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2572 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2573 ;; expression leads to the equivalent implementation that if SEPARATORS
2574 ;; is defaulted, OMIT-NULLS is treated as t.
2575 (defun split-string (string &optional separators omit-nulls)
2576 "Split STRING into substrings bounded by matches for SEPARATORS.
2578 The beginning and end of STRING, and each match for SEPARATORS, are
2579 splitting points. The substrings matching SEPARATORS are removed, and
2580 the substrings between the splitting points are collected as a list,
2583 If SEPARATORS is non-nil, it should be a regular expression matching text
2584 which separates, but is not part of, the substrings. If nil it defaults to
2585 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2586 OMIT-NULLS is forced to t.
2588 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2589 that for the default value of SEPARATORS leading and trailing whitespace
2590 are effectively trimmed). If nil, all zero-length substrings are retained,
2591 which correctly parses CSV format, for example.
2593 Note that the effect of `(split-string STRING)' is the same as
2594 `(split-string STRING split-string-default-separators t)'). In the rare
2595 case that you wish to retain zero-length substrings when splitting on
2596 whitespace, use `(split-string STRING split-string-default-separators)'.
2598 Modifies the match data; use `save-match-data' if necessary."
2599 (let ((keep-nulls (not (if separators omit-nulls t)))
2600 (rexp (or separators split-string-default-separators))
2604 (while (and (string-match rexp string
2606 (= start (match-beginning 0))
2607 (< start (length string)))
2609 (< start (length string)))
2611 (if (or keep-nulls (< start (match-beginning 0)))
2613 (cons (substring string start (match-beginning 0))
2615 (setq start (match-end 0)))
2616 (if (or keep-nulls (< start (length string)))
2618 (cons (substring string start)
2622 ;;;; Replacement in strings.
2624 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2625 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2626 Unless optional argument INPLACE is non-nil, return a new string."
2627 (let ((i (length string))
2628 (newstr (if inplace string (copy-sequence string))))
2631 (if (eq (aref newstr i) fromchar)
2632 (aset newstr i tochar)))
2635 (defun replace-regexp-in-string (regexp rep string &optional
2636 fixedcase literal subexp start)
2637 "Replace all matches for REGEXP with REP in STRING.
2639 Return a new string containing the replacements.
2641 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2642 arguments with the same names of function `replace-match'. If START
2643 is non-nil, start replacements at that index in STRING.
2645 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2646 function. If it is a function, it is called with the actual text of each
2647 match, and its value is used as the replacement text. When REP is called,
2648 the match-data are the result of matching REGEXP against a substring
2651 To replace only the first match (if any), make REGEXP match up to \\'
2652 and replace a sub-expression, e.g.
2653 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2657 ;; To avoid excessive consing from multiple matches in long strings,
2658 ;; don't just call `replace-match' continually. Walk down the
2659 ;; string looking for matches of REGEXP and building up a (reversed)
2660 ;; list MATCHES. This comprises segments of STRING which weren't
2661 ;; matched interspersed with replacements for segments that were.
2662 ;; [For a `large' number of replacements it's more efficient to
2663 ;; operate in a temporary buffer; we can't tell from the function's
2664 ;; args whether to choose the buffer-based implementation, though it
2665 ;; might be reasonable to do so for long enough STRING.]
2666 (let ((l (length string))
2667 (start (or start 0))
2670 (while (and (< start l) (string-match regexp string start))
2671 (setq mb (match-beginning 0)
2673 ;; If we matched the empty string, make sure we advance by one char
2674 (when (= me mb) (setq me (min l (1+ mb))))
2675 ;; Generate a replacement for the matched substring.
2676 ;; Operate only on the substring to minimize string consing.
2677 ;; Set up match data for the substring for replacement;
2678 ;; presumably this is likely to be faster than munging the
2679 ;; match data directly in Lisp.
2680 (string-match regexp (setq str (substring string mb me)))
2682 (cons (replace-match (if (stringp rep)
2684 (funcall rep (match-string 0 str)))
2685 fixedcase literal str subexp)
2686 (cons (substring string start mb) ; unmatched prefix
2689 ;; Reconstruct a string from the pieces.
2690 (setq matches (cons (substring string start l) matches)) ; leftover
2691 (apply #'concat (nreverse matches)))))
2693 ;;;; invisibility specs
2695 (defun add-to-invisibility-spec (element)
2696 "Add ELEMENT to `buffer-invisibility-spec'.
2697 See documentation for `buffer-invisibility-spec' for the kind of elements
2699 (if (eq buffer-invisibility-spec t)
2700 (setq buffer-invisibility-spec (list t)))
2701 (setq buffer-invisibility-spec
2702 (cons element buffer-invisibility-spec)))
2704 (defun remove-from-invisibility-spec (element)
2705 "Remove ELEMENT from `buffer-invisibility-spec'."
2706 (if (consp buffer-invisibility-spec)
2707 (setq buffer-invisibility-spec (delete element buffer-invisibility-spec))))
2711 (defmacro with-syntax-table (table &rest body)
2712 "Evaluate BODY with syntax table of current buffer set to TABLE.
2713 The syntax table of the current buffer is saved, BODY is evaluated, and the
2714 saved table is restored, even in case of an abnormal exit.
2715 Value is what BODY returns."
2717 (let ((old-table (make-symbol "table"))
2718 (old-buffer (make-symbol "buffer")))
2719 `(let ((,old-table (syntax-table))
2720 (,old-buffer (current-buffer)))
2723 (set-syntax-table ,table)
2725 (save-current-buffer
2726 (set-buffer ,old-buffer)
2727 (set-syntax-table ,old-table))))))
2729 (defun make-syntax-table (&optional oldtable)
2730 "Return a new syntax table.
2731 Create a syntax table which inherits from OLDTABLE (if non-nil) or
2732 from `standard-syntax-table' otherwise."
2733 (let ((table (make-char-table 'syntax-table nil)))
2734 (set-char-table-parent table (or oldtable (standard-syntax-table)))
2737 (defun syntax-after (pos)
2738 "Return the raw syntax of the char after POS.
2739 If POS is outside the buffer's accessible portion, return nil."
2740 (unless (or (< pos (point-min)) (>= pos (point-max)))
2741 (let ((st (if parse-sexp-lookup-properties
2742 (get-char-property pos 'syntax-table))))
2744 (aref (or st (syntax-table)) (char-after pos))))))
2746 (defun syntax-class (syntax)
2747 "Return the syntax class part of the syntax descriptor SYNTAX.
2748 If SYNTAX is nil, return nil."
2749 (and syntax (logand (car syntax) 65535)))
2753 (defun text-clone-maintain (ol1 after beg end &optional len)
2754 "Propagate the changes made under the overlay OL1 to the other clones.
2755 This is used on the `modification-hooks' property of text clones."
2756 (when (and after (not undo-in-progress) (overlay-start ol1))
2757 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
2758 (setq beg (max beg (+ (overlay-start ol1) margin)))
2759 (setq end (min end (- (overlay-end ol1) margin)))
2762 (when (overlay-get ol1 'text-clone-syntax)
2763 ;; Check content of the clone's text.
2764 (let ((cbeg (+ (overlay-start ol1) margin))
2765 (cend (- (overlay-end ol1) margin)))
2768 (if (not (re-search-forward
2769 (overlay-get ol1 'text-clone-syntax) cend t))
2770 ;; Mark the overlay for deletion.
2771 (overlay-put ol1 'text-clones nil)
2772 (when (< (match-end 0) cend)
2773 ;; Shrink the clone at its end.
2774 (setq end (min end (match-end 0)))
2775 (move-overlay ol1 (overlay-start ol1)
2776 (+ (match-end 0) margin)))
2777 (when (> (match-beginning 0) cbeg)
2778 ;; Shrink the clone at its beginning.
2779 (setq beg (max (match-beginning 0) beg))
2780 (move-overlay ol1 (- (match-beginning 0) margin)
2781 (overlay-end ol1)))))))
2782 ;; Now go ahead and update the clones.
2783 (let ((head (- beg (overlay-start ol1)))
2784 (tail (- (overlay-end ol1) end))
2785 (str (buffer-substring beg end))
2787 (inhibit-modification-hooks t))
2788 (dolist (ol2 (overlay-get ol1 'text-clones))
2789 (let ((oe (overlay-end ol2)))
2790 (unless (or (eq ol1 ol2) (null oe))
2791 (setq nothing-left nil)
2792 (let ((mod-beg (+ (overlay-start ol2) head)))
2793 ;;(overlay-put ol2 'modification-hooks nil)
2794 (goto-char (- (overlay-end ol2) tail))
2795 (unless (> mod-beg (point))
2796 (save-excursion (insert str))
2797 (delete-region mod-beg (point)))
2798 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
2800 (if nothing-left (delete-overlay ol1))))))))
2802 (defun text-clone-create (start end &optional spreadp syntax)
2803 "Create a text clone of START...END at point.
2804 Text clones are chunks of text that are automatically kept identical:
2805 changes done to one of the clones will be immediately propagated to the other.
2807 The buffer's content at point is assumed to be already identical to
2808 the one between START and END.
2809 If SYNTAX is provided it's a regexp that describes the possible text of
2810 the clones; the clone will be shrunk or killed if necessary to ensure that
2811 its text matches the regexp.
2812 If SPREADP is non-nil it indicates that text inserted before/after the
2813 clone should be incorporated in the clone."
2814 ;; To deal with SPREADP we can either use an overlay with `nil t' along
2815 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
2816 ;; (with a one-char margin at each end) with `t nil'.
2817 ;; We opted for a larger overlay because it behaves better in the case
2818 ;; where the clone is reduced to the empty string (we want the overlay to
2819 ;; stay when the clone's content is the empty string and we want to use
2820 ;; `evaporate' to make sure those overlays get deleted when needed).
2822 (let* ((pt-end (+ (point) (- end start)))
2823 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
2825 (end-margin (if (or (not spreadp)
2826 (>= pt-end (point-max))
2827 (>= start (point-max)))
2829 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
2830 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
2831 (dups (list ol1 ol2)))
2832 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
2833 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
2834 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
2835 ;;(overlay-put ol1 'face 'underline)
2836 (overlay-put ol1 'evaporate t)
2837 (overlay-put ol1 'text-clones dups)
2839 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
2840 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
2841 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
2842 ;;(overlay-put ol2 'face 'underline)
2843 (overlay-put ol2 'evaporate t)
2844 (overlay-put ol2 'text-clones dups)))
2846 ;;;; Mail user agents.
2848 ;; Here we include just enough for other packages to be able
2851 (defun define-mail-user-agent (symbol composefunc sendfunc
2852 &optional abortfunc hookvar)
2853 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
2855 SYMBOL can be any Lisp symbol. Its function definition and/or
2856 value as a variable do not matter for this usage; we use only certain
2857 properties on its property list, to encode the rest of the arguments.
2859 COMPOSEFUNC is program callable function that composes an outgoing
2860 mail message buffer. This function should set up the basics of the
2861 buffer without requiring user interaction. It should populate the
2862 standard mail headers, leaving the `to:' and `subject:' headers blank
2865 COMPOSEFUNC should accept several optional arguments--the same
2866 arguments that `compose-mail' takes. See that function's documentation.
2868 SENDFUNC is the command a user would run to send the message.
2870 Optional ABORTFUNC is the command a user would run to abort the
2871 message. For mail packages that don't have a separate abort function,
2872 this can be `kill-buffer' (the equivalent of omitting this argument).
2874 Optional HOOKVAR is a hook variable that gets run before the message
2875 is actually sent. Callers that use the `mail-user-agent' may
2876 install a hook function temporarily on this hook variable.
2877 If HOOKVAR is nil, `mail-send-hook' is used.
2879 The properties used on SYMBOL are `composefunc', `sendfunc',
2880 `abortfunc', and `hookvar'."
2881 (put symbol 'composefunc composefunc)
2882 (put symbol 'sendfunc sendfunc)
2883 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
2884 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
2886 ;;;; Progress reporters.
2888 ;; Progress reporter has the following structure:
2890 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
2897 ;; This weirdeness is for optimization reasons: we want
2898 ;; `progress-reporter-update' to be as fast as possible, so
2899 ;; `(car reporter)' is better than `(aref reporter 0)'.
2901 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
2902 ;; digits of precision, it doesn't really matter here. On the other
2903 ;; hand, it greatly simplifies the code.
2905 (defsubst progress-reporter-update (reporter value)
2906 "Report progress of an operation in the echo area.
2907 However, if the change since last echo area update is too small
2908 or not enough time has passed, then do nothing (see
2909 `make-progress-reporter' for details).
2911 First parameter, REPORTER, should be the result of a call to
2912 `make-progress-reporter'. Second, VALUE, determines the actual
2913 progress of operation; it must be between MIN-VALUE and MAX-VALUE
2914 as passed to `make-progress-reporter'.
2916 This function is very inexpensive, you may not bother how often
2918 (when (>= value (car reporter))
2919 (progress-reporter-do-update reporter value)))
2921 (defun make-progress-reporter (message min-value max-value
2922 &optional current-value
2923 min-change min-time)
2924 "Return progress reporter object to be used with `progress-reporter-update'.
2926 MESSAGE is shown in the echo area. When at least 1% of operation
2927 is complete, the exact percentage will be appended to the
2928 MESSAGE. When you call `progress-reporter-done', word \"done\"
2929 is printed after the MESSAGE. You can change MESSAGE of an
2930 existing progress reporter with `progress-reporter-force-update'.
2932 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
2933 final (100% complete) states of operation. The latter should be
2934 larger; if this is not the case, then simply negate all values.
2935 Optional CURRENT-VALUE specifies the progress by the moment you
2936 call this function. You should omit it or set it to nil in most
2937 cases since it defaults to MIN-VALUE.
2939 Optional MIN-CHANGE determines the minimal change in percents to
2940 report (default is 1%.) Optional MIN-TIME specifies the minimal
2941 time before echo area updates (default is 0.2 seconds.) If
2942 `float-time' function is not present, then time is not tracked
2943 at all. If OS is not capable of measuring fractions of seconds,
2944 then this parameter is effectively rounded up."
2947 (setq min-time 0.2))
2949 (cons min-value ;; Force a call to `message' now
2950 (vector (if (and (fboundp 'float-time)
2956 (if min-change (max (min min-change 50) 1) 1)
2958 (progress-reporter-update reporter (or current-value min-value))
2961 (defun progress-reporter-force-update (reporter value &optional new-message)
2962 "Report progress of an operation in the echo area unconditionally.
2964 First two parameters are the same as for
2965 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
2966 change the displayed message."
2967 (let ((parameters (cdr reporter)))
2969 (aset parameters 3 new-message))
2970 (when (aref parameters 0)
2971 (aset parameters 0 (float-time)))
2972 (progress-reporter-do-update reporter value)))
2974 (defun progress-reporter-do-update (reporter value)
2975 (let* ((parameters (cdr reporter))
2976 (min-value (aref parameters 1))
2977 (max-value (aref parameters 2))
2978 (one-percent (/ (- max-value min-value) 100.0))
2979 (percentage (if (= max-value min-value)
2981 (truncate (/ (- value min-value) one-percent))))
2982 (update-time (aref parameters 0))
2983 (current-time (float-time))
2985 ;; See if enough time has passed since the last update.
2986 (or (not update-time)
2987 (when (>= current-time update-time)
2988 ;; Calculate time for the next update
2989 (aset parameters 0 (+ update-time (aref parameters 5)))))))
2991 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
2992 ;; message this time because not enough time has passed, then use
2993 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
2994 ;; updates closer to MIN-TIME.
2996 (min (+ min-value (* (+ percentage
2997 (if enough-time-passed
2998 (aref parameters 4) ;; MIN-CHANGE
3002 (when (integerp value)
3003 (setcar reporter (ceiling (car reporter))))
3005 ;; Only print message if enough time has passed
3006 (when enough-time-passed
3007 (if (> percentage 0)
3008 (message "%s%d%%" (aref parameters 3) percentage)
3009 (message "%s" (aref parameters 3))))))
3011 (defun progress-reporter-done (reporter)
3012 "Print reporter's message followed by word \"done\" in echo area."
3013 (message "%sdone" (aref (cdr reporter) 3)))
3015 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3016 "Loop a certain number of times and report progress in the echo area.
3017 Evaluate BODY with VAR bound to successive integers running from
3018 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3019 the return value (nil if RESULT is omitted).
3021 At each iteration MESSAGE followed by progress percentage is
3022 printed in the echo area. After the loop is finished, MESSAGE
3023 followed by word \"done\" is printed. This macro is a
3024 convenience wrapper around `make-progress-reporter' and friends.
3026 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3027 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3028 (let ((temp (make-symbol "--dotimes-temp--"))
3029 (temp2 (make-symbol "--dotimes-temp2--"))
3033 (,(car spec) ,start)
3034 (,temp2 (make-progress-reporter ,message ,start ,end)))
3035 (while (< ,(car spec) ,temp)
3037 (progress-reporter-update ,temp2
3038 (setq ,(car spec) (1+ ,(car spec)))))
3039 (progress-reporter-done ,temp2)
3040 nil ,@(cdr (cdr spec)))))
3043 ;;;; Comparing version strings.
3045 (defvar version-separator "."
3046 "*Specify the string used to separate the version elements.
3048 Usually the separator is \".\", but it can be any other string.")
3051 (defvar version-regexp-alist
3052 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3053 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3054 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3055 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3056 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3057 "*Specify association between non-numeric version part and a priority.
3059 This association is used to handle version string like \"1.0pre2\",
3060 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3061 non-numeric part to an integer. For example:
3063 String Version Integer List Version
3064 \"1.0pre2\" (1 0 -1 2)
3065 \"1.0PRE2\" (1 0 -1 2)
3066 \"22.8beta3\" (22 8 -2 3)
3067 \"22.8 Beta3\" (22 8 -2 3)
3068 \"0.9alpha1\" (0 9 -3 1)
3069 \"0.9AlphA1\" (0 9 -3 1)
3070 \"0.9 alpha\" (0 9 -3)
3072 Each element has the following form:
3078 REGEXP regexp used to match non-numeric part of a version string.
3079 It should begin with a `^' anchor and end with a `$' to
3080 prevent false hits. Letter-case is ignored while matching
3083 PRIORITY negative integer which indicate the non-numeric priority.")
3086 (defun version-to-list (ver)
3087 "Convert version string VER into an integer list.
3089 The version syntax is given by the following EBNF:
3091 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3093 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3095 SEPARATOR ::= `version-separator' (which see)
3096 | `version-regexp-alist' (which see).
3098 The NUMBER part is optional if SEPARATOR is a match for an element
3099 in `version-regexp-alist'.
3101 As an example of valid version syntax:
3103 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3105 As an example of invalid version syntax:
3107 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3109 As an example of version convertion:
3111 String Version Integer List Version
3112 \"1.0.7.5\" (1 0 7 5)
3113 \"1.0pre2\" (1 0 -1 2)
3114 \"1.0PRE2\" (1 0 -1 2)
3115 \"22.8beta3\" (22 8 -2 3)
3116 \"22.8Beta3\" (22 8 -2 3)
3117 \"0.9alpha1\" (0 9 -3 1)
3118 \"0.9AlphA1\" (0 9 -3 1)
3119 \"0.9alpha\" (0 9 -3)
3121 See documentation for `version-separator' and `version-regexp-alist'."
3122 (or (and (stringp ver) (> (length ver) 0))
3123 (error "Invalid version string: '%s'" ver))
3124 ;; Change .x.y to 0.x.y
3125 (if (and (>= (length ver) (length version-separator))
3126 (string-equal (substring ver 0 (length version-separator))
3128 (setq ver (concat "0" ver)))
3131 (case-fold-search t) ; ignore case in matching
3133 (while (and (setq s (string-match "[0-9]+" ver i))
3135 ;; handle numeric part
3136 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3139 ;; handle non-numeric part
3140 (when (and (setq s (string-match "[^0-9]+" ver i))
3142 (setq s (substring ver i (match-end 0))
3144 ;; handle alpha, beta, pre, etc. separator
3145 (unless (string= s version-separator)
3146 (setq al version-regexp-alist)
3147 (while (and al (not (string-match (caar al) s)))
3149 (or al (error "Invalid version syntax: '%s'" ver))
3150 (setq lst (cons (cdar al) lst)))))
3152 (error "Invalid version syntax: '%s'" ver)
3156 (defun version-list-< (l1 l2)
3157 "Return t if integer list L1 is lesser than L2.
3159 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3160 etc. That is, the trailing zeroes are irrelevant. Also, integer
3161 list (1) is greater than (1 -1) which is greater than (1 -2)
3162 which is greater than (1 -3)."
3163 (while (and l1 l2 (= (car l1) (car l2)))
3167 ;; l1 not null and l2 not null
3168 ((and l1 l2) (< (car l1) (car l2)))
3169 ;; l1 null and l2 null ==> l1 length = l2 length
3170 ((and (null l1) (null l2)) nil)
3171 ;; l1 not null and l2 null ==> l1 length > l2 length
3172 (l1 (< (version-list-not-zero l1) 0))
3173 ;; l1 null and l2 not null ==> l2 length > l1 length
3174 (t (< 0 (version-list-not-zero l2)))))
3177 (defun version-list-= (l1 l2)
3178 "Return t if integer list L1 is equal to L2.
3180 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3181 etc. That is, the trailing zeroes are irrelevant. Also, integer
3182 list (1) is greater than (1 -1) which is greater than (1 -2)
3183 which is greater than (1 -3)."
3184 (while (and l1 l2 (= (car l1) (car l2)))
3188 ;; l1 not null and l2 not null
3190 ;; l1 null and l2 null ==> l1 length = l2 length
3191 ((and (null l1) (null l2)))
3192 ;; l1 not null and l2 null ==> l1 length > l2 length
3193 (l1 (zerop (version-list-not-zero l1)))
3194 ;; l1 null and l2 not null ==> l2 length > l1 length
3195 (t (zerop (version-list-not-zero l2)))))
3198 (defun version-list-<= (l1 l2)
3199 "Return t if integer list L1 is lesser than or equal to L2.
3201 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3202 etc. That is, the trailing zeroes are irrelevant. Also, integer
3203 list (1) is greater than (1 -1) which is greater than (1 -2)
3204 which is greater than (1 -3)."
3205 (while (and l1 l2 (= (car l1) (car l2)))
3209 ;; l1 not null and l2 not null
3210 ((and l1 l2) (< (car l1) (car l2)))
3211 ;; l1 null and l2 null ==> l1 length = l2 length
3212 ((and (null l1) (null l2)))
3213 ;; l1 not null and l2 null ==> l1 length > l2 length
3214 (l1 (<= (version-list-not-zero l1) 0))
3215 ;; l1 null and l2 not null ==> l2 length > l1 length
3216 (t (<= 0 (version-list-not-zero l2)))))
3218 (defun version-list-not-zero (lst)
3219 "Return the first non-zero element of integer list LST.
3221 If all LST elements are zeroes or LST is nil, return zero."
3222 (while (and lst (zerop (car lst)))
3223 (setq lst (cdr lst)))
3226 ;; there is no element different of zero
3230 (defun version< (v1 v2)
3231 "Return t if version V1 is lesser than V2.
3233 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3234 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3235 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3237 (version-list-< (version-to-list v1) (version-to-list v2)))
3240 (defun version<= (v1 v2)
3241 "Return t if version V1 is lesser than or equal to V2.
3243 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3244 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3245 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3247 (version-list-<= (version-to-list v1) (version-to-list v2)))
3249 (defun version= (v1 v2)
3250 "Return t if version V1 is equal to V2.
3252 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3253 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3254 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3256 (version-list-= (version-to-list v1) (version-to-list v2)))
3260 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3261 ;;; subr.el ends here