simple.el 145 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; simple.el --- basic editing commands for Emacs

3
;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 1998
4
;;        Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

;; 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
Eric S. Raymond's avatar
Eric S. Raymond committed
10
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18
;; 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
Erik Naggum's avatar
Erik Naggum committed
19 20 21
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
22

23 24 25 26 27
;;; Commentary:

;; A grab-bag of basic Emacs commands not specifically related to some
;; major mode or to file-handling.

Eric S. Raymond's avatar
Eric S. Raymond committed
28
;;; Code:
Jim Blandy's avatar
Jim Blandy committed
29

30 31 32 33 34 35 36 37 38 39 40 41 42 43
(defgroup killing nil
  "Killing and yanking commands"
  :group 'editing)

(defgroup fill-comments nil
  "Indenting and filling of comments."
  :prefix "comment-"
  :group 'fill)

(defgroup paren-matching nil
  "Highlight (un)matching of parens and expressions."
  :group 'matching)


44
(defun newline (&optional arg)
45
  "Insert a newline, and move to left margin of the new line if it's blank.
46 47 48 49
The newline is marked with the text-property `hard'.
With arg, insert that many newlines.
In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
  (interactive "*P")
50
  (barf-if-buffer-read-only)
51 52 53 54 55 56
  ;; Inserting a newline at the end of a line produces better redisplay in
  ;; try_window_id than inserting at the beginning of a line, and the textual
  ;; result is the same.  So, if we're at beginning of line, pretend to be at
  ;; the end of the previous line.
  (let ((flag (and (not (bobp)) 
		   (bolp)
57 58 59 60 61 62
		   ;; Make sure no functions want to be told about
		   ;; the range of the changes.
		   (not after-change-function)
		   (not before-change-function)
		   (not after-change-functions)
		   (not before-change-functions)
63 64
		   ;; Make sure there are no markers here.
		   (not (buffer-has-markers-at (1- (point))))
65 66 67 68 69 70
		   ;; Make sure no text properties want to know
		   ;; where the change was.
		   (not (get-char-property (1- (point)) 'modification-hooks))
		   (not (get-char-property (1- (point)) 'insert-behind-hooks))
		   (or (eobp)
		       (not (get-char-property (point) 'insert-in-front-hooks)))
71 72 73 74 75 76 77 78
		   ;; Make sure the newline before point isn't intangible.
		   (not (get-char-property (1- (point)) 'intangible))
		   ;; Make sure the newline before point isn't read-only.
		   (not (get-char-property (1- (point)) 'read-only))
		   ;; Make sure the newline before point isn't invisible.
		   (not (get-char-property (1- (point)) 'invisible))
		   ;; Make sure the newline before point has the same
		   ;; properties as the char before it (if any).
79
		   (< (or (previous-property-change (point)) -2) 
80 81 82 83
		      (- (point) 2))))
	(was-page-start (and (bolp)
			     (looking-at page-delimiter)))
	(beforepos (point)))
84 85 86 87 88
    (if flag (backward-char 1))
    ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
    ;; Set last-command-char to tell self-insert what to insert.
    (let ((last-command-char ?\n)
	  ;; Don't auto-fill if we have a numeric argument.
89 90 91
	  ;; Also not if flag is true (it would fill wrong line);
	  ;; there is no need to since we're at BOL.
	  (auto-fill-function (if (or arg flag) nil auto-fill-function)))
92 93 94 95 96 97
      (unwind-protect
	  (self-insert-command (prefix-numeric-value arg))
	;; If we get an error in self-insert-command, put point at right place.
	(if flag (forward-char 1))))
    ;; If we did *not* get an error, cancel that forward-char.
    (if flag (backward-char 1))
98 99
    ;; Mark the newline(s) `hard'.
    (if use-hard-newlines
100 101
	(set-hard-newline-properties 
	 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    ;; If the newline leaves the previous line blank,
    ;; and we have a left margin, delete that from the blank line.
    (or flag
	(save-excursion
	  (goto-char beforepos)
	  (beginning-of-line)
	  (and (looking-at "[ \t]$")
	       (> (current-left-margin) 0)
	       (delete-region (point) (progn (end-of-line) (point))))))
    (if flag (forward-char 1))
    ;; Indent the line after the newline, except in one case:
    ;; when we added the newline at the beginning of a line
    ;; which starts a page.
    (or was-page-start
	(move-to-left-margin nil t)))
117 118
  nil)

119 120 121 122 123 124 125 126
(defun set-hard-newline-properties (from to)
  (let ((sticky (get-text-property from 'rear-nonsticky)))
    (put-text-property from to 'hard 't)
    ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
    (if (and (listp sticky) (not (memq 'hard sticky)))
	(put-text-property from (point) 'rear-nonsticky
			   (cons 'hard sticky)))))

Jim Blandy's avatar
Jim Blandy committed
127
(defun open-line (arg)
128
  "Insert a newline and leave point before it.
129
If there is a fill prefix and/or a left-margin, insert them on the new line
130
if the line would have been blank.
131
With arg N, insert N newlines."
Jim Blandy's avatar
Jim Blandy committed
132
  (interactive "*p")
133
  (let* ((do-fill-prefix (and fill-prefix (bolp)))
134
	 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
135
	 (loc (point)))
136 137
    (newline arg)
    (goto-char loc)
138
    (while (> arg 0)
139 140 141 142
      (cond ((bolp)
	     (if do-left-margin (indent-to (current-left-margin)))
	     (if do-fill-prefix (insert-and-inherit fill-prefix))))
      (forward-line 1)
143
      (setq arg (1- arg)))
144 145
    (goto-char loc)
    (end-of-line)))
Jim Blandy's avatar
Jim Blandy committed
146 147 148 149 150 151 152

(defun split-line ()
  "Split current line, moving portion beyond point vertically down."
  (interactive "*")
  (skip-chars-forward " \t")
  (let ((col (current-column))
	(pos (point)))
153
    (newline 1)
Jim Blandy's avatar
Jim Blandy committed
154 155 156 157 158
    (indent-to col 0)
    (goto-char pos)))

(defun quoted-insert (arg)
  "Read next input character and insert it.
159
This is useful for inserting control characters.
160 161 162

If the first character you type after this command is an octal digit,
you should type a sequence of octal digits which specify a character code.
163
Any nondigit terminates the sequence.  If the terminator is a RET,
164
it is discarded; any other terminator is used itself as input.
165 166
The variable `read-quoted-char-radix' specifies the radix for this feature;
set it to 10 or 16 to use decimal or hex instead of octal.
167 168 169 170 171 172 173

In overwrite mode, this function inserts the character anyway, and
does not handle octal digits specially.  This means that if you use
overwrite as your normal editing mode, you can use this function to
insert characters when necessary.

In binary overwrite mode, this function does overwrite, and octal
174 175
digits are interpreted as a character code.  This is intended to be
useful for editing binary files."
Jim Blandy's avatar
Jim Blandy committed
176
  (interactive "*p")
177 178 179 180
  (let ((char (if (or (not overwrite-mode)
		      (eq overwrite-mode 'overwrite-mode-binary))
		  (read-quoted-char)
		(read-char))))
181 182 183 184 185 186 187
    ;; Assume character codes 0240 - 0377 stand for characters in some
    ;; single-byte character set, and convert them to Emacs
    ;; characters.
    (if (and enable-multibyte-characters
	     (>= char ?\240)
	     (<= char ?\377))
	(setq char (unibyte-char-to-multibyte char)))
188 189 190 191 192 193
    (if (> arg 0)
	(if (eq overwrite-mode 'overwrite-mode-binary)
	    (delete-char arg)))
    (while (> arg 0)
      (insert-and-inherit char)
      (setq arg (1- arg)))))
Jim Blandy's avatar
Jim Blandy committed
194 195 196

(defun delete-indentation (&optional arg)
  "Join this line to previous and fix up whitespace at join.
197
If there is a fill prefix, delete it from the beginning of this line.
Jim Blandy's avatar
Jim Blandy committed
198 199 200 201 202 203 204
With argument, join this line to following line."
  (interactive "*P")
  (beginning-of-line)
  (if arg (forward-line 1))
  (if (eq (preceding-char) ?\n)
      (progn
	(delete-region (point) (1- (point)))
205 206 207
	;; If the second line started with the fill prefix,
	;; delete the prefix.
	(if (and fill-prefix
208
		 (<= (+ (point) (length fill-prefix)) (point-max))
209 210 211 212
		 (string= fill-prefix
			  (buffer-substring (point)
					    (+ (point) (length fill-prefix)))))
	    (delete-region (point) (+ (point) (length fill-prefix))))
Jim Blandy's avatar
Jim Blandy committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
	(fixup-whitespace))))

(defun fixup-whitespace ()
  "Fixup white space between objects around point.
Leave one space or none, according to the context."
  (interactive "*")
  (save-excursion
    (delete-horizontal-space)
    (if (or (looking-at "^\\|\\s)")
	    (save-excursion (forward-char -1)
			    (looking-at "$\\|\\s(\\|\\s'")))
	nil
      (insert ?\ ))))

(defun delete-horizontal-space ()
  "Delete all spaces and tabs around point."
  (interactive "*")
  (skip-chars-backward " \t")
  (delete-region (point) (progn (skip-chars-forward " \t") (point))))

(defun just-one-space ()
  "Delete all spaces and tabs around point, leaving one space."
  (interactive "*")
  (skip-chars-backward " \t")
  (if (= (following-char) ? )
      (forward-char 1)
    (insert ? ))
  (delete-region (point) (progn (skip-chars-forward " \t") (point))))

(defun delete-blank-lines ()
  "On blank line, delete all surrounding blank lines, leaving just one.
On isolated blank line, delete that one.
245
On nonblank line, delete any immediately following blank lines."
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250
  (interactive "*")
  (let (thisblank singleblank)
    (save-excursion
      (beginning-of-line)
      (setq thisblank (looking-at "[ \t]*$"))
Jim Blandy's avatar
Jim Blandy committed
251
      ;; Set singleblank if there is just one blank line here.
Jim Blandy's avatar
Jim Blandy committed
252 253 254 255 256 257
      (setq singleblank
	    (and thisblank
		 (not (looking-at "[ \t]*\n[ \t]*$"))
		 (or (bobp)
		     (progn (forward-line -1)
			    (not (looking-at "[ \t]*$")))))))
Jim Blandy's avatar
Jim Blandy committed
258
    ;; Delete preceding blank lines, and this one too if it's the only one.
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262 263 264 265 266
    (if thisblank
	(progn
	  (beginning-of-line)
	  (if singleblank (forward-line 1))
	  (delete-region (point)
			 (if (re-search-backward "[^ \t\n]" nil t)
			     (progn (forward-line 1) (point))
			   (point-min)))))
Jim Blandy's avatar
Jim Blandy committed
267 268
    ;; Delete following blank lines, unless the current line is blank
    ;; and there are no following blank lines.
Jim Blandy's avatar
Jim Blandy committed
269 270 271 272 273 274 275
    (if (not (and thisblank singleblank))
	(save-excursion
	  (end-of-line)
	  (forward-line 1)
	  (delete-region (point)
			 (if (re-search-forward "[^ \t\n]" nil t)
			     (progn (beginning-of-line) (point))
Jim Blandy's avatar
Jim Blandy committed
276 277 278 279 280
			   (point-max)))))
    ;; Handle the special case where point is followed by newline and eob.
    ;; Delete the line, leaving point at eob.
    (if (looking-at "^[ \t]*\n\\'")
	(delete-region (point) (point-max)))))
Jim Blandy's avatar
Jim Blandy committed
281 282 283 284 285 286 287 288 289

(defun back-to-indentation ()
  "Move point to the first non-whitespace character on this line."
  (interactive)
  (beginning-of-line 1)
  (skip-chars-forward " \t"))

(defun newline-and-indent ()
  "Insert a newline, then indent according to major mode.
290
Indentation is done using the value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
291
In programming language modes, this is the same as TAB.
292
In some text modes, where TAB inserts a tab, this command indents to the
293
column specified by the function `current-left-margin'."
Jim Blandy's avatar
Jim Blandy committed
294 295
  (interactive "*")
  (delete-region (point) (progn (skip-chars-backward " \t") (point)))
Jim Blandy's avatar
Jim Blandy committed
296
  (newline)
Jim Blandy's avatar
Jim Blandy committed
297 298 299 300 301
  (indent-according-to-mode))

(defun reindent-then-newline-and-indent ()
  "Reindent current line, insert newline, then indent the new line.
Indentation of both lines is done according to the current major mode,
302
which means calling the current value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
303 304
In programming language modes, this is the same as TAB.
In some text modes, where TAB inserts a tab, this indents to the
305
column specified by the function `current-left-margin'."
Jim Blandy's avatar
Jim Blandy committed
306 307 308 309
  (interactive "*")
  (save-excursion
    (delete-region (point) (progn (skip-chars-backward " \t") (point)))
    (indent-according-to-mode))
Jim Blandy's avatar
Jim Blandy committed
310
  (newline)
Jim Blandy's avatar
Jim Blandy committed
311 312
  (indent-according-to-mode))

313 314 315 316
;; Internal subroutine of delete-char
(defun kill-forward-chars (arg)
  (if (listp arg) (setq arg (car arg)))
  (if (eq arg '-) (setq arg -1))
317
  (kill-region (point) (forward-point arg)))
318 319 320 321 322

;; Internal subroutine of backward-delete-char
(defun kill-backward-chars (arg)
  (if (listp arg) (setq arg (car arg)))
  (if (eq arg '-) (setq arg -1))
323
  (kill-region (point) (forward-point (- arg))))
324

325 326 327 328 329 330 331 332
(defcustom backward-delete-char-untabify-method 'untabify
  "*The method for untabifying when deleting backward.
Can be `untabify' -- turn a tab to many spaces, then delete one space.
       `hungry' -- delete all whitespace, both tabs and spaces.
       nil -- just delete one character."
  :type '(choice (const untabify) (const hungry) (const nil))
  :group 'killing)

Jim Blandy's avatar
Jim Blandy committed
333 334
(defun backward-delete-char-untabify (arg &optional killp)
  "Delete characters backward, changing tabs into spaces.
335
The exact behavior depends on `backward-delete-char-untabify-method'.
Jim Blandy's avatar
Jim Blandy committed
336 337
Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
Interactively, ARG is the prefix arg (default 1)
338
and KILLP is t if a prefix arg was specified."
Jim Blandy's avatar
Jim Blandy committed
339
  (interactive "*p\nP")
340
  (when (eq backward-delete-char-untabify-method 'untabify)
341 342 343 344 345 346 347 348 349 350 351
    (let ((count arg))
      (save-excursion
	(while (and (> count 0) (not (bobp)))
	  (if (= (preceding-char) ?\t)
	      (let ((col (current-column)))
		(forward-char -1)
		(setq col (- col (current-column)))
		(insert-char ?\ col)
		(delete-char 1)))
	  (forward-char -1)
	  (setq count (1- count))))))
352 353 354 355 356 357 358
  (delete-backward-char
   (if (eq backward-delete-char-untabify-method 'hungry)
       (let ((wh (- (point) (save-excursion (skip-chars-backward " \t")
					    (point)))))
	 (+ arg (if (zerop wh) 0 (1- wh))))
     arg)
   killp))
Jim Blandy's avatar
Jim Blandy committed
359 360 361 362 363 364 365 366 367 368 369 370

(defun zap-to-char (arg char)
  "Kill up to and including ARG'th occurrence of CHAR.
Goes backward if ARG is negative; error if CHAR not found."
  (interactive "p\ncZap to char: ")
  (kill-region (point) (progn
			 (search-forward (char-to-string char) nil nil arg)
;			 (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
			 (point))))

(defun beginning-of-buffer (&optional arg)
  "Move point to the beginning of the buffer; leave mark at previous position.
371 372 373 374
With arg N, put point N/10 of the way from the beginning.

If the buffer is narrowed, this command uses the beginning and size
of the accessible part of the buffer.
375 376

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
377 378 379
\(goto-char (point-min)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
380 381 382 383 384 385 386 387 388
  (let ((size (- (point-max) (point-min))))
    (goto-char (if arg
		   (+ (point-min)
		      (if (> size 10000)
			  ;; Avoid overflow for large buffer sizes!
			  (* (prefix-numeric-value arg)
			     (/ size 10))
			(/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
		 (point-min))))
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392
  (if arg (forward-line 1)))

(defun end-of-buffer (&optional arg)
  "Move point to the end of the buffer; leave mark at previous position.
393 394 395 396
With arg N, put point N/10 of the way from the end.

If the buffer is narrowed, this command uses the beginning and size
of the accessible part of the buffer.
397 398

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
399 400 401
\(goto-char (point-max)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
402 403 404 405 406 407 408 409 410
  (let ((size (- (point-max) (point-min))))
    (goto-char (if arg
		   (- (point-max)
		      (if (> size 10000)
			  ;; Avoid overflow for large buffer sizes!
			  (* (prefix-numeric-value arg)
			     (/ size 10))
			(/ (* size (prefix-numeric-value arg)) 10)))
		 (point-max))))
Eric S. Raymond's avatar
Eric S. Raymond committed
411 412
  ;; If we went to a place in the middle of the buffer,
  ;; adjust it to the beginning of a line.
Jim Blandy's avatar
Jim Blandy committed
413
  (if arg (forward-line 1)
Eric S. Raymond's avatar
Eric S. Raymond committed
414 415 416 417 418 419 420
    ;; If the end of the buffer is not already on the screen,
    ;; then scroll specially to put it near, but not at, the bottom.
    (if (let ((old-point (point)))
	  (save-excursion
		    (goto-char (window-start))
		    (vertical-motion (window-height))
		    (< (point) old-point)))
421 422 423
	(progn
	  (overlay-recenter (point))
	  (recenter -3)))))
Jim Blandy's avatar
Jim Blandy committed
424 425

(defun mark-whole-buffer ()
Jim Blandy's avatar
Jim Blandy committed
426 427 428 429
  "Put point at beginning and mark at end of buffer.
You probably should not use this function in Lisp programs;
it is usually a mistake for a Lisp function to use any subroutine
that uses or sets the mark."
Jim Blandy's avatar
Jim Blandy committed
430 431
  (interactive)
  (push-mark (point))
432
  (push-mark (point-max) nil t)
Jim Blandy's avatar
Jim Blandy committed
433 434 435
  (goto-char (point-min)))

(defun count-lines-region (start end)
436
  "Print number of lines and characters in the region."
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441
  (interactive "r")
  (message "Region has %d lines, %d characters"
	   (count-lines start end) (- end start)))

(defun what-line ()
442
  "Print the current buffer line number and narrowed line number of point."
Jim Blandy's avatar
Jim Blandy committed
443
  (interactive)
444
  (let ((opoint (point)) start)
Jim Blandy's avatar
Jim Blandy committed
445
    (save-excursion
446 447 448 449 450 451 452 453 454 455 456 457 458
      (save-restriction
	(goto-char (point-min))
	(widen)
	(beginning-of-line)
	(setq start (point))
	(goto-char opoint)
	(beginning-of-line)
	(if (/= start 1)
	    (message "line %d (narrowed line %d)"
		     (1+ (count-lines 1 (point)))
		     (1+ (count-lines start (point))))
	  (message "Line %d" (1+ (count-lines 1 (point)))))))))

Jim Blandy's avatar
Jim Blandy committed
459 460 461 462

(defun count-lines (start end)
  "Return number of lines between START and END.
This is usually the number of newlines between them,
463
but can be one more if START is not equal to END
Jim Blandy's avatar
Jim Blandy committed
464
and the greater of them is not at the start of a line."
465 466 467 468 469 470
  (save-excursion
    (save-restriction
      (narrow-to-region start end)
      (goto-char (point-min))
      (if (eq selective-display t)
	  (save-match-data
471 472 473 474 475
	    (let ((done 0))
	      (while (re-search-forward "[\n\C-m]" nil t 40)
		(setq done (+ 40 done)))
	      (while (re-search-forward "[\n\C-m]" nil t 1)
		(setq done (+ 1 done)))
476 477 478 479
	      (goto-char (point-max))
	      (if (and (/= start end)
		       (not (bolp)))
		  (1+ done)
480 481
		done)))
	(- (buffer-size) (forward-line (buffer-size)))))))
Jim Blandy's avatar
Jim Blandy committed
482

483 484 485 486
(defun what-cursor-position (&optional detail)
  "Print info on cursor position (on screen and within buffer).
With prefix argument, print detailed info of a character on cursor position."
  (interactive "P")
Jim Blandy's avatar
Jim Blandy committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
  (let* ((char (following-char))
	 (beg (point-min))
	 (end (point-max))
         (pos (point))
	 (total (buffer-size))
	 (percent (if (> total 50000)
		      ;; Avoid overflow from multiplying by 100!
		      (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
		    (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
	 (hscroll (if (= (window-hscroll) 0)
		      ""
		    (format " Hscroll=%d" (window-hscroll))))
	 (col (current-column)))
    (if (= pos end)
	(if (or (/= beg 1) (/= end (1+ total)))
	    (message "point=%d of %d(%d%%) <%d - %d>  column %d %s"
		     pos total percent beg end col hscroll)
	  (message "point=%d of %d(%d%%)  column %d %s"
		   pos total percent col hscroll))
506 507 508 509 510 511 512 513 514 515 516 517
      (let ((str (if detail (format " %s" (split-char char)) "")))
	(if (or (/= beg 1) (/= end (1+ total)))
	    (message "Char: %s (0%o, %d, 0x%x) %s point=%d of %d(%d%%) <%d - %d>  column %d %s"
		     (if (< char 256)
			 (single-key-description char)
		       (char-to-string char))
		     char char char str pos total percent beg end col hscroll)
	  (message "Char: %s (0%o, %d, 0x%x)%s point=%d of %d(%d%%)  column %d %s"
		   (if (< char 256)
		       (single-key-description char)
		     (char-to-string char))
		   char char char str pos total percent col hscroll))))))
Jim Blandy's avatar
Jim Blandy committed
518 519 520 521 522 523 524

(defun fundamental-mode ()
  "Major mode not specialized for anything in particular.
Other major modes are defined by comparison with this one."
  (interactive)
  (kill-all-local-variables))

525
(defvar read-expression-map (cons 'keymap minibuffer-local-map)
526 527 528
  "Minibuffer keymap used for reading Lisp expressions.")
(define-key read-expression-map "\M-\t" 'lisp-complete-symbol)

529 530 531
(defvar read-expression-history nil)

;; We define this, rather than making `eval' interactive,
Jim Blandy's avatar
Jim Blandy committed
532
;; for the sake of completion of names like eval-region, eval-current-buffer.
533 534
(defun eval-expression (eval-expression-arg
			&optional eval-expression-insert-value)
Jim Blandy's avatar
Jim Blandy committed
535
  "Evaluate EXPRESSION and print value in minibuffer.
536
Value is also consed on to front of the variable `values'."
537
  (interactive
538 539
   (list (read-from-minibuffer "Eval: "
			       nil read-expression-map t
540 541
			       'read-expression-history)
	 current-prefix-arg))
542
  (setq values (cons (eval eval-expression-arg) values))
543 544
  (prin1 (car values)
	 (if eval-expression-insert-value (current-buffer) t)))
Jim Blandy's avatar
Jim Blandy committed
545 546 547 548 549

(defun edit-and-eval-command (prompt command)
  "Prompting with PROMPT, let user edit COMMAND and eval result.
COMMAND is a Lisp expression.  Let user edit that expression in
the minibuffer, then read and evaluate the result."
550 551 552 553
  (let ((command (read-from-minibuffer prompt
				       (prin1-to-string command)
				       read-expression-map t
				       '(command-history . 1))))
554
    ;; If command was added to command-history as a string,
555
    ;; get rid of that.  We want only evaluable expressions there.
556 557 558 559 560 561 562
    (if (stringp (car command-history))
	(setq command-history (cdr command-history)))

    ;; If command to be redone does not match front of history,
    ;; add it to the history.
    (or (equal command (car command-history))
	(setq command-history (cons command command-history)))
Jim Blandy's avatar
Jim Blandy committed
563 564
    (eval command)))

565
(defun repeat-complex-command (arg)
Jim Blandy's avatar
Jim Blandy committed
566 567 568 569 570 571
  "Edit and re-evaluate last complex command, or ARGth from last.
A complex command is one which used the minibuffer.
The command is placed in the minibuffer as a Lisp form for editing.
The result is executed, repeating the command as changed.
If the command has been changed or is not the most recent previous command
it is added to the front of the command history.
572 573
You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
to get different commands to edit and resubmit."
Jim Blandy's avatar
Jim Blandy committed
574
  (interactive "p")
575
  (let ((elt (nth (1- arg) command-history))
Jim Blandy's avatar
Jim Blandy committed
576 577
	newcmd)
    (if elt
578
	(progn
579
	  (setq newcmd
580 581
		(let ((print-level nil)
		      (minibuffer-history-position arg)
582
		      (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
583 584 585
		  (read-from-minibuffer
		   "Redo: " (prin1-to-string elt) read-expression-map t
		   (cons 'command-history arg))))
586

587
	  ;; If command was added to command-history as a string,
588
	  ;; get rid of that.  We want only evaluable expressions there.
589 590 591 592 593 594 595
	  (if (stringp (car command-history))
	      (setq command-history (cdr command-history)))

	  ;; If command to be redone does not match front of history,
	  ;; add it to the history.
	  (or (equal newcmd (car command-history))
	      (setq command-history (cons newcmd command-history)))
Jim Blandy's avatar
Jim Blandy committed
596 597
	  (eval newcmd))
      (ding))))
598

599 600 601 602 603
(defvar minibuffer-history nil
  "Default minibuffer history list.
This is used for all minibuffer input
except when an alternate history list is specified.")
(defvar minibuffer-history-sexp-flag nil
604
  "Non-nil when doing history operations on `command-history'.
605
More generally, indicates that the history list being acted on
606 607 608
contains expressions rather than strings.
It is only valid if its value equals the current minibuffer depth,
to handle recursive uses of the minibuffer.")
609 610
(setq minibuffer-history-variable 'minibuffer-history)
(setq minibuffer-history-position nil)
611
(defvar minibuffer-history-search-history nil)
612

Jim Blandy's avatar
Jim Blandy committed
613
(mapcar
614 615 616 617 618 619 620 621 622 623
 (lambda (key-and-command)
   (mapcar
    (lambda (keymap-and-completionp)
      ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
      ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
      ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
      (define-key (symbol-value (car keymap-and-completionp))
	(car key-and-command)
	(let ((command (cdr key-and-command)))
	  (if (consp command)
624 625 626 627
	      ;; (and ... nil) => ... turns back on the completion-oriented
	      ;; history commands which rms turned off since they seem to
	      ;; do things he doesn't like.
	      (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
628
		  (progn (error "EMACS BUG!") (cdr command))
629 630 631 632 633 634 635
		(car command))
	    command))))
    '((minibuffer-local-map . nil)
      (minibuffer-local-ns-map . nil)
      (minibuffer-local-completion-map . t)
      (minibuffer-local-must-match-map . t)
      (read-expression-map . nil))))
636 637 638 639
 '(("\en" . (next-history-element . next-complete-history-element))
   ([next] . (next-history-element . next-complete-history-element))
   ("\ep" . (previous-history-element . previous-complete-history-element))
   ([prior] . (previous-history-element . previous-complete-history-element))
Jim Blandy's avatar
Jim Blandy committed
640 641
   ("\er" . previous-matching-history-element)
   ("\es" . next-matching-history-element)))
642

643 644 645 646 647 648 649 650 651 652
(defvar minibuffer-text-before-history nil
  "Text that was in this minibuffer before any history commands.
This is nil if there have not yet been any history commands
in this use of the minibuffer.")

(add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)

(defun minibuffer-history-initialize ()
  (setq minibuffer-text-before-history nil))

653
(defun previous-matching-history-element (regexp n)
654 655 656
  "Find the previous history element that matches REGEXP.
\(Previous history elements refer to earlier actions.)
With prefix argument N, search for Nth previous match.
657 658
If N is negative, find the next or Nth next match.
An uppercase letter in REGEXP makes the search case-sensitive."
659
  (interactive
660 661 662 663 664 665 666 667
   (let* ((enable-recursive-minibuffers t)
	  (regexp (read-from-minibuffer "Previous element matching (regexp): "
					nil
					minibuffer-local-map
					nil
					'minibuffer-history-search-history)))
     ;; Use the last regexp specified, by default, if input is empty.
     (list (if (string= regexp "")
668 669 670
	       (if minibuffer-history-search-history
		   (car minibuffer-history-search-history)
		 (error "No previous history search regexp"))
671
	     regexp)
672
	   (prefix-numeric-value current-prefix-arg))))
673 674 675
  (if (and (zerop minibuffer-history-position)
	   (null minibuffer-text-before-history))
      (setq minibuffer-text-before-history (buffer-string)))
676
  (let ((history (symbol-value minibuffer-history-variable))
677 678 679 680 681
	(case-fold-search
	 (if (isearch-no-upper-case-p regexp t)	; assume isearch.el is dumped
	     ;; Respect the user's setting for case-fold-search:
	     case-fold-search
	   nil))
682
	prevpos
683 684 685 686 687 688
	(pos minibuffer-history-position))
    (while (/= n 0)
      (setq prevpos pos)
      (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
      (if (= pos prevpos)
	  (error (if (= pos 1)
689 690
		     "No later matching history item"
		   "No earlier matching history item")))
691
      (if (string-match regexp
692 693
			(if (eq minibuffer-history-sexp-flag
				(minibuffer-depth))
694 695
			    (let ((print-level nil))
			      (prin1-to-string (nth (1- pos) history)))
696
			  (nth (1- pos) history)))
697
	  (setq n (+ n (if (< n 0) 1 -1)))))
698 699 700
    (setq minibuffer-history-position pos)
    (erase-buffer)
    (let ((elt (nth (1- pos) history)))
701
      (insert (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
702 703
		  (let ((print-level nil))
		    (prin1-to-string elt))
704
		elt)))
705 706 707 708
      (goto-char (point-min)))
  (if (or (eq (car (car command-history)) 'previous-matching-history-element)
	  (eq (car (car command-history)) 'next-matching-history-element))
      (setq command-history (cdr command-history))))
709 710

(defun next-matching-history-element (regexp n)
711 712 713
  "Find the next history element that matches REGEXP.
\(The next history element refers to a more recent action.)
With prefix argument N, search for Nth next match.
714 715
If N is negative, find the previous or Nth previous match.
An uppercase letter in REGEXP makes the search case-sensitive."
716
  (interactive
717 718 719 720 721 722 723 724 725 726 727
   (let* ((enable-recursive-minibuffers t)
	  (regexp (read-from-minibuffer "Next element matching (regexp): "
					nil
					minibuffer-local-map
					nil
					'minibuffer-history-search-history)))
     ;; Use the last regexp specified, by default, if input is empty.
     (list (if (string= regexp "")
	       (setcar minibuffer-history-search-history
		       (nth 1 minibuffer-history-search-history))
	     regexp)
728
	   (prefix-numeric-value current-prefix-arg))))
729
  (previous-matching-history-element regexp (- n)))
Jim Blandy's avatar
Jim Blandy committed
730

731 732
(defun next-history-element (n)
  "Insert the next element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
733
  (interactive "p")
734
  (or (zerop n)
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
      (let ((narg (- minibuffer-history-position n))
	    (minimum (if minibuffer-default -1 0))
	    elt)
	(if (and (zerop minibuffer-history-position)
		 (null minibuffer-text-before-history))
	    (setq minibuffer-text-before-history (buffer-string)))
	(if (< narg minimum)
	    (error "End of history; no next item"))
	(if (> narg (length (symbol-value minibuffer-history-variable)))
	    (error "Beginning of history; no preceding item"))
	(erase-buffer)
	(setq minibuffer-history-position narg)
	(cond ((= narg -1)
	       (setq elt minibuffer-default))
	      ((= narg 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
750
	       (setq elt (or minibuffer-text-before-history ""))
751 752 753 754
	       (setq minibuffer-text-before-history nil))
	      (t (setq elt (nth (1- minibuffer-history-position)
				(symbol-value minibuffer-history-variable)))))
	(insert
755
	 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
756 757 758 759
	     (let ((print-level nil))
	       (prin1-to-string elt))
	   elt))
	(goto-char (point-min)))))
Jim Blandy's avatar
Jim Blandy committed
760

761
(defun previous-history-element (n)
Richard M. Stallman's avatar
Richard M. Stallman committed
762
  "Inserts the previous element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
763
  (interactive "p")
764
  (next-history-element (- n)))
765 766

(defun next-complete-history-element (n)
767
  "Get next element of history which is a completion of minibuffer contents."
768
  (interactive "p")
769 770 771 772 773 774 775
  (let ((point-at-start (point)))
    (next-matching-history-element
     (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
    ;; next-matching-history-element always puts us at (point-min).
    ;; Move to the position we were at before changing the buffer contents.
    ;; This is still sensical, because the text before point has not changed.
    (goto-char point-at-start)))
776 777

(defun previous-complete-history-element (n)
778 779
  "\
Get previous element of history which is a completion of minibuffer contents."
780 781
  (interactive "p")
  (next-complete-history-element (- n)))
782

Jim Blandy's avatar
Jim Blandy committed
783 784 785
(defun goto-line (arg)
  "Goto line ARG, counting from line 1 at beginning of buffer."
  (interactive "NGoto line: ")
786
  (setq arg (prefix-numeric-value arg))
Jim Blandy's avatar
Jim Blandy committed
787 788 789 790 791 792 793 794
  (save-restriction
    (widen)
    (goto-char 1)
    (if (eq selective-display t)
	(re-search-forward "[\n\C-m]" nil 'end (1- arg))
      (forward-line (1- arg)))))

;Put this on C-x u, so we can force that rather than C-_ into startup msg
795
(defalias 'advertised-undo 'undo)
Jim Blandy's avatar
Jim Blandy committed
796 797 798 799

(defun undo (&optional arg)
  "Undo some previous changes.
Repeat this command to undo more changes.
800 801 802 803 804 805
A numeric argument serves as a repeat count.

Just C-u as argument requests selective undo,
limited to changes within the current region.
Likewise in Transient Mark mode when the mark is active."
  (interactive "*P")
806 807 808
  ;; If we don't get all the way thru, make last-command indicate that
  ;; for the following command.
  (setq this-command t)
809 810
  (let ((modified (buffer-modified-p))
	(recent-save (recent-auto-save-p)))
Jim Blandy's avatar
Jim Blandy committed
811 812
    (or (eq (selected-window) (minibuffer-window))
	(message "Undo!"))
Jim Blandy's avatar
Jim Blandy committed
813
    (or (eq last-command 'undo)
814 815 816
	(progn (if (or arg (and transient-mark-mode mark-active))
		   (undo-start (region-beginning) (region-end))
		 (undo-start))
Jim Blandy's avatar
Jim Blandy committed
817
	       (undo-more 1)))
818
    (undo-more (if arg (prefix-numeric-value arg) 1))
819 820 821 822 823 824 825 826 827 828
    ;; Don't specify a position in the undo record for the undo command.
    ;; Instead, undoing this should move point to where the change is.
    (let ((tail buffer-undo-list)
	  done)
      (while (and tail (not done) (not (null (car tail))))
	(if (integerp (car tail))
	    (progn
	      (setq done t)
	      (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
	(setq tail (cdr tail))))
Jim Blandy's avatar
Jim Blandy committed
829
    (and modified (not (buffer-modified-p))
830 831 832
	 (delete-auto-save-file-if-necessary recent-save)))
  ;; If we do get all the way thru, make this-command indicate that.
  (setq this-command 'undo))
Jim Blandy's avatar
Jim Blandy committed
833

834 835 836
(defvar pending-undo-list nil
  "Within a run of consecutive undo commands, list remaining to be undone.")

Jim Blandy's avatar
Jim Blandy committed
837 838
(defun undo-more (count)
  "Undo back N undo-boundaries beyond what was already undone recently.
839 840
Call `undo-start' to get ready to undo recent changes,
then call `undo-more' one or more times to undo them."
Jim Blandy's avatar
Jim Blandy committed
841 842 843 844
  (or pending-undo-list
      (error "No further undo information"))
  (setq pending-undo-list (primitive-undo count pending-undo-list)))

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
;; Deep copy of a list
(defun undo-copy-list (list)
  "Make a copy of undo list LIST."
  (mapcar 'undo-copy-list-1 list))

(defun undo-copy-list-1 (elt)
  (if (consp elt)
      (cons (car elt) (undo-copy-list-1 (cdr elt)))
    elt))

(defun undo-start (&optional beg end)
  "Set `pending-undo-list' to the front of the undo list.
The next call to `undo-more' will undo the most recently made change.
If BEG and END are specified, then only undo elements
that apply to text between BEG and END are used; other undo elements
are ignored.  If BEG and END are nil, all undo elements are used."
  (if (eq buffer-undo-list t)
      (error "No undo information in this buffer"))
  (setq pending-undo-list 
	(if (and beg end (not (= beg end)))
	    (undo-make-selective-list (min beg end) (max beg end))
	  buffer-undo-list)))

(defvar undo-adjusted-markers)

(defun undo-make-selective-list (start end)
  "Return a list of undo elements for the region START to END.
The elements come from `buffer-undo-list', but we keep only
the elements inside this region, and discard those outside this region.
If we find an element that crosses an edge of this region,
we stop and ignore all further elements."
  (let ((undo-list-copy (undo-copy-list buffer-undo-list))
	(undo-list (list nil))
	undo-adjusted-markers
	some-rejected
	undo-elt undo-elt temp-undo-list delta)
    (while undo-list-copy
      (setq undo-elt (car undo-list-copy))
      (let ((keep-this
	     (cond ((and (consp undo-elt) (eq (car undo-elt) t))
		    ;; This is a "was unmodified" element.
		    ;; Keep it if we have kept everything thus far.
		    (not some-rejected))
		   (t
		    (undo-elt-in-region undo-elt start end)))))
	(if keep-this
	    (progn
	      (setq end (+ end (cdr (undo-delta undo-elt))))
	      ;; Don't put two nils together in the list
	      (if (not (and (eq (car undo-list) nil)
			    (eq undo-elt nil)))
		  (setq undo-list (cons undo-elt undo-list))))
	  (if (undo-elt-crosses-region undo-elt start end)
	      (setq undo-list-copy nil)
	    (setq some-rejected t)
	    (setq temp-undo-list (cdr undo-list-copy))
	    (setq delta (undo-delta undo-elt))

	    (when (/= (cdr delta) 0)
	      (let ((position (car delta))
		    (offset (cdr delta)))

		;; Loop down the earlier events adjusting their buffer positions
		;; to reflect the fact that a change to the buffer isn't being
		;; undone. We only need to process those element types which
		;; undo-elt-in-region will return as being in the region since
		;; only those types can ever get into the output

		(while temp-undo-list
		  (setq undo-elt (car temp-undo-list))
		  (cond ((integerp undo-elt)
			 (if (>= undo-elt position)
			     (setcar temp-undo-list (- undo-elt offset))))
			((atom undo-elt) nil)
			((stringp (car undo-elt))
			 ;; (TEXT . POSITION)
			 (let ((text-pos (abs (cdr undo-elt)))
			       (point-at-end (< (cdr undo-elt) 0 )))
			   (if (>= text-pos position)
			       (setcdr undo-elt (* (if point-at-end -1 1) 
						   (- text-pos offset))))))
			((integerp (car undo-elt))
			 ;; (BEGIN . END)
			 (when (>= (car undo-elt) position)
			   (setcar undo-elt (- (car undo-elt) offset))
			   (setcdr undo-elt (- (cdr undo-elt) offset))))
			((null (car undo-elt))
			 ;; (nil PROPERTY VALUE BEG . END)
			 (let ((tail (nthcdr 3 undo-elt)))
			   (when (>= (car tail) position)
			     (setcar tail (- (car tail) offset))
			     (setcdr tail (- (cdr tail) offset))))))
		  (setq temp-undo-list (cdr temp-undo-list))))))))
      (setq undo-list-copy (cdr undo-list-copy)))
    (nreverse undo-list)))

(defun undo-elt-in-region (undo-elt start end)
  "Determine whether UNDO-ELT falls inside the region START ... END.
If it crosses the edge, we return nil."
  (cond ((integerp undo-elt)
	 (and (>= undo-elt start)
	      (<  undo-elt end)))
	((eq undo-elt nil)
	 t)
	((atom undo-elt)
	 nil)
	((stringp (car undo-elt))
	 ;; (TEXT . POSITION)
	 (and (>= (abs (cdr undo-elt)) start)
	      (< (abs (cdr undo-elt)) end)))
	((and (consp undo-elt) (markerp (car undo-elt)))
	 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
	 ;; See if MARKER is inside the region.
	 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
	   (unless alist-elt
	     (setq alist-elt (cons (car undo-elt)
				   (marker-position (car undo-elt))))
	     (setq undo-adjusted-markers
		   (cons alist-elt undo-adjusted-markers)))
	   (and (cdr alist-elt)
		(>= (cdr alist-elt) start)
		(< (cdr alist-elt) end))))
	((null (car undo-elt))
	 ;; (nil PROPERTY VALUE BEG . END)
	 (let ((tail (nthcdr 3 undo-elt)))
	   (and (>= (car tail) start)
		(< (cdr tail) end))))
	((integerp (car undo-elt))
	 ;; (BEGIN . END)
	 (and (>= (car undo-elt) start)
	      (< (cdr undo-elt) end)))))

(defun undo-elt-crosses-region (undo-elt start end)
  "Test whether UNDO-ELT crosses one edge of that region START ... END.
This assumes we have already decided that UNDO-ELT
is not *inside* the region START...END."
  (cond ((atom undo-elt) nil)
	((null (car undo-elt))
	 ;; (nil PROPERTY VALUE BEG . END)
	 (let ((tail (nthcdr 3 undo-elt)))
	   (not (or (< (car tail) end)
		    (> (cdr tail) start)))))
	((integerp (car undo-elt))
	 ;; (BEGIN . END)
	 (not (or (< (car undo-elt) end)
		  (> (cdr undo-elt) start))))))

;; Return the first affected buffer position and the delta for an undo element
;; delta is defined as the change in subsequent buffer positions if we *did*
;; the undo.
(defun undo-delta (undo-elt)
  (if (consp undo-elt)
      (cond ((stringp (car undo-elt))
	     ;; (TEXT . POSITION)
	     (cons (abs (cdr undo-elt)) (length (car undo-elt))))
	    ((integerp (car undo-elt))
	     ;; (BEGIN . END)
	     (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
	    (t
	     '(0 . 0)))
    '(0 . 0)))

1007 1008 1009
(defvar shell-command-history nil
  "History list for some commands that read shell commands.")

1010 1011 1012
(defvar shell-command-switch "-c"
  "Switch used to have the shell execute its command line argument.")

1013
(defun shell-command (command &optional output-buffer)
Jim Blandy's avatar
Jim Blandy committed
1014
  "Execute string COMMAND in inferior shell; display output, if any.
1015

Jim Blandy's avatar
Jim Blandy committed
1016
If COMMAND ends in ampersand, execute it asynchronously.
1017
The output appears in the buffer `*Async Shell Command*'.
1018
That buffer is in shell mode.
1019

1020 1021
Otherwise, COMMAND is executed synchronously.  The output appears in the
buffer `*Shell Command Output*'.
1022 1023 1024 1025 1026
If the output is one line, it is displayed in the echo area *as well*,
but it is nonetheless available in buffer `*Shell Command Output*',
even though that buffer is not automatically displayed.
If there is no output, or if output is inserted in the current buffer,
then `*Shell Command Output*' is deleted.
1027

1028 1029 1030 1031 1032 1033 1034
To specify a coding system for converting non-ASCII characters
in the shell command output, use \\[universal-coding-system-argument]
before this command.

Noninteractive callers can specify coding systems by binding
`coding-system-for-read' and `coding-system-for-write'.

1035 1036 1037 1038 1039 1040
The optional second argument OUTPUT-BUFFER, if non-nil,
says to put the output in some other buffer.
If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
If OUTPUT-BUFFER is not a buffer and not nil,
insert output in current buffer.  (This cannot be done asynchronously.)
In either case, the output is inserted after point (leaving mark after it)."
1041 1042 1043
  (interactive (list (read-from-minibuffer "Shell command: "
					   nil nil nil 'shell-command-history)
		     current-prefix-arg))
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
  ;; Look for a handler in case default-directory is a remote file name.
  (let ((handler
	 (find-file-name-handler (directory-file-name default-directory)
				 'shell-command)))
    (if handler
	(funcall handler 'shell-command command output-buffer)
      (if (and output-buffer
	       (not (or (bufferp output-buffer)  (stringp output-buffer))))
	  (progn (barf-if-buffer-read-only)
		 (push-mark)
		 ;; We do not use -f for csh; we will not support broken use of
		 ;; .cshrcs.  Even the BSD csh manual says to use
		 ;; "if ($?prompt) exit" before things which are not useful
		 ;; non-interactively.  Besides, if someone wants their other
		 ;; aliases for shell commands then they can still have them.
		 (call-process shell-file-name nil t nil
			       shell-command-switch command)
		 ;; This is like exchange-point-and-mark, but doesn't
		 ;; activate the mark.  It is cleaner to avoid activation,
		 ;; even though the command loop would deactivate the mark
		 ;; because we inserted text.
		 (goto-char (prog1 (mark t)
			      (set-marker (mark-marker) (point)
					  (current-buffer)))))
	;; Preserve the match data in case called from a program.
	(save-match-data
	  (if (string-match "[ \t]*&[ \t]*$" command)
	      ;; Command ending with ampersand means asynchronous.
	      (let ((buffer (get-buffer-create
			     (or output-buffer "*Async Shell Command*")))
		    (directory default-directory)
		    proc)
		;; Remove the ampersand.
		(setq command (substring command 0 (match-beginning 0)))
		;; If will kill a process, query first.
		(setq proc (get-buffer-process buffer))
		(if proc
		    (if (yes-or-no-p "A command is running.  Kill it? ")
			(kill-process proc)
		      (error "Shell command in progress")))
		(save-excursion
		  (set-buffer buffer)
		  (setq buffer-read-only nil)
		  (erase-buffer)
		  (display-buffer buffer)
		  (setq default-directory directory)
		  (setq proc (start-process "Shell" buffer shell-file-name 
					    shell-command-switch command))
		  (setq mode-line-process '(":%s"))
		  (require 'shell) (shell-mode)
		  (set-process-sentinel proc 'shell-command-sentinel)
		  ))
1096
	    (shell-command-on-region (point) (point) command output-buffer)
1097
	    ))))))
1098

Jim Blandy's avatar
Jim Blandy committed
1099 1100 1101
;; We have a sentinel to prevent insertion of a termination message
;; in the buffer itself.
(defun shell-command-sentinel (process signal)
1102 1103 1104 1105
  (if (memq (process-status process) '(exit signal))
      (message "%s: %s." 
	       (car (cdr (cdr (process-command process))))
	       (substring signal 0 -1))))
Jim Blandy's avatar
Jim Blandy committed
1106

1107
(defun shell-command-on-region (start end command
1108 1109
				      &optional output-buffer replace
				      error-buffer)
Jim Blandy's avatar
Jim Blandy committed
1110 1111 1112
  "Execute string COMMAND in inferior shell with region as input.
Normally display output (if any) in temp buffer `*Shell Command Output*';
Prefix arg means replace the region with it.
1113

1114 1115 1116 1117 1118 1119 1120
To specify a coding system for converting non-ASCII characters
in the input and output to the shell command, use \\[universal-coding-system-argument]
before this command.  By default, the input (from the current buffer)
is encoded in the same coding system that will be used to save the file,
`buffer-file-coding-system'.  If the output is going to replace the region,
then it is decoded from that same coding system.

1121 1122
The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER, REPLACE,
ERROR-BUFFER.  If REPLACE is non-nil, that means insert the output
1123
in place of text from START to END, putting point and mark around it.
1124 1125
Noninteractive callers can specify coding systems by binding
`coding-system-for-read' and `coding-system-for-write'.
Jim Blandy's avatar
Jim Blandy committed
1126 1127 1128

If the output is one line, it is displayed in the echo area,
but it is nonetheless available in buffer `*Shell Command Output*'
1129
even though that buffer is not automatically displayed.
1130
If there is no output, or if output is inserted in the current buffer,
1131
then `*Shell Command Output*' is deleted.
1132

1133 1134
If the optional fourth argument OUTPUT-BUFFER is non-nil,
that says to put the output in some other buffer.
1135 1136 1137
If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
If OUTPUT-BUFFER is not a buffer and not nil,
insert output in the current buffer.
1138 1139 1140 1141 1142
In either case, the output is inserted after point (leaving mark after it).

If optional fifth argument ERROR-BUFFER is non-nil, it is a buffer
or buffer name to which to direct the command's standard error output.
If it is nil, error output is mingled with regular output."
1143 1144 1145 1146 1147