Commit | Line | Data |
---|---|---|
c88ab9ce | 1 | ;;; subr.el --- basic lisp subroutines for Emacs |
630cc463 | 2 | |
492878e4 | 3 | ;;; Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc. |
be9b65ac DL |
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 | |
492878e4 | 9 | ;; the Free Software Foundation; either version 2, or (at your option) |
be9b65ac DL |
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 | ||
630cc463 | 21 | ;;; Code: |
be9b65ac | 22 | |
492878e4 | 23 | (defun one-window-p (&optional nomini) |
be9b65ac DL |
24 | "Returns non-nil if there is only one window. |
25 | Optional arg NOMINI non-nil means don't count the minibuffer | |
26 | even if it is active." | |
492878e4 JB |
27 | (let ((base-window (selected-window))) |
28 | (if (and nomini (eq base-window (minibuffer-window))) | |
29 | (setq base-window (next-window base-window))) | |
30 | (eq base-window | |
31 | (next-window base-window (if nomini 'arg))))) | |
be9b65ac | 32 | |
0cc89026 | 33 | (defun walk-windows (proc &optional minibuf all-frames) |
be9b65ac DL |
34 | "Cycle through all visible windows, calling PROC for each one. |
35 | PROC is called with a window as argument. | |
36 | Optional second arg MINIBUF t means count the minibuffer window | |
37 | even if not active. If MINIBUF is neither t nor nil it means | |
38 | not to count the minibuffer even if it is active. | |
f1f2d09a RS |
39 | |
40 | Optional third arg ALL-FRAMES, if t, means include all frames. | |
41 | ALL-FRAMES nil or omitted means cycle within the selected frame, | |
42 | but include the minibuffer window (if MINIBUF says so) that that | |
43 | frame uses, even if it is on another frame. | |
44 | If ALL-FRAMES is neither nil nor t, stick strictly to the selected frame." | |
be9b65ac DL |
45 | (let* ((walk-windows-start (selected-window)) |
46 | (walk-windows-current walk-windows-start)) | |
47 | (while (progn | |
48 | (setq walk-windows-current | |
0cc89026 | 49 | (next-window walk-windows-current minibuf all-frames)) |
be9b65ac DL |
50 | (funcall proc walk-windows-current) |
51 | (not (eq walk-windows-current walk-windows-start)))))) | |
52 | ||
53 | (defun read-quoted-char (&optional prompt) | |
54 | "Like `read-char', except that if the first character read is an octal | |
55 | digit, we read up to two more octal digits and return the character | |
56 | represented by the octal number consisting of those digits. | |
57 | Optional argument PROMPT specifies a string to use to prompt the user." | |
58 | (let ((count 0) (code 0) char) | |
59 | (while (< count 3) | |
60 | (let ((inhibit-quit (zerop count)) | |
61 | (help-form nil)) | |
62 | (and prompt (message "%s-" prompt)) | |
63 | (setq char (read-char)) | |
64 | (if inhibit-quit (setq quit-flag nil))) | |
65 | (cond ((null char)) | |
66 | ((and (<= ?0 char) (<= char ?7)) | |
67 | (setq code (+ (* code 8) (- char ?0)) | |
68 | count (1+ count)) | |
69 | (and prompt (message (setq prompt | |
70 | (format "%s %c" prompt char))))) | |
71 | ((> count 0) | |
dbc4e1c1 | 72 | (setq unread-command-events (list char) count 259)) |
be9b65ac DL |
73 | (t (setq code char count 259)))) |
74 | (logand 255 code))) | |
75 | ||
76 | (defun error (&rest args) | |
77 | "Signal an error, making error message by passing all args to `format'." | |
78 | (while t | |
79 | (signal 'error (list (apply 'format args))))) | |
80 | ||
81 | (defun undefined () | |
82 | (interactive) | |
83 | (ding)) | |
84 | ||
8b824916 RS |
85 | ;; Some programs still use this as a function. |
86 | (defun baud-rate () | |
87 | "Obsolete function returning the value of the `baud-rate' variable." | |
88 | baud-rate) | |
89 | ||
be9b65ac DL |
90 | ;Prevent the \{...} documentation construct |
91 | ;from mentioning keys that run this command. | |
92 | (put 'undefined 'suppress-keymap t) | |
93 | ||
94 | (defun suppress-keymap (map &optional nodigits) | |
95 | "Make MAP override all normally self-inserting keys to be undefined. | |
96 | Normally, as an exception, digits and minus-sign are set to make prefix args, | |
97 | but optional second arg NODIGITS non-nil treats them like other chars." | |
98 | (let ((i 0)) | |
99 | (while (<= i 127) | |
100 | (if (eql (lookup-key global-map (char-to-string i)) 'self-insert-command) | |
101 | (define-key map (char-to-string i) 'undefined)) | |
102 | (setq i (1+ i)))) | |
103 | (or nodigits | |
104 | (let (loop) | |
105 | (define-key map "-" 'negative-argument) | |
106 | ;; Make plain numbers do numeric args. | |
107 | (setq loop ?0) | |
108 | (while (<= loop ?9) | |
109 | (define-key map (char-to-string loop) 'digit-argument) | |
110 | (setq loop (1+ loop)))))) | |
111 | ||
112 | ;; now in fns.c | |
113 | ;(defun nth (n list) | |
114 | ; "Returns the Nth element of LIST. | |
115 | ;N counts from zero. If LIST is not that long, nil is returned." | |
116 | ; (car (nthcdr n list))) | |
117 | ; | |
118 | ;(defun copy-alist (alist) | |
119 | ; "Return a copy of ALIST. | |
120 | ;This is a new alist which represents the same mapping | |
121 | ;from objects to objects, but does not share the alist structure with ALIST. | |
122 | ;The objects mapped (cars and cdrs of elements of the alist) | |
123 | ;are shared, however." | |
124 | ; (setq alist (copy-sequence alist)) | |
125 | ; (let ((tail alist)) | |
126 | ; (while tail | |
127 | ; (if (consp (car tail)) | |
128 | ; (setcar tail (cons (car (car tail)) (cdr (car tail))))) | |
129 | ; (setq tail (cdr tail)))) | |
130 | ; alist) | |
131 | ||
132 | ;Moved to keymap.c | |
133 | ;(defun copy-keymap (keymap) | |
134 | ; "Return a copy of KEYMAP" | |
135 | ; (while (not (keymapp keymap)) | |
136 | ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap)))) | |
137 | ; (if (vectorp keymap) | |
138 | ; (copy-sequence keymap) | |
139 | ; (copy-alist keymap))) | |
140 | ||
7f2c2edd | 141 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) |
be9b65ac DL |
142 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. |
143 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. | |
7f2c2edd RS |
144 | If optional fourth argument OLDMAP is specified, we redefine |
145 | in KEYMAP as NEWDEF those chars which are defined as OLDDEF in OLDMAP." | |
146 | (or prefix (setq prefix "")) | |
147 | (let* ((scan (or oldmap keymap)) | |
148 | (vec1 (vector nil)) | |
149 | (prefix1 (vconcat prefix vec1))) | |
150 | ;; Scan OLDMAP, finding each char or event-symbol that | |
151 | ;; has any definition, and act on it with hack-key. | |
152 | (while (consp scan) | |
153 | (if (consp (car scan)) | |
154 | (let ((char (car (car scan))) | |
155 | (defn (cdr (car scan)))) | |
156 | ;; The inside of this let duplicates exactly | |
157 | ;; the inside of the following let that handles array elements. | |
158 | (aset vec1 0 char) | |
159 | (aset prefix1 (length prefix) char) | |
160 | (let (inner-def) | |
161 | ;; Skip past menu-prompt. | |
162 | (while (stringp (car-safe defn)) | |
163 | (setq defn (cdr defn))) | |
164 | (setq inner-def defn) | |
165 | (while (and (symbolp inner-def) | |
166 | (fboundp inner-def)) | |
167 | (setq inner-def (symbol-function inner-def))) | |
168 | (if (eq defn olddef) | |
169 | (define-key keymap prefix1 newdef) | |
170 | (if (keymapp defn) | |
171 | (substitute-key-definition olddef newdef keymap | |
172 | inner-def | |
173 | prefix1))))) | |
174 | (if (arrayp (car scan)) | |
175 | (let* ((array (car scan)) | |
176 | (len (length array)) | |
177 | (i 0)) | |
178 | (while (< i len) | |
179 | (let ((char i) (defn (aref array i))) | |
180 | ;; The inside of this let duplicates exactly | |
181 | ;; the inside of the previous let. | |
182 | (aset vec1 0 char) | |
183 | (aset prefix1 (length prefix) char) | |
184 | (let (inner-def) | |
185 | ;; Skip past menu-prompt. | |
186 | (while (stringp (car-safe defn)) | |
187 | (setq defn (cdr defn))) | |
188 | (setq inner-def defn) | |
189 | (while (and (symbolp inner-def) | |
190 | (fboundp inner-def)) | |
191 | (setq inner-def (symbol-function inner-def))) | |
192 | (if (eq defn olddef) | |
193 | (define-key keymap prefix1 newdef) | |
194 | (if (keymapp defn) | |
195 | (substitute-key-definition olddef newdef keymap | |
196 | inner-def | |
197 | prefix1))))) | |
198 | (setq i (1+ i)))))) | |
199 | (setq scan (cdr scan))))) | |
be9b65ac | 200 | |
cde6d7e3 RS |
201 | (defun listify-key-sequence (key) |
202 | "Convert a key sequence to a list of events." | |
203 | (if (vectorp key) | |
204 | (append key nil) | |
205 | (mapcar (function (lambda (c) | |
206 | (if (> c 127) | |
207 | (logxor c 8388736) | |
208 | c))) | |
209 | (append key nil)))) | |
210 | ||
715984d3 RS |
211 | (defmacro save-match-data (&rest body) |
212 | "Execute the BODY forms, restoring the global value of the match data." | |
213 | (let ((original (make-symbol "match-data"))) | |
214 | (list | |
215 | 'let (list (list original '(match-data))) | |
216 | (list 'unwind-protect | |
217 | (cons 'progn body) | |
218 | (list 'store-match-data original))))) | |
219 | ||
a42a4305 RM |
220 | (defun ignore (&rest ignore) |
221 | "Do nothing. | |
dbc3787c | 222 | Accept any number of arguments, but ignore them." |
a42a4305 | 223 | nil) |
be9b65ac DL |
224 | \f |
225 | ; old names | |
226 | (fset 'make-syntax-table 'copy-syntax-table) | |
227 | (fset 'dot 'point) | |
228 | (fset 'dot-marker 'point-marker) | |
229 | (fset 'dot-min 'point-min) | |
230 | (fset 'dot-max 'point-max) | |
231 | (fset 'window-dot 'window-point) | |
232 | (fset 'set-window-dot 'set-window-point) | |
233 | (fset 'read-input 'read-string) | |
234 | (fset 'send-string 'process-send-string) | |
235 | (fset 'send-region 'process-send-region) | |
236 | (fset 'show-buffer 'set-window-buffer) | |
237 | (fset 'buffer-flush-undo 'buffer-disable-undo) | |
94b304d7 | 238 | (fset 'eval-current-buffer 'eval-buffer) |
dbc4e1c1 | 239 | (fset 'compiled-function-p 'byte-code-function-p) |
be9b65ac | 240 | |
d2ec8956 JB |
241 | ;;; This name isn't mentioned in the manual, and we've been hoping to |
242 | ;;; phase it out, but there's still a lot of code out there, even for | |
243 | ;;; Emacs 18.59, which uses mod. I'm going to let the byte compiler's | |
244 | ;;; make-obsolete function to poke people a little more, and leave the | |
245 | ;;; `mod' name around for a while longer. | |
246 | (fset 'mod '%) | |
247 | ||
be9b65ac DL |
248 | ; alternate names |
249 | (fset 'string= 'string-equal) | |
250 | (fset 'string< 'string-lessp) | |
251 | (fset 'move-marker 'set-marker) | |
252 | (fset 'eql 'eq) | |
253 | (fset 'not 'null) | |
be9b65ac DL |
254 | (fset 'rplaca 'setcar) |
255 | (fset 'rplacd 'setcdr) | |
256 | (fset 'beep 'ding) ;preserve lingual purtity | |
257 | (fset 'indent-to-column 'indent-to) | |
258 | (fset 'backward-delete-char 'delete-backward-char) | |
6f236da8 JB |
259 | (fset 'search-forward-regexp (symbol-function 're-search-forward)) |
260 | (fset 'search-backward-regexp (symbol-function 're-search-backward)) | |
37f6661a JB |
261 | |
262 | ;;; Should this be an obsolete name? If you decide it should, you get | |
263 | ;;; to go through all the sources and change them. | |
264 | (fset 'string-to-int 'string-to-number) | |
be9b65ac | 265 | \f |
d95b111b JB |
266 | ;;; global-map, esc-map, and ctl-x-map have their values set up |
267 | ;;; in keymap.c. | |
be9b65ac DL |
268 | (defvar global-map nil |
269 | "Default global keymap mapping Emacs keyboard input into commands. | |
270 | The value is a keymap which is usually (but not necessarily) Emacs's | |
271 | global map.") | |
272 | ||
d95b111b JB |
273 | (defvar esc-map nil |
274 | "Default keymap for ESC (meta) commands. | |
275 | The normal global definition of the character ESC indirects to this keymap.") | |
276 | ||
be9b65ac DL |
277 | (defvar ctl-x-map nil |
278 | "Default keymap for C-x commands. | |
279 | The normal global definition of the character C-x indirects to this keymap.") | |
280 | ||
d95b111b JB |
281 | (defvar ctl-x-4-map (make-sparse-keymap) |
282 | "Keymap for subcommands of C-x 4") | |
283 | (fset 'ctl-x-4-prefix ctl-x-4-map) | |
284 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) | |
285 | ||
492878e4 | 286 | (defvar ctl-x-5-map (make-sparse-keymap) |
0cc89026 | 287 | "Keymap for frame commands.") |
492878e4 JB |
288 | (fset 'ctl-x-5-prefix ctl-x-5-map) |
289 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) | |
be9b65ac | 290 | |
be9b65ac DL |
291 | \f |
292 | (defun run-hooks (&rest hooklist) | |
293 | "Takes hook names and runs each one in turn. Major mode functions use this. | |
294 | Each argument should be a symbol, a hook variable. | |
295 | These symbols are processed in the order specified. | |
296 | If a hook symbol has a non-nil value, that value may be a function | |
297 | or a list of functions to be called to run the hook. | |
298 | If the value is a function, it is called with no arguments. | |
299 | If it is a list, the elements are called, in order, with no arguments." | |
300 | (while hooklist | |
301 | (let ((sym (car hooklist))) | |
302 | (and (boundp sym) | |
303 | (symbol-value sym) | |
304 | (let ((value (symbol-value sym))) | |
305 | (if (and (listp value) (not (eq (car value) 'lambda))) | |
306 | (mapcar 'funcall value) | |
307 | (funcall value))))) | |
308 | (setq hooklist (cdr hooklist)))) | |
309 | ||
310 | ;; Tell C code how to call this function. | |
311 | (defconst run-hooks 'run-hooks | |
312 | "Variable by which C primitives find the function `run-hooks'. | |
313 | Don't change it.") | |
314 | ||
315 | (defun add-hook (hook function) | |
316 | "Add to the value of HOOK the function FUNCTION unless already present. | |
317 | HOOK should be a symbol, and FUNCTION may be any valid function. | |
318 | HOOK's value should be a list of functions, not a single function. | |
319 | If HOOK is void, it is first set to nil." | |
320 | (or (boundp hook) (set hook nil)) | |
321 | (or (if (consp function) | |
322 | ;; Clever way to tell whether a given lambda-expression | |
323 | ;; is equal to anything in the hook. | |
324 | (let ((tail (assoc (cdr function) (symbol-value hook)))) | |
325 | (equal function tail)) | |
326 | (memq function (symbol-value hook))) | |
f35fe3c6 | 327 | (set hook (cons function (symbol-value hook))))) |
be9b65ac DL |
328 | \f |
329 | (defun momentary-string-display (string pos &optional exit-char message) | |
330 | "Momentarily display STRING in the buffer at POS. | |
331 | Display remains until next character is typed. | |
332 | If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed; | |
333 | otherwise it is then available as input (as a command if nothing else). | |
334 | Display MESSAGE (optional fourth arg) in the echo area. | |
335 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." | |
336 | (or exit-char (setq exit-char ?\ )) | |
337 | (let ((buffer-read-only nil) | |
338 | (modified (buffer-modified-p)) | |
339 | (name buffer-file-name) | |
340 | insert-end) | |
341 | (unwind-protect | |
342 | (progn | |
343 | (save-excursion | |
344 | (goto-char pos) | |
345 | ;; defeat file locking... don't try this at home, kids! | |
346 | (setq buffer-file-name nil) | |
347 | (insert-before-markers string) | |
348 | (setq insert-end (point))) | |
349 | (message (or message "Type %s to continue editing.") | |
350 | (single-key-description exit-char)) | |
351 | (let ((char (read-char))) | |
352 | (or (eq char exit-char) | |
dbc4e1c1 | 353 | (setq unread-command-events (list char))))) |
be9b65ac DL |
354 | (if insert-end |
355 | (save-excursion | |
356 | (delete-region pos insert-end))) | |
357 | (setq buffer-file-name name) | |
358 | (set-buffer-modified-p modified)))) | |
359 | ||
360 | (defun start-process-shell-command (name buffer &rest args) | |
361 | "Start a program in a subprocess. Return the process object for it. | |
362 | Args are NAME BUFFER COMMAND &rest COMMAND-ARGS. | |
363 | NAME is name for process. It is modified if necessary to make it unique. | |
364 | BUFFER is the buffer or (buffer-name) to associate with the process. | |
365 | Process output goes at end of that buffer, unless you specify | |
366 | an output stream or filter function to handle the output. | |
367 | BUFFER may be also nil, meaning that this process is not associated | |
368 | with any buffer | |
369 | Third arg is command name, the name of a shell command. | |
370 | Remaining arguments are the arguments for the command. | |
371 | Wildcards and redirection are handle as usual in the shell." | |
372 | (if (eq system-type 'vax-vms) | |
373 | (apply 'start-process name buffer args) | |
374 | (start-process name buffer shell-file-name "-c" | |
375 | (concat "exec " (mapconcat 'identity args " "))))) | |
376 | \f | |
377 | (defun eval-after-load (file form) | |
378 | "Arrange that, if FILE is ever loaded, FORM will be run at that time. | |
379 | This makes or adds to an entry on `after-load-alist'. | |
380 | FILE should be the name of a library, with no directory name." | |
381 | (or (assoc file after-load-alist) | |
382 | (setq after-load-alist (cons (list file) after-load-alist))) | |
383 | (nconc (assoc file after-load-alist) (list form)) | |
384 | form) | |
385 | ||
386 | (defun eval-next-after-load (file) | |
387 | "Read the following input sexp, and run it whenever FILE is loaded. | |
388 | This makes or adds to an entry on `after-load-alist'. | |
389 | FILE should be the name of a library, with no directory name." | |
390 | (eval-after-load file (read))) | |
408a4c8f | 391 | |
e6dfdce5 RS |
392 | ;;(defmacro defun-inline (name args &rest body) |
393 | ;; "Create an \"inline defun\" (actually a macro). | |
394 | ;;Use just like `defun'." | |
395 | ;; (nconc (list 'defmacro name '(&rest args)) | |
396 | ;; (if (stringp (car body)) | |
397 | ;; (prog1 (list (car body)) | |
398 | ;; (setq body (or (cdr body) body)))) | |
399 | ;; (list (list 'cons (list 'quote | |
400 | ;; (cons 'lambda (cons args body))) | |
401 | ;; 'args)))) | |
be9b65ac DL |
402 | \f |
403 | (defun user-original-login-name () | |
404 | "Return user's login name from original login. | |
405 | This tries to remain unaffected by `su', by looking in environment variables." | |
406 | (or (getenv "LOGNAME") (getenv "USER") (user-login-name))) | |
407 | \f | |
408 | (defun force-mode-line-update (&optional all) | |
409 | "Force the mode-line of the current buffer to be redisplayed. | |
410 | With optional non-nil ALL then force then force redisplay of all mode-lines." | |
411 | (if all (save-excursion (set-buffer (other-buffer)))) | |
412 | (set-buffer-modified-p (buffer-modified-p))) | |
413 | ||
414 | (defun keyboard-translate (from to) | |
415 | "Translate character FROM to TO at a low level. | |
416 | This function creates a `keyboard-translate-table' if necessary | |
417 | and then modifies one entry in it." | |
b7cceaf1 JB |
418 | (or (arrayp keyboard-translate-table) |
419 | (setq keyboard-translate-table "")) | |
420 | (if (or (> from (length keyboard-translate-table)) | |
421 | (> to (length keyboard-translate-table))) | |
422 | (progn | |
423 | (let* ((i (length keyboard-translate-table)) | |
424 | (table (make-string (- 256 i) 0))) | |
425 | (while (< i 256) | |
426 | (aset table i i) | |
427 | (setq i (1+ i))) | |
428 | (setq keyboard-translate-table table)))) | |
be9b65ac | 429 | (aset keyboard-translate-table from to)) |
ffd56f97 JB |
430 | |
431 | \f | |
432 | (defmacro lambda (&rest cdr) | |
397587ee JB |
433 | "Return a lambda expression. |
434 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is | |
435 | self-quoting; the result of evaluating the lambda expression is the | |
436 | expression itself. The lambda expression may then be treated as a | |
437 | function, i. e. stored as the function value of a symbol, passed to | |
438 | funcall or mapcar, etcetera. | |
439 | ARGS should take the same form as an argument list for a `defun'. | |
440 | DOCSTRING should be a string, as described for `defun'. It may be omitted. | |
441 | INTERACTIVE should be a call to the function `interactive', which see. | |
442 | It may also be omitted. | |
443 | BODY should be a list of lisp expressions." | |
d77c36e8 JB |
444 | ;; Note that this definition should not use backquotes; subr.el should not |
445 | ;; depend on backquote.el. | |
446 | (list 'function (cons 'lambda cdr))) | |
630cc463 ER |
447 | |
448 | ;;; subr.el ends here |