Initial revision
[bpt/emacs.git] / lisp / subr.el
CommitLineData
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
9a5336ae
JB
23\f
24;;;; Lisp language features.
25
26(defmacro lambda (&rest cdr)
27 "Return a lambda expression.
28A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
29self-quoting; the result of evaluating the lambda expression is the
30expression itself. The lambda expression may then be treated as a
31function, i. e. stored as the function value of a symbol, passed to
32funcall or mapcar, etcetera.
33ARGS should take the same form as an argument list for a `defun'.
34DOCSTRING should be a string, as described for `defun'. It may be omitted.
35INTERACTIVE should be a call to the function `interactive', which see.
36It may also be omitted.
37BODY should be a list of lisp expressions."
38 ;; Note that this definition should not use backquotes; subr.el should not
39 ;; depend on backquote.el.
40 (list 'function (cons 'lambda cdr)))
41
42;;(defmacro defun-inline (name args &rest body)
43;; "Create an \"inline defun\" (actually a macro).
44;;Use just like `defun'."
45;; (nconc (list 'defmacro name '(&rest args))
46;; (if (stringp (car body))
47;; (prog1 (list (car body))
48;; (setq body (or (cdr body) body))))
49;; (list (list 'cons (list 'quote
50;; (cons 'lambda (cons args body)))
51;; 'args))))
52
53\f
54;;;; Window tree functions.
55
e0de7bcb 56(defun one-window-p (&optional nomini all-frames)
be9b65ac
DL
57 "Returns non-nil if there is only one window.
58Optional arg NOMINI non-nil means don't count the minibuffer
e0de7bcb
RS
59even if it is active.
60
61The optional arg ALL-FRAMES t means count windows on all frames.
62If it is `visible', count windows on all visible frames.
63ALL-FRAMES nil or omitted means count only the selected frame,
64plus the minibuffer it uses (which may be on another frame).
65If ALL-FRAMES is neither nil nor t, count only the selected frame."
492878e4
JB
66 (let ((base-window (selected-window)))
67 (if (and nomini (eq base-window (minibuffer-window)))
68 (setq base-window (next-window base-window)))
69 (eq base-window
e0de7bcb 70 (next-window base-window (if nomini 'arg) all-frames))))
be9b65ac 71
0cc89026 72(defun walk-windows (proc &optional minibuf all-frames)
be9b65ac
DL
73 "Cycle through all visible windows, calling PROC for each one.
74PROC is called with a window as argument.
75Optional second arg MINIBUF t means count the minibuffer window
76even if not active. If MINIBUF is neither t nor nil it means
77not to count the minibuffer even if it is active.
f1f2d09a
RS
78
79Optional third arg ALL-FRAMES, if t, means include all frames.
80ALL-FRAMES nil or omitted means cycle within the selected frame,
81but include the minibuffer window (if MINIBUF says so) that that
82frame uses, even if it is on another frame.
83If ALL-FRAMES is neither nil nor t, stick strictly to the selected frame."
7a18f5c2
RS
84 ;; If we start from the minibuffer window, don't fail to come back to it.
85 (if (window-minibuffer-p (selected-window))
86 (setq minibuf t))
be9b65ac
DL
87 (let* ((walk-windows-start (selected-window))
88 (walk-windows-current walk-windows-start))
89 (while (progn
90 (setq walk-windows-current
0cc89026 91 (next-window walk-windows-current minibuf all-frames))
be9b65ac
DL
92 (funcall proc walk-windows-current)
93 (not (eq walk-windows-current walk-windows-start))))))
94
79e0df73
RS
95(defun minibuffer-window-active-p (window)
96 "Return t if WINDOW (a minibuffer window) is now active."
97 ;; nil nil means include WINDOW's frame
98 ;; and other frames using WINDOW as minibuffer,
99 ;; and include minibuffer if active.
100 (let ((prev (previous-window window nil nil)))
101 ;; If PREV equals WINDOW, WINDOW must be on a minibuffer-only frame
102 ;; and it's not currently being used. So return nil.
103 (and (not (eq window prev))
104 (let ((should-be-same (next-window prev nil nil)))
105 ;; If next-window doesn't reverse previous-window,
106 ;; WINDOW must be outside the cycle specified by nil nil.
107 (eq should-be-same window)))))
9a5336ae
JB
108\f
109;;;; Keymap support.
be9b65ac
DL
110
111(defun undefined ()
112 (interactive)
113 (ding))
114
115;Prevent the \{...} documentation construct
116;from mentioning keys that run this command.
117(put 'undefined 'suppress-keymap t)
118
119(defun suppress-keymap (map &optional nodigits)
120 "Make MAP override all normally self-inserting keys to be undefined.
121Normally, as an exception, digits and minus-sign are set to make prefix args,
122but optional second arg NODIGITS non-nil treats them like other chars."
80e7b471 123 (substitute-key-definition 'self-insert-command 'undefined map global-map)
be9b65ac
DL
124 (or nodigits
125 (let (loop)
126 (define-key map "-" 'negative-argument)
127 ;; Make plain numbers do numeric args.
128 (setq loop ?0)
129 (while (<= loop ?9)
130 (define-key map (char-to-string loop) 'digit-argument)
131 (setq loop (1+ loop))))))
132
be9b65ac
DL
133;Moved to keymap.c
134;(defun copy-keymap (keymap)
135; "Return a copy of KEYMAP"
136; (while (not (keymapp keymap))
137; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap))))
138; (if (vectorp keymap)
139; (copy-sequence keymap)
140; (copy-alist keymap)))
141
f14dbba7
KH
142(defvar key-substitution-in-progress nil
143 "Used internally by substitute-key-definition.")
144
7f2c2edd 145(defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
be9b65ac
DL
146 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
147In other words, OLDDEF is replaced with NEWDEF where ever it appears.
7f2c2edd
RS
148If optional fourth argument OLDMAP is specified, we redefine
149in KEYMAP as NEWDEF those chars which are defined as OLDDEF in OLDMAP."
150 (or prefix (setq prefix ""))
151 (let* ((scan (or oldmap keymap))
152 (vec1 (vector nil))
f14dbba7
KH
153 (prefix1 (vconcat prefix vec1))
154 (key-substitution-in-progress
155 (cons scan key-substitution-in-progress)))
7f2c2edd
RS
156 ;; Scan OLDMAP, finding each char or event-symbol that
157 ;; has any definition, and act on it with hack-key.
158 (while (consp scan)
159 (if (consp (car scan))
160 (let ((char (car (car scan)))
161 (defn (cdr (car scan))))
162 ;; The inside of this let duplicates exactly
163 ;; the inside of the following let that handles array elements.
164 (aset vec1 0 char)
165 (aset prefix1 (length prefix) char)
44d798af 166 (let (inner-def skipped)
7f2c2edd
RS
167 ;; Skip past menu-prompt.
168 (while (stringp (car-safe defn))
44d798af 169 (setq skipped (cons (car defn) skipped))
7f2c2edd
RS
170 (setq defn (cdr defn)))
171 (setq inner-def defn)
172 (while (and (symbolp inner-def)
173 (fboundp inner-def))
174 (setq inner-def (symbol-function inner-def)))
175 (if (eq defn olddef)
44d798af 176 (define-key keymap prefix1 (nconc (nreverse skipped) newdef))
f14dbba7
KH
177 (if (and (keymapp defn)
178 (not (memq inner-def
179 key-substitution-in-progress)))
7f2c2edd
RS
180 (substitute-key-definition olddef newdef keymap
181 inner-def
182 prefix1)))))
183 (if (arrayp (car scan))
184 (let* ((array (car scan))
185 (len (length array))
186 (i 0))
187 (while (< i len)
188 (let ((char i) (defn (aref array i)))
189 ;; The inside of this let duplicates exactly
190 ;; the inside of the previous let.
191 (aset vec1 0 char)
192 (aset prefix1 (length prefix) char)
44d798af 193 (let (inner-def skipped)
7f2c2edd
RS
194 ;; Skip past menu-prompt.
195 (while (stringp (car-safe defn))
44d798af 196 (setq skipped (cons (car defn) skipped))
7f2c2edd
RS
197 (setq defn (cdr defn)))
198 (setq inner-def defn)
199 (while (and (symbolp inner-def)
200 (fboundp inner-def))
201 (setq inner-def (symbol-function inner-def)))
202 (if (eq defn olddef)
44d798af
RS
203 (define-key keymap prefix1
204 (nconc (nreverse skipped) newdef))
f14dbba7
KH
205 (if (and (keymapp defn)
206 (not (memq inner-def
207 key-substitution-in-progress)))
7f2c2edd
RS
208 (substitute-key-definition olddef newdef keymap
209 inner-def
210 prefix1)))))
211 (setq i (1+ i))))))
212 (setq scan (cdr scan)))))
9a5336ae 213
06ae9cf2 214(defun define-key-after (keymap key definition after)
4434d61b
RS
215 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
216This is like `define-key' except that the binding for KEY is placed
217just after the binding for the event AFTER, instead of at the beginning
218of the map.
626f67f3
RS
219The order matters when the keymap is used as a menu.
220KEY must contain just one event type--it must be a string or vector
221of length 1."
4434d61b
RS
222 (or (keymapp keymap)
223 (signal 'wrong-type-argument (list 'keymapp keymap)))
ab375e6c 224 (if (> (length key) 1)
626f67f3 225 (error "multi-event key specified in `define-key-after'"))
113d28a8 226 (let ((tail keymap) done inserted
4434d61b
RS
227 (first (aref key 0)))
228 (while (and (not done) tail)
229 ;; Delete any earlier bindings for the same key.
230 (if (eq (car-safe (car (cdr tail))) first)
231 (setcdr tail (cdr (cdr tail))))
232 ;; When we reach AFTER's binding, insert the new binding after.
233 ;; If we reach an inherited keymap, insert just before that.
113d28a8 234 ;; If we reach the end of this keymap, insert at the end.
4434d61b 235 (if (or (eq (car-safe (car tail)) after)
113d28a8
RS
236 (eq (car (cdr tail)) 'keymap)
237 (null (cdr tail)))
4434d61b 238 (progn
113d28a8
RS
239 ;; Stop the scan only if we find a parent keymap.
240 ;; Keep going past the inserted element
241 ;; so we can delete any duplications that come later.
242 (if (eq (car (cdr tail)) 'keymap)
243 (setq done t))
244 ;; Don't insert more than once.
245 (or inserted
246 (setcdr tail (cons (cons (aref key 0) definition) (cdr tail))))
247 (setq inserted t)))
4434d61b
RS
248 (setq tail (cdr tail)))))
249
9a5336ae
JB
250(defun keyboard-translate (from to)
251 "Translate character FROM to TO at a low level.
252This function creates a `keyboard-translate-table' if necessary
253and then modifies one entry in it."
254 (or (arrayp keyboard-translate-table)
255 (setq keyboard-translate-table ""))
256 (if (or (> from (length keyboard-translate-table))
257 (> to (length keyboard-translate-table)))
258 (progn
259 (let* ((i (length keyboard-translate-table))
f4ebbdbe
RS
260 (table (concat keyboard-translate-table
261 (make-string (- 256 i) 0))))
9a5336ae
JB
262 (while (< i 256)
263 (aset table i i)
264 (setq i (1+ i)))
265 (setq keyboard-translate-table table))))
266 (aset keyboard-translate-table from to))
267
268\f
269;;;; The global keymap tree.
270
271;;; global-map, esc-map, and ctl-x-map have their values set up in
272;;; keymap.c; we just give them docstrings here.
273
274(defvar global-map nil
275 "Default global keymap mapping Emacs keyboard input into commands.
276The value is a keymap which is usually (but not necessarily) Emacs's
277global map.")
278
279(defvar esc-map nil
280 "Default keymap for ESC (meta) commands.
281The normal global definition of the character ESC indirects to this keymap.")
282
283(defvar ctl-x-map nil
284 "Default keymap for C-x commands.
285The normal global definition of the character C-x indirects to this keymap.")
286
287(defvar ctl-x-4-map (make-sparse-keymap)
288 "Keymap for subcommands of C-x 4")
059184dd 289(defalias 'ctl-x-4-prefix ctl-x-4-map)
9a5336ae
JB
290(define-key ctl-x-map "4" 'ctl-x-4-prefix)
291
292(defvar ctl-x-5-map (make-sparse-keymap)
293 "Keymap for frame commands.")
059184dd 294(defalias 'ctl-x-5-prefix ctl-x-5-map)
9a5336ae
JB
295(define-key ctl-x-map "5" 'ctl-x-5-prefix)
296
0f03054a 297\f
9a5336ae
JB
298;;;; Event manipulation functions.
299
114137b8
RS
300;; This code exists specifically to make sure that the
301;; resulting number does not appear in the .elc file.
302;; The number is negative on most machines, but not on all!
303(defconst listify-key-sequence-1
304 (lsh 1 7))
305(setq listify-key-sequence-1 (logior (lsh 1 23) listify-key-sequence-1))
306
cde6d7e3
RS
307(defun listify-key-sequence (key)
308 "Convert a key sequence to a list of events."
309 (if (vectorp key)
310 (append key nil)
311 (mapcar (function (lambda (c)
312 (if (> c 127)
114137b8 313 (logxor c listify-key-sequence-1)
cde6d7e3
RS
314 c)))
315 (append key nil))))
316
53e5a4e8
RS
317(defsubst eventp (obj)
318 "True if the argument is an event object."
319 (or (integerp obj)
320 (and (symbolp obj)
321 (get obj 'event-symbol-elements))
322 (and (consp obj)
323 (symbolp (car obj))
324 (get (car obj) 'event-symbol-elements))))
325
326(defun event-modifiers (event)
327 "Returns a list of symbols representing the modifier keys in event EVENT.
328The elements of the list may include `meta', `control',
32295976
RS
329`shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
330and `down'."
53e5a4e8
RS
331 (let ((type event))
332 (if (listp type)
333 (setq type (car type)))
334 (if (symbolp type)
335 (cdr (get type 'event-symbol-elements))
336 (let ((list nil))
337 (or (zerop (logand type (lsh 1 23)))
338 (setq list (cons 'meta list)))
339 (or (and (zerop (logand type (lsh 1 22)))
340 (>= (logand type 127) 32))
341 (setq list (cons 'control list)))
342 (or (and (zerop (logand type (lsh 1 21)))
343 (= (logand type 255) (downcase (logand type 255))))
344 (setq list (cons 'shift list)))
345 (or (zerop (logand type (lsh 1 20)))
346 (setq list (cons 'hyper list)))
347 (or (zerop (logand type (lsh 1 19)))
348 (setq list (cons 'super list)))
349 (or (zerop (logand type (lsh 1 18)))
350 (setq list (cons 'alt list)))
351 list))))
352
d63de416
RS
353(defun event-basic-type (event)
354 "Returns the basic type of the given event (all modifiers removed).
355The value is an ASCII printing character (not upper case) or a symbol."
2b0f4ba5
JB
356 (if (consp event)
357 (setq event (car event)))
d63de416
RS
358 (if (symbolp event)
359 (car (get event 'event-symbol-elements))
360 (let ((base (logand event (1- (lsh 1 18)))))
361 (downcase (if (< base 32) (logior base 64) base)))))
362
0f03054a
RS
363(defsubst mouse-movement-p (object)
364 "Return non-nil if OBJECT is a mouse movement event."
365 (and (consp object)
366 (eq (car object) 'mouse-movement)))
367
368(defsubst event-start (event)
369 "Return the starting position of EVENT.
370If EVENT is a mouse press or a mouse click, this returns the location
371of the event.
372If EVENT is a drag, this returns the drag's starting position.
373The return value is of the form
e55c21be 374 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
0f03054a
RS
375The `posn-' functions access elements of such lists."
376 (nth 1 event))
377
378(defsubst event-end (event)
379 "Return the ending location of EVENT. EVENT should be a click or drag event.
380If EVENT is a click event, this function is the same as `event-start'.
381The return value is of the form
e55c21be 382 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
0f03054a 383The `posn-' functions access elements of such lists."
69b95560 384 (nth (if (consp (nth 2 event)) 2 1) event))
0f03054a 385
32295976
RS
386(defsubst event-click-count (event)
387 "Return the multi-click count of EVENT, a click or drag event.
388The return value is a positive integer."
389 (if (integerp (nth 2 event)) (nth 2 event) 1))
390
0f03054a
RS
391(defsubst posn-window (position)
392 "Return the window in POSITION.
393POSITION should be a list of the form
e55c21be 394 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
0f03054a
RS
395as returned by the `event-start' and `event-end' functions."
396 (nth 0 position))
397
398(defsubst posn-point (position)
399 "Return the buffer location in POSITION.
400POSITION should be a list of the form
e55c21be 401 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
0f03054a 402as returned by the `event-start' and `event-end' functions."
15db4e0e
JB
403 (if (consp (nth 1 position))
404 (car (nth 1 position))
405 (nth 1 position)))
0f03054a 406
e55c21be
RS
407(defsubst posn-x-y (position)
408 "Return the x and y coordinates in POSITION.
0f03054a 409POSITION should be a list of the form
e55c21be 410 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
0f03054a
RS
411as returned by the `event-start' and `event-end' functions."
412 (nth 2 position))
413
e55c21be
RS
414(defsubst posn-col-row (position)
415 "Return the row and column in POSITION, measured in characters.
416POSITION should be a list of the form
417 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
418as returned by the `event-start' and `event-end' functions."
419 (let* ((pair (nth 2 position))
420 (window (posn-window position))
421 (frame (if (framep window) window (window-frame window)))
422 (x (/ (car pair) (frame-char-width frame)))
423 (y (/ (cdr pair) (frame-char-height frame))))
424 (cons x y)))
425
0f03054a
RS
426(defsubst posn-timestamp (position)
427 "Return the timestamp of POSITION.
428POSITION should be a list of the form
e55c21be 429 (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
f415c00c 430as returned by the `event-start' and `event-end' functions."
0f03054a 431 (nth 3 position))
9a5336ae 432
0f03054a 433\f
9a5336ae
JB
434;;;; Obsolescent names for functions.
435
059184dd
ER
436(defalias 'dot 'point)
437(defalias 'dot-marker 'point-marker)
438(defalias 'dot-min 'point-min)
439(defalias 'dot-max 'point-max)
440(defalias 'window-dot 'window-point)
441(defalias 'set-window-dot 'set-window-point)
442(defalias 'read-input 'read-string)
443(defalias 'send-string 'process-send-string)
444(defalias 'send-region 'process-send-region)
445(defalias 'show-buffer 'set-window-buffer)
446(defalias 'buffer-flush-undo 'buffer-disable-undo)
447(defalias 'eval-current-buffer 'eval-buffer)
448(defalias 'compiled-function-p 'byte-code-function-p)
be9b65ac 449
9a5336ae
JB
450;; Some programs still use this as a function.
451(defun baud-rate ()
bcacc42c
RS
452 "Obsolete function returning the value of the `baud-rate' variable.
453Please convert your programs to use the variable `baud-rate' directly."
9a5336ae
JB
454 baud-rate)
455
456\f
457;;;; Alternate names for functions - these are not being phased out.
458
059184dd
ER
459(defalias 'string= 'string-equal)
460(defalias 'string< 'string-lessp)
461(defalias 'move-marker 'set-marker)
462(defalias 'eql 'eq)
463(defalias 'not 'null)
464(defalias 'rplaca 'setcar)
465(defalias 'rplacd 'setcdr)
eb8c3be9 466(defalias 'beep 'ding) ;preserve lingual purity
059184dd
ER
467(defalias 'indent-to-column 'indent-to)
468(defalias 'backward-delete-char 'delete-backward-char)
469(defalias 'search-forward-regexp (symbol-function 're-search-forward))
470(defalias 'search-backward-regexp (symbol-function 're-search-backward))
471(defalias 'int-to-string 'number-to-string)
1e0a78a1 472(defalias 'set-match-data 'store-match-data)
37f6661a
JB
473
474;;; Should this be an obsolete name? If you decide it should, you get
475;;; to go through all the sources and change them.
059184dd 476(defalias 'string-to-int 'string-to-number)
be9b65ac 477\f
9a5336ae 478;;;; Hook manipulation functions.
be9b65ac 479
be9b65ac
DL
480(defun run-hooks (&rest hooklist)
481 "Takes hook names and runs each one in turn. Major mode functions use this.
482Each argument should be a symbol, a hook variable.
483These symbols are processed in the order specified.
484If a hook symbol has a non-nil value, that value may be a function
485or a list of functions to be called to run the hook.
486If the value is a function, it is called with no arguments.
487If it is a list, the elements are called, in order, with no arguments."
488 (while hooklist
489 (let ((sym (car hooklist)))
490 (and (boundp sym)
491 (symbol-value sym)
492 (let ((value (symbol-value sym)))
493 (if (and (listp value) (not (eq (car value) 'lambda)))
494 (mapcar 'funcall value)
495 (funcall value)))))
496 (setq hooklist (cdr hooklist))))
497
498;; Tell C code how to call this function.
499(defconst run-hooks 'run-hooks
500 "Variable by which C primitives find the function `run-hooks'.
501Don't change it.")
502
08159178 503(defun add-hook (hook function &optional append)
32295976
RS
504 "Add to the value of HOOK the function FUNCTION.
505FUNCTION is not added if already present.
506FUNCTION is added (if necessary) at the beginning of the hook list
507unless the optional argument APPEND is non-nil, in which case
508FUNCTION is added at the end.
509
510HOOK should be a symbol, and FUNCTION may be any valid function. If
511HOOK is void, it is first set to nil. If HOOK's value is a single
512function, it is changed to a list of functions."
be9b65ac 513 (or (boundp hook) (set hook nil))
32295976
RS
514 ;; If the hook value is a single function, turn it into a list.
515 (let ((old (symbol-value hook)))
516 (if (or (not (listp old)) (eq (car old) 'lambda))
517 (set hook (list old))))
be9b65ac 518 (or (if (consp function)
f48c1d8d 519 (member function (symbol-value hook))
be9b65ac 520 (memq function (symbol-value hook)))
08159178
ER
521 (set hook
522 (if append
523 (nconc (symbol-value hook) (list function))
524 (cons function (symbol-value hook))))))
9a5336ae 525
24980d16
RS
526(defun remove-hook (hook function)
527 "Remove from the value of HOOK the function FUNCTION.
528HOOK should be a symbol, and FUNCTION may be any valid function. If
529FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
827534ea 530list of hooks to run in HOOK, then nothing is done. See `add-hook'."
24980d16
RS
531 (if (or (not (boundp hook)) ;unbound symbol, or
532 (null (symbol-value hook)) ;value is nil, or
533 (null function)) ;function is nil, then
534 nil ;Do nothing.
535 (let ((hook-value (symbol-value hook)))
536 (if (consp hook-value)
537 (setq hook-value (delete function hook-value))
f48c1d8d 538 (if (equal hook-value function)
24980d16
RS
539 (setq hook-value nil)))
540 (set hook hook-value))))
be9b65ac 541\f
9a5336ae
JB
542;;;; Specifying things to do after certain files are loaded.
543
544(defun eval-after-load (file form)
545 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
546This makes or adds to an entry on `after-load-alist'.
12c7071c 547It does nothing if FORM is already on the list for FILE.
9a5336ae
JB
548FILE should be the name of a library, with no directory name."
549 (or (assoc file after-load-alist)
550 (setq after-load-alist (cons (list file) after-load-alist)))
12c7071c
RS
551 (let ((elt (assoc file after-load-alist)))
552 (or (member form (cdr elt))
553 (nconc elt (list form))))
9a5336ae
JB
554 form)
555
556(defun eval-next-after-load (file)
557 "Read the following input sexp, and run it whenever FILE is loaded.
558This makes or adds to an entry on `after-load-alist'.
559FILE should be the name of a library, with no directory name."
560 (eval-after-load file (read)))
561
562\f
563;;;; Input and display facilities.
564
565(defun read-quoted-char (&optional prompt)
566 "Like `read-char', except that if the first character read is an octal
567digit, we read up to two more octal digits and return the character
568represented by the octal number consisting of those digits.
569Optional argument PROMPT specifies a string to use to prompt the user."
570 (let ((count 0) (code 0) char)
571 (while (< count 3)
572 (let ((inhibit-quit (zerop count))
573 (help-form nil))
574 (and prompt (message "%s-" prompt))
575 (setq char (read-char))
576 (if inhibit-quit (setq quit-flag nil)))
577 (cond ((null char))
578 ((and (<= ?0 char) (<= char ?7))
579 (setq code (+ (* code 8) (- char ?0))
580 count (1+ count))
581 (and prompt (message (setq prompt
582 (format "%s %c" prompt char)))))
583 ((> count 0)
584 (setq unread-command-events (list char) count 259))
585 (t (setq code char count 259))))
586 (logand 255 code)))
587
588(defun force-mode-line-update (&optional all)
589 "Force the mode-line of the current buffer to be redisplayed.
590With optional non-nil ALL then force then force redisplay of all mode-lines."
591 (if all (save-excursion (set-buffer (other-buffer))))
592 (set-buffer-modified-p (buffer-modified-p)))
593
be9b65ac
DL
594(defun momentary-string-display (string pos &optional exit-char message)
595 "Momentarily display STRING in the buffer at POS.
596Display remains until next character is typed.
597If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed;
598otherwise it is then available as input (as a command if nothing else).
599Display MESSAGE (optional fourth arg) in the echo area.
600If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
601 (or exit-char (setq exit-char ?\ ))
602 (let ((buffer-read-only nil)
603 (modified (buffer-modified-p))
604 (name buffer-file-name)
605 insert-end)
606 (unwind-protect
607 (progn
608 (save-excursion
609 (goto-char pos)
610 ;; defeat file locking... don't try this at home, kids!
611 (setq buffer-file-name nil)
612 (insert-before-markers string)
3eec84bf
RS
613 (setq insert-end (point))
614 ;; If the message end is off screen, recenter now.
615 (if (> (window-end) insert-end)
616 (recenter (/ (window-height) 2)))
617 ;; If that pushed message start off the screen,
618 ;; scroll to start it at the top of the screen.
619 (move-to-window-line 0)
620 (if (> (point) pos)
621 (progn
622 (goto-char pos)
623 (recenter 0))))
be9b65ac
DL
624 (message (or message "Type %s to continue editing.")
625 (single-key-description exit-char))
3547c855 626 (let ((char (read-event)))
be9b65ac 627 (or (eq char exit-char)
dbc4e1c1 628 (setq unread-command-events (list char)))))
be9b65ac
DL
629 (if insert-end
630 (save-excursion
631 (delete-region pos insert-end)))
632 (setq buffer-file-name name)
633 (set-buffer-modified-p modified))))
634
9a5336ae
JB
635\f
636;;;; Miscellanea.
637
638(defun ignore (&rest ignore)
639 "Do nothing.
640Accept any number of arguments, but ignore them."
641 nil)
642
643(defun error (&rest args)
644 "Signal an error, making error message by passing all args to `format'."
645 (while t
646 (signal 'error (list (apply 'format args)))))
647
cef7ae6e 648(defalias 'user-original-login-name 'user-login-name)
9a5336ae 649
be9b65ac
DL
650(defun start-process-shell-command (name buffer &rest args)
651 "Start a program in a subprocess. Return the process object for it.
652Args are NAME BUFFER COMMAND &rest COMMAND-ARGS.
653NAME is name for process. It is modified if necessary to make it unique.
654BUFFER is the buffer or (buffer-name) to associate with the process.
655 Process output goes at end of that buffer, unless you specify
656 an output stream or filter function to handle the output.
657 BUFFER may be also nil, meaning that this process is not associated
658 with any buffer
659Third arg is command name, the name of a shell command.
660Remaining arguments are the arguments for the command.
4f1d6310 661Wildcards and redirection are handled as usual in the shell."
be9b65ac
DL
662 (if (eq system-type 'vax-vms)
663 (apply 'start-process name buffer args)
664 (start-process name buffer shell-file-name "-c"
665 (concat "exec " (mapconcat 'identity args " ")))))
be9b65ac 666
9a5336ae
JB
667(defmacro save-match-data (&rest body)
668 "Execute the BODY forms, restoring the global value of the match data."
669 (let ((original (make-symbol "match-data")))
670 (list
671 'let (list (list original '(match-data)))
672 (list 'unwind-protect
673 (cons 'progn body)
674 (list 'store-match-data original)))))
ffd56f97 675
8af7df60
RS
676(defun shell-quote-argument (argument)
677 "Quote an argument for passing as argument to an inferior shell."
678 ;; Quote everything except POSIX filename characters.
679 ;; This should be safe enough even for really weird shells.
680 (let ((result "") (start 0) end)
26add1bf 681 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
8af7df60
RS
682 (setq end (match-beginning 0)
683 result (concat result (substring argument start end)
684 "\\" (substring argument end (1+ end)))
685 start (1+ end)))
686 (concat result (substring argument start))))
687
297d863b 688(defun make-syntax-table (&optional oldtable)
984f718a
RS
689 "Return a new syntax table.
690It inherits all letters and control characters from the standard
691syntax table; other characters are copied from the standard syntax table."
297d863b
KH
692 (if oldtable
693 (copy-syntax-table oldtable)
694 (let ((table (copy-syntax-table))
695 i)
696 (setq i 0)
697 (while (<= i 31)
698 (aset table i 13)
699 (setq i (1+ i)))
700 (setq i ?A)
701 (while (<= i ?Z)
702 (aset table i 13)
703 (setq i (1+ i)))
704 (setq i ?a)
705 (while (<= i ?z)
706 (aset table i 13)
707 (setq i (1+ i)))
708 (setq i 128)
709 (while (<= i 255)
710 (aset table i 13)
711 (setq i (1+ i)))
712 table)))
984f718a 713
9a5336ae
JB
714;; now in fns.c
715;(defun nth (n list)
716; "Returns the Nth element of LIST.
717;N counts from zero. If LIST is not that long, nil is returned."
718; (car (nthcdr n list)))
719;
720;(defun copy-alist (alist)
721; "Return a copy of ALIST.
722;This is a new alist which represents the same mapping
723;from objects to objects, but does not share the alist structure with ALIST.
724;The objects mapped (cars and cdrs of elements of the alist)
725;are shared, however."
726; (setq alist (copy-sequence alist))
727; (let ((tail alist))
728; (while tail
729; (if (consp (car tail))
730; (setcar tail (cons (car (car tail)) (cdr (car tail)))))
731; (setq tail (cdr tail))))
732; alist)
630cc463
ER
733
734;;; subr.el ends here
9a5336ae 735