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 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 (defvar custom-declare-variable-list nil
29 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
30 Each element of this list holds the arguments to one call to `defcustom'.")
32 ;; Use this, rather than defcustom, in subr.el and other files loaded
34 (defun custom-declare-variable-early (&rest arguments
)
35 (setq custom-declare-variable-list
36 (cons arguments custom-declare-variable-list
)))
38 (defmacro declare-function
(fn file
&optional arglist fileonly
)
39 "Tell the byte-compiler that function FN is defined, in FILE.
40 Optional ARGLIST is the argument list used by the function. The
41 FILE argument is not used by the byte-compiler, but by the
42 `check-declare' package, which checks that FILE contains a
43 definition for FN. ARGLIST is used by both the byte-compiler and
44 `check-declare' to check for consistency.
46 FILE can be either a Lisp file (in which case the \".el\"
47 extension is optional), or a C file. C files are expanded
48 relative to the Emacs \"src/\" directory. Lisp files are
49 searched for using `locate-library', and if that fails they are
50 expanded relative to the location of the file containing the
51 declaration. A FILE with an \"ext:\" prefix is an external file.
52 `check-declare' will check such files if they are found, and skip
53 them without error if they are not.
55 FILEONLY non-nil means that `check-declare' will only check that
56 FILE exists, not that it defines FN. This is intended for
57 function-definitions that `check-declare' does not recognize, e.g.
60 To specify a value for FILEONLY without passing an argument list,
61 set ARGLIST to `t'. This is necessary because `nil' means an
62 empty argument list, rather than an unspecified one.
64 Note that for the purposes of `check-declare', this statement
65 must be the first non-whitespace on a line.
67 For more information, see Info node `(elisp)Declaring Functions'."
68 ;; Does nothing - byte-compile-declare-function does the work.
72 ;;;; Basic Lisp macros.
76 (defmacro noreturn
(form)
77 "Evaluate FORM, expecting it not to return.
78 If FORM does return, signal an error."
80 (error "Form marked with `noreturn' did return")))
82 (defmacro 1value
(form)
83 "Evaluate FORM, expecting a constant return value.
84 This is the global do-nothing version. There is also `testcover-1value'
85 that complains if FORM ever does return differing values."
88 (defmacro def-edebug-spec
(symbol spec
)
89 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
90 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
91 0 (instrument no arguments); t (instrument all arguments);
92 a symbol (naming a function with an Edebug specification); or a list.
93 The elements of the list describe the argument types; see
94 \(info \"(elisp)Specification List\") for details."
95 `(put (quote ,symbol
) 'edebug-form-spec
(quote ,spec
)))
97 (defmacro lambda
(&rest cdr
)
98 "Return a lambda expression.
99 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
100 self-quoting; the result of evaluating the lambda expression is the
101 expression itself. The lambda expression may then be treated as a
102 function, i.e., stored as the function value of a symbol, passed to
103 `funcall' or `mapcar', etc.
105 ARGS should take the same form as an argument list for a `defun'.
106 DOCSTRING is an optional documentation string.
107 If present, it should describe how to call the function.
108 But documentation strings are usually not useful in nameless functions.
109 INTERACTIVE should be a call to the function `interactive', which see.
110 It may also be omitted.
111 BODY should be a list of Lisp expressions.
113 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
114 ;; Note that this definition should not use backquotes; subr.el should not
115 ;; depend on backquote.el.
116 (list 'function
(cons 'lambda cdr
)))
118 (if (null (featurep 'cl
))
120 ;; If we reload subr.el after having loaded CL, be careful not to
121 ;; overwrite CL's extended definition of `dolist', `dotimes',
122 ;; `declare', `push' and `pop'.
123 (defmacro push
(newelt listname
)
124 "Add NEWELT to the list stored in the symbol LISTNAME.
125 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
126 LISTNAME must be a symbol."
127 (declare (debug (form sexp
)))
129 (list 'cons newelt listname
)))
131 (defmacro pop
(listname)
132 "Return the first element of LISTNAME's value, and remove it from the list.
133 LISTNAME must be a symbol whose value is a list.
134 If the value is nil, `pop' returns nil but does not actually
136 (declare (debug (sexp)))
138 (list 'prog1 listname
139 (list 'setq listname
(list 'cdr listname
)))))
142 (defmacro when
(cond &rest body
)
143 "If COND yields non-nil, do BODY, else return nil.
144 When COND yields non-nil, eval BODY forms sequentially and return
145 value of last one, or nil if there are none.
148 (declare (indent 1) (debug t
))
149 (list 'if cond
(cons 'progn body
)))
151 (defmacro unless
(cond &rest body
)
152 "If COND yields nil, do BODY, else return nil.
153 When COND yields nil, eval BODY forms sequentially and return
154 value of last one, or nil if there are none.
157 (declare (indent 1) (debug t
))
158 (cons 'if
(cons cond
(cons nil body
))))
160 (if (null (featurep 'cl
))
162 ;; If we reload subr.el after having loaded CL, be careful not to
163 ;; overwrite CL's extended definition of `dolist', `dotimes',
164 ;; `declare', `push' and `pop'.
165 (defvar --dolist-tail-- nil
166 "Temporary variable used in `dolist' expansion.")
168 (defmacro dolist
(spec &rest body
)
170 Evaluate BODY with VAR bound to each car from LIST, in turn.
171 Then evaluate RESULT to get return value, default nil.
173 \(fn (VAR LIST [RESULT]) BODY...)"
174 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
175 ;; It would be cleaner to create an uninterned symbol,
176 ;; but that uses a lot more space when many functions in many files
178 (let ((temp '--dolist-tail--
))
179 `(let ((,temp
,(nth 1 spec
))
182 (setq ,(car spec
) (car ,temp
))
184 (setq ,temp
(cdr ,temp
)))
185 ,@(if (cdr (cdr spec
))
186 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
)))))))
188 (defvar --dotimes-limit-- nil
189 "Temporary variable used in `dotimes' expansion.")
191 (defmacro dotimes
(spec &rest body
)
192 "Loop a certain number of times.
193 Evaluate BODY with VAR bound to successive integers running from 0,
194 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
195 the return value (nil if RESULT is omitted).
197 \(fn (VAR COUNT [RESULT]) BODY...)"
198 (declare (indent 1) (debug dolist
))
199 ;; It would be cleaner to create an uninterned symbol,
200 ;; but that uses a lot more space when many functions in many files
202 (let ((temp '--dotimes-limit--
)
206 (,(car spec
) ,start
))
207 (while (< ,(car spec
) ,temp
)
209 (setq ,(car spec
) (1+ ,(car spec
))))
210 ,@(cdr (cdr spec
)))))
212 (defmacro declare
(&rest specs
)
213 "Do not evaluate any arguments and return nil.
214 Treated as a declaration when used at the right place in a
215 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
219 (defmacro ignore-errors
(&rest body
)
220 "Execute BODY; if an error occurs, return nil.
221 Otherwise, return result of last form in BODY."
222 `(condition-case nil
(progn ,@body
) (error nil
)))
224 ;;;; Basic Lisp functions.
226 (defun ignore (&rest ignore
)
227 "Do nothing and return nil.
228 This function accepts any number of arguments, but ignores them."
232 ;; Signal a compile-error if the first arg is missing.
233 (defun error (&rest args
)
234 "Signal an error, making error message by passing all args to `format'.
235 In Emacs, the convention is that error messages start with a capital
236 letter but *do not* end with a period. Please follow this convention
237 for the sake of consistency."
239 (signal 'error
(list (apply 'format args
)))))
240 (set-advertised-calling-convention 'error
'(string &rest args
))
242 ;; We put this here instead of in frame.el so that it's defined even on
243 ;; systems where frame.el isn't loaded.
244 (defun frame-configuration-p (object)
245 "Return non-nil if OBJECT seems to be a frame configuration.
246 Any list whose car is `frame-configuration' is assumed to be a frame
249 (eq (car object
) 'frame-configuration
)))
251 (defun functionp (object)
252 "Non-nil if OBJECT is a function."
253 (or (and (symbolp object
) (fboundp object
)
255 (setq object
(indirect-function object
))
257 (eq (car-safe object
) 'autoload
)
258 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object
)))))))
260 ;; Filter out special forms.
261 (not (eq 'unevalled
(cdr (subr-arity object
)))))
262 (byte-code-function-p object
)
263 (eq (car-safe object
) 'lambda
)))
268 "Return the car of the car of X."
272 "Return the car of the cdr of X."
276 "Return the cdr of the car of X."
280 "Return the cdr of the cdr of X."
283 (defun last (list &optional n
)
284 "Return the last link of LIST. Its car is the last element.
285 If LIST is nil, return nil.
286 If N is non-nil, return the Nth-to-last link of LIST.
287 If N is bigger than the length of LIST, return LIST."
289 (let ((m 0) (p list
))
291 (setq m
(1+ m
) p
(cdr p
)))
293 (if (< n m
) (nthcdr (- m n
) list
) list
)))
294 (while (consp (cdr list
))
295 (setq list
(cdr list
)))
298 (defun butlast (list &optional n
)
299 "Return a copy of LIST with the last N elements removed."
300 (if (and n
(<= n
0)) list
301 (nbutlast (copy-sequence list
) n
)))
303 (defun nbutlast (list &optional n
)
304 "Modifies LIST to remove the last N elements."
305 (let ((m (length list
)))
309 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
312 (defun delete-dups (list)
313 "Destructively remove `equal' duplicates from LIST.
314 Store the result in LIST and return it. LIST must be a proper list.
315 Of several `equal' occurrences of an element in LIST, the first
319 (setcdr tail
(delete (car tail
) (cdr tail
)))
320 (setq tail
(cdr tail
))))
323 (defun number-sequence (from &optional to inc
)
324 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
325 INC is the increment used between numbers in the sequence and defaults to 1.
326 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
327 zero. TO is only included if there is an N for which TO = FROM + N * INC.
328 If TO is nil or numerically equal to FROM, return \(FROM).
329 If INC is positive and TO is less than FROM, or INC is negative
330 and TO is larger than FROM, return nil.
331 If INC is zero and TO is neither nil nor numerically equal to
332 FROM, signal an error.
334 This function is primarily designed for integer arguments.
335 Nevertheless, FROM, TO and INC can be integer or float. However,
336 floating point arithmetic is inexact. For instance, depending on
337 the machine, it may quite well happen that
338 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
339 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
340 elements. Thus, if some of the arguments are floats and one wants
341 to make sure that TO is included, one may have to explicitly write
342 TO as \(+ FROM \(* N INC)) or use a variable whose value was
343 computed with this exact expression. Alternatively, you can,
344 of course, also replace TO with a slightly larger value
345 \(or a slightly more negative value if INC is negative)."
346 (if (or (not to
) (= from to
))
348 (or inc
(setq inc
1))
349 (when (zerop inc
) (error "The increment can not be zero"))
350 (let (seq (n 0) (next from
))
353 (setq seq
(cons next seq
)
355 next
(+ from
(* n inc
))))
357 (setq seq
(cons next seq
)
359 next
(+ from
(* n inc
)))))
362 (defun copy-tree (tree &optional vecp
)
363 "Make a copy of TREE.
364 If TREE is a cons cell, this recursively copies both its car and its cdr.
365 Contrast to `copy-sequence', which copies only along the cdrs. With second
366 argument VECP, this copies vectors as well as conses."
370 (let ((newcar (car tree
)))
371 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
372 (setq newcar
(copy-tree (car tree
) vecp
)))
373 (push newcar result
))
374 (setq tree
(cdr tree
)))
375 (nconc (nreverse result
) tree
))
376 (if (and vecp
(vectorp tree
))
377 (let ((i (length (setq tree
(copy-sequence tree
)))))
378 (while (>= (setq i
(1- i
)) 0)
379 (aset tree i
(copy-tree (aref tree i
) vecp
)))
383 ;;;; Various list-search functions.
385 (defun assoc-default (key alist
&optional test default
)
386 "Find object KEY in a pseudo-alist ALIST.
387 ALIST is a list of conses or objects. Each element
388 (or the element's car, if it is a cons) is compared with KEY by
389 calling TEST, with two arguments: (i) the element or its car,
391 If that is non-nil, the element matches; then `assoc-default'
392 returns the element's cdr, if it is a cons, or DEFAULT if the
393 element is not a cons.
395 If no element matches, the value is nil.
396 If TEST is omitted or nil, `equal' is used."
397 (let (found (tail alist
) value
)
398 (while (and tail
(not found
))
399 (let ((elt (car tail
)))
400 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
401 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
402 (setq tail
(cdr tail
)))
405 (make-obsolete 'assoc-ignore-case
'assoc-string
"22.1")
406 (defun assoc-ignore-case (key alist
)
407 "Like `assoc', but ignores differences in case and text representation.
408 KEY must be a string. Upper-case and lower-case letters are treated as equal.
409 Unibyte strings are converted to multibyte for comparison."
410 (assoc-string key alist t
))
412 (make-obsolete 'assoc-ignore-representation
'assoc-string
"22.1")
413 (defun assoc-ignore-representation (key alist
)
414 "Like `assoc', but ignores differences in text representation.
415 KEY must be a string.
416 Unibyte strings are converted to multibyte for comparison."
417 (assoc-string key alist nil
))
419 (defun member-ignore-case (elt list
)
420 "Like `member', but ignores differences in case and text representation.
421 ELT must be a string. Upper-case and lower-case letters are treated as equal.
422 Unibyte strings are converted to multibyte for comparison.
423 Non-strings in LIST are ignored."
425 (not (and (stringp (car list
))
426 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
427 (setq list
(cdr list
)))
430 (defun assq-delete-all (key alist
)
431 "Delete from ALIST all elements whose car is `eq' to KEY.
432 Return the modified alist.
433 Elements of ALIST that are not conses are ignored."
434 (while (and (consp (car alist
))
435 (eq (car (car alist
)) key
))
436 (setq alist
(cdr alist
)))
437 (let ((tail alist
) tail-cdr
)
438 (while (setq tail-cdr
(cdr tail
))
439 (if (and (consp (car tail-cdr
))
440 (eq (car (car tail-cdr
)) key
))
441 (setcdr tail
(cdr tail-cdr
))
442 (setq tail tail-cdr
))))
445 (defun rassq-delete-all (value alist
)
446 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
447 Return the modified alist.
448 Elements of ALIST that are not conses are ignored."
449 (while (and (consp (car alist
))
450 (eq (cdr (car alist
)) value
))
451 (setq alist
(cdr alist
)))
452 (let ((tail alist
) tail-cdr
)
453 (while (setq tail-cdr
(cdr tail
))
454 (if (and (consp (car tail-cdr
))
455 (eq (cdr (car tail-cdr
)) value
))
456 (setcdr tail
(cdr tail-cdr
))
457 (setq tail tail-cdr
))))
460 (defun remove (elt seq
)
461 "Return a copy of SEQ with all occurrences of ELT removed.
462 SEQ must be a list, vector, or string. The comparison is done with `equal'."
464 ;; If SEQ isn't a list, there's no need to copy SEQ because
465 ;; `delete' will return a new object.
467 (delete elt
(copy-sequence seq
))))
469 (defun remq (elt list
)
470 "Return LIST with all occurrences of ELT removed.
471 The comparison is done with `eq'. Contrary to `delq', this does not use
472 side-effects, and the argument LIST is not modified."
474 (delq elt
(copy-sequence list
))
480 "Convert KEYS to the internal Emacs key representation.
481 KEYS should be a string constant in the format used for
482 saving keyboard macros (see `edmacro-mode')."
483 (read-kbd-macro keys
))
489 ;; Prevent the \{...} documentation construct
490 ;; from mentioning keys that run this command.
491 (put 'undefined
'suppress-keymap t
)
493 (defun suppress-keymap (map &optional nodigits
)
494 "Make MAP override all normally self-inserting keys to be undefined.
495 Normally, as an exception, digits and minus-sign are set to make prefix args,
496 but optional second arg NODIGITS non-nil treats them like other chars."
497 (define-key map
[remap self-insert-command
] 'undefined
)
500 (define-key map
"-" 'negative-argument
)
501 ;; Make plain numbers do numeric args.
504 (define-key map
(char-to-string loop
) 'digit-argument
)
505 (setq loop
(1+ loop
))))))
507 (defun define-key-after (keymap key definition
&optional after
)
508 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
509 This is like `define-key' except that the binding for KEY is placed
510 just after the binding for the event AFTER, instead of at the beginning
511 of the map. Note that AFTER must be an event type (like KEY), NOT a command
514 If AFTER is t or omitted, the new binding goes at the end of the keymap.
515 AFTER should be a single event type--a symbol or a character, not a sequence.
517 Bindings are always added before any inherited map.
519 The order of bindings in a keymap matters when it is used as a menu."
520 (unless after
(setq after t
))
522 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
524 (if (<= (length key
) 1) (aref key
0)
525 (setq keymap
(lookup-key keymap
527 (butlast (mapcar 'identity key
)))))
528 (aref key
(1- (length key
)))))
529 (let ((tail keymap
) done inserted
)
530 (while (and (not done
) tail
)
531 ;; Delete any earlier bindings for the same key.
532 (if (eq (car-safe (car (cdr tail
))) key
)
533 (setcdr tail
(cdr (cdr tail
))))
534 ;; If we hit an included map, go down that one.
535 (if (keymapp (car tail
)) (setq tail
(car tail
)))
536 ;; When we reach AFTER's binding, insert the new binding after.
537 ;; If we reach an inherited keymap, insert just before that.
538 ;; If we reach the end of this keymap, insert at the end.
539 (if (or (and (eq (car-safe (car tail
)) after
)
541 (eq (car (cdr tail
)) 'keymap
)
544 ;; Stop the scan only if we find a parent keymap.
545 ;; Keep going past the inserted element
546 ;; so we can delete any duplications that come later.
547 (if (eq (car (cdr tail
)) 'keymap
)
549 ;; Don't insert more than once.
551 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
553 (setq tail
(cdr tail
)))))
555 (defun map-keymap-sorted (function keymap
)
556 "Implement `map-keymap' with sorting.
557 Don't call this function; it is for internal use only."
559 (map-keymap (lambda (a b
) (push (cons a b
) list
))
561 (setq list
(sort list
563 (setq a
(car a
) b
(car b
))
565 (if (integerp b
) (< a b
)
568 ;; string< also accepts symbols.
571 (funcall function
(car p
) (cdr p
)))))
573 (defun keymap-canonicalize (map)
574 "Return an equivalent keymap, without inheritance."
577 (prompt (keymap-prompt map
)))
579 (setq map
(map-keymap-internal
582 ;; Treat char-ranges specially.
583 (push (cons key item
) ranges
)
584 (push (cons key item
) bindings
)))
586 (setq map
(funcall (if ranges
'make-keymap
'make-sparse-keymap
) prompt
))
587 (dolist (binding ranges
)
588 ;; Treat char-ranges specially.
589 (define-key map
(vector (car binding
)) (cdr binding
)))
590 (dolist (binding (prog1 bindings
(setq bindings
())))
591 (let* ((key (car binding
))
593 (oldbind (assq key bindings
)))
594 ;; Newer bindings override older.
595 (if oldbind
(setq bindings
(delq oldbind bindings
)))
596 (when item
;nil bindings just hide older ones.
597 (push binding bindings
))))
598 (nconc map bindings
)))
600 (put 'keyboard-translate-table
'char-table-extra-slots
0)
602 (defun keyboard-translate (from to
)
603 "Translate character FROM to TO at a low level.
604 This function creates a `keyboard-translate-table' if necessary
605 and then modifies one entry in it."
606 (or (char-table-p keyboard-translate-table
)
607 (setq keyboard-translate-table
608 (make-char-table 'keyboard-translate-table nil
)))
609 (aset keyboard-translate-table from to
))
611 ;;;; Key binding commands.
613 (defun global-set-key (key command
)
614 "Give KEY a global binding as COMMAND.
615 COMMAND is the command definition to use; usually it is
616 a symbol naming an interactively-callable function.
617 KEY is a key sequence; noninteractively, it is a string or vector
618 of characters or event types, and non-ASCII characters with codes
619 above 127 (such as ISO Latin-1) can be included if you use a vector.
621 Note that if KEY has a local binding in the current buffer,
622 that local binding will continue to shadow any global binding
623 that you make with this function."
624 (interactive "KSet key globally: \nCSet key %s to command: ")
625 (or (vectorp key
) (stringp key
)
626 (signal 'wrong-type-argument
(list 'arrayp key
)))
627 (define-key (current-global-map) key command
))
629 (defun local-set-key (key command
)
630 "Give KEY a local binding as COMMAND.
631 COMMAND is the command definition to use; usually it is
632 a symbol naming an interactively-callable function.
633 KEY is a key sequence; noninteractively, it is a string or vector
634 of characters or event types, and non-ASCII characters with codes
635 above 127 (such as ISO Latin-1) can be included if you use a vector.
637 The binding goes in the current buffer's local map,
638 which in most cases is shared with all other buffers in the same major mode."
639 (interactive "KSet key locally: \nCSet key %s locally to command: ")
640 (let ((map (current-local-map)))
642 (use-local-map (setq map
(make-sparse-keymap))))
643 (or (vectorp key
) (stringp key
)
644 (signal 'wrong-type-argument
(list 'arrayp key
)))
645 (define-key map key command
)))
647 (defun global-unset-key (key)
648 "Remove global binding of KEY.
649 KEY is a string or vector representing a sequence of keystrokes."
650 (interactive "kUnset key globally: ")
651 (global-set-key key nil
))
653 (defun local-unset-key (key)
654 "Remove local binding of KEY.
655 KEY is a string or vector representing a sequence of keystrokes."
656 (interactive "kUnset key locally: ")
657 (if (current-local-map)
658 (local-set-key key nil
))
661 ;;;; substitute-key-definition and its subroutines.
663 (defvar key-substitution-in-progress nil
664 "Used internally by `substitute-key-definition'.")
666 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
667 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
668 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
669 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
670 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
672 If you don't specify OLDMAP, you can usually get the same results
673 in a cleaner way with command remapping, like this:
674 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
675 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
676 ;; Don't document PREFIX in the doc string because we don't want to
677 ;; advertise it. It's meant for recursive calls only. Here's its
680 ;; If optional argument PREFIX is specified, it should be a key
681 ;; prefix, a string. Redefined bindings will then be bound to the
682 ;; original key, with PREFIX added at the front.
683 (or prefix
(setq prefix
""))
684 (let* ((scan (or oldmap keymap
))
685 (prefix1 (vconcat prefix
[nil]))
686 (key-substitution-in-progress
687 (cons scan key-substitution-in-progress)))
688 ;; Scan OLDMAP, finding each char or event-symbol that
689 ;; has any definition, and act on it with hack-key.
692 (aset prefix1 (length prefix) char)
693 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
696 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
697 (let (inner-def skipped menu-item)
698 ;; Find the actual command name within the binding.
699 (if (eq (car-safe defn) 'menu-item)
700 (setq menu-item defn defn (nth 2 defn))
701 ;; Skip past menu-prompt.
702 (while (stringp (car-safe defn))
703 (push (pop defn) skipped))
704 ;; Skip past cached key-equivalence data for menu items.
705 (if (consp (car-safe defn))
706 (setq defn (cdr defn))))
707 (if (or (eq defn olddef)
708 ;; Compare with equal if definition is a key sequence.
709 ;; That is useful for operating on function-key-map.
710 (and (or (stringp defn) (vectorp defn))
711 (equal defn olddef)))
712 (define-key keymap prefix
714 (let ((copy (copy-sequence menu-item)))
715 (setcar (nthcdr 2 copy) newdef)
717 (nconc (nreverse skipped) newdef)))
718 ;; Look past a symbol that names a keymap.
720 (or (indirect-function defn t) defn))
721 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
722 ;; avoid autoloading a keymap. This is mostly done to preserve the
723 ;; original non-autoloading behavior of pre-map-keymap times.
724 (if (and (keymapp inner-def)
725 ;; Avoid recursively scanning
726 ;; where KEYMAP does not have a submap.
727 (let ((elt (lookup-key keymap prefix)))
728 (or (null elt) (natnump elt) (keymapp elt)))
729 ;; Avoid recursively rescanning keymap being scanned.
730 (not (memq inner-def key-substitution-in-progress)))
731 ;; If this one isn't being scanned already, scan it now.
732 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
735 ;;;; The global keymap tree.
737 ;; global-map, esc-map, and ctl-x-map have their values set up in
738 ;; keymap.c; we just give them docstrings here.
740 (defvar global-map nil
741 "Default global keymap mapping Emacs keyboard input into commands.
742 The value is a keymap which is usually (but not necessarily) Emacs's
746 "Default keymap for ESC (meta) commands.
747 The normal global definition of the character ESC indirects to this keymap.")
749 (defvar ctl-x-map nil
750 "Default keymap for C-x commands.
751 The normal global definition of the character C-x indirects to this keymap.")
753 (defvar ctl-x-4-map (make-sparse-keymap)
754 "Keymap for subcommands of C-x 4.")
755 (defalias 'ctl-x-4-prefix ctl-x-4-map)
756 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
758 (defvar ctl-x-5-map (make-sparse-keymap)
759 "Keymap for frame commands.")
760 (defalias 'ctl-x-5-prefix ctl-x-5-map)
761 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
764 ;;;; Event manipulation functions.
766 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
768 (defun listify-key-sequence (key)
769 "Convert a key sequence to a list of events."
772 (mapcar (function (lambda (c)
774 (logxor c listify-key-sequence-1)
778 (defsubst eventp (obj)
779 "True if the argument is an event object."
780 (or (and (integerp obj)
781 ;; Filter out integers too large to be events.
782 ;; M is the biggest modifier.
783 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
784 (characterp (event-basic-type obj)))
786 (get obj 'event-symbol-elements))
789 (get (car obj) 'event-symbol-elements))))
791 (defun event-modifiers (event)
792 "Return a list of symbols representing the modifier keys in event EVENT.
793 The elements of the list may include `meta', `control',
794 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
796 EVENT may be an event or an event type. If EVENT is a symbol
797 that has never been used in an event that has been read as input
798 in the current Emacs session, then this function can return nil,
799 even when EVENT actually has modifiers."
802 (setq type (car type)))
804 ;; Don't read event-symbol-elements directly since we're not
805 ;; sure the symbol has already been parsed.
806 (cdr (internal-event-symbol-parse-modifiers type))
808 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
809 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
810 (if (not (zerop (logand type ?\M-\^@)))
812 (if (or (not (zerop (logand type ?\C-\^@)))
814 (push 'control list))
815 (if (or (not (zerop (logand type ?\S-\^@)))
816 (/= char (downcase char)))
818 (or (zerop (logand type ?\H-\^@))
820 (or (zerop (logand type ?\s-\^@))
822 (or (zerop (logand type ?\A-\^@))
826 (defun event-basic-type (event)
827 "Return the basic type of the given event (all modifiers removed).
828 The value is a printing character (not upper case) or a symbol.
829 EVENT may be an event or an event type. If EVENT is a symbol
830 that has never been used in an event that has been read as input
831 in the current Emacs session, then this function may return nil."
833 (setq event (car event)))
835 (car (get event 'event-symbol-elements))
836 (let* ((base (logand event (1- ?\A-\^@)))
837 (uncontrolled (if (< base 32) (logior base 64) base)))
838 ;; There are some numbers that are invalid characters and
839 ;; cause `downcase' to get an error.
841 (downcase uncontrolled)
842 (error uncontrolled)))))
844 (defsubst mouse-movement-p (object)
845 "Return non-nil if OBJECT is a mouse movement event."
846 (eq (car-safe object) 'mouse-movement))
848 (defun mouse-event-p (object)
849 "Return non-nil if OBJECT is a mouse click event."
850 ;; is this really correct? maybe remove mouse-movement?
851 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
853 (defsubst event-start (event)
854 "Return the starting position of EVENT.
855 If EVENT is a mouse or key press or a mouse click, this returns the location
857 If EVENT is a drag, this returns the drag's starting position.
858 The return value is of the form
859 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
860 IMAGE (DX . DY) (WIDTH . HEIGHT))
861 The `posn-' functions access elements of such lists."
862 (if (consp event) (nth 1 event)
863 (list (selected-window) (point) '(0 . 0) 0)))
865 (defsubst event-end (event)
866 "Return the ending location of EVENT.
867 EVENT should be a click, drag, or key press event.
868 If EVENT is a click event, this function is the same as `event-start'.
869 The return value is of the form
870 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
871 IMAGE (DX . DY) (WIDTH . HEIGHT))
872 The `posn-' functions access elements of such lists."
873 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
874 (list (selected-window) (point) '(0 . 0) 0)))
876 (defsubst event-click-count (event)
877 "Return the multi-click count of EVENT, a click or drag event.
878 The return value is a positive integer."
879 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
881 ;;;; Extracting fields of the positions in an event.
883 (defsubst posn-window (position)
884 "Return the window in POSITION.
885 POSITION should be a list of the form returned by the `event-start'
886 and `event-end' functions."
889 (defsubst posn-area (position)
890 "Return the window area recorded in POSITION, or nil for the text area.
891 POSITION should be a list of the form returned by the `event-start'
892 and `event-end' functions."
893 (let ((area (if (consp (nth 1 position))
894 (car (nth 1 position))
896 (and (symbolp area) area)))
898 (defsubst posn-point (position)
899 "Return the buffer location in POSITION.
900 POSITION should be a list of the form returned by the `event-start'
901 and `event-end' functions."
903 (if (consp (nth 1 position))
904 (car (nth 1 position))
907 (defun posn-set-point (position)
908 "Move point to POSITION.
909 Select the corresponding window as well."
910 (if (not (windowp (posn-window position)))
911 (error "Position not in text area of window"))
912 (select-window (posn-window position))
913 (if (numberp (posn-point position))
914 (goto-char (posn-point position))))
916 (defsubst posn-x-y (position)
917 "Return the x and y coordinates in POSITION.
918 POSITION should be a list of the form returned by the `event-start'
919 and `event-end' functions."
922 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
924 (defun posn-col-row (position)
925 "Return the nominal column and row in POSITION, measured in characters.
926 The column and row values are approximations calculated from the x
927 and y coordinates in POSITION and the frame's default character width
929 For a scroll-bar event, the result column is 0, and the row
930 corresponds to the vertical position of the click in the scroll bar.
931 POSITION should be a list of the form returned by the `event-start'
932 and `event-end' functions."
933 (let* ((pair (posn-x-y position))
934 (window (posn-window position))
935 (area (posn-area position)))
939 ((eq area 'vertical-scroll-bar)
940 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
941 ((eq area 'horizontal-scroll-bar)
942 (cons (scroll-bar-scale pair (window-width window)) 0))
944 (let* ((frame (if (framep window) window (window-frame window)))
945 ;; FIXME: This should take line-spacing properties on
946 ;; newlines into account.
947 (spacing (when (display-graphic-p frame)
948 (or (with-current-buffer (window-buffer window)
950 (frame-parameter frame 'line-spacing)))))
951 (cond ((floatp spacing)
952 (setq spacing (truncate (* spacing
953 (frame-char-height frame)))))
956 (cons (/ (car pair) (frame-char-width frame))
957 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
959 (defun posn-actual-col-row (position)
960 "Return the actual column and row in POSITION, measured in characters.
961 These are the actual row number in the window and character number in that row.
962 Return nil if POSITION does not contain the actual position; in that case
963 `posn-col-row' can be used to get approximate values.
964 POSITION should be a list of the form returned by the `event-start'
965 and `event-end' functions."
968 (defsubst posn-timestamp (position)
969 "Return the timestamp of POSITION.
970 POSITION should be a list of the form returned by the `event-start'
971 and `event-end' functions."
974 (defsubst posn-string (position)
975 "Return the string object of POSITION.
976 Value is a cons (STRING . STRING-POS), or nil if not a string.
977 POSITION should be a list of the form returned by the `event-start'
978 and `event-end' functions."
981 (defsubst posn-image (position)
982 "Return the image object of POSITION.
983 Value is a list (image ...), or nil if not an image.
984 POSITION should be a list of the form returned by the `event-start'
985 and `event-end' functions."
988 (defsubst posn-object (position)
989 "Return the object (image or string) of POSITION.
990 Value is a list (image ...) for an image object, a cons cell
991 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
992 POSITION should be a list of the form returned by the `event-start'
993 and `event-end' functions."
994 (or (posn-image position) (posn-string position)))
996 (defsubst posn-object-x-y (position)
997 "Return the x and y coordinates relative to the object of POSITION.
998 POSITION should be a list of the form returned by the `event-start'
999 and `event-end' functions."
1002 (defsubst posn-object-width-height (position)
1003 "Return the pixel width and height of the object of POSITION.
1004 POSITION should be a list of the form returned by the `event-start'
1005 and `event-end' functions."
1009 ;;;; Obsolescent names for functions.
1011 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1012 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1013 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1014 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1015 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1016 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1018 (make-obsolete 'char-bytes "now always returns 1." "20.4")
1019 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1021 (defun insert-string (&rest args)
1022 "Mocklisp-compatibility insert function.
1023 Like the function `insert' except that any argument that is a number
1024 is converted into a string by expressing it in decimal."
1026 (insert (if (integerp el) (number-to-string el) el))))
1027 (make-obsolete 'insert-string 'insert "22.1")
1029 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1030 (make-obsolete 'makehash 'make-hash-table "22.1")
1032 ;; These are used by VM and some old programs
1033 (defalias 'focus-frame 'ignore "")
1034 (make-obsolete 'focus-frame "it does nothing." "22.1")
1035 (defalias 'unfocus-frame 'ignore "")
1036 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1037 (make-obsolete 'make-variable-frame-local
1038 "explicitly check for a frame-parameter instead." "22.2")
1039 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
1040 (set-advertised-calling-convention 'called-interactively-p '(kind))
1042 ;;;; Obsolescence declarations for variables, and aliases.
1044 ;; Special "default-FOO" variables which contain the default value of
1045 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1046 ;; slows down several unrelated variable operations; furthermore, they
1047 ;; can lead to really odd behavior if you decide to make them
1050 ;; Not used at all in Emacs, last time I checked:
1051 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1052 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1053 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1054 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1055 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1056 (make-obsolete-variable 'default-direction-reversed 'direction-reversed "23.2")
1057 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1058 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1059 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1060 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1061 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1062 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1063 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1064 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1065 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1066 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1067 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1068 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1069 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1070 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1071 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1072 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1073 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1074 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1075 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1076 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1077 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1078 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1079 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1080 (make-obsolete-variable 'default-enable-multibyte-characters
1081 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1083 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1084 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1085 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1086 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1088 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1089 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1091 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
1092 (make-obsolete-variable
1093 'mode-line-inverse-video
1094 "use the appropriate faces instead."
1096 (make-obsolete-variable
1097 'unread-command-char
1098 "use `unread-command-events' instead. That variable is a list of events
1099 to reread, so it now uses nil to mean `no event', instead of -1."
1102 ;; Lisp manual only updated in 22.1.
1103 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1106 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1107 (make-obsolete-variable 'x-lost-selection-hooks
1108 'x-lost-selection-functions "22.1")
1109 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1110 (make-obsolete-variable 'x-sent-selection-hooks
1111 'x-sent-selection-functions "22.1")
1113 ;; This was introduced in 21.4 for pre-unicode unification. That
1114 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1115 ;; Other uses are possible, so this variable is not _really_ obsolete,
1116 ;; but Stefan insists to mark it so.
1117 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1119 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1121 ;; These aliases exist in Emacs 19.34, and probably before, but were
1122 ;; only marked as obsolete in 23.1.
1123 ;; The lisp manual (since at least Emacs 21) describes them as
1124 ;; existing "for compatibility with Emacs version 18".
1125 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1127 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1131 ;;;; Alternate names for functions - these are not being phased out.
1133 (defalias 'send-string 'process-send-string)
1134 (defalias 'send-region 'process-send-region)
1135 (defalias 'string= 'string-equal)
1136 (defalias 'string< 'string-lessp)
1137 (defalias 'move-marker 'set-marker)
1138 (defalias 'rplaca 'setcar)
1139 (defalias 'rplacd 'setcdr)
1140 (defalias 'beep 'ding) ;preserve lingual purity
1141 (defalias 'indent-to-column 'indent-to)
1142 (defalias 'backward-delete-char 'delete-backward-char)
1143 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1144 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1145 (defalias 'int-to-string 'number-to-string)
1146 (defalias 'store-match-data 'set-match-data)
1147 (defalias 'chmod 'set-file-modes)
1148 (defalias 'mkdir 'make-directory)
1149 ;; These are the XEmacs names:
1150 (defalias 'point-at-eol 'line-end-position)
1151 (defalias 'point-at-bol 'line-beginning-position)
1153 (defalias 'user-original-login-name 'user-login-name)
1156 ;;;; Hook manipulation functions.
1158 (defun make-local-hook (hook)
1159 "Make the hook HOOK local to the current buffer.
1160 The return value is HOOK.
1162 You never need to call this function now that `add-hook' does it for you
1163 if its LOCAL argument is non-nil.
1165 When a hook is local, its local and global values
1166 work in concert: running the hook actually runs all the hook
1167 functions listed in *either* the local value *or* the global value
1168 of the hook variable.
1170 This function works by making t a member of the buffer-local value,
1171 which acts as a flag to run the hook functions in the default value as
1172 well. This works for all normal hooks, but does not work for most
1173 non-normal hooks yet. We will be changing the callers of non-normal
1174 hooks so that they can handle localness; this has to be done one by
1177 This function does nothing if HOOK is already local in the current
1180 Do not use `make-local-variable' to make a hook variable buffer-local."
1181 (if (local-variable-p hook)
1183 (or (boundp hook) (set hook nil))
1184 (make-local-variable hook)
1185 (set hook (list t)))
1187 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1189 (defun add-hook (hook function &optional append local)
1190 "Add to the value of HOOK the function FUNCTION.
1191 FUNCTION is not added if already present.
1192 FUNCTION is added (if necessary) at the beginning of the hook list
1193 unless the optional argument APPEND is non-nil, in which case
1194 FUNCTION is added at the end.
1196 The optional fourth argument, LOCAL, if non-nil, says to modify
1197 the hook's buffer-local value rather than its default value.
1198 This makes the hook buffer-local if needed, and it makes t a member
1199 of the buffer-local value. That acts as a flag to run the hook
1200 functions in the default value as well as in the local value.
1202 HOOK should be a symbol, and FUNCTION may be any valid function. If
1203 HOOK is void, it is first set to nil. If HOOK's value is a single
1204 function, it is changed to a list of functions."
1205 (or (boundp hook) (set hook nil))
1206 (or (default-boundp hook) (set-default hook nil))
1207 (if local (unless (local-variable-if-set-p hook)
1208 (set (make-local-variable hook) (list t)))
1209 ;; Detect the case where make-local-variable was used on a hook
1210 ;; and do what we used to do.
1211 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1213 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1214 ;; If the hook value is a single function, turn it into a list.
1215 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1216 (setq hook-value (list hook-value)))
1217 ;; Do the actual addition if necessary
1218 (unless (member function hook-value)
1221 (append hook-value (list function))
1222 (cons function hook-value))))
1223 ;; Set the actual variable
1226 ;; If HOOK isn't a permanent local,
1227 ;; but FUNCTION wants to survive a change of modes,
1228 ;; mark HOOK as partially permanent.
1229 (and (symbolp function)
1230 (get function 'permanent-local-hook)
1231 (not (get hook 'permanent-local))
1232 (put hook 'permanent-local 'permanent-local-hook))
1233 (set hook hook-value))
1234 (set-default hook hook-value))))
1236 (defun remove-hook (hook function &optional local)
1237 "Remove from the value of HOOK the function FUNCTION.
1238 HOOK should be a symbol, and FUNCTION may be any valid function. If
1239 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1240 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1242 The optional third argument, LOCAL, if non-nil, says to modify
1243 the hook's buffer-local value rather than its default value."
1244 (or (boundp hook) (set hook nil))
1245 (or (default-boundp hook) (set-default hook nil))
1246 ;; Do nothing if LOCAL is t but this hook has no local binding.
1247 (unless (and local (not (local-variable-p hook)))
1248 ;; Detect the case where make-local-variable was used on a hook
1249 ;; and do what we used to do.
1250 (when (and (local-variable-p hook)
1251 (not (and (consp (symbol-value hook))
1252 (memq t (symbol-value hook)))))
1254 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1255 ;; Remove the function, for both the list and the non-list cases.
1256 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1257 (if (equal hook-value function) (setq hook-value nil))
1258 (setq hook-value (delete function (copy-sequence hook-value))))
1259 ;; If the function is on the global hook, we need to shadow it locally
1260 ;;(when (and local (member function (default-value hook))
1261 ;; (not (member (cons 'not function) hook-value)))
1262 ;; (push (cons 'not function) hook-value))
1263 ;; Set the actual variable
1265 (set-default hook hook-value)
1266 (if (equal hook-value '(t))
1267 (kill-local-variable hook)
1268 (set hook hook-value))))))
1270 (defun add-to-list (list-var element &optional append compare-fn)
1271 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1272 The test for presence of ELEMENT is done with `equal',
1273 or with COMPARE-FN if that's non-nil.
1274 If ELEMENT is added, it is added at the beginning of the list,
1275 unless the optional argument APPEND is non-nil, in which case
1276 ELEMENT is added at the end.
1278 The return value is the new value of LIST-VAR.
1280 If you want to use `add-to-list' on a variable that is not defined
1281 until a certain package is loaded, you should put the call to `add-to-list'
1282 into a hook function that will be run only after loading the package.
1283 `eval-after-load' provides one way to do this. In some cases
1284 other hooks, such as major mode hooks, can do the job."
1287 (member element (symbol-value list-var)))
1288 ((eq compare-fn 'eq)
1289 (memq element (symbol-value list-var)))
1290 ((eq compare-fn 'eql)
1291 (memql element (symbol-value list-var)))
1293 (let ((lst (symbol-value list-var)))
1295 (not (funcall compare-fn element (car lst))))
1296 (setq lst (cdr lst)))
1298 (symbol-value list-var)
1301 (append (symbol-value list-var) (list element))
1302 (cons element (symbol-value list-var))))))
1305 (defun add-to-ordered-list (list-var element &optional order)
1306 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1307 The test for presence of ELEMENT is done with `eq'.
1309 The resulting list is reordered so that the elements are in the
1310 order given by each element's numeric list order. Elements
1311 without a numeric list order are placed at the end of the list.
1313 If the third optional argument ORDER is a number (integer or
1314 float), set the element's list order to the given value. If
1315 ORDER is nil or omitted, do not change the numeric order of
1316 ELEMENT. If ORDER has any other value, remove the numeric order
1317 of ELEMENT if it has one.
1319 The list order for each element is stored in LIST-VAR's
1320 `list-order' property.
1322 The return value is the new value of LIST-VAR."
1323 (let ((ordering (get list-var 'list-order)))
1325 (put list-var 'list-order
1326 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1328 (puthash element (and (numberp order) order) ordering))
1329 (unless (memq element (symbol-value list-var))
1330 (set list-var (cons element (symbol-value list-var))))
1331 (set list-var (sort (symbol-value list-var)
1333 (let ((oa (gethash a ordering))
1334 (ob (gethash b ordering)))
1339 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1340 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1341 Return the new history list.
1342 If MAXELT is non-nil, it specifies the maximum length of the history.
1343 Otherwise, the maximum history length is the value of the `history-length'
1344 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1346 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1347 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1348 if it is empty or a duplicate."
1350 (setq maxelt (or (get history-var 'history-length)
1352 (let ((history (symbol-value history-var))
1354 (when (and (listp history)
1356 (not (stringp newelt))
1357 (> (length newelt) 0))
1359 (not (equal (car history) newelt))))
1360 (if history-delete-duplicates
1361 (delete newelt history))
1362 (setq history (cons newelt history))
1363 (when (integerp maxelt)
1366 (setq tail (nthcdr (1- maxelt) history))
1368 (setcdr tail nil)))))
1369 (set history-var history)))
1374 (defvar delay-mode-hooks nil
1375 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1376 (defvar delayed-mode-hooks nil
1377 "List of delayed mode hooks waiting to be run.")
1378 (make-variable-buffer-local 'delayed-mode-hooks)
1379 (put 'delay-mode-hooks 'permanent-local t)
1381 (defvar after-change-major-mode-hook nil
1382 "Normal hook run at the very end of major mode functions.")
1384 (defun run-mode-hooks (&rest hooks)
1385 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1386 Execution is delayed if `delay-mode-hooks' is non-nil.
1387 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1388 after running the mode hooks.
1389 Major mode functions should use this instead of `run-hooks' when running their
1391 (if delay-mode-hooks
1393 (dolist (hook hooks)
1394 (push hook delayed-mode-hooks))
1395 ;; Normal case, just run the hook as before plus any delayed hooks.
1396 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1397 (setq delayed-mode-hooks nil)
1398 (apply 'run-hooks hooks)
1399 (run-hooks 'after-change-major-mode-hook)))
1401 (defmacro delay-mode-hooks (&rest body)
1402 "Execute BODY, but delay any `run-mode-hooks'.
1403 These hooks will be executed by the first following call to
1404 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1405 Only affects hooks run in the current buffer."
1406 (declare (debug t) (indent 0))
1408 (make-local-variable 'delay-mode-hooks)
1409 (let ((delay-mode-hooks t))
1412 ;; PUBLIC: find if the current mode derives from another.
1414 (defun derived-mode-p (&rest modes)
1415 "Non-nil if the current major mode is derived from one of MODES.
1416 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1417 (let ((parent major-mode))
1418 (while (and (not (memq parent modes))
1419 (setq parent (get parent 'derived-mode-parent))))
1424 ;; If a minor mode is not defined with define-minor-mode,
1425 ;; add it here explicitly.
1426 ;; isearch-mode is deliberately excluded, since you should
1427 ;; not call it yourself.
1428 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1429 overwrite-mode view-mode
1431 "List of all minor mode functions.")
1433 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1434 "Register a new minor mode.
1436 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1438 TOGGLE is a symbol which is the name of a buffer-local variable that
1439 is toggled on or off to say whether the minor mode is active or not.
1441 NAME specifies what will appear in the mode line when the minor mode
1442 is active. NAME should be either a string starting with a space, or a
1443 symbol whose value is such a string.
1445 Optional KEYMAP is the keymap for the minor mode that will be added
1446 to `minor-mode-map-alist'.
1448 Optional AFTER specifies that TOGGLE should be added after AFTER
1449 in `minor-mode-alist'.
1451 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1452 It defaults to (and should by convention be) TOGGLE.
1454 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1455 included in the mode-line minor mode menu.
1456 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1457 (unless (memq toggle minor-mode-list)
1458 (push toggle minor-mode-list))
1460 (unless toggle-fun (setq toggle-fun toggle))
1461 (unless (eq toggle-fun toggle)
1462 (put toggle :minor-mode-function toggle-fun))
1463 ;; Add the name to the minor-mode-alist.
1465 (let ((existing (assq toggle minor-mode-alist)))
1467 (setcdr existing (list name))
1468 (let ((tail minor-mode-alist) found)
1469 (while (and tail (not found))
1470 (if (eq after (caar tail))
1472 (setq tail (cdr tail))))
1474 (let ((rest (cdr found)))
1476 (nconc found (list (list toggle name)) rest))
1477 (setq minor-mode-alist (cons (list toggle name)
1478 minor-mode-alist)))))))
1479 ;; Add the toggle to the minor-modes menu if requested.
1480 (when (get toggle :included)
1481 (define-key mode-line-mode-menu
1485 (or (get toggle :menu-tag)
1486 (if (stringp name) name (symbol-name toggle)))
1487 (let ((mode-name (if (symbolp name) (symbol-value name))))
1488 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1489 (concat " (" (match-string 0 mode-name) ")"))))
1491 :button (cons :toggle toggle))))
1493 ;; Add the map to the minor-mode-map-alist.
1495 (let ((existing (assq toggle minor-mode-map-alist)))
1497 (setcdr existing keymap)
1498 (let ((tail minor-mode-map-alist) found)
1499 (while (and tail (not found))
1500 (if (eq after (caar tail))
1502 (setq tail (cdr tail))))
1504 (let ((rest (cdr found)))
1506 (nconc found (list (cons toggle keymap)) rest))
1507 (setq minor-mode-map-alist (cons (cons toggle keymap)
1508 minor-mode-map-alist))))))))
1512 ;; (defvar symbol-file-load-history-loaded nil
1513 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1514 ;; That file records the part of `load-history' for preloaded files,
1515 ;; which is cleared out before dumping to make Emacs smaller.")
1517 ;; (defun load-symbol-file-load-history ()
1518 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1519 ;; That file records the part of `load-history' for preloaded files,
1520 ;; which is cleared out before dumping to make Emacs smaller."
1521 ;; (unless symbol-file-load-history-loaded
1522 ;; (load (expand-file-name
1523 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1524 ;; (if (eq system-type 'ms-dos)
1526 ;; (format "fns-%s.el" emacs-version))
1528 ;; ;; The file name fns-%s.el already has a .el extension.
1530 ;; (setq symbol-file-load-history-loaded t)))
1532 (defun symbol-file (symbol &optional type)
1533 "Return the name of the file that defined SYMBOL.
1534 The value is normally an absolute file name. It can also be nil,
1535 if the definition is not associated with any file. If SYMBOL
1536 specifies an autoloaded function, the value can be a relative
1537 file name without extension.
1539 If TYPE is nil, then any kind of definition is acceptable. If
1540 TYPE is `defun', `defvar', or `defface', that specifies function
1541 definition, variable definition, or face definition only."
1542 (if (and (or (null type) (eq type 'defun))
1543 (symbolp symbol) (fboundp symbol)
1544 (eq 'autoload (car-safe (symbol-function symbol))))
1545 (nth 1 (symbol-function symbol))
1546 (let ((files load-history)
1550 (if (eq type 'defvar)
1551 ;; Variables are present just as their names.
1552 (member symbol (cdr (car files)))
1553 ;; Other types are represented as (TYPE . NAME).
1554 (member (cons type symbol) (cdr (car files))))
1555 ;; We accept all types, so look for variable def
1556 ;; and then for any other kind.
1557 (or (member symbol (cdr (car files)))
1558 (rassq symbol (cdr (car files)))))
1559 (setq file (car (car files)) files nil))
1560 (setq files (cdr files)))
1563 (defun locate-library (library &optional nosuffix path interactive-call)
1564 "Show the precise file name of Emacs library LIBRARY.
1565 LIBRARY should be a relative file name of the library, a string.
1566 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1567 nil (which is the default, see below).
1568 This command searches the directories in `load-path' like `\\[load-library]'
1569 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1570 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1571 to the specified name LIBRARY.
1573 If the optional third arg PATH is specified, that list of directories
1574 is used instead of `load-path'.
1576 When called from a program, the file name is normally returned as a
1577 string. When run interactively, the argument INTERACTIVE-CALL is t,
1578 and the file name is displayed in the echo area."
1579 (interactive (list (completing-read "Locate library: "
1581 'locate-file-completion-table
1582 load-path (get-load-suffixes)))
1585 (let ((file (locate-file library
1587 (append (unless nosuffix (get-load-suffixes))
1588 load-file-rep-suffixes))))
1589 (if interactive-call
1591 (message "Library is file %s" (abbreviate-file-name file))
1592 (message "No library %s in search path" library)))
1596 ;;;; Specifying things to do later.
1598 (defun load-history-regexp (file)
1599 "Form a regexp to find FILE in `load-history'.
1600 FILE, a string, is described in the function `eval-after-load'."
1601 (if (file-name-absolute-p file)
1602 (setq file (file-truename file)))
1603 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1605 (if (file-name-extension file)
1607 ;; Note: regexp-opt can't be used here, since we need to call
1608 ;; this before Emacs has been fully started. 2006-05-21
1609 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1610 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1613 (defun load-history-filename-element (file-regexp)
1614 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1615 Return nil if there isn't one."
1616 (let* ((loads load-history)
1617 (load-elt (and loads (car loads))))
1620 (or (null (car load-elt))
1621 (not (string-match file-regexp (car load-elt)))))
1622 (setq loads (cdr loads)
1623 load-elt (and loads (car loads)))))
1626 (defun eval-after-load (file form)
1627 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1628 If FILE is already loaded, evaluate FORM right now.
1630 If a matching file is loaded again, FORM will be evaluated again.
1632 If FILE is a string, it may be either an absolute or a relative file
1633 name, and may have an extension \(e.g. \".el\") or may lack one, and
1634 additionally may or may not have an extension denoting a compressed
1635 format \(e.g. \".gz\").
1637 When FILE is absolute, this first converts it to a true name by chasing
1638 symbolic links. Only a file of this name \(see next paragraph regarding
1639 extensions) will trigger the evaluation of FORM. When FILE is relative,
1640 a file whose absolute true name ends in FILE will trigger evaluation.
1642 When FILE lacks an extension, a file name with any extension will trigger
1643 evaluation. Otherwise, its extension must match FILE's. A further
1644 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1647 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1648 is evaluated whenever that feature is `provide'd. Note that although
1649 provide statements are usually at the end of files, this is not always
1650 the case (e.g., sometimes they are at the start to avoid a recursive
1651 load error). If your FORM should not be evaluated until the code in
1652 FILE has been, do not use the symbol form for FILE in such cases.
1654 Usually FILE is just a library name like \"font-lock\" or a feature name
1657 This function makes or adds to an entry on `after-load-alist'."
1658 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1659 ;; evaluating it now).
1660 (let* ((regexp-or-feature
1661 (if (stringp file) (load-history-regexp file) file))
1662 (elt (assoc regexp-or-feature after-load-alist)))
1664 (setq elt (list regexp-or-feature))
1665 (push elt after-load-alist))
1666 ;; Add FORM to the element unless it's already there.
1667 (unless (member form (cdr elt))
1668 (nconc elt (list form)))
1670 ;; Is there an already loaded file whose name (or `provide' name)
1672 (if (if (stringp file)
1673 (load-history-filename-element regexp-or-feature)
1677 (defvar after-load-functions nil
1678 "Special hook run after loading a file.
1679 Each function there is called with a single argument, the absolute
1680 name of the file just loaded.")
1682 (defun do-after-load-evaluation (abs-file)
1683 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1684 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1685 This function is called directly from the C code."
1686 ;; Run the relevant eval-after-load forms.
1687 (mapc #'(lambda (a-l-element)
1688 (when (and (stringp (car a-l-element))
1689 (string-match-p (car a-l-element) abs-file))
1690 ;; discard the file name regexp
1691 (mapc #'eval (cdr a-l-element))))
1693 ;; Complain when the user uses obsolete files.
1694 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
1695 (run-with-timer 0 nil
1697 (message "Package %s is obsolete!"
1699 (string-match "\\.elc?\\>" file))))
1700 (file-name-nondirectory abs-file)))
1701 ;; Finally, run any other hook.
1702 (run-hook-with-args 'after-load-functions abs-file))
1704 (defun eval-next-after-load (file)
1705 "Read the following input sexp, and run it whenever FILE is loaded.
1706 This makes or adds to an entry on `after-load-alist'.
1707 FILE should be the name of a library, with no directory name."
1708 (eval-after-load file (read)))
1709 (make-obsolete 'eval-next-after-load `eval-after-load "23.2")
1713 (defun process-lines (program &rest args)
1714 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1715 Signal an error if the program returns with a non-zero exit status."
1717 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1718 (unless (eq status 0)
1719 (error "%s exited with status %s" program status))
1720 (goto-char (point-min))
1723 (setq lines (cons (buffer-substring-no-properties
1724 (line-beginning-position)
1725 (line-end-position))
1728 (nreverse lines)))))
1730 ;; open-network-stream is a wrapper around make-network-process.
1732 (when (featurep 'make-network-process)
1733 (defun open-network-stream (name buffer host service)
1734 "Open a TCP connection for a service to a host.
1735 Returns a subprocess-object to represent the connection.
1736 Input and output work as for subprocesses; `delete-process' closes it.
1738 NAME is the name for the process. It is modified if necessary to make
1740 BUFFER is the buffer (or buffer name) to associate with the
1741 process. Process output goes at end of that buffer. BUFFER may
1742 be nil, meaning that this process is not associated with any buffer.
1743 HOST is the name or IP address of the host to connect to.
1744 SERVICE is the name of the service desired, or an integer specifying
1745 a port number to connect to.
1747 This is a wrapper around `make-network-process', and only offers a
1748 subset of its functionality."
1749 (make-network-process :name name :buffer buffer
1750 :host host :service service)))
1755 'process-kill-without-query
1756 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1758 (defun process-kill-without-query (process &optional flag)
1759 "Say no query needed if PROCESS is running when Emacs is exited.
1760 Optional second argument if non-nil says to require a query.
1761 Value is t if a query was formerly required."
1762 (let ((old (process-query-on-exit-flag process)))
1763 (set-process-query-on-exit-flag process nil)
1766 (defun process-kill-buffer-query-function ()
1767 "Ask before killing a buffer that has a running process."
1768 (let ((process (get-buffer-process (current-buffer))))
1770 (not (memq (process-status process) '(run stop open listen)))
1771 (not (process-query-on-exit-flag process))
1772 (yes-or-no-p "Buffer has a running process; kill it? "))))
1774 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1776 ;; process plist management
1778 (defun process-get (process propname)
1779 "Return the value of PROCESS' PROPNAME property.
1780 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1781 (plist-get (process-plist process) propname))
1783 (defun process-put (process propname value)
1784 "Change PROCESS' PROPNAME property to VALUE.
1785 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1786 (set-process-plist process
1787 (plist-put (process-plist process) propname value)))
1790 ;;;; Input and display facilities.
1792 (defvar read-quoted-char-radix 8
1793 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1794 Legitimate radix values are 8, 10 and 16.")
1796 (custom-declare-variable-early
1797 'read-quoted-char-radix 8
1798 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1799 Legitimate radix values are 8, 10 and 16."
1800 :type '(choice (const 8) (const 10) (const 16))
1801 :group 'editing-basics)
1803 (defconst read-key-empty-map (make-sparse-keymap))
1805 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
1807 (defun read-key (&optional prompt)
1808 "Read a key from the keyboard.
1809 Contrary to `read-event' this will not return a raw event but instead will
1810 obey the input decoding and translations usually done by `read-key-sequence'.
1811 So escape sequences and keyboard encoding are taken into account.
1812 When there's an ambiguity because the key looks like the prefix of
1813 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1814 (let ((overriding-terminal-local-map read-key-empty-map)
1815 (overriding-local-map nil)
1816 (old-global-map (current-global-map))
1817 (timer (run-with-idle-timer
1818 ;; Wait long enough that Emacs has the time to receive and
1819 ;; process all the raw events associated with the single-key.
1820 ;; But don't wait too long, or the user may find the delay
1821 ;; annoying (or keep hitting more keys which may then get
1822 ;; lost or misinterpreted).
1823 ;; This is only relevant for keys which Emacs perceives as
1824 ;; "prefixes", such as C-x (because of the C-x 8 map in
1825 ;; key-translate-table and the C-x @ map in function-key-map)
1826 ;; or ESC (because of terminal escape sequences in
1827 ;; input-decode-map).
1830 (let ((keys (this-command-keys-vector)))
1831 (unless (zerop (length keys))
1832 ;; `keys' is non-empty, so the user has hit at least
1833 ;; one key; there's no point waiting any longer, even
1834 ;; though read-key-sequence thinks we should wait
1835 ;; for more input to decide how to interpret the
1837 (throw 'read-key keys)))))))
1840 (use-global-map read-key-empty-map)
1841 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
1842 (cancel-timer timer)
1843 (use-global-map old-global-map))))
1845 (defun read-quoted-char (&optional prompt)
1846 "Like `read-char', but do not allow quitting.
1847 Also, if the first character read is an octal digit,
1848 we read any number of octal digits and return the
1849 specified character code. Any nondigit terminates the sequence.
1850 If the terminator is RET, it is discarded;
1851 any other terminator is used itself as input.
1853 The optional argument PROMPT specifies a string to use to prompt the user.
1854 The variable `read-quoted-char-radix' controls which radix to use
1856 (let ((message-log-max nil) done (first t) (code 0) char translated)
1858 (let ((inhibit-quit first)
1859 ;; Don't let C-h get the help message--only help function keys.
1862 "Type the special character you want to use,
1863 or the octal character code.
1864 RET terminates the character code and is discarded;
1865 any other non-digit terminates the character code and is then used as input."))
1866 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1867 (if inhibit-quit (setq quit-flag nil)))
1868 ;; Translate TAB key into control-I ASCII character, and so on.
1869 ;; Note: `read-char' does it using the `ascii-character' property.
1870 ;; We could try and use read-key-sequence instead, but then C-q ESC
1871 ;; or C-q C-x might not return immediately since ESC or C-x might be
1872 ;; bound to some prefix in function-key-map or key-translation-map.
1875 (char-resolve-modifiers char)
1877 (let ((translation (lookup-key local-function-key-map (vector char))))
1878 (if (arrayp translation)
1879 (setq translated (aref translation 0))))
1880 (cond ((null translated))
1881 ((not (integerp translated))
1882 (setq unread-command-events (list char)
1884 ((/= (logand translated ?\M-\^@) 0)
1885 ;; Turn a meta-character into a character with the 0200 bit set.
1886 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1888 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1889 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1890 (and prompt (setq prompt (message "%s %c" prompt translated))))
1891 ((and (<= ?a (downcase translated))
1892 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1893 (setq code (+ (* code read-quoted-char-radix)
1894 (+ 10 (- (downcase translated) ?a))))
1895 (and prompt (setq prompt (message "%s %c" prompt translated))))
1896 ((and (not first) (eq translated ?\C-m))
1899 (setq unread-command-events (list char)
1901 (t (setq code translated
1906 (defun read-passwd (prompt &optional confirm default)
1907 "Read a password, prompting with PROMPT, and return it.
1908 If optional CONFIRM is non-nil, read the password twice to make sure.
1909 Optional DEFAULT is a default password to use instead of empty input.
1911 This function echoes `.' for each character that the user types.
1913 The user ends with RET, LFD, or ESC. DEL or C-h rubs out.
1914 C-y yanks the current kill. C-u kills line.
1915 C-g quits; if `inhibit-quit' was non-nil around this function,
1916 then it returns nil if the user types C-g, but quit-flag remains set.
1918 Once the caller uses the password, it can erase the password
1919 by doing (clear-string STRING)."
1923 (while (not success)
1924 (let ((first (read-passwd prompt nil default))
1925 (second (read-passwd "Confirm password: " nil default)))
1926 (if (equal first second)
1928 (and (arrayp second) (clear-string second))
1929 (setq success first))
1930 (and (arrayp first) (clear-string first))
1931 (and (arrayp second) (clear-string second))
1932 (message "Password not repeated accurately; please start over")
1936 ;; Copy it so that add-text-properties won't modify
1937 ;; the object that was passed in by the caller.
1938 (prompt (copy-sequence prompt))
1941 (cursor-in-echo-area t)
1942 (message-log-max nil)
1943 (stop-keys (list 'return ?\r ?\n ?\e))
1944 (rubout-keys (list 'backspace ?\b ?\177)))
1945 (add-text-properties 0 (length prompt)
1946 minibuffer-prompt-properties prompt)
1947 (while (progn (message "%s%s"
1949 (make-string (length pass) ?.))
1951 (not (memq c stop-keys)))
1952 (clear-this-command-keys)
1953 (cond ((memq c rubout-keys) ; rubout
1954 (when (> (length pass) 0)
1955 (let ((new-pass (substring pass 0 -1)))
1956 (and (arrayp pass) (clear-string pass))
1957 (setq pass new-pass))))
1958 ((eq c ?\C-g) (keyboard-quit))
1960 ((= c ?\C-u) ; kill line
1961 (and (arrayp pass) (clear-string pass))
1964 (let* ((str (condition-case nil
1971 (substring-no-properties str)))
1972 (and (arrayp pass) (clear-string pass))
1974 (setq pass new-pass))))
1975 ((characterp c) ; insert char
1976 (let* ((new-char (char-to-string c))
1977 (new-pass (concat pass new-char)))
1978 (and (arrayp pass) (clear-string pass))
1979 (clear-string new-char)
1981 (setq pass new-pass)))))
1983 (or pass default "")))))
1985 ;; This should be used by `call-interactively' for `n' specs.
1986 (defun read-number (prompt &optional default)
1987 "Read a numeric value in the minibuffer, prompting with PROMPT.
1988 DEFAULT specifies a default value to return if the user just types RET.
1989 The value of DEFAULT is inserted into PROMPT."
1993 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1994 (replace-match (format " (default %s)" default) t t prompt 1)
1995 (replace-regexp-in-string "[ \t]*\\'"
1996 (format " (default %s) " default)
2000 (let ((str (read-from-minibuffer prompt nil nil nil nil
2002 (number-to-string default)))))
2005 ((zerop (length str)) default)
2006 ((stringp str) (read str))))
2009 (message "Please enter a number.")
2014 (defun sit-for (seconds &optional nodisp obsolete)
2015 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2016 SECONDS may be a floating-point value.
2017 \(On operating systems that do not support waiting for fractions of a
2018 second, floating-point values are rounded down to the nearest integer.)
2020 If optional arg NODISP is t, don't redisplay, just wait for input.
2021 Redisplay does not happen if input is available before it starts.
2023 Value is t if waited the full time with no input arriving, and nil otherwise.
2025 An obsolete, but still supported form is
2026 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2027 where the optional arg MILLISECONDS specifies an additional wait period,
2028 in milliseconds; this was useful when Emacs was built without
2029 floating point support."
2030 (if (numberp nodisp)
2031 (setq seconds (+ seconds (* 1e-3 nodisp))
2033 (if obsolete (setq nodisp obsolete)))
2041 (or nodisp (redisplay)))
2043 (or nodisp (redisplay))
2044 (let ((read (read-event nil nil seconds)))
2047 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2048 ;; unread-command-events as (t . EVENT) so it will be added to
2049 ;; this-command-keys by read-key-sequence.
2050 (if (eq overriding-terminal-local-map universal-argument-map)
2051 (setq read (cons t read)))
2052 (push read unread-command-events)
2054 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp))
2056 ;;; Atomic change groups.
2058 (defmacro atomic-change-group (&rest body)
2059 "Perform BODY as an atomic change group.
2060 This means that if BODY exits abnormally,
2061 all of its changes to the current buffer are undone.
2062 This works regardless of whether undo is enabled in the buffer.
2064 This mechanism is transparent to ordinary use of undo;
2065 if undo is enabled in the buffer and BODY succeeds, the
2066 user can undo the change normally."
2067 (declare (indent 0) (debug t))
2068 (let ((handle (make-symbol "--change-group-handle--"))
2069 (success (make-symbol "--change-group-success--")))
2070 `(let ((,handle (prepare-change-group))
2071 ;; Don't truncate any undo data in the middle of this.
2072 (undo-outer-limit nil)
2073 (undo-limit most-positive-fixnum)
2074 (undo-strong-limit most-positive-fixnum)
2078 ;; This is inside the unwind-protect because
2079 ;; it enables undo if that was disabled; we need
2080 ;; to make sure that it gets disabled again.
2081 (activate-change-group ,handle)
2084 ;; Either of these functions will disable undo
2085 ;; if it was disabled before.
2087 (accept-change-group ,handle)
2088 (cancel-change-group ,handle))))))
2090 (defun prepare-change-group (&optional buffer)
2091 "Return a handle for the current buffer's state, for a change group.
2092 If you specify BUFFER, make a handle for BUFFER's state instead.
2094 Pass the handle to `activate-change-group' afterward to initiate
2095 the actual changes of the change group.
2097 To finish the change group, call either `accept-change-group' or
2098 `cancel-change-group' passing the same handle as argument. Call
2099 `accept-change-group' to accept the changes in the group as final;
2100 call `cancel-change-group' to undo them all. You should use
2101 `unwind-protect' to make sure the group is always finished. The call
2102 to `activate-change-group' should be inside the `unwind-protect'.
2103 Once you finish the group, don't use the handle again--don't try to
2104 finish the same group twice. For a simple example of correct use, see
2105 the source code of `atomic-change-group'.
2107 The handle records only the specified buffer. To make a multibuffer
2108 change group, call this function once for each buffer you want to
2109 cover, then use `nconc' to combine the returned values, like this:
2111 (nconc (prepare-change-group buffer-1)
2112 (prepare-change-group buffer-2))
2114 You can then activate that multibuffer change group with a single
2115 call to `activate-change-group' and finish it with a single call
2116 to `accept-change-group' or `cancel-change-group'."
2119 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2120 (list (cons (current-buffer) buffer-undo-list))))
2122 (defun activate-change-group (handle)
2123 "Activate a change group made with `prepare-change-group' (which see)."
2124 (dolist (elt handle)
2125 (with-current-buffer (car elt)
2126 (if (eq buffer-undo-list t)
2127 (setq buffer-undo-list nil)))))
2129 (defun accept-change-group (handle)
2130 "Finish a change group made with `prepare-change-group' (which see).
2131 This finishes the change group by accepting its changes as final."
2132 (dolist (elt handle)
2133 (with-current-buffer (car elt)
2135 (setq buffer-undo-list t)))))
2137 (defun cancel-change-group (handle)
2138 "Finish a change group made with `prepare-change-group' (which see).
2139 This finishes the change group by reverting all of its changes."
2140 (dolist (elt handle)
2141 (with-current-buffer (car elt)
2142 (setq elt (cdr elt))
2144 ;; Widen buffer temporarily so if the buffer was narrowed within
2145 ;; the body of `atomic-change-group' all changes can be undone.
2148 (if (consp elt) (car elt)))
2150 (if (consp elt) (cdr elt))))
2151 ;; Temporarily truncate the undo log at ELT.
2153 (setcar elt nil) (setcdr elt nil))
2154 (unless (eq last-command 'undo) (undo-start))
2155 ;; Make sure there's no confusion.
2156 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2157 (error "Undoing to some unrelated state"))
2160 (while (listp pending-undo-list) (undo-more 1)))
2161 ;; Reset the modified cons cell ELT to its original content.
2163 (setcar elt old-car)
2164 (setcdr elt old-cdr))
2165 ;; Revert the undo info to what it was when we grabbed the state.
2166 (setq buffer-undo-list elt))))))
2168 ;;;; Display-related functions.
2170 ;; For compatibility.
2171 (defalias 'redraw-modeline 'force-mode-line-update)
2173 (defun force-mode-line-update (&optional all)
2174 "Force redisplay of the current buffer's mode line and header line.
2175 With optional non-nil ALL, force redisplay of all mode lines and
2176 header lines. This function also forces recomputation of the
2177 menu bar menus and the frame title."
2178 (if all (with-current-buffer (other-buffer)))
2179 (set-buffer-modified-p (buffer-modified-p)))
2181 (defun momentary-string-display (string pos &optional exit-char message)
2182 "Momentarily display STRING in the buffer at POS.
2183 Display remains until next event is input.
2184 If POS is a marker, only its position is used; its buffer is ignored.
2185 Optional third arg EXIT-CHAR can be a character, event or event
2186 description list. EXIT-CHAR defaults to SPC. If the input is
2187 EXIT-CHAR it is swallowed; otherwise it is then available as
2188 input (as a command if nothing else).
2189 Display MESSAGE (optional fourth arg) in the echo area.
2190 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2191 (or exit-char (setq exit-char ?\s))
2192 (let ((ol (make-overlay pos pos))
2193 (message (copy-sequence string)))
2197 (overlay-put ol 'after-string message)
2199 ;; To avoid trouble with out-of-bounds position
2201 ;; If the message end is off screen, recenter now.
2202 (if (<= (window-end nil t) pos)
2203 (recenter (/ (window-height) 2))))
2204 (message (or message "Type %s to continue editing.")
2205 (single-key-description exit-char))
2207 (if (integerp exit-char)
2210 (setq char (read-char))
2211 (or (eq char exit-char)
2212 (setq unread-command-events (list char))))
2214 ;; `exit-char' is a character, hence it differs
2215 ;; from char, which is an event.
2216 (setq unread-command-events (list char))))
2217 ;; `exit-char' can be an event, or an event description list.
2218 (setq char (read-event))
2219 (or (eq char exit-char)
2220 (eq char (event-convert-list exit-char))
2221 (setq unread-command-events (list char))))))
2222 (delete-overlay ol))))
2225 ;;;; Overlay operations
2227 (defun copy-overlay (o)
2228 "Return a copy of overlay O."
2229 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
2230 ;; FIXME: there's no easy way to find the
2231 ;; insertion-type of the two markers.
2232 (overlay-buffer o)))
2233 (props (overlay-properties o)))
2235 (overlay-put o1 (pop props) (pop props)))
2238 (defun remove-overlays (&optional beg end name val)
2239 "Clear BEG and END of overlays whose property NAME has value VAL.
2240 Overlays might be moved and/or split.
2241 BEG and END default respectively to the beginning and end of buffer."
2242 ;; This speeds up the loops over overlays.
2243 (unless beg (setq beg (point-min)))
2244 (unless end (setq end (point-max)))
2245 (overlay-recenter end)
2247 (setq beg (prog1 end (setq end beg))))
2249 (dolist (o (overlays-in beg end))
2250 (when (eq (overlay-get o name) val)
2251 ;; Either push this overlay outside beg...end
2252 ;; or split it to exclude beg...end
2253 ;; or delete it entirely (if it is contained in beg...end).
2254 (if (< (overlay-start o) beg)
2255 (if (> (overlay-end o) end)
2257 (move-overlay (copy-overlay o)
2258 (overlay-start o) beg)
2259 (move-overlay o end (overlay-end o)))
2260 (move-overlay o (overlay-start o) beg))
2261 (if (> (overlay-end o) end)
2262 (move-overlay o end (overlay-end o))
2263 (delete-overlay o)))))))
2267 (defvar suspend-hook nil
2268 "Normal hook run by `suspend-emacs', before suspending.")
2270 (defvar suspend-resume-hook nil
2271 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2273 (defvar temp-buffer-show-hook nil
2274 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2275 When the hook runs, the temporary buffer is current, and the window it
2276 was displayed in is selected.")
2278 (defvar temp-buffer-setup-hook nil
2279 "Normal hook run by `with-output-to-temp-buffer' at the start.
2280 When the hook runs, the temporary buffer is current.
2281 This hook is normally set up with a function to put the buffer in Help
2284 ;; Avoid compiler warnings about this variable,
2285 ;; which has a special meaning on certain system types.
2286 (defvar buffer-file-type nil
2287 "Non-nil if the visited file is a binary file.
2288 This variable is meaningful on MS-DOG and Windows NT.
2289 On those systems, it is automatically local in every buffer.
2290 On other systems, this variable is normally always nil.")
2292 ;; The `assert' macro from the cl package signals
2293 ;; `cl-assertion-failed' at runtime so always define it.
2294 (put 'cl-assertion-failed 'error-conditions '(error))
2295 (put 'cl-assertion-failed 'error-message "Assertion failed")
2297 (defconst user-emacs-directory
2298 (if (eq system-type 'ms-dos)
2299 ;; MS-DOS cannot have initial dot.
2302 "Directory beneath which additional per-user Emacs-specific files are placed.
2303 Various programs in Emacs store information in this directory.
2304 Note that this should end with a directory separator.
2305 See also `locate-user-emacs-file'.")
2307 (defun locate-user-emacs-file (new-name &optional old-name)
2308 "Return an absolute per-user Emacs-specific file name.
2309 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2310 Else return NEW-NAME in `user-emacs-directory', creating the
2311 directory if it does not exist."
2312 (convert-standard-filename
2313 (let* ((home (concat "~" (or init-file-user "")))
2314 (at-home (and old-name (expand-file-name old-name home))))
2315 (if (and at-home (file-readable-p at-home))
2317 ;; Make sure `user-emacs-directory' exists,
2318 ;; unless we're in batch mode or dumping Emacs
2321 (file-accessible-directory-p (directory-file-name user-emacs-directory))
2322 (make-directory user-emacs-directory))
2323 (abbreviate-file-name
2324 (expand-file-name new-name user-emacs-directory))))))
2327 ;;;; Misc. useful functions.
2329 (defun find-tag-default ()
2330 "Determine default tag to search for, based on text at point.
2331 If there is no plausible default, return nil."
2332 (let (from to bound)
2334 ;; Look at text around `point'.
2336 (skip-syntax-backward "w_") (setq from (point)))
2338 (skip-syntax-forward "w_") (setq to (point)))
2340 ;; Look between `line-beginning-position' and `point'.
2342 (and (setq bound (line-beginning-position))
2343 (skip-syntax-backward "^w_" bound)
2344 (> (setq to (point)) bound)
2345 (skip-syntax-backward "w_")
2346 (setq from (point))))
2347 ;; Look between `point' and `line-end-position'.
2349 (and (setq bound (line-end-position))
2350 (skip-syntax-forward "^w_" bound)
2351 (< (setq from (point)) bound)
2352 (skip-syntax-forward "w_")
2353 (setq to (point)))))
2354 (buffer-substring-no-properties from to))))
2356 (defun play-sound (sound)
2357 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2358 The following keywords are recognized:
2360 :file FILE - read sound data from FILE. If FILE isn't an
2361 absolute file name, it is searched in `data-directory'.
2363 :data DATA - read sound data from string DATA.
2365 Exactly one of :file or :data must be present.
2367 :volume VOL - set volume to VOL. VOL must an integer in the
2368 range 0..100 or a float in the range 0..1.0. If not specified,
2369 don't change the volume setting of the sound device.
2371 :device DEVICE - play sound on DEVICE. If not specified,
2372 a system-dependent default device name is used.
2374 Note: :data and :device are currently not supported on Windows."
2375 (if (fboundp 'play-sound-internal)
2376 (play-sound-internal sound)
2377 (error "This Emacs binary lacks sound support")))
2379 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2381 (defun shell-quote-argument (argument)
2382 "Quote ARGUMENT for passing as argument to an inferior shell."
2383 (if (or (eq system-type 'ms-dos)
2384 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2385 ;; Quote using double quotes, but escape any existing quotes in
2386 ;; the argument with backslashes.
2390 (if (or (null (string-match "[^\"]" argument))
2391 (< (match-end 0) (length argument)))
2392 (while (string-match "[\"]" argument start)
2393 (setq end (match-beginning 0)
2394 result (concat result (substring argument start end)
2395 "\\" (substring argument end (1+ end)))
2397 (concat "\"" result (substring argument start) "\""))
2398 (if (equal argument "")
2400 ;; Quote everything except POSIX filename characters.
2401 ;; This should be safe enough even for really weird shells.
2402 (let ((result "") (start 0) end)
2403 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2404 (setq end (match-beginning 0)
2405 result (concat result (substring argument start end)
2406 "\\" (substring argument end (1+ end)))
2408 (concat result (substring argument start))))))
2410 (defun string-or-null-p (object)
2411 "Return t if OBJECT is a string or nil.
2412 Otherwise, return nil."
2413 (or (stringp object) (null object)))
2415 (defun booleanp (object)
2416 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2417 (memq object '(nil t)))
2419 (defun field-at-pos (pos)
2420 "Return the field at position POS, taking stickiness etc into account."
2421 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2422 (if (eq raw-field 'boundary)
2423 (get-char-property (1- (field-end pos)) 'field)
2427 ;;;; Support for yanking and text properties.
2429 (defvar yank-excluded-properties)
2431 (defun remove-yank-excluded-properties (start end)
2432 "Remove `yank-excluded-properties' between START and END positions.
2433 Replaces `category' properties with their defined properties."
2434 (let ((inhibit-read-only t))
2435 ;; Replace any `category' property with the properties it stands for.
2436 (unless (memq yank-excluded-properties '(t nil))
2439 (while (< (point) end)
2440 (let ((cat (get-text-property (point) 'category))
2443 (next-single-property-change (point) 'category nil end))
2445 (let (run-end2 original)
2446 (remove-list-of-text-properties (point) run-end '(category))
2447 (while (< (point) run-end)
2448 (setq run-end2 (next-property-change (point) nil run-end))
2449 (setq original (text-properties-at (point)))
2450 (set-text-properties (point) run-end2 (symbol-plist cat))
2451 (add-text-properties (point) run-end2 original)
2452 (goto-char run-end2))))
2453 (goto-char run-end)))))
2454 (if (eq yank-excluded-properties t)
2455 (set-text-properties start end nil)
2456 (remove-list-of-text-properties start end yank-excluded-properties))))
2458 (defvar yank-undo-function)
2460 (defun insert-for-yank (string)
2461 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2463 See `insert-for-yank-1' for more details."
2465 (while (setq to (next-single-property-change 0 'yank-handler string))
2466 (insert-for-yank-1 (substring string 0 to))
2467 (setq string (substring string to))))
2468 (insert-for-yank-1 string))
2470 (defun insert-for-yank-1 (string)
2471 "Insert STRING at point, stripping some text properties.
2473 Strip text properties from the inserted text according to
2474 `yank-excluded-properties'. Otherwise just like (insert STRING).
2476 If STRING has a non-nil `yank-handler' property on the first character,
2477 the normal insert behavior is modified in various ways. The value of
2478 the yank-handler property must be a list with one to four elements
2479 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2480 When FUNCTION is present and non-nil, it is called instead of `insert'
2481 to insert the string. FUNCTION takes one argument--the object to insert.
2482 If PARAM is present and non-nil, it replaces STRING as the object
2483 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2484 `yank-rectangle', PARAM may be a list of strings to insert as a
2486 If NOEXCLUDE is present and non-nil, the normal removal of the
2487 yank-excluded-properties is not performed; instead FUNCTION is
2488 responsible for removing those properties. This may be necessary
2489 if FUNCTION adjusts point before or after inserting the object.
2490 If UNDO is present and non-nil, it is a function that will be called
2491 by `yank-pop' to undo the insertion of the current object. It is
2492 called with two arguments, the start and end of the current region.
2493 FUNCTION may set `yank-undo-function' to override the UNDO value."
2494 (let* ((handler (and (stringp string)
2495 (get-text-property 0 'yank-handler string)))
2496 (param (or (nth 1 handler) string))
2498 (inhibit-read-only inhibit-read-only)
2501 (setq yank-undo-function t)
2502 (if (nth 0 handler) ;; FUNCTION
2503 (funcall (car handler) param)
2507 ;; Prevent read-only properties from interfering with the
2508 ;; following text property changes.
2509 (setq inhibit-read-only t)
2511 ;; What should we do with `font-lock-face' properties?
2512 (if font-lock-defaults
2513 ;; No, just wipe them.
2514 (remove-list-of-text-properties opoint end '(font-lock-face))
2515 ;; Convert them to `face'.
2518 (while (< (point) end)
2519 (let ((face (get-text-property (point) 'font-lock-face))
2522 (next-single-property-change (point) 'font-lock-face nil end))
2524 (remove-text-properties (point) run-end '(font-lock-face nil))
2525 (put-text-property (point) run-end 'face face))
2526 (goto-char run-end)))))
2528 (unless (nth 2 handler) ;; NOEXCLUDE
2529 (remove-yank-excluded-properties opoint (point)))
2531 ;; If last inserted char has properties, mark them as rear-nonsticky.
2532 (if (and (> end opoint)
2533 (text-properties-at (1- end)))
2534 (put-text-property (1- end) end 'rear-nonsticky t))
2536 (if (eq yank-undo-function t) ;; not set by FUNCTION
2537 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2538 (if (nth 4 handler) ;; COMMAND
2539 (setq this-command (nth 4 handler)))))
2541 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2542 "Insert before point a substring of BUFFER, without text properties.
2543 BUFFER may be a buffer or a buffer name.
2544 Arguments START and END are character positions specifying the substring.
2545 They default to the values of (point-min) and (point-max) in BUFFER."
2546 (let ((opoint (point)))
2547 (insert-buffer-substring buffer start end)
2548 (let ((inhibit-read-only t))
2549 (set-text-properties opoint (point) nil))))
2551 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2552 "Insert before point a part of BUFFER, stripping some text properties.
2553 BUFFER may be a buffer or a buffer name.
2554 Arguments START and END are character positions specifying the substring.
2555 They default to the values of (point-min) and (point-max) in BUFFER.
2556 Strip text properties from the inserted text according to
2557 `yank-excluded-properties'."
2558 ;; Since the buffer text should not normally have yank-handler properties,
2559 ;; there is no need to handle them here.
2560 (let ((opoint (point)))
2561 (insert-buffer-substring buffer start end)
2562 (remove-yank-excluded-properties opoint (point))))
2565 ;;;; Synchronous shell commands.
2567 (defun start-process-shell-command (name buffer &rest args)
2568 "Start a program in a subprocess. Return the process object for it.
2569 NAME is name for process. It is modified if necessary to make it unique.
2570 BUFFER is the buffer (or buffer name) to associate with the process.
2571 Process output goes at end of that buffer, unless you specify
2572 an output stream or filter function to handle the output.
2573 BUFFER may be also nil, meaning that this process is not associated
2575 COMMAND is the shell command to run.
2577 An old calling convention accepted any number of arguments after COMMAND,
2578 which were just concatenated to COMMAND. This is still supported but strongly
2580 ;; We used to use `exec' to replace the shell with the command,
2581 ;; but that failed to handle (...) and semicolon, etc.
2582 (start-process name buffer shell-file-name shell-command-switch
2583 (mapconcat 'identity args " ")))
2584 (set-advertised-calling-convention 'start-process-shell-command
2585 '(name buffer command))
2587 (defun start-file-process-shell-command (name buffer &rest args)
2588 "Start a program in a subprocess. Return the process object for it.
2589 Similar to `start-process-shell-command', but calls `start-file-process'."
2592 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2593 (if (file-remote-p default-directory) "-c" shell-command-switch)
2594 (mapconcat 'identity args " ")))
2595 (set-advertised-calling-convention 'start-file-process-shell-command
2596 '(name buffer command))
2598 (defun call-process-shell-command (command &optional infile buffer display
2600 "Execute the shell command COMMAND synchronously in separate process.
2601 The remaining arguments are optional.
2602 The program's input comes from file INFILE (nil means `/dev/null').
2603 Insert output in BUFFER before point; t means current buffer;
2604 nil for BUFFER means discard it; 0 means discard and don't wait.
2605 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2606 REAL-BUFFER says what to do with standard output, as above,
2607 while STDERR-FILE says what to do with standard error in the child.
2608 STDERR-FILE may be nil (discard standard error output),
2609 t (mix it with ordinary output), or a file name string.
2611 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2612 Remaining arguments are strings passed as additional arguments for COMMAND.
2613 Wildcards and redirection are handled as usual in the shell.
2615 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2616 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2617 status or a signal description string.
2618 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2619 ;; We used to use `exec' to replace the shell with the command,
2620 ;; but that failed to handle (...) and semicolon, etc.
2621 (call-process shell-file-name
2622 infile buffer display
2623 shell-command-switch
2624 (mapconcat 'identity (cons command args) " ")))
2626 (defun process-file-shell-command (command &optional infile buffer display
2628 "Process files synchronously in a separate process.
2629 Similar to `call-process-shell-command', but calls `process-file'."
2631 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2632 infile buffer display
2633 (if (file-remote-p default-directory) "-c" shell-command-switch)
2634 (mapconcat 'identity (cons command args) " ")))
2636 ;;;; Lisp macros to do various things temporarily.
2638 (defmacro with-current-buffer (buffer-or-name &rest body)
2639 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2640 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2641 The value returned is the value of the last form in BODY. See
2642 also `with-temp-buffer'."
2643 (declare (indent 1) (debug t))
2644 `(save-current-buffer
2645 (set-buffer ,buffer-or-name)
2648 (defmacro with-selected-window (window &rest body)
2649 "Execute the forms in BODY with WINDOW as the selected window.
2650 The value returned is the value of the last form in BODY.
2652 This macro saves and restores the selected window, as well as the
2653 selected window of each frame. It does not change the order of
2654 recently selected windows. If the previously selected window of
2655 some frame is no longer live at the end of BODY, that frame's
2656 selected window is left alone. If the selected window is no
2657 longer live, then whatever window is selected at the end of BODY
2660 This macro uses `save-current-buffer' to save and restore the
2661 current buffer, since otherwise its normal operation could
2662 potentially make a different buffer current. It does not alter
2663 the buffer list ordering."
2664 (declare (indent 1) (debug t))
2665 ;; Most of this code is a copy of save-selected-window.
2666 `(let ((save-selected-window-window (selected-window))
2667 ;; It is necessary to save all of these, because calling
2668 ;; select-window changes frame-selected-window for whatever
2669 ;; frame that window is in.
2670 (save-selected-window-alist
2671 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2673 (save-current-buffer
2675 (progn (select-window ,window 'norecord)
2677 (dolist (elt save-selected-window-alist)
2678 (and (frame-live-p (car elt))
2679 (window-live-p (cadr elt))
2680 (set-frame-selected-window (car elt) (cadr elt) 'norecord)))
2681 (when (window-live-p save-selected-window-window)
2682 (select-window save-selected-window-window 'norecord))))))
2684 (defmacro with-selected-frame (frame &rest body)
2685 "Execute the forms in BODY with FRAME as the selected frame.
2686 The value returned is the value of the last form in BODY.
2688 This macro neither changes the order of recently selected windows
2689 nor the buffer list."
2690 (declare (indent 1) (debug t))
2691 (let ((old-frame (make-symbol "old-frame"))
2692 (old-buffer (make-symbol "old-buffer")))
2693 `(let ((,old-frame (selected-frame))
2694 (,old-buffer (current-buffer)))
2696 (progn (select-frame ,frame 'norecord)
2698 (when (frame-live-p ,old-frame)
2699 (select-frame ,old-frame 'norecord))
2700 (when (buffer-live-p ,old-buffer)
2701 (set-buffer ,old-buffer))))))
2703 (defmacro with-temp-file (file &rest body)
2704 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2705 The value returned is the value of the last form in BODY.
2706 See also `with-temp-buffer'."
2708 (let ((temp-file (make-symbol "temp-file"))
2709 (temp-buffer (make-symbol "temp-buffer")))
2710 `(let ((,temp-file ,file)
2712 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2715 (with-current-buffer ,temp-buffer
2717 (with-current-buffer ,temp-buffer
2718 (write-region nil nil ,temp-file nil 0)))
2719 (and (buffer-name ,temp-buffer)
2720 (kill-buffer ,temp-buffer))))))
2722 (defmacro with-temp-message (message &rest body)
2723 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2724 The original message is restored to the echo area after BODY has finished.
2725 The value returned is the value of the last form in BODY.
2726 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2727 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2728 Use a MESSAGE of \"\" to temporarily clear the echo area."
2730 (let ((current-message (make-symbol "current-message"))
2731 (temp-message (make-symbol "with-temp-message")))
2732 `(let ((,temp-message ,message)
2737 (setq ,current-message (current-message))
2738 (message "%s" ,temp-message))
2741 (if ,current-message
2742 (message "%s" ,current-message)
2745 (defmacro with-temp-buffer (&rest body)
2746 "Create a temporary buffer, and evaluate BODY there like `progn'.
2747 See also `with-temp-file' and `with-output-to-string'."
2748 (declare (indent 0) (debug t))
2749 (let ((temp-buffer (make-symbol "temp-buffer")))
2750 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2751 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
2752 (with-current-buffer ,temp-buffer
2755 (and (buffer-name ,temp-buffer)
2756 (kill-buffer ,temp-buffer)))))))
2758 (defmacro with-silent-modifications (&rest body)
2759 "Execute BODY, pretending it does not modifies the buffer.
2760 If BODY performs real modifications to the buffer's text, other
2761 than cosmetic ones, undo data may become corrupted.
2762 Typically used around modifications of text-properties which do not really
2763 affect the buffer's content."
2764 (declare (debug t) (indent 0))
2765 (let ((modified (make-symbol "modified")))
2766 `(let* ((,modified (buffer-modified-p))
2767 (buffer-undo-list t)
2768 (inhibit-read-only t)
2769 (inhibit-modification-hooks t)
2771 ;; Avoid setting and removing file locks and checking
2772 ;; buffer's uptodate-ness w.r.t the underlying file.
2774 buffer-file-truename)
2779 (restore-buffer-modified-p nil))))))
2781 (defmacro with-output-to-string (&rest body)
2782 "Execute BODY, return the text it sent to `standard-output', as a string."
2783 (declare (indent 0) (debug t))
2784 `(let ((standard-output
2785 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2788 (let ((standard-output standard-output))
2790 (with-current-buffer standard-output
2792 (kill-buffer standard-output))))
2794 (defmacro with-local-quit (&rest body)
2795 "Execute BODY, allowing quits to terminate BODY but not escape further.
2796 When a quit terminates BODY, `with-local-quit' returns nil but
2797 requests another quit. That quit will be processed as soon as quitting
2798 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2799 (declare (debug t) (indent 0))
2800 `(condition-case nil
2801 (let ((inhibit-quit nil))
2803 (quit (setq quit-flag t)
2804 ;; This call is to give a chance to handle quit-flag
2805 ;; in case inhibit-quit is nil.
2806 ;; Without this, it will not be handled until the next function
2807 ;; call, and that might allow it to exit thru a condition-case
2808 ;; that intends to handle the quit signal next time.
2809 (eval '(ignore nil)))))
2811 (defmacro while-no-input (&rest body)
2812 "Execute BODY only as long as there's no pending input.
2813 If input arrives, that ends the execution of BODY,
2814 and `while-no-input' returns t. Quitting makes it return nil.
2815 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2816 (declare (debug t) (indent 0))
2817 (let ((catch-sym (make-symbol "input")))
2820 (let ((throw-on-input ',catch-sym))
2821 (or (input-pending-p)
2822 (progn ,@body)))))))
2824 (defmacro condition-case-no-debug (var bodyform &rest handlers)
2825 "Like `condition-case' except that it does not catch anything when debugging.
2826 More specifically if `debug-on-error' is set, then it does not catch any signal."
2827 (declare (debug condition-case) (indent 2))
2828 (let ((bodysym (make-symbol "body")))
2829 `(let ((,bodysym (lambda () ,bodyform)))
2832 (condition-case ,var
2836 (defmacro with-demoted-errors (&rest body)
2837 "Run BODY and demote any errors to simple messages.
2838 If `debug-on-error' is non-nil, run BODY without catching its errors.
2839 This is to be used around code which is not expected to signal an error
2840 but which should be robust in the unexpected case that an error is signaled."
2841 (declare (debug t) (indent 0))
2842 (let ((err (make-symbol "err")))
2843 `(condition-case-no-debug ,err
2845 (error (message "Error: %s" ,err) nil))))
2847 (defmacro combine-after-change-calls (&rest body)
2848 "Execute BODY, but don't call the after-change functions till the end.
2849 If BODY makes changes in the buffer, they are recorded
2850 and the functions on `after-change-functions' are called several times
2851 when BODY is finished.
2852 The return value is the value of the last form in BODY.
2854 If `before-change-functions' is non-nil, then calls to the after-change
2855 functions can't be deferred, so in that case this macro has no effect.
2857 Do not alter `after-change-functions' or `before-change-functions'
2859 (declare (indent 0) (debug t))
2861 (let ((combine-after-change-calls t))
2863 (combine-after-change-execute)))
2865 (defmacro with-case-table (table &rest body)
2866 "Execute the forms in BODY with TABLE as the current case table.
2867 The value returned is the value of the last form in BODY."
2868 (declare (indent 1) (debug t))
2869 (let ((old-case-table (make-symbol "table"))
2870 (old-buffer (make-symbol "buffer")))
2871 `(let ((,old-case-table (current-case-table))
2872 (,old-buffer (current-buffer)))
2874 (progn (set-case-table ,table)
2876 (with-current-buffer ,old-buffer
2877 (set-case-table ,old-case-table))))))
2879 ;;; Matching and match data.
2881 (defvar save-match-data-internal)
2883 ;; We use save-match-data-internal as the local variable because
2884 ;; that works ok in practice (people should not use that variable elsewhere).
2885 ;; We used to use an uninterned symbol; the compiler handles that properly
2886 ;; now, but it generates slower code.
2887 (defmacro save-match-data (&rest body)
2888 "Execute the BODY forms, restoring the global value of the match data.
2889 The value returned is the value of the last form in BODY."
2890 ;; It is better not to use backquote here,
2891 ;; because that makes a bootstrapping problem
2892 ;; if you need to recompile all the Lisp files using interpreted code.
2893 (declare (indent 0) (debug t))
2895 '((save-match-data-internal (match-data)))
2896 (list 'unwind-protect
2898 ;; It is safe to free (evaporate) markers immediately here,
2899 ;; as Lisp programs should not copy from save-match-data-internal.
2900 '(set-match-data save-match-data-internal 'evaporate))))
2902 (defun match-string (num &optional string)
2903 "Return string of text matched by last search.
2904 NUM specifies which parenthesized expression in the last regexp.
2905 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2906 Zero means the entire text matched by the whole regexp or whole string.
2907 STRING should be given if the last search was by `string-match' on STRING."
2908 (if (match-beginning num)
2910 (substring string (match-beginning num) (match-end num))
2911 (buffer-substring (match-beginning num) (match-end num)))))
2913 (defun match-string-no-properties (num &optional string)
2914 "Return string of text matched by last search, without text properties.
2915 NUM specifies which parenthesized expression in the last regexp.
2916 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2917 Zero means the entire text matched by the whole regexp or whole string.
2918 STRING should be given if the last search was by `string-match' on STRING."
2919 (if (match-beginning num)
2921 (substring-no-properties string (match-beginning num)
2923 (buffer-substring-no-properties (match-beginning num)
2927 (defun match-substitute-replacement (replacement
2928 &optional fixedcase literal string subexp)
2929 "Return REPLACEMENT as it will be inserted by `replace-match'.
2930 In other words, all back-references in the form `\\&' and `\\N'
2931 are substituted with actual strings matched by the last search.
2932 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
2933 meaning as for `replace-match'."
2934 (let ((match (match-string 0 string)))
2936 (set-match-data (mapcar (lambda (x)
2938 (- x (match-beginning 0))
2941 (replace-match replacement fixedcase literal match subexp))))
2944 (defun looking-back (regexp &optional limit greedy)
2945 "Return non-nil if text before point matches regular expression REGEXP.
2946 Like `looking-at' except matches before point, and is slower.
2947 LIMIT if non-nil speeds up the search by specifying a minimum
2948 starting position, to avoid checking matches that would start
2951 If GREEDY is non-nil, extend the match backwards as far as
2952 possible, stopping when a single additional previous character
2953 cannot be part of a match for REGEXP. When the match is
2954 extended, its starting position is allowed to occur before
2956 (let ((start (point))
2959 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2961 (if (and greedy pos)
2963 (narrow-to-region (point-min) start)
2964 (while (and (> pos (point-min))
2968 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2969 (setq pos (1- pos)))
2972 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2975 (defsubst looking-at-p (regexp)
2977 Same as `looking-at' except this function does not change the match data."
2978 (let ((inhibit-changing-match-data t))
2979 (looking-at regexp)))
2981 (defsubst string-match-p (regexp string &optional start)
2983 Same as `string-match' except this function does not change the match data."
2984 (let ((inhibit-changing-match-data t))
2985 (string-match regexp string start)))
2987 (defun subregexp-context-p (regexp pos &optional start)
2988 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2989 A subregexp context is one where a sub-regexp can appear.
2990 A non-subregexp context is for example within brackets, or within a
2991 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2992 If START is non-nil, it should be a position in REGEXP, smaller
2993 than POS, and known to be in a subregexp context."
2994 ;; Here's one possible implementation, with the great benefit that it
2995 ;; reuses the regexp-matcher's own parser, so it understands all the
2996 ;; details of the syntax. A disadvantage is that it needs to match the
3000 (string-match (substring regexp (or start 0) pos) "")
3003 (not (member (cadr err) '("Unmatched [ or [^"
3005 "Trailing backslash")))))
3006 ;; An alternative implementation:
3007 ;; (defconst re-context-re
3008 ;; (let* ((harmless-ch "[^\\[]")
3009 ;; (harmless-esc "\\\\[^{]")
3010 ;; (class-harmless-ch "[^][]")
3011 ;; (class-lb-harmless "[^]:]")
3012 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3013 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3014 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3016 ;; (concat "\\[^?]?"
3017 ;; "\\(" class-harmless-ch
3018 ;; "\\|" class-lb "\\)*"
3019 ;; "\\[?]")) ; special handling for bare [ at end of re
3020 ;; (braces "\\\\{[0-9,]+\\\\}"))
3021 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3022 ;; "\\|" class "\\|" braces "\\)*\\'"))
3023 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3024 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3029 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3030 "The default value of separators for `split-string'.
3032 A regexp matching strings of whitespace. May be locale-dependent
3033 \(as yet unimplemented). Should not match non-breaking spaces.
3035 Warning: binding this to a different value and using it as default is
3036 likely to have undesired semantics.")
3038 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3039 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3040 ;; expression leads to the equivalent implementation that if SEPARATORS
3041 ;; is defaulted, OMIT-NULLS is treated as t.
3042 (defun split-string (string &optional separators omit-nulls)
3043 "Split STRING into substrings bounded by matches for SEPARATORS.
3045 The beginning and end of STRING, and each match for SEPARATORS, are
3046 splitting points. The substrings matching SEPARATORS are removed, and
3047 the substrings between the splitting points are collected as a list,
3050 If SEPARATORS is non-nil, it should be a regular expression matching text
3051 which separates, but is not part of, the substrings. If nil it defaults to
3052 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3053 OMIT-NULLS is forced to t.
3055 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3056 that for the default value of SEPARATORS leading and trailing whitespace
3057 are effectively trimmed). If nil, all zero-length substrings are retained,
3058 which correctly parses CSV format, for example.
3060 Note that the effect of `(split-string STRING)' is the same as
3061 `(split-string STRING split-string-default-separators t)'. In the rare
3062 case that you wish to retain zero-length substrings when splitting on
3063 whitespace, use `(split-string STRING split-string-default-separators)'.
3065 Modifies the match data; use `save-match-data' if necessary."
3066 (let ((keep-nulls (not (if separators omit-nulls t)))
3067 (rexp (or separators split-string-default-separators))
3071 (while (and (string-match rexp string
3073 (= start (match-beginning 0))
3074 (< start (length string)))
3076 (< start (length string)))
3078 (if (or keep-nulls (< start (match-beginning 0)))
3080 (cons (substring string start (match-beginning 0))
3082 (setq start (match-end 0)))
3083 (if (or keep-nulls (< start (length string)))
3085 (cons (substring string start)
3089 (defun combine-and-quote-strings (strings &optional separator)
3090 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3091 This tries to quote the strings to avoid ambiguity such that
3092 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3093 Only some SEPARATORs will work properly."
3094 (let* ((sep (or separator " "))
3095 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3098 (if (string-match re str)
3099 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3103 (defun split-string-and-unquote (string &optional separator)
3104 "Split the STRING into a list of strings.
3105 It understands Emacs Lisp quoting within STRING, such that
3106 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3107 The SEPARATOR regexp defaults to \"\\s-+\"."
3108 (let ((sep (or separator "\\s-+"))
3109 (i (string-match "\"" string)))
3111 (split-string string sep t) ; no quoting: easy
3112 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3113 (let ((rfs (read-from-string string i)))
3115 (split-string-and-unquote (substring string (cdr rfs))
3119 ;;;; Replacement in strings.
3121 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3122 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3123 Unless optional argument INPLACE is non-nil, return a new string."
3124 (let ((i (length string))
3125 (newstr (if inplace string (copy-sequence string))))
3128 (if (eq (aref newstr i) fromchar)
3129 (aset newstr i tochar)))
3132 (defun replace-regexp-in-string (regexp rep string &optional
3133 fixedcase literal subexp start)
3134 "Replace all matches for REGEXP with REP in STRING.
3136 Return a new string containing the replacements.
3138 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3139 arguments with the same names of function `replace-match'. If START
3140 is non-nil, start replacements at that index in STRING.
3142 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3143 function. If it is a function, it is called with the actual text of each
3144 match, and its value is used as the replacement text. When REP is called,
3145 the match-data are the result of matching REGEXP against a substring
3148 To replace only the first match (if any), make REGEXP match up to \\'
3149 and replace a sub-expression, e.g.
3150 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3154 ;; To avoid excessive consing from multiple matches in long strings,
3155 ;; don't just call `replace-match' continually. Walk down the
3156 ;; string looking for matches of REGEXP and building up a (reversed)
3157 ;; list MATCHES. This comprises segments of STRING which weren't
3158 ;; matched interspersed with replacements for segments that were.
3159 ;; [For a `large' number of replacements it's more efficient to
3160 ;; operate in a temporary buffer; we can't tell from the function's
3161 ;; args whether to choose the buffer-based implementation, though it
3162 ;; might be reasonable to do so for long enough STRING.]
3163 (let ((l (length string))
3164 (start (or start 0))
3167 (while (and (< start l) (string-match regexp string start))
3168 (setq mb (match-beginning 0)
3170 ;; If we matched the empty string, make sure we advance by one char
3171 (when (= me mb) (setq me (min l (1+ mb))))
3172 ;; Generate a replacement for the matched substring.
3173 ;; Operate only on the substring to minimize string consing.
3174 ;; Set up match data for the substring for replacement;
3175 ;; presumably this is likely to be faster than munging the
3176 ;; match data directly in Lisp.
3177 (string-match regexp (setq str (substring string mb me)))
3179 (cons (replace-match (if (stringp rep)
3181 (funcall rep (match-string 0 str)))
3182 fixedcase literal str subexp)
3183 (cons (substring string start mb) ; unmatched prefix
3186 ;; Reconstruct a string from the pieces.
3187 (setq matches (cons (substring string start l) matches)) ; leftover
3188 (apply #'concat (nreverse matches)))))
3190 ;;;; invisibility specs
3192 (defun add-to-invisibility-spec (element)
3193 "Add ELEMENT to `buffer-invisibility-spec'.
3194 See documentation for `buffer-invisibility-spec' for the kind of elements
3196 (if (eq buffer-invisibility-spec t)
3197 (setq buffer-invisibility-spec (list t)))
3198 (setq buffer-invisibility-spec
3199 (cons element buffer-invisibility-spec)))
3201 (defun remove-from-invisibility-spec (element)
3202 "Remove ELEMENT from `buffer-invisibility-spec'."
3203 (if (consp buffer-invisibility-spec)
3204 (setq buffer-invisibility-spec
3205 (delete element buffer-invisibility-spec))))
3209 (defmacro with-syntax-table (table &rest body)
3210 "Evaluate BODY with syntax table of current buffer set to TABLE.
3211 The syntax table of the current buffer is saved, BODY is evaluated, and the
3212 saved table is restored, even in case of an abnormal exit.
3213 Value is what BODY returns."
3215 (let ((old-table (make-symbol "table"))
3216 (old-buffer (make-symbol "buffer")))
3217 `(let ((,old-table (syntax-table))
3218 (,old-buffer (current-buffer)))
3221 (set-syntax-table ,table)
3223 (save-current-buffer
3224 (set-buffer ,old-buffer)
3225 (set-syntax-table ,old-table))))))
3227 (defun make-syntax-table (&optional oldtable)
3228 "Return a new syntax table.
3229 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3230 from `standard-syntax-table' otherwise."
3231 (let ((table (make-char-table 'syntax-table nil)))
3232 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3235 (defun syntax-after (pos)
3236 "Return the raw syntax of the char after POS.
3237 If POS is outside the buffer's accessible portion, return nil."
3238 (unless (or (< pos (point-min)) (>= pos (point-max)))
3239 (let ((st (if parse-sexp-lookup-properties
3240 (get-char-property pos 'syntax-table))))
3242 (aref (or st (syntax-table)) (char-after pos))))))
3244 (defun syntax-class (syntax)
3245 "Return the syntax class part of the syntax descriptor SYNTAX.
3246 If SYNTAX is nil, return nil."
3247 (and syntax (logand (car syntax) 65535)))
3251 (defun text-clone-maintain (ol1 after beg end &optional len)
3252 "Propagate the changes made under the overlay OL1 to the other clones.
3253 This is used on the `modification-hooks' property of text clones."
3254 (when (and after (not undo-in-progress) (overlay-start ol1))
3255 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3256 (setq beg (max beg (+ (overlay-start ol1) margin)))
3257 (setq end (min end (- (overlay-end ol1) margin)))
3260 (when (overlay-get ol1 'text-clone-syntax)
3261 ;; Check content of the clone's text.
3262 (let ((cbeg (+ (overlay-start ol1) margin))
3263 (cend (- (overlay-end ol1) margin)))
3266 (if (not (re-search-forward
3267 (overlay-get ol1 'text-clone-syntax) cend t))
3268 ;; Mark the overlay for deletion.
3269 (overlay-put ol1 'text-clones nil)
3270 (when (< (match-end 0) cend)
3271 ;; Shrink the clone at its end.
3272 (setq end (min end (match-end 0)))
3273 (move-overlay ol1 (overlay-start ol1)
3274 (+ (match-end 0) margin)))
3275 (when (> (match-beginning 0) cbeg)
3276 ;; Shrink the clone at its beginning.
3277 (setq beg (max (match-beginning 0) beg))
3278 (move-overlay ol1 (- (match-beginning 0) margin)
3279 (overlay-end ol1)))))))
3280 ;; Now go ahead and update the clones.
3281 (let ((head (- beg (overlay-start ol1)))
3282 (tail (- (overlay-end ol1) end))
3283 (str (buffer-substring beg end))
3285 (inhibit-modification-hooks t))
3286 (dolist (ol2 (overlay-get ol1 'text-clones))
3287 (let ((oe (overlay-end ol2)))
3288 (unless (or (eq ol1 ol2) (null oe))
3289 (setq nothing-left nil)
3290 (let ((mod-beg (+ (overlay-start ol2) head)))
3291 ;;(overlay-put ol2 'modification-hooks nil)
3292 (goto-char (- (overlay-end ol2) tail))
3293 (unless (> mod-beg (point))
3294 (save-excursion (insert str))
3295 (delete-region mod-beg (point)))
3296 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3298 (if nothing-left (delete-overlay ol1))))))))
3300 (defun text-clone-create (start end &optional spreadp syntax)
3301 "Create a text clone of START...END at point.
3302 Text clones are chunks of text that are automatically kept identical:
3303 changes done to one of the clones will be immediately propagated to the other.
3305 The buffer's content at point is assumed to be already identical to
3306 the one between START and END.
3307 If SYNTAX is provided it's a regexp that describes the possible text of
3308 the clones; the clone will be shrunk or killed if necessary to ensure that
3309 its text matches the regexp.
3310 If SPREADP is non-nil it indicates that text inserted before/after the
3311 clone should be incorporated in the clone."
3312 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3313 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3314 ;; (with a one-char margin at each end) with `t nil'.
3315 ;; We opted for a larger overlay because it behaves better in the case
3316 ;; where the clone is reduced to the empty string (we want the overlay to
3317 ;; stay when the clone's content is the empty string and we want to use
3318 ;; `evaporate' to make sure those overlays get deleted when needed).
3320 (let* ((pt-end (+ (point) (- end start)))
3321 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3323 (end-margin (if (or (not spreadp)
3324 (>= pt-end (point-max))
3325 (>= start (point-max)))
3327 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3328 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3329 (dups (list ol1 ol2)))
3330 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3331 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3332 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3333 ;;(overlay-put ol1 'face 'underline)
3334 (overlay-put ol1 'evaporate t)
3335 (overlay-put ol1 'text-clones dups)
3337 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3338 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3339 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3340 ;;(overlay-put ol2 'face 'underline)
3341 (overlay-put ol2 'evaporate t)
3342 (overlay-put ol2 'text-clones dups)))
3344 ;;;; Mail user agents.
3346 ;; Here we include just enough for other packages to be able
3349 (defun define-mail-user-agent (symbol composefunc sendfunc
3350 &optional abortfunc hookvar)
3351 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3353 SYMBOL can be any Lisp symbol. Its function definition and/or
3354 value as a variable do not matter for this usage; we use only certain
3355 properties on its property list, to encode the rest of the arguments.
3357 COMPOSEFUNC is program callable function that composes an outgoing
3358 mail message buffer. This function should set up the basics of the
3359 buffer without requiring user interaction. It should populate the
3360 standard mail headers, leaving the `to:' and `subject:' headers blank
3363 COMPOSEFUNC should accept several optional arguments--the same
3364 arguments that `compose-mail' takes. See that function's documentation.
3366 SENDFUNC is the command a user would run to send the message.
3368 Optional ABORTFUNC is the command a user would run to abort the
3369 message. For mail packages that don't have a separate abort function,
3370 this can be `kill-buffer' (the equivalent of omitting this argument).
3372 Optional HOOKVAR is a hook variable that gets run before the message
3373 is actually sent. Callers that use the `mail-user-agent' may
3374 install a hook function temporarily on this hook variable.
3375 If HOOKVAR is nil, `mail-send-hook' is used.
3377 The properties used on SYMBOL are `composefunc', `sendfunc',
3378 `abortfunc', and `hookvar'."
3379 (put symbol 'composefunc composefunc)
3380 (put symbol 'sendfunc sendfunc)
3381 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3382 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3384 ;;;; Progress reporters.
3386 ;; Progress reporter has the following structure:
3388 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3395 ;; This weirdeness is for optimization reasons: we want
3396 ;; `progress-reporter-update' to be as fast as possible, so
3397 ;; `(car reporter)' is better than `(aref reporter 0)'.
3399 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3400 ;; digits of precision, it doesn't really matter here. On the other
3401 ;; hand, it greatly simplifies the code.
3403 (defsubst progress-reporter-update (reporter value)
3404 "Report progress of an operation in the echo area.
3405 However, if the change since last echo area update is too small
3406 or not enough time has passed, then do nothing (see
3407 `make-progress-reporter' for details).
3409 First parameter, REPORTER, should be the result of a call to
3410 `make-progress-reporter'. Second, VALUE, determines the actual
3411 progress of operation; it must be between MIN-VALUE and MAX-VALUE
3412 as passed to `make-progress-reporter'.
3414 This function is very inexpensive, you may not bother how often
3416 (when (>= value (car reporter))
3417 (progress-reporter-do-update reporter value)))
3419 (defun make-progress-reporter (message min-value max-value
3420 &optional current-value
3421 min-change min-time)
3422 "Return progress reporter object to be used with `progress-reporter-update'.
3424 MESSAGE is shown in the echo area. When at least 1% of operation
3425 is complete, the exact percentage will be appended to the
3426 MESSAGE. When you call `progress-reporter-done', word \"done\"
3427 is printed after the MESSAGE. You can change MESSAGE of an
3428 existing progress reporter with `progress-reporter-force-update'.
3430 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
3431 final (100% complete) states of operation. The latter should be
3432 larger; if this is not the case, then simply negate all values.
3433 Optional CURRENT-VALUE specifies the progress by the moment you
3434 call this function. You should omit it or set it to nil in most
3435 cases since it defaults to MIN-VALUE.
3437 Optional MIN-CHANGE determines the minimal change in percents to
3438 report (default is 1%.) Optional MIN-TIME specifies the minimal
3439 time before echo area updates (default is 0.2 seconds.) If
3440 `float-time' function is not present, then time is not tracked
3441 at all. If OS is not capable of measuring fractions of seconds,
3442 then this parameter is effectively rounded up."
3445 (setq min-time 0.2))
3447 (cons min-value ;; Force a call to `message' now
3448 (vector (if (and (fboundp 'float-time)
3454 (if min-change (max (min min-change 50) 1) 1)
3456 (progress-reporter-update reporter (or current-value min-value))
3459 (defun progress-reporter-force-update (reporter value &optional new-message)
3460 "Report progress of an operation in the echo area unconditionally.
3462 First two parameters are the same as for
3463 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
3464 change the displayed message."
3465 (let ((parameters (cdr reporter)))
3467 (aset parameters 3 new-message))
3468 (when (aref parameters 0)
3469 (aset parameters 0 (float-time)))
3470 (progress-reporter-do-update reporter value)))
3472 (defun progress-reporter-do-update (reporter value)
3473 (let* ((parameters (cdr reporter))
3474 (min-value (aref parameters 1))
3475 (max-value (aref parameters 2))
3476 (one-percent (/ (- max-value min-value) 100.0))
3477 (percentage (if (= max-value min-value)
3479 (truncate (/ (- value min-value) one-percent))))
3480 (update-time (aref parameters 0))
3481 (current-time (float-time))
3483 ;; See if enough time has passed since the last update.
3484 (or (not update-time)
3485 (when (>= current-time update-time)
3486 ;; Calculate time for the next update
3487 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3489 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
3490 ;; message this time because not enough time has passed, then use
3491 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
3492 ;; updates closer to MIN-TIME.
3494 (min (+ min-value (* (+ percentage
3495 (if enough-time-passed
3496 (aref parameters 4) ;; MIN-CHANGE
3500 (when (integerp value)
3501 (setcar reporter (ceiling (car reporter))))
3503 ;; Only print message if enough time has passed
3504 (when enough-time-passed
3505 (if (> percentage 0)
3506 (message "%s%d%%" (aref parameters 3) percentage)
3507 (message "%s" (aref parameters 3))))))
3509 (defun progress-reporter-done (reporter)
3510 "Print reporter's message followed by word \"done\" in echo area."
3511 (message "%sdone" (aref (cdr reporter) 3)))
3513 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3514 "Loop a certain number of times and report progress in the echo area.
3515 Evaluate BODY with VAR bound to successive integers running from
3516 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3517 the return value (nil if RESULT is omitted).
3519 At each iteration MESSAGE followed by progress percentage is
3520 printed in the echo area. After the loop is finished, MESSAGE
3521 followed by word \"done\" is printed. This macro is a
3522 convenience wrapper around `make-progress-reporter' and friends.
3524 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3525 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3526 (let ((temp (make-symbol "--dotimes-temp--"))
3527 (temp2 (make-symbol "--dotimes-temp2--"))
3531 (,(car spec) ,start)
3532 (,temp2 (make-progress-reporter ,message ,start ,end)))
3533 (while (< ,(car spec) ,temp)
3535 (progress-reporter-update ,temp2
3536 (setq ,(car spec) (1+ ,(car spec)))))
3537 (progress-reporter-done ,temp2)
3538 nil ,@(cdr (cdr spec)))))
3541 ;;;; Comparing version strings.
3543 (defvar version-separator "."
3544 "*Specify the string used to separate the version elements.
3546 Usually the separator is \".\", but it can be any other string.")
3549 (defvar version-regexp-alist
3550 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3551 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3552 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3553 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3554 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3555 "*Specify association between non-numeric version part and a priority.
3557 This association is used to handle version string like \"1.0pre2\",
3558 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3559 non-numeric part to an integer. For example:
3561 String Version Integer List Version
3562 \"1.0pre2\" (1 0 -1 2)
3563 \"1.0PRE2\" (1 0 -1 2)
3564 \"22.8beta3\" (22 8 -2 3)
3565 \"22.8 Beta3\" (22 8 -2 3)
3566 \"0.9alpha1\" (0 9 -3 1)
3567 \"0.9AlphA1\" (0 9 -3 1)
3568 \"0.9 alpha\" (0 9 -3)
3570 Each element has the following form:
3576 REGEXP regexp used to match non-numeric part of a version string.
3577 It should begin with a `^' anchor and end with a `$' to
3578 prevent false hits. Letter-case is ignored while matching
3581 PRIORITY negative integer which indicate the non-numeric priority.")
3584 (defun version-to-list (ver)
3585 "Convert version string VER into an integer list.
3587 The version syntax is given by the following EBNF:
3589 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3591 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3593 SEPARATOR ::= `version-separator' (which see)
3594 | `version-regexp-alist' (which see).
3596 The NUMBER part is optional if SEPARATOR is a match for an element
3597 in `version-regexp-alist'.
3599 As an example of valid version syntax:
3601 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3603 As an example of invalid version syntax:
3605 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3607 As an example of version convertion:
3609 String Version Integer List Version
3610 \"1.0.7.5\" (1 0 7 5)
3611 \"1.0pre2\" (1 0 -1 2)
3612 \"1.0PRE2\" (1 0 -1 2)
3613 \"22.8beta3\" (22 8 -2 3)
3614 \"22.8Beta3\" (22 8 -2 3)
3615 \"0.9alpha1\" (0 9 -3 1)
3616 \"0.9AlphA1\" (0 9 -3 1)
3617 \"0.9alpha\" (0 9 -3)
3619 See documentation for `version-separator' and `version-regexp-alist'."
3620 (or (and (stringp ver) (> (length ver) 0))
3621 (error "Invalid version string: '%s'" ver))
3622 ;; Change .x.y to 0.x.y
3623 (if (and (>= (length ver) (length version-separator))
3624 (string-equal (substring ver 0 (length version-separator))
3626 (setq ver (concat "0" ver)))
3629 (case-fold-search t) ; ignore case in matching
3631 (while (and (setq s (string-match "[0-9]+" ver i))
3633 ;; handle numeric part
3634 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3637 ;; handle non-numeric part
3638 (when (and (setq s (string-match "[^0-9]+" ver i))
3640 (setq s (substring ver i (match-end 0))
3642 ;; handle alpha, beta, pre, etc. separator
3643 (unless (string= s version-separator)
3644 (setq al version-regexp-alist)
3645 (while (and al (not (string-match (caar al) s)))
3647 (or al (error "Invalid version syntax: '%s'" ver))
3648 (setq lst (cons (cdar al) lst)))))
3650 (error "Invalid version syntax: '%s'" ver)
3654 (defun version-list-< (l1 l2)
3655 "Return t if integer list L1 is lesser than L2.
3657 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3658 etc. That is, the trailing zeroes are irrelevant. Also, integer
3659 list (1) is greater than (1 -1) which is greater than (1 -2)
3660 which is greater than (1 -3)."
3661 (while (and l1 l2 (= (car l1) (car l2)))
3665 ;; l1 not null and l2 not null
3666 ((and l1 l2) (< (car l1) (car l2)))
3667 ;; l1 null and l2 null ==> l1 length = l2 length
3668 ((and (null l1) (null l2)) nil)
3669 ;; l1 not null and l2 null ==> l1 length > l2 length
3670 (l1 (< (version-list-not-zero l1) 0))
3671 ;; l1 null and l2 not null ==> l2 length > l1 length
3672 (t (< 0 (version-list-not-zero l2)))))
3675 (defun version-list-= (l1 l2)
3676 "Return t if integer list L1 is equal to L2.
3678 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3679 etc. That is, the trailing zeroes are irrelevant. Also, integer
3680 list (1) is greater than (1 -1) which is greater than (1 -2)
3681 which is greater than (1 -3)."
3682 (while (and l1 l2 (= (car l1) (car l2)))
3686 ;; l1 not null and l2 not null
3688 ;; l1 null and l2 null ==> l1 length = l2 length
3689 ((and (null l1) (null l2)))
3690 ;; l1 not null and l2 null ==> l1 length > l2 length
3691 (l1 (zerop (version-list-not-zero l1)))
3692 ;; l1 null and l2 not null ==> l2 length > l1 length
3693 (t (zerop (version-list-not-zero l2)))))
3696 (defun version-list-<= (l1 l2)
3697 "Return t if integer list L1 is lesser than or equal to L2.
3699 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3700 etc. That is, the trailing zeroes are irrelevant. Also, integer
3701 list (1) is greater than (1 -1) which is greater than (1 -2)
3702 which is greater than (1 -3)."
3703 (while (and l1 l2 (= (car l1) (car l2)))
3707 ;; l1 not null and l2 not null
3708 ((and l1 l2) (< (car l1) (car l2)))
3709 ;; l1 null and l2 null ==> l1 length = l2 length
3710 ((and (null l1) (null l2)))
3711 ;; l1 not null and l2 null ==> l1 length > l2 length
3712 (l1 (<= (version-list-not-zero l1) 0))
3713 ;; l1 null and l2 not null ==> l2 length > l1 length
3714 (t (<= 0 (version-list-not-zero l2)))))
3716 (defun version-list-not-zero (lst)
3717 "Return the first non-zero element of integer list LST.
3719 If all LST elements are zeroes or LST is nil, return zero."
3720 (while (and lst (zerop (car lst)))
3721 (setq lst (cdr lst)))
3724 ;; there is no element different of zero
3728 (defun version< (v1 v2)
3729 "Return t if version V1 is lesser than V2.
3731 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3732 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3733 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3735 (version-list-< (version-to-list v1) (version-to-list v2)))
3738 (defun version<= (v1 v2)
3739 "Return t if version V1 is lesser than or equal to V2.
3741 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3742 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3743 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3745 (version-list-<= (version-to-list v1) (version-to-list v2)))
3747 (defun version= (v1 v2)
3748 "Return t if version V1 is equal to V2.
3750 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3751 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3752 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3754 (version-list-= (version-to-list v1) (version-to-list v2)))
3759 ;; The following statement ought to be in print.c, but `provide' can't
3761 (when (hash-table-p (car (read-from-string
3762 (prin1-to-string (make-hash-table)))))
3763 (provide 'hashtable-print-readable))
3765 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3766 ;;; subr.el ends here