1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000, 2001
4 ;; Free Software Foundation, Inc.
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
26 (defvar custom-declare-variable-list nil
27 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
28 Each element of this list holds the arguments to one call to `defcustom'.")
30 ;; Use this, rather than defcustom, in subr.el and other files loaded
32 (defun custom-declare-variable-early (&rest arguments)
33 (setq custom-declare-variable-list
34 (cons arguments custom-declare-variable-list)))
36 ;;;; Lisp language features.
40 (defmacro lambda (&rest cdr)
41 "Return a lambda expression.
42 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
43 self-quoting; the result of evaluating the lambda expression is the
44 expression itself. The lambda expression may then be treated as a
45 function, i.e., stored as the function value of a symbol, passed to
46 funcall or mapcar, etc.
48 ARGS should take the same form as an argument list for a `defun'.
49 DOCSTRING is an optional documentation string.
50 If present, it should describe how to call the function.
51 But documentation strings are usually not useful in nameless functions.
52 INTERACTIVE should be a call to the function `interactive', which see.
53 It may also be omitted.
54 BODY should be a list of lisp expressions."
55 ;; Note that this definition should not use backquotes; subr.el should not
56 ;; depend on backquote.el.
57 (list 'function (cons 'lambda cdr)))
59 (defmacro push (newelt listname)
60 "Add NEWELT to the list stored in the symbol LISTNAME.
61 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
62 LISTNAME must be a symbol."
64 (list 'cons newelt listname)))
66 (defmacro pop (listname)
67 "Return the first element of LISTNAME's value, and remove it from the list.
68 LISTNAME must be a symbol whose value is a list.
69 If the value is nil, `pop' returns nil but does not actually
71 (list 'prog1 (list 'car listname)
72 (list 'setq listname (list 'cdr listname))))
74 (defmacro when (cond &rest body)
75 "If COND yields non-nil, do BODY, else return nil."
76 (list 'if cond (cons 'progn body)))
78 (defmacro unless (cond &rest body)
79 "If COND yields nil, do BODY, else return nil."
80 (cons 'if (cons cond (cons nil body))))
82 (defmacro dolist (spec &rest body)
83 "(dolist (VAR LIST [RESULT]) BODY...): loop over a list.
84 Evaluate BODY with VAR bound to each car from LIST, in turn.
85 Then evaluate RESULT to get return value, default nil."
86 (let ((temp (make-symbol "--dolist-temp--")))
87 (list 'let (list (list temp (nth 1 spec)) (car spec))
89 (list 'setq (car spec) (list 'car temp))
92 (list (list 'setq temp (list 'cdr temp))))))
95 (cons (list 'setq (car spec) nil) (cdr (cdr spec))))))))
97 (defmacro dotimes (spec &rest body)
98 "(dotimes (VAR COUNT [RESULT]) BODY...): loop a certain number of times.
99 Evaluate BODY with VAR bound to successive integers running from 0,
100 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
101 the return value (nil if RESULT is omitted)."
102 (let ((temp (make-symbol "--dotimes-temp--")))
103 (list 'let (list (list temp (nth 1 spec)) (list (car spec) 0))
104 (list 'while (list '< (car spec) temp)
106 (append body (list (list 'setq (car spec)
107 (list '1+ (car spec)))))))
109 (car (cdr (cdr spec)))
113 "Return the car of the car of X."
117 "Return the car of the cdr of X."
121 "Return the cdr of the car of X."
125 "Return the cdr of the cdr of X."
128 (defun last (x &optional n)
129 "Return the last link of the list X. Its car is the last element.
130 If X is nil, return nil.
131 If N is non-nil, return the Nth-to-last link of X.
132 If N is bigger than the length of X, return X."
136 (setq m (1+ m) p (cdr p)))
138 (if (< n m) (nthcdr (- m n) x) x)))
139 (while (consp (cdr x))
143 (defun butlast (x &optional n)
144 "Returns a copy of LIST with the last N elements removed."
145 (if (and n (<= n 0)) x
146 (nbutlast (copy-sequence x) n)))
148 (defun nbutlast (x &optional n)
149 "Modifies LIST to remove the last N elements."
150 (let ((m (length x)))
154 (if (> n 0) (setcdr (nthcdr (- (1- m) n) x) nil))
157 (defun remove (elt seq)
158 "Return a copy of SEQ with all occurences of ELT removed.
159 SEQ must be a list, vector, or string. The comparison is done with `equal'."
161 ;; If SEQ isn't a list, there's no need to copy SEQ because
162 ;; `delete' will return a new object.
164 (delete elt (copy-sequence seq))))
166 (defun remq (elt list)
167 "Return a copy of LIST with all occurences of ELT removed.
168 The comparison is done with `eq'."
170 (delq elt (copy-sequence list))
173 (defun assoc-default (key alist &optional test default)
174 "Find object KEY in a pseudo-alist ALIST.
175 ALIST is a list of conses or objects. Each element (or the element's car,
176 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
177 If that is non-nil, the element matches;
178 then `assoc-default' returns the element's cdr, if it is a cons,
179 or DEFAULT if the element is not a cons.
181 If no element matches, the value is nil.
182 If TEST is omitted or nil, `equal' is used."
183 (let (found (tail alist) value)
184 (while (and tail (not found))
185 (let ((elt (car tail)))
186 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
187 (setq found t value (if (consp elt) (cdr elt) default))))
188 (setq tail (cdr tail)))
191 (defun assoc-ignore-case (key alist)
192 "Like `assoc', but ignores differences in case and text representation.
193 KEY must be a string. Upper-case and lower-case letters are treated as equal.
194 Unibyte strings are converted to multibyte for comparison."
196 (while (and alist (not element))
197 (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil t))
198 (setq element (car alist)))
199 (setq alist (cdr alist)))
202 (defun assoc-ignore-representation (key alist)
203 "Like `assoc', but ignores differences in text representation.
204 KEY must be a string.
205 Unibyte strings are converted to multibyte for comparison."
207 (while (and alist (not element))
208 (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil))
209 (setq element (car alist)))
210 (setq alist (cdr alist)))
213 (defun member-ignore-case (elt list)
214 "Like `member', but ignores differences in case and text representation.
215 ELT must be a string. Upper-case and lower-case letters are treated as equal.
216 Unibyte strings are converted to multibyte for comparison."
217 (while (and list (not (eq t (compare-strings elt 0 nil (car list) 0 nil t))))
218 (setq list (cdr list)))
228 ;Prevent the \{...} documentation construct
229 ;from mentioning keys that run this command.
230 (put 'undefined 'suppress-keymap t)
232 (defun suppress-keymap (map &optional nodigits)
233 "Make MAP override all normally self-inserting keys to be undefined.
234 Normally, as an exception, digits and minus-sign are set to make prefix args,
235 but optional second arg NODIGITS non-nil treats them like other chars."
236 (substitute-key-definition 'self-insert-command 'undefined map global-map)
239 (define-key map "-" 'negative-argument)
240 ;; Make plain numbers do numeric args.
243 (define-key map (char-to-string loop) 'digit-argument)
244 (setq loop (1+ loop))))))
247 ;(defun copy-keymap (keymap)
248 ; "Return a copy of KEYMAP"
249 ; (while (not (keymapp keymap))
250 ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap))))
251 ; (if (vectorp keymap)
252 ; (copy-sequence keymap)
253 ; (copy-alist keymap)))
255 (defvar key-substitution-in-progress nil
256 "Used internally by substitute-key-definition.")
258 (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
259 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
260 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
261 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
262 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP."
263 ;; Don't document PREFIX in the doc string because we don't want to
264 ;; advertise it. It's meant for recursive calls only. Here's its
267 ;; If optional argument PREFIX is specified, it should be a key
268 ;; prefix, a string. Redefined bindings will then be bound to the
269 ;; original key, with PREFIX added at the front.
270 (or prefix (setq prefix ""))
271 (let* ((scan (or oldmap keymap))
273 (prefix1 (vconcat prefix vec1))
274 (key-substitution-in-progress
275 (cons scan key-substitution-in-progress)))
276 ;; Scan OLDMAP, finding each char or event-symbol that
277 ;; has any definition, and act on it with hack-key.
279 (if (consp (car scan))
280 (let ((char (car (car scan)))
281 (defn (cdr (car scan))))
282 ;; The inside of this let duplicates exactly
283 ;; the inside of the following let that handles array elements.
285 (aset prefix1 (length prefix) char)
286 (let (inner-def skipped)
287 ;; Skip past menu-prompt.
288 (while (stringp (car-safe defn))
289 (setq skipped (cons (car defn) skipped))
290 (setq defn (cdr defn)))
291 ;; Skip past cached key-equivalence data for menu items.
292 (and (consp defn) (consp (car defn))
293 (setq defn (cdr defn)))
294 (setq inner-def defn)
295 ;; Look past a symbol that names a keymap.
296 (while (and (symbolp inner-def)
298 (setq inner-def (symbol-function inner-def)))
299 (if (or (eq defn olddef)
300 ;; Compare with equal if definition is a key sequence.
301 ;; That is useful for operating on function-key-map.
302 (and (or (stringp defn) (vectorp defn))
303 (equal defn olddef)))
304 (define-key keymap prefix1 (nconc (nreverse skipped) newdef))
305 (if (and (keymapp defn)
306 ;; Avoid recursively scanning
307 ;; where KEYMAP does not have a submap.
308 (let ((elt (lookup-key keymap prefix1)))
311 ;; Avoid recursively rescanning keymap being scanned.
313 key-substitution-in-progress)))
314 ;; If this one isn't being scanned already,
316 (substitute-key-definition olddef newdef keymap
319 (if (vectorp (car scan))
320 (let* ((array (car scan))
324 (let ((char i) (defn (aref array i)))
325 ;; The inside of this let duplicates exactly
326 ;; the inside of the previous let.
328 (aset prefix1 (length prefix) char)
329 (let (inner-def skipped)
330 ;; Skip past menu-prompt.
331 (while (stringp (car-safe defn))
332 (setq skipped (cons (car defn) skipped))
333 (setq defn (cdr defn)))
334 (and (consp defn) (consp (car defn))
335 (setq defn (cdr defn)))
336 (setq inner-def defn)
337 (while (and (symbolp inner-def)
339 (setq inner-def (symbol-function inner-def)))
340 (if (or (eq defn olddef)
341 (and (or (stringp defn) (vectorp defn))
342 (equal defn olddef)))
343 (define-key keymap prefix1
344 (nconc (nreverse skipped) newdef))
345 (if (and (keymapp defn)
346 (let ((elt (lookup-key keymap prefix1)))
350 key-substitution-in-progress)))
351 (substitute-key-definition olddef newdef keymap
355 (if (char-table-p (car scan))
357 (function (lambda (char defn)
359 ;; The inside of this let duplicates exactly
360 ;; the inside of the previous let,
361 ;; except that it uses set-char-table-range
362 ;; instead of define-key.
364 (aset prefix1 (length prefix) char)
365 (let (inner-def skipped)
366 ;; Skip past menu-prompt.
367 (while (stringp (car-safe defn))
368 (setq skipped (cons (car defn) skipped))
369 (setq defn (cdr defn)))
370 (and (consp defn) (consp (car defn))
371 (setq defn (cdr defn)))
372 (setq inner-def defn)
373 (while (and (symbolp inner-def)
375 (setq inner-def (symbol-function inner-def)))
376 (if (or (eq defn olddef)
377 (and (or (stringp defn) (vectorp defn))
378 (equal defn olddef)))
379 (define-key keymap prefix1
380 (nconc (nreverse skipped) newdef))
381 (if (and (keymapp defn)
382 (let ((elt (lookup-key keymap prefix1)))
386 key-substitution-in-progress)))
387 (substitute-key-definition olddef newdef keymap
391 (setq scan (cdr scan)))))
393 (defun define-key-after (keymap key definition &optional after)
394 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
395 This is like `define-key' except that the binding for KEY is placed
396 just after the binding for the event AFTER, instead of at the beginning
397 of the map. Note that AFTER must be an event type (like KEY), NOT a command
400 If AFTER is t or omitted, the new binding goes at the end of the keymap.
401 AFTER should be a single event type--a symbol or a character, not a sequence.
403 Bindings are always added before any inherited map.
405 The order of bindings in a keymap matters when it is used as a menu."
406 (unless after (setq after t))
408 (signal 'wrong-type-argument (list 'keymapp keymap)))
410 (if (<= (length key) 1) (aref key 0)
411 (setq keymap (lookup-key keymap
413 (butlast (mapcar 'identity key)))))
414 (aref key (1- (length key)))))
415 (let ((tail keymap) done inserted)
416 (while (and (not done) tail)
417 ;; Delete any earlier bindings for the same key.
418 (if (eq (car-safe (car (cdr tail))) key)
419 (setcdr tail (cdr (cdr tail))))
420 ;; If we hit an included map, go down that one.
421 (if (keymapp (car tail)) (setq tail (car tail)))
422 ;; When we reach AFTER's binding, insert the new binding after.
423 ;; If we reach an inherited keymap, insert just before that.
424 ;; If we reach the end of this keymap, insert at the end.
425 (if (or (and (eq (car-safe (car tail)) after)
427 (eq (car (cdr tail)) 'keymap)
430 ;; Stop the scan only if we find a parent keymap.
431 ;; Keep going past the inserted element
432 ;; so we can delete any duplications that come later.
433 (if (eq (car (cdr tail)) 'keymap)
435 ;; Don't insert more than once.
437 (setcdr tail (cons (cons key definition) (cdr tail))))
439 (setq tail (cdr tail)))))
442 "Convert KEYS to the internal Emacs key representation.
443 KEYS should be a string constant in the format used for
444 saving keyboard macros (see `insert-kbd-macro')."
445 (read-kbd-macro keys))
447 (put 'keyboard-translate-table 'char-table-extra-slots 0)
449 (defun keyboard-translate (from to)
450 "Translate character FROM to TO at a low level.
451 This function creates a `keyboard-translate-table' if necessary
452 and then modifies one entry in it."
453 (or (char-table-p keyboard-translate-table)
454 (setq keyboard-translate-table
455 (make-char-table 'keyboard-translate-table nil)))
456 (aset keyboard-translate-table from to))
459 ;;;; The global keymap tree.
461 ;;; global-map, esc-map, and ctl-x-map have their values set up in
462 ;;; keymap.c; we just give them docstrings here.
464 (defvar global-map nil
465 "Default global keymap mapping Emacs keyboard input into commands.
466 The value is a keymap which is usually (but not necessarily) Emacs's
470 "Default keymap for ESC (meta) commands.
471 The normal global definition of the character ESC indirects to this keymap.")
473 (defvar ctl-x-map nil
474 "Default keymap for C-x commands.
475 The normal global definition of the character C-x indirects to this keymap.")
477 (defvar ctl-x-4-map (make-sparse-keymap)
478 "Keymap for subcommands of C-x 4")
479 (defalias 'ctl-x-4-prefix ctl-x-4-map)
480 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
482 (defvar ctl-x-5-map (make-sparse-keymap)
483 "Keymap for frame commands.")
484 (defalias 'ctl-x-5-prefix ctl-x-5-map)
485 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
488 ;;;; Event manipulation functions.
490 ;; The call to `read' is to ensure that the value is computed at load time
491 ;; and not compiled into the .elc file. The value is negative on most
492 ;; machines, but not on all!
493 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
495 (defun listify-key-sequence (key)
496 "Convert a key sequence to a list of events."
499 (mapcar (function (lambda (c)
501 (logxor c listify-key-sequence-1)
505 (defsubst eventp (obj)
506 "True if the argument is an event object."
509 (get obj 'event-symbol-elements))
512 (get (car obj) 'event-symbol-elements))))
514 (defun event-modifiers (event)
515 "Returns a list of symbols representing the modifier keys in event EVENT.
516 The elements of the list may include `meta', `control',
517 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
521 (setq type (car type)))
523 (cdr (get type 'event-symbol-elements))
525 (or (zerop (logand type ?\M-\^@))
526 (setq list (cons 'meta list)))
527 (or (and (zerop (logand type ?\C-\^@))
528 (>= (logand type 127) 32))
529 (setq list (cons 'control list)))
530 (or (and (zerop (logand type ?\S-\^@))
531 (= (logand type 255) (downcase (logand type 255))))
532 (setq list (cons 'shift list)))
533 (or (zerop (logand type ?\H-\^@))
534 (setq list (cons 'hyper list)))
535 (or (zerop (logand type ?\s-\^@))
536 (setq list (cons 'super list)))
537 (or (zerop (logand type ?\A-\^@))
538 (setq list (cons 'alt list)))
541 (defun event-basic-type (event)
542 "Returns the basic type of the given event (all modifiers removed).
543 The value is a printing character (not upper case) or a symbol."
545 (setq event (car event)))
547 (car (get event 'event-symbol-elements))
548 (let ((base (logand event (1- (lsh 1 18)))))
549 (downcase (if (< base 32) (logior base 64) base)))))
551 (defsubst mouse-movement-p (object)
552 "Return non-nil if OBJECT is a mouse movement event."
554 (eq (car object) 'mouse-movement)))
556 (defsubst event-start (event)
557 "Return the starting position of EVENT.
558 If EVENT is a mouse press or a mouse click, this returns the location
560 If EVENT is a drag, this returns the drag's starting position.
561 The return value is of the form
562 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
563 The `posn-' functions access elements of such lists."
566 (defsubst event-end (event)
567 "Return the ending location of EVENT. EVENT should be a click or drag event.
568 If EVENT is a click event, this function is the same as `event-start'.
569 The return value is of the form
570 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
571 The `posn-' functions access elements of such lists."
572 (nth (if (consp (nth 2 event)) 2 1) event))
574 (defsubst event-click-count (event)
575 "Return the multi-click count of EVENT, a click or drag event.
576 The return value is a positive integer."
577 (if (integerp (nth 2 event)) (nth 2 event) 1))
579 (defsubst posn-window (position)
580 "Return the window in POSITION.
581 POSITION should be a list of the form
582 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
583 as returned by the `event-start' and `event-end' functions."
586 (defsubst posn-point (position)
587 "Return the buffer location in POSITION.
588 POSITION should be a list of the form
589 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
590 as returned by the `event-start' and `event-end' functions."
591 (if (consp (nth 1 position))
592 (car (nth 1 position))
595 (defsubst posn-x-y (position)
596 "Return the x and y coordinates in POSITION.
597 POSITION should be a list of the form
598 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
599 as returned by the `event-start' and `event-end' functions."
602 (defun posn-col-row (position)
603 "Return the column and row in POSITION, measured in characters.
604 POSITION should be a list of the form
605 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
606 as returned by the `event-start' and `event-end' functions.
607 For a scroll-bar event, the result column is 0, and the row
608 corresponds to the vertical position of the click in the scroll bar."
609 (let ((pair (nth 2 position))
610 (window (posn-window position)))
611 (if (eq (if (consp (nth 1 position))
612 (car (nth 1 position))
614 'vertical-scroll-bar)
615 (cons 0 (scroll-bar-scale pair (1- (window-height window))))
616 (if (eq (if (consp (nth 1 position))
617 (car (nth 1 position))
619 'horizontal-scroll-bar)
620 (cons (scroll-bar-scale pair (window-width window)) 0)
621 (let* ((frame (if (framep window) window (window-frame window)))
622 (x (/ (car pair) (frame-char-width frame)))
623 (y (/ (cdr pair) (frame-char-height frame))))
626 (defsubst posn-timestamp (position)
627 "Return the timestamp of POSITION.
628 POSITION should be a list of the form
629 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
630 as returned by the `event-start' and `event-end' functions."
634 ;;;; Obsolescent names for functions.
636 (defalias 'dot 'point)
637 (defalias 'dot-marker 'point-marker)
638 (defalias 'dot-min 'point-min)
639 (defalias 'dot-max 'point-max)
640 (defalias 'window-dot 'window-point)
641 (defalias 'set-window-dot 'set-window-point)
642 (defalias 'read-input 'read-string)
643 (defalias 'send-string 'process-send-string)
644 (defalias 'send-region 'process-send-region)
645 (defalias 'show-buffer 'set-window-buffer)
646 (defalias 'buffer-flush-undo 'buffer-disable-undo)
647 (defalias 'eval-current-buffer 'eval-buffer)
648 (defalias 'compiled-function-p 'byte-code-function-p)
649 (defalias 'define-function 'defalias)
651 (defalias 'sref 'aref)
652 (make-obsolete 'sref 'aref "20.4")
653 (make-obsolete 'char-bytes "Now this function always returns 1" "20.4")
655 ;; Some programs still use this as a function.
657 "Obsolete function returning the value of the `baud-rate' variable.
658 Please convert your programs to use the variable `baud-rate' directly."
661 (defalias 'focus-frame 'ignore)
662 (defalias 'unfocus-frame 'ignore)
664 ;;;; Alternate names for functions - these are not being phased out.
666 (defalias 'string= 'string-equal)
667 (defalias 'string< 'string-lessp)
668 (defalias 'move-marker 'set-marker)
669 (defalias 'rplaca 'setcar)
670 (defalias 'rplacd 'setcdr)
671 (defalias 'beep 'ding) ;preserve lingual purity
672 (defalias 'indent-to-column 'indent-to)
673 (defalias 'backward-delete-char 'delete-backward-char)
674 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
675 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
676 (defalias 'int-to-string 'number-to-string)
677 (defalias 'store-match-data 'set-match-data)
678 ;; These are the XEmacs names:
679 (defalias 'point-at-eol 'line-end-position)
680 (defalias 'point-at-bol 'line-beginning-position)
682 ;;; Should this be an obsolete name? If you decide it should, you get
683 ;;; to go through all the sources and change them.
684 (defalias 'string-to-int 'string-to-number)
686 ;;;; Hook manipulation functions.
688 (defun make-local-hook (hook)
689 "Make the hook HOOK local to the current buffer.
690 The return value is HOOK.
692 You never need to call this function now that `add-hook' does it for you
693 if its LOCAL argument is non-nil.
695 When a hook is local, its local and global values
696 work in concert: running the hook actually runs all the hook
697 functions listed in *either* the local value *or* the global value
698 of the hook variable.
700 This function works by making t a member of the buffer-local value,
701 which acts as a flag to run the hook functions in the default value as
702 well. This works for all normal hooks, but does not work for most
703 non-normal hooks yet. We will be changing the callers of non-normal
704 hooks so that they can handle localness; this has to be done one by
707 This function does nothing if HOOK is already local in the current
710 Do not use `make-local-variable' to make a hook variable buffer-local."
711 (if (local-variable-p hook)
713 (or (boundp hook) (set hook nil))
714 (make-local-variable hook)
717 (make-obsolete 'make-local-hook "Not necessary any more." "21.1")
719 (defun add-hook (hook function &optional append local)
720 "Add to the value of HOOK the function FUNCTION.
721 FUNCTION is not added if already present.
722 FUNCTION is added (if necessary) at the beginning of the hook list
723 unless the optional argument APPEND is non-nil, in which case
724 FUNCTION is added at the end.
726 The optional fourth argument, LOCAL, if non-nil, says to modify
727 the hook's buffer-local value rather than its default value.
728 This makes the hook buffer-local if needed.
730 HOOK should be a symbol, and FUNCTION may be any valid function. If
731 HOOK is void, it is first set to nil. If HOOK's value is a single
732 function, it is changed to a list of functions."
733 (or (boundp hook) (set hook nil))
734 (or (default-boundp hook) (set-default hook nil))
735 (if local (unless (local-variable-if-set-p hook)
736 (set (make-local-variable hook) (list t)))
737 ;; Detect the case where make-local-variable was used on a hook
738 ;; and do what we used to do.
739 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
741 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
742 ;; If the hook value is a single function, turn it into a list.
743 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
744 (setq hook-value (list hook-value)))
745 ;; Do the actual addition if necessary
746 (unless (member function hook-value)
749 (append hook-value (list function))
750 (cons function hook-value))))
751 ;; Set the actual variable
752 (if local (set hook hook-value) (set-default hook hook-value))))
754 (defun remove-hook (hook function &optional local)
755 "Remove from the value of HOOK the function FUNCTION.
756 HOOK should be a symbol, and FUNCTION may be any valid function. If
757 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
758 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
760 The optional third argument, LOCAL, if non-nil, says to modify
761 the hook's buffer-local value rather than its default value.
762 This makes the hook buffer-local if needed."
763 (or (boundp hook) (set hook nil))
764 (or (default-boundp hook) (set-default hook nil))
765 (if local (unless (local-variable-if-set-p hook)
766 (set (make-local-variable hook) (list t)))
767 ;; Detect the case where make-local-variable was used on a hook
768 ;; and do what we used to do.
769 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
771 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
772 ;; Remove the function, for both the list and the non-list cases.
773 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
774 (if (equal hook-value function) (setq hook-value nil))
775 (setq hook-value (delete function (copy-sequence hook-value))))
776 ;; If the function is on the global hook, we need to shadow it locally
777 ;;(when (and local (member function (default-value hook))
778 ;; (not (member (cons 'not function) hook-value)))
779 ;; (push (cons 'not function) hook-value))
780 ;; Set the actual variable
781 (if local (set hook hook-value) (set-default hook hook-value))))
783 (defun add-to-list (list-var element &optional append)
784 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet.
785 The test for presence of ELEMENT is done with `equal'.
786 If ELEMENT is added, it is added at the beginning of the list,
787 unless the optional argument APPEND is non-nil, in which case
788 ELEMENT is added at the end.
790 If you want to use `add-to-list' on a variable that is not defined
791 until a certain package is loaded, you should put the call to `add-to-list'
792 into a hook function that will be run only after loading the package.
793 `eval-after-load' provides one way to do this. In some cases
794 other hooks, such as major mode hooks, can do the job."
795 (if (member element (symbol-value list-var))
796 (symbol-value list-var)
799 (append (symbol-value list-var) (list element))
800 (cons element (symbol-value list-var))))))
805 (defvar symbol-file-load-history-loaded nil
806 "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
807 That file records the part of `load-history' for preloaded files,
808 which is cleared out before dumping to make Emacs smaller.")
810 (defun load-symbol-file-load-history ()
811 "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
812 That file records the part of `load-history' for preloaded files,
813 which is cleared out before dumping to make Emacs smaller."
814 (unless symbol-file-load-history-loaded
815 (load (expand-file-name
816 ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
817 (if (eq system-type 'ms-dos)
819 (format "fns-%s.el" emacs-version))
821 ;; The file name fns-%s.el already has a .el extension.
823 (setq symbol-file-load-history-loaded t)))
825 (defun symbol-file (function)
826 "Return the input source from which FUNCTION was loaded.
827 The value is normally a string that was passed to `load':
828 either an absolute file name, or a library name
829 \(with no directory name and no `.el' or `.elc' at the end).
830 It can also be nil, if the definition is not associated with any file."
831 (load-symbol-file-load-history)
832 (let ((files load-history)
835 (if (memq function (cdr (car files)))
836 (setq file (car (car files)) files nil))
837 (setq files (cdr files)))
841 ;;;; Specifying things to do after certain files are loaded.
843 (defun eval-after-load (file form)
844 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
845 This makes or adds to an entry on `after-load-alist'.
846 If FILE is already loaded, evaluate FORM right now.
847 It does nothing if FORM is already on the list for FILE.
848 FILE must match exactly. Normally FILE is the name of a library,
849 with no directory or extension specified, since that is how `load'
851 FILE can also be a feature (i.e. a symbol), in which case FORM is
852 evaluated whenever that feature is `provide'd."
853 (let ((elt (assoc file after-load-alist)))
854 ;; Make sure there is an element for FILE.
855 (unless elt (setq elt (list file)) (push elt after-load-alist))
856 ;; Add FORM to the element if it isn't there.
857 (unless (member form (cdr elt))
858 (nconc elt (list form))
859 ;; If the file has been loaded already, run FORM right away.
860 (if (if (symbolp file)
862 ;; Make sure `load-history' contains the files dumped with
863 ;; Emacs for the case that FILE is one of them.
864 (load-symbol-file-load-history)
865 (assoc file load-history))
869 (defun eval-next-after-load (file)
870 "Read the following input sexp, and run it whenever FILE is loaded.
871 This makes or adds to an entry on `after-load-alist'.
872 FILE should be the name of a library, with no directory name."
873 (eval-after-load file (read)))
876 ;;;; Input and display facilities.
878 (defvar read-quoted-char-radix 8
879 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
880 Legitimate radix values are 8, 10 and 16.")
882 (custom-declare-variable-early
883 'read-quoted-char-radix 8
884 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
885 Legitimate radix values are 8, 10 and 16."
886 :type '(choice (const 8) (const 10) (const 16))
887 :group 'editing-basics)
889 (defun read-quoted-char (&optional prompt)
890 "Like `read-char', but do not allow quitting.
891 Also, if the first character read is an octal digit,
892 we read any number of octal digits and return the
893 specified character code. Any nondigit terminates the sequence.
894 If the terminator is RET, it is discarded;
895 any other terminator is used itself as input.
897 The optional argument PROMPT specifies a string to use to prompt the user.
898 The variable `read-quoted-char-radix' controls which radix to use
900 (let ((message-log-max nil) done (first t) (code 0) char)
902 (let ((inhibit-quit first)
903 ;; Don't let C-h get the help message--only help function keys.
906 "Type the special character you want to use,
907 or the octal character code.
908 RET terminates the character code and is discarded;
909 any other non-digit terminates the character code and is then used as input."))
910 (setq char (read-event (and prompt (format "%s-" prompt)) t))
911 (if inhibit-quit (setq quit-flag nil)))
912 ;; Translate TAB key into control-I ASCII character, and so on.
914 (let ((translated (lookup-key function-key-map (vector char))))
915 (if (arrayp translated)
916 (setq char (aref translated 0)))))
918 ((not (integerp char))
919 (setq unread-command-events (list char)
921 ((/= (logand char ?\M-\^@) 0)
922 ;; Turn a meta-character into a character with the 0200 bit set.
923 (setq code (logior (logand char (lognot ?\M-\^@)) 128)
925 ((and (<= ?0 char) (< char (+ ?0 (min 10 read-quoted-char-radix))))
926 (setq code (+ (* code read-quoted-char-radix) (- char ?0)))
927 (and prompt (setq prompt (message "%s %c" prompt char))))
928 ((and (<= ?a (downcase char))
929 (< (downcase char) (+ ?a -10 (min 26 read-quoted-char-radix))))
930 (setq code (+ (* code read-quoted-char-radix)
931 (+ 10 (- (downcase char) ?a))))
932 (and prompt (setq prompt (message "%s %c" prompt char))))
933 ((and (not first) (eq char ?\C-m))
936 (setq unread-command-events (list char)
943 (defun read-passwd (prompt &optional confirm default)
944 "Read a password, prompting with PROMPT. Echo `.' for each character typed.
945 End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
946 Optional argument CONFIRM, if non-nil, then read it twice to make sure.
947 Optional DEFAULT is a default password to use instead of empty input."
951 (let ((first (read-passwd prompt nil default))
952 (second (read-passwd "Confirm password: " nil default)))
953 (if (equal first second)
955 (and (arrayp second) (fillarray second ?\0))
956 (setq success first))
957 (and (arrayp first) (fillarray first ?\0))
958 (and (arrayp second) (fillarray second ?\0))
959 (message "Password not repeated accurately; please start over")
965 (cursor-in-echo-area t))
966 (while (progn (message "%s%s"
968 (make-string (length pass) ?.))
969 (setq c (read-char-exclusive nil t))
970 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
971 (clear-this-command-keys)
974 (and (arrayp pass) (fillarray pass ?\0))
976 (if (and (/= c ?\b) (/= c ?\177))
977 (let* ((new-char (char-to-string c))
978 (new-pass (concat pass new-char)))
979 (and (arrayp pass) (fillarray pass ?\0))
980 (fillarray new-char ?\0)
982 (setq pass new-pass))
983 (if (> (length pass) 0)
984 (let ((new-pass (substring pass 0 -1)))
985 (and (arrayp pass) (fillarray pass ?\0))
986 (setq pass new-pass))))))
988 (or pass default ""))))
990 (defun force-mode-line-update (&optional all)
991 "Force the mode-line of the current buffer to be redisplayed.
992 With optional non-nil ALL, force redisplay of all mode-lines."
993 (if all (save-excursion (set-buffer (other-buffer))))
994 (set-buffer-modified-p (buffer-modified-p)))
996 (defun momentary-string-display (string pos &optional exit-char message)
997 "Momentarily display STRING in the buffer at POS.
998 Display remains until next character is typed.
999 If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed;
1000 otherwise it is then available as input (as a command if nothing else).
1001 Display MESSAGE (optional fourth arg) in the echo area.
1002 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1003 (or exit-char (setq exit-char ?\ ))
1004 (let ((inhibit-read-only t)
1005 ;; Don't modify the undo list at all.
1006 (buffer-undo-list t)
1007 (modified (buffer-modified-p))
1008 (name buffer-file-name)
1014 ;; defeat file locking... don't try this at home, kids!
1015 (setq buffer-file-name nil)
1016 (insert-before-markers string)
1017 (setq insert-end (point))
1018 ;; If the message end is off screen, recenter now.
1019 (if (< (window-end nil t) insert-end)
1020 (recenter (/ (window-height) 2)))
1021 ;; If that pushed message start off the screen,
1022 ;; scroll to start it at the top of the screen.
1023 (move-to-window-line 0)
1028 (message (or message "Type %s to continue editing.")
1029 (single-key-description exit-char))
1030 (let ((char (read-event)))
1031 (or (eq char exit-char)
1032 (setq unread-command-events (list char)))))
1035 (delete-region pos insert-end)))
1036 (setq buffer-file-name name)
1037 (set-buffer-modified-p modified))))
1040 ;;;; Overlay operations
1042 (defun copy-overlay (o)
1043 "Return a copy of overlay O."
1044 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1045 ;; FIXME: there's no easy way to find the
1046 ;; insertion-type of the two markers.
1047 (overlay-buffer o)))
1048 (props (overlay-properties o)))
1050 (overlay-put o1 (pop props) (pop props)))
1053 (defun remove-overlays (beg end name val)
1054 "Clear BEG and END of overlays whose property NAME has value VAL.
1055 Overlays might be moved and or split."
1057 (setq beg (prog1 end (setq end beg))))
1059 (dolist (o (overlays-in beg end))
1060 (when (eq (overlay-get o name) val)
1061 ;; Either push this overlay outside beg...end
1062 ;; or split it to exclude beg...end
1063 ;; or delete it entirely (if it is contained in beg...end).
1064 (if (< (overlay-start o) beg)
1065 (if (> (overlay-end o) end)
1067 (move-overlay (copy-overlay o)
1068 (overlay-start o) beg)
1069 (move-overlay o end (overlay-end o)))
1070 (move-overlay o (overlay-start o) beg))
1071 (if (> (overlay-end o) end)
1072 (move-overlay o end (overlay-end o))
1073 (delete-overlay o)))))))
1077 ;; A number of major modes set this locally.
1078 ;; Give it a global value to avoid compiler warnings.
1079 (defvar font-lock-defaults nil)
1081 (defvar suspend-hook nil
1082 "Normal hook run by `suspend-emacs', before suspending.")
1084 (defvar suspend-resume-hook nil
1085 "Normal hook run by `suspend-emacs', after Emacs is continued.")
1087 ;; Avoid compiler warnings about this variable,
1088 ;; which has a special meaning on certain system types.
1089 (defvar buffer-file-type nil
1090 "Non-nil if the visited file is a binary file.
1091 This variable is meaningful on MS-DOG and Windows NT.
1092 On those systems, it is automatically local in every buffer.
1093 On other systems, this variable is normally always nil.")
1095 ;; This should probably be written in C (i.e., without using `walk-windows').
1096 (defun get-buffer-window-list (buffer &optional minibuf frame)
1097 "Return windows currently displaying BUFFER, or nil if none.
1098 See `walk-windows' for the meaning of MINIBUF and FRAME."
1099 (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows)
1100 (walk-windows (function (lambda (window)
1101 (if (eq (window-buffer window) buffer)
1102 (setq windows (cons window windows)))))
1106 (defun ignore (&rest ignore)
1107 "Do nothing and return nil.
1108 This function accepts any number of arguments, but ignores them."
1112 (defun error (&rest args)
1113 "Signal an error, making error message by passing all args to `format'.
1114 In Emacs, the convention is that error messages start with a capital
1115 letter but *do not* end with a period. Please follow this convention
1116 for the sake of consistency."
1118 (signal 'error (list (apply 'format args)))))
1120 (defalias 'user-original-login-name 'user-login-name)
1122 (defun start-process-shell-command (name buffer &rest args)
1123 "Start a program in a subprocess. Return the process object for it.
1124 Args are NAME BUFFER COMMAND &rest COMMAND-ARGS.
1125 NAME is name for process. It is modified if necessary to make it unique.
1126 BUFFER is the buffer or (buffer-name) to associate with the process.
1127 Process output goes at end of that buffer, unless you specify
1128 an output stream or filter function to handle the output.
1129 BUFFER may be also nil, meaning that this process is not associated
1131 Third arg is command name, the name of a shell command.
1132 Remaining arguments are the arguments for the command.
1133 Wildcards and redirection are handled as usual in the shell."
1135 ((eq system-type 'vax-vms)
1136 (apply 'start-process name buffer args))
1137 ;; We used to use `exec' to replace the shell with the command,
1138 ;; but that failed to handle (...) and semicolon, etc.
1140 (start-process name buffer shell-file-name shell-command-switch
1141 (mapconcat 'identity args " ")))))
1143 (defun call-process-shell-command (command &optional infile buffer display
1145 "Execute the shell command COMMAND synchronously in separate process.
1146 The remaining arguments are optional.
1147 The program's input comes from file INFILE (nil means `/dev/null').
1148 Insert output in BUFFER before point; t means current buffer;
1149 nil for BUFFER means discard it; 0 means discard and don't wait.
1150 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1151 REAL-BUFFER says what to do with standard output, as above,
1152 while STDERR-FILE says what to do with standard error in the child.
1153 STDERR-FILE may be nil (discard standard error output),
1154 t (mix it with ordinary output), or a file name string.
1156 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1157 Remaining arguments are strings passed as additional arguments for COMMAND.
1158 Wildcards and redirection are handled as usual in the shell.
1160 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
1161 Otherwise it waits for COMMAND to terminate and returns a numeric exit
1162 status or a signal description string.
1163 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
1165 ((eq system-type 'vax-vms)
1166 (apply 'call-process command infile buffer display args))
1167 ;; We used to use `exec' to replace the shell with the command,
1168 ;; but that failed to handle (...) and semicolon, etc.
1170 (call-process shell-file-name
1171 infile buffer display
1172 shell-command-switch
1173 (mapconcat 'identity (cons command args) " ")))))
1175 (defmacro with-current-buffer (buffer &rest body)
1176 "Execute the forms in BODY with BUFFER as the current buffer.
1177 The value returned is the value of the last form in BODY.
1178 See also `with-temp-buffer'."
1179 (cons 'save-current-buffer
1180 (cons (list 'set-buffer buffer)
1183 (defmacro with-temp-file (file &rest body)
1184 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
1185 The value returned is the value of the last form in BODY.
1186 See also `with-temp-buffer'."
1187 (let ((temp-file (make-symbol "temp-file"))
1188 (temp-buffer (make-symbol "temp-buffer")))
1189 `(let ((,temp-file ,file)
1191 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
1194 (with-current-buffer ,temp-buffer
1196 (with-current-buffer ,temp-buffer
1198 (write-region (point-min) (point-max) ,temp-file nil 0)))
1199 (and (buffer-name ,temp-buffer)
1200 (kill-buffer ,temp-buffer))))))
1202 (defmacro with-temp-message (message &rest body)
1203 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
1204 The original message is restored to the echo area after BODY has finished.
1205 The value returned is the value of the last form in BODY.
1206 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
1207 If MESSAGE is nil, the echo area and message log buffer are unchanged.
1208 Use a MESSAGE of \"\" to temporarily clear the echo area."
1209 (let ((current-message (make-symbol "current-message"))
1210 (temp-message (make-symbol "with-temp-message")))
1211 `(let ((,temp-message ,message)
1216 (setq ,current-message (current-message))
1217 (message "%s" ,temp-message))
1219 (and ,temp-message ,current-message
1220 (message "%s" ,current-message))))))
1222 (defmacro with-temp-buffer (&rest body)
1223 "Create a temporary buffer, and evaluate BODY there like `progn'.
1224 See also `with-temp-file' and `with-output-to-string'."
1225 (let ((temp-buffer (make-symbol "temp-buffer")))
1226 `(let ((,temp-buffer
1227 (get-buffer-create (generate-new-buffer-name " *temp*"))))
1229 (with-current-buffer ,temp-buffer
1231 (and (buffer-name ,temp-buffer)
1232 (kill-buffer ,temp-buffer))))))
1234 (defmacro with-output-to-string (&rest body)
1235 "Execute BODY, return the text it sent to `standard-output', as a string."
1236 `(let ((standard-output
1237 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
1238 (let ((standard-output standard-output))
1240 (with-current-buffer standard-output
1243 (kill-buffer nil)))))
1245 (defmacro with-local-quit (&rest body)
1246 "Execute BODY with `inhibit-quit' temporarily bound to nil."
1247 `(condition-case nil
1248 (let ((inhibit-quit nil))
1250 (quit (setq quit-flag t))))
1252 (defmacro combine-after-change-calls (&rest body)
1253 "Execute BODY, but don't call the after-change functions till the end.
1254 If BODY makes changes in the buffer, they are recorded
1255 and the functions on `after-change-functions' are called several times
1256 when BODY is finished.
1257 The return value is the value of the last form in BODY.
1259 If `before-change-functions' is non-nil, then calls to the after-change
1260 functions can't be deferred, so in that case this macro has no effect.
1262 Do not alter `after-change-functions' or `before-change-functions'
1265 (let ((combine-after-change-calls t))
1267 (combine-after-change-execute)))
1270 (defvar delay-mode-hooks nil
1271 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1272 (defvar delayed-mode-hooks nil
1273 "List of delayed mode hooks waiting to be run.")
1274 (make-variable-buffer-local 'delayed-mode-hooks)
1276 (defun run-mode-hooks (&rest hooks)
1277 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1278 Execution is delayed if `delay-mode-hooks' is non-nil.
1279 Major mode functions should use this."
1280 (if delay-mode-hooks
1282 (dolist (hook hooks)
1283 (push hook delayed-mode-hooks))
1284 ;; Normal case, just run the hook as before plus any delayed hooks.
1285 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1286 (setq delayed-mode-hooks nil)
1287 (apply 'run-hooks hooks)))
1289 (defmacro delay-mode-hooks (&rest body)
1290 "Execute BODY, but delay any `run-mode-hooks'.
1291 Only affects hooks run in the current buffer."
1293 (make-local-variable 'delay-mode-hooks)
1294 (let ((delay-mode-hooks t))
1297 (defmacro with-syntax-table (table &rest body)
1298 "Evaluate BODY with syntax table of current buffer set to a copy of TABLE.
1299 The syntax table of the current buffer is saved, BODY is evaluated, and the
1300 saved table is restored, even in case of an abnormal exit.
1301 Value is what BODY returns."
1302 (let ((old-table (make-symbol "table"))
1303 (old-buffer (make-symbol "buffer")))
1304 `(let ((,old-table (syntax-table))
1305 (,old-buffer (current-buffer)))
1308 (set-syntax-table (copy-syntax-table ,table))
1310 (save-current-buffer
1311 (set-buffer ,old-buffer)
1312 (set-syntax-table ,old-table))))))
1314 (defvar save-match-data-internal)
1316 ;; We use save-match-data-internal as the local variable because
1317 ;; that works ok in practice (people should not use that variable elsewhere).
1318 ;; We used to use an uninterned symbol; the compiler handles that properly
1319 ;; now, but it generates slower code.
1320 (defmacro save-match-data (&rest body)
1321 "Execute the BODY forms, restoring the global value of the match data."
1322 ;; It is better not to use backquote here,
1323 ;; because that makes a bootstrapping problem
1324 ;; if you need to recompile all the Lisp files using interpreted code.
1326 '((save-match-data-internal (match-data)))
1327 (list 'unwind-protect
1329 '(set-match-data save-match-data-internal))))
1331 (defun match-string (num &optional string)
1332 "Return string of text matched by last search.
1333 NUM specifies which parenthesized expression in the last regexp.
1334 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
1335 Zero means the entire text matched by the whole regexp or whole string.
1336 STRING should be given if the last search was by `string-match' on STRING."
1337 (if (match-beginning num)
1339 (substring string (match-beginning num) (match-end num))
1340 (buffer-substring (match-beginning num) (match-end num)))))
1342 (defun match-string-no-properties (num &optional string)
1343 "Return string of text matched by last search, without text properties.
1344 NUM specifies which parenthesized expression in the last regexp.
1345 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
1346 Zero means the entire text matched by the whole regexp or whole string.
1347 STRING should be given if the last search was by `string-match' on STRING."
1348 (if (match-beginning num)
1351 (substring string (match-beginning num) (match-end num))))
1352 (set-text-properties 0 (length result) nil result)
1354 (buffer-substring-no-properties (match-beginning num)
1357 (defun split-string (string &optional separators)
1358 "Splits STRING into substrings where there are matches for SEPARATORS.
1359 Each match for SEPARATORS is a splitting point.
1360 The substrings between the splitting points are made into a list
1362 If SEPARATORS is absent, it defaults to \"[ \\f\\t\\n\\r\\v]+\".
1364 If there is match for SEPARATORS at the beginning of STRING, we do not
1365 include a null substring for that. Likewise, if there is a match
1366 at the end of STRING, we don't include a null substring for that.
1368 Modifies the match data; use `save-match-data' if necessary."
1369 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
1373 (while (and (string-match rexp string
1375 (= start (match-beginning 0))
1376 (< start (length string)))
1378 (< (match-beginning 0) (length string)))
1380 (or (eq (match-beginning 0) 0)
1381 (and (eq (match-beginning 0) (match-end 0))
1382 (eq (match-beginning 0) start))
1384 (cons (substring string start (match-beginning 0))
1386 (setq start (match-end 0)))
1387 (or (eq start (length string))
1389 (cons (substring string start)
1393 (defun subst-char-in-string (fromchar tochar string &optional inplace)
1394 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
1395 Unless optional argument INPLACE is non-nil, return a new string."
1396 (let ((i (length string))
1397 (newstr (if inplace string (copy-sequence string))))
1400 (if (eq (aref newstr i) fromchar)
1401 (aset newstr i tochar)))
1404 (defun replace-regexp-in-string (regexp rep string &optional
1405 fixedcase literal subexp start)
1406 "Replace all matches for REGEXP with REP in STRING.
1408 Return a new string containing the replacements.
1410 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
1411 arguments with the same names of function `replace-match'. If START
1412 is non-nil, start replacements at that index in STRING.
1414 REP is either a string used as the NEWTEXT arg of `replace-match' or a
1415 function. If it is a function it is applied to each match to generate
1416 the replacement passed to `replace-match'; the match-data at this
1417 point are such that match 0 is the function's argument.
1419 To replace only the first match (if any), make REGEXP match up to \\'
1420 and replace a sub-expression, e.g.
1421 (replace-regexp-in-string \"\\(foo\\).*\\'\" \"bar\" \" foo foo\" nil nil 1)
1425 ;; To avoid excessive consing from multiple matches in long strings,
1426 ;; don't just call `replace-match' continually. Walk down the
1427 ;; string looking for matches of REGEXP and building up a (reversed)
1428 ;; list MATCHES. This comprises segments of STRING which weren't
1429 ;; matched interspersed with replacements for segments that were.
1430 ;; [For a `large' number of replacements it's more efficient to
1431 ;; operate in a temporary buffer; we can't tell from the function's
1432 ;; args whether to choose the buffer-based implementation, though it
1433 ;; might be reasonable to do so for long enough STRING.]
1434 (let ((l (length string))
1435 (start (or start 0))
1438 (while (and (< start l) (string-match regexp string start))
1439 (setq mb (match-beginning 0)
1441 ;; If we matched the empty string, make sure we advance by one char
1442 (when (= me mb) (setq me (min l (1+ mb))))
1443 ;; Generate a replacement for the matched substring.
1444 ;; Operate only on the substring to minimize string consing.
1445 ;; Set up match data for the substring for replacement;
1446 ;; presumably this is likely to be faster than munging the
1447 ;; match data directly in Lisp.
1448 (string-match regexp (setq str (substring string mb me)))
1450 (cons (replace-match (if (stringp rep)
1452 (funcall rep (match-string 0 str)))
1453 fixedcase literal str subexp)
1454 (cons (substring string start mb) ; unmatched prefix
1457 ;; Reconstruct a string from the pieces.
1458 (setq matches (cons (substring string start l) matches)) ; leftover
1459 (apply #'concat (nreverse matches)))))
1461 (defun shell-quote-argument (argument)
1462 "Quote an argument for passing as argument to an inferior shell."
1463 (if (eq system-type 'ms-dos)
1464 ;; Quote using double quotes, but escape any existing quotes in
1465 ;; the argument with backslashes.
1469 (if (or (null (string-match "[^\"]" argument))
1470 (< (match-end 0) (length argument)))
1471 (while (string-match "[\"]" argument start)
1472 (setq end (match-beginning 0)
1473 result (concat result (substring argument start end)
1474 "\\" (substring argument end (1+ end)))
1476 (concat "\"" result (substring argument start) "\""))
1477 (if (eq system-type 'windows-nt)
1478 (concat "\"" argument "\"")
1479 (if (equal argument "")
1481 ;; Quote everything except POSIX filename characters.
1482 ;; This should be safe enough even for really weird shells.
1483 (let ((result "") (start 0) end)
1484 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
1485 (setq end (match-beginning 0)
1486 result (concat result (substring argument start end)
1487 "\\" (substring argument end (1+ end)))
1489 (concat result (substring argument start)))))))
1491 (defun make-syntax-table (&optional oldtable)
1492 "Return a new syntax table.
1493 Create a syntax table which inherits from OLDTABLE (if non-nil) or
1494 from `standard-syntax-table' otherwise."
1495 (let ((table (make-char-table 'syntax-table nil)))
1496 (set-char-table-parent table (or oldtable (standard-syntax-table)))
1499 (defun add-to-invisibility-spec (arg)
1500 "Add elements to `buffer-invisibility-spec'.
1501 See documentation for `buffer-invisibility-spec' for the kind of elements
1504 ((or (null buffer-invisibility-spec) (eq buffer-invisibility-spec t))
1505 (setq buffer-invisibility-spec (list arg)))
1507 (setq buffer-invisibility-spec
1508 (cons arg buffer-invisibility-spec)))))
1510 (defun remove-from-invisibility-spec (arg)
1511 "Remove elements from `buffer-invisibility-spec'."
1512 (if (consp buffer-invisibility-spec)
1513 (setq buffer-invisibility-spec (delete arg buffer-invisibility-spec))))
1515 (defun global-set-key (key command)
1516 "Give KEY a global binding as COMMAND.
1517 COMMAND is the command definition to use; usually it is
1518 a symbol naming an interactively-callable function.
1519 KEY is a key sequence; noninteractively, it is a string or vector
1520 of characters or event types, and non-ASCII characters with codes
1521 above 127 (such as ISO Latin-1) can be included if you use a vector.
1523 Note that if KEY has a local binding in the current buffer,
1524 that local binding will continue to shadow any global binding
1525 that you make with this function."
1526 (interactive "KSet key globally: \nCSet key %s to command: ")
1527 (or (vectorp key) (stringp key)
1528 (signal 'wrong-type-argument (list 'arrayp key)))
1529 (define-key (current-global-map) key command))
1531 (defun local-set-key (key command)
1532 "Give KEY a local binding as COMMAND.
1533 COMMAND is the command definition to use; usually it is
1534 a symbol naming an interactively-callable function.
1535 KEY is a key sequence; noninteractively, it is a string or vector
1536 of characters or event types, and non-ASCII characters with codes
1537 above 127 (such as ISO Latin-1) can be included if you use a vector.
1539 The binding goes in the current buffer's local map,
1540 which in most cases is shared with all other buffers in the same major mode."
1541 (interactive "KSet key locally: \nCSet key %s locally to command: ")
1542 (let ((map (current-local-map)))
1544 (use-local-map (setq map (make-sparse-keymap))))
1545 (or (vectorp key) (stringp key)
1546 (signal 'wrong-type-argument (list 'arrayp key)))
1547 (define-key map key command)))
1549 (defun global-unset-key (key)
1550 "Remove global binding of KEY.
1551 KEY is a string representing a sequence of keystrokes."
1552 (interactive "kUnset key globally: ")
1553 (global-set-key key nil))
1555 (defun local-unset-key (key)
1556 "Remove local binding of KEY.
1557 KEY is a string representing a sequence of keystrokes."
1558 (interactive "kUnset key locally: ")
1559 (if (current-local-map)
1560 (local-set-key key nil))
1563 ;; We put this here instead of in frame.el so that it's defined even on
1564 ;; systems where frame.el isn't loaded.
1565 (defun frame-configuration-p (object)
1566 "Return non-nil if OBJECT seems to be a frame configuration.
1567 Any list whose car is `frame-configuration' is assumed to be a frame
1570 (eq (car object) 'frame-configuration)))
1572 (defun functionp (object)
1573 "Non-nil iff OBJECT is a type of object that can be called as a function."
1574 (or (and (symbolp object) (fboundp object)
1575 (setq object (indirect-function object))
1576 (eq (car-safe object) 'autoload)
1577 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object)))))))
1578 (subrp object) (byte-code-function-p object)
1579 (eq (car-safe object) 'lambda)))
1581 (defun interactive-form (function)
1582 "Return the interactive form of FUNCTION.
1583 If function is a command (see `commandp'), value is a list of the form
1584 \(interactive SPEC). If function is not a command, return nil."
1585 (setq function (indirect-function function))
1586 (when (commandp function)
1587 (cond ((byte-code-function-p function)
1588 (when (> (length function) 5)
1589 (let ((spec (aref function 5)))
1591 (list 'interactive spec)
1592 (list 'interactive)))))
1594 (subr-interactive-form function))
1595 ((eq (car-safe function) 'lambda)
1596 (setq function (cddr function))
1597 (when (stringp (car function))
1598 (setq function (cdr function)))
1599 (let ((form (car function)))
1600 (when (eq (car-safe form) 'interactive)
1601 (copy-sequence form)))))))
1603 (defun assq-delete-all (key alist)
1604 "Delete from ALIST all elements whose car is KEY.
1605 Return the modified alist."
1608 (if (eq (car (car tail)) key)
1609 (setq alist (delq (car tail) alist)))
1610 (setq tail (cdr tail)))
1613 (defun make-temp-file (prefix &optional dir-flag)
1614 "Create a temporary file.
1615 The returned file name (created by appending some random characters at the end
1616 of PREFIX, and expanding against `temporary-file-directory' if necessary,
1617 is guaranteed to point to a newly created empty file.
1618 You can then use `write-region' to write new data into the file.
1620 If DIR-FLAG is non-nil, create a new empty directory instead of a file."
1622 (while (condition-case ()
1626 (expand-file-name prefix temporary-file-directory)))
1628 (make-directory file)
1629 (write-region "" nil file nil 'silent nil 'excl))
1631 (file-already-exists t))
1632 ;; the file was somehow created by someone else between
1633 ;; `make-temp-name' and `write-region', let's try again.
1638 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1639 "Register a new minor mode.
1641 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1643 TOGGLE is a symbol which is the name of a buffer-local variable that
1644 is toggled on or off to say whether the minor mode is active or not.
1646 NAME specifies what will appear in the mode line when the minor mode
1647 is active. NAME should be either a string starting with a space, or a
1648 symbol whose value is such a string.
1650 Optional KEYMAP is the keymap for the minor mode that will be added
1651 to `minor-mode-map-alist'.
1653 Optional AFTER specifies that TOGGLE should be added after AFTER
1654 in `minor-mode-alist'.
1656 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1657 It defaults to (and should by convention be) TOGGLE.
1659 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1660 included in the mode-line minor mode menu.
1661 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1662 (unless toggle-fun (setq toggle-fun toggle))
1663 ;; Add the toggle to the minor-modes menu if requested.
1664 (when (get toggle :included)
1665 (define-key mode-line-mode-menu
1668 (or (get toggle :menu-tag)
1669 (if (stringp name) name (symbol-name toggle)))
1671 :button (cons :toggle toggle))))
1672 ;; Add the name to the minor-mode-alist.
1674 (let ((existing (assq toggle minor-mode-alist)))
1675 (when (and (stringp name) (not (get-text-property 0 'local-map name)))
1678 'local-map mode-line-minor-mode-keymap
1679 'help-echo "mouse-3: minor mode menu")))
1681 (setcdr existing (list name))
1682 (let ((tail minor-mode-alist) found)
1683 (while (and tail (not found))
1684 (if (eq after (caar tail))
1686 (setq tail (cdr tail))))
1688 (let ((rest (cdr found)))
1690 (nconc found (list (list toggle name)) rest))
1691 (setq minor-mode-alist (cons (list toggle name)
1692 minor-mode-alist)))))))
1693 ;; Add the map to the minor-mode-map-alist.
1695 (let ((existing (assq toggle minor-mode-map-alist)))
1697 (setcdr existing keymap)
1698 (let ((tail minor-mode-map-alist) found)
1699 (while (and tail (not found))
1700 (if (eq after (caar tail))
1702 (setq tail (cdr tail))))
1704 (let ((rest (cdr found)))
1706 (nconc found (list (cons toggle keymap)) rest))
1707 (setq minor-mode-map-alist (cons (cons toggle keymap)
1708 minor-mode-map-alist))))))))
1710 ;; XEmacs compatibility/convenience.
1711 (if (fboundp 'play-sound)
1712 (defun play-sound-file (file &optional volume device)
1713 "Play sound stored in FILE.
1714 VOLUME and DEVICE correspond to the keywords of the sound
1715 specification for `play-sound'."
1716 (interactive "fPlay sound file: ")
1717 (let ((sound (list :file file)))
1719 (plist-put sound :volume volume))
1721 (plist-put sound :device device))
1723 (play-sound sound))))
1725 ;; Clones ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1727 (defun text-clone-maintain (ol1 after beg end &optional len)
1728 "Propagate the changes made under the overlay OL1 to the other clones.
1729 This is used on the `modification-hooks' property of text clones."
1730 (when (and after (not undo-in-progress) (overlay-start ol1))
1731 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
1732 (setq beg (max beg (+ (overlay-start ol1) margin)))
1733 (setq end (min end (- (overlay-end ol1) margin)))
1736 (when (overlay-get ol1 'text-clone-syntax)
1737 ;; Check content of the clone's text.
1738 (let ((cbeg (+ (overlay-start ol1) margin))
1739 (cend (- (overlay-end ol1) margin)))
1742 (if (not (re-search-forward
1743 (overlay-get ol1 'text-clone-syntax) cend t))
1744 ;; Mark the overlay for deletion.
1745 (overlay-put ol1 'text-clones nil)
1746 (when (< (match-end 0) cend)
1747 ;; Shrink the clone at its end.
1748 (setq end (min end (match-end 0)))
1749 (move-overlay ol1 (overlay-start ol1)
1750 (+ (match-end 0) margin)))
1751 (when (> (match-beginning 0) cbeg)
1752 ;; Shrink the clone at its beginning.
1753 (setq beg (max (match-beginning 0) beg))
1754 (move-overlay ol1 (- (match-beginning 0) margin)
1755 (overlay-end ol1)))))))
1756 ;; Now go ahead and update the clones.
1757 (let ((head (- beg (overlay-start ol1)))
1758 (tail (- (overlay-end ol1) end))
1759 (str (buffer-substring beg end))
1761 (inhibit-modification-hooks t))
1762 (dolist (ol2 (overlay-get ol1 'text-clones))
1763 (let ((oe (overlay-end ol2)))
1764 (unless (or (eq ol1 ol2) (null oe))
1765 (setq nothing-left nil)
1766 (let ((mod-beg (+ (overlay-start ol2) head)))
1767 ;;(overlay-put ol2 'modification-hooks nil)
1768 (goto-char (- (overlay-end ol2) tail))
1769 (unless (> mod-beg (point))
1770 (save-excursion (insert str))
1771 (delete-region mod-beg (point)))
1772 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
1774 (if nothing-left (delete-overlay ol1))))))))
1776 (defun text-clone-create (start end &optional spreadp syntax)
1777 "Create a text clone of START...END at point.
1778 Text clones are chunks of text that are automatically kept identical:
1779 changes done to one of the clones will be immediately propagated to the other.
1781 The buffer's content at point is assumed to be already identical to
1782 the one between START and END.
1783 If SYNTAX is provided it's a regexp that describes the possible text of
1784 the clones; the clone will be shrunk or killed if necessary to ensure that
1785 its text matches the regexp.
1786 If SPREADP is non-nil it indicates that text inserted before/after the
1787 clone should be incorporated in the clone."
1788 ;; To deal with SPREADP we can either use an overlay with `nil t' along
1789 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
1790 ;; (with a one-char margin at each end) with `t nil'.
1791 ;; We opted for a larger overlay because it behaves better in the case
1792 ;; where the clone is reduced to the empty string (we want the overlay to
1793 ;; stay when the clone's content is the empty string and we want to use
1794 ;; `evaporate' to make sure those overlays get deleted when needed).
1796 (let* ((pt-end (+ (point) (- end start)))
1797 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
1799 (end-margin (if (or (not spreadp)
1800 (>= pt-end (point-max))
1801 (>= start (point-max)))
1803 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
1804 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
1805 (dups (list ol1 ol2)))
1806 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
1807 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
1808 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
1809 ;;(overlay-put ol1 'face 'underline)
1810 (overlay-put ol1 'evaporate t)
1811 (overlay-put ol1 'text-clones dups)
1813 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
1814 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
1815 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
1816 ;;(overlay-put ol2 'face 'underline)
1817 (overlay-put ol2 'evaporate t)
1818 (overlay-put ol2 'text-clones dups)))
1820 ;;; subr.el ends here