Mercurial > emacs
annotate lisp/subr.el @ 684:bd574e49bfac
*** empty log message ***
author | Roland McGrath <roland@gnu.org> |
---|---|
date | Thu, 04 Jun 1992 04:33:43 +0000 |
parents | 85fd29f25c75 |
children | e4253da532fb |
rev | line source |
---|---|
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
648
diff
changeset
|
1 ;;; subr.el --- basic lisp subroutines for Emacs |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
648
diff
changeset
|
2 |
114 | 3 ;; Copyright (C) 1985, 1986 Free Software Foundation, Inc. |
4 | |
5 ;; This file is part of GNU Emacs. | |
6 | |
7 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
8 ;; it under the terms of the GNU General Public License as published by | |
9 ;; the Free Software Foundation; either version 1, or (at your option) | |
10 ;; any later version. | |
11 | |
12 ;; GNU Emacs is distributed in the hope that it will be useful, | |
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 ;; GNU General Public License for more details. | |
16 | |
17 ;; You should have received a copy of the GNU General Public License | |
18 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
19 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
20 | |
21 | |
22 (defun one-window-p (&optional arg) | |
23 "Returns non-nil if there is only one window. | |
24 Optional arg NOMINI non-nil means don't count the minibuffer | |
25 even if it is active." | |
26 (eq (selected-window) | |
27 (next-window (selected-window) (if arg 'arg)))) | |
28 | |
29 (defun walk-windows (proc &optional minibuf all-screens) | |
30 "Cycle through all visible windows, calling PROC for each one. | |
31 PROC is called with a window as argument. | |
32 Optional second arg MINIBUF t means count the minibuffer window | |
33 even if not active. If MINIBUF is neither t nor nil it means | |
34 not to count the minibuffer even if it is active. | |
35 Optional third arg ALL-SCREENS t means include all windows in all screens; | |
36 otherwise cycle within the selected screen." | |
37 (let* ((walk-windows-start (selected-window)) | |
38 (walk-windows-current walk-windows-start)) | |
39 (while (progn | |
40 (setq walk-windows-current | |
41 (next-window walk-windows-current minibuf all-screens)) | |
42 (funcall proc walk-windows-current) | |
43 (not (eq walk-windows-current walk-windows-start)))))) | |
44 | |
45 (defun read-quoted-char (&optional prompt) | |
46 "Like `read-char', except that if the first character read is an octal | |
47 digit, we read up to two more octal digits and return the character | |
48 represented by the octal number consisting of those digits. | |
49 Optional argument PROMPT specifies a string to use to prompt the user." | |
50 (let ((count 0) (code 0) char) | |
51 (while (< count 3) | |
52 (let ((inhibit-quit (zerop count)) | |
53 (help-form nil)) | |
54 (and prompt (message "%s-" prompt)) | |
55 (setq char (read-char)) | |
56 (if inhibit-quit (setq quit-flag nil))) | |
57 (cond ((null char)) | |
58 ((and (<= ?0 char) (<= char ?7)) | |
59 (setq code (+ (* code 8) (- char ?0)) | |
60 count (1+ count)) | |
61 (and prompt (message (setq prompt | |
62 (format "%s %c" prompt char))))) | |
63 ((> count 0) | |
64 (setq unread-command-char char count 259)) | |
65 (t (setq code char count 259)))) | |
66 (logand 255 code))) | |
67 | |
68 (defun error (&rest args) | |
69 "Signal an error, making error message by passing all args to `format'." | |
70 (while t | |
71 (signal 'error (list (apply 'format args))))) | |
72 | |
73 (defun undefined () | |
74 (interactive) | |
75 (ding)) | |
76 | |
77 ;Prevent the \{...} documentation construct | |
78 ;from mentioning keys that run this command. | |
79 (put 'undefined 'suppress-keymap t) | |
80 | |
81 (defun suppress-keymap (map &optional nodigits) | |
82 "Make MAP override all normally self-inserting keys to be undefined. | |
83 Normally, as an exception, digits and minus-sign are set to make prefix args, | |
84 but optional second arg NODIGITS non-nil treats them like other chars." | |
85 (let ((i 0)) | |
86 (while (<= i 127) | |
87 (if (eql (lookup-key global-map (char-to-string i)) 'self-insert-command) | |
88 (define-key map (char-to-string i) 'undefined)) | |
89 (setq i (1+ i)))) | |
90 (or nodigits | |
91 (let (loop) | |
92 (define-key map "-" 'negative-argument) | |
93 ;; Make plain numbers do numeric args. | |
94 (setq loop ?0) | |
95 (while (<= loop ?9) | |
96 (define-key map (char-to-string loop) 'digit-argument) | |
97 (setq loop (1+ loop)))))) | |
98 | |
99 ;; now in fns.c | |
100 ;(defun nth (n list) | |
101 ; "Returns the Nth element of LIST. | |
102 ;N counts from zero. If LIST is not that long, nil is returned." | |
103 ; (car (nthcdr n list))) | |
104 ; | |
105 ;(defun copy-alist (alist) | |
106 ; "Return a copy of ALIST. | |
107 ;This is a new alist which represents the same mapping | |
108 ;from objects to objects, but does not share the alist structure with ALIST. | |
109 ;The objects mapped (cars and cdrs of elements of the alist) | |
110 ;are shared, however." | |
111 ; (setq alist (copy-sequence alist)) | |
112 ; (let ((tail alist)) | |
113 ; (while tail | |
114 ; (if (consp (car tail)) | |
115 ; (setcar tail (cons (car (car tail)) (cdr (car tail))))) | |
116 ; (setq tail (cdr tail)))) | |
117 ; alist) | |
118 | |
119 ;Moved to keymap.c | |
120 ;(defun copy-keymap (keymap) | |
121 ; "Return a copy of KEYMAP" | |
122 ; (while (not (keymapp keymap)) | |
123 ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap)))) | |
124 ; (if (vectorp keymap) | |
125 ; (copy-sequence keymap) | |
126 ; (copy-alist keymap))) | |
127 | |
128 (defun substitute-key-definition (olddef newdef keymap) | |
129 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. | |
130 In other words, OLDDEF is replaced with NEWDEF where ever it appears. | |
131 Prefix keymaps reached from KEYMAP are not checked recursively; | |
132 perhaps they ought to be." | |
133 (if (arrayp keymap) | |
134 (let ((len (length keymap)) | |
135 (i 0)) | |
136 (while (< i len) | |
137 (if (eq (aref keymap i) olddef) | |
138 (aset keymap i newdef)) | |
139 (setq i (1+ i)))) | |
140 (while keymap | |
141 (if (eq (cdr-safe (car-safe keymap)) olddef) | |
142 (setcdr (car keymap) newdef)) | |
143 (setq keymap (cdr keymap))))) | |
144 | |
145 ;; Avoids useless byte-compilation. | |
146 ;; In the future, would be better to fix byte compiler | |
147 ;; not to really compile in cases like this, | |
148 ;; and use defun here. | |
293 | 149 (fset 'ignore '(lambda (&rest ignore) |
150 "Do nothing. | |
151 Accept any number of arguments, but ignore them." | |
152 nil)) | |
114 | 153 |
154 | |
155 ; old names | |
156 (fset 'make-syntax-table 'copy-syntax-table) | |
157 (fset 'dot 'point) | |
158 (fset 'dot-marker 'point-marker) | |
159 (fset 'dot-min 'point-min) | |
160 (fset 'dot-max 'point-max) | |
161 (fset 'window-dot 'window-point) | |
162 (fset 'set-window-dot 'set-window-point) | |
163 (fset 'read-input 'read-string) | |
164 (fset 'send-string 'process-send-string) | |
165 (fset 'send-region 'process-send-region) | |
166 (fset 'show-buffer 'set-window-buffer) | |
167 (fset 'buffer-flush-undo 'buffer-disable-undo) | |
675
85fd29f25c75
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
668
diff
changeset
|
168 (fset 'eval-current-buffer 'eval-buffer) |
114 | 169 |
170 ; alternate names | |
171 (fset 'string= 'string-equal) | |
172 (fset 'string< 'string-lessp) | |
173 (fset 'move-marker 'set-marker) | |
174 (fset 'eql 'eq) | |
175 (fset 'not 'null) | |
176 (fset 'numberp 'integerp) | |
177 (fset 'rplaca 'setcar) | |
178 (fset 'rplacd 'setcdr) | |
179 (fset 'beep 'ding) ;preserve lingual purtity | |
180 (fset 'indent-to-column 'indent-to) | |
181 (fset 'backward-delete-char 'delete-backward-char) | |
353 | 182 (fset 'search-forward-regexp (symbol-function 're-search-forward)) |
183 (fset 'search-backward-regexp (symbol-function 're-search-backward)) | |
114 | 184 |
388 | 185 ;;; global-map, esc-map, and ctl-x-map have their values set up |
186 ;;; in keymap.c. | |
114 | 187 (defvar global-map nil |
188 "Default global keymap mapping Emacs keyboard input into commands. | |
189 The value is a keymap which is usually (but not necessarily) Emacs's | |
190 global map.") | |
191 | |
388 | 192 (defvar esc-map nil |
193 "Default keymap for ESC (meta) commands. | |
194 The normal global definition of the character ESC indirects to this keymap.") | |
195 | |
114 | 196 (defvar ctl-x-map nil |
197 "Default keymap for C-x commands. | |
198 The normal global definition of the character C-x indirects to this keymap.") | |
199 | |
388 | 200 (defvar ctl-x-4-map (make-sparse-keymap) |
201 "Keymap for subcommands of C-x 4") | |
202 (fset 'ctl-x-4-prefix ctl-x-4-map) | |
203 (define-key ctl-x-map "4" 'ctl-x-4-prefix) | |
114 | 204 |
388 | 205 (defvar ctl-x-3-map (make-sparse-keymap) |
206 "Keymap for screen commands.") | |
207 (fset 'ctl-x-3-prefix ctl-x-3-map) | |
208 (define-key ctl-x-map "3" 'ctl-x-3-prefix) | |
209 | |
114 | 210 |
211 (defun run-hooks (&rest hooklist) | |
212 "Takes hook names and runs each one in turn. Major mode functions use this. | |
213 Each argument should be a symbol, a hook variable. | |
214 These symbols are processed in the order specified. | |
215 If a hook symbol has a non-nil value, that value may be a function | |
216 or a list of functions to be called to run the hook. | |
217 If the value is a function, it is called with no arguments. | |
218 If it is a list, the elements are called, in order, with no arguments." | |
219 (while hooklist | |
220 (let ((sym (car hooklist))) | |
221 (and (boundp sym) | |
222 (symbol-value sym) | |
223 (let ((value (symbol-value sym))) | |
224 (if (and (listp value) (not (eq (car value) 'lambda))) | |
225 (mapcar 'funcall value) | |
226 (funcall value))))) | |
227 (setq hooklist (cdr hooklist)))) | |
228 | |
229 ;; Tell C code how to call this function. | |
230 (defconst run-hooks 'run-hooks | |
231 "Variable by which C primitives find the function `run-hooks'. | |
232 Don't change it.") | |
233 | |
234 (defun add-hook (hook function) | |
235 "Add to the value of HOOK the function FUNCTION unless already present. | |
236 HOOK should be a symbol, and FUNCTION may be any valid function. | |
237 HOOK's value should be a list of functions, not a single function. | |
238 If HOOK is void, it is first set to nil." | |
239 (or (boundp hook) (set hook nil)) | |
240 (or (if (consp function) | |
241 ;; Clever way to tell whether a given lambda-expression | |
242 ;; is equal to anything in the hook. | |
243 (let ((tail (assoc (cdr function) (symbol-value hook)))) | |
244 (equal function tail)) | |
245 (memq function (symbol-value hook))) | |
384 | 246 (set hook (cons function (symbol-value hook))))) |
114 | 247 |
248 (defun momentary-string-display (string pos &optional exit-char message) | |
249 "Momentarily display STRING in the buffer at POS. | |
250 Display remains until next character is typed. | |
251 If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed; | |
252 otherwise it is then available as input (as a command if nothing else). | |
253 Display MESSAGE (optional fourth arg) in the echo area. | |
254 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." | |
255 (or exit-char (setq exit-char ?\ )) | |
256 (let ((buffer-read-only nil) | |
257 (modified (buffer-modified-p)) | |
258 (name buffer-file-name) | |
259 insert-end) | |
260 (unwind-protect | |
261 (progn | |
262 (save-excursion | |
263 (goto-char pos) | |
264 ;; defeat file locking... don't try this at home, kids! | |
265 (setq buffer-file-name nil) | |
266 (insert-before-markers string) | |
267 (setq insert-end (point))) | |
268 (message (or message "Type %s to continue editing.") | |
269 (single-key-description exit-char)) | |
270 (let ((char (read-char))) | |
271 (or (eq char exit-char) | |
272 (setq unread-command-char char)))) | |
273 (if insert-end | |
274 (save-excursion | |
275 (delete-region pos insert-end))) | |
276 (setq buffer-file-name name) | |
277 (set-buffer-modified-p modified)))) | |
278 | |
279 (defun start-process-shell-command (name buffer &rest args) | |
280 "Start a program in a subprocess. Return the process object for it. | |
281 Args are NAME BUFFER COMMAND &rest COMMAND-ARGS. | |
282 NAME is name for process. It is modified if necessary to make it unique. | |
283 BUFFER is the buffer or (buffer-name) to associate with the process. | |
284 Process output goes at end of that buffer, unless you specify | |
285 an output stream or filter function to handle the output. | |
286 BUFFER may be also nil, meaning that this process is not associated | |
287 with any buffer | |
288 Third arg is command name, the name of a shell command. | |
289 Remaining arguments are the arguments for the command. | |
290 Wildcards and redirection are handle as usual in the shell." | |
291 (if (eq system-type 'vax-vms) | |
292 (apply 'start-process name buffer args) | |
293 (start-process name buffer shell-file-name "-c" | |
294 (concat "exec " (mapconcat 'identity args " "))))) | |
295 | |
296 (defun eval-after-load (file form) | |
297 "Arrange that, if FILE is ever loaded, FORM will be run at that time. | |
298 This makes or adds to an entry on `after-load-alist'. | |
299 FILE should be the name of a library, with no directory name." | |
300 (or (assoc file after-load-alist) | |
301 (setq after-load-alist (cons (list file) after-load-alist))) | |
302 (nconc (assoc file after-load-alist) (list form)) | |
303 form) | |
304 | |
305 (defun eval-next-after-load (file) | |
306 "Read the following input sexp, and run it whenever FILE is loaded. | |
307 This makes or adds to an entry on `after-load-alist'. | |
308 FILE should be the name of a library, with no directory name." | |
309 (eval-after-load file (read))) | |
144
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
310 |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
311 (defmacro defun-inline (name args &rest body) |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
312 "Create an \"inline defun\" (actually a macro). |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
313 Use just like `defun'." |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
314 (nconc (list 'defmacro name '(&rest args)) |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
315 (if (stringp (car body)) |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
316 (prog1 (list (car body)) |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
317 (setq body (or (cdr body) body)))) |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
318 (list (list 'cons (list 'quote |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
319 (cons 'lambda (cons args body))) |
535ec1aa78ef
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
114
diff
changeset
|
320 'args)))) |
114 | 321 |
322 (defun user-original-login-name () | |
323 "Return user's login name from original login. | |
324 This tries to remain unaffected by `su', by looking in environment variables." | |
325 (or (getenv "LOGNAME") (getenv "USER") (user-login-name))) | |
326 | |
327 (defun force-mode-line-update (&optional all) | |
328 "Force the mode-line of the current buffer to be redisplayed. | |
329 With optional non-nil ALL then force then force redisplay of all mode-lines." | |
330 (if all (save-excursion (set-buffer (other-buffer)))) | |
331 (set-buffer-modified-p (buffer-modified-p))) | |
332 | |
333 (defun keyboard-translate (from to) | |
334 "Translate character FROM to TO at a low level. | |
335 This function creates a `keyboard-translate-table' if necessary | |
336 and then modifies one entry in it." | |
337 (or (boundp 'keyboard-translate-table) | |
338 (let ((table (make-string 256)) | |
339 (i 0)) | |
340 (while (< i 256) | |
341 (aset table i i) | |
342 (setq i (1+ i))) | |
343 (setq keyboard-translate-table table))) | |
344 (aset keyboard-translate-table from to)) | |
648 | 345 |
346 | |
347 (defmacro lambda (&rest cdr) | |
668
47871343371e
*** empty log message ***
Noah Friedman <friedman@splode.com>
parents:
667
diff
changeset
|
348 "Macro which allows one to write (lambda ...) for anonymous functions |
47871343371e
*** empty log message ***
Noah Friedman <friedman@splode.com>
parents:
667
diff
changeset
|
349 instead of having to write (function (lambda ...)) or '(lambda ...), the |
47871343371e
*** empty log message ***
Noah Friedman <friedman@splode.com>
parents:
667
diff
changeset
|
350 latter of which won't get byte-compiled." |
648 | 351 (` (function (lambda (,@ cdr))))) |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
648
diff
changeset
|
352 |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
648
diff
changeset
|
353 ;;; subr.el ends here |