1 ;;; subr.el --- basic lisp subroutines for XEmacs
3 ;; Copyright (C) 1985, 1986, 1992, 1994-5, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
5 ;; Copyright (C) 1995 Sun Microsystems.
7 ;; Maintainer: XEmacs Development Team
8 ;; Keywords: extensions, dumped
10 ;; This file is part of XEmacs.
12 ;; XEmacs is free software; you can redistribute it and/or modify it
13 ;; under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; XEmacs is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ;; General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
27 ;;; Synched up with: FSF 19.34.
31 ;; This file is dumped with XEmacs.
33 ;; There's not a whole lot in common now with the FSF version,
34 ;; be wary when applying differences. I've left in a number of lines
35 ;; of commentary just to give diff(1) something to synch itself with to
36 ;; provide useful context diffs. -sb
41 ;;;; Lisp language features.
43 (defmacro lambda (&rest cdr)
44 "Return a lambda expression.
45 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
46 self-quoting; the result of evaluating the lambda expression is the
47 expression itself. The lambda expression may then be treated as a
48 function, i.e., stored as the function value of a symbol, passed to
49 funcall or mapcar, etc.
51 ARGS should take the same form as an argument list for a `defun'.
52 DOCSTRING is an optional documentation string.
53 If present, it should describe how to call the function.
54 But documentation strings are usually not useful in nameless functions.
55 INTERACTIVE should be a call to the function `interactive', which see.
56 It may also be omitted.
57 BODY should be a list of lisp expressions."
58 `(function (lambda ,@cdr)))
60 (defmacro defun-when-void (&rest args)
61 "Define a function, just like `defun', unless it's already defined.
62 Used for compatibility among different emacs variants."
63 `(if (fboundp ',(car args))
67 (defmacro define-function-when-void (&rest args)
68 "Define a function, just like `define-function', unless it's already defined.
69 Used for compatibility among different emacs variants."
70 `(if (fboundp ,(car args))
72 (define-function ,@args)))
76 ;; XEmacs: removed to keymap.el
78 ;;;; The global keymap tree.
80 ;;; global-map, esc-map, and ctl-x-map have their values set up in
81 ;;; keymap.c; we just give them docstrings here.
83 ;;;; Event manipulation functions.
85 ;; XEmacs: This stuff is done in C Code.
87 ;;;; Obsolescent names for functions.
91 (defun local-variable-if-set-p (sym buffer)
92 "Return t if SYM would be local to BUFFER after it is set.
93 A nil value for BUFFER is *not* the same as (current-buffer), but
94 can be used to determine whether `make-variable-buffer-local' has been
96 (local-variable-p sym buffer t))
99 ;;;; Hook manipulation functions.
101 ;; (defconst run-hooks 'run-hooks ...)
103 (defun make-local-hook (hook)
104 "Make the hook HOOK local to the current buffer.
105 When a hook is local, its local and global values
106 work in concert: running the hook actually runs all the hook
107 functions listed in *either* the local value *or* the global value
108 of the hook variable.
110 This function works by making `t' a member of the buffer-local value,
111 which acts as a flag to run the hook functions in the default value as
112 well. This works for all normal hooks, but does not work for most
113 non-normal hooks yet. We will be changing the callers of non-normal
114 hooks so that they can handle localness; this has to be done one by
117 This function does nothing if HOOK is already local in the current
120 Do not use `make-local-variable' to make a hook variable buffer-local."
121 (if (local-variable-p hook (current-buffer)) ; XEmacs
123 (or (boundp hook) (set hook nil))
124 (make-local-variable hook)
125 (set hook (list t))))
127 (defun add-hook (hook function &optional append local)
128 "Add to the value of HOOK the function FUNCTION.
129 FUNCTION is not added if already present.
130 FUNCTION is added (if necessary) at the beginning of the hook list
131 unless the optional argument APPEND is non-nil, in which case
132 FUNCTION is added at the end.
134 The optional fourth argument, LOCAL, if non-nil, says to modify
135 the hook's buffer-local value rather than its default value.
136 This makes no difference if the hook is not buffer-local.
137 To make a hook variable buffer-local, always use
138 `make-local-hook', not `make-local-variable'.
140 HOOK should be a symbol, and FUNCTION may be any valid function. If
141 HOOK is void, it is first set to nil. If HOOK's value is a single
142 function, it is changed to a list of functions."
143 (or (boundp hook) (set hook nil))
144 (or (default-boundp hook) (set-default hook nil))
145 ;; If the hook value is a single function, turn it into a list.
146 (let ((old (symbol-value hook)))
147 (if (or (not (listp old)) (eq (car old) 'lambda))
148 (set hook (list old))))
150 ;; Detect the case where make-local-variable was used on a hook
151 ;; and do what we used to do.
152 (and (local-variable-if-set-p hook (current-buffer)) ; XEmacs
153 (not (memq t (symbol-value hook)))))
154 ;; Alter the local value only.
155 (or (if (consp function)
156 (member function (symbol-value hook))
157 (memq function (symbol-value hook)))
160 (append (symbol-value hook) (list function))
161 (cons function (symbol-value hook)))))
162 ;; Alter the global value (which is also the only value,
163 ;; if the hook doesn't have a local value).
164 (or (if (consp function)
165 (member function (default-value hook))
166 (memq function (default-value hook)))
169 (append (default-value hook) (list function))
170 (cons function (default-value hook)))))))
172 (defun remove-hook (hook function &optional local)
173 "Remove from the value of HOOK the function FUNCTION.
174 HOOK should be a symbol, and FUNCTION may be any valid function. If
175 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
176 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
178 The optional third argument, LOCAL, if non-nil, says to modify
179 the hook's buffer-local value rather than its default value.
180 This makes no difference if the hook is not buffer-local.
181 To make a hook variable buffer-local, always use
182 `make-local-hook', not `make-local-variable'."
183 (if (or (not (boundp hook)) ;unbound symbol, or
184 (not (default-boundp 'hook))
185 (null (symbol-value hook)) ;value is nil, or
186 (null function)) ;function is nil, then
189 ;; Detect the case where make-local-variable was used on a hook
190 ;; and do what we used to do.
191 (and (local-variable-p hook (current-buffer))
192 (not (memq t (symbol-value hook)))))
193 (let ((hook-value (symbol-value hook)))
194 (if (and (consp hook-value) (not (functionp hook-value)))
195 (if (member function hook-value)
196 (setq hook-value (delete function (copy-sequence hook-value))))
197 (if (equal hook-value function)
198 (setq hook-value nil)))
199 (set hook hook-value))
200 (let ((hook-value (default-value hook)))
201 (if (and (consp hook-value) (not (functionp hook-value)))
202 (if (member function hook-value)
203 (setq hook-value (delete function (copy-sequence hook-value))))
204 (if (equal hook-value function)
205 (setq hook-value nil)))
206 (set-default hook hook-value)))))
208 (defun add-to-list (list-var element)
209 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet.
210 The test for presence of ELEMENT is done with `equal'.
211 If you want to use `add-to-list' on a variable that is not defined
212 until a certain package is loaded, you should put the call to `add-to-list'
213 into a hook function that will be run only after loading the package.
214 `eval-after-load' provides one way to do this. In some cases
215 other hooks, such as major mode hooks, can do the job."
216 (or (member element (symbol-value list-var))
217 (set list-var (cons element (symbol-value list-var)))))
220 ;; called by Fkill_buffer()
221 (defvar kill-buffer-hook nil
222 "Function or functions to be called when a buffer is killed.
223 The value of this variable may be buffer-local.
224 The buffer about to be killed is current when this hook is run.")
227 (defvar kill-emacs-hook nil
228 "Function or functions to be called when `kill-emacs' is called,
229 just before emacs is actually killed.")
232 ;; #### These are a bad idea, because the CL RPLACA and RPLACD
233 ;; return the cons cell, not the new CAR/CDR. -hniksic
234 ;; The proper definition would be:
235 ;; (defun rplaca (conscell newcar)
236 ;; (setcar conscell newcar)
238 ;; ...and analogously for RPLACD.
239 (define-function 'rplaca 'setcar)
240 (define-function 'rplacd 'setcdr)
242 ;;;; String functions.
245 (defun replace-in-string (str regexp newtext &optional literal)
246 "Replace all matches in STR for REGEXP with NEWTEXT string,
247 and returns the new string.
248 Optional LITERAL non-nil means do a literal replacement.
249 Otherwise treat \\ in NEWTEXT string as special:
250 \\& means substitute original matched text,
251 \\N means substitute match for \(...\) number N,
252 \\\\ means insert one \\."
253 (check-argument-type 'stringp str)
254 (check-argument-type 'stringp newtext)
259 (while (setq match (string-match regexp str start))
260 (setq prev-start start
265 (substring str prev-start match)
266 (cond (literal newtext)
272 (cond ((eq c ?\\) "\\")
277 ((and (>= c ?0) (<= c ?9))
278 (if (> c (+ ?0 (length
281 (error "Invalid match num: %c" c)
286 (t (char-to-string c))))
287 (if (eq c ?\\) (progn (setq special t) nil)
288 (char-to-string c))))
290 (concat rtn-str (substring str start))))
292 (defun split-string (string &optional pattern)
293 "Return a list of substrings of STRING which are separated by PATTERN.
294 If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
296 (setq pattern "[ \f\t\n\r\v]+"))
297 (let (parts (start 0) (len (length string)))
298 (if (string-match pattern string)
299 (setq parts (cons (substring string 0 (match-beginning 0)) parts)
300 start (match-end 0)))
301 (while (and (< start len)
302 (string-match pattern string (if (> start (match-beginning 0))
305 (setq parts (cons (substring string start (match-beginning 0)) parts)
306 start (match-end 0)))
307 (nreverse (cons (substring string start) parts))))
309 ;; #### #### #### AAaargh! Must be in C, because it is used insanely
310 ;; early in the bootstrap process.
311 ;(defun split-path (path)
312 ; "Explode a search path into a list of strings.
313 ;The path components are separated with the characters specified
314 ;with `path-separator'."
315 ; (while (or (not stringp path-separator)
316 ; (/= (length path-separator) 1))
317 ; (setq path-separator (signal 'error (list "\
318 ;`path-separator' should be set to a single-character string"
320 ; (split-string-by-char path (aref separator 0)))
322 (defmacro with-output-to-string (&rest forms)
323 "Collect output to `standard-output' while evaluating FORMS and return
325 ;; by "William G. Dubuque" <wgd@zurich.ai.mit.edu> w/ mods from Stig
326 `(with-current-buffer (get-buffer-create " *string-output*")
327 (setq buffer-read-only nil)
328 (buffer-disable-undo (current-buffer))
330 (let ((standard-output (current-buffer)))
336 (defmacro with-current-buffer (buffer &rest body)
337 "Temporarily make BUFFER the current buffer and execute the forms in BODY.
338 The value returned is the value of the last form in BODY.
339 See also `with-temp-buffer'."
340 `(save-current-buffer
344 (defmacro with-temp-file (file &rest forms)
345 "Create a new buffer, evaluate FORMS there, and write the buffer to FILE.
346 The value of the last form in FORMS is returned, like `progn'.
347 See also `with-temp-buffer'."
348 (let ((temp-file (make-symbol "temp-file"))
349 (temp-buffer (make-symbol "temp-buffer")))
350 `(let ((,temp-file ,file)
352 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
355 (with-current-buffer ,temp-buffer
357 (with-current-buffer ,temp-buffer
359 (write-region (point-min) (point-max) ,temp-file nil 0)))
360 (and (buffer-name ,temp-buffer)
361 (kill-buffer ,temp-buffer))))))
363 (defmacro with-temp-buffer (&rest forms)
364 "Create a temporary buffer, and evaluate FORMS there like `progn'.
365 See also `with-temp-file' and `with-output-to-string'."
366 (let ((temp-buffer (make-symbol "temp-buffer")))
368 (get-buffer-create (generate-new-buffer-name " *temp*"))))
370 (with-current-buffer ,temp-buffer
372 (and (buffer-name ,temp-buffer)
373 (kill-buffer ,temp-buffer))))))
375 ;; Moved from mule-coding.el.
376 (defmacro with-string-as-buffer-contents (str &rest body)
377 "With the contents of the current buffer being STR, run BODY.
378 Returns the new contents of the buffer, as modified by BODY.
379 The original current buffer is restored afterwards."
380 `(let ((tempbuf (get-buffer-create " *string-as-buffer-contents*")))
381 (with-current-buffer tempbuf
384 (buffer-disable-undo (current-buffer))
389 (erase-buffer tempbuf)))))
391 (defun insert-face (string face)
392 "Insert STRING and highlight with FACE. Return the extent created."
393 (let ((p (point)) ext)
395 (setq ext (make-extent p (point)))
396 (set-extent-face ext face)
400 (define-function 'string= 'string-equal)
401 (define-function 'string< 'string-lessp)
402 (define-function 'int-to-string 'number-to-string)
403 (define-function 'string-to-int 'string-to-number)
405 ;; These two names are a bit awkward, as they conflict with the normal
406 ;; foo-to-bar naming scheme, but CLtL2 has them, so they stay.
407 (define-function 'char-int 'char-to-int)
408 (define-function 'int-char 'int-to-char)
411 ;; alist/plist functions
412 (defun plist-to-alist (plist)
413 "Convert property list PLIST into the equivalent association-list form.
414 The alist is returned. This converts from
420 \((a . 1) (b . 2) (c . 3))
422 The original plist is not modified. See also `destructive-plist-to-alist'."
425 (setq alist (cons (cons (car plist) (cadr plist)) alist))
426 (setq plist (cddr plist)))
429 (defun destructive-plist-to-alist (plist)
430 "Convert property list PLIST into the equivalent association-list form.
431 The alist is returned. This converts from
437 \((a . 1) (b . 2) (c . 3))
439 The original plist is destroyed in the process of constructing the alist.
440 See also `plist-to-alist'."
444 ;; remember the next plist pair.
445 (setq next (cddr plist))
446 ;; make the cons holding the property value into the alist element.
447 (setcdr (cdr plist) (cadr plist))
448 (setcar (cdr plist) (car plist))
449 ;; reattach into alist form.
450 (setcar plist (cdr plist))
455 (defun alist-to-plist (alist)
456 "Convert association list ALIST into the equivalent property-list form.
457 The plist is returned. This converts from
459 \((a . 1) (b . 2) (c . 3))
465 The original alist is not modified. See also `destructive-alist-to-plist'."
468 (let ((el (car alist)))
469 (setq plist (cons (cdr el) (cons (car el) plist))))
470 (setq alist (cdr alist)))
473 ;; getf, remf in cl*.el.
475 (defmacro putf (plist prop val)
476 "Add property PROP to plist PLIST with value VAL.
477 Analogous to (setq PLIST (plist-put PLIST PROP VAL))."
478 `(setq ,plist (plist-put ,plist ,prop ,val)))
480 (defmacro laxputf (lax-plist prop val)
481 "Add property PROP to lax plist LAX-PLIST with value VAL.
482 Analogous to (setq LAX-PLIST (lax-plist-put LAX-PLIST PROP VAL))."
483 `(setq ,lax-plist (lax-plist-put ,lax-plist ,prop ,val)))
485 (defmacro laxremf (lax-plist prop)
486 "Remove property PROP from lax plist LAX-PLIST.
487 Analogous to (setq LAX-PLIST (lax-plist-remprop LAX-PLIST PROP))."
488 `(setq ,lax-plist (lax-plist-remprop ,lax-plist ,prop)))
492 (defun error (&rest args)
493 "Signal an error, making error message by passing all args to `format'.
494 This error is not continuable: you cannot continue execution after the
495 error using the debugger `r' command. See also `cerror'."
497 (apply 'cerror args)))
499 (defun cerror (&rest args)
500 "Like `error' but signals a continuable error."
501 (signal 'error (list (apply 'format args))))
503 (defmacro check-argument-type (predicate argument)
504 "Check that ARGUMENT satisfies PREDICATE.
505 If not, signal a continuable `wrong-type-argument' error until the
506 returned value satisfies PREDICATE, and assign the returned value
508 `(if (not (,(eval predicate) ,argument))
510 (wrong-type-argument ,predicate ,argument))))
512 (defun signal-error (error-symbol data)
513 "Signal a non-continuable error. Args are ERROR-SYMBOL, and associated DATA.
514 An error symbol is a symbol defined using `define-error'.
515 DATA should be a list. Its elements are printed as part of the error message.
516 If the signal is handled, DATA is made available to the handler.
517 See also `signal', and the functions to handle errors: `condition-case'
518 and `call-with-condition-handler'."
520 (signal error-symbol data)))
522 (defun define-error (error-sym doc-string &optional inherits-from)
523 "Define a new error, denoted by ERROR-SYM.
524 DOC-STRING is an informative message explaining the error, and will be
525 printed out when an unhandled error occurs.
526 ERROR-SYM is a sub-error of INHERITS-FROM (which defaults to `error').
528 \[`define-error' internally works by putting on ERROR-SYM an `error-message'
529 property whose value is DOC-STRING, and an `error-conditions' property
530 that is a list of ERROR-SYM followed by each of its super-errors, up
531 to and including `error'. You will sometimes see code that sets this up
532 directly rather than calling `define-error', but you should *not* do this
534 (check-argument-type 'symbolp error-sym)
535 (check-argument-type 'stringp doc-string)
536 (put error-sym 'error-message doc-string)
537 (or inherits-from (setq inherits-from 'error))
538 (let ((conds (get inherits-from 'error-conditions)))
539 (or conds (signal-error 'error (list "Not an error symbol" error-sym)))
540 (put error-sym 'error-conditions (cons error-sym conds))))
545 ;(defun buffer-substring-no-properties (beg end)
546 ; "Return the text from BEG to END, without text properties, as a string."
547 ; (let ((string (buffer-substring beg end)))
548 ; (set-text-properties 0 (length string) nil string)
551 (defun get-buffer-window-list (&optional buffer minibuf frame)
552 "Return windows currently displaying BUFFER, or nil if none.
553 BUFFER defaults to the current buffer.
554 See `walk-windows' for the meaning of MINIBUF and FRAME."
556 (setq buffer (current-buffer)))
557 ((not (bufferp buffer))
558 (setq buffer (get-buffer buffer))))
560 (walk-windows (lambda (window)
561 (if (eq (window-buffer window) buffer)
562 (push window windows)))
566 (defun ignore (&rest ignore)
567 "Do nothing and return nil.
568 This function accepts any number of arguments, but ignores them."
572 (define-function 'mapc-internal 'mapc)
573 (make-obsolete 'mapc-internal 'mapc)
575 (define-function 'eval-in-buffer 'with-current-buffer)
576 (make-obsolete 'eval-in-buffer 'with-current-buffer)
578 ;;; The real defn is in abbrev.el but some early callers
579 ;;; (eg lisp-mode-abbrev-table) want this before abbrev.el is loaded...
581 (if (not (fboundp 'define-abbrev-table))
583 (setq abbrev-table-name-list '())
584 (fset 'define-abbrev-table (function (lambda (name defs)
585 ;; These are fixed-up when abbrev.el loads.
586 (setq abbrev-table-name-list
587 (cons (cons name defs)
588 abbrev-table-name-list)))))))
590 ;;; `functionp' has been moved into C.
592 ;;(defun functionp (object)
593 ;; "Non-nil if OBJECT can be called as a function."
594 ;; (or (and (symbolp object) (fboundp object))
596 ;; (compiled-function-p object)
597 ;; (eq (car-safe object) 'lambda)))
601 (defun function-interactive (function)
602 "Return the interactive specification of FUNCTION.
603 FUNCTION can be any funcallable object.
604 The specification will be returned as the list of the symbol `interactive'
606 If FUNCTION is not interactive, nil will be returned."
607 (setq function (indirect-function function))
608 (cond ((compiled-function-p function)
609 (compiled-function-interactive function))
611 (subr-interactive function))
612 ((eq (car-safe function) 'lambda)
613 (let ((spec (if (stringp (nth 2 function))
616 (and (eq (car-safe spec) 'interactive)
619 (error "Non-funcallable object: %s" function))))
621 ;; This function used to be an alias to `buffer-substring', except
622 ;; that FSF Emacs 20.4 added a BUFFER argument in an incompatible way.
623 ;; The new FSF's semantics makes more sense, but we try to support
624 ;; both for backward compatibility.
625 (defun buffer-string (&optional buffer old-end old-buffer)
626 "Return the contents of the current buffer as a string.
627 If narrowing is in effect, this function returns only the visible part
630 If BUFFER is specified, the contents of that buffer are returned.
632 The arguments OLD-END and OLD-BUFFER are supported for backward
633 compatibility with pre-21.2 XEmacsen times when arguments to this
634 function were (buffer-string &optional START END BUFFER)."
635 (if (or (null buffer)
639 (buffer-substring nil nil buffer)
641 (buffer-substring buffer old-end old-buffer)))
643 ;; This was not present before. I think Jamie had some objections
644 ;; to this, so I'm leaving this undefined for now. --ben
646 ;;; The objection is this: there is more than one way to load the same file.
647 ;;; "foo", "foo.elc", "foo.el", and "/some/path/foo.elc" are all different
648 ;;; ways to load the exact same code. `eval-after-load' is too stupid to
649 ;;; deal with this sort of thing. If this sort of feature is desired, then
650 ;;; it should work off of a hook on `provide'. Features are unique and
651 ;;; the arguments to (load) are not. --Stig
653 ;; We provide this for FSFmacs compatibility, at least until we devise
656 ;;;; Specifying things to do after certain files are loaded.
658 (defun eval-after-load (file form)
659 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
660 This makes or adds to an entry on `after-load-alist'.
661 If FILE is already loaded, evaluate FORM right now.
662 It does nothing if FORM is already on the list for FILE.
663 FILE should be the name of a library, with no directory name."
664 ;; Make sure there is an element for FILE.
665 (or (assoc file after-load-alist)
666 (setq after-load-alist (cons (list file) after-load-alist)))
667 ;; Add FORM to the element if it isn't there.
668 (let ((elt (assoc file after-load-alist)))
669 (or (member form (cdr elt))
671 (nconc elt (list form))
672 ;; If the file has been loaded already, run FORM right away.
673 (and (assoc file load-history)
676 (make-compatible 'eval-after-load "")
678 (defun eval-next-after-load (file)
679 "Read the following input sexp, and run it whenever FILE is loaded.
680 This makes or adds to an entry on `after-load-alist'.
681 FILE should be the name of a library, with no directory name."
682 (eval-after-load file (read)))
683 (make-compatible 'eval-next-after-load "")
685 ; alternate names (not obsolete)
686 (if (not (fboundp 'mod)) (define-function 'mod '%))
687 (define-function 'move-marker 'set-marker)
688 (define-function 'beep 'ding) ; preserve lingual purity
689 (define-function 'indent-to-column 'indent-to)
690 (define-function 'backward-delete-char 'delete-backward-char)
691 (define-function 'search-forward-regexp (symbol-function 're-search-forward))
692 (define-function 'search-backward-regexp (symbol-function 're-search-backward))
693 (define-function 'remove-directory 'delete-directory)
694 (define-function 'set-match-data 'store-match-data)
695 (define-function 'send-string-to-terminal 'external-debugging-output)
697 ;;; subr.el ends here