1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
29 (defvar custom-declare-variable-list nil
30 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
31 Each element of this list holds the arguments to one call to `defcustom'.")
33 ;; Use this, rather than defcustom, in subr.el and other files loaded
35 (defun custom-declare-variable-early (&rest arguments)
36 (setq custom-declare-variable-list
37 (cons arguments custom-declare-variable-list)))
40 ;;;; Basic Lisp macros.
44 (defmacro noreturn (form)
45 "Evaluate FORM, expecting it not to return.
46 If FORM does return, signal an error."
48 (error "Form marked with `noreturn' did return")))
50 (defmacro 1value (form)
51 "Evaluate FORM, expecting a constant return value.
52 This is the global do-nothing version. There is also `testcover-1value'
53 that complains if FORM ever does return differing values."
56 (defmacro lambda (&rest cdr)
57 "Return a lambda expression.
58 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
59 self-quoting; the result of evaluating the lambda expression is the
60 expression itself. The lambda expression may then be treated as a
61 function, i.e., stored as the function value of a symbol, passed to
62 `funcall' or `mapcar', etc.
64 ARGS should take the same form as an argument list for a `defun'.
65 DOCSTRING is an optional documentation string.
66 If present, it should describe how to call the function.
67 But documentation strings are usually not useful in nameless functions.
68 INTERACTIVE should be a call to the function `interactive', which see.
69 It may also be omitted.
70 BODY should be a list of Lisp expressions.
72 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
73 ;; Note that this definition should not use backquotes; subr.el should not
74 ;; depend on backquote.el.
75 (list 'function (cons 'lambda cdr)))
77 (defmacro push (newelt listname)
78 "Add NEWELT to the list stored in the symbol LISTNAME.
79 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
80 LISTNAME must be a symbol."
81 (declare (debug (form sexp)))
83 (list 'cons newelt listname)))
85 (defmacro pop (listname)
86 "Return the first element of LISTNAME's value, and remove it from the list.
87 LISTNAME must be a symbol whose value is a list.
88 If the value is nil, `pop' returns nil but does not actually
90 (declare (debug (sexp)))
93 (list 'setq listname (list 'cdr listname)))))
95 (defmacro when (cond &rest body)
96 "If COND yields non-nil, do BODY, else return nil."
97 (declare (indent 1) (debug t))
98 (list 'if cond (cons 'progn body)))
100 (defmacro unless (cond &rest body)
101 "If COND yields nil, do BODY, else return nil."
102 (declare (indent 1) (debug t))
103 (cons 'if (cons cond (cons nil body))))
105 (defmacro dolist (spec &rest body)
107 Evaluate BODY with VAR bound to each car from LIST, in turn.
108 Then evaluate RESULT to get return value, default nil.
110 \(fn (VAR LIST [RESULT]) BODY...)"
111 (declare (indent 1) (debug ((symbolp form &optional form) body)))
112 (let ((temp (make-symbol "--dolist-temp--")))
113 `(let ((,temp ,(nth 1 spec))
116 (setq ,(car spec) (car ,temp))
117 (setq ,temp (cdr ,temp))
119 ,@(if (cdr (cdr spec))
120 `((setq ,(car spec) nil) ,@(cdr (cdr spec)))))))
122 (defmacro dotimes (spec &rest body)
123 "Loop a certain number of times.
124 Evaluate BODY with VAR bound to successive integers running from 0,
125 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
126 the return value (nil if RESULT is omitted).
128 \(fn (VAR COUNT [RESULT]) BODY...)"
129 (declare (indent 1) (debug dolist))
130 (let ((temp (make-symbol "--dotimes-temp--"))
134 (,(car spec) ,start))
135 (while (< ,(car spec) ,temp)
137 (setq ,(car spec) (1+ ,(car spec))))
138 ,@(cdr (cdr spec)))))
140 (defmacro declare (&rest specs)
141 "Do not evaluate any arguments and return nil.
142 Treated as a declaration when used at the right place in a
143 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
146 ;;;; Basic Lisp functions.
148 (defun ignore (&rest ignore)
149 "Do nothing and return nil.
150 This function accepts any number of arguments, but ignores them."
154 (defun error (&rest args)
155 "Signal an error, making error message by passing all args to `format'.
156 In Emacs, the convention is that error messages start with a capital
157 letter but *do not* end with a period. Please follow this convention
158 for the sake of consistency."
160 (signal 'error (list (apply 'format args)))))
162 ;; We put this here instead of in frame.el so that it's defined even on
163 ;; systems where frame.el isn't loaded.
164 (defun frame-configuration-p (object)
165 "Return non-nil if OBJECT seems to be a frame configuration.
166 Any list whose car is `frame-configuration' is assumed to be a frame
169 (eq (car object) 'frame-configuration)))
171 (defun functionp (object)
172 "Non-nil if OBJECT is any kind of function or a special form.
173 Also non-nil if OBJECT is a symbol and its function definition is
174 \(recursively) a function or special form. This does not include
176 (or (and (symbolp object) (fboundp object)
178 (setq object (indirect-function object))
180 (eq (car-safe object) 'autoload)
181 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object)))))))
182 (subrp object) (byte-code-function-p object)
183 (eq (car-safe object) 'lambda)))
188 "Return the car of the car of X."
192 "Return the car of the cdr of X."
196 "Return the cdr of the car of X."
200 "Return the cdr of the cdr of X."
203 (defun last (list &optional n)
204 "Return the last link of LIST. Its car is the last element.
205 If LIST is nil, return nil.
206 If N is non-nil, return the Nth-to-last link of LIST.
207 If N is bigger than the length of LIST, return LIST."
209 (let ((m 0) (p list))
211 (setq m (1+ m) p (cdr p)))
213 (if (< n m) (nthcdr (- m n) list) list)))
214 (while (consp (cdr list))
215 (setq list (cdr list)))
218 (defun butlast (list &optional n)
219 "Return a copy of LIST with the last N elements removed."
220 (if (and n (<= n 0)) list
221 (nbutlast (copy-sequence list) n)))
223 (defun nbutlast (list &optional n)
224 "Modifies LIST to remove the last N elements."
225 (let ((m (length list)))
229 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
232 (defun delete-dups (list)
233 "Destructively remove `equal' duplicates from LIST.
234 Store the result in LIST and return it. LIST must be a proper list.
235 Of several `equal' occurrences of an element in LIST, the first
239 (setcdr tail (delete (car tail) (cdr tail)))
240 (setq tail (cdr tail))))
243 (defun number-sequence (from &optional to inc)
244 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
245 INC is the increment used between numbers in the sequence and defaults to 1.
246 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
247 zero. TO is only included if there is an N for which TO = FROM + N * INC.
248 If TO is nil or numerically equal to FROM, return \(FROM).
249 If INC is positive and TO is less than FROM, or INC is negative
250 and TO is larger than FROM, return nil.
251 If INC is zero and TO is neither nil nor numerically equal to
252 FROM, signal an error.
254 This function is primarily designed for integer arguments.
255 Nevertheless, FROM, TO and INC can be integer or float. However,
256 floating point arithmetic is inexact. For instance, depending on
257 the machine, it may quite well happen that
258 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
259 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
260 elements. Thus, if some of the arguments are floats and one wants
261 to make sure that TO is included, one may have to explicitly write
262 TO as \(+ FROM \(* N INC)) or use a variable whose value was
263 computed with this exact expression. Alternatively, you can,
264 of course, also replace TO with a slightly larger value
265 \(or a slightly more negative value if INC is negative)."
266 (if (or (not to) (= from to))
268 (or inc (setq inc 1))
269 (when (zerop inc) (error "The increment can not be zero"))
270 (let (seq (n 0) (next from))
273 (setq seq (cons next seq)
275 next (+ from (* n inc))))
277 (setq seq (cons next seq)
279 next (+ from (* n inc)))))
282 (defun copy-tree (tree &optional vecp)
283 "Make a copy of TREE.
284 If TREE is a cons cell, this recursively copies both its car and its cdr.
285 Contrast to `copy-sequence', which copies only along the cdrs. With second
286 argument VECP, this copies vectors as well as conses."
290 (let ((newcar (car tree)))
291 (if (or (consp (car tree)) (and vecp (vectorp (car tree))))
292 (setq newcar (copy-tree (car tree) vecp)))
293 (push newcar result))
294 (setq tree (cdr tree)))
295 (nconc (nreverse result) tree))
296 (if (and vecp (vectorp tree))
297 (let ((i (length (setq tree (copy-sequence tree)))))
298 (while (>= (setq i (1- i)) 0)
299 (aset tree i (copy-tree (aref tree i) vecp)))
303 ;;;; Various list-search functions.
305 (defun assoc-default (key alist &optional test default)
306 "Find object KEY in a pseudo-alist ALIST.
307 ALIST is a list of conses or objects. Each element (or the element's car,
308 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
309 If that is non-nil, the element matches;
310 then `assoc-default' returns the element's cdr, if it is a cons,
311 or DEFAULT if the element is not a cons.
313 If no element matches, the value is nil.
314 If TEST is omitted or nil, `equal' is used."
315 (let (found (tail alist) value)
316 (while (and tail (not found))
317 (let ((elt (car tail)))
318 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
319 (setq found t value (if (consp elt) (cdr elt) default))))
320 (setq tail (cdr tail)))
323 (make-obsolete 'assoc-ignore-case 'assoc-string)
324 (defun assoc-ignore-case (key alist)
325 "Like `assoc', but ignores differences in case and text representation.
326 KEY must be a string. Upper-case and lower-case letters are treated as equal.
327 Unibyte strings are converted to multibyte for comparison."
328 (assoc-string key alist t))
330 (make-obsolete 'assoc-ignore-representation 'assoc-string)
331 (defun assoc-ignore-representation (key alist)
332 "Like `assoc', but ignores differences in text representation.
333 KEY must be a string.
334 Unibyte strings are converted to multibyte for comparison."
335 (assoc-string key alist nil))
337 (defun member-ignore-case (elt list)
338 "Like `member', but ignores differences in case and text representation.
339 ELT must be a string. Upper-case and lower-case letters are treated as equal.
340 Unibyte strings are converted to multibyte for comparison.
341 Non-strings in LIST are ignored."
343 (not (and (stringp (car list))
344 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
345 (setq list (cdr list)))
348 (defun assq-delete-all (key alist)
349 "Delete from ALIST all elements whose car is `eq' to KEY.
350 Return the modified alist.
351 Elements of ALIST that are not conses are ignored."
352 (while (and (consp (car alist))
353 (eq (car (car alist)) key))
354 (setq alist (cdr alist)))
355 (let ((tail alist) tail-cdr)
356 (while (setq tail-cdr (cdr tail))
357 (if (and (consp (car tail-cdr))
358 (eq (car (car tail-cdr)) key))
359 (setcdr tail (cdr tail-cdr))
360 (setq tail tail-cdr))))
363 (defun rassq-delete-all (value alist)
364 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
365 Return the modified alist.
366 Elements of ALIST that are not conses are ignored."
367 (while (and (consp (car alist))
368 (eq (cdr (car alist)) value))
369 (setq alist (cdr alist)))
370 (let ((tail alist) tail-cdr)
371 (while (setq tail-cdr (cdr tail))
372 (if (and (consp (car tail-cdr))
373 (eq (cdr (car tail-cdr)) value))
374 (setcdr tail (cdr tail-cdr))
375 (setq tail tail-cdr))))
378 (defun remove (elt seq)
379 "Return a copy of SEQ with all occurrences of ELT removed.
380 SEQ must be a list, vector, or string. The comparison is done with `equal'."
382 ;; If SEQ isn't a list, there's no need to copy SEQ because
383 ;; `delete' will return a new object.
385 (delete elt (copy-sequence seq))))
387 (defun remq (elt list)
388 "Return LIST with all occurrences of ELT removed.
389 The comparison is done with `eq'. Contrary to `delq', this does not use
390 side-effects, and the argument LIST is not modified."
392 (delq elt (copy-sequence list))
398 "Convert KEYS to the internal Emacs key representation.
399 KEYS should be a string constant in the format used for
400 saving keyboard macros (see `edmacro-mode')."
401 (read-kbd-macro keys))
407 ;; Prevent the \{...} documentation construct
408 ;; from mentioning keys that run this command.
409 (put 'undefined 'suppress-keymap t)
411 (defun suppress-keymap (map &optional nodigits)
412 "Make MAP override all normally self-inserting keys to be undefined.
413 Normally, as an exception, digits and minus-sign are set to make prefix args,
414 but optional second arg NODIGITS non-nil treats them like other chars."
415 (define-key map [remap self-insert-command] 'undefined)
418 (define-key map "-" 'negative-argument)
419 ;; Make plain numbers do numeric args.
422 (define-key map (char-to-string loop) 'digit-argument)
423 (setq loop (1+ loop))))))
425 (defun define-key-after (keymap key definition &optional after)
426 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
427 This is like `define-key' except that the binding for KEY is placed
428 just after the binding for the event AFTER, instead of at the beginning
429 of the map. Note that AFTER must be an event type (like KEY), NOT a command
432 If AFTER is t or omitted, the new binding goes at the end of the keymap.
433 AFTER should be a single event type--a symbol or a character, not a sequence.
435 Bindings are always added before any inherited map.
437 The order of bindings in a keymap matters when it is used as a menu."
438 (unless after (setq after t))
440 (signal 'wrong-type-argument (list 'keymapp keymap)))
442 (if (<= (length key) 1) (aref key 0)
443 (setq keymap (lookup-key keymap
445 (butlast (mapcar 'identity key)))))
446 (aref key (1- (length key)))))
447 (let ((tail keymap) done inserted)
448 (while (and (not done) tail)
449 ;; Delete any earlier bindings for the same key.
450 (if (eq (car-safe (car (cdr tail))) key)
451 (setcdr tail (cdr (cdr tail))))
452 ;; If we hit an included map, go down that one.
453 (if (keymapp (car tail)) (setq tail (car tail)))
454 ;; When we reach AFTER's binding, insert the new binding after.
455 ;; If we reach an inherited keymap, insert just before that.
456 ;; If we reach the end of this keymap, insert at the end.
457 (if (or (and (eq (car-safe (car tail)) after)
459 (eq (car (cdr tail)) 'keymap)
462 ;; Stop the scan only if we find a parent keymap.
463 ;; Keep going past the inserted element
464 ;; so we can delete any duplications that come later.
465 (if (eq (car (cdr tail)) 'keymap)
467 ;; Don't insert more than once.
469 (setcdr tail (cons (cons key definition) (cdr tail))))
471 (setq tail (cdr tail)))))
473 (defun map-keymap-internal (function keymap &optional sort-first)
474 "Implement `map-keymap' with sorting.
475 Don't call this function; it is for internal use only."
478 (map-keymap (lambda (a b) (push (cons a b) list))
480 (setq list (sort list
482 (setq a (car a) b (car b))
484 (if (integerp b) (< a b)
489 (funcall function (car p) (cdr p))))
490 (map-keymap function keymap)))
492 (put 'keyboard-translate-table 'char-table-extra-slots 0)
494 (defun keyboard-translate (from to)
495 "Translate character FROM to TO at a low level.
496 This function creates a `keyboard-translate-table' if necessary
497 and then modifies one entry in it."
498 (or (char-table-p keyboard-translate-table)
499 (setq keyboard-translate-table
500 (make-char-table 'keyboard-translate-table nil)))
501 (aset keyboard-translate-table from to))
503 ;;;; Key binding commands.
505 (defun global-set-key (key command)
506 "Give KEY a global binding as COMMAND.
507 COMMAND is the command definition to use; usually it is
508 a symbol naming an interactively-callable function.
509 KEY is a key sequence; noninteractively, it is a string or vector
510 of characters or event types, and non-ASCII characters with codes
511 above 127 (such as ISO Latin-1) can be included if you use a vector.
513 Note that if KEY has a local binding in the current buffer,
514 that local binding will continue to shadow any global binding
515 that you make with this function."
516 (interactive "KSet key globally: \nCSet key %s to command: ")
517 (or (vectorp key) (stringp key)
518 (signal 'wrong-type-argument (list 'arrayp key)))
519 (define-key (current-global-map) key command))
521 (defun local-set-key (key command)
522 "Give KEY a local binding as COMMAND.
523 COMMAND is the command definition to use; usually it is
524 a symbol naming an interactively-callable function.
525 KEY is a key sequence; noninteractively, it is a string or vector
526 of characters or event types, and non-ASCII characters with codes
527 above 127 (such as ISO Latin-1) can be included if you use a vector.
529 The binding goes in the current buffer's local map,
530 which in most cases is shared with all other buffers in the same major mode."
531 (interactive "KSet key locally: \nCSet key %s locally to command: ")
532 (let ((map (current-local-map)))
534 (use-local-map (setq map (make-sparse-keymap))))
535 (or (vectorp key) (stringp key)
536 (signal 'wrong-type-argument (list 'arrayp key)))
537 (define-key map key command)))
539 (defun global-unset-key (key)
540 "Remove global binding of KEY.
541 KEY is a string or vector representing a sequence of keystrokes."
542 (interactive "kUnset key globally: ")
543 (global-set-key key nil))
545 (defun local-unset-key (key)
546 "Remove local binding of KEY.
547 KEY is a string or vector representing a sequence of keystrokes."
548 (interactive "kUnset key locally: ")
549 (if (current-local-map)
550 (local-set-key key nil))
553 ;;;; substitute-key-definition and its subroutines.
555 (defvar key-substitution-in-progress nil
556 "Used internally by `substitute-key-definition'.")
558 (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
559 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
560 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
561 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
562 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
564 If you don't specify OLDMAP, you can usually get the same results
565 in a cleaner way with command remapping, like this:
566 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
567 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
568 ;; Don't document PREFIX in the doc string because we don't want to
569 ;; advertise it. It's meant for recursive calls only. Here's its
572 ;; If optional argument PREFIX is specified, it should be a key
573 ;; prefix, a string. Redefined bindings will then be bound to the
574 ;; original key, with PREFIX added at the front.
575 (or prefix (setq prefix ""))
576 (let* ((scan (or oldmap keymap))
577 (prefix1 (vconcat prefix [nil]))
578 (key-substitution-in-progress
579 (cons scan key-substitution-in-progress)))
580 ;; Scan OLDMAP, finding each char or event-symbol that
581 ;; has any definition, and act on it with hack-key.
584 (aset prefix1 (length prefix) char)
585 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
588 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
589 (let (inner-def skipped menu-item)
590 ;; Find the actual command name within the binding.
591 (if (eq (car-safe defn) 'menu-item)
592 (setq menu-item defn defn (nth 2 defn))
593 ;; Skip past menu-prompt.
594 (while (stringp (car-safe defn))
595 (push (pop defn) skipped))
596 ;; Skip past cached key-equivalence data for menu items.
597 (if (consp (car-safe defn))
598 (setq defn (cdr defn))))
599 (if (or (eq defn olddef)
600 ;; Compare with equal if definition is a key sequence.
601 ;; That is useful for operating on function-key-map.
602 (and (or (stringp defn) (vectorp defn))
603 (equal defn olddef)))
604 (define-key keymap prefix
606 (let ((copy (copy-sequence menu-item)))
607 (setcar (nthcdr 2 copy) newdef)
609 (nconc (nreverse skipped) newdef)))
610 ;; Look past a symbol that names a keymap.
612 (or (indirect-function defn t) defn))
613 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
614 ;; avoid autoloading a keymap. This is mostly done to preserve the
615 ;; original non-autoloading behavior of pre-map-keymap times.
616 (if (and (keymapp inner-def)
617 ;; Avoid recursively scanning
618 ;; where KEYMAP does not have a submap.
619 (let ((elt (lookup-key keymap prefix)))
620 (or (null elt) (natnump elt) (keymapp elt)))
621 ;; Avoid recursively rescanning keymap being scanned.
622 (not (memq inner-def key-substitution-in-progress)))
623 ;; If this one isn't being scanned already, scan it now.
624 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
627 ;;;; The global keymap tree.
629 ;;; global-map, esc-map, and ctl-x-map have their values set up in
630 ;;; keymap.c; we just give them docstrings here.
632 (defvar global-map nil
633 "Default global keymap mapping Emacs keyboard input into commands.
634 The value is a keymap which is usually (but not necessarily) Emacs's
638 "Default keymap for ESC (meta) commands.
639 The normal global definition of the character ESC indirects to this keymap.")
641 (defvar ctl-x-map nil
642 "Default keymap for C-x commands.
643 The normal global definition of the character C-x indirects to this keymap.")
645 (defvar ctl-x-4-map (make-sparse-keymap)
646 "Keymap for subcommands of C-x 4.")
647 (defalias 'ctl-x-4-prefix ctl-x-4-map)
648 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
650 (defvar ctl-x-5-map (make-sparse-keymap)
651 "Keymap for frame commands.")
652 (defalias 'ctl-x-5-prefix ctl-x-5-map)
653 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
656 ;;;; Event manipulation functions.
658 ;; The call to `read' is to ensure that the value is computed at load time
659 ;; and not compiled into the .elc file. The value is negative on most
660 ;; machines, but not on all!
661 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
663 (defun listify-key-sequence (key)
664 "Convert a key sequence to a list of events."
667 (mapcar (function (lambda (c)
669 (logxor c listify-key-sequence-1)
673 (defsubst eventp (obj)
674 "True if the argument is an event object."
675 (or (and (integerp obj)
676 ;; Filter out integers too large to be events.
677 ;; M is the biggest modifier.
678 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
679 (char-valid-p (event-basic-type obj)))
681 (get obj 'event-symbol-elements))
684 (get (car obj) 'event-symbol-elements))))
686 (defun event-modifiers (event)
687 "Return a list of symbols representing the modifier keys in event EVENT.
688 The elements of the list may include `meta', `control',
689 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
691 EVENT may be an event or an event type. If EVENT is a symbol
692 that has never been used in an event that has been read as input
693 in the current Emacs session, then this function can return nil,
694 even when EVENT actually has modifiers."
697 (setq type (car type)))
699 (cdr (get type 'event-symbol-elements))
701 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
702 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
703 (if (not (zerop (logand type ?\M-\^@)))
705 (if (or (not (zerop (logand type ?\C-\^@)))
707 (push 'control list))
708 (if (or (not (zerop (logand type ?\S-\^@)))
709 (/= char (downcase char)))
711 (or (zerop (logand type ?\H-\^@))
713 (or (zerop (logand type ?\s-\^@))
715 (or (zerop (logand type ?\A-\^@))
719 (defun event-basic-type (event)
720 "Return the basic type of the given event (all modifiers removed).
721 The value is a printing character (not upper case) or a symbol.
722 EVENT may be an event or an event type. If EVENT is a symbol
723 that has never been used in an event that has been read as input
724 in the current Emacs session, then this function may return nil."
726 (setq event (car event)))
728 (car (get event 'event-symbol-elements))
729 (let* ((base (logand event (1- ?\A-\^@)))
730 (uncontrolled (if (< base 32) (logior base 64) base)))
731 ;; There are some numbers that are invalid characters and
732 ;; cause `downcase' to get an error.
734 (downcase uncontrolled)
735 (error uncontrolled)))))
737 (defsubst mouse-movement-p (object)
738 "Return non-nil if OBJECT is a mouse movement event."
739 (eq (car-safe object) 'mouse-movement))
741 (defsubst event-start (event)
742 "Return the starting position of EVENT.
743 If EVENT is a mouse or key press or a mouse click, this returns the location
745 If EVENT is a drag, this returns the drag's starting position.
746 The return value is of the form
747 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
748 IMAGE (DX . DY) (WIDTH . HEIGHT))
749 The `posn-' functions access elements of such lists."
750 (if (consp event) (nth 1 event)
751 (list (selected-window) (point) '(0 . 0) 0)))
753 (defsubst event-end (event)
754 "Return the ending location of EVENT.
755 EVENT should be a click, drag, or key press event.
756 If EVENT is a click event, this function is the same as `event-start'.
757 The return value is of the form
758 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
759 IMAGE (DX . DY) (WIDTH . HEIGHT))
760 The `posn-' functions access elements of such lists."
761 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
762 (list (selected-window) (point) '(0 . 0) 0)))
764 (defsubst event-click-count (event)
765 "Return the multi-click count of EVENT, a click or drag event.
766 The return value is a positive integer."
767 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
769 ;;;; Extracting fields of the positions in an event.
771 (defsubst posn-window (position)
772 "Return the window in POSITION.
773 POSITION should be a list of the form returned by the `event-start'
774 and `event-end' functions."
777 (defsubst posn-area (position)
778 "Return the window area recorded in POSITION, or nil for the text area.
779 POSITION should be a list of the form returned by the `event-start'
780 and `event-end' functions."
781 (let ((area (if (consp (nth 1 position))
782 (car (nth 1 position))
784 (and (symbolp area) area)))
786 (defsubst posn-point (position)
787 "Return the buffer location in POSITION.
788 POSITION should be a list of the form returned by the `event-start'
789 and `event-end' functions."
791 (if (consp (nth 1 position))
792 (car (nth 1 position))
795 (defun posn-set-point (position)
796 "Move point to POSITION.
797 Select the corresponding window as well."
798 (if (not (windowp (posn-window position)))
799 (error "Position not in text area of window"))
800 (select-window (posn-window position))
801 (if (numberp (posn-point position))
802 (goto-char (posn-point position))))
804 (defsubst posn-x-y (position)
805 "Return the x and y coordinates in POSITION.
806 POSITION should be a list of the form returned by the `event-start'
807 and `event-end' functions."
810 (defun posn-col-row (position)
811 "Return the nominal column and row in POSITION, measured in characters.
812 The column and row values are approximations calculated from the x
813 and y coordinates in POSITION and the frame's default character width
815 For a scroll-bar event, the result column is 0, and the row
816 corresponds to the vertical position of the click in the scroll bar.
817 POSITION should be a list of the form returned by the `event-start'
818 and `event-end' functions."
819 (let* ((pair (posn-x-y position))
820 (window (posn-window position))
821 (area (posn-area position)))
825 ((eq area 'vertical-scroll-bar)
826 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
827 ((eq area 'horizontal-scroll-bar)
828 (cons (scroll-bar-scale pair (window-width window)) 0))
830 (let* ((frame (if (framep window) window (window-frame window)))
831 (x (/ (car pair) (frame-char-width frame)))
832 (y (/ (cdr pair) (+ (frame-char-height frame)
833 (or (frame-parameter frame 'line-spacing)
838 (defun posn-actual-col-row (position)
839 "Return the actual column and row in POSITION, measured in characters.
840 These are the actual row number in the window and character number in that row.
841 Return nil if POSITION does not contain the actual position; in that case
842 `posn-col-row' can be used to get approximate values.
843 POSITION should be a list of the form returned by the `event-start'
844 and `event-end' functions."
847 (defsubst posn-timestamp (position)
848 "Return the timestamp of POSITION.
849 POSITION should be a list of the form returned by the `event-start'
850 and `event-end' functions."
853 (defsubst posn-string (position)
854 "Return the string object of POSITION.
855 Value is a cons (STRING . STRING-POS), or nil if not a string.
856 POSITION should be a list of the form returned by the `event-start'
857 and `event-end' functions."
860 (defsubst posn-image (position)
861 "Return the image object of POSITION.
862 Value is an list (image ...), or nil if not an image.
863 POSITION should be a list of the form returned by the `event-start'
864 and `event-end' functions."
867 (defsubst posn-object (position)
868 "Return the object (image or string) of POSITION.
869 Value is a list (image ...) for an image object, a cons cell
870 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
871 POSITION should be a list of the form returned by the `event-start'
872 and `event-end' functions."
873 (or (posn-image position) (posn-string position)))
875 (defsubst posn-object-x-y (position)
876 "Return the x and y coordinates relative to the object of POSITION.
877 POSITION should be a list of the form returned by the `event-start'
878 and `event-end' functions."
881 (defsubst posn-object-width-height (position)
882 "Return the pixel width and height of the object of POSITION.
883 POSITION should be a list of the form returned by the `event-start'
884 and `event-end' functions."
888 ;;;; Obsolescent names for functions.
890 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
891 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
892 (define-obsolete-function-alias 'read-input 'read-string "22.1")
893 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
894 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
895 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
897 (make-obsolete 'char-bytes "now always returns 1." "20.4")
899 (defun insert-string (&rest args)
900 "Mocklisp-compatibility insert function.
901 Like the function `insert' except that any argument that is a number
902 is converted into a string by expressing it in decimal."
904 (insert (if (integerp el) (number-to-string el) el))))
905 (make-obsolete 'insert-string 'insert "22.1")
907 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
908 (make-obsolete 'makehash 'make-hash-table "22.1")
910 ;; Some programs still use this as a function.
912 "Return the value of the `baud-rate' variable."
914 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
916 ;; These are used by VM and some old programs
917 (defalias 'focus-frame 'ignore "")
918 (make-obsolete 'focus-frame "it does nothing." "22.1")
919 (defalias 'unfocus-frame 'ignore "")
920 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
923 ;;;; Obsolescence declarations for variables, and aliases.
925 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
926 (make-obsolete-variable 'mode-line-inverse-video "use the appropriate faces instead." "21.1")
927 (make-obsolete-variable 'unread-command-char
928 "use `unread-command-events' instead. That variable is a list of events to reread, so it now uses nil to mean `no event', instead of -1."
931 ;; Lisp manual only updated in 22.1.
932 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
935 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
936 (make-obsolete-variable 'x-lost-selection-hooks 'x-lost-selection-functions "22.1")
937 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
938 (make-obsolete-variable 'x-sent-selection-hooks 'x-sent-selection-functions "22.1")
940 (defvaralias 'messages-buffer-max-lines 'message-log-max)
942 ;;;; Alternate names for functions - these are not being phased out.
944 (defalias 'send-string 'process-send-string)
945 (defalias 'send-region 'process-send-region)
946 (defalias 'string= 'string-equal)
947 (defalias 'string< 'string-lessp)
948 (defalias 'move-marker 'set-marker)
949 (defalias 'rplaca 'setcar)
950 (defalias 'rplacd 'setcdr)
951 (defalias 'beep 'ding) ;preserve lingual purity
952 (defalias 'indent-to-column 'indent-to)
953 (defalias 'backward-delete-char 'delete-backward-char)
954 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
955 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
956 (defalias 'int-to-string 'number-to-string)
957 (defalias 'store-match-data 'set-match-data)
958 (defalias 'make-variable-frame-localizable 'make-variable-frame-local)
959 ;; These are the XEmacs names:
960 (defalias 'point-at-eol 'line-end-position)
961 (defalias 'point-at-bol 'line-beginning-position)
963 (defalias 'user-original-login-name 'user-login-name)
966 ;;;; Hook manipulation functions.
968 (defun make-local-hook (hook)
969 "Make the hook HOOK local to the current buffer.
970 The return value is HOOK.
972 You never need to call this function now that `add-hook' does it for you
973 if its LOCAL argument is non-nil.
975 When a hook is local, its local and global values
976 work in concert: running the hook actually runs all the hook
977 functions listed in *either* the local value *or* the global value
978 of the hook variable.
980 This function works by making t a member of the buffer-local value,
981 which acts as a flag to run the hook functions in the default value as
982 well. This works for all normal hooks, but does not work for most
983 non-normal hooks yet. We will be changing the callers of non-normal
984 hooks so that they can handle localness; this has to be done one by
987 This function does nothing if HOOK is already local in the current
990 Do not use `make-local-variable' to make a hook variable buffer-local."
991 (if (local-variable-p hook)
993 (or (boundp hook) (set hook nil))
994 (make-local-variable hook)
997 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
999 (defun add-hook (hook function &optional append local)
1000 "Add to the value of HOOK the function FUNCTION.
1001 FUNCTION is not added if already present.
1002 FUNCTION is added (if necessary) at the beginning of the hook list
1003 unless the optional argument APPEND is non-nil, in which case
1004 FUNCTION is added at the end.
1006 The optional fourth argument, LOCAL, if non-nil, says to modify
1007 the hook's buffer-local value rather than its default value.
1008 This makes the hook buffer-local if needed, and it makes t a member
1009 of the buffer-local value. That acts as a flag to run the hook
1010 functions in the default value as well as in the local value.
1012 HOOK should be a symbol, and FUNCTION may be any valid function. If
1013 HOOK is void, it is first set to nil. If HOOK's value is a single
1014 function, it is changed to a list of functions."
1015 (or (boundp hook) (set hook nil))
1016 (or (default-boundp hook) (set-default hook nil))
1017 (if local (unless (local-variable-if-set-p hook)
1018 (set (make-local-variable hook) (list t)))
1019 ;; Detect the case where make-local-variable was used on a hook
1020 ;; and do what we used to do.
1021 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1023 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1024 ;; If the hook value is a single function, turn it into a list.
1025 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1026 (setq hook-value (list hook-value)))
1027 ;; Do the actual addition if necessary
1028 (unless (member function hook-value)
1031 (append hook-value (list function))
1032 (cons function hook-value))))
1033 ;; Set the actual variable
1034 (if local (set hook hook-value) (set-default hook hook-value))))
1036 (defun remove-hook (hook function &optional local)
1037 "Remove from the value of HOOK the function FUNCTION.
1038 HOOK should be a symbol, and FUNCTION may be any valid function. If
1039 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1040 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1042 The optional third argument, LOCAL, if non-nil, says to modify
1043 the hook's buffer-local value rather than its default value."
1044 (or (boundp hook) (set hook nil))
1045 (or (default-boundp hook) (set-default hook nil))
1046 ;; Do nothing if LOCAL is t but this hook has no local binding.
1047 (unless (and local (not (local-variable-p hook)))
1048 ;; Detect the case where make-local-variable was used on a hook
1049 ;; and do what we used to do.
1050 (when (and (local-variable-p hook)
1051 (not (and (consp (symbol-value hook))
1052 (memq t (symbol-value hook)))))
1054 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1055 ;; Remove the function, for both the list and the non-list cases.
1056 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1057 (if (equal hook-value function) (setq hook-value nil))
1058 (setq hook-value (delete function (copy-sequence hook-value))))
1059 ;; If the function is on the global hook, we need to shadow it locally
1060 ;;(when (and local (member function (default-value hook))
1061 ;; (not (member (cons 'not function) hook-value)))
1062 ;; (push (cons 'not function) hook-value))
1063 ;; Set the actual variable
1065 (set-default hook hook-value)
1066 (if (equal hook-value '(t))
1067 (kill-local-variable hook)
1068 (set hook hook-value))))))
1070 (defun add-to-list (list-var element &optional append)
1071 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1072 The test for presence of ELEMENT is done with `equal'.
1073 If ELEMENT is added, it is added at the beginning of the list,
1074 unless the optional argument APPEND is non-nil, in which case
1075 ELEMENT is added at the end.
1077 The return value is the new value of LIST-VAR.
1079 If you want to use `add-to-list' on a variable that is not defined
1080 until a certain package is loaded, you should put the call to `add-to-list'
1081 into a hook function that will be run only after loading the package.
1082 `eval-after-load' provides one way to do this. In some cases
1083 other hooks, such as major mode hooks, can do the job."
1084 (if (member element (symbol-value list-var))
1085 (symbol-value list-var)
1088 (append (symbol-value list-var) (list element))
1089 (cons element (symbol-value list-var))))))
1092 (defun add-to-ordered-list (list-var element &optional order)
1093 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1094 The test for presence of ELEMENT is done with `eq'.
1096 The resulting list is reordered so that the elements are in the
1097 order given by each element's numeric list order. Elements
1098 without a numeric list order are placed at the end of the list.
1100 If the third optional argument ORDER is a number (integer or
1101 float), set the element's list order to the given value. If
1102 ORDER is nil or omitted, do not change the numeric order of
1103 ELEMENT. If ORDER has any other value, remove the numeric order
1104 of ELEMENT if it has one.
1106 The list order for each element is stored in LIST-VAR's
1107 `list-order' property.
1109 The return value is the new value of LIST-VAR."
1110 (let ((ordering (get list-var 'list-order)))
1112 (put list-var 'list-order
1113 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1115 (puthash element (and (numberp order) order) ordering))
1116 (unless (memq element (symbol-value list-var))
1117 (set list-var (cons element (symbol-value list-var))))
1118 (set list-var (sort (symbol-value list-var)
1120 (let ((oa (gethash a ordering))
1121 (ob (gethash b ordering)))
1126 (defun add-to-history (history-var newelt &optional maxelt)
1127 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1128 Return the new history list.
1129 If MAXELT is non-nil, it specifies the maximum length of the history.
1130 Otherwise, the maximum history length is the value of the `history-length'
1131 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1133 Remove duplicates of NEWELT unless `history-delete-duplicates' is nil."
1135 (setq maxelt (or (get history-var 'history-length)
1137 (let ((history (symbol-value history-var))
1139 (if history-delete-duplicates
1140 (setq history (delete newelt history)))
1141 (setq history (cons newelt history))
1142 (when (integerp maxelt)
1145 (setq tail (nthcdr (1- maxelt) history))
1147 (setcdr tail nil))))
1148 (set history-var history)))
1153 (defvar delay-mode-hooks nil
1154 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1155 (defvar delayed-mode-hooks nil
1156 "List of delayed mode hooks waiting to be run.")
1157 (make-variable-buffer-local 'delayed-mode-hooks)
1158 (put 'delay-mode-hooks 'permanent-local t)
1160 (defvar after-change-major-mode-hook nil
1161 "Normal hook run at the very end of major mode functions.")
1163 (defun run-mode-hooks (&rest hooks)
1164 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1165 Execution is delayed if `delay-mode-hooks' is non-nil.
1166 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1167 after running the mode hooks.
1168 Major mode functions should use this."
1169 (if delay-mode-hooks
1171 (dolist (hook hooks)
1172 (push hook delayed-mode-hooks))
1173 ;; Normal case, just run the hook as before plus any delayed hooks.
1174 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1175 (setq delayed-mode-hooks nil)
1176 (apply 'run-hooks hooks)
1177 (run-hooks 'after-change-major-mode-hook)))
1179 (defmacro delay-mode-hooks (&rest body)
1180 "Execute BODY, but delay any `run-mode-hooks'.
1181 These hooks will be executed by the first following call to
1182 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1183 Only affects hooks run in the current buffer."
1184 (declare (debug t) (indent 0))
1186 (make-local-variable 'delay-mode-hooks)
1187 (let ((delay-mode-hooks t))
1190 ;; PUBLIC: find if the current mode derives from another.
1192 (defun derived-mode-p (&rest modes)
1193 "Non-nil if the current major mode is derived from one of MODES.
1194 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1195 (let ((parent major-mode))
1196 (while (and (not (memq parent modes))
1197 (setq parent (get parent 'derived-mode-parent))))
1202 ;; If a minor mode is not defined with define-minor-mode,
1203 ;; add it here explicitly.
1204 ;; isearch-mode is deliberately excluded, since you should
1205 ;; not call it yourself.
1206 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1207 overwrite-mode view-mode
1209 "List of all minor mode functions.")
1211 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1212 "Register a new minor mode.
1214 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1216 TOGGLE is a symbol which is the name of a buffer-local variable that
1217 is toggled on or off to say whether the minor mode is active or not.
1219 NAME specifies what will appear in the mode line when the minor mode
1220 is active. NAME should be either a string starting with a space, or a
1221 symbol whose value is such a string.
1223 Optional KEYMAP is the keymap for the minor mode that will be added
1224 to `minor-mode-map-alist'.
1226 Optional AFTER specifies that TOGGLE should be added after AFTER
1227 in `minor-mode-alist'.
1229 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1230 It defaults to (and should by convention be) TOGGLE.
1232 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1233 included in the mode-line minor mode menu.
1234 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1235 (unless (memq toggle minor-mode-list)
1236 (push toggle minor-mode-list))
1238 (unless toggle-fun (setq toggle-fun toggle))
1239 (unless (eq toggle-fun toggle)
1240 (put toggle :minor-mode-function toggle-fun))
1241 ;; Add the name to the minor-mode-alist.
1243 (let ((existing (assq toggle minor-mode-alist)))
1245 (setcdr existing (list name))
1246 (let ((tail minor-mode-alist) found)
1247 (while (and tail (not found))
1248 (if (eq after (caar tail))
1250 (setq tail (cdr tail))))
1252 (let ((rest (cdr found)))
1254 (nconc found (list (list toggle name)) rest))
1255 (setq minor-mode-alist (cons (list toggle name)
1256 minor-mode-alist)))))))
1257 ;; Add the toggle to the minor-modes menu if requested.
1258 (when (get toggle :included)
1259 (define-key mode-line-mode-menu
1263 (or (get toggle :menu-tag)
1264 (if (stringp name) name (symbol-name toggle)))
1265 (let ((mode-name (if (symbolp name) (symbol-value name))))
1266 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1267 (concat " (" (match-string 0 mode-name) ")"))))
1269 :button (cons :toggle toggle))))
1271 ;; Add the map to the minor-mode-map-alist.
1273 (let ((existing (assq toggle minor-mode-map-alist)))
1275 (setcdr existing keymap)
1276 (let ((tail minor-mode-map-alist) found)
1277 (while (and tail (not found))
1278 (if (eq after (caar tail))
1280 (setq tail (cdr tail))))
1282 (let ((rest (cdr found)))
1284 (nconc found (list (cons toggle keymap)) rest))
1285 (setq minor-mode-map-alist (cons (cons toggle keymap)
1286 minor-mode-map-alist))))))))
1290 ;; (defvar symbol-file-load-history-loaded nil
1291 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1292 ;; That file records the part of `load-history' for preloaded files,
1293 ;; which is cleared out before dumping to make Emacs smaller.")
1295 ;; (defun load-symbol-file-load-history ()
1296 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1297 ;; That file records the part of `load-history' for preloaded files,
1298 ;; which is cleared out before dumping to make Emacs smaller."
1299 ;; (unless symbol-file-load-history-loaded
1300 ;; (load (expand-file-name
1301 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1302 ;; (if (eq system-type 'ms-dos)
1304 ;; (format "fns-%s.el" emacs-version))
1306 ;; ;; The file name fns-%s.el already has a .el extension.
1308 ;; (setq symbol-file-load-history-loaded t)))
1310 (defun symbol-file (symbol &optional type)
1311 "Return the input source in which SYMBOL was defined.
1312 The value is an absolute file name.
1313 It can also be nil, if the definition is not associated with any file.
1315 If TYPE is nil, then any kind of definition is acceptable.
1316 If TYPE is `defun' or `defvar', that specifies function
1317 definition only or variable definition only.
1318 `defface' specifies a face definition only."
1319 (if (and (or (null type) (eq type 'defun))
1320 (symbolp symbol) (fboundp symbol)
1321 (eq 'autoload (car-safe (symbol-function symbol))))
1322 (nth 1 (symbol-function symbol))
1323 (let ((files load-history)
1327 (if (eq type 'defvar)
1328 ;; Variables are present just as their names.
1329 (member symbol (cdr (car files)))
1330 ;; Other types are represented as (TYPE . NAME).
1331 (member (cons type symbol) (cdr (car files))))
1332 ;; We accept all types, so look for variable def
1333 ;; and then for any other kind.
1334 (or (member symbol (cdr (car files)))
1335 (rassq symbol (cdr (car files)))))
1336 (setq file (car (car files)) files nil))
1337 (setq files (cdr files)))
1341 (defun locate-library (library &optional nosuffix path interactive-call)
1342 "Show the precise file name of Emacs library LIBRARY.
1343 This command searches the directories in `load-path' like `\\[load-library]'
1344 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1345 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1346 to the specified name LIBRARY.
1348 If the optional third arg PATH is specified, that list of directories
1349 is used instead of `load-path'.
1351 When called from a program, the file name is normaly returned as a
1352 string. When run interactively, the argument INTERACTIVE-CALL is t,
1353 and the file name is displayed in the echo area."
1354 (interactive (list (completing-read "Locate library: "
1355 'locate-file-completion
1356 (cons load-path (get-load-suffixes)))
1359 (let ((file (locate-file library
1361 (append (unless nosuffix (get-load-suffixes))
1362 load-file-rep-suffixes))))
1363 (if interactive-call
1365 (message "Library is file %s" (abbreviate-file-name file))
1366 (message "No library %s in search path" library)))
1370 ;;;; Specifying things to do later.
1372 (defmacro eval-at-startup (&rest body)
1373 "Make arrangements to evaluate BODY when Emacs starts up.
1374 If this is run after Emacs startup, evaluate BODY immediately.
1377 This works by adding a function to `before-init-hook'.
1378 That function's doc string says which file created it."
1380 (if command-line-processed
1382 (add-hook 'before-init-hook
1383 '(lambda () ,(concat "From " (or load-file-name "no file"))
1388 (defun eval-after-load (file form)
1389 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1390 This makes or adds to an entry on `after-load-alist'.
1391 If FILE is already loaded, evaluate FORM right now.
1392 It does nothing if FORM is already on the list for FILE.
1393 FILE must match exactly. Normally FILE is the name of a library,
1394 with no directory or extension specified, since that is how `load'
1396 FILE can also be a feature (i.e. a symbol), in which case FORM is
1397 evaluated whenever that feature is `provide'd."
1398 (let ((elt (assoc file after-load-alist)))
1399 ;; Make sure there is an element for FILE.
1400 (unless elt (setq elt (list file)) (push elt after-load-alist))
1401 ;; Add FORM to the element if it isn't there.
1402 (unless (member form (cdr elt))
1403 (nconc elt (list form))
1404 ;; If the file has been loaded already, run FORM right away.
1405 (if (if (symbolp file)
1407 ;; Make sure `load-history' contains the files dumped with
1408 ;; Emacs for the case that FILE is one of them.
1409 ;; (load-symbol-file-load-history)
1410 (when (locate-library file)
1411 (assoc (locate-library file) load-history)))
1415 (defun eval-next-after-load (file)
1416 "Read the following input sexp, and run it whenever FILE is loaded.
1417 This makes or adds to an entry on `after-load-alist'.
1418 FILE should be the name of a library, with no directory name."
1419 (eval-after-load file (read)))
1423 ;; open-network-stream is a wrapper around make-network-process.
1425 (when (featurep 'make-network-process)
1426 (defun open-network-stream (name buffer host service)
1427 "Open a TCP connection for a service to a host.
1428 Returns a subprocess-object to represent the connection.
1429 Input and output work as for subprocesses; `delete-process' closes it.
1431 Args are NAME BUFFER HOST SERVICE.
1432 NAME is name for process. It is modified if necessary to make it unique.
1433 BUFFER is the buffer (or buffer name) to associate with the process.
1434 Process output goes at end of that buffer, unless you specify
1435 an output stream or filter function to handle the output.
1436 BUFFER may be also nil, meaning that this process is not associated
1438 HOST is name of the host to connect to, or its IP address.
1439 SERVICE is name of the service desired, or an integer specifying
1440 a port number to connect to."
1441 (make-network-process :name name :buffer buffer
1442 :host host :service service)))
1446 (make-obsolete 'process-kill-without-query
1447 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1449 (defun process-kill-without-query (process &optional flag)
1450 "Say no query needed if PROCESS is running when Emacs is exited.
1451 Optional second argument if non-nil says to require a query.
1452 Value is t if a query was formerly required."
1453 (let ((old (process-query-on-exit-flag process)))
1454 (set-process-query-on-exit-flag process nil)
1457 ;; process plist management
1459 (defun process-get (process propname)
1460 "Return the value of PROCESS' PROPNAME property.
1461 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1462 (plist-get (process-plist process) propname))
1464 (defun process-put (process propname value)
1465 "Change PROCESS' PROPNAME property to VALUE.
1466 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1467 (set-process-plist process
1468 (plist-put (process-plist process) propname value)))
1471 ;;;; Input and display facilities.
1473 (defvar read-quoted-char-radix 8
1474 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1475 Legitimate radix values are 8, 10 and 16.")
1477 (custom-declare-variable-early
1478 'read-quoted-char-radix 8
1479 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1480 Legitimate radix values are 8, 10 and 16."
1481 :type '(choice (const 8) (const 10) (const 16))
1482 :group 'editing-basics)
1484 (defun read-quoted-char (&optional prompt)
1485 "Like `read-char', but do not allow quitting.
1486 Also, if the first character read is an octal digit,
1487 we read any number of octal digits and return the
1488 specified character code. Any nondigit terminates the sequence.
1489 If the terminator is RET, it is discarded;
1490 any other terminator is used itself as input.
1492 The optional argument PROMPT specifies a string to use to prompt the user.
1493 The variable `read-quoted-char-radix' controls which radix to use
1495 (let ((message-log-max nil) done (first t) (code 0) char translated)
1497 (let ((inhibit-quit first)
1498 ;; Don't let C-h get the help message--only help function keys.
1501 "Type the special character you want to use,
1502 or the octal character code.
1503 RET terminates the character code and is discarded;
1504 any other non-digit terminates the character code and is then used as input."))
1505 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1506 (if inhibit-quit (setq quit-flag nil)))
1507 ;; Translate TAB key into control-I ASCII character, and so on.
1508 ;; Note: `read-char' does it using the `ascii-character' property.
1509 ;; We could try and use read-key-sequence instead, but then C-q ESC
1510 ;; or C-q C-x might not return immediately since ESC or C-x might be
1511 ;; bound to some prefix in function-key-map or key-translation-map.
1512 (setq translated char)
1513 (let ((translation (lookup-key function-key-map (vector char))))
1514 (if (arrayp translation)
1515 (setq translated (aref translation 0))))
1516 (cond ((null translated))
1517 ((not (integerp translated))
1518 (setq unread-command-events (list char)
1520 ((/= (logand translated ?\M-\^@) 0)
1521 ;; Turn a meta-character into a character with the 0200 bit set.
1522 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1524 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1525 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1526 (and prompt (setq prompt (message "%s %c" prompt translated))))
1527 ((and (<= ?a (downcase translated))
1528 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1529 (setq code (+ (* code read-quoted-char-radix)
1530 (+ 10 (- (downcase translated) ?a))))
1531 (and prompt (setq prompt (message "%s %c" prompt translated))))
1532 ((and (not first) (eq translated ?\C-m))
1535 (setq unread-command-events (list char)
1537 (t (setq code translated
1542 (defun read-passwd (prompt &optional confirm default)
1543 "Read a password, prompting with PROMPT, and return it.
1544 If optional CONFIRM is non-nil, read the password twice to make sure.
1545 Optional DEFAULT is a default password to use instead of empty input.
1547 This function echoes `.' for each character that the user types.
1548 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1549 C-g quits; if `inhibit-quit' was non-nil around this function,
1550 then it returns nil if the user types C-g.
1552 Once the caller uses the password, it can erase the password
1553 by doing (clear-string STRING)."
1557 (while (not success)
1558 (let ((first (read-passwd prompt nil default))
1559 (second (read-passwd "Confirm password: " nil default)))
1560 (if (equal first second)
1562 (and (arrayp second) (clear-string second))
1563 (setq success first))
1564 (and (arrayp first) (clear-string first))
1565 (and (arrayp second) (clear-string second))
1566 (message "Password not repeated accurately; please start over")
1572 (cursor-in-echo-area t)
1573 (message-log-max nil))
1574 (add-text-properties 0 (length prompt)
1575 minibuffer-prompt-properties prompt)
1576 (while (progn (message "%s%s"
1578 (make-string (length pass) ?.))
1579 (setq c (read-char-exclusive nil t))
1580 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1581 (clear-this-command-keys)
1584 (and (arrayp pass) (clear-string pass))
1586 (if (and (/= c ?\b) (/= c ?\177))
1587 (let* ((new-char (char-to-string c))
1588 (new-pass (concat pass new-char)))
1589 (and (arrayp pass) (clear-string pass))
1590 (clear-string new-char)
1592 (setq pass new-pass))
1593 (if (> (length pass) 0)
1594 (let ((new-pass (substring pass 0 -1)))
1595 (and (arrayp pass) (clear-string pass))
1596 (setq pass new-pass))))))
1598 (or pass default "")))))
1600 ;; This should be used by `call-interactively' for `n' specs.
1601 (defun read-number (prompt &optional default)
1605 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1606 (replace-match (format " (default %s)" default) t t prompt 1)
1607 (replace-regexp-in-string "[ \t]*\\'"
1608 (format " (default %s) " default)
1612 (let ((str (read-from-minibuffer prompt nil nil nil nil
1614 (number-to-string default)))))
1616 ((zerop (length str)) default)
1617 ((stringp str) (read str)))))
1619 (message "Please enter a number.")
1624 ;;; Atomic change groups.
1626 (defmacro atomic-change-group (&rest body)
1627 "Perform BODY as an atomic change group.
1628 This means that if BODY exits abnormally,
1629 all of its changes to the current buffer are undone.
1630 This works regardless of whether undo is enabled in the buffer.
1632 This mechanism is transparent to ordinary use of undo;
1633 if undo is enabled in the buffer and BODY succeeds, the
1634 user can undo the change normally."
1635 (declare (indent 0) (debug t))
1636 (let ((handle (make-symbol "--change-group-handle--"))
1637 (success (make-symbol "--change-group-success--")))
1638 `(let ((,handle (prepare-change-group))
1642 ;; This is inside the unwind-protect because
1643 ;; it enables undo if that was disabled; we need
1644 ;; to make sure that it gets disabled again.
1645 (activate-change-group ,handle)
1648 ;; Either of these functions will disable undo
1649 ;; if it was disabled before.
1651 (accept-change-group ,handle)
1652 (cancel-change-group ,handle))))))
1654 (defun prepare-change-group (&optional buffer)
1655 "Return a handle for the current buffer's state, for a change group.
1656 If you specify BUFFER, make a handle for BUFFER's state instead.
1658 Pass the handle to `activate-change-group' afterward to initiate
1659 the actual changes of the change group.
1661 To finish the change group, call either `accept-change-group' or
1662 `cancel-change-group' passing the same handle as argument. Call
1663 `accept-change-group' to accept the changes in the group as final;
1664 call `cancel-change-group' to undo them all. You should use
1665 `unwind-protect' to make sure the group is always finished. The call
1666 to `activate-change-group' should be inside the `unwind-protect'.
1667 Once you finish the group, don't use the handle again--don't try to
1668 finish the same group twice. For a simple example of correct use, see
1669 the source code of `atomic-change-group'.
1671 The handle records only the specified buffer. To make a multibuffer
1672 change group, call this function once for each buffer you want to
1673 cover, then use `nconc' to combine the returned values, like this:
1675 (nconc (prepare-change-group buffer-1)
1676 (prepare-change-group buffer-2))
1678 You can then activate that multibuffer change group with a single
1679 call to `activate-change-group' and finish it with a single call
1680 to `accept-change-group' or `cancel-change-group'."
1683 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
1684 (list (cons (current-buffer) buffer-undo-list))))
1686 (defun activate-change-group (handle)
1687 "Activate a change group made with `prepare-change-group' (which see)."
1688 (dolist (elt handle)
1689 (with-current-buffer (car elt)
1690 (if (eq buffer-undo-list t)
1691 (setq buffer-undo-list nil)))))
1693 (defun accept-change-group (handle)
1694 "Finish a change group made with `prepare-change-group' (which see).
1695 This finishes the change group by accepting its changes as final."
1696 (dolist (elt handle)
1697 (with-current-buffer (car elt)
1699 (setq buffer-undo-list t)))))
1701 (defun cancel-change-group (handle)
1702 "Finish a change group made with `prepare-change-group' (which see).
1703 This finishes the change group by reverting all of its changes."
1704 (dolist (elt handle)
1705 (with-current-buffer (car elt)
1706 (setq elt (cdr elt))
1708 (if (consp elt) (car elt)))
1710 (if (consp elt) (cdr elt))))
1711 ;; Temporarily truncate the undo log at ELT.
1713 (setcar elt nil) (setcdr elt nil))
1714 (unless (eq last-command 'undo) (undo-start))
1715 ;; Make sure there's no confusion.
1716 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
1717 (error "Undoing to some unrelated state"))
1719 (while (listp pending-undo-list) (undo-more 1))
1720 ;; Reset the modified cons cell ELT to its original content.
1722 (setcar elt old-car)
1723 (setcdr elt old-cdr))
1724 ;; Revert the undo info to what it was when we grabbed the state.
1725 (setq buffer-undo-list elt)))))
1727 ;;;; Display-related functions.
1729 ;; For compatibility.
1730 (defalias 'redraw-modeline 'force-mode-line-update)
1732 (defun force-mode-line-update (&optional all)
1733 "Force redisplay of the current buffer's mode line and header line.
1734 With optional non-nil ALL, force redisplay of all mode lines and
1735 header lines. This function also forces recomputation of the
1736 menu bar menus and the frame title."
1737 (if all (save-excursion (set-buffer (other-buffer))))
1738 (set-buffer-modified-p (buffer-modified-p)))
1740 (defun momentary-string-display (string pos &optional exit-char message)
1741 "Momentarily display STRING in the buffer at POS.
1742 Display remains until next event is input.
1743 Optional third arg EXIT-CHAR can be a character, event or event
1744 description list. EXIT-CHAR defaults to SPC. If the input is
1745 EXIT-CHAR it is swallowed; otherwise it is then available as
1746 input (as a command if nothing else).
1747 Display MESSAGE (optional fourth arg) in the echo area.
1748 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1749 (or exit-char (setq exit-char ?\ ))
1750 (let ((inhibit-read-only t)
1751 ;; Don't modify the undo list at all.
1752 (buffer-undo-list t)
1753 (modified (buffer-modified-p))
1754 (name buffer-file-name)
1760 ;; defeat file locking... don't try this at home, kids!
1761 (setq buffer-file-name nil)
1762 (insert-before-markers string)
1763 (setq insert-end (point))
1764 ;; If the message end is off screen, recenter now.
1765 (if (< (window-end nil t) insert-end)
1766 (recenter (/ (window-height) 2)))
1767 ;; If that pushed message start off the screen,
1768 ;; scroll to start it at the top of the screen.
1769 (move-to-window-line 0)
1774 (message (or message "Type %s to continue editing.")
1775 (single-key-description exit-char))
1777 (if (integerp exit-char)
1780 (setq char (read-char))
1781 (or (eq char exit-char)
1782 (setq unread-command-events (list char))))
1784 ;; `exit-char' is a character, hence it differs
1785 ;; from char, which is an event.
1786 (setq unread-command-events (list char))))
1787 ;; `exit-char' can be an event, or an event description
1789 (setq char (read-event))
1790 (or (eq char exit-char)
1791 (eq char (event-convert-list exit-char))
1792 (setq unread-command-events (list char))))))
1795 (delete-region pos insert-end)))
1796 (setq buffer-file-name name)
1797 (set-buffer-modified-p modified))))
1800 ;;;; Overlay operations
1802 (defun copy-overlay (o)
1803 "Return a copy of overlay O."
1804 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1805 ;; FIXME: there's no easy way to find the
1806 ;; insertion-type of the two markers.
1807 (overlay-buffer o)))
1808 (props (overlay-properties o)))
1810 (overlay-put o1 (pop props) (pop props)))
1813 (defun remove-overlays (&optional beg end name val)
1814 "Clear BEG and END of overlays whose property NAME has value VAL.
1815 Overlays might be moved and/or split.
1816 BEG and END default respectively to the beginning and end of buffer."
1817 (unless beg (setq beg (point-min)))
1818 (unless end (setq end (point-max)))
1820 (setq beg (prog1 end (setq end beg))))
1822 (dolist (o (overlays-in beg end))
1823 (when (eq (overlay-get o name) val)
1824 ;; Either push this overlay outside beg...end
1825 ;; or split it to exclude beg...end
1826 ;; or delete it entirely (if it is contained in beg...end).
1827 (if (< (overlay-start o) beg)
1828 (if (> (overlay-end o) end)
1830 (move-overlay (copy-overlay o)
1831 (overlay-start o) beg)
1832 (move-overlay o end (overlay-end o)))
1833 (move-overlay o (overlay-start o) beg))
1834 (if (> (overlay-end o) end)
1835 (move-overlay o end (overlay-end o))
1836 (delete-overlay o)))))))
1840 (defvar suspend-hook nil
1841 "Normal hook run by `suspend-emacs', before suspending.")
1843 (defvar suspend-resume-hook nil
1844 "Normal hook run by `suspend-emacs', after Emacs is continued.")
1846 (defvar temp-buffer-show-hook nil
1847 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
1848 When the hook runs, the temporary buffer is current, and the window it
1849 was displayed in is selected. This hook is normally set up with a
1850 function to make the buffer read only, and find function names and
1851 variable names in it, provided the major mode is still Help mode.")
1853 (defvar temp-buffer-setup-hook nil
1854 "Normal hook run by `with-output-to-temp-buffer' at the start.
1855 When the hook runs, the temporary buffer is current.
1856 This hook is normally set up with a function to put the buffer in Help
1859 ;; Avoid compiler warnings about this variable,
1860 ;; which has a special meaning on certain system types.
1861 (defvar buffer-file-type nil
1862 "Non-nil if the visited file is a binary file.
1863 This variable is meaningful on MS-DOG and Windows NT.
1864 On those systems, it is automatically local in every buffer.
1865 On other systems, this variable is normally always nil.")
1867 ;; The `assert' macro from the cl package signals
1868 ;; `cl-assertion-failed' at runtime so always define it.
1869 (put 'cl-assertion-failed 'error-conditions '(error))
1870 (put 'cl-assertion-failed 'error-message "Assertion failed")
1873 ;;;; Misc. useful functions.
1875 (defun find-tag-default ()
1876 "Determine default tag to search for, based on text at point.
1877 If there is no plausible default, return nil."
1879 (while (looking-at "\\sw\\|\\s_")
1881 (if (or (re-search-backward "\\sw\\|\\s_"
1882 (save-excursion (beginning-of-line) (point))
1884 (re-search-forward "\\(\\sw\\|\\s_\\)+"
1885 (save-excursion (end-of-line) (point))
1888 (goto-char (match-end 0))
1890 (buffer-substring-no-properties
1892 (progn (forward-sexp -1)
1893 (while (looking-at "\\s'")
1899 (defun play-sound (sound)
1900 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
1901 The following keywords are recognized:
1903 :file FILE - read sound data from FILE. If FILE isn't an
1904 absolute file name, it is searched in `data-directory'.
1906 :data DATA - read sound data from string DATA.
1908 Exactly one of :file or :data must be present.
1910 :volume VOL - set volume to VOL. VOL must an integer in the
1911 range 0..100 or a float in the range 0..1.0. If not specified,
1912 don't change the volume setting of the sound device.
1914 :device DEVICE - play sound on DEVICE. If not specified,
1915 a system-dependent default device name is used."
1916 (if (fboundp 'play-sound-internal)
1917 (play-sound-internal sound)
1918 (error "This Emacs binary lacks sound support")))
1920 (defun shell-quote-argument (argument)
1921 "Quote an argument for passing as argument to an inferior shell."
1922 (if (eq system-type 'ms-dos)
1923 ;; Quote using double quotes, but escape any existing quotes in
1924 ;; the argument with backslashes.
1928 (if (or (null (string-match "[^\"]" argument))
1929 (< (match-end 0) (length argument)))
1930 (while (string-match "[\"]" argument start)
1931 (setq end (match-beginning 0)
1932 result (concat result (substring argument start end)
1933 "\\" (substring argument end (1+ end)))
1935 (concat "\"" result (substring argument start) "\""))
1936 (if (eq system-type 'windows-nt)
1937 (concat "\"" argument "\"")
1938 (if (equal argument "")
1940 ;; Quote everything except POSIX filename characters.
1941 ;; This should be safe enough even for really weird shells.
1942 (let ((result "") (start 0) end)
1943 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
1944 (setq end (match-beginning 0)
1945 result (concat result (substring argument start end)
1946 "\\" (substring argument end (1+ end)))
1948 (concat result (substring argument start)))))))
1950 (defun string-or-null-p (object)
1951 "Return t if OBJECT is a string or nil.
1952 Otherwise, return nil."
1953 (or (stringp object) (null object)))
1955 (defun booleanp (object)
1956 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
1957 (memq object '(nil t)))
1960 ;;;; Support for yanking and text properties.
1962 (defvar yank-excluded-properties)
1964 (defun remove-yank-excluded-properties (start end)
1965 "Remove `yank-excluded-properties' between START and END positions.
1966 Replaces `category' properties with their defined properties."
1967 (let ((inhibit-read-only t))
1968 ;; Replace any `category' property with the properties it stands for.
1969 (unless (memq yank-excluded-properties '(t nil))
1972 (while (< (point) end)
1973 (let ((cat (get-text-property (point) 'category))
1976 (next-single-property-change (point) 'category nil end))
1978 (let (run-end2 original)
1979 (remove-list-of-text-properties (point) run-end '(category))
1980 (while (< (point) run-end)
1981 (setq run-end2 (next-property-change (point) nil run-end))
1982 (setq original (text-properties-at (point)))
1983 (set-text-properties (point) run-end2 (symbol-plist cat))
1984 (add-text-properties (point) run-end2 original)
1985 (goto-char run-end2))))
1986 (goto-char run-end)))))
1987 (if (eq yank-excluded-properties t)
1988 (set-text-properties start end nil)
1989 (remove-list-of-text-properties start end yank-excluded-properties))))
1991 (defvar yank-undo-function)
1993 (defun insert-for-yank (string)
1994 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
1996 See `insert-for-yank-1' for more details."
1998 (while (setq to (next-single-property-change 0 'yank-handler string))
1999 (insert-for-yank-1 (substring string 0 to))
2000 (setq string (substring string to))))
2001 (insert-for-yank-1 string))
2003 (defun insert-for-yank-1 (string)
2004 "Insert STRING at point, stripping some text properties.
2006 Strip text properties from the inserted text according to
2007 `yank-excluded-properties'. Otherwise just like (insert STRING).
2009 If STRING has a non-nil `yank-handler' property on the first character,
2010 the normal insert behavior is modified in various ways. The value of
2011 the yank-handler property must be a list with one to four elements
2012 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2013 When FUNCTION is present and non-nil, it is called instead of `insert'
2014 to insert the string. FUNCTION takes one argument--the object to insert.
2015 If PARAM is present and non-nil, it replaces STRING as the object
2016 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2017 `yank-rectangle', PARAM may be a list of strings to insert as a
2019 If NOEXCLUDE is present and non-nil, the normal removal of the
2020 yank-excluded-properties is not performed; instead FUNCTION is
2021 responsible for removing those properties. This may be necessary
2022 if FUNCTION adjusts point before or after inserting the object.
2023 If UNDO is present and non-nil, it is a function that will be called
2024 by `yank-pop' to undo the insertion of the current object. It is
2025 called with two arguments, the start and end of the current region.
2026 FUNCTION may set `yank-undo-function' to override the UNDO value."
2027 (let* ((handler (and (stringp string)
2028 (get-text-property 0 'yank-handler string)))
2029 (param (or (nth 1 handler) string))
2031 (setq yank-undo-function t)
2032 (if (nth 0 handler) ;; FUNCTION
2033 (funcall (car handler) param)
2035 (unless (nth 2 handler) ;; NOEXCLUDE
2036 (remove-yank-excluded-properties opoint (point)))
2037 (if (eq yank-undo-function t) ;; not set by FUNCTION
2038 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2039 (if (nth 4 handler) ;; COMMAND
2040 (setq this-command (nth 4 handler)))))
2042 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2043 "Insert before point a substring of BUFFER, without text properties.
2044 BUFFER may be a buffer or a buffer name.
2045 Arguments START and END are character positions specifying the substring.
2046 They default to the values of (point-min) and (point-max) in BUFFER."
2047 (let ((opoint (point)))
2048 (insert-buffer-substring buffer start end)
2049 (let ((inhibit-read-only t))
2050 (set-text-properties opoint (point) nil))))
2052 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2053 "Insert before point a part of BUFFER, stripping some text properties.
2054 BUFFER may be a buffer or a buffer name.
2055 Arguments START and END are character positions specifying the substring.
2056 They default to the values of (point-min) and (point-max) in BUFFER.
2057 Strip text properties from the inserted text according to
2058 `yank-excluded-properties'."
2059 ;; Since the buffer text should not normally have yank-handler properties,
2060 ;; there is no need to handle them here.
2061 (let ((opoint (point)))
2062 (insert-buffer-substring buffer start end)
2063 (remove-yank-excluded-properties opoint (point))))
2066 ;;;; Synchronous shell commands.
2068 (defun start-process-shell-command (name buffer &rest args)
2069 "Start a program in a subprocess. Return the process object for it.
2070 NAME is name for process. It is modified if necessary to make it unique.
2071 BUFFER is the buffer (or buffer name) to associate with the process.
2072 Process output goes at end of that buffer, unless you specify
2073 an output stream or filter function to handle the output.
2074 BUFFER may be also nil, meaning that this process is not associated
2076 COMMAND is the name of a shell command.
2077 Remaining arguments are the arguments for the command.
2078 Wildcards and redirection are handled as usual in the shell.
2080 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
2082 ((eq system-type 'vax-vms)
2083 (apply 'start-process name buffer args))
2084 ;; We used to use `exec' to replace the shell with the command,
2085 ;; but that failed to handle (...) and semicolon, etc.
2087 (start-process name buffer shell-file-name shell-command-switch
2088 (mapconcat 'identity args " ")))))
2090 (defun call-process-shell-command (command &optional infile buffer display
2092 "Execute the shell command COMMAND synchronously in separate process.
2093 The remaining arguments are optional.
2094 The program's input comes from file INFILE (nil means `/dev/null').
2095 Insert output in BUFFER before point; t means current buffer;
2096 nil for BUFFER means discard it; 0 means discard and don't wait.
2097 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2098 REAL-BUFFER says what to do with standard output, as above,
2099 while STDERR-FILE says what to do with standard error in the child.
2100 STDERR-FILE may be nil (discard standard error output),
2101 t (mix it with ordinary output), or a file name string.
2103 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2104 Remaining arguments are strings passed as additional arguments for COMMAND.
2105 Wildcards and redirection are handled as usual in the shell.
2107 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2108 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2109 status or a signal description string.
2110 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2112 ((eq system-type 'vax-vms)
2113 (apply 'call-process command infile buffer display args))
2114 ;; We used to use `exec' to replace the shell with the command,
2115 ;; but that failed to handle (...) and semicolon, etc.
2117 (call-process shell-file-name
2118 infile buffer display
2119 shell-command-switch
2120 (mapconcat 'identity (cons command args) " ")))))
2122 ;;;; Lisp macros to do various things temporarily.
2124 (defmacro with-current-buffer (buffer &rest body)
2125 "Execute the forms in BODY with BUFFER as the current buffer.
2126 The value returned is the value of the last form in BODY.
2127 See also `with-temp-buffer'."
2128 (declare (indent 1) (debug t))
2129 `(save-current-buffer
2130 (set-buffer ,buffer)
2133 (defmacro with-selected-window (window &rest body)
2134 "Execute the forms in BODY with WINDOW as the selected window.
2135 The value returned is the value of the last form in BODY.
2137 This macro saves and restores the current buffer, since otherwise
2138 its normal operation could potentially make a different
2139 buffer current. It does not alter the buffer list ordering.
2141 This macro saves and restores the selected window, as well as
2142 the selected window in each frame. If the previously selected
2143 window of some frame is no longer live at the end of BODY, that
2144 frame's selected window is left alone. If the selected window is
2145 no longer live, then whatever window is selected at the end of
2146 BODY remains selected.
2147 See also `with-temp-buffer'."
2148 (declare (indent 1) (debug t))
2149 ;; Most of this code is a copy of save-selected-window.
2150 `(let ((save-selected-window-window (selected-window))
2151 ;; It is necessary to save all of these, because calling
2152 ;; select-window changes frame-selected-window for whatever
2153 ;; frame that window is in.
2154 (save-selected-window-alist
2155 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2157 (save-current-buffer
2159 (progn (select-window ,window 'norecord)
2161 (dolist (elt save-selected-window-alist)
2162 (and (frame-live-p (car elt))
2163 (window-live-p (cadr elt))
2164 (set-frame-selected-window (car elt) (cadr elt))))
2165 (if (window-live-p save-selected-window-window)
2166 (select-window save-selected-window-window 'norecord))))))
2168 (defmacro with-temp-file (file &rest body)
2169 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2170 The value returned is the value of the last form in BODY.
2171 See also `with-temp-buffer'."
2173 (let ((temp-file (make-symbol "temp-file"))
2174 (temp-buffer (make-symbol "temp-buffer")))
2175 `(let ((,temp-file ,file)
2177 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2180 (with-current-buffer ,temp-buffer
2182 (with-current-buffer ,temp-buffer
2184 (write-region (point-min) (point-max) ,temp-file nil 0)))
2185 (and (buffer-name ,temp-buffer)
2186 (kill-buffer ,temp-buffer))))))
2188 (defmacro with-temp-message (message &rest body)
2189 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2190 The original message is restored to the echo area after BODY has finished.
2191 The value returned is the value of the last form in BODY.
2192 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2193 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2194 Use a MESSAGE of \"\" to temporarily clear the echo area."
2196 (let ((current-message (make-symbol "current-message"))
2197 (temp-message (make-symbol "with-temp-message")))
2198 `(let ((,temp-message ,message)
2203 (setq ,current-message (current-message))
2204 (message "%s" ,temp-message))
2207 (if ,current-message
2208 (message "%s" ,current-message)
2211 (defmacro with-temp-buffer (&rest body)
2212 "Create a temporary buffer, and evaluate BODY there like `progn'.
2213 See also `with-temp-file' and `with-output-to-string'."
2214 (declare (indent 0) (debug t))
2215 (let ((temp-buffer (make-symbol "temp-buffer")))
2216 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2218 (with-current-buffer ,temp-buffer
2220 (and (buffer-name ,temp-buffer)
2221 (kill-buffer ,temp-buffer))))))
2223 (defmacro with-output-to-string (&rest body)
2224 "Execute BODY, return the text it sent to `standard-output', as a string."
2225 (declare (indent 0) (debug t))
2226 `(let ((standard-output
2227 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2228 (let ((standard-output standard-output))
2230 (with-current-buffer standard-output
2233 (kill-buffer nil)))))
2235 (defmacro with-local-quit (&rest body)
2236 "Execute BODY, allowing quits to terminate BODY but not escape further.
2237 When a quit terminates BODY, `with-local-quit' returns nil but
2238 requests another quit. That quit will be processed, the next time quitting
2239 is allowed once again."
2240 (declare (debug t) (indent 0))
2241 `(condition-case nil
2242 (let ((inhibit-quit nil))
2244 (quit (setq quit-flag t) nil)))
2246 (defmacro while-no-input (&rest body)
2247 "Execute BODY only as long as there's no pending input.
2248 If input arrives, that ends the execution of BODY,
2249 and `while-no-input' returns t. Quitting makes it return nil.
2250 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2251 (declare (debug t) (indent 0))
2252 (let ((catch-sym (make-symbol "input")))
2255 (let ((throw-on-input ',catch-sym))
2256 (or (not (sit-for 0 0 t))
2259 (defmacro combine-after-change-calls (&rest body)
2260 "Execute BODY, but don't call the after-change functions till the end.
2261 If BODY makes changes in the buffer, they are recorded
2262 and the functions on `after-change-functions' are called several times
2263 when BODY is finished.
2264 The return value is the value of the last form in BODY.
2266 If `before-change-functions' is non-nil, then calls to the after-change
2267 functions can't be deferred, so in that case this macro has no effect.
2269 Do not alter `after-change-functions' or `before-change-functions'
2271 (declare (indent 0) (debug t))
2273 (let ((combine-after-change-calls t))
2275 (combine-after-change-execute)))
2277 ;;;; Constructing completion tables.
2279 (defmacro dynamic-completion-table (fun)
2280 "Use function FUN as a dynamic completion table.
2281 FUN is called with one argument, the string for which completion is required,
2282 and it should return an alist containing all the intended possible
2283 completions. This alist may be a full list of possible completions so that FUN
2284 can ignore the value of its argument. If completion is performed in the
2285 minibuffer, FUN will be called in the buffer from which the minibuffer was
2288 The result of the `dynamic-completion-table' form is a function
2289 that can be used as the ALIST argument to `try-completion' and
2290 `all-completion'. See Info node `(elisp)Programmed Completion'."
2291 (declare (debug (lambda-expr)))
2292 (let ((win (make-symbol "window"))
2293 (string (make-symbol "string"))
2294 (predicate (make-symbol "predicate"))
2295 (mode (make-symbol "mode")))
2296 `(lambda (,string ,predicate ,mode)
2297 (with-current-buffer (let ((,win (minibuffer-selected-window)))
2298 (if (window-live-p ,win) (window-buffer ,win)
2301 ((eq ,mode t) (all-completions ,string (,fun ,string) ,predicate))
2302 ((not ,mode) (try-completion ,string (,fun ,string) ,predicate))
2303 (t (test-completion ,string (,fun ,string) ,predicate)))))))
2305 (defmacro lazy-completion-table (var fun)
2306 ;; We used to have `&rest args' where `args' were evaluated late (at the
2307 ;; time of the call to `fun'), which was counter intuitive. But to get
2308 ;; them to be evaluated early, we have to either use lexical-let (which is
2309 ;; not available in subr.el) or use `(lambda (,str) ...) which prevents the use
2310 ;; of lexical-let in the callers.
2311 ;; So we just removed the argument. Callers can then simply use either of:
2312 ;; (lazy-completion-table var (lambda () (fun x y)))
2314 ;; (lazy-completion-table var `(lambda () (fun ',x ',y)))
2316 ;; (lexical-let ((x x)) ((y y))
2317 ;; (lazy-completion-table var (lambda () (fun x y))))
2318 ;; depending on the behavior they want.
2319 "Initialize variable VAR as a lazy completion table.
2320 If the completion table VAR is used for the first time (e.g., by passing VAR
2321 as an argument to `try-completion'), the function FUN is called with no
2322 arguments. FUN must return the completion table that will be stored in VAR.
2323 If completion is requested in the minibuffer, FUN will be called in the buffer
2324 from which the minibuffer was entered. The return value of
2325 `lazy-completion-table' must be used to initialize the value of VAR.
2327 You should give VAR a non-nil `risky-local-variable' property."
2328 (declare (debug (symbol lambda-expr)))
2329 (let ((str (make-symbol "string")))
2330 `(dynamic-completion-table
2332 (when (functionp ,var)
2336 (defmacro complete-in-turn (a b)
2337 "Create a completion table that first tries completion in A and then in B.
2338 A and B should not be costly (or side-effecting) expressions."
2339 (declare (debug (def-form def-form)))
2340 `(lambda (string predicate mode)
2343 (or (all-completions string ,a predicate)
2344 (all-completions string ,b predicate)))
2346 (or (try-completion string ,a predicate)
2347 (try-completion string ,b predicate)))
2349 (or (test-completion string ,a predicate)
2350 (test-completion string ,b predicate))))))
2352 ;;; Matching and match data.
2354 (defvar save-match-data-internal)
2356 ;; We use save-match-data-internal as the local variable because
2357 ;; that works ok in practice (people should not use that variable elsewhere).
2358 ;; We used to use an uninterned symbol; the compiler handles that properly
2359 ;; now, but it generates slower code.
2360 (defmacro save-match-data (&rest body)
2361 "Execute the BODY forms, restoring the global value of the match data.
2362 The value returned is the value of the last form in BODY."
2363 ;; It is better not to use backquote here,
2364 ;; because that makes a bootstrapping problem
2365 ;; if you need to recompile all the Lisp files using interpreted code.
2366 (declare (indent 0) (debug t))
2368 '((save-match-data-internal (match-data)))
2369 (list 'unwind-protect
2371 ;; It is safe to free (evaporate) markers immediately here,
2372 ;; as Lisp programs should not copy from save-match-data-internal.
2373 '(set-match-data save-match-data-internal 'evaporate))))
2375 (defun match-string (num &optional string)
2376 "Return string of text matched by last search.
2377 NUM specifies which parenthesized expression in the last regexp.
2378 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2379 Zero means the entire text matched by the whole regexp or whole string.
2380 STRING should be given if the last search was by `string-match' on STRING."
2381 (if (match-beginning num)
2383 (substring string (match-beginning num) (match-end num))
2384 (buffer-substring (match-beginning num) (match-end num)))))
2386 (defun match-string-no-properties (num &optional string)
2387 "Return string of text matched by last search, without text properties.
2388 NUM specifies which parenthesized expression in the last regexp.
2389 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2390 Zero means the entire text matched by the whole regexp or whole string.
2391 STRING should be given if the last search was by `string-match' on STRING."
2392 (if (match-beginning num)
2394 (substring-no-properties string (match-beginning num)
2396 (buffer-substring-no-properties (match-beginning num)
2399 (defun looking-back (regexp &optional limit greedy)
2400 "Return non-nil if text before point matches regular expression REGEXP.
2401 Like `looking-at' except matches before point, and is slower.
2402 LIMIT if non-nil speeds up the search by specifying how far back the
2405 If GREEDY is non-nil, extend the match backwards as far as possible,
2406 stopping when a single additional previous character cannot be part
2407 of a match for REGEXP."
2408 (let ((start (point))
2411 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2413 (if (and greedy pos)
2415 (narrow-to-region (point-min) start)
2416 (while (and (> pos (point-min))
2420 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2421 (setq pos (1- pos)))
2424 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2427 (defun subregexp-context-p (regexp pos &optional start)
2428 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2429 A subregexp context is one where a sub-regexp can appear.
2430 A non-subregexp context is for example within brackets, or within a
2431 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2432 If START is non-nil, it should be a position in REGEXP, smaller
2433 than POS, and known to be in a subregexp context."
2434 ;; Here's one possible implementation, with the great benefit that it
2435 ;; reuses the regexp-matcher's own parser, so it understands all the
2436 ;; details of the syntax. A disadvantage is that it needs to match the
2440 (string-match (substring regexp (or start 0) pos) "")
2443 (not (member (cadr err) '("Unmatched [ or [^"
2445 "Trailing backslash")))))
2446 ;; An alternative implementation:
2447 ;; (defconst re-context-re
2448 ;; (let* ((harmless-ch "[^\\[]")
2449 ;; (harmless-esc "\\\\[^{]")
2450 ;; (class-harmless-ch "[^][]")
2451 ;; (class-lb-harmless "[^]:]")
2452 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2453 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2454 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2456 ;; (concat "\\[^?]?"
2457 ;; "\\(" class-harmless-ch
2458 ;; "\\|" class-lb "\\)*"
2459 ;; "\\[?]")) ; special handling for bare [ at end of re
2460 ;; (braces "\\\\{[0-9,]+\\\\}"))
2461 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2462 ;; "\\|" class "\\|" braces "\\)*\\'"))
2463 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2464 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2469 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2470 "The default value of separators for `split-string'.
2472 A regexp matching strings of whitespace. May be locale-dependent
2473 \(as yet unimplemented). Should not match non-breaking spaces.
2475 Warning: binding this to a different value and using it as default is
2476 likely to have undesired semantics.")
2478 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2479 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2480 ;; expression leads to the equivalent implementation that if SEPARATORS
2481 ;; is defaulted, OMIT-NULLS is treated as t.
2482 (defun split-string (string &optional separators omit-nulls)
2483 "Split STRING into substrings bounded by matches for SEPARATORS.
2485 The beginning and end of STRING, and each match for SEPARATORS, are
2486 splitting points. The substrings matching SEPARATORS are removed, and
2487 the substrings between the splitting points are collected as a list,
2490 If SEPARATORS is non-nil, it should be a regular expression matching text
2491 which separates, but is not part of, the substrings. If nil it defaults to
2492 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2493 OMIT-NULLS is forced to t.
2495 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2496 that for the default value of SEPARATORS leading and trailing whitespace
2497 are effectively trimmed). If nil, all zero-length substrings are retained,
2498 which correctly parses CSV format, for example.
2500 Note that the effect of `(split-string STRING)' is the same as
2501 `(split-string STRING split-string-default-separators t)'). In the rare
2502 case that you wish to retain zero-length substrings when splitting on
2503 whitespace, use `(split-string STRING split-string-default-separators)'.
2505 Modifies the match data; use `save-match-data' if necessary."
2506 (let ((keep-nulls (not (if separators omit-nulls t)))
2507 (rexp (or separators split-string-default-separators))
2511 (while (and (string-match rexp string
2513 (= start (match-beginning 0))
2514 (< start (length string)))
2516 (< start (length string)))
2518 (if (or keep-nulls (< start (match-beginning 0)))
2520 (cons (substring string start (match-beginning 0))
2522 (setq start (match-end 0)))
2523 (if (or keep-nulls (< start (length string)))
2525 (cons (substring string start)
2529 ;;;; Replacement in strings.
2531 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2532 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2533 Unless optional argument INPLACE is non-nil, return a new string."
2534 (let ((i (length string))
2535 (newstr (if inplace string (copy-sequence string))))
2538 (if (eq (aref newstr i) fromchar)
2539 (aset newstr i tochar)))
2542 (defun replace-regexp-in-string (regexp rep string &optional
2543 fixedcase literal subexp start)
2544 "Replace all matches for REGEXP with REP in STRING.
2546 Return a new string containing the replacements.
2548 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2549 arguments with the same names of function `replace-match'. If START
2550 is non-nil, start replacements at that index in STRING.
2552 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2553 function. If it is a function, it is called with the actual text of each
2554 match, and its value is used as the replacement text. When REP is called,
2555 the match-data are the result of matching REGEXP against a substring
2558 To replace only the first match (if any), make REGEXP match up to \\'
2559 and replace a sub-expression, e.g.
2560 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2564 ;; To avoid excessive consing from multiple matches in long strings,
2565 ;; don't just call `replace-match' continually. Walk down the
2566 ;; string looking for matches of REGEXP and building up a (reversed)
2567 ;; list MATCHES. This comprises segments of STRING which weren't
2568 ;; matched interspersed with replacements for segments that were.
2569 ;; [For a `large' number of replacements it's more efficient to
2570 ;; operate in a temporary buffer; we can't tell from the function's
2571 ;; args whether to choose the buffer-based implementation, though it
2572 ;; might be reasonable to do so for long enough STRING.]
2573 (let ((l (length string))
2574 (start (or start 0))
2577 (while (and (< start l) (string-match regexp string start))
2578 (setq mb (match-beginning 0)
2580 ;; If we matched the empty string, make sure we advance by one char
2581 (when (= me mb) (setq me (min l (1+ mb))))
2582 ;; Generate a replacement for the matched substring.
2583 ;; Operate only on the substring to minimize string consing.
2584 ;; Set up match data for the substring for replacement;
2585 ;; presumably this is likely to be faster than munging the
2586 ;; match data directly in Lisp.
2587 (string-match regexp (setq str (substring string mb me)))
2589 (cons (replace-match (if (stringp rep)
2591 (funcall rep (match-string 0 str)))
2592 fixedcase literal str subexp)
2593 (cons (substring string start mb) ; unmatched prefix
2596 ;; Reconstruct a string from the pieces.
2597 (setq matches (cons (substring string start l) matches)) ; leftover
2598 (apply #'concat (nreverse matches)))))
2600 ;;;; invisibility specs
2602 (defun add-to-invisibility-spec (element)
2603 "Add ELEMENT to `buffer-invisibility-spec'.
2604 See documentation for `buffer-invisibility-spec' for the kind of elements
2606 (if (eq buffer-invisibility-spec t)
2607 (setq buffer-invisibility-spec (list t)))
2608 (setq buffer-invisibility-spec
2609 (cons element buffer-invisibility-spec)))
2611 (defun remove-from-invisibility-spec (element)
2612 "Remove ELEMENT from `buffer-invisibility-spec'."
2613 (if (consp buffer-invisibility-spec)
2614 (setq buffer-invisibility-spec (delete element buffer-invisibility-spec))))
2618 (defmacro with-syntax-table (table &rest body)
2619 "Evaluate BODY with syntax table of current buffer set to TABLE.
2620 The syntax table of the current buffer is saved, BODY is evaluated, and the
2621 saved table is restored, even in case of an abnormal exit.
2622 Value is what BODY returns."
2624 (let ((old-table (make-symbol "table"))
2625 (old-buffer (make-symbol "buffer")))
2626 `(let ((,old-table (syntax-table))
2627 (,old-buffer (current-buffer)))
2630 (set-syntax-table ,table)
2632 (save-current-buffer
2633 (set-buffer ,old-buffer)
2634 (set-syntax-table ,old-table))))))
2636 (defun make-syntax-table (&optional oldtable)
2637 "Return a new syntax table.
2638 Create a syntax table which inherits from OLDTABLE (if non-nil) or
2639 from `standard-syntax-table' otherwise."
2640 (let ((table (make-char-table 'syntax-table nil)))
2641 (set-char-table-parent table (or oldtable (standard-syntax-table)))
2644 (defun syntax-after (pos)
2645 "Return the raw syntax of the char after POS.
2646 If POS is outside the buffer's accessible portion, return nil."
2647 (unless (or (< pos (point-min)) (>= pos (point-max)))
2648 (let ((st (if parse-sexp-lookup-properties
2649 (get-char-property pos 'syntax-table))))
2651 (aref (or st (syntax-table)) (char-after pos))))))
2653 (defun syntax-class (syntax)
2654 "Return the syntax class part of the syntax descriptor SYNTAX.
2655 If SYNTAX is nil, return nil."
2656 (and syntax (logand (car syntax) 65535)))
2660 (defun text-clone-maintain (ol1 after beg end &optional len)
2661 "Propagate the changes made under the overlay OL1 to the other clones.
2662 This is used on the `modification-hooks' property of text clones."
2663 (when (and after (not undo-in-progress) (overlay-start ol1))
2664 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
2665 (setq beg (max beg (+ (overlay-start ol1) margin)))
2666 (setq end (min end (- (overlay-end ol1) margin)))
2669 (when (overlay-get ol1 'text-clone-syntax)
2670 ;; Check content of the clone's text.
2671 (let ((cbeg (+ (overlay-start ol1) margin))
2672 (cend (- (overlay-end ol1) margin)))
2675 (if (not (re-search-forward
2676 (overlay-get ol1 'text-clone-syntax) cend t))
2677 ;; Mark the overlay for deletion.
2678 (overlay-put ol1 'text-clones nil)
2679 (when (< (match-end 0) cend)
2680 ;; Shrink the clone at its end.
2681 (setq end (min end (match-end 0)))
2682 (move-overlay ol1 (overlay-start ol1)
2683 (+ (match-end 0) margin)))
2684 (when (> (match-beginning 0) cbeg)
2685 ;; Shrink the clone at its beginning.
2686 (setq beg (max (match-beginning 0) beg))
2687 (move-overlay ol1 (- (match-beginning 0) margin)
2688 (overlay-end ol1)))))))
2689 ;; Now go ahead and update the clones.
2690 (let ((head (- beg (overlay-start ol1)))
2691 (tail (- (overlay-end ol1) end))
2692 (str (buffer-substring beg end))
2694 (inhibit-modification-hooks t))
2695 (dolist (ol2 (overlay-get ol1 'text-clones))
2696 (let ((oe (overlay-end ol2)))
2697 (unless (or (eq ol1 ol2) (null oe))
2698 (setq nothing-left nil)
2699 (let ((mod-beg (+ (overlay-start ol2) head)))
2700 ;;(overlay-put ol2 'modification-hooks nil)
2701 (goto-char (- (overlay-end ol2) tail))
2702 (unless (> mod-beg (point))
2703 (save-excursion (insert str))
2704 (delete-region mod-beg (point)))
2705 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
2707 (if nothing-left (delete-overlay ol1))))))))
2709 (defun text-clone-create (start end &optional spreadp syntax)
2710 "Create a text clone of START...END at point.
2711 Text clones are chunks of text that are automatically kept identical:
2712 changes done to one of the clones will be immediately propagated to the other.
2714 The buffer's content at point is assumed to be already identical to
2715 the one between START and END.
2716 If SYNTAX is provided it's a regexp that describes the possible text of
2717 the clones; the clone will be shrunk or killed if necessary to ensure that
2718 its text matches the regexp.
2719 If SPREADP is non-nil it indicates that text inserted before/after the
2720 clone should be incorporated in the clone."
2721 ;; To deal with SPREADP we can either use an overlay with `nil t' along
2722 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
2723 ;; (with a one-char margin at each end) with `t nil'.
2724 ;; We opted for a larger overlay because it behaves better in the case
2725 ;; where the clone is reduced to the empty string (we want the overlay to
2726 ;; stay when the clone's content is the empty string and we want to use
2727 ;; `evaporate' to make sure those overlays get deleted when needed).
2729 (let* ((pt-end (+ (point) (- end start)))
2730 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
2732 (end-margin (if (or (not spreadp)
2733 (>= pt-end (point-max))
2734 (>= start (point-max)))
2736 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
2737 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
2738 (dups (list ol1 ol2)))
2739 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
2740 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
2741 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
2742 ;;(overlay-put ol1 'face 'underline)
2743 (overlay-put ol1 'evaporate t)
2744 (overlay-put ol1 'text-clones dups)
2746 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
2747 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
2748 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
2749 ;;(overlay-put ol2 'face 'underline)
2750 (overlay-put ol2 'evaporate t)
2751 (overlay-put ol2 'text-clones dups)))
2753 ;;;; Mail user agents.
2755 ;; Here we include just enough for other packages to be able
2758 (defun define-mail-user-agent (symbol composefunc sendfunc
2759 &optional abortfunc hookvar)
2760 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
2762 SYMBOL can be any Lisp symbol. Its function definition and/or
2763 value as a variable do not matter for this usage; we use only certain
2764 properties on its property list, to encode the rest of the arguments.
2766 COMPOSEFUNC is program callable function that composes an outgoing
2767 mail message buffer. This function should set up the basics of the
2768 buffer without requiring user interaction. It should populate the
2769 standard mail headers, leaving the `to:' and `subject:' headers blank
2772 COMPOSEFUNC should accept several optional arguments--the same
2773 arguments that `compose-mail' takes. See that function's documentation.
2775 SENDFUNC is the command a user would run to send the message.
2777 Optional ABORTFUNC is the command a user would run to abort the
2778 message. For mail packages that don't have a separate abort function,
2779 this can be `kill-buffer' (the equivalent of omitting this argument).
2781 Optional HOOKVAR is a hook variable that gets run before the message
2782 is actually sent. Callers that use the `mail-user-agent' may
2783 install a hook function temporarily on this hook variable.
2784 If HOOKVAR is nil, `mail-send-hook' is used.
2786 The properties used on SYMBOL are `composefunc', `sendfunc',
2787 `abortfunc', and `hookvar'."
2788 (put symbol 'composefunc composefunc)
2789 (put symbol 'sendfunc sendfunc)
2790 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
2791 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
2793 ;;;; Progress reporters.
2795 ;; Progress reporter has the following structure:
2797 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
2804 ;; This weirdeness is for optimization reasons: we want
2805 ;; `progress-reporter-update' to be as fast as possible, so
2806 ;; `(car reporter)' is better than `(aref reporter 0)'.
2808 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
2809 ;; digits of precision, it doesn't really matter here. On the other
2810 ;; hand, it greatly simplifies the code.
2812 (defsubst progress-reporter-update (reporter value)
2813 "Report progress of an operation in the echo area.
2814 However, if the change since last echo area update is too small
2815 or not enough time has passed, then do nothing (see
2816 `make-progress-reporter' for details).
2818 First parameter, REPORTER, should be the result of a call to
2819 `make-progress-reporter'. Second, VALUE, determines the actual
2820 progress of operation; it must be between MIN-VALUE and MAX-VALUE
2821 as passed to `make-progress-reporter'.
2823 This function is very inexpensive, you may not bother how often
2825 (when (>= value (car reporter))
2826 (progress-reporter-do-update reporter value)))
2828 (defun make-progress-reporter (message min-value max-value
2829 &optional current-value
2830 min-change min-time)
2831 "Return progress reporter object to be used with `progress-reporter-update'.
2833 MESSAGE is shown in the echo area. When at least 1% of operation
2834 is complete, the exact percentage will be appended to the
2835 MESSAGE. When you call `progress-reporter-done', word \"done\"
2836 is printed after the MESSAGE. You can change MESSAGE of an
2837 existing progress reporter with `progress-reporter-force-update'.
2839 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
2840 final (100% complete) states of operation. The latter should be
2841 larger; if this is not the case, then simply negate all values.
2842 Optional CURRENT-VALUE specifies the progress by the moment you
2843 call this function. You should omit it or set it to nil in most
2844 cases since it defaults to MIN-VALUE.
2846 Optional MIN-CHANGE determines the minimal change in percents to
2847 report (default is 1%.) Optional MIN-TIME specifies the minimal
2848 time before echo area updates (default is 0.2 seconds.) If
2849 `float-time' function is not present, then time is not tracked
2850 at all. If OS is not capable of measuring fractions of seconds,
2851 then this parameter is effectively rounded up."
2854 (setq min-time 0.2))
2856 (cons min-value ;; Force a call to `message' now
2857 (vector (if (and (fboundp 'float-time)
2863 (if min-change (max (min min-change 50) 1) 1)
2865 (progress-reporter-update reporter (or current-value min-value))
2868 (defun progress-reporter-force-update (reporter value &optional new-message)
2869 "Report progress of an operation in the echo area unconditionally.
2871 First two parameters are the same as for
2872 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
2873 change the displayed message."
2874 (let ((parameters (cdr reporter)))
2876 (aset parameters 3 new-message))
2877 (when (aref parameters 0)
2878 (aset parameters 0 (float-time)))
2879 (progress-reporter-do-update reporter value)))
2881 (defun progress-reporter-do-update (reporter value)
2882 (let* ((parameters (cdr reporter))
2883 (min-value (aref parameters 1))
2884 (max-value (aref parameters 2))
2885 (one-percent (/ (- max-value min-value) 100.0))
2886 (percentage (if (= max-value min-value)
2888 (truncate (/ (- value min-value) one-percent))))
2889 (update-time (aref parameters 0))
2890 (current-time (float-time))
2892 ;; See if enough time has passed since the last update.
2893 (or (not update-time)
2894 (when (>= current-time update-time)
2895 ;; Calculate time for the next update
2896 (aset parameters 0 (+ update-time (aref parameters 5)))))))
2898 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
2899 ;; message this time because not enough time has passed, then use
2900 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
2901 ;; updates closer to MIN-TIME.
2903 (min (+ min-value (* (+ percentage
2904 (if enough-time-passed
2905 (aref parameters 4) ;; MIN-CHANGE
2909 (when (integerp value)
2910 (setcar reporter (ceiling (car reporter))))
2912 ;; Only print message if enough time has passed
2913 (when enough-time-passed
2914 (if (> percentage 0)
2915 (message "%s%d%%" (aref parameters 3) percentage)
2916 (message "%s" (aref parameters 3))))))
2918 (defun progress-reporter-done (reporter)
2919 "Print reporter's message followed by word \"done\" in echo area."
2920 (message "%sdone" (aref (cdr reporter) 3)))
2922 (defmacro dotimes-with-progress-reporter (spec message &rest body)
2923 "Loop a certain number of times and report progress in the echo area.
2924 Evaluate BODY with VAR bound to successive integers running from
2925 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
2926 the return value (nil if RESULT is omitted).
2928 At each iteration MESSAGE followed by progress percentage is
2929 printed in the echo area. After the loop is finished, MESSAGE
2930 followed by word \"done\" is printed. This macro is a
2931 convenience wrapper around `make-progress-reporter' and friends.
2933 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
2934 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
2935 (let ((temp (make-symbol "--dotimes-temp--"))
2936 (temp2 (make-symbol "--dotimes-temp2--"))
2940 (,(car spec) ,start)
2941 (,temp2 (make-progress-reporter ,message ,start ,end)))
2942 (while (< ,(car spec) ,temp)
2944 (progress-reporter-update ,temp2
2945 (setq ,(car spec) (1+ ,(car spec)))))
2946 (progress-reporter-done ,temp2)
2947 nil ,@(cdr (cdr spec)))))
2950 ;;;; Comparing version strings.
2952 (defvar version-separator "."
2953 "*Specify the string used to separate the version elements.
2955 Usually the separator is \".\", but it can be any other string.")
2958 (defvar version-regexp-alist
2959 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
2960 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
2961 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
2962 ("^[-_+ ]?b\\(eta\\)?$" . -2)
2963 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
2964 "*Specify association between non-numeric version part and a priority.
2966 This association is used to handle version string like \"1.0pre2\",
2967 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
2968 non-numeric part to an integer. For example:
2970 String Version Integer List Version
2971 \"1.0pre2\" (1 0 -1 2)
2972 \"1.0PRE2\" (1 0 -1 2)
2973 \"22.8beta3\" (22 8 -2 3)
2974 \"22.8 Beta3\" (22 8 -2 3)
2975 \"0.9alpha1\" (0 9 -3 1)
2976 \"0.9AlphA1\" (0 9 -3 1)
2977 \"0.9 alpha\" (0 9 -3)
2979 Each element has the following form:
2985 REGEXP regexp used to match non-numeric part of a version string.
2986 It should begin with a `^' anchor and end with a `$' to
2987 prevent false hits. Letter-case is ignored while matching
2990 PRIORITY negative integer which indicate the non-numeric priority.")
2993 (defun version-to-list (ver)
2994 "Convert version string VER into an integer list.
2996 The version syntax is given by the following EBNF:
2998 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3000 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3002 SEPARATOR ::= `version-separator' (which see)
3003 | `version-regexp-alist' (which see).
3005 The NUMBER part is optional if SEPARATOR is a match for an element
3006 in `version-regexp-alist'.
3008 As an example of valid version syntax:
3010 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3012 As an example of invalid version syntax:
3014 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3016 As an example of version convertion:
3018 String Version Integer List Version
3019 \"1.0.7.5\" (1 0 7 5)
3020 \"1.0pre2\" (1 0 -1 2)
3021 \"1.0PRE2\" (1 0 -1 2)
3022 \"22.8beta3\" (22 8 -2 3)
3023 \"22.8Beta3\" (22 8 -2 3)
3024 \"0.9alpha1\" (0 9 -3 1)
3025 \"0.9AlphA1\" (0 9 -3 1)
3026 \"0.9alpha\" (0 9 -3)
3028 See documentation for `version-separator' and `version-regexp-alist'."
3029 (or (and (stringp ver) (> (length ver) 0))
3030 (error "Invalid version string: '%s'" ver))
3031 ;; Change .x.y to 0.x.y
3032 (if (and (>= (length ver) (length version-separator))
3033 (string-equal (substring ver 0 (length version-separator))
3035 (setq ver (concat "0" ver)))
3038 (case-fold-search t) ; ignore case in matching
3040 (while (and (setq s (string-match "[0-9]+" ver i))
3042 ;; handle numeric part
3043 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3046 ;; handle non-numeric part
3047 (when (and (setq s (string-match "[^0-9]+" ver i))
3049 (setq s (substring ver i (match-end 0))
3051 ;; handle alpha, beta, pre, etc. separator
3052 (unless (string= s version-separator)
3053 (setq al version-regexp-alist)
3054 (while (and al (not (string-match (caar al) s)))
3056 (or al (error "Invalid version syntax: '%s'" ver))
3057 (setq lst (cons (cdar al) lst)))))
3059 (error "Invalid version syntax: '%s'" ver)
3063 (defun version-list-< (l1 l2)
3064 "Return t if integer list L1 is lesser than L2.
3066 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3067 etc. That is, the trailing zeroes are irrelevant. Also, integer
3068 list (1) is greater than (1 -1) which is greater than (1 -2)
3069 which is greater than (1 -3)."
3070 (while (and l1 l2 (= (car l1) (car l2)))
3074 ;; l1 not null and l2 not null
3075 ((and l1 l2) (< (car l1) (car l2)))
3076 ;; l1 null and l2 null ==> l1 length = l2 length
3077 ((and (null l1) (null l2)) nil)
3078 ;; l1 not null and l2 null ==> l1 length > l2 length
3079 (l1 (< (version-list-not-zero l1) 0))
3080 ;; l1 null and l2 not null ==> l2 length > l1 length
3081 (t (< 0 (version-list-not-zero l2)))))
3084 (defun version-list-= (l1 l2)
3085 "Return t if integer list L1 is equal to L2.
3087 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3088 etc. That is, the trailing zeroes are irrelevant. Also, integer
3089 list (1) is greater than (1 -1) which is greater than (1 -2)
3090 which is greater than (1 -3)."
3091 (while (and l1 l2 (= (car l1) (car l2)))
3095 ;; l1 not null and l2 not null
3097 ;; l1 null and l2 null ==> l1 length = l2 length
3098 ((and (null l1) (null l2)))
3099 ;; l1 not null and l2 null ==> l1 length > l2 length
3100 (l1 (zerop (version-list-not-zero l1)))
3101 ;; l1 null and l2 not null ==> l2 length > l1 length
3102 (t (zerop (version-list-not-zero l2)))))
3105 (defun version-list-<= (l1 l2)
3106 "Return t if integer list L1 is lesser than or equal to L2.
3108 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3109 etc. That is, the trailing zeroes are irrelevant. Also, integer
3110 list (1) is greater than (1 -1) which is greater than (1 -2)
3111 which is greater than (1 -3)."
3112 (while (and l1 l2 (= (car l1) (car l2)))
3116 ;; l1 not null and l2 not null
3117 ((and l1 l2) (< (car l1) (car l2)))
3118 ;; l1 null and l2 null ==> l1 length = l2 length
3119 ((and (null l1) (null l2)))
3120 ;; l1 not null and l2 null ==> l1 length > l2 length
3121 (l1 (<= (version-list-not-zero l1) 0))
3122 ;; l1 null and l2 not null ==> l2 length > l1 length
3123 (t (<= 0 (version-list-not-zero l2)))))
3125 (defun version-list-not-zero (lst)
3126 "Return the first non-zero element of integer list LST.
3128 If all LST elements are zeroes or LST is nil, return zero."
3129 (while (and lst (zerop (car lst)))
3130 (setq lst (cdr lst)))
3133 ;; there is no element different of zero
3137 (defun version< (v1 v2)
3138 "Return t if version V1 is lesser than V2.
3140 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3141 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3142 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3144 (version-list-< (version-to-list v1) (version-to-list v2)))
3147 (defun version<= (v1 v2)
3148 "Return t if version V1 is lesser than or equal to V2.
3150 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3151 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3152 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3154 (version-list-<= (version-to-list v1) (version-to-list v2)))
3156 (defun version= (v1 v2)
3157 "Return t if version V1 is equal to V2.
3159 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3160 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3161 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3163 (version-list-= (version-to-list v1) (version-to-list v2)))
3167 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3168 ;;; subr.el ends here