| blob | 8c7212e5ef19579fcf6a31f02eb735d914571e27 |
1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000, 2001, 2002
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
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)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;;; Code:
30 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
33 ;; Use this, rather than defcustom, in subr.el and other files loaded
34 ;; before custom.el.
39 \f
41 "Process a declaration found in a macro definition.
42 This is set as the value of the variable `macro-declaration-function'.
43 MACRO is the name of the macro being defined.
44 DECL is a list `(declare ...)' containing the declarations.
45 The return value of this function is not used."
56 \f
57 ;;;; Lisp language features.
62 "Return a lambda expression.
63 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
64 self-quoting; the result of evaluating the lambda expression is the
65 expression itself. The lambda expression may then be treated as a
66 function, i.e., stored as the function value of a symbol, passed to
67 funcall or mapcar, etc.
69 ARGS should take the same form as an argument list for a `defun'.
70 DOCSTRING is an optional documentation string.
71 If present, it should describe how to call the function.
72 But documentation strings are usually not useful in nameless functions.
73 INTERACTIVE should be a call to the function `interactive', which see.
74 It may also be omitted.
75 BODY should be a list of lisp expressions."
76 ;; Note that this definition should not use backquotes; subr.el should not
77 ;; depend on backquote.el.
81 "Add NEWELT to the list stored in the symbol LISTNAME.
82 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
83 LISTNAME must be a symbol."
88 "Return the first element of LISTNAME's value, and remove it from the list.
89 LISTNAME must be a symbol whose value is a list.
90 If the value is nil, `pop' returns nil but does not actually
91 change the list."
97 "If COND yields non-nil, do BODY, else return nil."
101 "If COND yields nil, do BODY, else return nil."
105 "(dolist (VAR LIST [RESULT]) BODY...): loop over a list.
106 Evaluate BODY with VAR bound to each car from LIST, in turn.
107 Then evaluate RESULT to get return value, default nil."
120 "(dotimes (VAR COUNT [RESULT]) BODY...): loop a certain number of times.
121 Evaluate BODY with VAR bound to successive integers running from 0,
122 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
123 the return value (nil if RESULT is omitted)."
132 nil))))
135 "Return the car of the car of X."
139 "Return the car of the cdr of X."
143 "Return the cdr of the car of X."
147 "Return the cdr of the cdr of X."
151 "Return the last link of the list X. Its car is the last element.
152 If X is nil, return nil.
153 If N is non-nil, return the Nth-to-last link of X.
154 If N is bigger than the length of X, return X."
163 x))
166 "Returns a copy of LIST with the last N elements removed."
171 "Modifies LIST to remove the last N elements."
177 x))))
180 "Return a copy of SEQ with all occurrences of ELT removed.
181 SEQ must be a list, vector, or string. The comparison is done with `equal'."
183 ;; If SEQ isn't a list, there's no need to copy SEQ because
184 ;; `delete' will return a new object.
189 "Return a copy of LIST with all occurences of ELT removed.
190 The comparison is done with `eq'."
193 list))
196 "Make a copy of TREE.
197 If TREE is a cons cell, this recursively copies both its car and its cdr.
198 Contrast to `copy-sequence', which copies only along the cdrs. With second
199 argument VECP, this copies vectors as well as conses."
213 tree)
214 tree)))
217 "Find object KEY in a pseudo-alist ALIST.
218 ALIST is a list of conses or objects. Each element (or the element's car,
219 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
220 If that is non-nil, the element matches;
221 then `assoc-default' returns the element's cdr, if it is a cons,
222 or DEFAULT if the element is not a cons.
224 If no element matches, the value is nil.
225 If TEST is omitted or nil, `equal' is used."
232 value))
235 "Like `assoc', but ignores differences in case and text representation.
236 KEY must be a string. Upper-case and lower-case letters are treated as equal.
237 Unibyte strings are converted to multibyte for comparison."
243 element))
246 "Like `assoc', but ignores differences in text representation.
247 KEY must be a string.
248 Unibyte strings are converted to multibyte for comparison."
254 element))
257 "Like `member', but ignores differences in case and text representation.
258 ELT must be a string. Upper-case and lower-case letters are treated as equal.
259 Unibyte strings are converted to multibyte for comparison.
260 Non-strings in LIST are ignored."
265 list)
267 \f
268 ;;;; Keymap support.
274 ;Prevent the \{...} documentation construct
275 ;from mentioning keys that run this command.
279 "Make MAP override all normally self-inserting keys to be undefined.
280 Normally, as an exception, digits and minus-sign are set to make prefix args,
281 but optional second arg NODIGITS non-nil treats them like other chars."
286 ;; Make plain numbers do numeric args.
292 ;Moved to keymap.c
293 ;(defun copy-keymap (keymap)
294 ; "Return a copy of KEYMAP"
295 ; (while (not (keymapp keymap))
296 ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap))))
297 ; (if (vectorp keymap)
298 ; (copy-sequence keymap)
299 ; (copy-alist keymap)))
305 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
306 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
307 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
308 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP."
309 ;; Don't document PREFIX in the doc string because we don't want to
310 ;; advertise it. It's meant for recursive calls only. Here's its
311 ;; meaning
313 ;; If optional argument PREFIX is specified, it should be a key
314 ;; prefix, a string. Redefined bindings will then be bound to the
315 ;; original key, with PREFIX added at the front.
322 ;; Scan OLDMAP, finding each char or event-symbol that
323 ;; has any definition, and act on it with hack-key.
328 ;; The inside of this let duplicates exactly
329 ;; the inside of the following let that handles array elements.
333 ;; Skip past menu-prompt.
337 ;; Skip past cached key-equivalence data for menu items.
341 ;; Look past a symbol that names a keymap.
346 ;; Compare with equal if definition is a key sequence.
347 ;; That is useful for operating on function-key-map.
352 ;; Avoid recursively scanning
353 ;; where KEYMAP does not have a submap.
357 ;; Avoid recursively rescanning keymap being scanned.
359 key-substitution-in-progress)))
360 ;; If this one isn't being scanned already,
361 ;; scan it now.
363 inner-def
364 prefix1)))))
371 ;; The inside of this let duplicates exactly
372 ;; the inside of the previous let.
376 ;; Skip past menu-prompt.
396 key-substitution-in-progress)))
398 inner-def
399 prefix1)))))
405 ;; The inside of this let duplicates exactly
406 ;; the inside of the previous let,
407 ;; except that it uses set-char-table-range
408 ;; instead of define-key.
412 ;; Skip past menu-prompt.
432 key-substitution-in-progress)))
434 inner-def
435 prefix1)))))))
440 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
441 This is like `define-key' except that the binding for KEY is placed
442 just after the binding for the event AFTER, instead of at the beginning
443 of the map. Note that AFTER must be an event type (like KEY), NOT a command
444 \(like DEFINITION).
446 If AFTER is t or omitted, the new binding goes at the end of the keymap.
447 AFTER should be a single event type--a symbol or a character, not a sequence.
449 Bindings are always added before any inherited map.
451 The order of bindings in a keymap matters when it is used as a menu."
463 ;; Delete any earlier bindings for the same key.
466 ;; If we hit an included map, go down that one.
468 ;; When we reach AFTER's binding, insert the new binding after.
469 ;; If we reach an inherited keymap, insert just before that.
470 ;; If we reach the end of this keymap, insert at the end.
476 ;; Stop the scan only if we find a parent keymap.
477 ;; Keep going past the inserted element
478 ;; so we can delete any duplications that come later.
481 ;; Don't insert more than once.
489 "Convert KEYS to the internal Emacs key representation.
490 KEYS should be a string constant in the format used for
491 saving keyboard macros (see `insert-kbd-macro')."
497 "Translate character FROM to TO at a low level.
498 This function creates a `keyboard-translate-table' if necessary
499 and then modifies one entry in it."
505 \f
506 ;;;; The global keymap tree.
508 ;;; global-map, esc-map, and ctl-x-map have their values set up in
509 ;;; keymap.c; we just give them docstrings here.
512 "Default global keymap mapping Emacs keyboard input into commands.
513 The value is a keymap which is usually (but not necessarily) Emacs's
517 "Default keymap for ESC (meta) commands.
521 "Default keymap for C-x commands.
534 \f
535 ;;;; Event manipulation functions.
537 ;; The call to `read' is to ensure that the value is computed at load time
538 ;; and not compiled into the .elc file. The value is negative on most
539 ;; machines, but not on all!
543 "Convert a key sequence to a list of events."
549 c)))
553 "True if the argument is an event object."
562 "Returns a list of symbols representing the modifier keys in event EVENT.
563 The elements of the list may include `meta', `control',
564 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
565 and `down'."
586 list))))
589 "Returns the basic type of the given event (all modifiers removed).
590 The value is a printing character (not upper case) or a symbol."
599 "Return non-nil if OBJECT is a mouse movement event."
604 "Return the starting position of EVENT.
605 If EVENT is a mouse press or a mouse click, this returns the location
606 of the event.
607 If EVENT is a drag, this returns the drag's starting position.
608 The return value is of the form
609 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
610 The `posn-' functions access elements of such lists."
615 "Return the ending location of EVENT. EVENT should be a click or drag event.
616 If EVENT is a click event, this function is the same as `event-start'.
617 The return value is of the form
618 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
619 The `posn-' functions access elements of such lists."
624 "Return the multi-click count of EVENT, a click or drag event.
625 The return value is a positive integer."
629 "Return the window in POSITION.
630 POSITION should be a list of the form
631 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
632 as returned by the `event-start' and `event-end' functions."
636 "Return the buffer location in POSITION.
637 POSITION should be a list of the form
638 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
639 as returned by the `event-start' and `event-end' functions."
645 "Return the x and y coordinates in POSITION.
646 POSITION should be a list of the form
647 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
648 as returned by the `event-start' and `event-end' functions."
652 "Return the column and row in POSITION, measured in characters.
653 POSITION should be a list of the form
654 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
655 as returned by the `event-start' and `event-end' functions.
656 For a scroll-bar event, the result column is 0, and the row
657 corresponds to the vertical position of the click in the scroll bar."
676 "Return the timestamp of POSITION.
677 POSITION should be a list of the form
678 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
679 as returned by the `event-start' and `event-end' functions."
682 \f
683 ;;;; Obsolescent names for functions.
714 "Mocklisp-compatibility insert function.
715 Like the function `insert' except that any argument that is a number
716 is converted into a string by expressing it in decimal."
723 ;; Some programs still use this as a function.
725 "Return the value of the `baud-rate' variable."
726 baud-rate)
731 \f
732 ;;;; Obsolescence declarations for variables.
737 "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."
745 \f
746 ;;;; Alternate names for functions - these are not being phased out.
761 ;; These are the XEmacs names:
765 ;;; Should this be an obsolete name? If you decide it should, you get
766 ;;; to go through all the sources and change them.
768 \f
769 ;;;; Hook manipulation functions.
772 "Make the hook HOOK local to the current buffer.
773 The return value is HOOK.
775 You never need to call this function now that `add-hook' does it for you
776 if its LOCAL argument is non-nil.
778 When a hook is local, its local and global values
779 work in concert: running the hook actually runs all the hook
780 functions listed in *either* the local value *or* the global value
781 of the hook variable.
783 This function works by making t a member of the buffer-local value,
784 which acts as a flag to run the hook functions in the default value as
785 well. This works for all normal hooks, but does not work for most
786 non-normal hooks yet. We will be changing the callers of non-normal
787 hooks so that they can handle localness; this has to be done one by
788 one.
790 This function does nothing if HOOK is already local in the current
791 buffer.
793 Do not use `make-local-variable' to make a hook variable buffer-local."
795 nil
799 hook)
803 "Add to the value of HOOK the function FUNCTION.
804 FUNCTION is not added if already present.
805 FUNCTION is added (if necessary) at the beginning of the hook list
806 unless the optional argument APPEND is non-nil, in which case
807 FUNCTION is added at the end.
809 The optional fourth argument, LOCAL, if non-nil, says to modify
810 the hook's buffer-local value rather than its default value.
811 This makes the hook buffer-local if needed, and it makes t a member
812 of the buffer-local value. That acts as a flag to run the hook
813 functions in the default value as well as in the local value.
815 HOOK should be a symbol, and FUNCTION may be any valid function. If
816 HOOK is void, it is first set to nil. If HOOK's value is a single
817 function, it is changed to a list of functions."
822 ;; Detect the case where make-local-variable was used on a hook
823 ;; and do what we used to do.
827 ;; If the hook value is a single function, turn it into a list.
830 ;; Do the actual addition if necessary
836 ;; Set the actual variable
840 "Remove from the value of HOOK the function FUNCTION.
841 HOOK should be a symbol, and FUNCTION may be any valid function. If
842 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
843 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
845 The optional third argument, LOCAL, if non-nil, says to modify
846 the hook's buffer-local value rather than its default value.
847 This makes the hook buffer-local if needed."
852 ;; Detect the case where make-local-variable was used on a hook
853 ;; and do what we used to do.
857 ;; Remove the function, for both the list and the non-list cases.
861 ;; If the function is on the global hook, we need to shadow it locally
862 ;;(when (and local (member function (default-value hook))
863 ;; (not (member (cons 'not function) hook-value)))
864 ;; (push (cons 'not function) hook-value))
865 ;; Set the actual variable
873 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet.
874 The test for presence of ELEMENT is done with `equal'.
875 If ELEMENT is added, it is added at the beginning of the list,
876 unless the optional argument APPEND is non-nil, in which case
877 ELEMENT is added at the end.
879 The return value is the new value of LIST-VAR.
881 If you want to use `add-to-list' on a variable that is not defined
882 until a certain package is loaded, you should put the call to `add-to-list'
883 into a hook function that will be run only after loading the package.
884 `eval-after-load' provides one way to do this. In some cases
885 other hooks, such as major mode hooks, can do the job."
893 \f
894 ;;; Load history
896 ;;; (defvar symbol-file-load-history-loaded nil
897 ;;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
898 ;;; That file records the part of `load-history' for preloaded files,
899 ;;; which is cleared out before dumping to make Emacs smaller.")
901 ;;; (defun load-symbol-file-load-history ()
902 ;;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
903 ;;; That file records the part of `load-history' for preloaded files,
904 ;;; which is cleared out before dumping to make Emacs smaller."
905 ;;; (unless symbol-file-load-history-loaded
906 ;;; (load (expand-file-name
907 ;;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
908 ;;; (if (eq system-type 'ms-dos)
909 ;;; "fns.el"
910 ;;; (format "fns-%s.el" emacs-version))
911 ;;; exec-directory)
912 ;;; ;; The file name fns-%s.el already has a .el extension.
913 ;;; nil nil t)
914 ;;; (setq symbol-file-load-history-loaded t)))
917 "Return the input source from which FUNCTION was loaded.
918 The value is normally a string that was passed to `load':
919 either an absolute file name, or a library name
920 \(with no directory name and no `.el' or `.elc' at the end).
921 It can also be nil, if the definition is not associated with any file."
926 file functions)
931 file)))
933 \f
934 ;;;; Specifying things to do after certain files are loaded.
937 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
938 This makes or adds to an entry on `after-load-alist'.
939 If FILE is already loaded, evaluate FORM right now.
940 It does nothing if FORM is already on the list for FILE.
941 FILE must match exactly. Normally FILE is the name of a library,
942 with no directory or extension specified, since that is how `load'
943 is normally called.
944 FILE can also be a feature (i.e. a symbol), in which case FORM is
945 evaluated whenever that feature is `provide'd."
947 ;; Make sure there is an element for FILE.
949 ;; Add FORM to the element if it isn't there.
952 ;; If the file has been loaded already, run FORM right away.
955 ;; Make sure `load-history' contains the files dumped with
956 ;; Emacs for the case that FILE is one of them.
957 ;; (load-symbol-file-load-history)
960 form)
963 "Read the following input sexp, and run it whenever FILE is loaded.
964 This makes or adds to an entry on `after-load-alist'.
965 FILE should be the name of a library, with no directory name."
967 \f
968 ;;; make-network-process wrappers
974 "Open a TCP connection for a service to a host.
975 Returns a subprocess-object to represent the connection.
976 Input and output work as for subprocesses; `delete-process' closes it.
977 Args are NAME BUFFER HOST SERVICE.
978 NAME is name for process. It is modified if necessary to make it unique.
979 BUFFER is the buffer (or buffer-name) to associate with the process.
980 Process output goes at end of that buffer, unless you specify
981 an output stream or filter function to handle the output.
982 BUFFER may be also nil, meaning that this process is not associated
983 with any buffer
984 Third arg is name of the host to connect to, or its IP address.
985 Fourth arg SERVICE is name of the service desired, or an integer
986 specifying a port number to connect to."
991 "Initiate connection to a TCP connection for a service to a host.
992 It returns nil if non-blocking connects are not supported; otherwise,
993 it returns a subprocess-object to represent the connection.
995 This function is similar to `open-network-stream', except that this
996 function returns before the connection is established. When the
997 connection is completed, the sentinel function will be called with
998 second arg matching `open' (if successful) or `failed' (on error).
1000 Args are NAME BUFFER HOST SERVICE SENTINEL FILTER.
1001 NAME, BUFFER, HOST, and SERVICE are as for `open-network-stream'.
1002 Optional args, SENTINEL and FILTER specifies the sentinel and filter
1003 functions to be used for this network stream."
1010 "Create a network server process for a TCP service.
1011 It returns nil if server processes are not supported; otherwise,
1012 it returns a subprocess-object to represent the server.
1014 When a client connects to the specified service, a new subprocess
1015 is created to handle the new connection, and the sentinel function
1016 is called for the new process.
1018 Args are NAME BUFFER SERVICE SENTINEL FILTER.
1019 NAME is name for the server process. Client processes are named by
1020 appending the ip-address and port number of the client to NAME.
1021 BUFFER is the buffer (or buffer-name) to associate with the server
1022 process. Client processes will not get a buffer if a process filter
1023 is specified or BUFFER is nil; otherwise, a new buffer is created for
1024 the client process. The name is similar to the process name.
1025 Third arg SERVICE is name of the service desired, or an integer
1026 specifying a port number to connect to. It may also be t to selected
1027 an unused port number for the server.
1028 Optional args, SENTINEL and FILTER specifies the sentinel and filter
1029 functions to be used for the client processes; the server process
1030 does not use these function."
1039 ;; compatibility
1042 "Say no query needed if PROCESS is running when Emacs is exited.
1043 Optional second argument if non-nil says to require a query.
1044 Value is t if a query was formerly required.
1045 New code should not use this function; use `process-query-on-exit-flag'
1046 or `set-process-query-on-exit-flag' instead."
1049 old))
1051 \f
1052 ;;;; Input and display facilities.
1061 Legitimate radix values are 8, 10 and 16."
1068 map))
1070 (defun read-key (&optional prompt)
1071 "Read a key from the keyboard.
1072 Contrary to `read-event' this will not return a raw event but will
1073 obey `function-key-map' and `key-translation-map' instead."
1074 (let ((overriding-terminal-local-map read-key-aux-map))
1075 (aref (read-key-sequence prompt nil t) 0)))
1077 (defun read-quoted-char (&optional prompt)
1078 "Like `read-char', but do not allow quitting.
1079 Also, if the first character read is an octal digit,
1080 we read any number of octal digits and return the
1081 specified character code. Any nondigit terminates the sequence.
1082 If the terminator is RET, it is discarded;
1083 any other terminator is used itself as input.
1085 The optional argument PROMPT specifies a string to use to prompt the user.
1086 The variable `read-quoted-char-radix' controls which radix to use
1087 for numeric input."
1088 (let ((message-log-max nil) done (first t) (code 0) char)
1089 (while (not done)
1090 (let ((inhibit-quit first)
1091 ;; Don't let C-h get the help message--only help function keys.
1092 (help-char nil)
1093 (help-form
1094 "Type the special character you want to use,
1095 or the octal character code.
1096 RET terminates the character code and is discarded;
1097 any other non-digit terminates the character code and is then used as input."))
1098 (setq char (read-key (and prompt (format "%s-" prompt))))
1099 (if inhibit-quit (setq quit-flag nil)))
1100 (cond ((null char))
1101 ((not (integerp char))
1102 (setq unread-command-events (listify-key-sequence (this-single-command-raw-keys))
1103 done t))
1104 ((/= (logand char ?\M-\^@) 0)
1105 ;; Turn a meta-character into a character with the 0200 bit set.
1106 (setq code (logior (logand char (lognot ?\M-\^@)) 128)
1107 done t))
1108 ((and (<= ?0 char) (< char (+ ?0 (min 10 read-quoted-char-radix))))
1109 (setq code (+ (* code read-quoted-char-radix) (- char ?0)))
1110 (and prompt (setq prompt (message "%s %c" prompt char))))
1111 ((and (<= ?a (downcase char))
1112 (< (downcase char) (+ ?a -10 (min 26 read-quoted-char-radix))))
1113 (setq code (+ (* code read-quoted-char-radix)
1114 (+ 10 (- (downcase char) ?a))))
1115 (and prompt (setq prompt (message "%s %c" prompt char))))
1116 ((and (not first) (eq char ?\C-m))
1117 (setq done t))
1118 ((not first)
1119 (setq unread-command-events (listify-key-sequence (this-single-command-raw-keys))
1120 done t))
1121 (t (setq code char
1122 done t)))
1123 (setq first nil))
1124 code))
1126 (defun read-passwd (prompt &optional confirm default)
1127 "Read a password, prompting with PROMPT. Echo `.' for each character typed.
1128 End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1129 Optional argument CONFIRM, if non-nil, then read it twice to make sure.
1130 Optional DEFAULT is a default password to use instead of empty input."
1131 (if confirm
1132 (let (success)
1133 (while (not success)
1134 (let ((first (read-passwd prompt nil default))
1135 (second (read-passwd "Confirm password: " nil default)))
1136 (if (equal first second)
1137 (progn
1138 (and (arrayp second) (fillarray second ?\0))
1139 (setq success first))
1140 (and (arrayp first) (fillarray first ?\0))
1141 (and (arrayp second) (fillarray second ?\0))
1142 (message "Password not repeated accurately; please start over")
1143 (sit-for 1))))
1144 success)
1145 (let ((pass nil)
1146 (c 0)
1147 (echo-keystrokes 0)
1148 (cursor-in-echo-area t))
1149 (while (progn (message "%s%s"
1150 prompt
1151 (make-string (length pass) ?.))
1152 (setq c (read-char-exclusive nil t))
1154 (clear-this-command-keys)
1155 (if (= c ?\C-u)
1156 (progn
1157 (and (arrayp pass) (fillarray pass ?\0))
1158 (setq pass ""))
1160 (let* ((new-char (char-to-string c))
1161 (new-pass (concat pass new-char)))
1162 (and (arrayp pass) (fillarray pass ?\0))
1163 (fillarray new-char ?\0)
1164 (setq c ?\0)
1165 (setq pass new-pass))
1166 (if (> (length pass) 0)
1167 (let ((new-pass (substring pass 0 -1)))
1168 (and (arrayp pass) (fillarray pass ?\0))
1169 (setq pass new-pass))))))
1170 (message nil)
1171 (or pass default ""))))
1172 \f
1173 ;;; Atomic change groups.
1175 (defmacro atomic-change-group (&rest body)
1176 "Perform BODY as an atomic change group.
1177 This means that if BODY exits abnormally,
1178 all of its changes to the current buffer are undone.
1179 This works regardless of whether undo is enabled in the buffer.
1181 This mechanism is transparent to ordinary use of undo;
1182 if undo is enabled in the buffer and BODY succeeds, the
1183 user can undo the change normally."
1184 (let ((handle (make-symbol "--change-group-handle--"))
1185 (success (make-symbol "--change-group-success--")))
1186 `(let ((,handle (prepare-change-group))
1187 (,success nil))
1188 (unwind-protect
1189 (progn
1190 ;; This is inside the unwind-protect because
1191 ;; it enables undo if that was disabled; we need
1192 ;; to make sure that it gets disabled again.
1193 (activate-change-group ,handle)
1194 ,@body
1195 (setq ,success t))
1196 ;; Either of these functions will disable undo
1197 ;; if it was disabled before.
1198 (if ,success
1199 (accept-change-group ,handle)
1200 (cancel-change-group ,handle))))))
1202 (defun prepare-change-group (&optional buffer)
1203 "Return a handle for the current buffer's state, for a change group.
1204 If you specify BUFFER, make a handle for BUFFER's state instead.
1206 Pass the handle to `activate-change-group' afterward to initiate
1207 the actual changes of the change group.
1209 To finish the change group, call either `accept-change-group' or
1210 `cancel-change-group' passing the same handle as argument. Call
1211 `accept-change-group' to accept the changes in the group as final;
1212 call `cancel-change-group' to undo them all. You should use
1213 `unwind-protect' to make sure the group is always finished. The call
1214 to `activate-change-group' should be inside the `unwind-protect'.
1215 Once you finish the group, don't use the handle again--don't try to
1216 finish the same group twice. For a simple example of correct use, see
1217 the source code of `atomic-change-group'.
1219 The handle records only the specified buffer. To make a multibuffer
1220 change group, call this function once for each buffer you want to
1221 cover, then use `nconc' to combine the returned values, like this:
1223 (nconc (prepare-change-group buffer-1)
1224 (prepare-change-group buffer-2))
1226 You can then activate that multibuffer change group with a single
1227 call to `activate-change-group' and finish it with a single call
1228 to `accept-change-group' or `cancel-change-group'."
1230 (list (cons (current-buffer) buffer-undo-list)))
1232 (defun activate-change-group (handle)
1233 "Activate a change group made with `prepare-change-group' (which see)."
1234 (dolist (elt handle)
1235 (with-current-buffer (car elt)
1236 (if (eq buffer-undo-list t)
1237 (setq buffer-undo-list nil)))))
1239 (defun accept-change-group (handle)
1240 "Finish a change group made with `prepare-change-group' (which see).
1241 This finishes the change group by accepting its changes as final."
1242 (dolist (elt handle)
1243 (with-current-buffer (car elt)
1244 (if (eq elt t)
1245 (setq buffer-undo-list t)))))
1247 (defun cancel-change-group (handle)
1248 "Finish a change group made with `prepare-change-group' (which see).
1249 This finishes the change group by reverting all of its changes."
1250 (dolist (elt handle)
1251 (with-current-buffer (car elt)
1252 (setq elt (cdr elt))
1253 (let ((old-car
1254 (if (consp elt) (car elt)))
1255 (old-cdr
1256 (if (consp elt) (cdr elt))))
1257 ;; Temporarily truncate the undo log at ELT.
1258 (when (consp elt)
1259 (setcar elt nil) (setcdr elt nil))
1260 (unless (eq last-command 'undo) (undo-start))
1261 ;; Make sure there's no confusion.
1262 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
1263 (error "Undoing to some unrelated state"))
1264 ;; Undo it all.
1265 (while pending-undo-list (undo-more 1))
1266 ;; Reset the modified cons cell ELT to its original content.
1267 (when (consp elt)
1268 (setcar elt old-car)
1269 (setcdr elt old-cdr))
1270 ;; Revert the undo info to what it was when we grabbed the state.
1271 (setq buffer-undo-list elt)))))
1272 \f
1273 ;; For compatibility.
1274 (defalias 'redraw-modeline 'force-mode-line-update)
1276 (defun force-mode-line-update (&optional all)
1277 "Force the mode line of the current buffer to be redisplayed.
1278 With optional non-nil ALL, force redisplay of all mode lines."
1279 (if all (save-excursion (set-buffer (other-buffer))))
1280 (set-buffer-modified-p (buffer-modified-p)))
1282 (defun momentary-string-display (string pos &optional exit-char message)
1283 "Momentarily display STRING in the buffer at POS.
1284 Display remains until next character is typed.
1285 If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed;
1286 otherwise it is then available as input (as a command if nothing else).
1287 Display MESSAGE (optional fourth arg) in the echo area.
1288 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1289 (or exit-char (setq exit-char ?\ ))
1290 (let ((inhibit-read-only t)
1291 ;; Don't modify the undo list at all.
1292 (buffer-undo-list t)
1293 (modified (buffer-modified-p))
1294 (name buffer-file-name)
1295 insert-end)
1296 (unwind-protect
1297 (progn
1298 (save-excursion
1299 (goto-char pos)
1300 ;; defeat file locking... don't try this at home, kids!
1301 (setq buffer-file-name nil)
1302 (insert-before-markers string)
1303 (setq insert-end (point))
1304 ;; If the message end is off screen, recenter now.
1305 (if (< (window-end nil t) insert-end)
1306 (recenter (/ (window-height) 2)))
1307 ;; If that pushed message start off the screen,
1308 ;; scroll to start it at the top of the screen.
1309 (move-to-window-line 0)
1310 (if (> (point) pos)
1311 (progn
1312 (goto-char pos)
1313 (recenter 0))))
1314 (message (or message "Type %s to continue editing.")
1315 (single-key-description exit-char))
1316 (let ((char (read-event)))
1317 (or (eq char exit-char)
1318 (setq unread-command-events (list char)))))
1319 (if insert-end
1320 (save-excursion
1321 (delete-region pos insert-end)))
1322 (setq buffer-file-name name)
1323 (set-buffer-modified-p modified))))
1325 \f
1326 ;;;; Overlay operations
1328 (defun copy-overlay (o)
1329 "Return a copy of overlay O."
1330 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1331 ;; FIXME: there's no easy way to find the
1332 ;; insertion-type of the two markers.
1333 (overlay-buffer o)))
1334 (props (overlay-properties o)))
1335 (while props
1336 (overlay-put o1 (pop props) (pop props)))
1337 o1))
1339 (defun remove-overlays (beg end name val)
1340 "Clear BEG and END of overlays whose property NAME has value VAL.
1341 Overlays might be moved and or split."
1342 (if (< end beg)
1343 (setq beg (prog1 end (setq end beg))))
1344 (save-excursion
1345 (dolist (o (overlays-in beg end))
1346 (when (eq (overlay-get o name) val)
1347 ;; Either push this overlay outside beg...end
1348 ;; or split it to exclude beg...end
1349 ;; or delete it entirely (if it is contained in beg...end).
1350 (if (< (overlay-start o) beg)
1351 (if (> (overlay-end o) end)
1352 (progn
1353 (move-overlay (copy-overlay o)
1354 (overlay-start o) beg)
1355 (move-overlay o end (overlay-end o)))
1356 (move-overlay o (overlay-start o) beg))
1357 (if (> (overlay-end o) end)
1358 (move-overlay o end (overlay-end o))
1359 (delete-overlay o)))))))
1360 \f
1361 ;;;; Miscellanea.
1363 ;; A number of major modes set this locally.
1364 ;; Give it a global value to avoid compiler warnings.
1365 (defvar font-lock-defaults nil)
1367 (defvar suspend-hook nil
1368 "Normal hook run by `suspend-emacs', before suspending.")
1370 (defvar suspend-resume-hook nil
1371 "Normal hook run by `suspend-emacs', after Emacs is continued.")
1373 (defvar temp-buffer-show-hook nil
1374 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
1375 When the hook runs, the temporary buffer is current, and the window it
1376 was displayed in is selected. This hook is normally set up with a
1377 function to make the buffer read only, and find function names and
1378 variable names in it, provided the major mode is still Help mode.")
1380 (defvar temp-buffer-setup-hook nil
1381 "Normal hook run by `with-output-to-temp-buffer' at the start.
1382 When the hook runs, the temporary buffer is current.
1383 This hook is normally set up with a function to put the buffer in Help
1384 mode.")
1386 ;; Avoid compiler warnings about this variable,
1387 ;; which has a special meaning on certain system types.
1388 (defvar buffer-file-type nil
1389 "Non-nil if the visited file is a binary file.
1390 This variable is meaningful on MS-DOG and Windows NT.
1391 On those systems, it is automatically local in every buffer.
1392 On other systems, this variable is normally always nil.")
1394 ;; This should probably be written in C (i.e., without using `walk-windows').
1395 (defun get-buffer-window-list (buffer &optional minibuf frame)
1396 "Return windows currently displaying BUFFER, or nil if none.
1397 See `walk-windows' for the meaning of MINIBUF and FRAME."
1398 (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows)
1399 (walk-windows (function (lambda (window)
1400 (if (eq (window-buffer window) buffer)
1401 (setq windows (cons window windows)))))
1402 minibuf frame)
1403 windows))
1405 (defun ignore (&rest ignore)
1406 "Do nothing and return nil.
1407 This function accepts any number of arguments, but ignores them."
1408 (interactive)
1409 nil)
1411 (defun error (&rest args)
1412 "Signal an error, making error message by passing all args to `format'.
1413 In Emacs, the convention is that error messages start with a capital
1414 letter but *do not* end with a period. Please follow this convention
1415 for the sake of consistency."
1416 (while t
1417 (signal 'error (list (apply 'format args)))))
1419 (defalias 'user-original-login-name 'user-login-name)
1421 (defvar yank-excluded-properties)
1423 (defun remove-yank-excluded-properties (start end)
1424 "Remove `yank-excluded-properties' between START and END positions.
1425 Replaces `category' properties with their defined properties."
1426 (let ((inhibit-read-only t))
1427 ;; Replace any `category' property with the properties it stands for.
1428 (unless (memq yank-excluded-properties '(t nil))
1429 (save-excursion
1430 (goto-char start)
1431 (while (< (point) end)
1432 (let ((cat (get-text-property (point) 'category))
1433 run-end)
1434 (setq run-end
1435 (next-single-property-change (point) 'category nil end))
1436 (when cat
1437 (let (run-end2 original)
1438 (remove-list-of-text-properties (point) run-end '(category))
1439 (while (< (point) run-end)
1440 (setq run-end2 (next-property-change (point) nil run-end))
1441 (setq original (text-properties-at (point)))
1442 (set-text-properties (point) run-end2 (symbol-plist cat))
1443 (add-text-properties (point) run-end2 original)
1444 (goto-char run-end2))))
1445 (goto-char run-end)))))
1446 (if (eq yank-excluded-properties t)
1447 (set-text-properties start end nil)
1448 (remove-list-of-text-properties start end yank-excluded-properties))))
1450 (defun insert-for-yank (&rest strings)
1451 "Insert STRINGS at point, stripping some text properties.
1452 Strip text properties from the inserted text
1453 according to `yank-excluded-properties'.
1454 Otherwise just like (insert STRINGS...)."
1455 (let ((opoint (point)))
1456 (apply 'insert strings)
1457 (remove-yank-excluded-properties opoint (point))))
1459 (defun insert-buffer-substring-no-properties (buf &optional start end)
1460 "Insert before point a substring of buffer BUFFER, without text properties.
1461 BUFFER may be a buffer or a buffer name.
1462 Arguments START and END are character numbers specifying the substring.
1463 They default to the beginning and the end of BUFFER."
1464 (let ((opoint (point)))
1465 (insert-buffer-substring buf start end)
1466 (let ((inhibit-read-only t))
1467 (set-text-properties opoint (point) nil))))
1469 (defun insert-buffer-substring-as-yank (buf &optional start end)
1470 "Insert before point a part of buffer BUFFER, stripping some text properties.
1471 BUFFER may be a buffer or a buffer name. Arguments START and END are
1472 character numbers specifying the substring. They default to the
1473 beginning and the end of BUFFER. Strip text properties from the
1474 inserted text according to `yank-excluded-properties'."
1475 (let ((opoint (point)))
1476 (insert-buffer-substring buf start end)
1477 (remove-yank-excluded-properties opoint (point))))
1479 \f
1480 ;; Synchronous shell commands.
1482 (defun start-process-shell-command (name buffer &rest args)
1483 "Start a program in a subprocess. Return the process object for it.
1484 Args are NAME BUFFER COMMAND &rest COMMAND-ARGS.
1485 NAME is name for process. It is modified if necessary to make it unique.
1486 BUFFER is the buffer or (buffer-name) to associate with the process.
1487 Process output goes at end of that buffer, unless you specify
1488 an output stream or filter function to handle the output.
1489 BUFFER may be also nil, meaning that this process is not associated
1490 with any buffer
1491 Third arg is command name, the name of a shell command.
1492 Remaining arguments are the arguments for the command.
1493 Wildcards and redirection are handled as usual in the shell."
1494 (cond
1495 ((eq system-type 'vax-vms)
1496 (apply 'start-process name buffer args))
1497 ;; We used to use `exec' to replace the shell with the command,
1498 ;; but that failed to handle (...) and semicolon, etc.
1499 (t
1500 (start-process name buffer shell-file-name shell-command-switch
1501 (mapconcat 'identity args " ")))))
1503 (defun call-process-shell-command (command &optional infile buffer display
1504 &rest args)
1505 "Execute the shell command COMMAND synchronously in separate process.
1506 The remaining arguments are optional.
1507 The program's input comes from file INFILE (nil means `/dev/null').
1508 Insert output in BUFFER before point; t means current buffer;
1509 nil for BUFFER means discard it; 0 means discard and don't wait.
1510 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1511 REAL-BUFFER says what to do with standard output, as above,
1512 while STDERR-FILE says what to do with standard error in the child.
1513 STDERR-FILE may be nil (discard standard error output),
1514 t (mix it with ordinary output), or a file name string.
1516 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1517 Remaining arguments are strings passed as additional arguments for COMMAND.
1518 Wildcards and redirection are handled as usual in the shell.
1520 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
1521 Otherwise it waits for COMMAND to terminate and returns a numeric exit
1522 status or a signal description string.
1523 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
1524 (cond
1525 ((eq system-type 'vax-vms)
1526 (apply 'call-process command infile buffer display args))
1527 ;; We used to use `exec' to replace the shell with the command,
1528 ;; but that failed to handle (...) and semicolon, etc.
1529 (t
1530 (call-process shell-file-name
1531 infile buffer display
1532 shell-command-switch
1533 (mapconcat 'identity (cons command args) " ")))))
1534 \f
1535 (defmacro with-current-buffer (buffer &rest body)
1536 "Execute the forms in BODY with BUFFER as the current buffer.
1537 The value returned is the value of the last form in BODY.
1538 See also `with-temp-buffer'."
1539 (cons 'save-current-buffer
1540 (cons (list 'set-buffer buffer)
1541 body)))
1543 (defmacro with-temp-file (file &rest body)
1544 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
1545 The value returned is the value of the last form in BODY.
1546 See also `with-temp-buffer'."
1547 (let ((temp-file (make-symbol "temp-file"))
1548 (temp-buffer (make-symbol "temp-buffer")))
1549 `(let ((,temp-file ,file)
1550 (,temp-buffer
1551 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
1552 (unwind-protect
1553 (prog1
1554 (with-current-buffer ,temp-buffer
1555 ,@body)
1556 (with-current-buffer ,temp-buffer
1557 (widen)
1558 (write-region (point-min) (point-max) ,temp-file nil 0)))
1559 (and (buffer-name ,temp-buffer)
1560 (kill-buffer ,temp-buffer))))))
1562 (defmacro with-temp-message (message &rest body)
1563 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
1564 The original message is restored to the echo area after BODY has finished.
1565 The value returned is the value of the last form in BODY.
1566 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
1567 If MESSAGE is nil, the echo area and message log buffer are unchanged.
1569 (let ((current-message (make-symbol "current-message"))
1570 (temp-message (make-symbol "with-temp-message")))
1571 `(let ((,temp-message ,message)
1572 (,current-message))
1573 (unwind-protect
1574 (progn
1575 (when ,temp-message
1576 (setq ,current-message (current-message))
1577 (message "%s" ,temp-message))
1578 ,@body)
1579 (and ,temp-message
1580 (if ,current-message
1581 (message "%s" ,current-message)
1582 (message nil)))))))
1584 (defmacro with-temp-buffer (&rest body)
1585 "Create a temporary buffer, and evaluate BODY there like `progn'.
1586 See also `with-temp-file' and `with-output-to-string'."
1587 (let ((temp-buffer (make-symbol "temp-buffer")))
1588 `(let ((,temp-buffer
1589 (get-buffer-create (generate-new-buffer-name " *temp*"))))
1590 (unwind-protect
1591 (with-current-buffer ,temp-buffer
1592 ,@body)
1593 (and (buffer-name ,temp-buffer)
1594 (kill-buffer ,temp-buffer))))))
1596 (defmacro with-output-to-string (&rest body)
1597 "Execute BODY, return the text it sent to `standard-output', as a string."
1598 `(let ((standard-output
1599 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
1600 (let ((standard-output standard-output))
1601 ,@body)
1602 (with-current-buffer standard-output
1603 (prog1
1604 (buffer-string)
1605 (kill-buffer nil)))))
1607 (defmacro with-local-quit (&rest body)
1608 "Execute BODY with `inhibit-quit' temporarily bound to nil."
1609 `(condition-case nil
1610 (let ((inhibit-quit nil))
1611 ,@body)
1612 (quit (setq quit-flag t))))
1614 (defmacro combine-after-change-calls (&rest body)
1615 "Execute BODY, but don't call the after-change functions till the end.
1616 If BODY makes changes in the buffer, they are recorded
1617 and the functions on `after-change-functions' are called several times
1618 when BODY is finished.
1619 The return value is the value of the last form in BODY.
1621 If `before-change-functions' is non-nil, then calls to the after-change
1622 functions can't be deferred, so in that case this macro has no effect.
1624 Do not alter `after-change-functions' or `before-change-functions'
1625 in BODY."
1626 `(unwind-protect
1627 (let ((combine-after-change-calls t))
1628 . ,body)
1629 (combine-after-change-execute)))
1632 (defvar delay-mode-hooks nil
1633 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1634 (defvar delayed-mode-hooks nil
1635 "List of delayed mode hooks waiting to be run.")
1636 (make-variable-buffer-local 'delayed-mode-hooks)
1638 (defun run-mode-hooks (&rest hooks)
1639 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1640 Execution is delayed if `delay-mode-hooks' is non-nil.
1641 Major mode functions should use this."
1642 (if delay-mode-hooks
1643 ;; Delaying case.
1644 (dolist (hook hooks)
1645 (push hook delayed-mode-hooks))
1646 ;; Normal case, just run the hook as before plus any delayed hooks.
1647 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1648 (setq delayed-mode-hooks nil)
1649 (apply 'run-hooks hooks)))
1651 (defmacro delay-mode-hooks (&rest body)
1652 "Execute BODY, but delay any `run-mode-hooks'.
1653 Only affects hooks run in the current buffer."
1654 `(progn
1655 (make-local-variable 'delay-mode-hooks)
1656 (let ((delay-mode-hooks t))
1657 ,@body)))
1659 ;; PUBLIC: find if the current mode derives from another.
1661 (defun derived-mode-p (&rest modes)
1662 "Non-nil if the current major mode is derived from one of MODES.
1663 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1664 (let ((parent major-mode))
1665 (while (and (not (memq parent modes))
1666 (setq parent (get parent 'derived-mode-parent))))
1667 parent))
1669 (defmacro with-syntax-table (table &rest body)
1670 "Evaluate BODY with syntax table of current buffer set to a copy of TABLE.
1671 The syntax table of the current buffer is saved, BODY is evaluated, and the
1672 saved table is restored, even in case of an abnormal exit.
1673 Value is what BODY returns."
1674 (let ((old-table (make-symbol "table"))
1675 (old-buffer (make-symbol "buffer")))
1676 `(let ((,old-table (syntax-table))
1677 (,old-buffer (current-buffer)))
1678 (unwind-protect
1679 (progn
1680 (set-syntax-table (copy-syntax-table ,table))
1681 ,@body)
1682 (save-current-buffer
1683 (set-buffer ,old-buffer)
1684 (set-syntax-table ,old-table))))))
1685 \f
1686 ;;; Matching and substitution
1688 (defvar save-match-data-internal)
1690 ;; We use save-match-data-internal as the local variable because
1691 ;; that works ok in practice (people should not use that variable elsewhere).
1692 ;; We used to use an uninterned symbol; the compiler handles that properly
1693 ;; now, but it generates slower code.
1694 (defmacro save-match-data (&rest body)
1695 "Execute the BODY forms, restoring the global value of the match data.
1696 The value returned is the value of the last form in BODY."
1697 ;; It is better not to use backquote here,
1698 ;; because that makes a bootstrapping problem
1699 ;; if you need to recompile all the Lisp files using interpreted code.
1700 (list 'let
1701 '((save-match-data-internal (match-data)))
1702 (list 'unwind-protect
1703 (cons 'progn body)
1704 '(set-match-data save-match-data-internal))))
1706 (defun match-string (num &optional string)
1707 "Return string of text matched by last search.
1708 NUM specifies which parenthesized expression in the last regexp.
1709 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
1710 Zero means the entire text matched by the whole regexp or whole string.
1711 STRING should be given if the last search was by `string-match' on STRING."
1712 (if (match-beginning num)
1713 (if string
1714 (substring string (match-beginning num) (match-end num))
1715 (buffer-substring (match-beginning num) (match-end num)))))
1717 (defun match-string-no-properties (num &optional string)
1718 "Return string of text matched by last search, without text properties.
1719 NUM specifies which parenthesized expression in the last regexp.
1720 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
1721 Zero means the entire text matched by the whole regexp or whole string.
1722 STRING should be given if the last search was by `string-match' on STRING."
1723 (if (match-beginning num)
1724 (if string
1725 (let ((result
1726 (substring string (match-beginning num) (match-end num))))
1727 (set-text-properties 0 (length result) nil result)
1728 result)
1729 (buffer-substring-no-properties (match-beginning num)
1730 (match-end num)))))
1732 (defun split-string (string &optional separators)
1733 "Splits STRING into substrings where there are matches for SEPARATORS.
1734 Each match for SEPARATORS is a splitting point.
1735 The substrings between the splitting points are made into a list
1736 which is returned.
1739 If there is match for SEPARATORS at the beginning of STRING, we do not
1740 include a null substring for that. Likewise, if there is a match
1741 at the end of STRING, we don't include a null substring for that.
1743 Modifies the match data; use `save-match-data' if necessary."
1745 (start 0)
1746 notfirst
1747 (list nil))
1748 (while (and (string-match rexp string
1749 (if (and notfirst
1750 (= start (match-beginning 0))
1751 (< start (length string)))
1752 (1+ start) start))
1753 (< (match-beginning 0) (length string)))
1754 (setq notfirst t)
1755 (or (eq (match-beginning 0) 0)
1756 (and (eq (match-beginning 0) (match-end 0))
1757 (eq (match-beginning 0) start))
1758 (setq list
1759 (cons (substring string start (match-beginning 0))
1760 list)))
1761 (setq start (match-end 0)))
1762 (or (eq start (length string))
1763 (setq list
1764 (cons (substring string start)
1765 list)))
1766 (nreverse list)))
1768 (defun subst-char-in-string (fromchar tochar string &optional inplace)
1769 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
1770 Unless optional argument INPLACE is non-nil, return a new string."
1771 (let ((i (length string))
1772 (newstr (if inplace string (copy-sequence string))))
1773 (while (> i 0)
1774 (setq i (1- i))
1775 (if (eq (aref newstr i) fromchar)
1776 (aset newstr i tochar)))
1777 newstr))
1779 (defun replace-regexp-in-string (regexp rep string &optional
1780 fixedcase literal subexp start)
1781 "Replace all matches for REGEXP with REP in STRING.
1783 Return a new string containing the replacements.
1785 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
1786 arguments with the same names of function `replace-match'. If START
1787 is non-nil, start replacements at that index in STRING.
1789 REP is either a string used as the NEWTEXT arg of `replace-match' or a
1790 function. If it is a function it is applied to each match to generate
1791 the replacement passed to `replace-match'; the match-data at this
1792 point are such that match 0 is the function's argument.
1795 and replace a sub-expression, e.g.
1798 "
1800 ;; To avoid excessive consing from multiple matches in long strings,
1801 ;; don't just call `replace-match' continually. Walk down the
1802 ;; string looking for matches of REGEXP and building up a (reversed)
1803 ;; list MATCHES. This comprises segments of STRING which weren't
1804 ;; matched interspersed with replacements for segments that were.
1805 ;; [For a `large' number of replacements it's more efficient to
1806 ;; operate in a temporary buffer; we can't tell from the function's
1807 ;; args whether to choose the buffer-based implementation, though it
1808 ;; might be reasonable to do so for long enough STRING.]
1809 (let ((l (length string))
1810 (start (or start 0))
1811 matches str mb me)
1812 (save-match-data
1813 (while (and (< start l) (string-match regexp string start))
1814 (setq mb (match-beginning 0)
1815 me (match-end 0))
1816 ;; If we matched the empty string, make sure we advance by one char
1817 (when (= me mb) (setq me (min l (1+ mb))))
1818 ;; Generate a replacement for the matched substring.
1819 ;; Operate only on the substring to minimize string consing.
1820 ;; Set up match data for the substring for replacement;
1821 ;; presumably this is likely to be faster than munging the
1822 ;; match data directly in Lisp.
1823 (string-match regexp (setq str (substring string mb me)))
1824 (setq matches
1825 (cons (replace-match (if (stringp rep)
1826 rep
1827 (funcall rep (match-string 0 str)))
1828 fixedcase literal str subexp)
1829 (cons (substring string start mb) ; unmatched prefix
1830 matches)))
1831 (setq start me))
1832 ;; Reconstruct a string from the pieces.
1833 (setq matches (cons (substring string start l) matches)) ; leftover
1834 (apply #'concat (nreverse matches)))))
1835 \f
1836 (defun shell-quote-argument (argument)
1837 "Quote an argument for passing as argument to an inferior shell."
1838 (if (eq system-type 'ms-dos)
1839 ;; Quote using double quotes, but escape any existing quotes in
1840 ;; the argument with backslashes.
1841 (let ((result "")
1842 (start 0)
1843 end)
1845 (< (match-end 0) (length argument)))
1847 (setq end (match-beginning 0)
1848 result (concat result (substring argument start end)
1850 start (1+ end))))
1852 (if (eq system-type 'windows-nt)
1854 (if (equal argument "")
1855 "''"
1856 ;; Quote everything except POSIX filename characters.
1857 ;; This should be safe enough even for really weird shells.
1858 (let ((result "") (start 0) end)
1859 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
1860 (setq end (match-beginning 0)
1861 result (concat result (substring argument start end)
1863 start (1+ end)))
1864 (concat result (substring argument start)))))))
1866 (defun make-syntax-table (&optional oldtable)
1867 "Return a new syntax table.
1868 Create a syntax table which inherits from OLDTABLE (if non-nil) or
1869 from `standard-syntax-table' otherwise."
1870 (let ((table (make-char-table 'syntax-table nil)))
1871 (set-char-table-parent table (or oldtable (standard-syntax-table)))
1872 table))
1874 (defun syntax-after (pos)
1875 "Return the syntax of the char after POS."
1876 (unless (or (< pos (point-min)) (>= pos (point-max)))
1877 (let ((st (if parse-sexp-lookup-properties
1878 (get-char-property pos 'syntax-table))))
1879 (if (consp st) st
1880 (aref (or st (syntax-table)) (char-after pos))))))
1882 (defun add-to-invisibility-spec (arg)
1883 "Add elements to `buffer-invisibility-spec'.
1884 See documentation for `buffer-invisibility-spec' for the kind of elements
1885 that can be added."
1886 (cond
1887 ((or (null buffer-invisibility-spec) (eq buffer-invisibility-spec t))
1888 (setq buffer-invisibility-spec (list arg)))
1889 (t
1890 (setq buffer-invisibility-spec
1891 (cons arg buffer-invisibility-spec)))))
1893 (defun remove-from-invisibility-spec (arg)
1894 "Remove elements from `buffer-invisibility-spec'."
1895 (if (consp buffer-invisibility-spec)
1896 (setq buffer-invisibility-spec (delete arg buffer-invisibility-spec))))
1897 \f
1898 (defun global-set-key (key command)
1899 "Give KEY a global binding as COMMAND.
1900 COMMAND is the command definition to use; usually it is
1901 a symbol naming an interactively-callable function.
1902 KEY is a key sequence; noninteractively, it is a string or vector
1903 of characters or event types, and non-ASCII characters with codes
1904 above 127 (such as ISO Latin-1) can be included if you use a vector.
1906 Note that if KEY has a local binding in the current buffer,
1907 that local binding will continue to shadow any global binding
1908 that you make with this function."
1910 (or (vectorp key) (stringp key)
1911 (signal 'wrong-type-argument (list 'arrayp key)))
1912 (define-key (current-global-map) key command))
1914 (defun local-set-key (key command)
1915 "Give KEY a local binding as COMMAND.
1916 COMMAND is the command definition to use; usually it is
1917 a symbol naming an interactively-callable function.
1918 KEY is a key sequence; noninteractively, it is a string or vector
1919 of characters or event types, and non-ASCII characters with codes
1920 above 127 (such as ISO Latin-1) can be included if you use a vector.
1922 The binding goes in the current buffer's local map,
1923 which in most cases is shared with all other buffers in the same major mode."
1925 (let ((map (current-local-map)))
1926 (or map
1927 (use-local-map (setq map (make-sparse-keymap))))
1928 (or (vectorp key) (stringp key)
1929 (signal 'wrong-type-argument (list 'arrayp key)))
1930 (define-key map key command)))
1932 (defun global-unset-key (key)
1933 "Remove global binding of KEY.
1934 KEY is a string representing a sequence of keystrokes."
1935 (interactive "kUnset key globally: ")
1936 (global-set-key key nil))
1938 (defun local-unset-key (key)
1939 "Remove local binding of KEY.
1940 KEY is a string representing a sequence of keystrokes."
1941 (interactive "kUnset key locally: ")
1942 (if (current-local-map)
1943 (local-set-key key nil))
1944 nil)
1945 \f
1946 ;; We put this here instead of in frame.el so that it's defined even on
1947 ;; systems where frame.el isn't loaded.
1948 (defun frame-configuration-p (object)
1949 "Return non-nil if OBJECT seems to be a frame configuration.
1950 Any list whose car is `frame-configuration' is assumed to be a frame
1951 configuration."
1952 (and (consp object)
1953 (eq (car object) 'frame-configuration)))
1955 (defun functionp (object)
1956 "Non-nil iff OBJECT is a type of object that can be called as a function."
1957 (or (and (symbolp object) (fboundp object)
1958 (condition-case nil
1959 (setq object (indirect-function object))
1960 (error nil))
1961 (eq (car-safe object) 'autoload)
1962 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object)))))))
1963 (subrp object) (byte-code-function-p object)
1964 (eq (car-safe object) 'lambda)))
1966 (defun interactive-form (function)
1967 "Return the interactive form of FUNCTION.
1968 If function is a command (see `commandp'), value is a list of the form
1969 \(interactive SPEC). If function is not a command, return nil."
1970 (setq function (indirect-function function))
1971 (when (commandp function)
1972 (cond ((byte-code-function-p function)
1973 (when (> (length function) 5)
1974 (let ((spec (aref function 5)))
1975 (if spec
1976 (list 'interactive spec)
1977 (list 'interactive)))))
1978 ((subrp function)
1979 (subr-interactive-form function))
1980 ((eq (car-safe function) 'lambda)
1981 (setq function (cddr function))
1982 (when (stringp (car function))
1983 (setq function (cdr function)))
1984 (let ((form (car function)))
1985 (when (eq (car-safe form) 'interactive)
1986 (copy-sequence form)))))))
1988 (defun assq-delete-all (key alist)
1989 "Delete from ALIST all elements whose car is KEY.
1990 Return the modified alist."
1991 (let ((tail alist))
1992 (while tail
1993 (if (eq (car (car tail)) key)
1994 (setq alist (delq (car tail) alist)))
1995 (setq tail (cdr tail)))
1996 alist))
1998 (defun make-temp-file (prefix &optional dir-flag suffix)
1999 "Create a temporary file.
2000 The returned file name (created by appending some random characters at the end
2001 of PREFIX, and expanding against `temporary-file-directory' if necessary),
2002 is guaranteed to point to a newly created empty file.
2003 You can then use `write-region' to write new data into the file.
2005 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
2007 If SUFFIX is non-nil, add that at the end of the file name."
2008 (let ((umask (default-file-modes))
2009 file)
2010 (unwind-protect
2011 (progn
2012 ;; Create temp files with strict access rights. It's easy to
2013 ;; loosen them later, whereas it's impossible to close the
2014 ;; time-window of loose permissions otherwise.
2016 (while (condition-case ()
2017 (progn
2018 (setq file
2019 (make-temp-name
2020 (expand-file-name prefix temporary-file-directory)))
2021 (if suffix
2022 (setq file (concat file suffix)))
2023 (if dir-flag
2024 (make-directory file)
2025 (write-region "" nil file nil 'silent nil 'excl))
2026 nil)
2027 (file-already-exists t))
2028 ;; the file was somehow created by someone else between
2029 ;; `make-temp-name' and `write-region', let's try again.
2030 nil)
2031 file)
2032 ;; Reset the umask.
2033 (set-default-file-modes umask))))
2035 \f
2036 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
2037 "Register a new minor mode.
2039 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
2041 TOGGLE is a symbol which is the name of a buffer-local variable that
2042 is toggled on or off to say whether the minor mode is active or not.
2044 NAME specifies what will appear in the mode line when the minor mode
2045 is active. NAME should be either a string starting with a space, or a
2046 symbol whose value is such a string.
2048 Optional KEYMAP is the keymap for the minor mode that will be added
2049 to `minor-mode-map-alist'.
2051 Optional AFTER specifies that TOGGLE should be added after AFTER
2052 in `minor-mode-alist'.
2054 Optional TOGGLE-FUN is an interactive function to toggle the mode.
2055 It defaults to (and should by convention be) TOGGLE.
2057 If TOGGLE has a non-nil `:included' property, an entry for the mode is
2058 included in the mode-line minor mode menu.
2059 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
2060 (unless toggle-fun (setq toggle-fun toggle))
2061 ;; Add the name to the minor-mode-alist.
2062 (when name
2063 (let ((existing (assq toggle minor-mode-alist)))
2064 (if existing
2065 (setcdr existing (list name))
2066 (let ((tail minor-mode-alist) found)
2067 (while (and tail (not found))
2068 (if (eq after (caar tail))
2069 (setq found tail)
2070 (setq tail (cdr tail))))
2071 (if found
2072 (let ((rest (cdr found)))
2073 (setcdr found nil)
2074 (nconc found (list (list toggle name)) rest))
2075 (setq minor-mode-alist (cons (list toggle name)
2076 minor-mode-alist)))))))
2077 ;; Add the toggle to the minor-modes menu if requested.
2078 (when (get toggle :included)
2079 (define-key mode-line-mode-menu
2080 (vector toggle)
2081 (list 'menu-item
2082 (concat
2083 (or (get toggle :menu-tag)
2084 (if (stringp name) name (symbol-name toggle)))
2085 (let ((mode-name (if (symbolp name) (symbol-value name))))
2086 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
2087 (concat " (" (match-string 0 mode-name) ")"))))
2088 toggle-fun
2089 :button (cons :toggle toggle))))
2091 ;; Add the map to the minor-mode-map-alist.
2092 (when keymap
2093 (let ((existing (assq toggle minor-mode-map-alist)))
2094 (if existing
2095 (setcdr existing keymap)
2096 (let ((tail minor-mode-map-alist) found)
2097 (while (and tail (not found))
2098 (if (eq after (caar tail))
2099 (setq found tail)
2100 (setq tail (cdr tail))))
2101 (if found
2102 (let ((rest (cdr found)))
2103 (setcdr found nil)
2104 (nconc found (list (cons toggle keymap)) rest))
2105 (setq minor-mode-map-alist (cons (cons toggle keymap)
2106 minor-mode-map-alist))))))))
2107 \f
2108 ;; Clones ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2110 (defun text-clone-maintain (ol1 after beg end &optional len)
2111 "Propagate the changes made under the overlay OL1 to the other clones.
2112 This is used on the `modification-hooks' property of text clones."
2113 (when (and after (not undo-in-progress) (overlay-start ol1))
2114 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
2115 (setq beg (max beg (+ (overlay-start ol1) margin)))
2116 (setq end (min end (- (overlay-end ol1) margin)))
2117 (when (<= beg end)
2118 (save-excursion
2119 (when (overlay-get ol1 'text-clone-syntax)
2120 ;; Check content of the clone's text.
2121 (let ((cbeg (+ (overlay-start ol1) margin))
2122 (cend (- (overlay-end ol1) margin)))
2123 (goto-char cbeg)
2124 (save-match-data
2125 (if (not (re-search-forward
2126 (overlay-get ol1 'text-clone-syntax) cend t))
2127 ;; Mark the overlay for deletion.
2128 (overlay-put ol1 'text-clones nil)
2129 (when (< (match-end 0) cend)
2130 ;; Shrink the clone at its end.
2131 (setq end (min end (match-end 0)))
2132 (move-overlay ol1 (overlay-start ol1)
2133 (+ (match-end 0) margin)))
2134 (when (> (match-beginning 0) cbeg)
2135 ;; Shrink the clone at its beginning.
2136 (setq beg (max (match-beginning 0) beg))
2137 (move-overlay ol1 (- (match-beginning 0) margin)
2138 (overlay-end ol1)))))))
2139 ;; Now go ahead and update the clones.
2140 (let ((head (- beg (overlay-start ol1)))
2141 (tail (- (overlay-end ol1) end))
2142 (str (buffer-substring beg end))
2143 (nothing-left t)
2144 (inhibit-modification-hooks t))
2145 (dolist (ol2 (overlay-get ol1 'text-clones))
2146 (let ((oe (overlay-end ol2)))
2147 (unless (or (eq ol1 ol2) (null oe))
2148 (setq nothing-left nil)
2149 (let ((mod-beg (+ (overlay-start ol2) head)))
2150 ;;(overlay-put ol2 'modification-hooks nil)
2151 (goto-char (- (overlay-end ol2) tail))
2152 (unless (> mod-beg (point))
2153 (save-excursion (insert str))
2154 (delete-region mod-beg (point)))
2155 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
2156 ))))
2157 (if nothing-left (delete-overlay ol1))))))))
2159 (defun text-clone-create (start end &optional spreadp syntax)
2160 "Create a text clone of START...END at point.
2161 Text clones are chunks of text that are automatically kept identical:
2162 changes done to one of the clones will be immediately propagated to the other.
2164 The buffer's content at point is assumed to be already identical to
2165 the one between START and END.
2166 If SYNTAX is provided it's a regexp that describes the possible text of
2167 the clones; the clone will be shrunk or killed if necessary to ensure that
2168 its text matches the regexp.
2169 If SPREADP is non-nil it indicates that text inserted before/after the
2170 clone should be incorporated in the clone."
2171 ;; To deal with SPREADP we can either use an overlay with `nil t' along
2172 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
2173 ;; (with a one-char margin at each end) with `t nil'.
2174 ;; We opted for a larger overlay because it behaves better in the case
2175 ;; where the clone is reduced to the empty string (we want the overlay to
2176 ;; stay when the clone's content is the empty string and we want to use
2177 ;; `evaporate' to make sure those overlays get deleted when needed).
2178 ;;
2179 (let* ((pt-end (+ (point) (- end start)))
2180 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
2181 0 1))
2182 (end-margin (if (or (not spreadp)
2183 (>= pt-end (point-max))
2184 (>= start (point-max)))
2185 0 1))
2186 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
2187 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
2188 (dups (list ol1 ol2)))
2189 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
2190 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
2191 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
2192 ;;(overlay-put ol1 'face 'underline)
2193 (overlay-put ol1 'evaporate t)
2194 (overlay-put ol1 'text-clones dups)
2195 ;;
2196 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
2197 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
2198 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
2199 ;;(overlay-put ol2 'face 'underline)
2200 (overlay-put ol2 'evaporate t)
2201 (overlay-put ol2 'text-clones dups)))
2203 (defun play-sound (sound)
2204 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2205 The following keywords are recognized:
2207 :file FILE - read sound data from FILE. If FILE isn't an
2208 absolute file name, it is searched in `data-directory'.
2210 :data DATA - read sound data from string DATA.
2212 Exactly one of :file or :data must be present.
2214 :volume VOL - set volume to VOL. VOL must an integer in the
2215 range 0..100 or a float in the range 0..1.0. If not specified,
2216 don't change the volume setting of the sound device.
2218 :device DEVICE - play sound on DEVICE. If not specified,
2219 a system-dependent default device name is used."
2220 (unless (fboundp 'play-sound-internal)
2221 (error "This Emacs binary lacks sound support"))
2222 (play-sound-internal sound))
2224 (defun define-mail-user-agent (symbol composefunc sendfunc
2225 &optional abortfunc hookvar)
2226 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
2228 SYMBOL can be any Lisp symbol. Its function definition and/or
2229 value as a variable do not matter for this usage; we use only certain
2230 properties on its property list, to encode the rest of the arguments.
2232 COMPOSEFUNC is program callable function that composes an outgoing
2233 mail message buffer. This function should set up the basics of the
2234 buffer without requiring user interaction. It should populate the
2235 standard mail headers, leaving the `to:' and `subject:' headers blank
2236 by default.
2238 COMPOSEFUNC should accept several optional arguments--the same
2239 arguments that `compose-mail' takes. See that function's documentation.
2241 SENDFUNC is the command a user would run to send the message.
2243 Optional ABORTFUNC is the command a user would run to abort the
2244 message. For mail packages that don't have a separate abort function,
2245 this can be `kill-buffer' (the equivalent of omitting this argument).
2247 Optional HOOKVAR is a hook variable that gets run before the message
2248 is actually sent. Callers that use the `mail-user-agent' may
2249 install a hook function temporarily on this hook variable.
2250 If HOOKVAR is nil, `mail-send-hook' is used.
2252 The properties used on SYMBOL are `composefunc', `sendfunc',
2253 `abortfunc', and `hookvar'."
2254 (put symbol 'composefunc composefunc)
2255 (put symbol 'sendfunc sendfunc)
2256 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
2257 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
2259 ;;; subr.el ends here