1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 (defvar custom-declare-variable-list nil
31 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
32 Each element of this list holds the arguments to one call to `defcustom'.")
34 ;; Use this, rather than defcustom, in subr.el and other files loaded
36 (defun custom-declare-variable-early (&rest arguments
)
37 (setq custom-declare-variable-list
38 (cons arguments custom-declare-variable-list
)))
40 (defmacro declare-function
(fn file
&optional arglist fileonly
)
41 "Tell the byte-compiler that function FN is defined, in FILE.
42 Optional ARGLIST is the argument list used by the function. The
43 FILE argument is not used by the byte-compiler, but by the
44 `check-declare' package, which checks that FILE contains a
45 definition for FN. ARGLIST is used by both the byte-compiler and
46 `check-declare' to check for consistency.
48 FILE can be either a Lisp file (in which case the \".el\"
49 extension is optional), or a C file. C files are expanded
50 relative to the Emacs \"src/\" directory. Lisp files are
51 searched for using `locate-library', and if that fails they are
52 expanded relative to the location of the file containing the
53 declaration. A FILE with an \"ext:\" prefix is an external file.
54 `check-declare' will check such files if they are found, and skip
55 them without error if they are not.
57 FILEONLY non-nil means that `check-declare' will only check that
58 FILE exists, not that it defines FN. This is intended for
59 function-definitions that `check-declare' does not recognize, e.g.
62 To specify a value for FILEONLY without passing an argument list,
63 set ARGLIST to `t'. This is necessary because `nil' means an
64 empty argument list, rather than an unspecified one.
66 Note that for the purposes of `check-declare', this statement
67 must be the first non-whitespace on a line.
69 For more information, see Info node `(elisp)Declaring Functions'."
70 ;; Does nothing - byte-compile-declare-function does the work.
74 ;;;; Basic Lisp macros.
78 (defmacro noreturn
(form)
79 "Evaluate FORM, expecting it not to return.
80 If FORM does return, signal an error."
82 (error "Form marked with `noreturn' did return")))
84 (defmacro 1value
(form)
85 "Evaluate FORM, expecting a constant return value.
86 This is the global do-nothing version. There is also `testcover-1value'
87 that complains if FORM ever does return differing values."
90 (defmacro def-edebug-spec
(symbol spec
)
91 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
92 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
93 0 (instrument no arguments); t (instrument all arguments);
94 a symbol (naming a function with an Edebug specification); or a list.
95 The elements of the list describe the argument types; see
96 \(info \"(elisp)Specification List\") for details."
97 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
99 (defmacro lambda
(&rest cdr
)
100 "Return a lambda expression.
101 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
102 self-quoting; the result of evaluating the lambda expression is the
103 expression itself. The lambda expression may then be treated as a
104 function, i.e., stored as the function value of a symbol, passed to
105 `funcall' or `mapcar', etc.
107 ARGS should take the same form as an argument list for a `defun'.
108 DOCSTRING is an optional documentation string.
109 If present, it should describe how to call the function.
110 But documentation strings are usually not useful in nameless functions.
111 INTERACTIVE should be a call to the function `interactive', which see.
112 It may also be omitted.
113 BODY should be a list of Lisp expressions.
115 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
116 ;; Note that this definition should not use backquotes; subr.el should not
117 ;; depend on backquote.el.
118 (list 'function
(cons 'lambda cdr
)))
120 (if (null (featurep 'cl
))
122 ;; If we reload subr.el after having loaded CL, be careful not to
123 ;; overwrite CL's extended definition of `dolist', `dotimes',
124 ;; `declare', `push' and `pop'.
125 (defmacro push
(newelt listname
)
126 "Add NEWELT to the list stored in the symbol LISTNAME.
127 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
128 LISTNAME must be a symbol."
129 (declare (debug (form sexp
)))
131 (list 'cons newelt listname
)))
133 (defmacro pop
(listname)
134 "Return the first element of LISTNAME's value, and remove it from the list.
135 LISTNAME must be a symbol whose value is a list.
136 If the value is nil, `pop' returns nil but does not actually
138 (declare (debug (sexp)))
140 (list 'prog1 listname
141 (list 'setq listname
(list 'cdr listname
)))))
144 (defmacro when
(cond &rest body
)
145 "If COND yields non-nil, do BODY, else return nil.
146 When COND yields non-nil, eval BODY forms sequentially and return
147 value of last one, or nil if there are none.
150 (declare (indent 1) (debug t
))
151 (list 'if cond
(cons 'progn body
)))
153 (defmacro unless
(cond &rest body
)
154 "If COND yields nil, do BODY, else return nil.
155 When COND yields nil, eval BODY forms sequentially and return
156 value of last one, or nil if there are none.
159 (declare (indent 1) (debug t
))
160 (cons 'if
(cons cond
(cons nil body
))))
162 (if (null (featurep 'cl
))
164 ;; If we reload subr.el after having loaded CL, be careful not to
165 ;; overwrite CL's extended definition of `dolist', `dotimes',
166 ;; `declare', `push' and `pop'.
167 (defvar --dolist-tail-- nil
168 "Temporary variable used in `dolist' expansion.")
170 (defmacro dolist
(spec &rest body
)
172 Evaluate BODY with VAR bound to each car from LIST, in turn.
173 Then evaluate RESULT to get return value, default nil.
175 \(fn (VAR LIST [RESULT]) BODY...)"
176 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
177 ;; It would be cleaner to create an uninterned symbol,
178 ;; but that uses a lot more space when many functions in many files
180 (let ((temp '--dolist-tail--
))
181 `(let ((,temp
,(nth 1 spec
))
184 (setq ,(car spec
) (car ,temp
))
186 (setq ,temp
(cdr ,temp
)))
187 ,@(if (cdr (cdr spec
))
188 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
)))))))
190 (defvar --dotimes-limit-- nil
191 "Temporary variable used in `dotimes' expansion.")
193 (defmacro dotimes
(spec &rest body
)
194 "Loop a certain number of times.
195 Evaluate BODY with VAR bound to successive integers running from 0,
196 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
197 the return value (nil if RESULT is omitted).
199 \(fn (VAR COUNT [RESULT]) BODY...)"
200 (declare (indent 1) (debug dolist
))
201 ;; It would be cleaner to create an uninterned symbol,
202 ;; but that uses a lot more space when many functions in many files
204 (let ((temp '--dotimes-limit--
)
208 (,(car spec
) ,start
))
209 (while (< ,(car spec
) ,temp
)
211 (setq ,(car spec
) (1+ ,(car spec
))))
212 ,@(cdr (cdr spec
)))))
214 (defmacro declare
(&rest specs
)
215 "Do not evaluate any arguments and return nil.
216 Treated as a declaration when used at the right place in a
217 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
221 (defmacro ignore-errors
(&rest body
)
222 "Execute BODY; if an error occurs, return nil.
223 Otherwise, return result of last form in BODY."
224 (declare (debug t
) (indent 0))
225 `(condition-case nil
(progn ,@body
) (error nil
)))
227 ;;;; Basic Lisp functions.
229 (defun ignore (&rest ignore
)
230 "Do nothing and return nil.
231 This function accepts any number of arguments, but ignores them."
235 ;; Signal a compile-error if the first arg is missing.
236 (defun error (&rest args
)
237 "Signal an error, making error message by passing all args to `format'.
238 In Emacs, the convention is that error messages start with a capital
239 letter but *do not* end with a period. Please follow this convention
240 for the sake of consistency."
242 (signal 'error
(list (apply 'format args
)))))
243 (set-advertised-calling-convention 'error
'(string &rest args
) "23.1")
245 ;; We put this here instead of in frame.el so that it's defined even on
246 ;; systems where frame.el isn't loaded.
247 (defun frame-configuration-p (object)
248 "Return non-nil if OBJECT seems to be a frame configuration.
249 Any list whose car is `frame-configuration' is assumed to be a frame
252 (eq (car object
) 'frame-configuration
)))
254 (defun functionp (object)
255 "Non-nil if OBJECT is a function."
256 (or (and (symbolp object
) (fboundp object
)
258 (setq object
(indirect-function object
))
260 (eq (car-safe object
) 'autoload
)
261 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object
)))))))
263 ;; Filter out special forms.
264 (not (eq 'unevalled
(cdr (subr-arity object
)))))
265 (byte-code-function-p object
)
266 (eq (car-safe object
) 'lambda
)))
271 "Return the car of the car of X."
275 "Return the car of the cdr of X."
279 "Return the cdr of the car of X."
283 "Return the cdr of the cdr of X."
286 (defun last (list &optional n
)
287 "Return the last link of LIST. Its car is the last element.
288 If LIST is nil, return nil.
289 If N is non-nil, return the Nth-to-last link of LIST.
290 If N is bigger than the length of LIST, return LIST."
293 (let ((m (safe-length list
)))
294 (if (< n m
) (nthcdr (- m n
) list
) list
)))
296 (nthcdr (1- (safe-length list
)) list
))))
298 (defun butlast (list &optional n
)
299 "Return a copy of LIST with the last N elements removed."
300 (if (and n
(<= n
0)) list
301 (nbutlast (copy-sequence list
) n
)))
303 (defun nbutlast (list &optional n
)
304 "Modifies LIST to remove the last N elements."
305 (let ((m (length list
)))
309 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
312 (defun delete-dups (list)
313 "Destructively remove `equal' duplicates from LIST.
314 Store the result in LIST and return it. LIST must be a proper list.
315 Of several `equal' occurrences of an element in LIST, the first
319 (setcdr tail
(delete (car tail
) (cdr tail
)))
320 (setq tail
(cdr tail
))))
323 (defun number-sequence (from &optional to inc
)
324 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
325 INC is the increment used between numbers in the sequence and defaults to 1.
326 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
327 zero. TO is only included if there is an N for which TO = FROM + N * INC.
328 If TO is nil or numerically equal to FROM, return \(FROM).
329 If INC is positive and TO is less than FROM, or INC is negative
330 and TO is larger than FROM, return nil.
331 If INC is zero and TO is neither nil nor numerically equal to
332 FROM, signal an error.
334 This function is primarily designed for integer arguments.
335 Nevertheless, FROM, TO and INC can be integer or float. However,
336 floating point arithmetic is inexact. For instance, depending on
337 the machine, it may quite well happen that
338 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
339 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
340 elements. Thus, if some of the arguments are floats and one wants
341 to make sure that TO is included, one may have to explicitly write
342 TO as \(+ FROM \(* N INC)) or use a variable whose value was
343 computed with this exact expression. Alternatively, you can,
344 of course, also replace TO with a slightly larger value
345 \(or a slightly more negative value if INC is negative)."
346 (if (or (not to
) (= from to
))
348 (or inc
(setq inc
1))
349 (when (zerop inc
) (error "The increment can not be zero"))
350 (let (seq (n 0) (next from
))
353 (setq seq
(cons next seq
)
355 next
(+ from
(* n inc
))))
357 (setq seq
(cons next seq
)
359 next
(+ from
(* n inc
)))))
362 (defun copy-tree (tree &optional vecp
)
363 "Make a copy of TREE.
364 If TREE is a cons cell, this recursively copies both its car and its cdr.
365 Contrast to `copy-sequence', which copies only along the cdrs. With second
366 argument VECP, this copies vectors as well as conses."
370 (let ((newcar (car tree
)))
371 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
372 (setq newcar
(copy-tree (car tree
) vecp
)))
373 (push newcar result
))
374 (setq tree
(cdr tree
)))
375 (nconc (nreverse result
) tree
))
376 (if (and vecp
(vectorp tree
))
377 (let ((i (length (setq tree
(copy-sequence tree
)))))
378 (while (>= (setq i
(1- i
)) 0)
379 (aset tree i
(copy-tree (aref tree i
) vecp
)))
383 ;;;; Various list-search functions.
385 (defun assoc-default (key alist
&optional test default
)
386 "Find object KEY in a pseudo-alist ALIST.
387 ALIST is a list of conses or objects. Each element
388 (or the element's car, if it is a cons) is compared with KEY by
389 calling TEST, with two arguments: (i) the element or its car,
391 If that is non-nil, the element matches; then `assoc-default'
392 returns the element's cdr, if it is a cons, or DEFAULT if the
393 element is not a cons.
395 If no element matches, the value is nil.
396 If TEST is omitted or nil, `equal' is used."
397 (let (found (tail alist
) value
)
398 (while (and tail
(not found
))
399 (let ((elt (car tail
)))
400 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
401 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
402 (setq tail
(cdr tail
)))
405 (make-obsolete 'assoc-ignore-case
'assoc-string
"22.1")
406 (defun assoc-ignore-case (key alist
)
407 "Like `assoc', but ignores differences in case and text representation.
408 KEY must be a string. Upper-case and lower-case letters are treated as equal.
409 Unibyte strings are converted to multibyte for comparison."
410 (assoc-string key alist t
))
412 (make-obsolete 'assoc-ignore-representation
'assoc-string
"22.1")
413 (defun assoc-ignore-representation (key alist
)
414 "Like `assoc', but ignores differences in text representation.
415 KEY must be a string.
416 Unibyte strings are converted to multibyte for comparison."
417 (assoc-string key alist nil
))
419 (defun member-ignore-case (elt list
)
420 "Like `member', but ignores differences in case and text representation.
421 ELT must be a string. Upper-case and lower-case letters are treated as equal.
422 Unibyte strings are converted to multibyte for comparison.
423 Non-strings in LIST are ignored."
425 (not (and (stringp (car list
))
426 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
427 (setq list
(cdr list
)))
430 (defun assq-delete-all (key alist
)
431 "Delete from ALIST all elements whose car is `eq' to KEY.
432 Return the modified alist.
433 Elements of ALIST that are not conses are ignored."
434 (while (and (consp (car alist
))
435 (eq (car (car alist
)) key
))
436 (setq alist
(cdr alist
)))
437 (let ((tail alist
) tail-cdr
)
438 (while (setq tail-cdr
(cdr tail
))
439 (if (and (consp (car tail-cdr
))
440 (eq (car (car tail-cdr
)) key
))
441 (setcdr tail
(cdr tail-cdr
))
442 (setq tail tail-cdr
))))
445 (defun rassq-delete-all (value alist
)
446 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
447 Return the modified alist.
448 Elements of ALIST that are not conses are ignored."
449 (while (and (consp (car alist
))
450 (eq (cdr (car alist
)) value
))
451 (setq alist
(cdr alist
)))
452 (let ((tail alist
) tail-cdr
)
453 (while (setq tail-cdr
(cdr tail
))
454 (if (and (consp (car tail-cdr
))
455 (eq (cdr (car tail-cdr
)) value
))
456 (setcdr tail
(cdr tail-cdr
))
457 (setq tail tail-cdr
))))
460 (defun remove (elt seq
)
461 "Return a copy of SEQ with all occurrences of ELT removed.
462 SEQ must be a list, vector, or string. The comparison is done with `equal'."
464 ;; If SEQ isn't a list, there's no need to copy SEQ because
465 ;; `delete' will return a new object.
467 (delete elt
(copy-sequence seq
))))
469 (defun remq (elt list
)
470 "Return LIST with all occurrences of ELT removed.
471 The comparison is done with `eq'. Contrary to `delq', this does not use
472 side-effects, and the argument LIST is not modified."
474 (delq elt
(copy-sequence list
))
480 "Convert KEYS to the internal Emacs key representation.
481 KEYS should be a string constant in the format used for
482 saving keyboard macros (see `edmacro-mode')."
483 (read-kbd-macro keys
))
489 ;; Prevent the \{...} documentation construct
490 ;; from mentioning keys that run this command.
491 (put 'undefined
'suppress-keymap t
)
493 (defun suppress-keymap (map &optional nodigits
)
494 "Make MAP override all normally self-inserting keys to be undefined.
495 Normally, as an exception, digits and minus-sign are set to make prefix args,
496 but optional second arg NODIGITS non-nil treats them like other chars."
497 (define-key map
[remap self-insert-command
] 'undefined
)
500 (define-key map
"-" 'negative-argument
)
501 ;; Make plain numbers do numeric args.
504 (define-key map
(char-to-string loop
) 'digit-argument
)
505 (setq loop
(1+ loop
))))))
507 (defun define-key-after (keymap key definition
&optional after
)
508 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
509 This is like `define-key' except that the binding for KEY is placed
510 just after the binding for the event AFTER, instead of at the beginning
511 of the map. Note that AFTER must be an event type (like KEY), NOT a command
514 If AFTER is t or omitted, the new binding goes at the end of the keymap.
515 AFTER should be a single event type--a symbol or a character, not a sequence.
517 Bindings are always added before any inherited map.
519 The order of bindings in a keymap matters when it is used as a menu."
520 (unless after
(setq after t
))
522 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
524 (if (<= (length key
) 1) (aref key
0)
525 (setq keymap
(lookup-key keymap
527 (butlast (mapcar 'identity key
)))))
528 (aref key
(1- (length key
)))))
529 (let ((tail keymap
) done inserted
)
530 (while (and (not done
) tail
)
531 ;; Delete any earlier bindings for the same key.
532 (if (eq (car-safe (car (cdr tail
))) key
)
533 (setcdr tail
(cdr (cdr tail
))))
534 ;; If we hit an included map, go down that one.
535 (if (keymapp (car tail
)) (setq tail
(car tail
)))
536 ;; When we reach AFTER's binding, insert the new binding after.
537 ;; If we reach an inherited keymap, insert just before that.
538 ;; If we reach the end of this keymap, insert at the end.
539 (if (or (and (eq (car-safe (car tail
)) after
)
541 (eq (car (cdr tail
)) 'keymap
)
544 ;; Stop the scan only if we find a parent keymap.
545 ;; Keep going past the inserted element
546 ;; so we can delete any duplications that come later.
547 (if (eq (car (cdr tail
)) 'keymap
)
549 ;; Don't insert more than once.
551 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
553 (setq tail
(cdr tail
)))))
555 (defun map-keymap-sorted (function keymap
)
556 "Implement `map-keymap' with sorting.
557 Don't call this function; it is for internal use only."
559 (map-keymap (lambda (a b
) (push (cons a b
) list
))
561 (setq list
(sort list
563 (setq a
(car a
) b
(car b
))
565 (if (integerp b
) (< a b
)
568 ;; string< also accepts symbols.
571 (funcall function
(car p
) (cdr p
)))))
573 (defun keymap-canonicalize (map)
574 "Return an equivalent keymap, without inheritance."
577 (prompt (keymap-prompt map
)))
579 (setq map
(map-keymap-internal
582 ;; Treat char-ranges specially.
583 (push (cons key item
) ranges
)
584 (push (cons key item
) bindings
)))
586 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
587 (dolist (binding ranges
)
588 ;; Treat char-ranges specially.
589 (define-key map
(vector (car binding
)) (cdr binding
)))
590 (dolist (binding (prog1 bindings
(setq bindings
())))
591 (let* ((key (car binding
))
593 (oldbind (assq key bindings
)))
594 ;; Newer bindings override older.
595 (if oldbind
(setq bindings
(delq oldbind bindings
)))
596 (when item
;nil bindings just hide older ones.
597 (push binding bindings
))))
598 (nconc map bindings
)))
600 (put 'keyboard-translate-table
'char-table-extra-slots
0)
602 (defun keyboard-translate (from to
)
603 "Translate character FROM to TO at a low level.
604 This function creates a `keyboard-translate-table' if necessary
605 and then modifies one entry in it."
606 (or (char-table-p keyboard-translate-table
)
607 (setq keyboard-translate-table
608 (make-char-table 'keyboard-translate-table nil
)))
609 (aset keyboard-translate-table from to
))
611 ;;;; Key binding commands.
613 (defun global-set-key (key command
)
614 "Give KEY a global binding as COMMAND.
615 COMMAND is the command definition to use; usually it is
616 a symbol naming an interactively-callable function.
617 KEY is a key sequence; noninteractively, it is a string or vector
618 of characters or event types, and non-ASCII characters with codes
619 above 127 (such as ISO Latin-1) can be included if you use a vector.
621 Note that if KEY has a local binding in the current buffer,
622 that local binding will continue to shadow any global binding
623 that you make with this function."
624 (interactive "KSet key globally: \nCSet key %s to command: ")
625 (or (vectorp key
) (stringp key
)
626 (signal 'wrong-type-argument
(list 'arrayp key
)))
627 (define-key (current-global-map) key command
))
629 (defun local-set-key (key command
)
630 "Give KEY a local binding as COMMAND.
631 COMMAND is the command definition to use; usually it is
632 a symbol naming an interactively-callable function.
633 KEY is a key sequence; noninteractively, it is a string or vector
634 of characters or event types, and non-ASCII characters with codes
635 above 127 (such as ISO Latin-1) can be included if you use a vector.
637 The binding goes in the current buffer's local map,
638 which in most cases is shared with all other buffers in the same major mode."
639 (interactive "KSet key locally: \nCSet key %s locally to command: ")
640 (let ((map (current-local-map)))
642 (use-local-map (setq map
(make-sparse-keymap))))
643 (or (vectorp key
) (stringp key
)
644 (signal 'wrong-type-argument
(list 'arrayp key
)))
645 (define-key map key command
)))
647 (defun global-unset-key (key)
648 "Remove global binding of KEY.
649 KEY is a string or vector representing a sequence of keystrokes."
650 (interactive "kUnset key globally: ")
651 (global-set-key key nil
))
653 (defun local-unset-key (key)
654 "Remove local binding of KEY.
655 KEY is a string or vector representing a sequence of keystrokes."
656 (interactive "kUnset key locally: ")
657 (if (current-local-map)
658 (local-set-key key nil
))
661 ;;;; substitute-key-definition and its subroutines.
663 (defvar key-substitution-in-progress nil
664 "Used internally by `substitute-key-definition'.")
666 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
667 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
668 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
669 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
670 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
672 If you don't specify OLDMAP, you can usually get the same results
673 in a cleaner way with command remapping, like this:
674 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
675 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
676 ;; Don't document PREFIX in the doc string because we don't want to
677 ;; advertise it. It's meant for recursive calls only. Here's its
680 ;; If optional argument PREFIX is specified, it should be a key
681 ;; prefix, a string. Redefined bindings will then be bound to the
682 ;; original key, with PREFIX added at the front.
683 (or prefix
(setq prefix
""))
684 (let* ((scan (or oldmap keymap
))
685 (prefix1 (vconcat prefix
[nil]))
686 (key-substitution-in-progress
687 (cons scan key-substitution-in-progress)))
688 ;; Scan OLDMAP, finding each char or event-symbol that
689 ;; has any definition, and act on it with hack-key.
692 (aset prefix1 (length prefix) char)
693 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
696 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
697 (let (inner-def skipped menu-item)
698 ;; Find the actual command name within the binding.
699 (if (eq (car-safe defn) 'menu-item)
700 (setq menu-item defn defn (nth 2 defn))
701 ;; Skip past menu-prompt.
702 (while (stringp (car-safe defn))
703 (push (pop defn) skipped))
704 ;; Skip past cached key-equivalence data for menu items.
705 (if (consp (car-safe defn))
706 (setq defn (cdr defn))))
707 (if (or (eq defn olddef)
708 ;; Compare with equal if definition is a key sequence.
709 ;; That is useful for operating on function-key-map.
710 (and (or (stringp defn) (vectorp defn))
711 (equal defn olddef)))
712 (define-key keymap prefix
714 (let ((copy (copy-sequence menu-item)))
715 (setcar (nthcdr 2 copy) newdef)
717 (nconc (nreverse skipped) newdef)))
718 ;; Look past a symbol that names a keymap.
720 (or (indirect-function defn t) defn))
721 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
722 ;; avoid autoloading a keymap. This is mostly done to preserve the
723 ;; original non-autoloading behavior of pre-map-keymap times.
724 (if (and (keymapp inner-def)
725 ;; Avoid recursively scanning
726 ;; where KEYMAP does not have a submap.
727 (let ((elt (lookup-key keymap prefix)))
728 (or (null elt) (natnump elt) (keymapp elt)))
729 ;; Avoid recursively rescanning keymap being scanned.
730 (not (memq inner-def key-substitution-in-progress)))
731 ;; If this one isn't being scanned already, scan it now.
732 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
735 ;;;; The global keymap tree.
737 ;; global-map, esc-map, and ctl-x-map have their values set up in
738 ;; keymap.c; we just give them docstrings here.
740 (defvar global-map nil
741 "Default global keymap mapping Emacs keyboard input into commands.
742 The value is a keymap which is usually (but not necessarily) Emacs's
746 "Default keymap for ESC (meta) commands.
747 The normal global definition of the character ESC indirects to this keymap.")
749 (defvar ctl-x-map nil
750 "Default keymap for C-x commands.
751 The normal global definition of the character C-x indirects to this keymap.")
753 (defvar ctl-x-4-map (make-sparse-keymap)
754 "Keymap for subcommands of C-x 4.")
755 (defalias 'ctl-x-4-prefix ctl-x-4-map)
756 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
758 (defvar ctl-x-5-map (make-sparse-keymap)
759 "Keymap for frame commands.")
760 (defalias 'ctl-x-5-prefix ctl-x-5-map)
761 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
764 ;;;; Event manipulation functions.
766 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
768 (defun listify-key-sequence (key)
769 "Convert a key sequence to a list of events."
772 (mapcar (function (lambda (c)
774 (logxor c listify-key-sequence-1)
778 (defsubst eventp (obj)
779 "True if the argument is an event object."
780 (or (and (integerp obj)
781 ;; Filter out integers too large to be events.
782 ;; M is the biggest modifier.
783 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
784 (characterp (event-basic-type obj)))
786 (get obj 'event-symbol-elements))
789 (get (car obj) 'event-symbol-elements))))
791 (defun event-modifiers (event)
792 "Return a list of symbols representing the modifier keys in event EVENT.
793 The elements of the list may include `meta', `control',
794 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
796 EVENT may be an event or an event type. If EVENT is a symbol
797 that has never been used in an event that has been read as input
798 in the current Emacs session, then this function can return nil,
799 even when EVENT actually has modifiers."
802 (setq type (car type)))
804 ;; Don't read event-symbol-elements directly since we're not
805 ;; sure the symbol has already been parsed.
806 (cdr (internal-event-symbol-parse-modifiers type))
808 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
809 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
810 (if (not (zerop (logand type ?\M-\^@)))
812 (if (or (not (zerop (logand type ?\C-\^@)))
814 (push 'control list))
815 (if (or (not (zerop (logand type ?\S-\^@)))
816 (/= char (downcase char)))
818 (or (zerop (logand type ?\H-\^@))
820 (or (zerop (logand type ?\s-\^@))
822 (or (zerop (logand type ?\A-\^@))
826 (defun event-basic-type (event)
827 "Return the basic type of the given event (all modifiers removed).
828 The value is a printing character (not upper case) or a symbol.
829 EVENT may be an event or an event type. If EVENT is a symbol
830 that has never been used in an event that has been read as input
831 in the current Emacs session, then this function may return nil."
833 (setq event (car event)))
835 (car (get event 'event-symbol-elements))
836 (let* ((base (logand event (1- ?\A-\^@)))
837 (uncontrolled (if (< base 32) (logior base 64) base)))
838 ;; There are some numbers that are invalid characters and
839 ;; cause `downcase' to get an error.
841 (downcase uncontrolled)
842 (error uncontrolled)))))
844 (defsubst mouse-movement-p (object)
845 "Return non-nil if OBJECT is a mouse movement event."
846 (eq (car-safe object) 'mouse-movement))
848 (defun mouse-event-p (object)
849 "Return non-nil if OBJECT is a mouse click event."
850 ;; is this really correct? maybe remove mouse-movement?
851 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
853 (defsubst event-start (event)
854 "Return the starting position of EVENT.
855 If EVENT is a mouse or key press or a mouse click, this returns the location
857 If EVENT is a drag, this returns the drag's starting position.
858 The return value is of the form
859 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
860 IMAGE (DX . DY) (WIDTH . HEIGHT))
861 The `posn-' functions access elements of such lists."
862 (if (consp event) (nth 1 event)
863 (list (selected-window) (point) '(0 . 0) 0)))
865 (defsubst event-end (event)
866 "Return the ending location of EVENT.
867 EVENT should be a click, drag, or key press event.
868 If EVENT is a click event, this function is the same as `event-start'.
869 The return value is of the form
870 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
871 IMAGE (DX . DY) (WIDTH . HEIGHT))
872 The `posn-' functions access elements of such lists."
873 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
874 (list (selected-window) (point) '(0 . 0) 0)))
876 (defsubst event-click-count (event)
877 "Return the multi-click count of EVENT, a click or drag event.
878 The return value is a positive integer."
879 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
881 ;;;; Extracting fields of the positions in an event.
883 (defsubst posn-window (position)
884 "Return the window in POSITION.
885 POSITION should be a list of the form returned by the `event-start'
886 and `event-end' functions."
889 (defsubst posn-area (position)
890 "Return the window area recorded in POSITION, or nil for the text area.
891 POSITION should be a list of the form returned by the `event-start'
892 and `event-end' functions."
893 (let ((area (if (consp (nth 1 position))
894 (car (nth 1 position))
896 (and (symbolp area) area)))
898 (defsubst posn-point (position)
899 "Return the buffer location in POSITION.
900 POSITION should be a list of the form returned by the `event-start'
901 and `event-end' functions."
903 (if (consp (nth 1 position))
904 (car (nth 1 position))
907 (defun posn-set-point (position)
908 "Move point to POSITION.
909 Select the corresponding window as well."
910 (if (not (windowp (posn-window position)))
911 (error "Position not in text area of window"))
912 (select-window (posn-window position))
913 (if (numberp (posn-point position))
914 (goto-char (posn-point position))))
916 (defsubst posn-x-y (position)
917 "Return the x and y coordinates in POSITION.
918 POSITION should be a list of the form returned by the `event-start'
919 and `event-end' functions."
922 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
924 (defun posn-col-row (position)
925 "Return the nominal column and row in POSITION, measured in characters.
926 The column and row values are approximations calculated from the x
927 and y coordinates in POSITION and the frame's default character width
929 For a scroll-bar event, the result column is 0, and the row
930 corresponds to the vertical position of the click in the scroll bar.
931 POSITION should be a list of the form returned by the `event-start'
932 and `event-end' functions."
933 (let* ((pair (posn-x-y position))
934 (window (posn-window position))
935 (area (posn-area position)))
939 ((eq area 'vertical-scroll-bar)
940 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
941 ((eq area 'horizontal-scroll-bar)
942 (cons (scroll-bar-scale pair (window-width window)) 0))
944 (let* ((frame (if (framep window) window (window-frame window)))
945 ;; FIXME: This should take line-spacing properties on
946 ;; newlines into account.
947 (spacing (when (display-graphic-p frame)
948 (or (with-current-buffer (window-buffer window)
950 (frame-parameter frame 'line-spacing)))))
951 (cond ((floatp spacing)
952 (setq spacing (truncate (* spacing
953 (frame-char-height frame)))))
956 (cons (/ (car pair) (frame-char-width frame))
957 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
959 (defun posn-actual-col-row (position)
960 "Return the actual column and row in POSITION, measured in characters.
961 These are the actual row number in the window and character number in that row.
962 Return nil if POSITION does not contain the actual position; in that case
963 `posn-col-row' can be used to get approximate values.
964 POSITION should be a list of the form returned by the `event-start'
965 and `event-end' functions."
968 (defsubst posn-timestamp (position)
969 "Return the timestamp of POSITION.
970 POSITION should be a list of the form returned by the `event-start'
971 and `event-end' functions."
974 (defsubst posn-string (position)
975 "Return the string object of POSITION.
976 Value is a cons (STRING . STRING-POS), or nil if not a string.
977 POSITION should be a list of the form returned by the `event-start'
978 and `event-end' functions."
981 (defsubst posn-image (position)
982 "Return the image object of POSITION.
983 Value is a list (image ...), or nil if not an image.
984 POSITION should be a list of the form returned by the `event-start'
985 and `event-end' functions."
988 (defsubst posn-object (position)
989 "Return the object (image or string) of POSITION.
990 Value is a list (image ...) for an image object, a cons cell
991 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
992 POSITION should be a list of the form returned by the `event-start'
993 and `event-end' functions."
994 (or (posn-image position) (posn-string position)))
996 (defsubst posn-object-x-y (position)
997 "Return the x and y coordinates relative to the object of POSITION.
998 POSITION should be a list of the form returned by the `event-start'
999 and `event-end' functions."
1002 (defsubst posn-object-width-height (position)
1003 "Return the pixel width and height of the object of POSITION.
1004 POSITION should be a list of the form returned by the `event-start'
1005 and `event-end' functions."
1009 ;;;; Obsolescent names for functions.
1011 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1012 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1013 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1014 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1015 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1016 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1018 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1020 (defun insert-string (&rest args)
1021 "Mocklisp-compatibility insert function.
1022 Like the function `insert' except that any argument that is a number
1023 is converted into a string by expressing it in decimal."
1025 (insert (if (integerp el) (number-to-string el) el))))
1026 (make-obsolete 'insert-string 'insert "22.1")
1028 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1029 (make-obsolete 'makehash 'make-hash-table "22.1")
1031 ;; These are used by VM and some old programs
1032 (defalias 'focus-frame 'ignore "")
1033 (make-obsolete 'focus-frame "it does nothing." "22.1")
1034 (defalias 'unfocus-frame 'ignore "")
1035 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1036 (make-obsolete 'make-variable-frame-local
1037 "explicitly check for a frame-parameter instead." "22.2")
1038 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1039 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
1040 (set-advertised-calling-convention
1041 'all-completions '(string collection &optional predicate) "23.1")
1042 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1044 ;;;; Obsolescence declarations for variables, and aliases.
1046 ;; Special "default-FOO" variables which contain the default value of
1047 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1048 ;; slows down several unrelated variable operations; furthermore, they
1049 ;; can lead to really odd behavior if you decide to make them
1052 ;; Not used at all in Emacs, last time I checked:
1053 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1054 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1055 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1056 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1057 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1058 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1059 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1060 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1061 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1062 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1063 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1064 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1065 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1066 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1067 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1068 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1069 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1070 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1071 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1072 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1073 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1074 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1075 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1076 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1077 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1078 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1079 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1080 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1081 (make-obsolete-variable 'default-enable-multibyte-characters
1082 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1084 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1085 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1086 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1087 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1089 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1090 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1092 (make-obsolete-variable
1093 'mode-line-inverse-video
1094 "use the appropriate faces instead."
1096 (make-obsolete-variable
1097 'unread-command-char
1098 "use `unread-command-events' instead. That variable is a list of events
1099 to reread, so it now uses nil to mean `no event', instead of -1."
1102 ;; Lisp manual only updated in 22.1.
1103 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1106 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1107 (make-obsolete-variable 'x-lost-selection-hooks
1108 'x-lost-selection-functions "22.1")
1109 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1110 (make-obsolete-variable 'x-sent-selection-hooks
1111 'x-sent-selection-functions "22.1")
1113 ;; This was introduced in 21.4 for pre-unicode unification. That
1114 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1115 ;; Other uses are possible, so this variable is not _really_ obsolete,
1116 ;; but Stefan insists to mark it so.
1117 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1119 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1121 ;; These aliases exist in Emacs 19.34, and probably before, but were
1122 ;; only marked as obsolete in 23.1.
1123 ;; The lisp manual (since at least Emacs 21) describes them as
1124 ;; existing "for compatibility with Emacs version 18".
1125 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1127 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1131 ;;;; Alternate names for functions - these are not being phased out.
1133 (defalias 'send-string 'process-send-string)
1134 (defalias 'send-region 'process-send-region)
1135 (defalias 'string= 'string-equal)
1136 (defalias 'string< 'string-lessp)
1137 (defalias 'move-marker 'set-marker)
1138 (defalias 'rplaca 'setcar)
1139 (defalias 'rplacd 'setcdr)
1140 (defalias 'beep 'ding) ;preserve lingual purity
1141 (defalias 'indent-to-column 'indent-to)
1142 (defalias 'backward-delete-char 'delete-backward-char)
1143 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1144 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1145 (defalias 'int-to-string 'number-to-string)
1146 (defalias 'store-match-data 'set-match-data)
1147 (defalias 'chmod 'set-file-modes)
1148 (defalias 'mkdir 'make-directory)
1149 ;; These are the XEmacs names:
1150 (defalias 'point-at-eol 'line-end-position)
1151 (defalias 'point-at-bol 'line-beginning-position)
1153 (defalias 'user-original-login-name 'user-login-name)
1156 ;;;; Hook manipulation functions.
1158 (defun add-hook (hook function &optional append local)
1159 "Add to the value of HOOK the function FUNCTION.
1160 FUNCTION is not added if already present.
1161 FUNCTION is added (if necessary) at the beginning of the hook list
1162 unless the optional argument APPEND is non-nil, in which case
1163 FUNCTION is added at the end.
1165 The optional fourth argument, LOCAL, if non-nil, says to modify
1166 the hook's buffer-local value rather than its default value.
1167 This makes the hook buffer-local if needed, and it makes t a member
1168 of the buffer-local value. That acts as a flag to run the hook
1169 functions in the default value as well as in the local value.
1171 HOOK should be a symbol, and FUNCTION may be any valid function. If
1172 HOOK is void, it is first set to nil. If HOOK's value is a single
1173 function, it is changed to a list of functions."
1174 (or (boundp hook) (set hook nil))
1175 (or (default-boundp hook) (set-default hook nil))
1176 (if local (unless (local-variable-if-set-p hook)
1177 (set (make-local-variable hook) (list t)))
1178 ;; Detect the case where make-local-variable was used on a hook
1179 ;; and do what we used to do.
1180 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1182 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1183 ;; If the hook value is a single function, turn it into a list.
1184 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1185 (setq hook-value (list hook-value)))
1186 ;; Do the actual addition if necessary
1187 (unless (member function hook-value)
1188 (when (stringp function)
1189 (setq function (purecopy function)))
1192 (append hook-value (list function))
1193 (cons function hook-value))))
1194 ;; Set the actual variable
1197 ;; If HOOK isn't a permanent local,
1198 ;; but FUNCTION wants to survive a change of modes,
1199 ;; mark HOOK as partially permanent.
1200 (and (symbolp function)
1201 (get function 'permanent-local-hook)
1202 (not (get hook 'permanent-local))
1203 (put hook 'permanent-local 'permanent-local-hook))
1204 (set hook hook-value))
1205 (set-default hook hook-value))))
1207 (defun remove-hook (hook function &optional local)
1208 "Remove from the value of HOOK the function FUNCTION.
1209 HOOK should be a symbol, and FUNCTION may be any valid function. If
1210 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1211 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1213 The optional third argument, LOCAL, if non-nil, says to modify
1214 the hook's buffer-local value rather than its default value."
1215 (or (boundp hook) (set hook nil))
1216 (or (default-boundp hook) (set-default hook nil))
1217 ;; Do nothing if LOCAL is t but this hook has no local binding.
1218 (unless (and local (not (local-variable-p hook)))
1219 ;; Detect the case where make-local-variable was used on a hook
1220 ;; and do what we used to do.
1221 (when (and (local-variable-p hook)
1222 (not (and (consp (symbol-value hook))
1223 (memq t (symbol-value hook)))))
1225 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1226 ;; Remove the function, for both the list and the non-list cases.
1227 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1228 (if (equal hook-value function) (setq hook-value nil))
1229 (setq hook-value (delete function (copy-sequence hook-value))))
1230 ;; If the function is on the global hook, we need to shadow it locally
1231 ;;(when (and local (member function (default-value hook))
1232 ;; (not (member (cons 'not function) hook-value)))
1233 ;; (push (cons 'not function) hook-value))
1234 ;; Set the actual variable
1236 (set-default hook hook-value)
1237 (if (equal hook-value '(t))
1238 (kill-local-variable hook)
1239 (set hook hook-value))))))
1241 (defun add-to-list (list-var element &optional append compare-fn)
1242 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1243 The test for presence of ELEMENT is done with `equal',
1244 or with COMPARE-FN if that's non-nil.
1245 If ELEMENT is added, it is added at the beginning of the list,
1246 unless the optional argument APPEND is non-nil, in which case
1247 ELEMENT is added at the end.
1249 The return value is the new value of LIST-VAR.
1251 If you want to use `add-to-list' on a variable that is not defined
1252 until a certain package is loaded, you should put the call to `add-to-list'
1253 into a hook function that will be run only after loading the package.
1254 `eval-after-load' provides one way to do this. In some cases
1255 other hooks, such as major mode hooks, can do the job."
1258 (member element (symbol-value list-var)))
1259 ((eq compare-fn 'eq)
1260 (memq element (symbol-value list-var)))
1261 ((eq compare-fn 'eql)
1262 (memql element (symbol-value list-var)))
1264 (let ((lst (symbol-value list-var)))
1266 (not (funcall compare-fn element (car lst))))
1267 (setq lst (cdr lst)))
1269 (symbol-value list-var)
1272 (append (symbol-value list-var) (list element))
1273 (cons element (symbol-value list-var))))))
1276 (defun add-to-ordered-list (list-var element &optional order)
1277 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1278 The test for presence of ELEMENT is done with `eq'.
1280 The resulting list is reordered so that the elements are in the
1281 order given by each element's numeric list order. Elements
1282 without a numeric list order are placed at the end of the list.
1284 If the third optional argument ORDER is a number (integer or
1285 float), set the element's list order to the given value. If
1286 ORDER is nil or omitted, do not change the numeric order of
1287 ELEMENT. If ORDER has any other value, remove the numeric order
1288 of ELEMENT if it has one.
1290 The list order for each element is stored in LIST-VAR's
1291 `list-order' property.
1293 The return value is the new value of LIST-VAR."
1294 (let ((ordering (get list-var 'list-order)))
1296 (put list-var 'list-order
1297 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1299 (puthash element (and (numberp order) order) ordering))
1300 (unless (memq element (symbol-value list-var))
1301 (set list-var (cons element (symbol-value list-var))))
1302 (set list-var (sort (symbol-value list-var)
1304 (let ((oa (gethash a ordering))
1305 (ob (gethash b ordering)))
1310 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1311 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1312 Return the new history list.
1313 If MAXELT is non-nil, it specifies the maximum length of the history.
1314 Otherwise, the maximum history length is the value of the `history-length'
1315 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1317 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1318 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1319 if it is empty or a duplicate."
1321 (setq maxelt (or (get history-var 'history-length)
1323 (let ((history (symbol-value history-var))
1325 (when (and (listp history)
1327 (not (stringp newelt))
1328 (> (length newelt) 0))
1330 (not (equal (car history) newelt))))
1331 (if history-delete-duplicates
1332 (delete newelt history))
1333 (setq history (cons newelt history))
1334 (when (integerp maxelt)
1337 (setq tail (nthcdr (1- maxelt) history))
1339 (setcdr tail nil)))))
1340 (set history-var history)))
1345 (defvar delay-mode-hooks nil
1346 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1347 (defvar delayed-mode-hooks nil
1348 "List of delayed mode hooks waiting to be run.")
1349 (make-variable-buffer-local 'delayed-mode-hooks)
1350 (put 'delay-mode-hooks 'permanent-local t)
1352 (defvar after-change-major-mode-hook nil
1353 "Normal hook run at the very end of major mode functions.")
1355 (defun run-mode-hooks (&rest hooks)
1356 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1357 Execution is delayed if `delay-mode-hooks' is non-nil.
1358 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1359 after running the mode hooks.
1360 Major mode functions should use this instead of `run-hooks' when running their
1362 (if delay-mode-hooks
1364 (dolist (hook hooks)
1365 (push hook delayed-mode-hooks))
1366 ;; Normal case, just run the hook as before plus any delayed hooks.
1367 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1368 (setq delayed-mode-hooks nil)
1369 (apply 'run-hooks hooks)
1370 (run-hooks 'after-change-major-mode-hook)))
1372 (defmacro delay-mode-hooks (&rest body)
1373 "Execute BODY, but delay any `run-mode-hooks'.
1374 These hooks will be executed by the first following call to
1375 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1376 Only affects hooks run in the current buffer."
1377 (declare (debug t) (indent 0))
1379 (make-local-variable 'delay-mode-hooks)
1380 (let ((delay-mode-hooks t))
1383 ;; PUBLIC: find if the current mode derives from another.
1385 (defun derived-mode-p (&rest modes)
1386 "Non-nil if the current major mode is derived from one of MODES.
1387 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1388 (let ((parent major-mode))
1389 (while (and (not (memq parent modes))
1390 (setq parent (get parent 'derived-mode-parent))))
1395 ;; If a minor mode is not defined with define-minor-mode,
1396 ;; add it here explicitly.
1397 ;; isearch-mode is deliberately excluded, since you should
1398 ;; not call it yourself.
1399 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1400 overwrite-mode view-mode
1402 "List of all minor mode functions.")
1404 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1405 "Register a new minor mode.
1407 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1409 TOGGLE is a symbol which is the name of a buffer-local variable that
1410 is toggled on or off to say whether the minor mode is active or not.
1412 NAME specifies what will appear in the mode line when the minor mode
1413 is active. NAME should be either a string starting with a space, or a
1414 symbol whose value is such a string.
1416 Optional KEYMAP is the keymap for the minor mode that will be added
1417 to `minor-mode-map-alist'.
1419 Optional AFTER specifies that TOGGLE should be added after AFTER
1420 in `minor-mode-alist'.
1422 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1423 It defaults to (and should by convention be) TOGGLE.
1425 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1426 included in the mode-line minor mode menu.
1427 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1428 (unless (memq toggle minor-mode-list)
1429 (push toggle minor-mode-list))
1431 (unless toggle-fun (setq toggle-fun toggle))
1432 (unless (eq toggle-fun toggle)
1433 (put toggle :minor-mode-function toggle-fun))
1434 ;; Add the name to the minor-mode-alist.
1436 (let ((existing (assq toggle minor-mode-alist)))
1438 (setcdr existing (list name))
1439 (let ((tail minor-mode-alist) found)
1440 (while (and tail (not found))
1441 (if (eq after (caar tail))
1443 (setq tail (cdr tail))))
1445 (let ((rest (cdr found)))
1447 (nconc found (list (list toggle name)) rest))
1448 (push (list toggle name) minor-mode-alist))))))
1449 ;; Add the toggle to the minor-modes menu if requested.
1450 (when (get toggle :included)
1451 (define-key mode-line-mode-menu
1455 (or (get toggle :menu-tag)
1456 (if (stringp name) name (symbol-name toggle)))
1457 (let ((mode-name (if (symbolp name) (symbol-value name))))
1458 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1459 (concat " (" (match-string 0 mode-name) ")"))))
1461 :button (cons :toggle toggle))))
1463 ;; Add the map to the minor-mode-map-alist.
1465 (let ((existing (assq toggle minor-mode-map-alist)))
1467 (setcdr existing keymap)
1468 (let ((tail minor-mode-map-alist) found)
1469 (while (and tail (not found))
1470 (if (eq after (caar tail))
1472 (setq tail (cdr tail))))
1474 (let ((rest (cdr found)))
1476 (nconc found (list (cons toggle keymap)) rest))
1477 (push (cons toggle keymap) minor-mode-map-alist)))))))
1481 ;; (defvar symbol-file-load-history-loaded nil
1482 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1483 ;; That file records the part of `load-history' for preloaded files,
1484 ;; which is cleared out before dumping to make Emacs smaller.")
1486 ;; (defun load-symbol-file-load-history ()
1487 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1488 ;; That file records the part of `load-history' for preloaded files,
1489 ;; which is cleared out before dumping to make Emacs smaller."
1490 ;; (unless symbol-file-load-history-loaded
1491 ;; (load (expand-file-name
1492 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1493 ;; (if (eq system-type 'ms-dos)
1495 ;; (format "fns-%s.el" emacs-version))
1497 ;; ;; The file name fns-%s.el already has a .el extension.
1499 ;; (setq symbol-file-load-history-loaded t)))
1501 (defun symbol-file (symbol &optional type)
1502 "Return the name of the file that defined SYMBOL.
1503 The value is normally an absolute file name. It can also be nil,
1504 if the definition is not associated with any file. If SYMBOL
1505 specifies an autoloaded function, the value can be a relative
1506 file name without extension.
1508 If TYPE is nil, then any kind of definition is acceptable. If
1509 TYPE is `defun', `defvar', or `defface', that specifies function
1510 definition, variable definition, or face definition only."
1511 (if (and (or (null type) (eq type 'defun))
1512 (symbolp symbol) (fboundp symbol)
1513 (eq 'autoload (car-safe (symbol-function symbol))))
1514 (nth 1 (symbol-function symbol))
1515 (let ((files load-history)
1519 (if (eq type 'defvar)
1520 ;; Variables are present just as their names.
1521 (member symbol (cdr (car files)))
1522 ;; Other types are represented as (TYPE . NAME).
1523 (member (cons type symbol) (cdr (car files))))
1524 ;; We accept all types, so look for variable def
1525 ;; and then for any other kind.
1526 (or (member symbol (cdr (car files)))
1527 (rassq symbol (cdr (car files)))))
1528 (setq file (car (car files)) files nil))
1529 (setq files (cdr files)))
1532 (defun locate-library (library &optional nosuffix path interactive-call)
1533 "Show the precise file name of Emacs library LIBRARY.
1534 LIBRARY should be a relative file name of the library, a string.
1535 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1536 nil (which is the default, see below).
1537 This command searches the directories in `load-path' like `\\[load-library]'
1538 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1539 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1540 to the specified name LIBRARY.
1542 If the optional third arg PATH is specified, that list of directories
1543 is used instead of `load-path'.
1545 When called from a program, the file name is normally returned as a
1546 string. When run interactively, the argument INTERACTIVE-CALL is t,
1547 and the file name is displayed in the echo area."
1548 (interactive (list (completing-read "Locate library: "
1550 'locate-file-completion-table
1551 load-path (get-load-suffixes)))
1554 (let ((file (locate-file library
1556 (append (unless nosuffix (get-load-suffixes))
1557 load-file-rep-suffixes))))
1558 (if interactive-call
1560 (message "Library is file %s" (abbreviate-file-name file))
1561 (message "No library %s in search path" library)))
1565 ;;;; Specifying things to do later.
1567 (defun load-history-regexp (file)
1568 "Form a regexp to find FILE in `load-history'.
1569 FILE, a string, is described in the function `eval-after-load'."
1570 (if (file-name-absolute-p file)
1571 (setq file (file-truename file)))
1572 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1574 (if (file-name-extension file)
1576 ;; Note: regexp-opt can't be used here, since we need to call
1577 ;; this before Emacs has been fully started. 2006-05-21
1578 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1579 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1582 (defun load-history-filename-element (file-regexp)
1583 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1584 Return nil if there isn't one."
1585 (let* ((loads load-history)
1586 (load-elt (and loads (car loads))))
1589 (or (null (car load-elt))
1590 (not (string-match file-regexp (car load-elt)))))
1591 (setq loads (cdr loads)
1592 load-elt (and loads (car loads)))))
1595 (put 'eval-after-load 'lisp-indent-function 1)
1596 (defun eval-after-load (file form)
1597 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1598 If FILE is already loaded, evaluate FORM right now.
1600 If a matching file is loaded again, FORM will be evaluated again.
1602 If FILE is a string, it may be either an absolute or a relative file
1603 name, and may have an extension \(e.g. \".el\") or may lack one, and
1604 additionally may or may not have an extension denoting a compressed
1605 format \(e.g. \".gz\").
1607 When FILE is absolute, this first converts it to a true name by chasing
1608 symbolic links. Only a file of this name \(see next paragraph regarding
1609 extensions) will trigger the evaluation of FORM. When FILE is relative,
1610 a file whose absolute true name ends in FILE will trigger evaluation.
1612 When FILE lacks an extension, a file name with any extension will trigger
1613 evaluation. Otherwise, its extension must match FILE's. A further
1614 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1617 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1618 is evaluated whenever that feature is `provide'd. Note that although
1619 provide statements are usually at the end of files, this is not always
1620 the case (e.g., sometimes they are at the start to avoid a recursive
1621 load error). If your FORM should not be evaluated until the code in
1622 FILE has been, do not use the symbol form for FILE in such cases.
1624 Usually FILE is just a library name like \"font-lock\" or a feature name
1627 This function makes or adds to an entry on `after-load-alist'."
1628 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1629 ;; evaluating it now).
1630 (let* ((regexp-or-feature
1631 (if (stringp file) (setq file (purecopy (load-history-regexp file))) file))
1632 (elt (assoc regexp-or-feature after-load-alist)))
1634 (setq elt (list regexp-or-feature))
1635 (push elt after-load-alist))
1636 ;; Add FORM to the element unless it's already there.
1637 (unless (member form (cdr elt))
1638 (nconc elt (purecopy (list form))))
1640 ;; Is there an already loaded file whose name (or `provide' name)
1642 (if (if (stringp file)
1643 (load-history-filename-element regexp-or-feature)
1647 (defvar after-load-functions nil
1648 "Special hook run after loading a file.
1649 Each function there is called with a single argument, the absolute
1650 name of the file just loaded.")
1652 (defun do-after-load-evaluation (abs-file)
1653 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1654 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1655 This function is called directly from the C code."
1656 ;; Run the relevant eval-after-load forms.
1657 (mapc #'(lambda (a-l-element)
1658 (when (and (stringp (car a-l-element))
1659 (string-match-p (car a-l-element) abs-file))
1660 ;; discard the file name regexp
1661 (mapc #'eval (cdr a-l-element))))
1663 ;; Complain when the user uses obsolete files.
1664 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1665 (run-with-timer 0 nil
1667 (message "Package %s is obsolete!"
1669 (string-match "\\.elc?\\>" file))))
1670 (file-name-nondirectory abs-file)))
1671 ;; Finally, run any other hook.
1672 (run-hook-with-args 'after-load-functions abs-file))
1674 (defun eval-next-after-load (file)
1675 "Read the following input sexp, and run it whenever FILE is loaded.
1676 This makes or adds to an entry on `after-load-alist'.
1677 FILE should be the name of a library, with no directory name."
1678 (eval-after-load file (read)))
1679 (make-obsolete 'eval-next-after-load `eval-after-load "23.2")
1683 (defun process-lines (program &rest args)
1684 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1685 Signal an error if the program returns with a non-zero exit status."
1687 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1688 (unless (eq status 0)
1689 (error "%s exited with status %s" program status))
1690 (goto-char (point-min))
1693 (setq lines (cons (buffer-substring-no-properties
1694 (line-beginning-position)
1695 (line-end-position))
1698 (nreverse lines)))))
1700 ;; open-network-stream is a wrapper around make-network-process.
1702 (when (featurep 'make-network-process)
1703 (defun open-network-stream (name buffer host service)
1704 "Open a TCP connection for a service to a host.
1705 Returns a subprocess-object to represent the connection.
1706 Input and output work as for subprocesses; `delete-process' closes it.
1708 NAME is the name for the process. It is modified if necessary to make
1710 BUFFER is the buffer (or buffer name) to associate with the
1711 process. Process output goes at end of that buffer. BUFFER may
1712 be nil, meaning that this process is not associated with any buffer.
1713 HOST is the name or IP address of the host to connect to.
1714 SERVICE is the name of the service desired, or an integer specifying
1715 a port number to connect to.
1717 This is a wrapper around `make-network-process', and only offers a
1718 subset of its functionality."
1719 (make-network-process :name name :buffer buffer
1720 :host host :service service)))
1725 'process-kill-without-query
1726 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1728 (defun process-kill-without-query (process &optional flag)
1729 "Say no query needed if PROCESS is running when Emacs is exited.
1730 Optional second argument if non-nil says to require a query.
1731 Value is t if a query was formerly required."
1732 (let ((old (process-query-on-exit-flag process)))
1733 (set-process-query-on-exit-flag process nil)
1736 (defun process-kill-buffer-query-function ()
1737 "Ask before killing a buffer that has a running process."
1738 (let ((process (get-buffer-process (current-buffer))))
1740 (not (memq (process-status process) '(run stop open listen)))
1741 (not (process-query-on-exit-flag process))
1742 (yes-or-no-p "Buffer has a running process; kill it? "))))
1744 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1746 ;; process plist management
1748 (defun process-get (process propname)
1749 "Return the value of PROCESS' PROPNAME property.
1750 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1751 (plist-get (process-plist process) propname))
1753 (defun process-put (process propname value)
1754 "Change PROCESS' PROPNAME property to VALUE.
1755 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1756 (set-process-plist process
1757 (plist-put (process-plist process) propname value)))
1760 ;;;; Input and display facilities.
1762 (defvar read-quoted-char-radix 8
1763 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1764 Legitimate radix values are 8, 10 and 16.")
1766 (custom-declare-variable-early
1767 'read-quoted-char-radix 8
1768 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1769 Legitimate radix values are 8, 10 and 16."
1770 :type '(choice (const 8) (const 10) (const 16))
1771 :group 'editing-basics)
1773 (defconst read-key-empty-map (make-sparse-keymap))
1775 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
1777 (defun read-key (&optional prompt)
1778 "Read a key from the keyboard.
1779 Contrary to `read-event' this will not return a raw event but instead will
1780 obey the input decoding and translations usually done by `read-key-sequence'.
1781 So escape sequences and keyboard encoding are taken into account.
1782 When there's an ambiguity because the key looks like the prefix of
1783 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1784 (let ((overriding-terminal-local-map read-key-empty-map)
1785 (overriding-local-map nil)
1787 (old-global-map (current-global-map))
1788 (timer (run-with-idle-timer
1789 ;; Wait long enough that Emacs has the time to receive and
1790 ;; process all the raw events associated with the single-key.
1791 ;; But don't wait too long, or the user may find the delay
1792 ;; annoying (or keep hitting more keys which may then get
1793 ;; lost or misinterpreted).
1794 ;; This is only relevant for keys which Emacs perceives as
1795 ;; "prefixes", such as C-x (because of the C-x 8 map in
1796 ;; key-translate-table and the C-x @ map in function-key-map)
1797 ;; or ESC (because of terminal escape sequences in
1798 ;; input-decode-map).
1801 (let ((keys (this-command-keys-vector)))
1802 (unless (zerop (length keys))
1803 ;; `keys' is non-empty, so the user has hit at least
1804 ;; one key; there's no point waiting any longer, even
1805 ;; though read-key-sequence thinks we should wait
1806 ;; for more input to decide how to interpret the
1808 (throw 'read-key keys)))))))
1812 (let ((map (make-sparse-keymap)))
1813 ;; Don't hide the menu-bar and tool-bar entries.
1814 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
1815 (define-key map [tool-bar] (lookup-key global-map [tool-bar]))
1817 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
1818 (cancel-timer timer)
1819 (use-global-map old-global-map))))
1821 (defun read-quoted-char (&optional prompt)
1822 "Like `read-char', but do not allow quitting.
1823 Also, if the first character read is an octal digit,
1824 we read any number of octal digits and return the
1825 specified character code. Any nondigit terminates the sequence.
1826 If the terminator is RET, it is discarded;
1827 any other terminator is used itself as input.
1829 The optional argument PROMPT specifies a string to use to prompt the user.
1830 The variable `read-quoted-char-radix' controls which radix to use
1832 (let ((message-log-max nil) done (first t) (code 0) char translated)
1834 (let ((inhibit-quit first)
1835 ;; Don't let C-h get the help message--only help function keys.
1838 "Type the special character you want to use,
1839 or the octal character code.
1840 RET terminates the character code and is discarded;
1841 any other non-digit terminates the character code and is then used as input."))
1842 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1843 (if inhibit-quit (setq quit-flag nil)))
1844 ;; Translate TAB key into control-I ASCII character, and so on.
1845 ;; Note: `read-char' does it using the `ascii-character' property.
1846 ;; We should try and use read-key instead.
1847 (let ((translation (lookup-key local-function-key-map (vector char))))
1848 (setq translated (if (arrayp translation)
1849 (aref translation 0)
1851 (if (integerp translated)
1852 (setq translated (char-resolve-modifiers translated)))
1853 (cond ((null translated))
1854 ((not (integerp translated))
1855 (setq unread-command-events (list char)
1857 ((/= (logand translated ?\M-\^@) 0)
1858 ;; Turn a meta-character into a character with the 0200 bit set.
1859 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1861 ((and (<= ?0 translated)
1862 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1863 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1864 (and prompt (setq prompt (message "%s %c" prompt translated))))
1865 ((and (<= ?a (downcase translated))
1866 (< (downcase translated)
1867 (+ ?a -10 (min 36 read-quoted-char-radix))))
1868 (setq code (+ (* code read-quoted-char-radix)
1869 (+ 10 (- (downcase translated) ?a))))
1870 (and prompt (setq prompt (message "%s %c" prompt translated))))
1871 ((and (not first) (eq translated ?\C-m))
1874 (setq unread-command-events (list char)
1876 (t (setq code translated
1881 (defun read-passwd (prompt &optional confirm default)
1882 "Read a password, prompting with PROMPT, and return it.
1883 If optional CONFIRM is non-nil, read the password twice to make sure.
1884 Optional DEFAULT is a default password to use instead of empty input.
1886 This function echoes `.' for each character that the user types.
1888 The user ends with RET, LFD, or ESC. DEL or C-h rubs out.
1889 C-y yanks the current kill. C-u kills line.
1890 C-g quits; if `inhibit-quit' was non-nil around this function,
1891 then it returns nil if the user types C-g, but quit-flag remains set.
1893 Once the caller uses the password, it can erase the password
1894 by doing (clear-string STRING)."
1898 (while (not success)
1899 (let ((first (read-passwd prompt nil default))
1900 (second (read-passwd "Confirm password: " nil default)))
1901 (if (equal first second)
1903 (and (arrayp second) (clear-string second))
1904 (setq success first))
1905 (and (arrayp first) (clear-string first))
1906 (and (arrayp second) (clear-string second))
1907 (message "Password not repeated accurately; please start over")
1911 ;; Copy it so that add-text-properties won't modify
1912 ;; the object that was passed in by the caller.
1913 (prompt (copy-sequence prompt))
1916 (cursor-in-echo-area t)
1917 (message-log-max nil)
1918 (stop-keys (list 'return ?\r ?\n ?\e))
1919 (rubout-keys (list 'backspace ?\b ?\177)))
1920 (add-text-properties 0 (length prompt)
1921 minibuffer-prompt-properties prompt)
1922 (while (progn (message "%s%s"
1924 (make-string (length pass) ?.))
1926 (not (memq c stop-keys)))
1927 (clear-this-command-keys)
1928 (cond ((memq c rubout-keys) ; rubout
1929 (when (> (length pass) 0)
1930 (let ((new-pass (substring pass 0 -1)))
1931 (and (arrayp pass) (clear-string pass))
1932 (setq pass new-pass))))
1933 ((eq c ?\C-g) (keyboard-quit))
1935 ((= c ?\C-u) ; kill line
1936 (and (arrayp pass) (clear-string pass))
1939 (let* ((str (condition-case nil
1946 (substring-no-properties str)))
1947 (and (arrayp pass) (clear-string pass))
1949 (setq pass new-pass))))
1950 ((characterp c) ; insert char
1951 (let* ((new-char (char-to-string c))
1952 (new-pass (concat pass new-char)))
1953 (and (arrayp pass) (clear-string pass))
1954 (clear-string new-char)
1956 (setq pass new-pass)))))
1958 (or pass default "")))))
1960 ;; This should be used by `call-interactively' for `n' specs.
1961 (defun read-number (prompt &optional default)
1962 "Read a numeric value in the minibuffer, prompting with PROMPT.
1963 DEFAULT specifies a default value to return if the user just types RET.
1964 The value of DEFAULT is inserted into PROMPT."
1968 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1969 (replace-match (format " (default %s)" default) t t prompt 1)
1970 (replace-regexp-in-string "[ \t]*\\'"
1971 (format " (default %s) " default)
1975 (let ((str (read-from-minibuffer prompt nil nil nil nil
1977 (number-to-string default)))))
1980 ((zerop (length str)) default)
1981 ((stringp str) (read str))))
1984 (message "Please enter a number.")
1989 (defun sit-for (seconds &optional nodisp obsolete)
1990 "Perform redisplay, then wait for SECONDS seconds or until input is available.
1991 SECONDS may be a floating-point value.
1992 \(On operating systems that do not support waiting for fractions of a
1993 second, floating-point values are rounded down to the nearest integer.)
1995 If optional arg NODISP is t, don't redisplay, just wait for input.
1996 Redisplay does not happen if input is available before it starts.
1998 Value is t if waited the full time with no input arriving, and nil otherwise.
2000 An obsolete, but still supported form is
2001 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2002 where the optional arg MILLISECONDS specifies an additional wait period,
2003 in milliseconds; this was useful when Emacs was built without
2004 floating point support."
2005 (if (numberp nodisp)
2006 (setq seconds (+ seconds (* 1e-3 nodisp))
2008 (if obsolete (setq nodisp obsolete)))
2016 (or nodisp (redisplay)))
2018 (or nodisp (redisplay))
2019 (let ((read (read-event nil nil seconds)))
2022 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2023 ;; unread-command-events as (t . EVENT) so it will be added to
2024 ;; this-command-keys by read-key-sequence.
2025 (if (eq overriding-terminal-local-map universal-argument-map)
2026 (setq read (cons t read)))
2027 (push read unread-command-events)
2029 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2031 ;;; Atomic change groups.
2033 (defmacro atomic-change-group (&rest body)
2034 "Perform BODY as an atomic change group.
2035 This means that if BODY exits abnormally,
2036 all of its changes to the current buffer are undone.
2037 This works regardless of whether undo is enabled in the buffer.
2039 This mechanism is transparent to ordinary use of undo;
2040 if undo is enabled in the buffer and BODY succeeds, the
2041 user can undo the change normally."
2042 (declare (indent 0) (debug t))
2043 (let ((handle (make-symbol "--change-group-handle--"))
2044 (success (make-symbol "--change-group-success--")))
2045 `(let ((,handle (prepare-change-group))
2046 ;; Don't truncate any undo data in the middle of this.
2047 (undo-outer-limit nil)
2048 (undo-limit most-positive-fixnum)
2049 (undo-strong-limit most-positive-fixnum)
2053 ;; This is inside the unwind-protect because
2054 ;; it enables undo if that was disabled; we need
2055 ;; to make sure that it gets disabled again.
2056 (activate-change-group ,handle)
2059 ;; Either of these functions will disable undo
2060 ;; if it was disabled before.
2062 (accept-change-group ,handle)
2063 (cancel-change-group ,handle))))))
2065 (defun prepare-change-group (&optional buffer)
2066 "Return a handle for the current buffer's state, for a change group.
2067 If you specify BUFFER, make a handle for BUFFER's state instead.
2069 Pass the handle to `activate-change-group' afterward to initiate
2070 the actual changes of the change group.
2072 To finish the change group, call either `accept-change-group' or
2073 `cancel-change-group' passing the same handle as argument. Call
2074 `accept-change-group' to accept the changes in the group as final;
2075 call `cancel-change-group' to undo them all. You should use
2076 `unwind-protect' to make sure the group is always finished. The call
2077 to `activate-change-group' should be inside the `unwind-protect'.
2078 Once you finish the group, don't use the handle again--don't try to
2079 finish the same group twice. For a simple example of correct use, see
2080 the source code of `atomic-change-group'.
2082 The handle records only the specified buffer. To make a multibuffer
2083 change group, call this function once for each buffer you want to
2084 cover, then use `nconc' to combine the returned values, like this:
2086 (nconc (prepare-change-group buffer-1)
2087 (prepare-change-group buffer-2))
2089 You can then activate that multibuffer change group with a single
2090 call to `activate-change-group' and finish it with a single call
2091 to `accept-change-group' or `cancel-change-group'."
2094 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2095 (list (cons (current-buffer) buffer-undo-list))))
2097 (defun activate-change-group (handle)
2098 "Activate a change group made with `prepare-change-group' (which see)."
2099 (dolist (elt handle)
2100 (with-current-buffer (car elt)
2101 (if (eq buffer-undo-list t)
2102 (setq buffer-undo-list nil)))))
2104 (defun accept-change-group (handle)
2105 "Finish a change group made with `prepare-change-group' (which see).
2106 This finishes the change group by accepting its changes as final."
2107 (dolist (elt handle)
2108 (with-current-buffer (car elt)
2110 (setq buffer-undo-list t)))))
2112 (defun cancel-change-group (handle)
2113 "Finish a change group made with `prepare-change-group' (which see).
2114 This finishes the change group by reverting all of its changes."
2115 (dolist (elt handle)
2116 (with-current-buffer (car elt)
2117 (setq elt (cdr elt))
2119 ;; Widen buffer temporarily so if the buffer was narrowed within
2120 ;; the body of `atomic-change-group' all changes can be undone.
2123 (if (consp elt) (car elt)))
2125 (if (consp elt) (cdr elt))))
2126 ;; Temporarily truncate the undo log at ELT.
2128 (setcar elt nil) (setcdr elt nil))
2129 (unless (eq last-command 'undo) (undo-start))
2130 ;; Make sure there's no confusion.
2131 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2132 (error "Undoing to some unrelated state"))
2135 (while (listp pending-undo-list) (undo-more 1)))
2136 ;; Reset the modified cons cell ELT to its original content.
2138 (setcar elt old-car)
2139 (setcdr elt old-cdr))
2140 ;; Revert the undo info to what it was when we grabbed the state.
2141 (setq buffer-undo-list elt))))))
2143 ;;;; Display-related functions.
2145 ;; For compatibility.
2146 (defalias 'redraw-modeline 'force-mode-line-update)
2148 (defun force-mode-line-update (&optional all)
2149 "Force redisplay of the current buffer's mode line and header line.
2150 With optional non-nil ALL, force redisplay of all mode lines and
2151 header lines. This function also forces recomputation of the
2152 menu bar menus and the frame title."
2153 (if all (with-current-buffer (other-buffer)))
2154 (set-buffer-modified-p (buffer-modified-p)))
2156 (defun momentary-string-display (string pos &optional exit-char message)
2157 "Momentarily display STRING in the buffer at POS.
2158 Display remains until next event is input.
2159 If POS is a marker, only its position is used; its buffer is ignored.
2160 Optional third arg EXIT-CHAR can be a character, event or event
2161 description list. EXIT-CHAR defaults to SPC. If the input is
2162 EXIT-CHAR it is swallowed; otherwise it is then available as
2163 input (as a command if nothing else).
2164 Display MESSAGE (optional fourth arg) in the echo area.
2165 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2166 (or exit-char (setq exit-char ?\s))
2167 (let ((ol (make-overlay pos pos))
2168 (str (copy-sequence string)))
2172 (overlay-put ol 'after-string str)
2174 ;; To avoid trouble with out-of-bounds position
2176 ;; If the string end is off screen, recenter now.
2177 (if (<= (window-end nil t) pos)
2178 (recenter (/ (window-height) 2))))
2179 (message (or message "Type %s to continue editing.")
2180 (single-key-description exit-char))
2181 (let ((event (read-event)))
2182 ;; `exit-char' can be an event, or an event description list.
2183 (or (eq event exit-char)
2184 (eq event (event-convert-list exit-char))
2185 (setq unread-command-events (list event)))))
2186 (delete-overlay ol))))
2189 ;;;; Overlay operations
2191 (defun copy-overlay (o)
2192 "Return a copy of overlay O."
2193 (let ((o1 (if (overlay-buffer o)
2194 (make-overlay (overlay-start o) (overlay-end o)
2195 ;; FIXME: there's no easy way to find the
2196 ;; insertion-type of the two markers.
2198 (let ((o1 (make-overlay (point-min) (point-min))))
2201 (props (overlay-properties o)))
2203 (overlay-put o1 (pop props) (pop props)))
2206 (defun remove-overlays (&optional beg end name val)
2207 "Clear BEG and END of overlays whose property NAME has value VAL.
2208 Overlays might be moved and/or split.
2209 BEG and END default respectively to the beginning and end of buffer."
2210 ;; This speeds up the loops over overlays.
2211 (unless beg (setq beg (point-min)))
2212 (unless end (setq end (point-max)))
2213 (overlay-recenter end)
2215 (setq beg (prog1 end (setq end beg))))
2217 (dolist (o (overlays-in beg end))
2218 (when (eq (overlay-get o name) val)
2219 ;; Either push this overlay outside beg...end
2220 ;; or split it to exclude beg...end
2221 ;; or delete it entirely (if it is contained in beg...end).
2222 (if (< (overlay-start o) beg)
2223 (if (> (overlay-end o) end)
2225 (move-overlay (copy-overlay o)
2226 (overlay-start o) beg)
2227 (move-overlay o end (overlay-end o)))
2228 (move-overlay o (overlay-start o) beg))
2229 (if (> (overlay-end o) end)
2230 (move-overlay o end (overlay-end o))
2231 (delete-overlay o)))))))
2235 (defvar suspend-hook nil
2236 "Normal hook run by `suspend-emacs', before suspending.")
2238 (defvar suspend-resume-hook nil
2239 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2241 (defvar temp-buffer-show-hook nil
2242 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2243 When the hook runs, the temporary buffer is current, and the window it
2244 was displayed in is selected.")
2246 (defvar temp-buffer-setup-hook nil
2247 "Normal hook run by `with-output-to-temp-buffer' at the start.
2248 When the hook runs, the temporary buffer is current.
2249 This hook is normally set up with a function to put the buffer in Help
2252 ;; Avoid compiler warnings about this variable,
2253 ;; which has a special meaning on certain system types.
2254 (defvar buffer-file-type nil
2255 "Non-nil if the visited file is a binary file.
2256 This variable is meaningful on MS-DOG and Windows NT.
2257 On those systems, it is automatically local in every buffer.
2258 On other systems, this variable is normally always nil.")
2260 ;; The `assert' macro from the cl package signals
2261 ;; `cl-assertion-failed' at runtime so always define it.
2262 (put 'cl-assertion-failed 'error-conditions '(error))
2263 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2265 (defconst user-emacs-directory
2266 (if (eq system-type 'ms-dos)
2267 ;; MS-DOS cannot have initial dot.
2270 "Directory beneath which additional per-user Emacs-specific files are placed.
2271 Various programs in Emacs store information in this directory.
2272 Note that this should end with a directory separator.
2273 See also `locate-user-emacs-file'.")
2275 (defun locate-user-emacs-file (new-name &optional old-name)
2276 "Return an absolute per-user Emacs-specific file name.
2277 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2278 Else return NEW-NAME in `user-emacs-directory', creating the
2279 directory if it does not exist."
2280 (convert-standard-filename
2281 (let* ((home (concat "~" (or init-file-user "")))
2282 (at-home (and old-name (expand-file-name old-name home))))
2283 (if (and at-home (file-readable-p at-home))
2285 ;; Make sure `user-emacs-directory' exists,
2286 ;; unless we're in batch mode or dumping Emacs
2289 (file-accessible-directory-p (directory-file-name user-emacs-directory))
2290 (make-directory user-emacs-directory))
2291 (abbreviate-file-name
2292 (expand-file-name new-name user-emacs-directory))))))
2295 ;;;; Misc. useful functions.
2297 (defun find-tag-default ()
2298 "Determine default tag to search for, based on text at point.
2299 If there is no plausible default, return nil."
2300 (let (from to bound)
2302 ;; Look at text around `point'.
2304 (skip-syntax-backward "w_") (setq from (point)))
2306 (skip-syntax-forward "w_") (setq to (point)))
2308 ;; Look between `line-beginning-position' and `point'.
2310 (and (setq bound (line-beginning-position))
2311 (skip-syntax-backward "^w_" bound)
2312 (> (setq to (point)) bound)
2313 (skip-syntax-backward "w_")
2314 (setq from (point))))
2315 ;; Look between `point' and `line-end-position'.
2317 (and (setq bound (line-end-position))
2318 (skip-syntax-forward "^w_" bound)
2319 (< (setq from (point)) bound)
2320 (skip-syntax-forward "w_")
2321 (setq to (point)))))
2322 (buffer-substring-no-properties from to))))
2324 (defun play-sound (sound)
2325 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2326 The following keywords are recognized:
2328 :file FILE - read sound data from FILE. If FILE isn't an
2329 absolute file name, it is searched in `data-directory'.
2331 :data DATA - read sound data from string DATA.
2333 Exactly one of :file or :data must be present.
2335 :volume VOL - set volume to VOL. VOL must an integer in the
2336 range 0..100 or a float in the range 0..1.0. If not specified,
2337 don't change the volume setting of the sound device.
2339 :device DEVICE - play sound on DEVICE. If not specified,
2340 a system-dependent default device name is used.
2342 Note: :data and :device are currently not supported on Windows."
2343 (if (fboundp 'play-sound-internal)
2344 (play-sound-internal sound)
2345 (error "This Emacs binary lacks sound support")))
2347 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2349 (defun shell-quote-argument (argument)
2350 "Quote ARGUMENT for passing as argument to an inferior shell."
2351 (if (or (eq system-type 'ms-dos)
2352 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2353 ;; Quote using double quotes, but escape any existing quotes in
2354 ;; the argument with backslashes.
2358 (if (or (null (string-match "[^\"]" argument))
2359 (< (match-end 0) (length argument)))
2360 (while (string-match "[\"]" argument start)
2361 (setq end (match-beginning 0)
2362 result (concat result (substring argument start end)
2363 "\\" (substring argument end (1+ end)))
2365 (concat "\"" result (substring argument start) "\""))
2366 (if (equal argument "")
2368 ;; Quote everything except POSIX filename characters.
2369 ;; This should be safe enough even for really weird shells.
2370 (let ((result "") (start 0) end)
2371 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2372 (setq end (match-beginning 0)
2373 result (concat result (substring argument start end)
2374 "\\" (substring argument end (1+ end)))
2376 (concat result (substring argument start))))))
2378 (defun string-or-null-p (object)
2379 "Return t if OBJECT is a string or nil.
2380 Otherwise, return nil."
2381 (or (stringp object) (null object)))
2383 (defun booleanp (object)
2384 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2385 Otherwise, return nil."
2386 (and (memq object '(nil t)) t))
2388 (defun field-at-pos (pos)
2389 "Return the field at position POS, taking stickiness etc into account."
2390 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2391 (if (eq raw-field 'boundary)
2392 (get-char-property (1- (field-end pos)) 'field)
2396 ;;;; Support for yanking and text properties.
2398 (defvar yank-excluded-properties)
2400 (defun remove-yank-excluded-properties (start end)
2401 "Remove `yank-excluded-properties' between START and END positions.
2402 Replaces `category' properties with their defined properties."
2403 (let ((inhibit-read-only t))
2404 ;; Replace any `category' property with the properties it stands
2405 ;; for. This is to remove `mouse-face' properties that are placed
2406 ;; on categories in *Help* buffers' buttons. See
2407 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2409 (unless (memq yank-excluded-properties '(t nil))
2412 (while (< (point) end)
2413 (let ((cat (get-text-property (point) 'category))
2416 (next-single-property-change (point) 'category nil end))
2418 (let (run-end2 original)
2419 (remove-list-of-text-properties (point) run-end '(category))
2420 (while (< (point) run-end)
2421 (setq run-end2 (next-property-change (point) nil run-end))
2422 (setq original (text-properties-at (point)))
2423 (set-text-properties (point) run-end2 (symbol-plist cat))
2424 (add-text-properties (point) run-end2 original)
2425 (goto-char run-end2))))
2426 (goto-char run-end)))))
2427 (if (eq yank-excluded-properties t)
2428 (set-text-properties start end nil)
2429 (remove-list-of-text-properties start end yank-excluded-properties))))
2431 (defvar yank-undo-function)
2433 (defun insert-for-yank (string)
2434 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2436 See `insert-for-yank-1' for more details."
2438 (while (setq to (next-single-property-change 0 'yank-handler string))
2439 (insert-for-yank-1 (substring string 0 to))
2440 (setq string (substring string to))))
2441 (insert-for-yank-1 string))
2443 (defun insert-for-yank-1 (string)
2444 "Insert STRING at point, stripping some text properties.
2446 Strip text properties from the inserted text according to
2447 `yank-excluded-properties'. Otherwise just like (insert STRING).
2449 If STRING has a non-nil `yank-handler' property on the first character,
2450 the normal insert behavior is modified in various ways. The value of
2451 the yank-handler property must be a list with one to four elements
2452 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2453 When FUNCTION is present and non-nil, it is called instead of `insert'
2454 to insert the string. FUNCTION takes one argument--the object to insert.
2455 If PARAM is present and non-nil, it replaces STRING as the object
2456 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2457 `yank-rectangle', PARAM may be a list of strings to insert as a
2459 If NOEXCLUDE is present and non-nil, the normal removal of the
2460 yank-excluded-properties is not performed; instead FUNCTION is
2461 responsible for removing those properties. This may be necessary
2462 if FUNCTION adjusts point before or after inserting the object.
2463 If UNDO is present and non-nil, it is a function that will be called
2464 by `yank-pop' to undo the insertion of the current object. It is
2465 called with two arguments, the start and end of the current region.
2466 FUNCTION may set `yank-undo-function' to override the UNDO value."
2467 (let* ((handler (and (stringp string)
2468 (get-text-property 0 'yank-handler string)))
2469 (param (or (nth 1 handler) string))
2471 (inhibit-read-only inhibit-read-only)
2474 (setq yank-undo-function t)
2475 (if (nth 0 handler) ;; FUNCTION
2476 (funcall (car handler) param)
2480 ;; Prevent read-only properties from interfering with the
2481 ;; following text property changes.
2482 (setq inhibit-read-only t)
2484 ;; What should we do with `font-lock-face' properties?
2485 (if font-lock-defaults
2486 ;; No, just wipe them.
2487 (remove-list-of-text-properties opoint end '(font-lock-face))
2488 ;; Convert them to `face'.
2491 (while (< (point) end)
2492 (let ((face (get-text-property (point) 'font-lock-face))
2495 (next-single-property-change (point) 'font-lock-face nil end))
2497 (remove-text-properties (point) run-end '(font-lock-face nil))
2498 (put-text-property (point) run-end 'face face))
2499 (goto-char run-end)))))
2501 (unless (nth 2 handler) ;; NOEXCLUDE
2502 (remove-yank-excluded-properties opoint (point)))
2504 ;; If last inserted char has properties, mark them as rear-nonsticky.
2505 (if (and (> end opoint)
2506 (text-properties-at (1- end)))
2507 (put-text-property (1- end) end 'rear-nonsticky t))
2509 (if (eq yank-undo-function t) ;; not set by FUNCTION
2510 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2511 (if (nth 4 handler) ;; COMMAND
2512 (setq this-command (nth 4 handler)))))
2514 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2515 "Insert before point a substring of BUFFER, without text properties.
2516 BUFFER may be a buffer or a buffer name.
2517 Arguments START and END are character positions specifying the substring.
2518 They default to the values of (point-min) and (point-max) in BUFFER."
2519 (let ((opoint (point)))
2520 (insert-buffer-substring buffer start end)
2521 (let ((inhibit-read-only t))
2522 (set-text-properties opoint (point) nil))))
2524 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2525 "Insert before point a part of BUFFER, stripping some text properties.
2526 BUFFER may be a buffer or a buffer name.
2527 Arguments START and END are character positions specifying the substring.
2528 They default to the values of (point-min) and (point-max) in BUFFER.
2529 Strip text properties from the inserted text according to
2530 `yank-excluded-properties'."
2531 ;; Since the buffer text should not normally have yank-handler properties,
2532 ;; there is no need to handle them here.
2533 (let ((opoint (point)))
2534 (insert-buffer-substring buffer start end)
2535 (remove-yank-excluded-properties opoint (point))))
2538 ;;;; Synchronous shell commands.
2540 (defun start-process-shell-command (name buffer &rest args)
2541 "Start a program in a subprocess. Return the process object for it.
2542 NAME is name for process. It is modified if necessary to make it unique.
2543 BUFFER is the buffer (or buffer name) to associate with the process.
2544 Process output goes at end of that buffer, unless you specify
2545 an output stream or filter function to handle the output.
2546 BUFFER may be also nil, meaning that this process is not associated
2548 COMMAND is the shell command to run.
2550 An old calling convention accepted any number of arguments after COMMAND,
2551 which were just concatenated to COMMAND. This is still supported but strongly
2553 ;; We used to use `exec' to replace the shell with the command,
2554 ;; but that failed to handle (...) and semicolon, etc.
2555 (start-process name buffer shell-file-name shell-command-switch
2556 (mapconcat 'identity args " ")))
2557 (set-advertised-calling-convention 'start-process-shell-command
2558 '(name buffer command) "23.1")
2560 (defun start-file-process-shell-command (name buffer &rest args)
2561 "Start a program in a subprocess. Return the process object for it.
2562 Similar to `start-process-shell-command', but calls `start-file-process'."
2565 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2566 (if (file-remote-p default-directory) "-c" shell-command-switch)
2567 (mapconcat 'identity args " ")))
2568 (set-advertised-calling-convention 'start-file-process-shell-command
2569 '(name buffer command) "23.1")
2571 (defun call-process-shell-command (command &optional infile buffer display
2573 "Execute the shell command COMMAND synchronously in separate process.
2574 The remaining arguments are optional.
2575 The program's input comes from file INFILE (nil means `/dev/null').
2576 Insert output in BUFFER before point; t means current buffer;
2577 nil for BUFFER means discard it; 0 means discard and don't wait.
2578 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2579 REAL-BUFFER says what to do with standard output, as above,
2580 while STDERR-FILE says what to do with standard error in the child.
2581 STDERR-FILE may be nil (discard standard error output),
2582 t (mix it with ordinary output), or a file name string.
2584 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2585 Remaining arguments are strings passed as additional arguments for COMMAND.
2586 Wildcards and redirection are handled as usual in the shell.
2588 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2589 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2590 status or a signal description string.
2591 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2592 ;; We used to use `exec' to replace the shell with the command,
2593 ;; but that failed to handle (...) and semicolon, etc.
2594 (call-process shell-file-name
2595 infile buffer display
2596 shell-command-switch
2597 (mapconcat 'identity (cons command args) " ")))
2599 (defun process-file-shell-command (command &optional infile buffer display
2601 "Process files synchronously in a separate process.
2602 Similar to `call-process-shell-command', but calls `process-file'."
2604 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2605 infile buffer display
2606 (if (file-remote-p default-directory) "-c" shell-command-switch)
2607 (mapconcat 'identity (cons command args) " ")))
2609 ;;;; Lisp macros to do various things temporarily.
2611 (defmacro with-current-buffer (buffer-or-name &rest body)
2612 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2613 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2614 The value returned is the value of the last form in BODY. See
2615 also `with-temp-buffer'."
2616 (declare (indent 1) (debug t))
2617 `(save-current-buffer
2618 (set-buffer ,buffer-or-name)
2621 (defmacro with-selected-window (window &rest body)
2622 "Execute the forms in BODY with WINDOW as the selected window.
2623 The value returned is the value of the last form in BODY.
2625 This macro saves and restores the selected window, as well as the
2626 selected window of each frame. It does not change the order of
2627 recently selected windows. If the previously selected window of
2628 some frame is no longer live at the end of BODY, that frame's
2629 selected window is left alone. If the selected window is no
2630 longer live, then whatever window is selected at the end of BODY
2633 This macro uses `save-current-buffer' to save and restore the
2634 current buffer, since otherwise its normal operation could
2635 potentially make a different buffer current. It does not alter
2636 the buffer list ordering."
2637 (declare (indent 1) (debug t))
2638 ;; Most of this code is a copy of save-selected-window.
2639 `(let ((save-selected-window-window (selected-window))
2640 ;; It is necessary to save all of these, because calling
2641 ;; select-window changes frame-selected-window for whatever
2642 ;; frame that window is in.
2643 (save-selected-window-alist
2644 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2646 (save-current-buffer
2648 (progn (select-window ,window 'norecord)
2650 (dolist (elt save-selected-window-alist)
2651 (and (frame-live-p (car elt))
2652 (window-live-p (cadr elt))
2653 (set-frame-selected-window (car elt) (cadr elt) 'norecord)))
2654 (when (window-live-p save-selected-window-window)
2655 (select-window save-selected-window-window 'norecord))))))
2657 (defmacro with-selected-frame (frame &rest body)
2658 "Execute the forms in BODY with FRAME as the selected frame.
2659 The value returned is the value of the last form in BODY.
2661 This macro neither changes the order of recently selected windows
2662 nor the buffer list."
2663 (declare (indent 1) (debug t))
2664 (let ((old-frame (make-symbol "old-frame"))
2665 (old-buffer (make-symbol "old-buffer")))
2666 `(let ((,old-frame (selected-frame))
2667 (,old-buffer (current-buffer)))
2669 (progn (select-frame ,frame 'norecord)
2671 (when (frame-live-p ,old-frame)
2672 (select-frame ,old-frame 'norecord))
2673 (when (buffer-live-p ,old-buffer)
2674 (set-buffer ,old-buffer))))))
2676 (defmacro with-temp-file (file &rest body)
2677 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2678 The value returned is the value of the last form in BODY.
2679 See also `with-temp-buffer'."
2680 (declare (indent 1) (debug t))
2681 (let ((temp-file (make-symbol "temp-file"))
2682 (temp-buffer (make-symbol "temp-buffer")))
2683 `(let ((,temp-file ,file)
2685 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2688 (with-current-buffer ,temp-buffer
2690 (with-current-buffer ,temp-buffer
2691 (write-region nil nil ,temp-file nil 0)))
2692 (and (buffer-name ,temp-buffer)
2693 (kill-buffer ,temp-buffer))))))
2695 (defmacro with-temp-message (message &rest body)
2696 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2697 The original message is restored to the echo area after BODY has finished.
2698 The value returned is the value of the last form in BODY.
2699 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2700 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2701 Use a MESSAGE of \"\" to temporarily clear the echo area."
2702 (declare (debug t) (indent 1))
2703 (let ((current-message (make-symbol "current-message"))
2704 (temp-message (make-symbol "with-temp-message")))
2705 `(let ((,temp-message ,message)
2710 (setq ,current-message (current-message))
2711 (message "%s" ,temp-message))
2714 (if ,current-message
2715 (message "%s" ,current-message)
2718 (defmacro with-temp-buffer (&rest body)
2719 "Create a temporary buffer, and evaluate BODY there like `progn'.
2720 See also `with-temp-file' and `with-output-to-string'."
2721 (declare (indent 0) (debug t))
2722 (let ((temp-buffer (make-symbol "temp-buffer")))
2723 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2724 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
2725 (with-current-buffer ,temp-buffer
2728 (and (buffer-name ,temp-buffer)
2729 (kill-buffer ,temp-buffer)))))))
2731 (defmacro with-silent-modifications (&rest body)
2732 "Execute BODY, pretending it does not modify the buffer.
2733 If BODY performs real modifications to the buffer's text, other
2734 than cosmetic ones, undo data may become corrupted.
2735 Typically used around modifications of text-properties which do not really
2736 affect the buffer's content."
2737 (declare (debug t) (indent 0))
2738 (let ((modified (make-symbol "modified")))
2739 `(let* ((,modified (buffer-modified-p))
2740 (buffer-undo-list t)
2741 (inhibit-read-only t)
2742 (inhibit-modification-hooks t)
2744 ;; Avoid setting and removing file locks and checking
2745 ;; buffer's uptodate-ness w.r.t the underlying file.
2747 buffer-file-truename)
2752 (restore-buffer-modified-p nil))))))
2754 (defmacro with-output-to-string (&rest body)
2755 "Execute BODY, return the text it sent to `standard-output', as a string."
2756 (declare (indent 0) (debug t))
2757 `(let ((standard-output
2758 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2761 (let ((standard-output standard-output))
2763 (with-current-buffer standard-output
2765 (kill-buffer standard-output))))
2767 (defmacro with-local-quit (&rest body)
2768 "Execute BODY, allowing quits to terminate BODY but not escape further.
2769 When a quit terminates BODY, `with-local-quit' returns nil but
2770 requests another quit. That quit will be processed as soon as quitting
2771 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2772 (declare (debug t) (indent 0))
2773 `(condition-case nil
2774 (let ((inhibit-quit nil))
2776 (quit (setq quit-flag t)
2777 ;; This call is to give a chance to handle quit-flag
2778 ;; in case inhibit-quit is nil.
2779 ;; Without this, it will not be handled until the next function
2780 ;; call, and that might allow it to exit thru a condition-case
2781 ;; that intends to handle the quit signal next time.
2782 (eval '(ignore nil)))))
2784 (defmacro while-no-input (&rest body)
2785 "Execute BODY only as long as there's no pending input.
2786 If input arrives, that ends the execution of BODY,
2787 and `while-no-input' returns t. Quitting makes it return nil.
2788 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2789 (declare (debug t) (indent 0))
2790 (let ((catch-sym (make-symbol "input")))
2793 (let ((throw-on-input ',catch-sym))
2794 (or (input-pending-p)
2795 (progn ,@body)))))))
2797 (defmacro condition-case-no-debug (var bodyform &rest handlers)
2798 "Like `condition-case' except that it does not catch anything when debugging.
2799 More specifically if `debug-on-error' is set, then it does not catch any signal."
2800 (declare (debug condition-case) (indent 2))
2801 (let ((bodysym (make-symbol "body")))
2802 `(let ((,bodysym (lambda () ,bodyform)))
2805 (condition-case ,var
2809 (defmacro with-demoted-errors (&rest body)
2810 "Run BODY and demote any errors to simple messages.
2811 If `debug-on-error' is non-nil, run BODY without catching its errors.
2812 This is to be used around code which is not expected to signal an error
2813 but which should be robust in the unexpected case that an error is signaled."
2814 (declare (debug t) (indent 0))
2815 (let ((err (make-symbol "err")))
2816 `(condition-case-no-debug ,err
2818 (error (message "Error: %s" ,err) nil))))
2820 (defmacro combine-after-change-calls (&rest body)
2821 "Execute BODY, but don't call the after-change functions till the end.
2822 If BODY makes changes in the buffer, they are recorded
2823 and the functions on `after-change-functions' are called several times
2824 when BODY is finished.
2825 The return value is the value of the last form in BODY.
2827 If `before-change-functions' is non-nil, then calls to the after-change
2828 functions can't be deferred, so in that case this macro has no effect.
2830 Do not alter `after-change-functions' or `before-change-functions'
2832 (declare (indent 0) (debug t))
2834 (let ((combine-after-change-calls t))
2836 (combine-after-change-execute)))
2838 (defmacro with-case-table (table &rest body)
2839 "Execute the forms in BODY with TABLE as the current case table.
2840 The value returned is the value of the last form in BODY."
2841 (declare (indent 1) (debug t))
2842 (let ((old-case-table (make-symbol "table"))
2843 (old-buffer (make-symbol "buffer")))
2844 `(let ((,old-case-table (current-case-table))
2845 (,old-buffer (current-buffer)))
2847 (progn (set-case-table ,table)
2849 (with-current-buffer ,old-buffer
2850 (set-case-table ,old-case-table))))))
2852 ;;; Matching and match data.
2854 (defvar save-match-data-internal)
2856 ;; We use save-match-data-internal as the local variable because
2857 ;; that works ok in practice (people should not use that variable elsewhere).
2858 ;; We used to use an uninterned symbol; the compiler handles that properly
2859 ;; now, but it generates slower code.
2860 (defmacro save-match-data (&rest body)
2861 "Execute the BODY forms, restoring the global value of the match data.
2862 The value returned is the value of the last form in BODY."
2863 ;; It is better not to use backquote here,
2864 ;; because that makes a bootstrapping problem
2865 ;; if you need to recompile all the Lisp files using interpreted code.
2866 (declare (indent 0) (debug t))
2868 '((save-match-data-internal (match-data)))
2869 (list 'unwind-protect
2871 ;; It is safe to free (evaporate) markers immediately here,
2872 ;; as Lisp programs should not copy from save-match-data-internal.
2873 '(set-match-data save-match-data-internal 'evaporate))))
2875 (defun match-string (num &optional string)
2876 "Return string of text matched by last search.
2877 NUM specifies which parenthesized expression in the last regexp.
2878 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2879 Zero means the entire text matched by the whole regexp or whole string.
2880 STRING should be given if the last search was by `string-match' on STRING."
2881 (if (match-beginning num)
2883 (substring string (match-beginning num) (match-end num))
2884 (buffer-substring (match-beginning num) (match-end num)))))
2886 (defun match-string-no-properties (num &optional string)
2887 "Return string of text matched by last search, without text properties.
2888 NUM specifies which parenthesized expression in the last regexp.
2889 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2890 Zero means the entire text matched by the whole regexp or whole string.
2891 STRING should be given if the last search was by `string-match' on STRING."
2892 (if (match-beginning num)
2894 (substring-no-properties string (match-beginning num)
2896 (buffer-substring-no-properties (match-beginning num)
2900 (defun match-substitute-replacement (replacement
2901 &optional fixedcase literal string subexp)
2902 "Return REPLACEMENT as it will be inserted by `replace-match'.
2903 In other words, all back-references in the form `\\&' and `\\N'
2904 are substituted with actual strings matched by the last search.
2905 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
2906 meaning as for `replace-match'."
2907 (let ((match (match-string 0 string)))
2909 (set-match-data (mapcar (lambda (x)
2911 (- x (match-beginning 0))
2914 (replace-match replacement fixedcase literal match subexp))))
2917 (defun looking-back (regexp &optional limit greedy)
2918 "Return non-nil if text before point matches regular expression REGEXP.
2919 Like `looking-at' except matches before point, and is slower.
2920 LIMIT if non-nil speeds up the search by specifying a minimum
2921 starting position, to avoid checking matches that would start
2924 If GREEDY is non-nil, extend the match backwards as far as
2925 possible, stopping when a single additional previous character
2926 cannot be part of a match for REGEXP. When the match is
2927 extended, its starting position is allowed to occur before
2929 (let ((start (point))
2932 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2934 (if (and greedy pos)
2936 (narrow-to-region (point-min) start)
2937 (while (and (> pos (point-min))
2941 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2942 (setq pos (1- pos)))
2945 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2948 (defsubst looking-at-p (regexp)
2950 Same as `looking-at' except this function does not change the match data."
2951 (let ((inhibit-changing-match-data t))
2952 (looking-at regexp)))
2954 (defsubst string-match-p (regexp string &optional start)
2956 Same as `string-match' except this function does not change the match data."
2957 (let ((inhibit-changing-match-data t))
2958 (string-match regexp string start)))
2960 (defun subregexp-context-p (regexp pos &optional start)
2961 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2962 A subregexp context is one where a sub-regexp can appear.
2963 A non-subregexp context is for example within brackets, or within a
2964 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2965 If START is non-nil, it should be a position in REGEXP, smaller
2966 than POS, and known to be in a subregexp context."
2967 ;; Here's one possible implementation, with the great benefit that it
2968 ;; reuses the regexp-matcher's own parser, so it understands all the
2969 ;; details of the syntax. A disadvantage is that it needs to match the
2973 (string-match (substring regexp (or start 0) pos) "")
2976 (not (member (cadr err) '("Unmatched [ or [^"
2978 "Trailing backslash")))))
2979 ;; An alternative implementation:
2980 ;; (defconst re-context-re
2981 ;; (let* ((harmless-ch "[^\\[]")
2982 ;; (harmless-esc "\\\\[^{]")
2983 ;; (class-harmless-ch "[^][]")
2984 ;; (class-lb-harmless "[^]:]")
2985 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2986 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2987 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2989 ;; (concat "\\[^?]?"
2990 ;; "\\(" class-harmless-ch
2991 ;; "\\|" class-lb "\\)*"
2992 ;; "\\[?]")) ; special handling for bare [ at end of re
2993 ;; (braces "\\\\{[0-9,]+\\\\}"))
2994 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2995 ;; "\\|" class "\\|" braces "\\)*\\'"))
2996 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2997 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3002 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3003 "The default value of separators for `split-string'.
3005 A regexp matching strings of whitespace. May be locale-dependent
3006 \(as yet unimplemented). Should not match non-breaking spaces.
3008 Warning: binding this to a different value and using it as default is
3009 likely to have undesired semantics.")
3011 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3012 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3013 ;; expression leads to the equivalent implementation that if SEPARATORS
3014 ;; is defaulted, OMIT-NULLS is treated as t.
3015 (defun split-string (string &optional separators omit-nulls)
3016 "Split STRING into substrings bounded by matches for SEPARATORS.
3018 The beginning and end of STRING, and each match for SEPARATORS, are
3019 splitting points. The substrings matching SEPARATORS are removed, and
3020 the substrings between the splitting points are collected as a list,
3023 If SEPARATORS is non-nil, it should be a regular expression matching text
3024 which separates, but is not part of, the substrings. If nil it defaults to
3025 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3026 OMIT-NULLS is forced to t.
3028 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3029 that for the default value of SEPARATORS leading and trailing whitespace
3030 are effectively trimmed). If nil, all zero-length substrings are retained,
3031 which correctly parses CSV format, for example.
3033 Note that the effect of `(split-string STRING)' is the same as
3034 `(split-string STRING split-string-default-separators t)'. In the rare
3035 case that you wish to retain zero-length substrings when splitting on
3036 whitespace, use `(split-string STRING split-string-default-separators)'.
3038 Modifies the match data; use `save-match-data' if necessary."
3039 (let ((keep-nulls (not (if separators omit-nulls t)))
3040 (rexp (or separators split-string-default-separators))
3044 (while (and (string-match rexp string
3046 (= start (match-beginning 0))
3047 (< start (length string)))
3049 (< start (length string)))
3051 (if (or keep-nulls (< start (match-beginning 0)))
3053 (cons (substring string start (match-beginning 0))
3055 (setq start (match-end 0)))
3056 (if (or keep-nulls (< start (length string)))
3058 (cons (substring string start)
3062 (defun combine-and-quote-strings (strings &optional separator)
3063 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3064 This tries to quote the strings to avoid ambiguity such that
3065 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3066 Only some SEPARATORs will work properly."
3067 (let* ((sep (or separator " "))
3068 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3071 (if (string-match re str)
3072 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3076 (defun split-string-and-unquote (string &optional separator)
3077 "Split the STRING into a list of strings.
3078 It understands Emacs Lisp quoting within STRING, such that
3079 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3080 The SEPARATOR regexp defaults to \"\\s-+\"."
3081 (let ((sep (or separator "\\s-+"))
3082 (i (string-match "\"" string)))
3084 (split-string string sep t) ; no quoting: easy
3085 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3086 (let ((rfs (read-from-string string i)))
3088 (split-string-and-unquote (substring string (cdr rfs))
3092 ;;;; Replacement in strings.
3094 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3095 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3096 Unless optional argument INPLACE is non-nil, return a new string."
3097 (let ((i (length string))
3098 (newstr (if inplace string (copy-sequence string))))
3101 (if (eq (aref newstr i) fromchar)
3102 (aset newstr i tochar)))
3105 (defun replace-regexp-in-string (regexp rep string &optional
3106 fixedcase literal subexp start)
3107 "Replace all matches for REGEXP with REP in STRING.
3109 Return a new string containing the replacements.
3111 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3112 arguments with the same names of function `replace-match'. If START
3113 is non-nil, start replacements at that index in STRING.
3115 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3116 function. If it is a function, it is called with the actual text of each
3117 match, and its value is used as the replacement text. When REP is called,
3118 the match-data are the result of matching REGEXP against a substring
3121 To replace only the first match (if any), make REGEXP match up to \\'
3122 and replace a sub-expression, e.g.
3123 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3127 ;; To avoid excessive consing from multiple matches in long strings,
3128 ;; don't just call `replace-match' continually. Walk down the
3129 ;; string looking for matches of REGEXP and building up a (reversed)
3130 ;; list MATCHES. This comprises segments of STRING which weren't
3131 ;; matched interspersed with replacements for segments that were.
3132 ;; [For a `large' number of replacements it's more efficient to
3133 ;; operate in a temporary buffer; we can't tell from the function's
3134 ;; args whether to choose the buffer-based implementation, though it
3135 ;; might be reasonable to do so for long enough STRING.]
3136 (let ((l (length string))
3137 (start (or start 0))
3140 (while (and (< start l) (string-match regexp string start))
3141 (setq mb (match-beginning 0)
3143 ;; If we matched the empty string, make sure we advance by one char
3144 (when (= me mb) (setq me (min l (1+ mb))))
3145 ;; Generate a replacement for the matched substring.
3146 ;; Operate only on the substring to minimize string consing.
3147 ;; Set up match data for the substring for replacement;
3148 ;; presumably this is likely to be faster than munging the
3149 ;; match data directly in Lisp.
3150 (string-match regexp (setq str (substring string mb me)))
3152 (cons (replace-match (if (stringp rep)
3154 (funcall rep (match-string 0 str)))
3155 fixedcase literal str subexp)
3156 (cons (substring string start mb) ; unmatched prefix
3159 ;; Reconstruct a string from the pieces.
3160 (setq matches (cons (substring string start l) matches)) ; leftover
3161 (apply #'concat (nreverse matches)))))
3163 (defun string-prefix-p (str1 str2 &optional ignore-case)
3164 "Return non-nil if STR1 is a prefix of STR2.
3165 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3166 to case differences."
3167 (eq t (compare-strings str1 nil nil
3168 str2 0 (length str1) ignore-case)))
3170 ;;;; invisibility specs
3172 (defun add-to-invisibility-spec (element)
3173 "Add ELEMENT to `buffer-invisibility-spec'.
3174 See documentation for `buffer-invisibility-spec' for the kind of elements
3176 (if (eq buffer-invisibility-spec t)
3177 (setq buffer-invisibility-spec (list t)))
3178 (setq buffer-invisibility-spec
3179 (cons element buffer-invisibility-spec)))
3181 (defun remove-from-invisibility-spec (element)
3182 "Remove ELEMENT from `buffer-invisibility-spec'."
3183 (if (consp buffer-invisibility-spec)
3184 (setq buffer-invisibility-spec
3185 (delete element buffer-invisibility-spec))))
3189 (defmacro with-syntax-table (table &rest body)
3190 "Evaluate BODY with syntax table of current buffer set to TABLE.
3191 The syntax table of the current buffer is saved, BODY is evaluated, and the
3192 saved table is restored, even in case of an abnormal exit.
3193 Value is what BODY returns."
3194 (declare (debug t) (indent 1))
3195 (let ((old-table (make-symbol "table"))
3196 (old-buffer (make-symbol "buffer")))
3197 `(let ((,old-table (syntax-table))
3198 (,old-buffer (current-buffer)))
3201 (set-syntax-table ,table)
3203 (save-current-buffer
3204 (set-buffer ,old-buffer)
3205 (set-syntax-table ,old-table))))))
3207 (defun make-syntax-table (&optional oldtable)
3208 "Return a new syntax table.
3209 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3210 from `standard-syntax-table' otherwise."
3211 (let ((table (make-char-table 'syntax-table nil)))
3212 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3215 (defun syntax-after (pos)
3216 "Return the raw syntax of the char after POS.
3217 If POS is outside the buffer's accessible portion, return nil."
3218 (unless (or (< pos (point-min)) (>= pos (point-max)))
3219 (let ((st (if parse-sexp-lookup-properties
3220 (get-char-property pos 'syntax-table))))
3222 (aref (or st (syntax-table)) (char-after pos))))))
3224 (defun syntax-class (syntax)
3225 "Return the syntax class part of the syntax descriptor SYNTAX.
3226 If SYNTAX is nil, return nil."
3227 (and syntax (logand (car syntax) 65535)))
3231 (defun text-clone-maintain (ol1 after beg end &optional len)
3232 "Propagate the changes made under the overlay OL1 to the other clones.
3233 This is used on the `modification-hooks' property of text clones."
3234 (when (and after (not undo-in-progress) (overlay-start ol1))
3235 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3236 (setq beg (max beg (+ (overlay-start ol1) margin)))
3237 (setq end (min end (- (overlay-end ol1) margin)))
3240 (when (overlay-get ol1 'text-clone-syntax)
3241 ;; Check content of the clone's text.
3242 (let ((cbeg (+ (overlay-start ol1) margin))
3243 (cend (- (overlay-end ol1) margin)))
3246 (if (not (re-search-forward
3247 (overlay-get ol1 'text-clone-syntax) cend t))
3248 ;; Mark the overlay for deletion.
3249 (overlay-put ol1 'text-clones nil)
3250 (when (< (match-end 0) cend)
3251 ;; Shrink the clone at its end.
3252 (setq end (min end (match-end 0)))
3253 (move-overlay ol1 (overlay-start ol1)
3254 (+ (match-end 0) margin)))
3255 (when (> (match-beginning 0) cbeg)
3256 ;; Shrink the clone at its beginning.
3257 (setq beg (max (match-beginning 0) beg))
3258 (move-overlay ol1 (- (match-beginning 0) margin)
3259 (overlay-end ol1)))))))
3260 ;; Now go ahead and update the clones.
3261 (let ((head (- beg (overlay-start ol1)))
3262 (tail (- (overlay-end ol1) end))
3263 (str (buffer-substring beg end))
3265 (inhibit-modification-hooks t))
3266 (dolist (ol2 (overlay-get ol1 'text-clones))
3267 (let ((oe (overlay-end ol2)))
3268 (unless (or (eq ol1 ol2) (null oe))
3269 (setq nothing-left nil)
3270 (let ((mod-beg (+ (overlay-start ol2) head)))
3271 ;;(overlay-put ol2 'modification-hooks nil)
3272 (goto-char (- (overlay-end ol2) tail))
3273 (unless (> mod-beg (point))
3274 (save-excursion (insert str))
3275 (delete-region mod-beg (point)))
3276 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3278 (if nothing-left (delete-overlay ol1))))))))
3280 (defun text-clone-create (start end &optional spreadp syntax)
3281 "Create a text clone of START...END at point.
3282 Text clones are chunks of text that are automatically kept identical:
3283 changes done to one of the clones will be immediately propagated to the other.
3285 The buffer's content at point is assumed to be already identical to
3286 the one between START and END.
3287 If SYNTAX is provided it's a regexp that describes the possible text of
3288 the clones; the clone will be shrunk or killed if necessary to ensure that
3289 its text matches the regexp.
3290 If SPREADP is non-nil it indicates that text inserted before/after the
3291 clone should be incorporated in the clone."
3292 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3293 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3294 ;; (with a one-char margin at each end) with `t nil'.
3295 ;; We opted for a larger overlay because it behaves better in the case
3296 ;; where the clone is reduced to the empty string (we want the overlay to
3297 ;; stay when the clone's content is the empty string and we want to use
3298 ;; `evaporate' to make sure those overlays get deleted when needed).
3300 (let* ((pt-end (+ (point) (- end start)))
3301 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3303 (end-margin (if (or (not spreadp)
3304 (>= pt-end (point-max))
3305 (>= start (point-max)))
3307 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3308 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3309 (dups (list ol1 ol2)))
3310 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3311 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3312 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3313 ;;(overlay-put ol1 'face 'underline)
3314 (overlay-put ol1 'evaporate t)
3315 (overlay-put ol1 'text-clones dups)
3317 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3318 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3319 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3320 ;;(overlay-put ol2 'face 'underline)
3321 (overlay-put ol2 'evaporate t)
3322 (overlay-put ol2 'text-clones dups)))
3324 ;;;; Misc functions moved over from the C side.
3326 (defun y-or-n-p (prompt)
3327 "Ask user a \"y or n\" question. Return t if answer is \"y\".
3328 The argument PROMPT is the string to display to ask the question.
3329 It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
3330 No confirmation of the answer is requested; a single character is enough.
3331 Also accepts Space to mean yes, or Delete to mean no. \(Actually, it uses
3332 the bindings in `query-replace-map'; see the documentation of that variable
3333 for more information. In this case, the useful bindings are `act', `skip',
3334 `recenter', and `quit'.\)
3336 Under a windowing system a dialog box will be used if `last-nonmenu-event'
3337 is nil and `use-dialog-box' is non-nil."
3338 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
3339 ;; where all the keys were unbound (i.e. it somehow got triggered
3340 ;; within read-key, apparently). I had to kill it.
3341 (let ((answer 'recenter))
3342 (if (and (display-popup-menus-p)
3343 (listp last-nonmenu-event)
3346 (x-popup-dialog t `(,prompt ("yes" . act) ("No" . skip))))
3347 (setq prompt (concat prompt
3348 (if (eq ?\s (aref prompt (1- (length prompt))))
3353 (let ((cursor-in-echo-area t))
3354 (when minibuffer-auto-raise
3355 (raise-frame (window-frame (minibuffer-window))))
3356 (read-key (propertize (if (eq answer 'recenter)
3358 (concat "Please answer y or n. "
3360 'face 'minibuffer-prompt)))))
3361 (setq answer (lookup-key query-replace-map (vector key) t))
3363 ((memq answer '(skip act)) nil)
3364 ((eq answer 'recenter) (recenter) t)
3365 ((memq answer '(exit-prefix quit)) (signal 'quit nil) t)
3369 (let ((ret (eq answer 'act)))
3370 (unless noninteractive
3371 (message "%s %s" prompt (if ret "y" "n")))
3374 ;;;; Mail user agents.
3376 ;; Here we include just enough for other packages to be able
3379 (defun define-mail-user-agent (symbol composefunc sendfunc
3380 &optional abortfunc hookvar)
3381 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3383 SYMBOL can be any Lisp symbol. Its function definition and/or
3384 value as a variable do not matter for this usage; we use only certain
3385 properties on its property list, to encode the rest of the arguments.
3387 COMPOSEFUNC is program callable function that composes an outgoing
3388 mail message buffer. This function should set up the basics of the
3389 buffer without requiring user interaction. It should populate the
3390 standard mail headers, leaving the `to:' and `subject:' headers blank
3393 COMPOSEFUNC should accept several optional arguments--the same
3394 arguments that `compose-mail' takes. See that function's documentation.
3396 SENDFUNC is the command a user would run to send the message.
3398 Optional ABORTFUNC is the command a user would run to abort the
3399 message. For mail packages that don't have a separate abort function,
3400 this can be `kill-buffer' (the equivalent of omitting this argument).
3402 Optional HOOKVAR is a hook variable that gets run before the message
3403 is actually sent. Callers that use the `mail-user-agent' may
3404 install a hook function temporarily on this hook variable.
3405 If HOOKVAR is nil, `mail-send-hook' is used.
3407 The properties used on SYMBOL are `composefunc', `sendfunc',
3408 `abortfunc', and `hookvar'."
3409 (put symbol 'composefunc composefunc)
3410 (put symbol 'sendfunc sendfunc)
3411 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3412 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3414 ;;;; Progress reporters.
3416 ;; Progress reporter has the following structure:
3418 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3425 ;; This weirdeness is for optimization reasons: we want
3426 ;; `progress-reporter-update' to be as fast as possible, so
3427 ;; `(car reporter)' is better than `(aref reporter 0)'.
3429 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3430 ;; digits of precision, it doesn't really matter here. On the other
3431 ;; hand, it greatly simplifies the code.
3433 (defsubst progress-reporter-update (reporter &optional value)
3434 "Report progress of an operation in the echo area.
3435 REPORTER should be the result of a call to `make-progress-reporter'.
3437 If REPORTER is a numerical progress reporter---i.e. if it was
3438 made using non-nil MIN-VALUE and MAX-VALUE arguments to
3439 `make-progress-reporter'---then VALUE should be a number between
3440 MIN-VALUE and MAX-VALUE.
3442 If REPORTER is a non-numerical reporter, VALUE should be nil.
3444 This function is relatively inexpensive. If the change since
3445 last update is too small or insufficient time has passed, it does
3447 (when (or (not (numberp value)) ; For pulsing reporter
3448 (>= value (car reporter))) ; For numerical reporter
3449 (progress-reporter-do-update reporter value)))
3451 (defun make-progress-reporter (message &optional min-value max-value
3452 current-value min-change min-time)
3453 "Return progress reporter object for use with `progress-reporter-update'.
3455 MESSAGE is shown in the echo area, with a status indicator
3456 appended to the end. When you call `progress-reporter-done', the
3457 word \"done\" is printed after the MESSAGE. You can change the
3458 MESSAGE of an existing progress reporter by calling
3459 `progress-reporter-force-update'.
3461 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
3462 and final (100% complete) states of operation; the latter should
3463 be larger. In this case, the status message shows the percentage
3466 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
3467 message shows a \"spinning\", non-numeric indicator.
3469 Optional CURRENT-VALUE is the initial progress; the default is
3471 Optional MIN-CHANGE is the minimal change in percents to report;
3473 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
3474 and/or MAX-VALUE are nil.
3476 Optional MIN-TIME specifies the minimum interval time between
3477 echo area updates (default is 0.2 seconds.) If the function
3478 `float-time' is not present, time is not tracked at all. If the
3479 OS is not capable of measuring fractions of seconds, this
3480 parameter is effectively rounded up."
3482 (setq min-time 0.2))
3484 ;; Force a call to `message' now
3485 (cons (or min-value 0)
3486 (vector (if (and (fboundp 'float-time)
3492 (if min-change (max (min min-change 50) 1) 1)
3494 (progress-reporter-update reporter (or current-value min-value))
3497 (defun progress-reporter-force-update (reporter &optional value new-message)
3498 "Report progress of an operation in the echo area unconditionally.
3500 The first two arguments are the same as in `progress-reporter-update'.
3501 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
3502 (let ((parameters (cdr reporter)))
3504 (aset parameters 3 new-message))
3505 (when (aref parameters 0)
3506 (aset parameters 0 (float-time)))
3507 (progress-reporter-do-update reporter value)))
3509 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
3510 "Characters to use for pulsing progress reporters.")
3512 (defun progress-reporter-do-update (reporter value)
3513 (let* ((parameters (cdr reporter))
3514 (update-time (aref parameters 0))
3515 (min-value (aref parameters 1))
3516 (max-value (aref parameters 2))
3517 (text (aref parameters 3))
3518 (current-time (float-time))
3520 ;; See if enough time has passed since the last update.
3521 (or (not update-time)
3522 (when (>= current-time update-time)
3523 ;; Calculate time for the next update
3524 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3525 (cond ((and min-value max-value)
3526 ;; Numerical indicator
3527 (let* ((one-percent (/ (- max-value min-value) 100.0))
3528 (percentage (if (= max-value min-value)
3530 (truncate (/ (- value min-value)
3532 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
3533 ;; message because not enough time has passed, use 1
3534 ;; instead of MIN-CHANGE. This makes delays between echo
3535 ;; area updates closer to MIN-TIME.
3537 (min (+ min-value (* (+ percentage
3538 (if enough-time-passed
3544 (when (integerp value)
3545 (setcar reporter (ceiling (car reporter))))
3546 ;; Only print message if enough time has passed
3547 (when enough-time-passed
3548 (if (> percentage 0)
3549 (message "%s%d%%" text percentage)
3550 (message "%s" text)))))
3551 ;; Pulsing indicator
3553 (let ((index (mod (1+ (car reporter)) 4))
3554 (message-log-max nil))
3555 (setcar reporter index)
3558 (aref progress-reporter--pulse-characters
3561 (defun progress-reporter-done (reporter)
3562 "Print reporter's message followed by word \"done\" in echo area."
3563 (message "%sdone" (aref (cdr reporter) 3)))
3565 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3566 "Loop a certain number of times and report progress in the echo area.
3567 Evaluate BODY with VAR bound to successive integers running from
3568 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3569 the return value (nil if RESULT is omitted).
3571 At each iteration MESSAGE followed by progress percentage is
3572 printed in the echo area. After the loop is finished, MESSAGE
3573 followed by word \"done\" is printed. This macro is a
3574 convenience wrapper around `make-progress-reporter' and friends.
3576 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3577 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3578 (let ((temp (make-symbol "--dotimes-temp--"))
3579 (temp2 (make-symbol "--dotimes-temp2--"))
3583 (,(car spec) ,start)
3584 (,temp2 (make-progress-reporter ,message ,start ,end)))
3585 (while (< ,(car spec) ,temp)
3587 (progress-reporter-update ,temp2
3588 (setq ,(car spec) (1+ ,(car spec)))))
3589 (progress-reporter-done ,temp2)
3590 nil ,@(cdr (cdr spec)))))
3593 ;;;; Comparing version strings.
3595 (defconst version-separator "."
3596 "Specify the string used to separate the version elements.
3598 Usually the separator is \".\", but it can be any other string.")
3601 (defconst version-regexp-alist
3602 '(("^[-_+ ]?alpha$" . -3)
3603 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3604 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3605 ("^[-_+ ]?beta$" . -2)
3606 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
3607 "Specify association between non-numeric version and its priority.
3609 This association is used to handle version string like \"1.0pre2\",
3610 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3611 non-numeric part of a version string to an integer. For example:
3613 String Version Integer List Version
3614 \"1.0pre2\" (1 0 -1 2)
3615 \"1.0PRE2\" (1 0 -1 2)
3616 \"22.8beta3\" (22 8 -2 3)
3617 \"22.8 Beta3\" (22 8 -2 3)
3618 \"0.9alpha1\" (0 9 -3 1)
3619 \"0.9AlphA1\" (0 9 -3 1)
3620 \"0.9 alpha\" (0 9 -3)
3622 Each element has the following form:
3628 REGEXP regexp used to match non-numeric part of a version string.
3629 It should begin with the `^' anchor and end with a `$' to
3630 prevent false hits. Letter-case is ignored while matching
3633 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
3636 (defun version-to-list (ver)
3637 "Convert version string VER into a list of integers.
3639 The version syntax is given by the following EBNF:
3641 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3643 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3645 SEPARATOR ::= `version-separator' (which see)
3646 | `version-regexp-alist' (which see).
3648 The NUMBER part is optional if SEPARATOR is a match for an element
3649 in `version-regexp-alist'.
3651 Examples of valid version syntax:
3653 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3655 Examples of invalid version syntax:
3657 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3659 Examples of version conversion:
3661 Version String Version as a List of Integers
3662 \"1.0.7.5\" (1 0 7 5)
3663 \"1.0pre2\" (1 0 -1 2)
3664 \"1.0PRE2\" (1 0 -1 2)
3665 \"22.8beta3\" (22 8 -2 3)
3666 \"22.8Beta3\" (22 8 -2 3)
3667 \"0.9alpha1\" (0 9 -3 1)
3668 \"0.9AlphA1\" (0 9 -3 1)
3669 \"0.9alpha\" (0 9 -3)
3671 See documentation for `version-separator' and `version-regexp-alist'."
3672 (or (and (stringp ver) (> (length ver) 0))
3673 (error "Invalid version string: '%s'" ver))
3674 ;; Change .x.y to 0.x.y
3675 (if (and (>= (length ver) (length version-separator))
3676 (string-equal (substring ver 0 (length version-separator))
3678 (setq ver (concat "0" ver)))
3681 (case-fold-search t) ; ignore case in matching
3683 (while (and (setq s (string-match "[0-9]+" ver i))
3685 ;; handle numeric part
3686 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3689 ;; handle non-numeric part
3690 (when (and (setq s (string-match "[^0-9]+" ver i))
3692 (setq s (substring ver i (match-end 0))
3694 ;; handle alpha, beta, pre, etc. separator
3695 (unless (string= s version-separator)
3696 (setq al version-regexp-alist)
3697 (while (and al (not (string-match (caar al) s)))
3700 (push (cdar al) lst))
3701 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
3702 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
3703 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
3705 (t (error "Invalid version syntax: '%s'" ver))))))
3707 (error "Invalid version syntax: '%s'" ver)
3711 (defun version-list-< (l1 l2)
3712 "Return t if L1, a list specification of a version, is lower than L2.
3714 Note that a version specified by the list (1) is equal to (1 0),
3715 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
3716 Also, a version given by the list (1) is higher than (1 -1), which in
3717 turn is higher than (1 -2), which is higher than (1 -3)."
3718 (while (and l1 l2 (= (car l1) (car l2)))
3722 ;; l1 not null and l2 not null
3723 ((and l1 l2) (< (car l1) (car l2)))
3724 ;; l1 null and l2 null ==> l1 length = l2 length
3725 ((and (null l1) (null l2)) nil)
3726 ;; l1 not null and l2 null ==> l1 length > l2 length
3727 (l1 (< (version-list-not-zero l1) 0))
3728 ;; l1 null and l2 not null ==> l2 length > l1 length
3729 (t (< 0 (version-list-not-zero l2)))))
3732 (defun version-list-= (l1 l2)
3733 "Return t if L1, a list specification of a version, is equal to L2.
3735 Note that a version specified by the list (1) is equal to (1 0),
3736 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
3737 Also, a version given by the list (1) is higher than (1 -1), which in
3738 turn is higher than (1 -2), which is higher than (1 -3)."
3739 (while (and l1 l2 (= (car l1) (car l2)))
3743 ;; l1 not null and l2 not null
3745 ;; l1 null and l2 null ==> l1 length = l2 length
3746 ((and (null l1) (null l2)))
3747 ;; l1 not null and l2 null ==> l1 length > l2 length
3748 (l1 (zerop (version-list-not-zero l1)))
3749 ;; l1 null and l2 not null ==> l2 length > l1 length
3750 (t (zerop (version-list-not-zero l2)))))
3753 (defun version-list-<= (l1 l2)
3754 "Return t if L1, a list specification of a version, is lower or equal to L2.
3756 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3757 etc. That is, the trailing zeroes are insignificant. Also, integer
3758 list (1) is greater than (1 -1) which is greater than (1 -2)
3759 which is greater than (1 -3)."
3760 (while (and l1 l2 (= (car l1) (car l2)))
3764 ;; l1 not null and l2 not null
3765 ((and l1 l2) (< (car l1) (car l2)))
3766 ;; l1 null and l2 null ==> l1 length = l2 length
3767 ((and (null l1) (null l2)))
3768 ;; l1 not null and l2 null ==> l1 length > l2 length
3769 (l1 (<= (version-list-not-zero l1) 0))
3770 ;; l1 null and l2 not null ==> l2 length > l1 length
3771 (t (<= 0 (version-list-not-zero l2)))))
3773 (defun version-list-not-zero (lst)
3774 "Return the first non-zero element of LST, which is a list of integers.
3776 If all LST elements are zeros or LST is nil, return zero."
3777 (while (and lst (zerop (car lst)))
3778 (setq lst (cdr lst)))
3781 ;; there is no element different of zero
3785 (defun version< (v1 v2)
3786 "Return t if version V1 is lower (older) than V2.
3788 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3789 etc. That is, the trailing \".0\"s are insignificant. Also, version
3790 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
3791 which is higher than \"1alpha\"."
3792 (version-list-< (version-to-list v1) (version-to-list v2)))
3795 (defun version<= (v1 v2)
3796 "Return t if version V1 is lower (older) than or equal to V2.
3798 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3799 etc. That is, the trailing \".0\"s are insignificant. Also, version
3800 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
3801 which is higher than \"1alpha\"."
3802 (version-list-<= (version-to-list v1) (version-to-list v2)))
3804 (defun version= (v1 v2)
3805 "Return t if version V1 is equal to V2.
3807 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3808 etc. That is, the trailing \".0\"s are insignificant. Also, version
3809 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
3810 which is higher than \"1alpha\"."
3811 (version-list-= (version-to-list v1) (version-to-list v2)))
3815 (defconst menu-bar-separator '("--")
3816 "Separator for menus.")
3818 ;; The following statement ought to be in print.c, but `provide' can't
3820 (when (hash-table-p (car (read-from-string
3821 (prin1-to-string (make-hash-table)))))
3822 (provide 'hashtable-print-readable))
3824 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3825 ;;; subr.el ends here