subr.el 28.1 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1
;;; subr.el --- basic lisp subroutines for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Karl Heuer's avatar
Karl Heuer committed
3
;;; Copyright (C) 1985, 1986, 1992, 1994 Free Software Foundation, Inc.
David Lawrence's avatar
David Lawrence committed
4 5 6 7 8

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
;; the Free Software Foundation; either version 2, or (at your option)
David Lawrence's avatar
David Lawrence committed
10 11 12 13 14 15 16 17 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

Eric S. Raymond's avatar
Eric S. Raymond committed
21
;;; Code:
David Lawrence's avatar
David Lawrence committed
22

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

;;;; Lisp language features.

(defmacro lambda (&rest cdr)
  "Return a lambda expression.
A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
self-quoting; the result of evaluating the lambda expression is the
expression itself.  The lambda expression may then be treated as a
function, i. e. stored as the function value of a symbol, passed to
funcall or mapcar, etcetera.
ARGS should take the same form as an argument list for a `defun'.
DOCSTRING should be a string, as described for `defun'.  It may be omitted.
INTERACTIVE should be a call to the function `interactive', which see.
It may also be omitted.
BODY should be a list of lisp expressions."
  ;; Note that this definition should not use backquotes; subr.el should not
  ;; depend on backquote.el.
  (list 'function (cons 'lambda cdr)))

;;(defmacro defun-inline (name args &rest body)
;;  "Create an \"inline defun\" (actually a macro).
;;Use just like `defun'."
;;  (nconc (list 'defmacro name '(&rest args))
;;	 (if (stringp (car body))
;;	     (prog1 (list (car body))
;;	       (setq body (or (cdr body) body))))
;;	 (list (list 'cons (list 'quote
;;				 (cons 'lambda (cons args body)))
;;		     'args))))


;;;; Window tree functions.

56
(defun one-window-p (&optional nomini all-frames)
David Lawrence's avatar
David Lawrence committed
57 58
  "Returns non-nil if there is only one window.
Optional arg NOMINI non-nil means don't count the minibuffer
59 60 61 62 63 64 65
even if it is active.

The optional arg ALL-FRAMES t means count windows on all frames.
If it is `visible', count windows on all visible frames.
ALL-FRAMES nil or omitted means count only the selected frame, 
plus the minibuffer it uses (which may be on another frame).
If ALL-FRAMES is neither nil nor t, count only the selected frame."
Jim Blandy's avatar
Jim Blandy committed
66 67 68 69
  (let ((base-window (selected-window)))
    (if (and nomini (eq base-window (minibuffer-window)))
	(setq base-window (next-window base-window)))
    (eq base-window
70
	(next-window base-window (if nomini 'arg) all-frames))))
David Lawrence's avatar
David Lawrence committed
71

Jim Blandy's avatar
Jim Blandy committed
72
(defun walk-windows (proc &optional minibuf all-frames)
David Lawrence's avatar
David Lawrence committed
73 74 75 76 77
  "Cycle through all visible windows, calling PROC for each one.
PROC is called with a window as argument.
Optional second arg MINIBUF t means count the minibuffer window
even if not active.  If MINIBUF is neither t nor nil it means
not to count the minibuffer even if it is active.
Richard M. Stallman's avatar
Richard M. Stallman committed
78 79 80 81 82 83

Optional third arg ALL-FRAMES, if t, means include all frames.
ALL-FRAMES nil or omitted means cycle within the selected frame,
but include the minibuffer window (if MINIBUF says so) that that
frame uses, even if it is on another frame.
If ALL-FRAMES is neither nil nor t, stick strictly to the selected frame."
84 85 86
  ;; If we start from the minibuffer window, don't fail to come back to it.
  (if (window-minibuffer-p (selected-window))
      (setq minibuf t))
David Lawrence's avatar
David Lawrence committed
87 88 89 90
  (let* ((walk-windows-start (selected-window))
	 (walk-windows-current walk-windows-start))
    (while (progn
	     (setq walk-windows-current
Jim Blandy's avatar
Jim Blandy committed
91
		   (next-window walk-windows-current minibuf all-frames))
David Lawrence's avatar
David Lawrence committed
92 93 94
	     (funcall proc walk-windows-current)
	     (not (eq walk-windows-current walk-windows-start))))))

95 96 97 98 99 100 101 102 103 104 105 106 107
(defun minibuffer-window-active-p (window)
  "Return t if WINDOW (a minibuffer window) is now active."
  ;; nil nil means include WINDOW's frame
  ;; and other frames using WINDOW as minibuffer,
  ;; and include minibuffer if active.
  (let ((prev (previous-window window nil nil)))
    ;; If PREV equals WINDOW, WINDOW must be on a minibuffer-only frame
    ;; and it's not currently being used.  So return nil.
    (and (not (eq window prev))
	 (let ((should-be-same (next-window prev nil nil)))
	   ;; If next-window doesn't reverse previous-window,
	   ;; WINDOW must be outside the cycle specified by nil nil.
	   (eq should-be-same window)))))
108 109

;;;; Keymap support.
David Lawrence's avatar
David Lawrence committed
110 111 112 113 114 115 116 117 118 119 120 121 122

(defun undefined ()
  (interactive)
  (ding))

;Prevent the \{...} documentation construct
;from mentioning keys that run this command.
(put 'undefined 'suppress-keymap t)

(defun suppress-keymap (map &optional nodigits)
  "Make MAP override all normally self-inserting keys to be undefined.
Normally, as an exception, digits and minus-sign are set to make prefix args,
but optional second arg NODIGITS non-nil treats them like other chars."
123
  (substitute-key-definition 'self-insert-command 'undefined map global-map)
David Lawrence's avatar
David Lawrence committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
  (or nodigits
      (let (loop)
	(define-key map "-" 'negative-argument)
	;; Make plain numbers do numeric args.
	(setq loop ?0)
	(while (<= loop ?9)
	  (define-key map (char-to-string loop) 'digit-argument)
	  (setq loop (1+ loop))))))

;Moved to keymap.c
;(defun copy-keymap (keymap)
;  "Return a copy of KEYMAP"  
;  (while (not (keymapp keymap))
;    (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap))))
;  (if (vectorp keymap)
;      (copy-sequence keymap)
;      (copy-alist keymap)))

142 143 144
(defvar key-substitution-in-progress nil
 "Used internally by substitute-key-definition.")

Richard M. Stallman's avatar
Richard M. Stallman committed
145
(defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
David Lawrence's avatar
David Lawrence committed
146 147
  "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
In other words, OLDDEF is replaced with NEWDEF where ever it appears.
Richard M. Stallman's avatar
Richard M. Stallman committed
148 149 150 151 152
If optional fourth argument OLDMAP is specified, we redefine
in KEYMAP as NEWDEF those chars which are defined as OLDDEF in OLDMAP."
  (or prefix (setq prefix ""))
  (let* ((scan (or oldmap keymap))
	 (vec1 (vector nil))
153 154 155
	 (prefix1 (vconcat prefix vec1))
	 (key-substitution-in-progress
	  (cons scan key-substitution-in-progress)))
Richard M. Stallman's avatar
Richard M. Stallman committed
156 157 158 159 160 161 162 163 164 165
    ;; Scan OLDMAP, finding each char or event-symbol that
    ;; has any definition, and act on it with hack-key.
    (while (consp scan)
      (if (consp (car scan))
	  (let ((char (car (car scan)))
		(defn (cdr (car scan))))
	    ;; The inside of this let duplicates exactly
	    ;; the inside of the following let that handles array elements.
	    (aset vec1 0 char)
	    (aset prefix1 (length prefix) char)
166
	    (let (inner-def skipped)
Richard M. Stallman's avatar
Richard M. Stallman committed
167 168
	      ;; Skip past menu-prompt.
	      (while (stringp (car-safe defn))
169
		(setq skipped (cons (car defn) skipped))
Richard M. Stallman's avatar
Richard M. Stallman committed
170
		(setq defn (cdr defn)))
171 172 173
	      ;; Skip past cached key-equivalence data for menu items.
	      (and (consp defn) (consp (car defn))
		   (setq defn (cdr defn)))
Richard M. Stallman's avatar
Richard M. Stallman committed
174
	      (setq inner-def defn)
175
	      ;; Look past a symbol that names a keymap.
Richard M. Stallman's avatar
Richard M. Stallman committed
176 177 178 179
	      (while (and (symbolp inner-def)
			  (fboundp inner-def))
		(setq inner-def (symbol-function inner-def)))
	      (if (eq defn olddef)
180
		  (define-key keymap prefix1 (nconc (nreverse skipped) newdef))
181
		;; Avoid recursively rescanning a keymap being scanned.
182 183 184
		(if (and (keymapp defn)
			 (not (memq inner-def
				    key-substitution-in-progress)))
185 186
		    ;; If this one isn't being scanned already,
		    ;; scan it now.
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188 189 190 191 192 193 194 195 196 197 198 199
		    (substitute-key-definition olddef newdef keymap
					       inner-def
					       prefix1)))))
	(if (arrayp (car scan))
	    (let* ((array (car scan))
		   (len (length array))
		   (i 0))
	      (while (< i len)
		(let ((char i) (defn (aref array i)))
		  ;; The inside of this let duplicates exactly
		  ;; the inside of the previous let.
		  (aset vec1 0 char)
		  (aset prefix1 (length prefix) char)
200
		  (let (inner-def skipped)
Richard M. Stallman's avatar
Richard M. Stallman committed
201 202
		    ;; Skip past menu-prompt.
		    (while (stringp (car-safe defn))
203
		      (setq skipped (cons (car defn) skipped))
Richard M. Stallman's avatar
Richard M. Stallman committed
204
		      (setq defn (cdr defn)))
205 206
		    (and (consp defn) (consp (car defn))
			 (setq defn (cdr defn)))
Richard M. Stallman's avatar
Richard M. Stallman committed
207 208 209 210 211
		    (setq inner-def defn)
		    (while (and (symbolp inner-def)
				(fboundp inner-def))
		      (setq inner-def (symbol-function inner-def)))
		    (if (eq defn olddef)
212 213
			(define-key keymap prefix1
			  (nconc (nreverse skipped) newdef))
214 215 216
		      (if (and (keymapp defn)
			       (not (memq inner-def
					  key-substitution-in-progress)))
Richard M. Stallman's avatar
Richard M. Stallman committed
217 218 219 220 221
			  (substitute-key-definition olddef newdef keymap
						     inner-def
						     prefix1)))))
		(setq i (1+ i))))))
      (setq scan (cdr scan)))))
222

223
(defun define-key-after (keymap key definition after)
224 225 226 227
  "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
This is like `define-key' except that the binding for KEY is placed
just after the binding for the event AFTER, instead of at the beginning
of the map.
228
The order matters when the keymap is used as a menu.
229 230
KEY must contain just one event type--that is to say, it must be
a string or vector of length 1."
231 232
  (or (keymapp keymap)
      (signal 'wrong-type-argument (list 'keymapp keymap)))
233
  (if (> (length key) 1)
234
      (error "multi-event key specified in `define-key-after'"))
235
  (let ((tail keymap) done inserted
236 237 238 239 240 241 242
	(first (aref key 0)))
    (while (and (not done) tail)
      ;; Delete any earlier bindings for the same key.
      (if (eq (car-safe (car (cdr tail))) first)
	  (setcdr tail (cdr (cdr tail))))
      ;; When we reach AFTER's binding, insert the new binding after.
      ;; If we reach an inherited keymap, insert just before that.
243
      ;; If we reach the end of this keymap, insert at the end.
244
      (if (or (eq (car-safe (car tail)) after)
245 246
	      (eq (car (cdr tail)) 'keymap)
	      (null (cdr tail)))
247
	  (progn
248 249 250 251 252 253 254 255 256
	    ;; Stop the scan only if we find a parent keymap.
	    ;; Keep going past the inserted element
	    ;; so we can delete any duplications that come later.
	    (if (eq (car (cdr tail)) 'keymap)
		(setq done t))
	    ;; Don't insert more than once.
	    (or inserted
		(setcdr tail (cons (cons (aref key 0) definition) (cdr tail))))
	    (setq inserted t)))
257 258
      (setq tail (cdr tail)))))

259 260 261 262 263 264 265 266 267 268
(defun keyboard-translate (from to)
  "Translate character FROM to TO at a low level.
This function creates a `keyboard-translate-table' if necessary
and then modifies one entry in it."
  (or (arrayp keyboard-translate-table)
      (setq keyboard-translate-table ""))
  (if (or (> from (length keyboard-translate-table))
	  (> to   (length keyboard-translate-table)))
      (progn
	(let* ((i (length keyboard-translate-table))
269 270
	       (table (concat keyboard-translate-table
			      (make-string (- 256 i) 0))))
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
	  (while (< i 256)
	    (aset table i i)
	    (setq i (1+ i)))
	  (setq keyboard-translate-table table))))
  (aset keyboard-translate-table from to))


;;;; The global keymap tree.  

;;; global-map, esc-map, and ctl-x-map have their values set up in
;;; keymap.c; we just give them docstrings here.

(defvar global-map nil
  "Default global keymap mapping Emacs keyboard input into commands.
The value is a keymap which is usually (but not necessarily) Emacs's
global map.")

(defvar esc-map nil
  "Default keymap for ESC (meta) commands.
The normal global definition of the character ESC indirects to this keymap.")

(defvar ctl-x-map nil
  "Default keymap for C-x commands.
The normal global definition of the character C-x indirects to this keymap.")

(defvar ctl-x-4-map (make-sparse-keymap)
  "Keymap for subcommands of C-x 4")
298
(defalias 'ctl-x-4-prefix ctl-x-4-map)
299 300 301 302
(define-key ctl-x-map "4" 'ctl-x-4-prefix)

(defvar ctl-x-5-map (make-sparse-keymap)
  "Keymap for frame commands.")
303
(defalias 'ctl-x-5-prefix ctl-x-5-map)
304 305
(define-key ctl-x-map "5" 'ctl-x-5-prefix)

306

307 308
;;;; Event manipulation functions.

309 310 311 312 313 314 315
;; This code exists specifically to make sure that the
;; resulting number does not appear in the .elc file.
;; The number is negative on most machines, but not on all!
(defconst listify-key-sequence-1
   (lsh 1 7))
(setq listify-key-sequence-1 (logior (lsh 1 23) listify-key-sequence-1))

316 317 318 319 320 321
(defun listify-key-sequence (key)
  "Convert a key sequence to a list of events."
  (if (vectorp key)
      (append key nil)
    (mapcar (function (lambda (c)
			(if (> c 127)
322
			    (logxor c listify-key-sequence-1)
323 324 325
			  c)))
	    (append key nil))))

326 327 328 329 330 331 332 333 334 335 336 337
(defsubst eventp (obj)
  "True if the argument is an event object."
  (or (integerp obj)
      (and (symbolp obj)
	   (get obj 'event-symbol-elements))
      (and (consp obj)
	   (symbolp (car obj))
	   (get (car obj) 'event-symbol-elements))))

(defun event-modifiers (event)
  "Returns a list of symbols representing the modifier keys in event EVENT.
The elements of the list may include `meta', `control',
338 339
`shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
and `down'."
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
  (let ((type event))
    (if (listp type)
	(setq type (car type)))
    (if (symbolp type)
	(cdr (get type 'event-symbol-elements))
      (let ((list nil))
	(or (zerop (logand type (lsh 1 23)))
	    (setq list (cons 'meta list)))
	(or (and (zerop (logand type (lsh 1 22)))
		 (>= (logand type 127) 32))
	    (setq list (cons 'control list)))
	(or (and (zerop (logand type (lsh 1 21)))
		 (= (logand type 255) (downcase (logand type 255))))
	    (setq list (cons 'shift list)))
	(or (zerop (logand type (lsh 1 20)))
	    (setq list (cons 'hyper list)))
	(or (zerop (logand type (lsh 1 19)))
	    (setq list (cons 'super list)))
	(or (zerop (logand type (lsh 1 18)))
	    (setq list (cons 'alt list)))
	list))))

362 363 364
(defun event-basic-type (event)
  "Returns the basic type of the given event (all modifiers removed).
The value is an ASCII printing character (not upper case) or a symbol."
365 366
  (if (consp event)
      (setq event (car event)))
367 368 369 370 371
  (if (symbolp event)
      (car (get event 'event-symbol-elements))
    (let ((base (logand event (1- (lsh 1 18)))))
      (downcase (if (< base 32) (logior base 64) base)))))

372 373 374 375 376 377 378 379 380 381 382
(defsubst mouse-movement-p (object)
  "Return non-nil if OBJECT is a mouse movement event."
  (and (consp object)
       (eq (car object) 'mouse-movement)))

(defsubst event-start (event)
  "Return the starting position of EVENT.
If EVENT is a mouse press or a mouse click, this returns the location
of the event.
If EVENT is a drag, this returns the drag's starting position.
The return value is of the form
383
   (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
384 385 386 387 388 389 390
The `posn-' functions access elements of such lists."
  (nth 1 event))

(defsubst event-end (event)
  "Return the ending location of EVENT.  EVENT should be a click or drag event.
If EVENT is a click event, this function is the same as `event-start'.
The return value is of the form
391
   (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
392
The `posn-' functions access elements of such lists."
393
  (nth (if (consp (nth 2 event)) 2 1) event))
394

395 396 397 398 399
(defsubst event-click-count (event)
  "Return the multi-click count of EVENT, a click or drag event.
The return value is a positive integer."
  (if (integerp (nth 2 event)) (nth 2 event) 1))

400 401 402
(defsubst posn-window (position)
  "Return the window in POSITION.
POSITION should be a list of the form
403
   (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
404 405 406 407 408 409
as returned by the `event-start' and `event-end' functions."
  (nth 0 position))

(defsubst posn-point (position)
  "Return the buffer location in POSITION.
POSITION should be a list of the form
410
   (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
411
as returned by the `event-start' and `event-end' functions."
412 413 414
  (if (consp (nth 1 position))
      (car (nth 1 position))
    (nth 1 position)))
415

416 417
(defsubst posn-x-y (position)
  "Return the x and y coordinates in POSITION.
418
POSITION should be a list of the form
419
   (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
420 421 422
as returned by the `event-start' and `event-end' functions."
  (nth 2 position))

423
(defsubst posn-col-row (position)
Richard M. Stallman's avatar
Richard M. Stallman committed
424
  "Return the column and row in POSITION, measured in characters.
425 426 427 428 429 430 431 432 433 434
POSITION should be a list of the form
   (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
as returned by the `event-start' and `event-end' functions."
  (let* ((pair (nth 2 position))
	 (window (posn-window position))
	 (frame (if (framep window) window (window-frame window)))
	 (x (/ (car pair) (frame-char-width frame)))
	 (y (/ (cdr pair) (frame-char-height frame))))
    (cons x y)))

435 436 437
(defsubst posn-timestamp (position)
  "Return the timestamp of POSITION.
POSITION should be a list of the form
438
   (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP)
439
as returned by the `event-start' and `event-end' functions."
440
  (nth 3 position))
441

David Lawrence's avatar
David Lawrence committed
442

443 444
;;;; Obsolescent names for functions.

445 446 447 448 449 450 451 452 453 454 455 456 457
(defalias 'dot 'point)
(defalias 'dot-marker 'point-marker)
(defalias 'dot-min 'point-min)
(defalias 'dot-max 'point-max)
(defalias 'window-dot 'window-point)
(defalias 'set-window-dot 'set-window-point)
(defalias 'read-input 'read-string)
(defalias 'send-string 'process-send-string)
(defalias 'send-region 'process-send-region)
(defalias 'show-buffer 'set-window-buffer)
(defalias 'buffer-flush-undo 'buffer-disable-undo)
(defalias 'eval-current-buffer 'eval-buffer)
(defalias 'compiled-function-p 'byte-code-function-p)
David Lawrence's avatar
David Lawrence committed
458

459 460
;; Some programs still use this as a function.
(defun baud-rate ()
Richard M. Stallman's avatar
Richard M. Stallman committed
461 462
  "Obsolete function returning the value of the `baud-rate' variable.
Please convert your programs to use the variable `baud-rate' directly."
463 464 465 466 467
  baud-rate)


;;;; Alternate names for functions - these are not being phased out.

468 469 470 471 472 473 474
(defalias 'string= 'string-equal)
(defalias 'string< 'string-lessp)
(defalias 'move-marker 'set-marker)
(defalias 'eql 'eq)
(defalias 'not 'null)
(defalias 'rplaca 'setcar)
(defalias 'rplacd 'setcdr)
475
(defalias 'beep 'ding) ;preserve lingual purity
476 477 478 479 480
(defalias 'indent-to-column 'indent-to)
(defalias 'backward-delete-char 'delete-backward-char)
(defalias 'search-forward-regexp (symbol-function 're-search-forward))
(defalias 'search-backward-regexp (symbol-function 're-search-backward))
(defalias 'int-to-string 'number-to-string)
481
(defalias 'set-match-data 'store-match-data)
482 483 484

;;; Should this be an obsolete name?  If you decide it should, you get
;;; to go through all the sources and change them.
485
(defalias 'string-to-int 'string-to-number)
David Lawrence's avatar
David Lawrence committed
486

487
;;;; Hook manipulation functions.
David Lawrence's avatar
David Lawrence committed
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

(defun run-hooks (&rest hooklist)
  "Takes hook names and runs each one in turn.  Major mode functions use this.
Each argument should be a symbol, a hook variable.
These symbols are processed in the order specified.
If a hook symbol has a non-nil value, that value may be a function
or a list of functions to be called to run the hook.
If the value is a function, it is called with no arguments.
If it is a list, the elements are called, in order, with no arguments."
  (while hooklist
    (let ((sym (car hooklist)))
      (and (boundp sym)
	   (symbol-value sym)
	   (let ((value (symbol-value sym)))
	     (if (and (listp value) (not (eq (car value) 'lambda)))
503 504 505 506
		 (let ((functions value))
		   (while value
		     (funcall (car value))
		     (setq value (cdr value))))
David Lawrence's avatar
David Lawrence committed
507 508 509
	       (funcall value)))))
    (setq hooklist (cdr hooklist))))

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
(defun run-hook-with-args (hook &rest args)
  "Run HOOK with the specified arguments ARGS.
HOOK should be a symbol, a hook variable.  If HOOK has a non-nil
value, that value may be a function or a list of functions to be
called to run the hook.  If the value is a function, it is called with
the given arguments and its return value is returned.  If it is a list
of functions, those functions are called, in order,
with the given arguments ARGS.
It is best not to depend on the value return by `run-hook-with-args',
as that may change."
  (and (boundp hook)
       (symbol-value hook)
       (let ((value (symbol-value hook)))
	 (if (and (listp value) (not (eq (car value) 'lambda)))
	     (mapcar '(lambda (foo) (apply foo args))
		     value)
	   (apply value args)))))

David Lawrence's avatar
David Lawrence committed
528 529 530 531 532
;; Tell C code how to call this function.
(defconst run-hooks 'run-hooks
  "Variable by which C primitives find the function `run-hooks'.
Don't change it.")

533
(defun add-hook (hook function &optional append)
534 535 536 537 538 539 540 541 542
  "Add to the value of HOOK the function FUNCTION.
FUNCTION is not added if already present.
FUNCTION is added (if necessary) at the beginning of the hook list
unless the optional argument APPEND is non-nil, in which case
FUNCTION is added at the end.

HOOK should be a symbol, and FUNCTION may be any valid function.  If
HOOK is void, it is first set to nil.  If HOOK's value is a single
function, it is changed to a list of functions."
David Lawrence's avatar
David Lawrence committed
543
  (or (boundp hook) (set hook nil))
544 545 546 547
  ;; If the hook value is a single function, turn it into a list.
  (let ((old (symbol-value hook)))
    (if (or (not (listp old)) (eq (car old) 'lambda))
	(set hook (list old))))
David Lawrence's avatar
David Lawrence committed
548
  (or (if (consp function)
549
	  (member function (symbol-value hook))
David Lawrence's avatar
David Lawrence committed
550
	(memq function (symbol-value hook)))
551 552 553 554
      (set hook 
	   (if append
	       (nconc (symbol-value hook) (list function))
	     (cons function (symbol-value hook))))))
555

556 557 558 559
(defun remove-hook (hook function)
  "Remove from the value of HOOK the function FUNCTION.
HOOK should be a symbol, and FUNCTION may be any valid function.  If
FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
Richard M. Stallman's avatar
Richard M. Stallman committed
560
list of hooks to run in HOOK, then nothing is done.  See `add-hook'."
561 562 563 564 565 566 567
  (if (or (not (boundp hook))		;unbound symbol, or
	  (null (symbol-value hook))	;value is nil, or
	  (null function))		;function is nil, then
      nil				;Do nothing.
    (let ((hook-value (symbol-value hook)))
      (if (consp hook-value)
	  (setq hook-value (delete function hook-value))
568
	(if (equal hook-value function)
569 570
	    (setq hook-value nil)))
      (set hook hook-value))))
David Lawrence's avatar
David Lawrence committed
571

572 573 574 575 576
;;;; Specifying things to do after certain files are loaded.

(defun eval-after-load (file form)
  "Arrange that, if FILE is ever loaded, FORM will be run at that time.
This makes or adds to an entry on `after-load-alist'.
577
It does nothing if FORM is already on the list for FILE.
578 579 580
FILE should be the name of a library, with no directory name."
  (or (assoc file after-load-alist)
      (setq after-load-alist (cons (list file) after-load-alist)))
581 582 583
  (let ((elt (assoc file after-load-alist)))
    (or (member form (cdr elt))
	(nconc elt (list form))))
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
  form)

(defun eval-next-after-load (file)
  "Read the following input sexp, and run it whenever FILE is loaded.
This makes or adds to an entry on `after-load-alist'.
FILE should be the name of a library, with no directory name."
  (eval-after-load file (read)))


;;;; Input and display facilities.

(defun read-quoted-char (&optional prompt)
  "Like `read-char', except that if the first character read is an octal
digit, we read up to two more octal digits and return the character
represented by the octal number consisting of those digits.
Optional argument PROMPT specifies a string to use to prompt the user."
  (let ((count 0) (code 0) char)
    (while (< count 3)
      (let ((inhibit-quit (zerop count))
	    (help-form nil))
	(and prompt (message "%s-" prompt))
	(setq char (read-char))
	(if inhibit-quit (setq quit-flag nil)))
      (cond ((null char))
	    ((and (<= ?0 char) (<= char ?7))
	     (setq code (+ (* code 8) (- char ?0))
		   count (1+ count))
	     (and prompt (message (setq prompt
					(format "%s %c" prompt char)))))
	    ((> count 0)
	     (setq unread-command-events (list char) count 259))
	    (t (setq code char count 259))))
616 617 618
    ;; Turn a meta-character into a character with the 0200 bit set.
    (logior (if (/= (logand code (lsh 1 23)) 0) 128 0)
	    (logand 255 code))))
619 620 621

(defun force-mode-line-update (&optional all)
  "Force the mode-line of the current buffer to be redisplayed.
622
With optional non-nil ALL, force redisplay of all mode-lines."
623 624 625
  (if all (save-excursion (set-buffer (other-buffer))))
  (set-buffer-modified-p (buffer-modified-p)))

David Lawrence's avatar
David Lawrence committed
626 627 628 629 630 631 632 633 634
(defun momentary-string-display (string pos &optional exit-char message) 
  "Momentarily display STRING in the buffer at POS.
Display remains until next character is typed.
If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed;
otherwise it is then available as input (as a command if nothing else).
Display MESSAGE (optional fourth arg) in the echo area.
If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
  (or exit-char (setq exit-char ?\ ))
  (let ((buffer-read-only nil)
635 636
	;; Don't modify the undo list at all.
	(buffer-undo-list t)
David Lawrence's avatar
David Lawrence committed
637 638 639 640 641 642 643 644 645 646
	(modified (buffer-modified-p))
	(name buffer-file-name)
	insert-end)
    (unwind-protect
	(progn
	  (save-excursion
	    (goto-char pos)
	    ;; defeat file locking... don't try this at home, kids!
	    (setq buffer-file-name nil)
	    (insert-before-markers string)
647 648 649 650 651 652 653 654 655 656 657
	    (setq insert-end (point))
	    ;; If the message end is off screen, recenter now.
	    (if (> (window-end) insert-end)
		(recenter (/ (window-height) 2)))
	    ;; If that pushed message start off the screen,
	    ;; scroll to start it at the top of the screen.
	    (move-to-window-line 0)
	    (if (> (point) pos)
		(progn
		  (goto-char pos)
		  (recenter 0))))
David Lawrence's avatar
David Lawrence committed
658 659
	  (message (or message "Type %s to continue editing.")
		   (single-key-description exit-char))
660
	  (let ((char (read-event)))
David Lawrence's avatar
David Lawrence committed
661
	    (or (eq char exit-char)
Jim Blandy's avatar
Jim Blandy committed
662
		(setq unread-command-events (list char)))))
David Lawrence's avatar
David Lawrence committed
663 664 665 666 667 668
      (if insert-end
	  (save-excursion
	    (delete-region pos insert-end)))
      (setq buffer-file-name name)
      (set-buffer-modified-p modified))))

669 670 671 672

;;;; Miscellanea.

(defun ignore (&rest ignore) 
673
  (interactive)
674 675 676 677 678 679 680 681 682
  "Do nothing.
Accept any number of arguments, but ignore them."
  nil)

(defun error (&rest args)
  "Signal an error, making error message by passing all args to `format'."
  (while t
    (signal 'error (list (apply 'format args)))))

683
(defalias 'user-original-login-name 'user-login-name)
684

David Lawrence's avatar
David Lawrence committed
685 686 687 688 689 690 691 692 693 694 695
(defun start-process-shell-command (name buffer &rest args)
  "Start a program in a subprocess.  Return the process object for it.
Args are NAME BUFFER COMMAND &rest COMMAND-ARGS.
NAME is name for process.  It is modified if necessary to make it unique.
BUFFER is the buffer or (buffer-name) to associate with the process.
 Process output goes at end of that buffer, unless you specify
 an output stream or filter function to handle the output.
 BUFFER may be also nil, meaning that this process is not associated
 with any buffer
Third arg is command name, the name of a shell command.
Remaining arguments are the arguments for the command.
696
Wildcards and redirection are handled as usual in the shell."
David Lawrence's avatar
David Lawrence committed
697 698 699 700 701
  (if (eq system-type 'vax-vms)
      (apply 'start-process name buffer args)
    (start-process name buffer shell-file-name "-c"
		   (concat "exec " (mapconcat 'identity args " ")))))

702 703 704 705 706 707 708 709
(defmacro save-match-data (&rest body)
  "Execute the BODY forms, restoring the global value of the match data."
  (let ((original (make-symbol "match-data")))
    (list
     'let (list (list original '(match-data)))
     (list 'unwind-protect
           (cons 'progn body)
           (list 'store-match-data original)))))
Jim Blandy's avatar
Jim Blandy committed
710

711 712 713 714 715
(defun shell-quote-argument (argument)
  "Quote an argument for passing as argument to an inferior shell."
  ;; Quote everything except POSIX filename characters.
  ;; This should be safe enough even for really weird shells.
  (let ((result "") (start 0) end)
716
    (while (string-match "[^-0-9a-zA-Z_./]" argument start)
717 718 719 720 721 722
      (setq end (match-beginning 0)
	    result (concat result (substring argument start end)
			   "\\" (substring argument end (1+ end)))
	    start (1+ end)))
    (concat result (substring argument start))))

723
(defun make-syntax-table (&optional oldtable)
724 725 726
  "Return a new syntax table.
It inherits all letters and control characters from the standard
syntax table; other characters are copied from the standard syntax table."
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
  (if oldtable
      (copy-syntax-table oldtable)
    (let ((table (copy-syntax-table))
	  i)
      (setq i 0)
      (while (<= i 31)
	(aset table i 13)
	(setq i (1+ i)))
      (setq i ?A)
      (while (<= i ?Z)
	(aset table i 13)
	(setq i (1+ i)))
      (setq i ?a)
      (while (<= i ?z)
	(aset table i 13)
	(setq i (1+ i)))
      (setq i 128)
      (while (<= i 255)
	(aset table i 13)
	(setq i (1+ i)))
      table)))
748

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
;; now in fns.c
;(defun nth (n list)
;  "Returns the Nth element of LIST.
;N counts from zero.  If LIST is not that long, nil is returned."
;  (car (nthcdr n list)))
;
;(defun copy-alist (alist)
;  "Return a copy of ALIST.
;This is a new alist which represents the same mapping
;from objects to objects, but does not share the alist structure with ALIST.
;The objects mapped (cars and cdrs of elements of the alist)
;are shared, however."
;  (setq alist (copy-sequence alist))
;  (let ((tail alist))
;    (while tail
;      (if (consp (car tail))
;	  (setcar tail (cons (car (car tail)) (cdr (car tail)))))
;      (setq tail (cdr tail))))
;  alist)
Eric S. Raymond's avatar
Eric S. Raymond committed
768 769

;;; subr.el ends here
770