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 (defmacro with-lexical-binding
(&rest body
)
431 "Execute the statements in BODY using lexical binding."
432 `(let ((internal-interpreter-environment internal-interpreter-environment
))
433 (setq internal-interpreter-environment
'(t))
436 (defun assq-delete-all (key alist
)
437 "Delete from ALIST all elements whose car is `eq' to KEY.
438 Return the modified alist.
439 Elements of ALIST that are not conses are ignored."
440 (while (and (consp (car alist
))
441 (eq (car (car alist
)) key
))
442 (setq alist
(cdr alist
)))
443 (let ((tail alist
) tail-cdr
)
444 (while (setq tail-cdr
(cdr tail
))
445 (if (and (consp (car tail-cdr
))
446 (eq (car (car tail-cdr
)) key
))
447 (setcdr tail
(cdr tail-cdr
))
448 (setq tail tail-cdr
))))
451 (defun rassq-delete-all (value alist
)
452 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
453 Return the modified alist.
454 Elements of ALIST that are not conses are ignored."
455 (while (and (consp (car alist
))
456 (eq (cdr (car alist
)) value
))
457 (setq alist
(cdr alist
)))
458 (let ((tail alist
) tail-cdr
)
459 (while (setq tail-cdr
(cdr tail
))
460 (if (and (consp (car tail-cdr
))
461 (eq (cdr (car tail-cdr
)) value
))
462 (setcdr tail
(cdr tail-cdr
))
463 (setq tail tail-cdr
))))
466 (defun remove (elt seq
)
467 "Return a copy of SEQ with all occurrences of ELT removed.
468 SEQ must be a list, vector, or string. The comparison is done with `equal'."
470 ;; If SEQ isn't a list, there's no need to copy SEQ because
471 ;; `delete' will return a new object.
473 (delete elt
(copy-sequence seq
))))
475 (defun remq (elt list
)
476 "Return LIST with all occurrences of ELT removed.
477 The comparison is done with `eq'. Contrary to `delq', this does not use
478 side-effects, and the argument LIST is not modified."
480 (delq elt
(copy-sequence list
))
486 "Convert KEYS to the internal Emacs key representation.
487 KEYS should be a string constant in the format used for
488 saving keyboard macros (see `edmacro-mode')."
489 (read-kbd-macro keys
))
495 ;; Prevent the \{...} documentation construct
496 ;; from mentioning keys that run this command.
497 (put 'undefined
'suppress-keymap t
)
499 (defun suppress-keymap (map &optional nodigits
)
500 "Make MAP override all normally self-inserting keys to be undefined.
501 Normally, as an exception, digits and minus-sign are set to make prefix args,
502 but optional second arg NODIGITS non-nil treats them like other chars."
503 (define-key map
[remap self-insert-command
] 'undefined
)
506 (define-key map
"-" 'negative-argument
)
507 ;; Make plain numbers do numeric args.
510 (define-key map
(char-to-string loop
) 'digit-argument
)
511 (setq loop
(1+ loop
))))))
513 (defun define-key-after (keymap key definition
&optional after
)
514 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
515 This is like `define-key' except that the binding for KEY is placed
516 just after the binding for the event AFTER, instead of at the beginning
517 of the map. Note that AFTER must be an event type (like KEY), NOT a command
520 If AFTER is t or omitted, the new binding goes at the end of the keymap.
521 AFTER should be a single event type--a symbol or a character, not a sequence.
523 Bindings are always added before any inherited map.
525 The order of bindings in a keymap matters when it is used as a menu."
526 (unless after
(setq after t
))
528 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
530 (if (<= (length key
) 1) (aref key
0)
531 (setq keymap
(lookup-key keymap
533 (butlast (mapcar 'identity key
)))))
534 (aref key
(1- (length key
)))))
535 (let ((tail keymap
) done inserted
)
536 (while (and (not done
) tail
)
537 ;; Delete any earlier bindings for the same key.
538 (if (eq (car-safe (car (cdr tail
))) key
)
539 (setcdr tail
(cdr (cdr tail
))))
540 ;; If we hit an included map, go down that one.
541 (if (keymapp (car tail
)) (setq tail
(car tail
)))
542 ;; When we reach AFTER's binding, insert the new binding after.
543 ;; If we reach an inherited keymap, insert just before that.
544 ;; If we reach the end of this keymap, insert at the end.
545 (if (or (and (eq (car-safe (car tail
)) after
)
547 (eq (car (cdr tail
)) 'keymap
)
550 ;; Stop the scan only if we find a parent keymap.
551 ;; Keep going past the inserted element
552 ;; so we can delete any duplications that come later.
553 (if (eq (car (cdr tail
)) 'keymap
)
555 ;; Don't insert more than once.
557 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
559 (setq tail
(cdr tail
)))))
561 (defun map-keymap-sorted (function keymap
)
562 "Implement `map-keymap' with sorting.
563 Don't call this function; it is for internal use only."
565 (map-keymap (lambda (a b
) (push (cons a b
) list
))
567 (setq list
(sort list
569 (setq a
(car a
) b
(car b
))
571 (if (integerp b
) (< a b
)
574 ;; string< also accepts symbols.
577 (funcall function
(car p
) (cdr p
)))))
579 (defun keymap-canonicalize (map)
580 "Return an equivalent keymap, without inheritance."
583 (prompt (keymap-prompt map
)))
585 (setq map
(map-keymap-internal
588 ;; Treat char-ranges specially.
589 (push (cons key item
) ranges
)
590 (push (cons key item
) bindings
)))
592 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
593 (dolist (binding ranges
)
594 ;; Treat char-ranges specially.
595 (define-key map
(vector (car binding
)) (cdr binding
)))
596 (dolist (binding (prog1 bindings
(setq bindings
())))
597 (let* ((key (car binding
))
599 (oldbind (assq key bindings
)))
600 ;; Newer bindings override older.
601 (if oldbind
(setq bindings
(delq oldbind bindings
)))
602 (when item
;nil bindings just hide older ones.
603 (push binding bindings
))))
604 (nconc map bindings
)))
606 (put 'keyboard-translate-table
'char-table-extra-slots
0)
608 (defun keyboard-translate (from to
)
609 "Translate character FROM to TO at a low level.
610 This function creates a `keyboard-translate-table' if necessary
611 and then modifies one entry in it."
612 (or (char-table-p keyboard-translate-table
)
613 (setq keyboard-translate-table
614 (make-char-table 'keyboard-translate-table nil
)))
615 (aset keyboard-translate-table from to
))
617 ;;;; Key binding commands.
619 (defun global-set-key (key command
)
620 "Give KEY a global binding as COMMAND.
621 COMMAND is the command definition to use; usually it is
622 a symbol naming an interactively-callable function.
623 KEY is a key sequence; noninteractively, it is a string or vector
624 of characters or event types, and non-ASCII characters with codes
625 above 127 (such as ISO Latin-1) can be included if you use a vector.
627 Note that if KEY has a local binding in the current buffer,
628 that local binding will continue to shadow any global binding
629 that you make with this function."
630 (interactive "KSet key globally: \nCSet key %s to command: ")
631 (or (vectorp key
) (stringp key
)
632 (signal 'wrong-type-argument
(list 'arrayp key
)))
633 (define-key (current-global-map) key command
))
635 (defun local-set-key (key command
)
636 "Give KEY a local binding as COMMAND.
637 COMMAND is the command definition to use; usually it is
638 a symbol naming an interactively-callable function.
639 KEY is a key sequence; noninteractively, it is a string or vector
640 of characters or event types, and non-ASCII characters with codes
641 above 127 (such as ISO Latin-1) can be included if you use a vector.
643 The binding goes in the current buffer's local map,
644 which in most cases is shared with all other buffers in the same major mode."
645 (interactive "KSet key locally: \nCSet key %s locally to command: ")
646 (let ((map (current-local-map)))
648 (use-local-map (setq map
(make-sparse-keymap))))
649 (or (vectorp key
) (stringp key
)
650 (signal 'wrong-type-argument
(list 'arrayp key
)))
651 (define-key map key command
)))
653 (defun global-unset-key (key)
654 "Remove global binding of KEY.
655 KEY is a string or vector representing a sequence of keystrokes."
656 (interactive "kUnset key globally: ")
657 (global-set-key key nil
))
659 (defun local-unset-key (key)
660 "Remove local binding of KEY.
661 KEY is a string or vector representing a sequence of keystrokes."
662 (interactive "kUnset key locally: ")
663 (if (current-local-map)
664 (local-set-key key nil
))
667 ;;;; substitute-key-definition and its subroutines.
669 (defvar key-substitution-in-progress nil
670 "Used internally by `substitute-key-definition'.")
672 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
673 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
674 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
675 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
676 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
678 If you don't specify OLDMAP, you can usually get the same results
679 in a cleaner way with command remapping, like this:
680 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
681 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
682 ;; Don't document PREFIX in the doc string because we don't want to
683 ;; advertise it. It's meant for recursive calls only. Here's its
686 ;; If optional argument PREFIX is specified, it should be a key
687 ;; prefix, a string. Redefined bindings will then be bound to the
688 ;; original key, with PREFIX added at the front.
689 (or prefix
(setq prefix
""))
690 (let* ((scan (or oldmap keymap
))
691 (prefix1 (vconcat prefix
[nil]))
692 (key-substitution-in-progress
693 (cons scan key-substitution-in-progress)))
694 ;; Scan OLDMAP, finding each char or event-symbol that
695 ;; has any definition, and act on it with hack-key.
698 (aset prefix1 (length prefix) char)
699 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
702 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
703 (let (inner-def skipped menu-item)
704 ;; Find the actual command name within the binding.
705 (if (eq (car-safe defn) 'menu-item)
706 (setq menu-item defn defn (nth 2 defn))
707 ;; Skip past menu-prompt.
708 (while (stringp (car-safe defn))
709 (push (pop defn) skipped))
710 ;; Skip past cached key-equivalence data for menu items.
711 (if (consp (car-safe defn))
712 (setq defn (cdr defn))))
713 (if (or (eq defn olddef)
714 ;; Compare with equal if definition is a key sequence.
715 ;; That is useful for operating on function-key-map.
716 (and (or (stringp defn) (vectorp defn))
717 (equal defn olddef)))
718 (define-key keymap prefix
720 (let ((copy (copy-sequence menu-item)))
721 (setcar (nthcdr 2 copy) newdef)
723 (nconc (nreverse skipped) newdef)))
724 ;; Look past a symbol that names a keymap.
726 (or (indirect-function defn t) defn))
727 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
728 ;; avoid autoloading a keymap. This is mostly done to preserve the
729 ;; original non-autoloading behavior of pre-map-keymap times.
730 (if (and (keymapp inner-def)
731 ;; Avoid recursively scanning
732 ;; where KEYMAP does not have a submap.
733 (let ((elt (lookup-key keymap prefix)))
734 (or (null elt) (natnump elt) (keymapp elt)))
735 ;; Avoid recursively rescanning keymap being scanned.
736 (not (memq inner-def key-substitution-in-progress)))
737 ;; If this one isn't being scanned already, scan it now.
738 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
741 ;;;; The global keymap tree.
743 ;; global-map, esc-map, and ctl-x-map have their values set up in
744 ;; keymap.c; we just give them docstrings here.
746 (defvar global-map nil
747 "Default global keymap mapping Emacs keyboard input into commands.
748 The value is a keymap which is usually (but not necessarily) Emacs's
752 "Default keymap for ESC (meta) commands.
753 The normal global definition of the character ESC indirects to this keymap.")
755 (defvar ctl-x-map nil
756 "Default keymap for C-x commands.
757 The normal global definition of the character C-x indirects to this keymap.")
759 (defvar ctl-x-4-map (make-sparse-keymap)
760 "Keymap for subcommands of C-x 4.")
761 (defalias 'ctl-x-4-prefix ctl-x-4-map)
762 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
764 (defvar ctl-x-5-map (make-sparse-keymap)
765 "Keymap for frame commands.")
766 (defalias 'ctl-x-5-prefix ctl-x-5-map)
767 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
770 ;;;; Event manipulation functions.
772 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
774 (defun listify-key-sequence (key)
775 "Convert a key sequence to a list of events."
778 (mapcar (function (lambda (c)
780 (logxor c listify-key-sequence-1)
784 (defsubst eventp (obj)
785 "True if the argument is an event object."
786 (or (and (integerp obj)
787 ;; Filter out integers too large to be events.
788 ;; M is the biggest modifier.
789 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
790 (characterp (event-basic-type obj)))
792 (get obj 'event-symbol-elements))
795 (get (car obj) 'event-symbol-elements))))
797 (defun event-modifiers (event)
798 "Return a list of symbols representing the modifier keys in event EVENT.
799 The elements of the list may include `meta', `control',
800 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
802 EVENT may be an event or an event type. If EVENT is a symbol
803 that has never been used in an event that has been read as input
804 in the current Emacs session, then this function can return nil,
805 even when EVENT actually has modifiers."
808 (setq type (car type)))
810 ;; Don't read event-symbol-elements directly since we're not
811 ;; sure the symbol has already been parsed.
812 (cdr (internal-event-symbol-parse-modifiers type))
814 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
815 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
816 (if (not (zerop (logand type ?\M-\^@)))
818 (if (or (not (zerop (logand type ?\C-\^@)))
820 (push 'control list))
821 (if (or (not (zerop (logand type ?\S-\^@)))
822 (/= char (downcase char)))
824 (or (zerop (logand type ?\H-\^@))
826 (or (zerop (logand type ?\s-\^@))
828 (or (zerop (logand type ?\A-\^@))
832 (defun event-basic-type (event)
833 "Return the basic type of the given event (all modifiers removed).
834 The value is a printing character (not upper case) or a symbol.
835 EVENT may be an event or an event type. If EVENT is a symbol
836 that has never been used in an event that has been read as input
837 in the current Emacs session, then this function may return nil."
839 (setq event (car event)))
841 (car (get event 'event-symbol-elements))
842 (let* ((base (logand event (1- ?\A-\^@)))
843 (uncontrolled (if (< base 32) (logior base 64) base)))
844 ;; There are some numbers that are invalid characters and
845 ;; cause `downcase' to get an error.
847 (downcase uncontrolled)
848 (error uncontrolled)))))
850 (defsubst mouse-movement-p (object)
851 "Return non-nil if OBJECT is a mouse movement event."
852 (eq (car-safe object) 'mouse-movement))
854 (defun mouse-event-p (object)
855 "Return non-nil if OBJECT is a mouse click event."
856 ;; is this really correct? maybe remove mouse-movement?
857 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
859 (defsubst event-start (event)
860 "Return the starting position of EVENT.
861 If EVENT is a mouse or key press or a mouse click, this returns the location
863 If EVENT is a drag, this returns the drag's starting position.
864 The return value is of the form
865 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
866 IMAGE (DX . DY) (WIDTH . HEIGHT))
867 The `posn-' functions access elements of such lists."
868 (if (consp event) (nth 1 event)
869 (list (selected-window) (point) '(0 . 0) 0)))
871 (defsubst event-end (event)
872 "Return the ending location of EVENT.
873 EVENT should be a click, drag, or key press event.
874 If EVENT is a click event, this function is the same as `event-start'.
875 The return value is of the form
876 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
877 IMAGE (DX . DY) (WIDTH . HEIGHT))
878 The `posn-' functions access elements of such lists."
879 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
880 (list (selected-window) (point) '(0 . 0) 0)))
882 (defsubst event-click-count (event)
883 "Return the multi-click count of EVENT, a click or drag event.
884 The return value is a positive integer."
885 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
887 ;;;; Extracting fields of the positions in an event.
889 (defsubst posn-window (position)
890 "Return the window in POSITION.
891 POSITION should be a list of the form returned by the `event-start'
892 and `event-end' functions."
895 (defsubst posn-area (position)
896 "Return the window area recorded in POSITION, or nil for the text area.
897 POSITION should be a list of the form returned by the `event-start'
898 and `event-end' functions."
899 (let ((area (if (consp (nth 1 position))
900 (car (nth 1 position))
902 (and (symbolp area) area)))
904 (defsubst posn-point (position)
905 "Return the buffer location in POSITION.
906 POSITION should be a list of the form returned by the `event-start'
907 and `event-end' functions."
909 (if (consp (nth 1 position))
910 (car (nth 1 position))
913 (defun posn-set-point (position)
914 "Move point to POSITION.
915 Select the corresponding window as well."
916 (if (not (windowp (posn-window position)))
917 (error "Position not in text area of window"))
918 (select-window (posn-window position))
919 (if (numberp (posn-point position))
920 (goto-char (posn-point position))))
922 (defsubst posn-x-y (position)
923 "Return the x and y coordinates in POSITION.
924 POSITION should be a list of the form returned by the `event-start'
925 and `event-end' functions."
928 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
930 (defun posn-col-row (position)
931 "Return the nominal column and row in POSITION, measured in characters.
932 The column and row values are approximations calculated from the x
933 and y coordinates in POSITION and the frame's default character width
935 For a scroll-bar event, the result column is 0, and the row
936 corresponds to the vertical position of the click in the scroll bar.
937 POSITION should be a list of the form returned by the `event-start'
938 and `event-end' functions."
939 (let* ((pair (posn-x-y position))
940 (window (posn-window position))
941 (area (posn-area position)))
945 ((eq area 'vertical-scroll-bar)
946 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
947 ((eq area 'horizontal-scroll-bar)
948 (cons (scroll-bar-scale pair (window-width window)) 0))
950 (let* ((frame (if (framep window) window (window-frame window)))
951 ;; FIXME: This should take line-spacing properties on
952 ;; newlines into account.
953 (spacing (when (display-graphic-p frame)
954 (or (with-current-buffer (window-buffer window)
956 (frame-parameter frame 'line-spacing)))))
957 (cond ((floatp spacing)
958 (setq spacing (truncate (* spacing
959 (frame-char-height frame)))))
962 (cons (/ (car pair) (frame-char-width frame))
963 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
964 (if (null header-line-format) 0 1))))))))
966 (defun posn-actual-col-row (position)
967 "Return the actual column and row in POSITION, measured in characters.
968 These are the actual row number in the window and character number in that row.
969 Return nil if POSITION does not contain the actual position; in that case
970 `posn-col-row' can be used to get approximate values.
971 POSITION should be a list of the form returned by the `event-start'
972 and `event-end' functions."
975 (defsubst posn-timestamp (position)
976 "Return the timestamp of POSITION.
977 POSITION should be a list of the form returned by the `event-start'
978 and `event-end' functions."
981 (defsubst posn-string (position)
982 "Return the string object of POSITION.
983 Value is a cons (STRING . STRING-POS), or nil if not a string.
984 POSITION should be a list of the form returned by the `event-start'
985 and `event-end' functions."
988 (defsubst posn-image (position)
989 "Return the image object of POSITION.
990 Value is a list (image ...), or nil if not an image.
991 POSITION should be a list of the form returned by the `event-start'
992 and `event-end' functions."
995 (defsubst posn-object (position)
996 "Return the object (image or string) of POSITION.
997 Value is a list (image ...) for an image object, a cons cell
998 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
999 POSITION should be a list of the form returned by the `event-start'
1000 and `event-end' functions."
1001 (or (posn-image position) (posn-string position)))
1003 (defsubst posn-object-x-y (position)
1004 "Return the x and y coordinates relative to the object of POSITION.
1005 POSITION should be a list of the form returned by the `event-start'
1006 and `event-end' functions."
1009 (defsubst posn-object-width-height (position)
1010 "Return the pixel width and height of the object of POSITION.
1011 POSITION should be a list of the form returned by the `event-start'
1012 and `event-end' functions."
1016 ;;;; Obsolescent names for functions.
1018 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1019 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1020 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1021 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1022 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1023 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1025 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1027 (defun insert-string (&rest args)
1028 "Mocklisp-compatibility insert function.
1029 Like the function `insert' except that any argument that is a number
1030 is converted into a string by expressing it in decimal."
1032 (insert (if (integerp el) (number-to-string el) el))))
1033 (make-obsolete 'insert-string 'insert "22.1")
1035 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1036 (make-obsolete 'makehash 'make-hash-table "22.1")
1038 ;; These are used by VM and some old programs
1039 (defalias 'focus-frame 'ignore "")
1040 (make-obsolete 'focus-frame "it does nothing." "22.1")
1041 (defalias 'unfocus-frame 'ignore "")
1042 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1043 (make-obsolete 'make-variable-frame-local
1044 "explicitly check for a frame-parameter instead." "22.2")
1045 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1046 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
1047 (set-advertised-calling-convention
1048 'all-completions '(string collection &optional predicate) "23.1")
1049 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
1051 ;;;; Obsolescence declarations for variables, and aliases.
1053 ;; Special "default-FOO" variables which contain the default value of
1054 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1055 ;; slows down several unrelated variable operations; furthermore, they
1056 ;; can lead to really odd behavior if you decide to make them
1059 ;; Not used at all in Emacs, last time I checked:
1060 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1061 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1062 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1063 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1064 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1065 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1066 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1067 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1068 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1069 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1070 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1071 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1072 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1073 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1074 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1075 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1076 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1077 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1078 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1079 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1080 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1081 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1082 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1083 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1084 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1085 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1086 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1087 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1088 (make-obsolete-variable 'default-enable-multibyte-characters
1089 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1091 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1092 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1093 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1094 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1096 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1097 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1099 (make-obsolete-variable
1100 'mode-line-inverse-video
1101 "use the appropriate faces instead."
1103 (make-obsolete-variable
1104 'unread-command-char
1105 "use `unread-command-events' instead. That variable is a list of events
1106 to reread, so it now uses nil to mean `no event', instead of -1."
1109 ;; Lisp manual only updated in 22.1.
1110 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1113 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1114 (make-obsolete-variable 'x-lost-selection-hooks
1115 'x-lost-selection-functions "22.1")
1116 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1117 (make-obsolete-variable 'x-sent-selection-hooks
1118 'x-sent-selection-functions "22.1")
1120 ;; This was introduced in 21.4 for pre-unicode unification. That
1121 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1122 ;; Other uses are possible, so this variable is not _really_ obsolete,
1123 ;; but Stefan insists to mark it so.
1124 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1126 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1128 ;; These aliases exist in Emacs 19.34, and probably before, but were
1129 ;; only marked as obsolete in 23.1.
1130 ;; The lisp manual (since at least Emacs 21) describes them as
1131 ;; existing "for compatibility with Emacs version 18".
1132 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1134 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1138 ;;;; Alternate names for functions - these are not being phased out.
1140 (defalias 'send-string 'process-send-string)
1141 (defalias 'send-region 'process-send-region)
1142 (defalias 'string= 'string-equal)
1143 (defalias 'string< 'string-lessp)
1144 (defalias 'move-marker 'set-marker)
1145 (defalias 'rplaca 'setcar)
1146 (defalias 'rplacd 'setcdr)
1147 (defalias 'beep 'ding) ;preserve lingual purity
1148 (defalias 'indent-to-column 'indent-to)
1149 (defalias 'backward-delete-char 'delete-backward-char)
1150 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1151 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1152 (defalias 'int-to-string 'number-to-string)
1153 (defalias 'store-match-data 'set-match-data)
1154 (defalias 'chmod 'set-file-modes)
1155 (defalias 'mkdir 'make-directory)
1156 ;; These are the XEmacs names:
1157 (defalias 'point-at-eol 'line-end-position)
1158 (defalias 'point-at-bol 'line-beginning-position)
1160 (defalias 'user-original-login-name 'user-login-name)
1163 ;;;; Hook manipulation functions.
1165 (defun add-hook (hook function &optional append local)
1166 "Add to the value of HOOK the function FUNCTION.
1167 FUNCTION is not added if already present.
1168 FUNCTION is added (if necessary) at the beginning of the hook list
1169 unless the optional argument APPEND is non-nil, in which case
1170 FUNCTION is added at the end.
1172 The optional fourth argument, LOCAL, if non-nil, says to modify
1173 the hook's buffer-local value rather than its default value.
1174 This makes the hook buffer-local if needed, and it makes t a member
1175 of the buffer-local value. That acts as a flag to run the hook
1176 functions in the default value as well as in the local value.
1178 HOOK should be a symbol, and FUNCTION may be any valid function. If
1179 HOOK is void, it is first set to nil. If HOOK's value is a single
1180 function, it is changed to a list of functions."
1181 (or (boundp hook) (set hook nil))
1182 (or (default-boundp hook) (set-default hook nil))
1183 (if local (unless (local-variable-if-set-p hook)
1184 (set (make-local-variable hook) (list t)))
1185 ;; Detect the case where make-local-variable was used on a hook
1186 ;; and do what we used to do.
1187 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1189 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1190 ;; If the hook value is a single function, turn it into a list.
1191 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1192 (setq hook-value (list hook-value)))
1193 ;; Do the actual addition if necessary
1194 (unless (member function hook-value)
1195 (when (stringp function)
1196 (setq function (purecopy function)))
1199 (append hook-value (list function))
1200 (cons function hook-value))))
1201 ;; Set the actual variable
1204 ;; If HOOK isn't a permanent local,
1205 ;; but FUNCTION wants to survive a change of modes,
1206 ;; mark HOOK as partially permanent.
1207 (and (symbolp function)
1208 (get function 'permanent-local-hook)
1209 (not (get hook 'permanent-local))
1210 (put hook 'permanent-local 'permanent-local-hook))
1211 (set hook hook-value))
1212 (set-default hook hook-value))))
1214 (defun remove-hook (hook function &optional local)
1215 "Remove from the value of HOOK the function FUNCTION.
1216 HOOK should be a symbol, and FUNCTION may be any valid function. If
1217 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1218 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1220 The optional third argument, LOCAL, if non-nil, says to modify
1221 the hook's buffer-local value rather than its default value."
1222 (or (boundp hook) (set hook nil))
1223 (or (default-boundp hook) (set-default hook nil))
1224 ;; Do nothing if LOCAL is t but this hook has no local binding.
1225 (unless (and local (not (local-variable-p hook)))
1226 ;; Detect the case where make-local-variable was used on a hook
1227 ;; and do what we used to do.
1228 (when (and (local-variable-p hook)
1229 (not (and (consp (symbol-value hook))
1230 (memq t (symbol-value hook)))))
1232 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1233 ;; Remove the function, for both the list and the non-list cases.
1234 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1235 (if (equal hook-value function) (setq hook-value nil))
1236 (setq hook-value (delete function (copy-sequence hook-value))))
1237 ;; If the function is on the global hook, we need to shadow it locally
1238 ;;(when (and local (member function (default-value hook))
1239 ;; (not (member (cons 'not function) hook-value)))
1240 ;; (push (cons 'not function) hook-value))
1241 ;; Set the actual variable
1243 (set-default hook hook-value)
1244 (if (equal hook-value '(t))
1245 (kill-local-variable hook)
1246 (set hook hook-value))))))
1248 (defun add-to-list (list-var element &optional append compare-fn)
1249 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1250 The test for presence of ELEMENT is done with `equal',
1251 or with COMPARE-FN if that's non-nil.
1252 If ELEMENT is added, it is added at the beginning of the list,
1253 unless the optional argument APPEND is non-nil, in which case
1254 ELEMENT is added at the end.
1256 The return value is the new value of LIST-VAR.
1258 If you want to use `add-to-list' on a variable that is not defined
1259 until a certain package is loaded, you should put the call to `add-to-list'
1260 into a hook function that will be run only after loading the package.
1261 `eval-after-load' provides one way to do this. In some cases
1262 other hooks, such as major mode hooks, can do the job."
1265 (member element (symbol-value list-var)))
1266 ((eq compare-fn 'eq)
1267 (memq element (symbol-value list-var)))
1268 ((eq compare-fn 'eql)
1269 (memql element (symbol-value list-var)))
1271 (let ((lst (symbol-value list-var)))
1273 (not (funcall compare-fn element (car lst))))
1274 (setq lst (cdr lst)))
1276 (symbol-value list-var)
1279 (append (symbol-value list-var) (list element))
1280 (cons element (symbol-value list-var))))))
1283 (defun add-to-ordered-list (list-var element &optional order)
1284 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1285 The test for presence of ELEMENT is done with `eq'.
1287 The resulting list is reordered so that the elements are in the
1288 order given by each element's numeric list order. Elements
1289 without a numeric list order are placed at the end of the list.
1291 If the third optional argument ORDER is a number (integer or
1292 float), set the element's list order to the given value. If
1293 ORDER is nil or omitted, do not change the numeric order of
1294 ELEMENT. If ORDER has any other value, remove the numeric order
1295 of ELEMENT if it has one.
1297 The list order for each element is stored in LIST-VAR's
1298 `list-order' property.
1300 The return value is the new value of LIST-VAR."
1301 (let ((ordering (get list-var 'list-order)))
1303 (put list-var 'list-order
1304 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1306 (puthash element (and (numberp order) order) ordering))
1307 (unless (memq element (symbol-value list-var))
1308 (set list-var (cons element (symbol-value list-var))))
1309 (set list-var (sort (symbol-value list-var)
1311 (let ((oa (gethash a ordering))
1312 (ob (gethash b ordering)))
1317 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1318 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1319 Return the new history list.
1320 If MAXELT is non-nil, it specifies the maximum length of the history.
1321 Otherwise, the maximum history length is the value of the `history-length'
1322 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1324 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1325 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1326 if it is empty or a duplicate."
1328 (setq maxelt (or (get history-var 'history-length)
1330 (let ((history (symbol-value history-var))
1332 (when (and (listp history)
1334 (not (stringp newelt))
1335 (> (length newelt) 0))
1337 (not (equal (car history) newelt))))
1338 (if history-delete-duplicates
1339 (delete newelt history))
1340 (setq history (cons newelt history))
1341 (when (integerp maxelt)
1344 (setq tail (nthcdr (1- maxelt) history))
1346 (setcdr tail nil)))))
1347 (set history-var history)))
1352 (defvar delay-mode-hooks nil
1353 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1354 (defvar delayed-mode-hooks nil
1355 "List of delayed mode hooks waiting to be run.")
1356 (make-variable-buffer-local 'delayed-mode-hooks)
1357 (put 'delay-mode-hooks 'permanent-local t)
1359 (defvar after-change-major-mode-hook nil
1360 "Normal hook run at the very end of major mode functions.")
1362 (defun run-mode-hooks (&rest hooks)
1363 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1364 Execution is delayed if `delay-mode-hooks' is non-nil.
1365 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1366 after running the mode hooks.
1367 Major mode functions should use this instead of `run-hooks' when running their
1369 (if delay-mode-hooks
1371 (dolist (hook hooks)
1372 (push hook delayed-mode-hooks))
1373 ;; Normal case, just run the hook as before plus any delayed hooks.
1374 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1375 (setq delayed-mode-hooks nil)
1376 (apply 'run-hooks hooks)
1377 (run-hooks 'after-change-major-mode-hook)))
1379 (defmacro delay-mode-hooks (&rest body)
1380 "Execute BODY, but delay any `run-mode-hooks'.
1381 These hooks will be executed by the first following call to
1382 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1383 Only affects hooks run in the current buffer."
1384 (declare (debug t) (indent 0))
1386 (make-local-variable 'delay-mode-hooks)
1387 (let ((delay-mode-hooks t))
1390 ;; PUBLIC: find if the current mode derives from another.
1392 (defun derived-mode-p (&rest modes)
1393 "Non-nil if the current major mode is derived from one of MODES.
1394 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1395 (let ((parent major-mode))
1396 (while (and (not (memq parent modes))
1397 (setq parent (get parent 'derived-mode-parent))))
1402 ;; If a minor mode is not defined with define-minor-mode,
1403 ;; add it here explicitly.
1404 ;; isearch-mode is deliberately excluded, since you should
1405 ;; not call it yourself.
1406 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1407 overwrite-mode view-mode
1409 "List of all minor mode functions.")
1411 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1412 "Register a new minor mode.
1414 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1416 TOGGLE is a symbol which is the name of a buffer-local variable that
1417 is toggled on or off to say whether the minor mode is active or not.
1419 NAME specifies what will appear in the mode line when the minor mode
1420 is active. NAME should be either a string starting with a space, or a
1421 symbol whose value is such a string.
1423 Optional KEYMAP is the keymap for the minor mode that will be added
1424 to `minor-mode-map-alist'.
1426 Optional AFTER specifies that TOGGLE should be added after AFTER
1427 in `minor-mode-alist'.
1429 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1430 It defaults to (and should by convention be) TOGGLE.
1432 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1433 included in the mode-line minor mode menu.
1434 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1435 (unless (memq toggle minor-mode-list)
1436 (push toggle minor-mode-list))
1438 (unless toggle-fun (setq toggle-fun toggle))
1439 (unless (eq toggle-fun toggle)
1440 (put toggle :minor-mode-function toggle-fun))
1441 ;; Add the name to the minor-mode-alist.
1443 (let ((existing (assq toggle minor-mode-alist)))
1445 (setcdr existing (list name))
1446 (let ((tail minor-mode-alist) found)
1447 (while (and tail (not found))
1448 (if (eq after (caar tail))
1450 (setq tail (cdr tail))))
1452 (let ((rest (cdr found)))
1454 (nconc found (list (list toggle name)) rest))
1455 (push (list toggle name) minor-mode-alist))))))
1456 ;; Add the toggle to the minor-modes menu if requested.
1457 (when (get toggle :included)
1458 (define-key mode-line-mode-menu
1462 (or (get toggle :menu-tag)
1463 (if (stringp name) name (symbol-name toggle)))
1464 (let ((mode-name (if (symbolp name) (symbol-value name))))
1465 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1466 (concat " (" (match-string 0 mode-name) ")"))))
1468 :button (cons :toggle toggle))))
1470 ;; Add the map to the minor-mode-map-alist.
1472 (let ((existing (assq toggle minor-mode-map-alist)))
1474 (setcdr existing keymap)
1475 (let ((tail minor-mode-map-alist) found)
1476 (while (and tail (not found))
1477 (if (eq after (caar tail))
1479 (setq tail (cdr tail))))
1481 (let ((rest (cdr found)))
1483 (nconc found (list (cons toggle keymap)) rest))
1484 (push (cons toggle keymap) minor-mode-map-alist)))))))
1488 ;; (defvar symbol-file-load-history-loaded nil
1489 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1490 ;; That file records the part of `load-history' for preloaded files,
1491 ;; which is cleared out before dumping to make Emacs smaller.")
1493 ;; (defun load-symbol-file-load-history ()
1494 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1495 ;; That file records the part of `load-history' for preloaded files,
1496 ;; which is cleared out before dumping to make Emacs smaller."
1497 ;; (unless symbol-file-load-history-loaded
1498 ;; (load (expand-file-name
1499 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1500 ;; (if (eq system-type 'ms-dos)
1502 ;; (format "fns-%s.el" emacs-version))
1504 ;; ;; The file name fns-%s.el already has a .el extension.
1506 ;; (setq symbol-file-load-history-loaded t)))
1508 (defun symbol-file (symbol &optional type)
1509 "Return the name of the file that defined SYMBOL.
1510 The value is normally an absolute file name. It can also be nil,
1511 if the definition is not associated with any file. If SYMBOL
1512 specifies an autoloaded function, the value can be a relative
1513 file name without extension.
1515 If TYPE is nil, then any kind of definition is acceptable. If
1516 TYPE is `defun', `defvar', or `defface', that specifies function
1517 definition, variable definition, or face definition only."
1518 (if (and (or (null type) (eq type 'defun))
1519 (symbolp symbol) (fboundp symbol)
1520 (eq 'autoload (car-safe (symbol-function symbol))))
1521 (nth 1 (symbol-function symbol))
1522 (let ((files load-history)
1526 (if (eq type 'defvar)
1527 ;; Variables are present just as their names.
1528 (member symbol (cdr (car files)))
1529 ;; Other types are represented as (TYPE . NAME).
1530 (member (cons type symbol) (cdr (car files))))
1531 ;; We accept all types, so look for variable def
1532 ;; and then for any other kind.
1533 (or (member symbol (cdr (car files)))
1534 (rassq symbol (cdr (car files)))))
1535 (setq file (car (car files)) files nil))
1536 (setq files (cdr files)))
1539 (defun locate-library (library &optional nosuffix path interactive-call)
1540 "Show the precise file name of Emacs library LIBRARY.
1541 LIBRARY should be a relative file name of the library, a string.
1542 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1543 nil (which is the default, see below).
1544 This command searches the directories in `load-path' like `\\[load-library]'
1545 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1546 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1547 to the specified name LIBRARY.
1549 If the optional third arg PATH is specified, that list of directories
1550 is used instead of `load-path'.
1552 When called from a program, the file name is normally returned as a
1553 string. When run interactively, the argument INTERACTIVE-CALL is t,
1554 and the file name is displayed in the echo area."
1555 (interactive (list (completing-read "Locate library: "
1557 'locate-file-completion-table
1558 load-path (get-load-suffixes)))
1561 (let ((file (locate-file library
1563 (append (unless nosuffix (get-load-suffixes))
1564 load-file-rep-suffixes))))
1565 (if interactive-call
1567 (message "Library is file %s" (abbreviate-file-name file))
1568 (message "No library %s in search path" library)))
1572 ;;;; Specifying things to do later.
1574 (defun load-history-regexp (file)
1575 "Form a regexp to find FILE in `load-history'.
1576 FILE, a string, is described in the function `eval-after-load'."
1577 (if (file-name-absolute-p file)
1578 (setq file (file-truename file)))
1579 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1581 (if (file-name-extension file)
1583 ;; Note: regexp-opt can't be used here, since we need to call
1584 ;; this before Emacs has been fully started. 2006-05-21
1585 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1586 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1589 (defun load-history-filename-element (file-regexp)
1590 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1591 Return nil if there isn't one."
1592 (let* ((loads load-history)
1593 (load-elt (and loads (car loads))))
1596 (or (null (car load-elt))
1597 (not (string-match file-regexp (car load-elt)))))
1598 (setq loads (cdr loads)
1599 load-elt (and loads (car loads)))))
1602 (put 'eval-after-load 'lisp-indent-function 1)
1603 (defun eval-after-load (file form)
1604 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1605 If FILE is already loaded, evaluate FORM right now.
1607 If a matching file is loaded again, FORM will be evaluated again.
1609 If FILE is a string, it may be either an absolute or a relative file
1610 name, and may have an extension \(e.g. \".el\") or may lack one, and
1611 additionally may or may not have an extension denoting a compressed
1612 format \(e.g. \".gz\").
1614 When FILE is absolute, this first converts it to a true name by chasing
1615 symbolic links. Only a file of this name \(see next paragraph regarding
1616 extensions) will trigger the evaluation of FORM. When FILE is relative,
1617 a file whose absolute true name ends in FILE will trigger evaluation.
1619 When FILE lacks an extension, a file name with any extension will trigger
1620 evaluation. Otherwise, its extension must match FILE's. A further
1621 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1624 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1625 is evaluated whenever that feature is `provide'd. Note that although
1626 provide statements are usually at the end of files, this is not always
1627 the case (e.g., sometimes they are at the start to avoid a recursive
1628 load error). If your FORM should not be evaluated until the code in
1629 FILE has been, do not use the symbol form for FILE in such cases.
1631 Usually FILE is just a library name like \"font-lock\" or a feature name
1634 This function makes or adds to an entry on `after-load-alist'."
1635 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1636 ;; evaluating it now).
1637 (let* ((regexp-or-feature
1638 (if (stringp file) (setq file (purecopy (load-history-regexp file))) file))
1639 (elt (assoc regexp-or-feature after-load-alist)))
1641 (setq elt (list regexp-or-feature))
1642 (push elt after-load-alist))
1643 ;; Add FORM to the element unless it's already there.
1644 (unless (member form (cdr elt))
1645 (nconc elt (purecopy (list form))))
1647 ;; Is there an already loaded file whose name (or `provide' name)
1649 (if (if (stringp file)
1650 (load-history-filename-element regexp-or-feature)
1654 (defvar after-load-functions nil
1655 "Special hook run after loading a file.
1656 Each function there is called with a single argument, the absolute
1657 name of the file just loaded.")
1659 (defun do-after-load-evaluation (abs-file)
1660 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1661 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1662 This function is called directly from the C code."
1663 ;; Run the relevant eval-after-load forms.
1664 (mapc #'(lambda (a-l-element)
1665 (when (and (stringp (car a-l-element))
1666 (string-match-p (car a-l-element) abs-file))
1667 ;; discard the file name regexp
1668 (mapc #'eval (cdr a-l-element))))
1670 ;; Complain when the user uses obsolete files.
1671 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1672 (run-with-timer 0 nil
1674 (message "Package %s is obsolete!"
1676 (string-match "\\.elc?\\>" file))))
1677 (file-name-nondirectory abs-file)))
1678 ;; Finally, run any other hook.
1679 (run-hook-with-args 'after-load-functions abs-file))
1681 (defun eval-next-after-load (file)
1682 "Read the following input sexp, and run it whenever FILE is loaded.
1683 This makes or adds to an entry on `after-load-alist'.
1684 FILE should be the name of a library, with no directory name."
1685 (eval-after-load file (read)))
1686 (make-obsolete 'eval-next-after-load `eval-after-load "23.2")
1690 (defun process-lines (program &rest args)
1691 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1692 Signal an error if the program returns with a non-zero exit status."
1694 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1695 (unless (eq status 0)
1696 (error "%s exited with status %s" program status))
1697 (goto-char (point-min))
1700 (setq lines (cons (buffer-substring-no-properties
1701 (line-beginning-position)
1702 (line-end-position))
1705 (nreverse lines)))))
1707 ;; open-network-stream is a wrapper around make-network-process.
1709 (when (featurep 'make-network-process)
1710 (defun open-network-stream (name buffer host service)
1711 "Open a TCP connection for a service to a host.
1712 Returns a subprocess-object to represent the connection.
1713 Input and output work as for subprocesses; `delete-process' closes it.
1715 NAME is the name for the process. It is modified if necessary to make
1717 BUFFER is the buffer (or buffer name) to associate with the
1718 process. Process output goes at end of that buffer. BUFFER may
1719 be nil, meaning that this process is not associated with any buffer.
1720 HOST is the name or IP address of the host to connect to.
1721 SERVICE is the name of the service desired, or an integer specifying
1722 a port number to connect to.
1724 This is a wrapper around `make-network-process', and only offers a
1725 subset of its functionality."
1726 (make-network-process :name name :buffer buffer
1727 :host host :service service)))
1732 'process-kill-without-query
1733 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1735 (defun process-kill-without-query (process &optional flag)
1736 "Say no query needed if PROCESS is running when Emacs is exited.
1737 Optional second argument if non-nil says to require a query.
1738 Value is t if a query was formerly required."
1739 (let ((old (process-query-on-exit-flag process)))
1740 (set-process-query-on-exit-flag process nil)
1743 (defun process-kill-buffer-query-function ()
1744 "Ask before killing a buffer that has a running process."
1745 (let ((process (get-buffer-process (current-buffer))))
1747 (not (memq (process-status process) '(run stop open listen)))
1748 (not (process-query-on-exit-flag process))
1749 (yes-or-no-p "Buffer has a running process; kill it? "))))
1751 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1753 ;; process plist management
1755 (defun process-get (process propname)
1756 "Return the value of PROCESS' PROPNAME property.
1757 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1758 (plist-get (process-plist process) propname))
1760 (defun process-put (process propname value)
1761 "Change PROCESS' PROPNAME property to VALUE.
1762 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1763 (set-process-plist process
1764 (plist-put (process-plist process) propname value)))
1767 ;;;; Input and display facilities.
1769 (defvar read-quoted-char-radix 8
1770 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1771 Legitimate radix values are 8, 10 and 16.")
1773 (custom-declare-variable-early
1774 'read-quoted-char-radix 8
1775 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1776 Legitimate radix values are 8, 10 and 16."
1777 :type '(choice (const 8) (const 10) (const 16))
1778 :group 'editing-basics)
1780 (defconst read-key-empty-map (make-sparse-keymap))
1782 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
1784 (defun read-key (&optional prompt)
1785 "Read a key from the keyboard.
1786 Contrary to `read-event' this will not return a raw event but instead will
1787 obey the input decoding and translations usually done by `read-key-sequence'.
1788 So escape sequences and keyboard encoding are taken into account.
1789 When there's an ambiguity because the key looks like the prefix of
1790 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1791 (let ((overriding-terminal-local-map read-key-empty-map)
1792 (overriding-local-map nil)
1794 (old-global-map (current-global-map))
1795 (timer (run-with-idle-timer
1796 ;; Wait long enough that Emacs has the time to receive and
1797 ;; process all the raw events associated with the single-key.
1798 ;; But don't wait too long, or the user may find the delay
1799 ;; annoying (or keep hitting more keys which may then get
1800 ;; lost or misinterpreted).
1801 ;; This is only relevant for keys which Emacs perceives as
1802 ;; "prefixes", such as C-x (because of the C-x 8 map in
1803 ;; key-translate-table and the C-x @ map in function-key-map)
1804 ;; or ESC (because of terminal escape sequences in
1805 ;; input-decode-map).
1808 (let ((keys (this-command-keys-vector)))
1809 (unless (zerop (length keys))
1810 ;; `keys' is non-empty, so the user has hit at least
1811 ;; one key; there's no point waiting any longer, even
1812 ;; though read-key-sequence thinks we should wait
1813 ;; for more input to decide how to interpret the
1815 (throw 'read-key keys)))))))
1819 (let ((map (make-sparse-keymap)))
1820 ;; Don't hide the menu-bar and tool-bar entries.
1821 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
1822 (define-key map [tool-bar] (lookup-key global-map [tool-bar]))
1824 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
1825 (cancel-timer timer)
1826 (use-global-map old-global-map))))
1828 (defun read-quoted-char (&optional prompt)
1829 "Like `read-char', but do not allow quitting.
1830 Also, if the first character read is an octal digit,
1831 we read any number of octal digits and return the
1832 specified character code. Any nondigit terminates the sequence.
1833 If the terminator is RET, it is discarded;
1834 any other terminator is used itself as input.
1836 The optional argument PROMPT specifies a string to use to prompt the user.
1837 The variable `read-quoted-char-radix' controls which radix to use
1839 (let ((message-log-max nil) done (first t) (code 0) char translated)
1841 (let ((inhibit-quit first)
1842 ;; Don't let C-h get the help message--only help function keys.
1845 "Type the special character you want to use,
1846 or the octal character code.
1847 RET terminates the character code and is discarded;
1848 any other non-digit terminates the character code and is then used as input."))
1849 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1850 (if inhibit-quit (setq quit-flag nil)))
1851 ;; Translate TAB key into control-I ASCII character, and so on.
1852 ;; Note: `read-char' does it using the `ascii-character' property.
1853 ;; We should try and use read-key instead.
1854 (let ((translation (lookup-key local-function-key-map (vector char))))
1855 (setq translated (if (arrayp translation)
1856 (aref translation 0)
1858 (if (integerp translated)
1859 (setq translated (char-resolve-modifiers translated)))
1860 (cond ((null translated))
1861 ((not (integerp translated))
1862 (setq unread-command-events (list char)
1864 ((/= (logand translated ?\M-\^@) 0)
1865 ;; Turn a meta-character into a character with the 0200 bit set.
1866 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1868 ((and (<= ?0 translated)
1869 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1870 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1871 (and prompt (setq prompt (message "%s %c" prompt translated))))
1872 ((and (<= ?a (downcase translated))
1873 (< (downcase translated)
1874 (+ ?a -10 (min 36 read-quoted-char-radix))))
1875 (setq code (+ (* code read-quoted-char-radix)
1876 (+ 10 (- (downcase translated) ?a))))
1877 (and prompt (setq prompt (message "%s %c" prompt translated))))
1878 ((and (not first) (eq translated ?\C-m))
1881 (setq unread-command-events (list char)
1883 (t (setq code translated
1888 (defun read-passwd (prompt &optional confirm default)
1889 "Read a password, prompting with PROMPT, and return it.
1890 If optional CONFIRM is non-nil, read the password twice to make sure.
1891 Optional DEFAULT is a default password to use instead of empty input.
1893 This function echoes `.' for each character that the user types.
1895 The user ends with RET, LFD, or ESC. DEL or C-h rubs out.
1896 C-y yanks the current kill. C-u kills line.
1897 C-g quits; if `inhibit-quit' was non-nil around this function,
1898 then it returns nil if the user types C-g, but quit-flag remains set.
1900 Once the caller uses the password, it can erase the password
1901 by doing (clear-string STRING)."
1905 (while (not success)
1906 (let ((first (read-passwd prompt nil default))
1907 (second (read-passwd "Confirm password: " nil default)))
1908 (if (equal first second)
1910 (and (arrayp second) (clear-string second))
1911 (setq success first))
1912 (and (arrayp first) (clear-string first))
1913 (and (arrayp second) (clear-string second))
1914 (message "Password not repeated accurately; please start over")
1918 ;; Copy it so that add-text-properties won't modify
1919 ;; the object that was passed in by the caller.
1920 (prompt (copy-sequence prompt))
1923 (cursor-in-echo-area t)
1924 (message-log-max nil)
1925 (stop-keys (list 'return ?\r ?\n ?\e))
1926 (rubout-keys (list 'backspace ?\b ?\177)))
1927 (add-text-properties 0 (length prompt)
1928 minibuffer-prompt-properties prompt)
1929 (while (progn (message "%s%s"
1931 (make-string (length pass) ?.))
1933 (not (memq c stop-keys)))
1934 (clear-this-command-keys)
1935 (cond ((memq c rubout-keys) ; rubout
1936 (when (> (length pass) 0)
1937 (let ((new-pass (substring pass 0 -1)))
1938 (and (arrayp pass) (clear-string pass))
1939 (setq pass new-pass))))
1940 ((eq c ?\C-g) (keyboard-quit))
1942 ((= c ?\C-u) ; kill line
1943 (and (arrayp pass) (clear-string pass))
1946 (let* ((str (condition-case nil
1953 (substring-no-properties str)))
1954 (and (arrayp pass) (clear-string pass))
1956 (setq pass new-pass))))
1957 ((characterp c) ; insert char
1958 (let* ((new-char (char-to-string c))
1959 (new-pass (concat pass new-char)))
1960 (and (arrayp pass) (clear-string pass))
1961 (clear-string new-char)
1963 (setq pass new-pass)))))
1965 (or pass default "")))))
1967 ;; This should be used by `call-interactively' for `n' specs.
1968 (defun read-number (prompt &optional default)
1969 "Read a numeric value in the minibuffer, prompting with PROMPT.
1970 DEFAULT specifies a default value to return if the user just types RET.
1971 The value of DEFAULT is inserted into PROMPT."
1975 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1976 (replace-match (format " (default %s)" default) t t prompt 1)
1977 (replace-regexp-in-string "[ \t]*\\'"
1978 (format " (default %s) " default)
1982 (let ((str (read-from-minibuffer prompt nil nil nil nil
1984 (number-to-string default)))))
1987 ((zerop (length str)) default)
1988 ((stringp str) (read str))))
1991 (message "Please enter a number.")
1996 (defun sit-for (seconds &optional nodisp obsolete)
1997 "Perform redisplay, then wait for SECONDS seconds or until input is available.
1998 SECONDS may be a floating-point value.
1999 \(On operating systems that do not support waiting for fractions of a
2000 second, floating-point values are rounded down to the nearest integer.)
2002 If optional arg NODISP is t, don't redisplay, just wait for input.
2003 Redisplay does not happen if input is available before it starts.
2005 Value is t if waited the full time with no input arriving, and nil otherwise.
2007 An obsolete, but still supported form is
2008 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2009 where the optional arg MILLISECONDS specifies an additional wait period,
2010 in milliseconds; this was useful when Emacs was built without
2011 floating point support."
2012 (if (numberp nodisp)
2013 (setq seconds (+ seconds (* 1e-3 nodisp))
2015 (if obsolete (setq nodisp obsolete)))
2023 (or nodisp (redisplay)))
2025 (or nodisp (redisplay))
2026 (let ((read (read-event nil nil seconds)))
2029 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2030 ;; unread-command-events as (t . EVENT) so it will be added to
2031 ;; this-command-keys by read-key-sequence.
2032 (if (eq overriding-terminal-local-map universal-argument-map)
2033 (setq read (cons t read)))
2034 (push read unread-command-events)
2036 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
2038 ;;; Atomic change groups.
2040 (defmacro atomic-change-group (&rest body)
2041 "Perform BODY as an atomic change group.
2042 This means that if BODY exits abnormally,
2043 all of its changes to the current buffer are undone.
2044 This works regardless of whether undo is enabled in the buffer.
2046 This mechanism is transparent to ordinary use of undo;
2047 if undo is enabled in the buffer and BODY succeeds, the
2048 user can undo the change normally."
2049 (declare (indent 0) (debug t))
2050 (let ((handle (make-symbol "--change-group-handle--"))
2051 (success (make-symbol "--change-group-success--")))
2052 `(let ((,handle (prepare-change-group))
2053 ;; Don't truncate any undo data in the middle of this.
2054 (undo-outer-limit nil)
2055 (undo-limit most-positive-fixnum)
2056 (undo-strong-limit most-positive-fixnum)
2060 ;; This is inside the unwind-protect because
2061 ;; it enables undo if that was disabled; we need
2062 ;; to make sure that it gets disabled again.
2063 (activate-change-group ,handle)
2066 ;; Either of these functions will disable undo
2067 ;; if it was disabled before.
2069 (accept-change-group ,handle)
2070 (cancel-change-group ,handle))))))
2072 (defun prepare-change-group (&optional buffer)
2073 "Return a handle for the current buffer's state, for a change group.
2074 If you specify BUFFER, make a handle for BUFFER's state instead.
2076 Pass the handle to `activate-change-group' afterward to initiate
2077 the actual changes of the change group.
2079 To finish the change group, call either `accept-change-group' or
2080 `cancel-change-group' passing the same handle as argument. Call
2081 `accept-change-group' to accept the changes in the group as final;
2082 call `cancel-change-group' to undo them all. You should use
2083 `unwind-protect' to make sure the group is always finished. The call
2084 to `activate-change-group' should be inside the `unwind-protect'.
2085 Once you finish the group, don't use the handle again--don't try to
2086 finish the same group twice. For a simple example of correct use, see
2087 the source code of `atomic-change-group'.
2089 The handle records only the specified buffer. To make a multibuffer
2090 change group, call this function once for each buffer you want to
2091 cover, then use `nconc' to combine the returned values, like this:
2093 (nconc (prepare-change-group buffer-1)
2094 (prepare-change-group buffer-2))
2096 You can then activate that multibuffer change group with a single
2097 call to `activate-change-group' and finish it with a single call
2098 to `accept-change-group' or `cancel-change-group'."
2101 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2102 (list (cons (current-buffer) buffer-undo-list))))
2104 (defun activate-change-group (handle)
2105 "Activate a change group made with `prepare-change-group' (which see)."
2106 (dolist (elt handle)
2107 (with-current-buffer (car elt)
2108 (if (eq buffer-undo-list t)
2109 (setq buffer-undo-list nil)))))
2111 (defun accept-change-group (handle)
2112 "Finish a change group made with `prepare-change-group' (which see).
2113 This finishes the change group by accepting its changes as final."
2114 (dolist (elt handle)
2115 (with-current-buffer (car elt)
2117 (setq buffer-undo-list t)))))
2119 (defun cancel-change-group (handle)
2120 "Finish a change group made with `prepare-change-group' (which see).
2121 This finishes the change group by reverting all of its changes."
2122 (dolist (elt handle)
2123 (with-current-buffer (car elt)
2124 (setq elt (cdr elt))
2126 ;; Widen buffer temporarily so if the buffer was narrowed within
2127 ;; the body of `atomic-change-group' all changes can be undone.
2130 (if (consp elt) (car elt)))
2132 (if (consp elt) (cdr elt))))
2133 ;; Temporarily truncate the undo log at ELT.
2135 (setcar elt nil) (setcdr elt nil))
2136 (unless (eq last-command 'undo) (undo-start))
2137 ;; Make sure there's no confusion.
2138 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2139 (error "Undoing to some unrelated state"))
2142 (while (listp pending-undo-list) (undo-more 1)))
2143 ;; Reset the modified cons cell ELT to its original content.
2145 (setcar elt old-car)
2146 (setcdr elt old-cdr))
2147 ;; Revert the undo info to what it was when we grabbed the state.
2148 (setq buffer-undo-list elt))))))
2150 ;;;; Display-related functions.
2152 ;; For compatibility.
2153 (defalias 'redraw-modeline 'force-mode-line-update)
2155 (defun force-mode-line-update (&optional all)
2156 "Force redisplay of the current buffer's mode line and header line.
2157 With optional non-nil ALL, force redisplay of all mode lines and
2158 header lines. This function also forces recomputation of the
2159 menu bar menus and the frame title."
2160 (if all (with-current-buffer (other-buffer)))
2161 (set-buffer-modified-p (buffer-modified-p)))
2163 (defun momentary-string-display (string pos &optional exit-char message)
2164 "Momentarily display STRING in the buffer at POS.
2165 Display remains until next event is input.
2166 If POS is a marker, only its position is used; its buffer is ignored.
2167 Optional third arg EXIT-CHAR can be a character, event or event
2168 description list. EXIT-CHAR defaults to SPC. If the input is
2169 EXIT-CHAR it is swallowed; otherwise it is then available as
2170 input (as a command if nothing else).
2171 Display MESSAGE (optional fourth arg) in the echo area.
2172 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2173 (or exit-char (setq exit-char ?\s))
2174 (let ((ol (make-overlay pos pos))
2175 (str (copy-sequence string)))
2179 (overlay-put ol 'after-string str)
2181 ;; To avoid trouble with out-of-bounds position
2183 ;; If the string end is off screen, recenter now.
2184 (if (<= (window-end nil t) pos)
2185 (recenter (/ (window-height) 2))))
2186 (message (or message "Type %s to continue editing.")
2187 (single-key-description exit-char))
2188 (let ((event (read-event)))
2189 ;; `exit-char' can be an event, or an event description list.
2190 (or (eq event exit-char)
2191 (eq event (event-convert-list exit-char))
2192 (setq unread-command-events (list event)))))
2193 (delete-overlay ol))))
2196 ;;;; Overlay operations
2198 (defun copy-overlay (o)
2199 "Return a copy of overlay O."
2200 (let ((o1 (if (overlay-buffer o)
2201 (make-overlay (overlay-start o) (overlay-end o)
2202 ;; FIXME: there's no easy way to find the
2203 ;; insertion-type of the two markers.
2205 (let ((o1 (make-overlay (point-min) (point-min))))
2208 (props (overlay-properties o)))
2210 (overlay-put o1 (pop props) (pop props)))
2213 (defun remove-overlays (&optional beg end name val)
2214 "Clear BEG and END of overlays whose property NAME has value VAL.
2215 Overlays might be moved and/or split.
2216 BEG and END default respectively to the beginning and end of buffer."
2217 ;; This speeds up the loops over overlays.
2218 (unless beg (setq beg (point-min)))
2219 (unless end (setq end (point-max)))
2220 (overlay-recenter end)
2222 (setq beg (prog1 end (setq end beg))))
2224 (dolist (o (overlays-in beg end))
2225 (when (eq (overlay-get o name) val)
2226 ;; Either push this overlay outside beg...end
2227 ;; or split it to exclude beg...end
2228 ;; or delete it entirely (if it is contained in beg...end).
2229 (if (< (overlay-start o) beg)
2230 (if (> (overlay-end o) end)
2232 (move-overlay (copy-overlay o)
2233 (overlay-start o) beg)
2234 (move-overlay o end (overlay-end o)))
2235 (move-overlay o (overlay-start o) beg))
2236 (if (> (overlay-end o) end)
2237 (move-overlay o end (overlay-end o))
2238 (delete-overlay o)))))))
2242 (defvar suspend-hook nil
2243 "Normal hook run by `suspend-emacs', before suspending.")
2245 (defvar suspend-resume-hook nil
2246 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2248 (defvar temp-buffer-show-hook nil
2249 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2250 When the hook runs, the temporary buffer is current, and the window it
2251 was displayed in is selected.")
2253 (defvar temp-buffer-setup-hook nil
2254 "Normal hook run by `with-output-to-temp-buffer' at the start.
2255 When the hook runs, the temporary buffer is current.
2256 This hook is normally set up with a function to put the buffer in Help
2259 ;; Avoid compiler warnings about this variable,
2260 ;; which has a special meaning on certain system types.
2261 (defvar buffer-file-type nil
2262 "Non-nil if the visited file is a binary file.
2263 This variable is meaningful on MS-DOG and Windows NT.
2264 On those systems, it is automatically local in every buffer.
2265 On other systems, this variable is normally always nil.")
2267 ;; The `assert' macro from the cl package signals
2268 ;; `cl-assertion-failed' at runtime so always define it.
2269 (put 'cl-assertion-failed 'error-conditions '(error))
2270 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
2272 (defconst user-emacs-directory
2273 (if (eq system-type 'ms-dos)
2274 ;; MS-DOS cannot have initial dot.
2277 "Directory beneath which additional per-user Emacs-specific files are placed.
2278 Various programs in Emacs store information in this directory.
2279 Note that this should end with a directory separator.
2280 See also `locate-user-emacs-file'.")
2282 (defun locate-user-emacs-file (new-name &optional old-name)
2283 "Return an absolute per-user Emacs-specific file name.
2284 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2285 Else return NEW-NAME in `user-emacs-directory', creating the
2286 directory if it does not exist."
2287 (convert-standard-filename
2288 (let* ((home (concat "~" (or init-file-user "")))
2289 (at-home (and old-name (expand-file-name old-name home))))
2290 (if (and at-home (file-readable-p at-home))
2292 ;; Make sure `user-emacs-directory' exists,
2293 ;; unless we're in batch mode or dumping Emacs
2296 (file-accessible-directory-p (directory-file-name user-emacs-directory))
2297 (make-directory user-emacs-directory))
2298 (abbreviate-file-name
2299 (expand-file-name new-name user-emacs-directory))))))
2302 ;;;; Misc. useful functions.
2304 (defun find-tag-default ()
2305 "Determine default tag to search for, based on text at point.
2306 If there is no plausible default, return nil."
2307 (let (from to bound)
2309 ;; Look at text around `point'.
2311 (skip-syntax-backward "w_") (setq from (point)))
2313 (skip-syntax-forward "w_") (setq to (point)))
2315 ;; Look between `line-beginning-position' and `point'.
2317 (and (setq bound (line-beginning-position))
2318 (skip-syntax-backward "^w_" bound)
2319 (> (setq to (point)) bound)
2320 (skip-syntax-backward "w_")
2321 (setq from (point))))
2322 ;; Look between `point' and `line-end-position'.
2324 (and (setq bound (line-end-position))
2325 (skip-syntax-forward "^w_" bound)
2326 (< (setq from (point)) bound)
2327 (skip-syntax-forward "w_")
2328 (setq to (point)))))
2329 (buffer-substring-no-properties from to))))
2331 (defun play-sound (sound)
2332 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2333 The following keywords are recognized:
2335 :file FILE - read sound data from FILE. If FILE isn't an
2336 absolute file name, it is searched in `data-directory'.
2338 :data DATA - read sound data from string DATA.
2340 Exactly one of :file or :data must be present.
2342 :volume VOL - set volume to VOL. VOL must an integer in the
2343 range 0..100 or a float in the range 0..1.0. If not specified,
2344 don't change the volume setting of the sound device.
2346 :device DEVICE - play sound on DEVICE. If not specified,
2347 a system-dependent default device name is used.
2349 Note: :data and :device are currently not supported on Windows."
2350 (if (fboundp 'play-sound-internal)
2351 (play-sound-internal sound)
2352 (error "This Emacs binary lacks sound support")))
2354 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2356 (defun shell-quote-argument (argument)
2357 "Quote ARGUMENT for passing as argument to an inferior shell."
2358 (if (or (eq system-type 'ms-dos)
2359 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2360 ;; Quote using double quotes, but escape any existing quotes in
2361 ;; the argument with backslashes.
2365 (if (or (null (string-match "[^\"]" argument))
2366 (< (match-end 0) (length argument)))
2367 (while (string-match "[\"]" argument start)
2368 (setq end (match-beginning 0)
2369 result (concat result (substring argument start end)
2370 "\\" (substring argument end (1+ end)))
2372 (concat "\"" result (substring argument start) "\""))
2373 (if (equal argument "")
2375 ;; Quote everything except POSIX filename characters.
2376 ;; This should be safe enough even for really weird shells.
2377 (let ((result "") (start 0) end)
2378 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2379 (setq end (match-beginning 0)
2380 result (concat result (substring argument start end)
2381 "\\" (substring argument end (1+ end)))
2383 (concat result (substring argument start))))))
2385 (defun string-or-null-p (object)
2386 "Return t if OBJECT is a string or nil.
2387 Otherwise, return nil."
2388 (or (stringp object) (null object)))
2390 (defun booleanp (object)
2391 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2392 Otherwise, return nil."
2393 (and (memq object '(nil t)) t))
2395 (defun field-at-pos (pos)
2396 "Return the field at position POS, taking stickiness etc into account."
2397 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2398 (if (eq raw-field 'boundary)
2399 (get-char-property (1- (field-end pos)) 'field)
2403 ;;;; Support for yanking and text properties.
2405 (defvar yank-excluded-properties)
2407 (defun remove-yank-excluded-properties (start end)
2408 "Remove `yank-excluded-properties' between START and END positions.
2409 Replaces `category' properties with their defined properties."
2410 (let ((inhibit-read-only t))
2411 ;; Replace any `category' property with the properties it stands
2412 ;; for. This is to remove `mouse-face' properties that are placed
2413 ;; on categories in *Help* buffers' buttons. See
2414 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2416 (unless (memq yank-excluded-properties '(t nil))
2419 (while (< (point) end)
2420 (let ((cat (get-text-property (point) 'category))
2423 (next-single-property-change (point) 'category nil end))
2425 (let (run-end2 original)
2426 (remove-list-of-text-properties (point) run-end '(category))
2427 (while (< (point) run-end)
2428 (setq run-end2 (next-property-change (point) nil run-end))
2429 (setq original (text-properties-at (point)))
2430 (set-text-properties (point) run-end2 (symbol-plist cat))
2431 (add-text-properties (point) run-end2 original)
2432 (goto-char run-end2))))
2433 (goto-char run-end)))))
2434 (if (eq yank-excluded-properties t)
2435 (set-text-properties start end nil)
2436 (remove-list-of-text-properties start end yank-excluded-properties))))
2438 (defvar yank-undo-function)
2440 (defun insert-for-yank (string)
2441 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2443 See `insert-for-yank-1' for more details."
2445 (while (setq to (next-single-property-change 0 'yank-handler string))
2446 (insert-for-yank-1 (substring string 0 to))
2447 (setq string (substring string to))))
2448 (insert-for-yank-1 string))
2450 (defun insert-for-yank-1 (string)
2451 "Insert STRING at point, stripping some text properties.
2453 Strip text properties from the inserted text according to
2454 `yank-excluded-properties'. Otherwise just like (insert STRING).
2456 If STRING has a non-nil `yank-handler' property on the first character,
2457 the normal insert behavior is modified in various ways. The value of
2458 the yank-handler property must be a list with one to four elements
2459 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2460 When FUNCTION is present and non-nil, it is called instead of `insert'
2461 to insert the string. FUNCTION takes one argument--the object to insert.
2462 If PARAM is present and non-nil, it replaces STRING as the object
2463 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2464 `yank-rectangle', PARAM may be a list of strings to insert as a
2466 If NOEXCLUDE is present and non-nil, the normal removal of the
2467 yank-excluded-properties is not performed; instead FUNCTION is
2468 responsible for removing those properties. This may be necessary
2469 if FUNCTION adjusts point before or after inserting the object.
2470 If UNDO is present and non-nil, it is a function that will be called
2471 by `yank-pop' to undo the insertion of the current object. It is
2472 called with two arguments, the start and end of the current region.
2473 FUNCTION may set `yank-undo-function' to override the UNDO value."
2474 (let* ((handler (and (stringp string)
2475 (get-text-property 0 'yank-handler string)))
2476 (param (or (nth 1 handler) string))
2478 (inhibit-read-only inhibit-read-only)
2481 (setq yank-undo-function t)
2482 (if (nth 0 handler) ;; FUNCTION
2483 (funcall (car handler) param)
2487 ;; Prevent read-only properties from interfering with the
2488 ;; following text property changes.
2489 (setq inhibit-read-only t)
2491 ;; What should we do with `font-lock-face' properties?
2492 (if font-lock-defaults
2493 ;; No, just wipe them.
2494 (remove-list-of-text-properties opoint end '(font-lock-face))
2495 ;; Convert them to `face'.
2498 (while (< (point) end)
2499 (let ((face (get-text-property (point) 'font-lock-face))
2502 (next-single-property-change (point) 'font-lock-face nil end))
2504 (remove-text-properties (point) run-end '(font-lock-face nil))
2505 (put-text-property (point) run-end 'face face))
2506 (goto-char run-end)))))
2508 (unless (nth 2 handler) ;; NOEXCLUDE
2509 (remove-yank-excluded-properties opoint (point)))
2511 ;; If last inserted char has properties, mark them as rear-nonsticky.
2512 (if (and (> end opoint)
2513 (text-properties-at (1- end)))
2514 (put-text-property (1- end) end 'rear-nonsticky t))
2516 (if (eq yank-undo-function t) ;; not set by FUNCTION
2517 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2518 (if (nth 4 handler) ;; COMMAND
2519 (setq this-command (nth 4 handler)))))
2521 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2522 "Insert before point a substring of BUFFER, without text properties.
2523 BUFFER may be a buffer or a buffer name.
2524 Arguments START and END are character positions specifying the substring.
2525 They default to the values of (point-min) and (point-max) in BUFFER."
2526 (let ((opoint (point)))
2527 (insert-buffer-substring buffer start end)
2528 (let ((inhibit-read-only t))
2529 (set-text-properties opoint (point) nil))))
2531 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2532 "Insert before point a part of BUFFER, stripping some text properties.
2533 BUFFER may be a buffer or a buffer name.
2534 Arguments START and END are character positions specifying the substring.
2535 They default to the values of (point-min) and (point-max) in BUFFER.
2536 Strip text properties from the inserted text according to
2537 `yank-excluded-properties'."
2538 ;; Since the buffer text should not normally have yank-handler properties,
2539 ;; there is no need to handle them here.
2540 (let ((opoint (point)))
2541 (insert-buffer-substring buffer start end)
2542 (remove-yank-excluded-properties opoint (point))))
2545 ;;;; Synchronous shell commands.
2547 (defun start-process-shell-command (name buffer &rest args)
2548 "Start a program in a subprocess. Return the process object for it.
2549 NAME is name for process. It is modified if necessary to make it unique.
2550 BUFFER is the buffer (or buffer name) to associate with the process.
2551 Process output goes at end of that buffer, unless you specify
2552 an output stream or filter function to handle the output.
2553 BUFFER may be also nil, meaning that this process is not associated
2555 COMMAND is the shell command to run.
2557 An old calling convention accepted any number of arguments after COMMAND,
2558 which were just concatenated to COMMAND. This is still supported but strongly
2560 ;; We used to use `exec' to replace the shell with the command,
2561 ;; but that failed to handle (...) and semicolon, etc.
2562 (start-process name buffer shell-file-name shell-command-switch
2563 (mapconcat 'identity args " ")))
2564 (set-advertised-calling-convention 'start-process-shell-command
2565 '(name buffer command) "23.1")
2567 (defun start-file-process-shell-command (name buffer &rest args)
2568 "Start a program in a subprocess. Return the process object for it.
2569 Similar to `start-process-shell-command', but calls `start-file-process'."
2572 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2573 (if (file-remote-p default-directory) "-c" shell-command-switch)
2574 (mapconcat 'identity args " ")))
2575 (set-advertised-calling-convention 'start-file-process-shell-command
2576 '(name buffer command) "23.1")
2578 (defun call-process-shell-command (command &optional infile buffer display
2580 "Execute the shell command COMMAND synchronously in separate process.
2581 The remaining arguments are optional.
2582 The program's input comes from file INFILE (nil means `/dev/null').
2583 Insert output in BUFFER before point; t means current buffer;
2584 nil for BUFFER means discard it; 0 means discard and don't wait.
2585 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2586 REAL-BUFFER says what to do with standard output, as above,
2587 while STDERR-FILE says what to do with standard error in the child.
2588 STDERR-FILE may be nil (discard standard error output),
2589 t (mix it with ordinary output), or a file name string.
2591 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2592 Remaining arguments are strings passed as additional arguments for COMMAND.
2593 Wildcards and redirection are handled as usual in the shell.
2595 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2596 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2597 status or a signal description string.
2598 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2599 ;; We used to use `exec' to replace the shell with the command,
2600 ;; but that failed to handle (...) and semicolon, etc.
2601 (call-process shell-file-name
2602 infile buffer display
2603 shell-command-switch
2604 (mapconcat 'identity (cons command args) " ")))
2606 (defun process-file-shell-command (command &optional infile buffer display
2608 "Process files synchronously in a separate process.
2609 Similar to `call-process-shell-command', but calls `process-file'."
2611 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2612 infile buffer display
2613 (if (file-remote-p default-directory) "-c" shell-command-switch)
2614 (mapconcat 'identity (cons command args) " ")))
2616 ;;;; Lisp macros to do various things temporarily.
2618 (defmacro with-current-buffer (buffer-or-name &rest body)
2619 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2620 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2621 The value returned is the value of the last form in BODY. See
2622 also `with-temp-buffer'."
2623 (declare (indent 1) (debug t))
2624 `(save-current-buffer
2625 (set-buffer ,buffer-or-name)
2628 (defmacro with-selected-window (window &rest body)
2629 "Execute the forms in BODY with WINDOW as the selected window.
2630 The value returned is the value of the last form in BODY.
2632 This macro saves and restores the selected window, as well as the
2633 selected window of each frame. It does not change the order of
2634 recently selected windows. If the previously selected window of
2635 some frame is no longer live at the end of BODY, that frame's
2636 selected window is left alone. If the selected window is no
2637 longer live, then whatever window is selected at the end of BODY
2640 This macro uses `save-current-buffer' to save and restore the
2641 current buffer, since otherwise its normal operation could
2642 potentially make a different buffer current. It does not alter
2643 the buffer list ordering."
2644 (declare (indent 1) (debug t))
2645 ;; Most of this code is a copy of save-selected-window.
2646 `(let ((save-selected-window-window (selected-window))
2647 ;; It is necessary to save all of these, because calling
2648 ;; select-window changes frame-selected-window for whatever
2649 ;; frame that window is in.
2650 (save-selected-window-alist
2651 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2653 (save-current-buffer
2655 (progn (select-window ,window 'norecord)
2657 (dolist (elt save-selected-window-alist)
2658 (and (frame-live-p (car elt))
2659 (window-live-p (cadr elt))
2660 (set-frame-selected-window (car elt) (cadr elt) 'norecord)))
2661 (when (window-live-p save-selected-window-window)
2662 (select-window save-selected-window-window 'norecord))))))
2664 (defmacro with-selected-frame (frame &rest body)
2665 "Execute the forms in BODY with FRAME as the selected frame.
2666 The value returned is the value of the last form in BODY.
2668 This macro neither changes the order of recently selected windows
2669 nor the buffer list."
2670 (declare (indent 1) (debug t))
2671 (let ((old-frame (make-symbol "old-frame"))
2672 (old-buffer (make-symbol "old-buffer")))
2673 `(let ((,old-frame (selected-frame))
2674 (,old-buffer (current-buffer)))
2676 (progn (select-frame ,frame 'norecord)
2678 (when (frame-live-p ,old-frame)
2679 (select-frame ,old-frame 'norecord))
2680 (when (buffer-live-p ,old-buffer)
2681 (set-buffer ,old-buffer))))))
2683 (defmacro with-temp-file (file &rest body)
2684 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2685 The value returned is the value of the last form in BODY.
2686 See also `with-temp-buffer'."
2687 (declare (indent 1) (debug t))
2688 (let ((temp-file (make-symbol "temp-file"))
2689 (temp-buffer (make-symbol "temp-buffer")))
2690 `(let ((,temp-file ,file)
2692 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2695 (with-current-buffer ,temp-buffer
2697 (with-current-buffer ,temp-buffer
2698 (write-region nil nil ,temp-file nil 0)))
2699 (and (buffer-name ,temp-buffer)
2700 (kill-buffer ,temp-buffer))))))
2702 (defmacro with-temp-message (message &rest body)
2703 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2704 The original message is restored to the echo area after BODY has finished.
2705 The value returned is the value of the last form in BODY.
2706 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2707 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2708 Use a MESSAGE of \"\" to temporarily clear the echo area."
2709 (declare (debug t) (indent 1))
2710 (let ((current-message (make-symbol "current-message"))
2711 (temp-message (make-symbol "with-temp-message")))
2712 `(let ((,temp-message ,message)
2717 (setq ,current-message (current-message))
2718 (message "%s" ,temp-message))
2721 (if ,current-message
2722 (message "%s" ,current-message)
2725 (defmacro with-temp-buffer (&rest body)
2726 "Create a temporary buffer, and evaluate BODY there like `progn'.
2727 See also `with-temp-file' and `with-output-to-string'."
2728 (declare (indent 0) (debug t))
2729 (let ((temp-buffer (make-symbol "temp-buffer")))
2730 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2731 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
2732 (with-current-buffer ,temp-buffer
2735 (and (buffer-name ,temp-buffer)
2736 (kill-buffer ,temp-buffer)))))))
2738 (defmacro with-silent-modifications (&rest body)
2739 "Execute BODY, pretending it does not modify the buffer.
2740 If BODY performs real modifications to the buffer's text, other
2741 than cosmetic ones, undo data may become corrupted.
2742 Typically used around modifications of text-properties which do not really
2743 affect the buffer's content."
2744 (declare (debug t) (indent 0))
2745 (let ((modified (make-symbol "modified")))
2746 `(let* ((,modified (buffer-modified-p))
2747 (buffer-undo-list t)
2748 (inhibit-read-only t)
2749 (inhibit-modification-hooks t)
2751 ;; Avoid setting and removing file locks and checking
2752 ;; buffer's uptodate-ness w.r.t the underlying file.
2754 buffer-file-truename)
2759 (restore-buffer-modified-p nil))))))
2761 (defmacro with-output-to-string (&rest body)
2762 "Execute BODY, return the text it sent to `standard-output', as a string."
2763 (declare (indent 0) (debug t))
2764 `(let ((standard-output
2765 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2768 (let ((standard-output standard-output))
2770 (with-current-buffer standard-output
2772 (kill-buffer standard-output))))
2774 (defmacro with-local-quit (&rest body)
2775 "Execute BODY, allowing quits to terminate BODY but not escape further.
2776 When a quit terminates BODY, `with-local-quit' returns nil but
2777 requests another quit. That quit will be processed as soon as quitting
2778 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2779 (declare (debug t) (indent 0))
2780 `(condition-case nil
2781 (let ((inhibit-quit nil))
2783 (quit (setq quit-flag t)
2784 ;; This call is to give a chance to handle quit-flag
2785 ;; in case inhibit-quit is nil.
2786 ;; Without this, it will not be handled until the next function
2787 ;; call, and that might allow it to exit thru a condition-case
2788 ;; that intends to handle the quit signal next time.
2789 (eval '(ignore nil)))))
2791 (defmacro while-no-input (&rest body)
2792 "Execute BODY only as long as there's no pending input.
2793 If input arrives, that ends the execution of BODY,
2794 and `while-no-input' returns t. Quitting makes it return nil.
2795 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2796 (declare (debug t) (indent 0))
2797 (let ((catch-sym (make-symbol "input")))
2800 (let ((throw-on-input ',catch-sym))
2801 (or (input-pending-p)
2802 (progn ,@body)))))))
2804 (defmacro condition-case-no-debug (var bodyform &rest handlers)
2805 "Like `condition-case' except that it does not catch anything when debugging.
2806 More specifically if `debug-on-error' is set, then it does not catch any signal."
2807 (declare (debug condition-case) (indent 2))
2808 (let ((bodysym (make-symbol "body")))
2809 `(let ((,bodysym (lambda () ,bodyform)))
2812 (condition-case ,var
2816 (defmacro with-demoted-errors (&rest body)
2817 "Run BODY and demote any errors to simple messages.
2818 If `debug-on-error' is non-nil, run BODY without catching its errors.
2819 This is to be used around code which is not expected to signal an error
2820 but which should be robust in the unexpected case that an error is signaled."
2821 (declare (debug t) (indent 0))
2822 (let ((err (make-symbol "err")))
2823 `(condition-case-no-debug ,err
2825 (error (message "Error: %S" ,err) nil))))
2827 (defmacro combine-after-change-calls (&rest body)
2828 "Execute BODY, but don't call the after-change functions till the end.
2829 If BODY makes changes in the buffer, they are recorded
2830 and the functions on `after-change-functions' are called several times
2831 when BODY is finished.
2832 The return value is the value of the last form in BODY.
2834 If `before-change-functions' is non-nil, then calls to the after-change
2835 functions can't be deferred, so in that case this macro has no effect.
2837 Do not alter `after-change-functions' or `before-change-functions'
2839 (declare (indent 0) (debug t))
2841 (let ((combine-after-change-calls t))
2843 (combine-after-change-execute)))
2845 (defmacro with-case-table (table &rest body)
2846 "Execute the forms in BODY with TABLE as the current case table.
2847 The value returned is the value of the last form in BODY."
2848 (declare (indent 1) (debug t))
2849 (let ((old-case-table (make-symbol "table"))
2850 (old-buffer (make-symbol "buffer")))
2851 `(let ((,old-case-table (current-case-table))
2852 (,old-buffer (current-buffer)))
2854 (progn (set-case-table ,table)
2856 (with-current-buffer ,old-buffer
2857 (set-case-table ,old-case-table))))))
2859 ;;; Matching and match data.
2861 (defvar save-match-data-internal)
2863 ;; We use save-match-data-internal as the local variable because
2864 ;; that works ok in practice (people should not use that variable elsewhere).
2865 ;; We used to use an uninterned symbol; the compiler handles that properly
2866 ;; now, but it generates slower code.
2867 (defmacro save-match-data (&rest body)
2868 "Execute the BODY forms, restoring the global value of the match data.
2869 The value returned is the value of the last form in BODY."
2870 ;; It is better not to use backquote here,
2871 ;; because that makes a bootstrapping problem
2872 ;; if you need to recompile all the Lisp files using interpreted code.
2873 (declare (indent 0) (debug t))
2875 '((save-match-data-internal (match-data)))
2876 (list 'unwind-protect
2878 ;; It is safe to free (evaporate) markers immediately here,
2879 ;; as Lisp programs should not copy from save-match-data-internal.
2880 '(set-match-data save-match-data-internal 'evaporate))))
2882 (defun match-string (num &optional string)
2883 "Return string of text matched by last search.
2884 NUM specifies which parenthesized expression in the last regexp.
2885 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2886 Zero means the entire text matched by the whole regexp or whole string.
2887 STRING should be given if the last search was by `string-match' on STRING."
2888 (if (match-beginning num)
2890 (substring string (match-beginning num) (match-end num))
2891 (buffer-substring (match-beginning num) (match-end num)))))
2893 (defun match-string-no-properties (num &optional string)
2894 "Return string of text matched by last search, without text properties.
2895 NUM specifies which parenthesized expression in the last regexp.
2896 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2897 Zero means the entire text matched by the whole regexp or whole string.
2898 STRING should be given if the last search was by `string-match' on STRING."
2899 (if (match-beginning num)
2901 (substring-no-properties string (match-beginning num)
2903 (buffer-substring-no-properties (match-beginning num)
2907 (defun match-substitute-replacement (replacement
2908 &optional fixedcase literal string subexp)
2909 "Return REPLACEMENT as it will be inserted by `replace-match'.
2910 In other words, all back-references in the form `\\&' and `\\N'
2911 are substituted with actual strings matched by the last search.
2912 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
2913 meaning as for `replace-match'."
2914 (let ((match (match-string 0 string)))
2916 (set-match-data (mapcar (lambda (x)
2918 (- x (match-beginning 0))
2921 (replace-match replacement fixedcase literal match subexp))))
2924 (defun looking-back (regexp &optional limit greedy)
2925 "Return non-nil if text before point matches regular expression REGEXP.
2926 Like `looking-at' except matches before point, and is slower.
2927 LIMIT if non-nil speeds up the search by specifying a minimum
2928 starting position, to avoid checking matches that would start
2931 If GREEDY is non-nil, extend the match backwards as far as
2932 possible, stopping when a single additional previous character
2933 cannot be part of a match for REGEXP. When the match is
2934 extended, its starting position is allowed to occur before
2936 (let ((start (point))
2939 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2941 (if (and greedy pos)
2943 (narrow-to-region (point-min) start)
2944 (while (and (> pos (point-min))
2948 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2949 (setq pos (1- pos)))
2952 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2955 (defsubst looking-at-p (regexp)
2957 Same as `looking-at' except this function does not change the match data."
2958 (let ((inhibit-changing-match-data t))
2959 (looking-at regexp)))
2961 (defsubst string-match-p (regexp string &optional start)
2963 Same as `string-match' except this function does not change the match data."
2964 (let ((inhibit-changing-match-data t))
2965 (string-match regexp string start)))
2967 (defun subregexp-context-p (regexp pos &optional start)
2968 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2969 A subregexp context is one where a sub-regexp can appear.
2970 A non-subregexp context is for example within brackets, or within a
2971 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2972 If START is non-nil, it should be a position in REGEXP, smaller
2973 than POS, and known to be in a subregexp context."
2974 ;; Here's one possible implementation, with the great benefit that it
2975 ;; reuses the regexp-matcher's own parser, so it understands all the
2976 ;; details of the syntax. A disadvantage is that it needs to match the
2980 (string-match (substring regexp (or start 0) pos) "")
2983 (not (member (cadr err) '("Unmatched [ or [^"
2985 "Trailing backslash")))))
2986 ;; An alternative implementation:
2987 ;; (defconst re-context-re
2988 ;; (let* ((harmless-ch "[^\\[]")
2989 ;; (harmless-esc "\\\\[^{]")
2990 ;; (class-harmless-ch "[^][]")
2991 ;; (class-lb-harmless "[^]:]")
2992 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2993 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2994 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2996 ;; (concat "\\[^?]?"
2997 ;; "\\(" class-harmless-ch
2998 ;; "\\|" class-lb "\\)*"
2999 ;; "\\[?]")) ; special handling for bare [ at end of re
3000 ;; (braces "\\\\{[0-9,]+\\\\}"))
3001 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3002 ;; "\\|" class "\\|" braces "\\)*\\'"))
3003 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3004 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3009 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3010 "The default value of separators for `split-string'.
3012 A regexp matching strings of whitespace. May be locale-dependent
3013 \(as yet unimplemented). Should not match non-breaking spaces.
3015 Warning: binding this to a different value and using it as default is
3016 likely to have undesired semantics.")
3018 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3019 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3020 ;; expression leads to the equivalent implementation that if SEPARATORS
3021 ;; is defaulted, OMIT-NULLS is treated as t.
3022 (defun split-string (string &optional separators omit-nulls)
3023 "Split STRING into substrings bounded by matches for SEPARATORS.
3025 The beginning and end of STRING, and each match for SEPARATORS, are
3026 splitting points. The substrings matching SEPARATORS are removed, and
3027 the substrings between the splitting points are collected as a list,
3030 If SEPARATORS is non-nil, it should be a regular expression matching text
3031 which separates, but is not part of, the substrings. If nil it defaults to
3032 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3033 OMIT-NULLS is forced to t.
3035 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3036 that for the default value of SEPARATORS leading and trailing whitespace
3037 are effectively trimmed). If nil, all zero-length substrings are retained,
3038 which correctly parses CSV format, for example.
3040 Note that the effect of `(split-string STRING)' is the same as
3041 `(split-string STRING split-string-default-separators t)'. In the rare
3042 case that you wish to retain zero-length substrings when splitting on
3043 whitespace, use `(split-string STRING split-string-default-separators)'.
3045 Modifies the match data; use `save-match-data' if necessary."
3046 (let ((keep-nulls (not (if separators omit-nulls t)))
3047 (rexp (or separators split-string-default-separators))
3051 (while (and (string-match rexp string
3053 (= start (match-beginning 0))
3054 (< start (length string)))
3056 (< start (length string)))
3058 (if (or keep-nulls (< start (match-beginning 0)))
3060 (cons (substring string start (match-beginning 0))
3062 (setq start (match-end 0)))
3063 (if (or keep-nulls (< start (length string)))
3065 (cons (substring string start)
3069 (defun combine-and-quote-strings (strings &optional separator)
3070 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3071 This tries to quote the strings to avoid ambiguity such that
3072 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3073 Only some SEPARATORs will work properly."
3074 (let* ((sep (or separator " "))
3075 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3078 (if (string-match re str)
3079 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3083 (defun split-string-and-unquote (string &optional separator)
3084 "Split the STRING into a list of strings.
3085 It understands Emacs Lisp quoting within STRING, such that
3086 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3087 The SEPARATOR regexp defaults to \"\\s-+\"."
3088 (let ((sep (or separator "\\s-+"))
3089 (i (string-match "\"" string)))
3091 (split-string string sep t) ; no quoting: easy
3092 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3093 (let ((rfs (read-from-string string i)))
3095 (split-string-and-unquote (substring string (cdr rfs))
3099 ;;;; Replacement in strings.
3101 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3102 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3103 Unless optional argument INPLACE is non-nil, return a new string."
3104 (let ((i (length string))
3105 (newstr (if inplace string (copy-sequence string))))
3108 (if (eq (aref newstr i) fromchar)
3109 (aset newstr i tochar)))
3112 (defun replace-regexp-in-string (regexp rep string &optional
3113 fixedcase literal subexp start)
3114 "Replace all matches for REGEXP with REP in STRING.
3116 Return a new string containing the replacements.
3118 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3119 arguments with the same names of function `replace-match'. If START
3120 is non-nil, start replacements at that index in STRING.
3122 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3123 function. If it is a function, it is called with the actual text of each
3124 match, and its value is used as the replacement text. When REP is called,
3125 the match-data are the result of matching REGEXP against a substring
3128 To replace only the first match (if any), make REGEXP match up to \\'
3129 and replace a sub-expression, e.g.
3130 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3134 ;; To avoid excessive consing from multiple matches in long strings,
3135 ;; don't just call `replace-match' continually. Walk down the
3136 ;; string looking for matches of REGEXP and building up a (reversed)
3137 ;; list MATCHES. This comprises segments of STRING which weren't
3138 ;; matched interspersed with replacements for segments that were.
3139 ;; [For a `large' number of replacements it's more efficient to
3140 ;; operate in a temporary buffer; we can't tell from the function's
3141 ;; args whether to choose the buffer-based implementation, though it
3142 ;; might be reasonable to do so for long enough STRING.]
3143 (let ((l (length string))
3144 (start (or start 0))
3147 (while (and (< start l) (string-match regexp string start))
3148 (setq mb (match-beginning 0)
3150 ;; If we matched the empty string, make sure we advance by one char
3151 (when (= me mb) (setq me (min l (1+ mb))))
3152 ;; Generate a replacement for the matched substring.
3153 ;; Operate only on the substring to minimize string consing.
3154 ;; Set up match data for the substring for replacement;
3155 ;; presumably this is likely to be faster than munging the
3156 ;; match data directly in Lisp.
3157 (string-match regexp (setq str (substring string mb me)))
3159 (cons (replace-match (if (stringp rep)
3161 (funcall rep (match-string 0 str)))
3162 fixedcase literal str subexp)
3163 (cons (substring string start mb) ; unmatched prefix
3166 ;; Reconstruct a string from the pieces.
3167 (setq matches (cons (substring string start l) matches)) ; leftover
3168 (apply #'concat (nreverse matches)))))
3170 (defun string-prefix-p (str1 str2 &optional ignore-case)
3171 "Return non-nil if STR1 is a prefix of STR2.
3172 If IGNORE-CASE is non-nil, the comparison is done without paying attention
3173 to case differences."
3174 (eq t (compare-strings str1 nil nil
3175 str2 0 (length str1) ignore-case)))
3177 ;;;; invisibility specs
3179 (defun add-to-invisibility-spec (element)
3180 "Add ELEMENT to `buffer-invisibility-spec'.
3181 See documentation for `buffer-invisibility-spec' for the kind of elements
3183 (if (eq buffer-invisibility-spec t)
3184 (setq buffer-invisibility-spec (list t)))
3185 (setq buffer-invisibility-spec
3186 (cons element buffer-invisibility-spec)))
3188 (defun remove-from-invisibility-spec (element)
3189 "Remove ELEMENT from `buffer-invisibility-spec'."
3190 (if (consp buffer-invisibility-spec)
3191 (setq buffer-invisibility-spec
3192 (delete element buffer-invisibility-spec))))
3196 (defmacro with-syntax-table (table &rest body)
3197 "Evaluate BODY with syntax table of current buffer set to TABLE.
3198 The syntax table of the current buffer is saved, BODY is evaluated, and the
3199 saved table is restored, even in case of an abnormal exit.
3200 Value is what BODY returns."
3201 (declare (debug t) (indent 1))
3202 (let ((old-table (make-symbol "table"))
3203 (old-buffer (make-symbol "buffer")))
3204 `(let ((,old-table (syntax-table))
3205 (,old-buffer (current-buffer)))
3208 (set-syntax-table ,table)
3210 (save-current-buffer
3211 (set-buffer ,old-buffer)
3212 (set-syntax-table ,old-table))))))
3214 (defun make-syntax-table (&optional oldtable)
3215 "Return a new syntax table.
3216 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3217 from `standard-syntax-table' otherwise."
3218 (let ((table (make-char-table 'syntax-table nil)))
3219 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3222 (defun syntax-after (pos)
3223 "Return the raw syntax of the char after POS.
3224 If POS is outside the buffer's accessible portion, return nil."
3225 (unless (or (< pos (point-min)) (>= pos (point-max)))
3226 (let ((st (if parse-sexp-lookup-properties
3227 (get-char-property pos 'syntax-table))))
3229 (aref (or st (syntax-table)) (char-after pos))))))
3231 (defun syntax-class (syntax)
3232 "Return the syntax class part of the syntax descriptor SYNTAX.
3233 If SYNTAX is nil, return nil."
3234 (and syntax (logand (car syntax) 65535)))
3238 (defun text-clone-maintain (ol1 after beg end &optional len)
3239 "Propagate the changes made under the overlay OL1 to the other clones.
3240 This is used on the `modification-hooks' property of text clones."
3241 (when (and after (not undo-in-progress) (overlay-start ol1))
3242 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3243 (setq beg (max beg (+ (overlay-start ol1) margin)))
3244 (setq end (min end (- (overlay-end ol1) margin)))
3247 (when (overlay-get ol1 'text-clone-syntax)
3248 ;; Check content of the clone's text.
3249 (let ((cbeg (+ (overlay-start ol1) margin))
3250 (cend (- (overlay-end ol1) margin)))
3253 (if (not (re-search-forward
3254 (overlay-get ol1 'text-clone-syntax) cend t))
3255 ;; Mark the overlay for deletion.
3256 (overlay-put ol1 'text-clones nil)
3257 (when (< (match-end 0) cend)
3258 ;; Shrink the clone at its end.
3259 (setq end (min end (match-end 0)))
3260 (move-overlay ol1 (overlay-start ol1)
3261 (+ (match-end 0) margin)))
3262 (when (> (match-beginning 0) cbeg)
3263 ;; Shrink the clone at its beginning.
3264 (setq beg (max (match-beginning 0) beg))
3265 (move-overlay ol1 (- (match-beginning 0) margin)
3266 (overlay-end ol1)))))))
3267 ;; Now go ahead and update the clones.
3268 (let ((head (- beg (overlay-start ol1)))
3269 (tail (- (overlay-end ol1) end))
3270 (str (buffer-substring beg end))
3272 (inhibit-modification-hooks t))
3273 (dolist (ol2 (overlay-get ol1 'text-clones))
3274 (let ((oe (overlay-end ol2)))
3275 (unless (or (eq ol1 ol2) (null oe))
3276 (setq nothing-left nil)
3277 (let ((mod-beg (+ (overlay-start ol2) head)))
3278 ;;(overlay-put ol2 'modification-hooks nil)
3279 (goto-char (- (overlay-end ol2) tail))
3280 (unless (> mod-beg (point))
3281 (save-excursion (insert str))
3282 (delete-region mod-beg (point)))
3283 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3285 (if nothing-left (delete-overlay ol1))))))))
3287 (defun text-clone-create (start end &optional spreadp syntax)
3288 "Create a text clone of START...END at point.
3289 Text clones are chunks of text that are automatically kept identical:
3290 changes done to one of the clones will be immediately propagated to the other.
3292 The buffer's content at point is assumed to be already identical to
3293 the one between START and END.
3294 If SYNTAX is provided it's a regexp that describes the possible text of
3295 the clones; the clone will be shrunk or killed if necessary to ensure that
3296 its text matches the regexp.
3297 If SPREADP is non-nil it indicates that text inserted before/after the
3298 clone should be incorporated in the clone."
3299 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3300 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3301 ;; (with a one-char margin at each end) with `t nil'.
3302 ;; We opted for a larger overlay because it behaves better in the case
3303 ;; where the clone is reduced to the empty string (we want the overlay to
3304 ;; stay when the clone's content is the empty string and we want to use
3305 ;; `evaporate' to make sure those overlays get deleted when needed).
3307 (let* ((pt-end (+ (point) (- end start)))
3308 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3310 (end-margin (if (or (not spreadp)
3311 (>= pt-end (point-max))
3312 (>= start (point-max)))
3314 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3315 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3316 (dups (list ol1 ol2)))
3317 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3318 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3319 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3320 ;;(overlay-put ol1 'face 'underline)
3321 (overlay-put ol1 'evaporate t)
3322 (overlay-put ol1 'text-clones dups)
3324 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3325 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3326 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3327 ;;(overlay-put ol2 'face 'underline)
3328 (overlay-put ol2 'evaporate t)
3329 (overlay-put ol2 'text-clones dups)))
3331 ;;;; Misc functions moved over from the C side.
3333 (defun y-or-n-p (prompt)
3334 "Ask user a \"y or n\" question. Return t if answer is \"y\".
3335 The argument PROMPT is the string to display to ask the question.
3336 It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
3337 No confirmation of the answer is requested; a single character is enough.
3338 Also accepts Space to mean yes, or Delete to mean no. \(Actually, it uses
3339 the bindings in `query-replace-map'; see the documentation of that variable
3340 for more information. In this case, the useful bindings are `act', `skip',
3341 `recenter', and `quit'.\)
3343 Under a windowing system a dialog box will be used if `last-nonmenu-event'
3344 is nil and `use-dialog-box' is non-nil."
3345 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
3346 ;; where all the keys were unbound (i.e. it somehow got triggered
3347 ;; within read-key, apparently). I had to kill it.
3348 (let ((answer 'recenter))
3349 (if (and (display-popup-menus-p)
3350 (listp last-nonmenu-event)
3353 (x-popup-dialog t `(,prompt ("yes" . act) ("No" . skip))))
3354 (setq prompt (concat prompt
3355 (if (eq ?\s (aref prompt (1- (length prompt))))
3360 (let ((cursor-in-echo-area t))
3361 (when minibuffer-auto-raise
3362 (raise-frame (window-frame (minibuffer-window))))
3363 (read-key (propertize (if (eq answer 'recenter)
3365 (concat "Please answer y or n. "
3367 'face 'minibuffer-prompt)))))
3368 (setq answer (lookup-key query-replace-map (vector key) t))
3370 ((memq answer '(skip act)) nil)
3371 ((eq answer 'recenter) (recenter) t)
3372 ((memq answer '(exit-prefix quit)) (signal 'quit nil) t)
3376 (let ((ret (eq answer 'act)))
3377 (unless noninteractive
3378 (message "%s %s" prompt (if ret "y" "n")))
3381 ;;;; Mail user agents.
3383 ;; Here we include just enough for other packages to be able
3386 (defun define-mail-user-agent (symbol composefunc sendfunc
3387 &optional abortfunc hookvar)
3388 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3390 SYMBOL can be any Lisp symbol. Its function definition and/or
3391 value as a variable do not matter for this usage; we use only certain
3392 properties on its property list, to encode the rest of the arguments.
3394 COMPOSEFUNC is program callable function that composes an outgoing
3395 mail message buffer. This function should set up the basics of the
3396 buffer without requiring user interaction. It should populate the
3397 standard mail headers, leaving the `to:' and `subject:' headers blank
3400 COMPOSEFUNC should accept several optional arguments--the same
3401 arguments that `compose-mail' takes. See that function's documentation.
3403 SENDFUNC is the command a user would run to send the message.
3405 Optional ABORTFUNC is the command a user would run to abort the
3406 message. For mail packages that don't have a separate abort function,
3407 this can be `kill-buffer' (the equivalent of omitting this argument).
3409 Optional HOOKVAR is a hook variable that gets run before the message
3410 is actually sent. Callers that use the `mail-user-agent' may
3411 install a hook function temporarily on this hook variable.
3412 If HOOKVAR is nil, `mail-send-hook' is used.
3414 The properties used on SYMBOL are `composefunc', `sendfunc',
3415 `abortfunc', and `hookvar'."
3416 (put symbol 'composefunc composefunc)
3417 (put symbol 'sendfunc sendfunc)
3418 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3419 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3421 ;;;; Progress reporters.
3423 ;; Progress reporter has the following structure:
3425 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3432 ;; This weirdeness is for optimization reasons: we want
3433 ;; `progress-reporter-update' to be as fast as possible, so
3434 ;; `(car reporter)' is better than `(aref reporter 0)'.
3436 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3437 ;; digits of precision, it doesn't really matter here. On the other
3438 ;; hand, it greatly simplifies the code.
3440 (defsubst progress-reporter-update (reporter &optional value)
3441 "Report progress of an operation in the echo area.
3442 REPORTER should be the result of a call to `make-progress-reporter'.
3444 If REPORTER is a numerical progress reporter---i.e. if it was
3445 made using non-nil MIN-VALUE and MAX-VALUE arguments to
3446 `make-progress-reporter'---then VALUE should be a number between
3447 MIN-VALUE and MAX-VALUE.
3449 If REPORTER is a non-numerical reporter, VALUE should be nil.
3451 This function is relatively inexpensive. If the change since
3452 last update is too small or insufficient time has passed, it does
3454 (when (or (not (numberp value)) ; For pulsing reporter
3455 (>= value (car reporter))) ; For numerical reporter
3456 (progress-reporter-do-update reporter value)))
3458 (defun make-progress-reporter (message &optional min-value max-value
3459 current-value min-change min-time)
3460 "Return progress reporter object for use with `progress-reporter-update'.
3462 MESSAGE is shown in the echo area, with a status indicator
3463 appended to the end. When you call `progress-reporter-done', the
3464 word \"done\" is printed after the MESSAGE. You can change the
3465 MESSAGE of an existing progress reporter by calling
3466 `progress-reporter-force-update'.
3468 MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
3469 and final (100% complete) states of operation; the latter should
3470 be larger. In this case, the status message shows the percentage
3473 If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
3474 message shows a \"spinning\", non-numeric indicator.
3476 Optional CURRENT-VALUE is the initial progress; the default is
3478 Optional MIN-CHANGE is the minimal change in percents to report;
3480 CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
3481 and/or MAX-VALUE are nil.
3483 Optional MIN-TIME specifies the minimum interval time between
3484 echo area updates (default is 0.2 seconds.) If the function
3485 `float-time' is not present, time is not tracked at all. If the
3486 OS is not capable of measuring fractions of seconds, this
3487 parameter is effectively rounded up."
3489 (setq min-time 0.2))
3491 ;; Force a call to `message' now
3492 (cons (or min-value 0)
3493 (vector (if (and (fboundp 'float-time)
3499 (if min-change (max (min min-change 50) 1) 1)
3501 (progress-reporter-update reporter (or current-value min-value))
3504 (defun progress-reporter-force-update (reporter &optional value new-message)
3505 "Report progress of an operation in the echo area unconditionally.
3507 The first two arguments are the same as in `progress-reporter-update'.
3508 NEW-MESSAGE, if non-nil, sets a new message for the reporter."
3509 (let ((parameters (cdr reporter)))
3511 (aset parameters 3 new-message))
3512 (when (aref parameters 0)
3513 (aset parameters 0 (float-time)))
3514 (progress-reporter-do-update reporter value)))
3516 (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
3517 "Characters to use for pulsing progress reporters.")
3519 (defun progress-reporter-do-update (reporter value)
3520 (let* ((parameters (cdr reporter))
3521 (update-time (aref parameters 0))
3522 (min-value (aref parameters 1))
3523 (max-value (aref parameters 2))
3524 (text (aref parameters 3))
3525 (current-time (float-time))
3527 ;; See if enough time has passed since the last update.
3528 (or (not update-time)
3529 (when (>= current-time update-time)
3530 ;; Calculate time for the next update
3531 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3532 (cond ((and min-value max-value)
3533 ;; Numerical indicator
3534 (let* ((one-percent (/ (- max-value min-value) 100.0))
3535 (percentage (if (= max-value min-value)
3537 (truncate (/ (- value min-value)
3539 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
3540 ;; message because not enough time has passed, use 1
3541 ;; instead of MIN-CHANGE. This makes delays between echo
3542 ;; area updates closer to MIN-TIME.
3544 (min (+ min-value (* (+ percentage
3545 (if enough-time-passed
3551 (when (integerp value)
3552 (setcar reporter (ceiling (car reporter))))
3553 ;; Only print message if enough time has passed
3554 (when enough-time-passed
3555 (if (> percentage 0)
3556 (message "%s%d%%" text percentage)
3557 (message "%s" text)))))
3558 ;; Pulsing indicator
3560 (let ((index (mod (1+ (car reporter)) 4))
3561 (message-log-max nil))
3562 (setcar reporter index)
3565 (aref progress-reporter--pulse-characters
3568 (defun progress-reporter-done (reporter)
3569 "Print reporter's message followed by word \"done\" in echo area."
3570 (message "%sdone" (aref (cdr reporter) 3)))
3572 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3573 "Loop a certain number of times and report progress in the echo area.
3574 Evaluate BODY with VAR bound to successive integers running from
3575 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3576 the return value (nil if RESULT is omitted).
3578 At each iteration MESSAGE followed by progress percentage is
3579 printed in the echo area. After the loop is finished, MESSAGE
3580 followed by word \"done\" is printed. This macro is a
3581 convenience wrapper around `make-progress-reporter' and friends.
3583 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3584 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3585 (let ((temp (make-symbol "--dotimes-temp--"))
3586 (temp2 (make-symbol "--dotimes-temp2--"))
3590 (,(car spec) ,start)
3591 (,temp2 (make-progress-reporter ,message ,start ,end)))
3592 (while (< ,(car spec) ,temp)
3594 (progress-reporter-update ,temp2
3595 (setq ,(car spec) (1+ ,(car spec)))))
3596 (progress-reporter-done ,temp2)
3597 nil ,@(cdr (cdr spec)))))
3600 ;;;; Comparing version strings.
3602 (defconst version-separator "."
3603 "Specify the string used to separate the version elements.
3605 Usually the separator is \".\", but it can be any other string.")
3608 (defconst version-regexp-alist
3609 '(("^[-_+ ]?alpha$" . -3)
3610 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3611 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3612 ("^[-_+ ]?beta$" . -2)
3613 ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1))
3614 "Specify association between non-numeric version and its priority.
3616 This association is used to handle version string like \"1.0pre2\",
3617 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3618 non-numeric part of a version string to an integer. For example:
3620 String Version Integer List Version
3621 \"1.0pre2\" (1 0 -1 2)
3622 \"1.0PRE2\" (1 0 -1 2)
3623 \"22.8beta3\" (22 8 -2 3)
3624 \"22.8 Beta3\" (22 8 -2 3)
3625 \"0.9alpha1\" (0 9 -3 1)
3626 \"0.9AlphA1\" (0 9 -3 1)
3627 \"0.9 alpha\" (0 9 -3)
3629 Each element has the following form:
3635 REGEXP regexp used to match non-numeric part of a version string.
3636 It should begin with the `^' anchor and end with a `$' to
3637 prevent false hits. Letter-case is ignored while matching
3640 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
3643 (defun version-to-list (ver)
3644 "Convert version string VER into a list of integers.
3646 The version syntax is given by the following EBNF:
3648 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3650 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3652 SEPARATOR ::= `version-separator' (which see)
3653 | `version-regexp-alist' (which see).
3655 The NUMBER part is optional if SEPARATOR is a match for an element
3656 in `version-regexp-alist'.
3658 Examples of valid version syntax:
3660 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3662 Examples of invalid version syntax:
3664 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3666 Examples of version conversion:
3668 Version String Version as a List of Integers
3669 \"1.0.7.5\" (1 0 7 5)
3670 \"1.0pre2\" (1 0 -1 2)
3671 \"1.0PRE2\" (1 0 -1 2)
3672 \"22.8beta3\" (22 8 -2 3)
3673 \"22.8Beta3\" (22 8 -2 3)
3674 \"0.9alpha1\" (0 9 -3 1)
3675 \"0.9AlphA1\" (0 9 -3 1)
3676 \"0.9alpha\" (0 9 -3)
3678 See documentation for `version-separator' and `version-regexp-alist'."
3679 (or (and (stringp ver) (> (length ver) 0))
3680 (error "Invalid version string: '%s'" ver))
3681 ;; Change .x.y to 0.x.y
3682 (if (and (>= (length ver) (length version-separator))
3683 (string-equal (substring ver 0 (length version-separator))
3685 (setq ver (concat "0" ver)))
3688 (case-fold-search t) ; ignore case in matching
3690 (while (and (setq s (string-match "[0-9]+" ver i))
3692 ;; handle numeric part
3693 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3696 ;; handle non-numeric part
3697 (when (and (setq s (string-match "[^0-9]+" ver i))
3699 (setq s (substring ver i (match-end 0))
3701 ;; handle alpha, beta, pre, etc. separator
3702 (unless (string= s version-separator)
3703 (setq al version-regexp-alist)
3704 (while (and al (not (string-match (caar al) s)))
3707 (push (cdar al) lst))
3708 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
3709 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
3710 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
3712 (t (error "Invalid version syntax: '%s'" ver))))))
3714 (error "Invalid version syntax: '%s'" ver)
3718 (defun version-list-< (l1 l2)
3719 "Return t if L1, a list specification of a version, is lower than L2.
3721 Note that a version specified by the list (1) is equal to (1 0),
3722 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
3723 Also, a version given by the list (1) is higher than (1 -1), which in
3724 turn is higher than (1 -2), which is higher than (1 -3)."
3725 (while (and l1 l2 (= (car l1) (car l2)))
3729 ;; l1 not null and l2 not null
3730 ((and l1 l2) (< (car l1) (car l2)))
3731 ;; l1 null and l2 null ==> l1 length = l2 length
3732 ((and (null l1) (null l2)) nil)
3733 ;; l1 not null and l2 null ==> l1 length > l2 length
3734 (l1 (< (version-list-not-zero l1) 0))
3735 ;; l1 null and l2 not null ==> l2 length > l1 length
3736 (t (< 0 (version-list-not-zero l2)))))
3739 (defun version-list-= (l1 l2)
3740 "Return t if L1, a list specification of a version, is equal to L2.
3742 Note that a version specified by the list (1) is equal to (1 0),
3743 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
3744 Also, a version given by the list (1) is higher than (1 -1), which in
3745 turn is higher than (1 -2), which is higher than (1 -3)."
3746 (while (and l1 l2 (= (car l1) (car l2)))
3750 ;; l1 not null and l2 not null
3752 ;; l1 null and l2 null ==> l1 length = l2 length
3753 ((and (null l1) (null l2)))
3754 ;; l1 not null and l2 null ==> l1 length > l2 length
3755 (l1 (zerop (version-list-not-zero l1)))
3756 ;; l1 null and l2 not null ==> l2 length > l1 length
3757 (t (zerop (version-list-not-zero l2)))))
3760 (defun version-list-<= (l1 l2)
3761 "Return t if L1, a list specification of a version, is lower or equal to L2.
3763 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3764 etc. That is, the trailing zeroes are insignificant. Also, integer
3765 list (1) is greater than (1 -1) which is greater than (1 -2)
3766 which is greater than (1 -3)."
3767 (while (and l1 l2 (= (car l1) (car l2)))
3771 ;; l1 not null and l2 not null
3772 ((and l1 l2) (< (car l1) (car l2)))
3773 ;; l1 null and l2 null ==> l1 length = l2 length
3774 ((and (null l1) (null l2)))
3775 ;; l1 not null and l2 null ==> l1 length > l2 length
3776 (l1 (<= (version-list-not-zero l1) 0))
3777 ;; l1 null and l2 not null ==> l2 length > l1 length
3778 (t (<= 0 (version-list-not-zero l2)))))
3780 (defun version-list-not-zero (lst)
3781 "Return the first non-zero element of LST, which is a list of integers.
3783 If all LST elements are zeros or LST is nil, return zero."
3784 (while (and lst (zerop (car lst)))
3785 (setq lst (cdr lst)))
3788 ;; there is no element different of zero
3792 (defun version< (v1 v2)
3793 "Return t if version V1 is lower (older) than V2.
3795 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3796 etc. That is, the trailing \".0\"s are insignificant. Also, version
3797 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
3798 which is higher than \"1alpha\"."
3799 (version-list-< (version-to-list v1) (version-to-list v2)))
3802 (defun version<= (v1 v2)
3803 "Return t if version V1 is lower (older) than or equal to V2.
3805 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3806 etc. That is, the trailing \".0\"s are insignificant. Also, version
3807 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
3808 which is higher than \"1alpha\"."
3809 (version-list-<= (version-to-list v1) (version-to-list v2)))
3811 (defun version= (v1 v2)
3812 "Return t if version V1 is equal to V2.
3814 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3815 etc. That is, the trailing \".0\"s are insignificant. Also, version
3816 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
3817 which is higher than \"1alpha\"."
3818 (version-list-= (version-to-list v1) (version-to-list v2)))
3822 (defconst menu-bar-separator '("--")
3823 "Separator for menus.")
3825 ;; The following statement ought to be in print.c, but `provide' can't
3827 (when (hash-table-p (car (read-from-string
3828 (prin1-to-string (make-hash-table)))))
3829 (provide 'hashtable-print-readable))
3831 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3832 ;;; subr.el ends here