simple.el 150 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, 98, 1999
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
		   (not (buffer-has-markers-at (point)))
66 67 68 69 70 71
		   ;; 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)))
72 73 74 75 76 77 78 79
		   ;; 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).
80
		   (< (or (previous-property-change (point)) -2) 
81 82 83 84
		      (- (point) 2))))
	(was-page-start (and (bolp)
			     (looking-at page-delimiter)))
	(beforepos (point)))
85 86 87 88 89
    (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.
90 91 92
	  ;; 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)))
93 94 95 96
      (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))))
97 98 99 100
    ;; Even if we did *not* get an error, keep that forward-char;
    ;; all further processing should apply to the newline that the user
    ;; thinks he inserted.

101 102
    ;; Mark the newline(s) `hard'.
    (if use-hard-newlines
103
	(set-hard-newline-properties
104
	 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
105 106 107 108 109 110 111 112 113 114 115 116 117 118
    ;; 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))))))
    ;; 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)))
119 120
  nil)

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

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

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

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.
165
Any nondigit terminates the sequence.  If the terminator is a RET,
166
it is discarded; any other terminator is used itself as input.
167 168
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.
169 170 171 172 173 174 175

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
176 177
digits are interpreted as a character code.  This is intended to be
useful for editing binary files."
Jim Blandy's avatar
Jim Blandy committed
178
  (interactive "*p")
179 180 181 182
  (let ((char (if (or (not overwrite-mode)
		      (eq overwrite-mode 'overwrite-mode-binary))
		  (read-quoted-char)
		(read-char))))
183 184 185 186 187 188 189
    ;; 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)))
190 191 192 193 194 195
    (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
196 197 198

(defun delete-indentation (&optional arg)
  "Join this line to previous and fix up whitespace at join.
199
If there is a fill prefix, delete it from the beginning of this line.
Jim Blandy's avatar
Jim Blandy committed
200 201 202 203 204 205 206
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)))
207 208 209
	;; If the second line started with the fill prefix,
	;; delete the prefix.
	(if (and fill-prefix
210
		 (<= (+ (point) (length fill-prefix)) (point-max))
211 212 213 214
		 (string= fill-prefix
			  (buffer-substring (point)
					    (+ (point) (length fill-prefix)))))
	    (delete-region (point) (+ (point) (length fill-prefix))))
Jim Blandy's avatar
Jim Blandy committed
215 216
	(fixup-whitespace))))

Dave Love's avatar
Dave Love committed
217 218
(defalias 'join-line #'delete-indentation) ; easier to find

Jim Blandy's avatar
Jim Blandy committed
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 245 246 247 248
(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.
249
On nonblank line, delete any immediately following blank lines."
Jim Blandy's avatar
Jim Blandy committed
250 251 252 253 254
  (interactive "*")
  (let (thisblank singleblank)
    (save-excursion
      (beginning-of-line)
      (setq thisblank (looking-at "[ \t]*$"))
Jim Blandy's avatar
Jim Blandy committed
255
      ;; Set singleblank if there is just one blank line here.
Jim Blandy's avatar
Jim Blandy committed
256 257 258 259 260 261
      (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
262
    ;; Delete preceding blank lines, and this one too if it's the only one.
Jim Blandy's avatar
Jim Blandy committed
263 264 265 266 267 268 269 270
    (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
271 272
    ;; Delete following blank lines, unless the current line is blank
    ;; and there are no following blank lines.
Jim Blandy's avatar
Jim Blandy committed
273 274 275 276 277 278 279
    (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
280 281 282 283 284
			   (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
285 286 287 288 289 290 291 292 293

(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.
294
Indentation is done using the value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
295
In programming language modes, this is the same as TAB.
296
In some text modes, where TAB inserts a tab, this command indents to the
297
column specified by the function `current-left-margin'."
Jim Blandy's avatar
Jim Blandy committed
298 299
  (interactive "*")
  (delete-region (point) (progn (skip-chars-backward " \t") (point)))
Jim Blandy's avatar
Jim Blandy committed
300
  (newline)
Jim Blandy's avatar
Jim Blandy committed
301 302 303 304 305
  (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,
306
which means calling the current value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
307 308
In programming language modes, this is the same as TAB.
In some text modes, where TAB inserts a tab, this indents to the
309
column specified by the function `current-left-margin'."
Jim Blandy's avatar
Jim Blandy committed
310 311 312 313
  (interactive "*")
  (save-excursion
    (delete-region (point) (progn (skip-chars-backward " \t") (point)))
    (indent-according-to-mode))
Jim Blandy's avatar
Jim Blandy committed
314
  (newline)
Jim Blandy's avatar
Jim Blandy committed
315 316
  (indent-according-to-mode))

317 318 319 320
;; Internal subroutine of delete-char
(defun kill-forward-chars (arg)
  (if (listp arg) (setq arg (car arg)))
  (if (eq arg '-) (setq arg -1))
321
  (kill-region (point) (forward-point arg)))
322 323 324 325 326

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

329 330 331 332 333 334 335 336
(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
337 338
(defun backward-delete-char-untabify (arg &optional killp)
  "Delete characters backward, changing tabs into spaces.
339
The exact behavior depends on `backward-delete-char-untabify-method'.
Jim Blandy's avatar
Jim Blandy committed
340 341
Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
Interactively, ARG is the prefix arg (default 1)
342
and KILLP is t if a prefix arg was specified."
Jim Blandy's avatar
Jim Blandy committed
343
  (interactive "*p\nP")
344
  (when (eq backward-delete-char-untabify-method 'untabify)
345 346 347 348 349 350 351 352 353 354 355
    (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))))))
356 357 358 359 360 361 362
  (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
363 364 365 366 367 368 369 370 371 372 373 374

(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.
375 376 377 378
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.
379 380

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
381 382 383
\(goto-char (point-min)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
384 385 386 387 388 389 390 391 392
  (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
393 394 395 396
  (if arg (forward-line 1)))

(defun end-of-buffer (&optional arg)
  "Move point to the end of the buffer; leave mark at previous position.
397 398 399 400
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.
401 402

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
403 404 405
\(goto-char (point-max)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
406 407 408 409 410 411 412 413 414
  (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
415 416
  ;; 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
417
  (if arg (forward-line 1)
Eric S. Raymond's avatar
Eric S. Raymond committed
418 419 420 421 422 423 424
    ;; 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)))
425 426 427
	(progn
	  (overlay-recenter (point))
	  (recenter -3)))))
Jim Blandy's avatar
Jim Blandy committed
428 429

(defun mark-whole-buffer ()
Jim Blandy's avatar
Jim Blandy committed
430 431 432 433
  "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
434 435
  (interactive)
  (push-mark (point))
436
  (push-mark (point-max) nil t)
Jim Blandy's avatar
Jim Blandy committed
437 438 439
  (goto-char (point-min)))

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

(defun what-line ()
446
  "Print the current buffer line number and narrowed line number of point."
Jim Blandy's avatar
Jim Blandy committed
447
  (interactive)
448
  (let ((opoint (point)) start)
Jim Blandy's avatar
Jim Blandy committed
449
    (save-excursion
450 451 452 453 454 455 456 457 458 459 460 461 462
      (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
463 464 465 466

(defun count-lines (start end)
  "Return number of lines between START and END.
This is usually the number of newlines between them,
467
but can be one more if START is not equal to END
Jim Blandy's avatar
Jim Blandy committed
468
and the greater of them is not at the start of a line."
469 470 471 472 473 474
  (save-excursion
    (save-restriction
      (narrow-to-region start end)
      (goto-char (point-min))
      (if (eq selective-display t)
	  (save-match-data
475 476 477 478 479
	    (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)))
480 481 482 483
	      (goto-char (point-max))
	      (if (and (/= start end)
		       (not (bolp)))
		  (1+ done)
484 485
		done)))
	(- (buffer-size) (forward-line (buffer-size)))))))
Jim Blandy's avatar
Jim Blandy committed
486

487 488
(defun what-cursor-position (&optional detail)
  "Print info on cursor position (on screen and within buffer).
489
Also describe the character after point, and give its character code
490 491 492 493 494 495 496
in octal, decimal and hex.

For a non-ASCII multibyte character, also give its encoding in the
buffer's selected coding system if the coding system encodes the
character safely.  If the character is encoded into one byte, that
code is shown in hex.  If the character is encoded into more than one
byte, just \"...\" is shown.
497

498 499
With prefix argument, print additional details about that character,
instead of the cursor position.  This includes the character set name,
500 501
the codes that identify the character within that character set.  In
addition, the encoding is fully shown."
502
  (interactive "P")
Jim Blandy's avatar
Jim Blandy committed
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
  (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))
522 523 524 525 526 527
      (let ((coding buffer-file-coding-system)
	    encoded encoding-msg)
	(if (or (not coding)
		(eq (coding-system-type coding) t))
	    (setq coding default-buffer-file-coding-system))
	(setq encoded (and (>= char 128) (encode-coding-char char coding)))
528
	(setq encoding-msg
529 530 531 532 533 534 535 536 537
	      (if encoded
		  (format "(0%o, %d, 0x%x, ext %s)"
			  char char char
			  (if (and (not detail)
				   (> (length encoded) 1))
			      "..."
			    (concat
			     (encoded-string-description encoded coding)
			     (if (cmpcharp char) "..." ""))))
538
		(format "(0%o, %d, 0x%x)" char char char)))
539
	(if detail
540
	    ;; We show the detailed information of CHAR.
541 542 543 544 545 546 547 548 549
	    (let ((internal
		   (if (cmpcharp char)
		       ;; For a composite character, we show the
		       ;; components only.
		       (concat "(composed \""
			       (decompose-composite-char char)
			       "\")")
		     (split-char char))))
	      (message "Char: %s %s %s"
550 551 552
		       (if (< char 256)
			   (single-key-description char)
			 (char-to-string char))
553
		       encoding-msg internal))
554 555 556 557 558 559 560
	  (if (or (/= beg 1) (/= end (1+ total)))
	      (message "Char: %s %s point=%d of %d(%d%%) <%d - %d>  column %d %s"
		       (if (< char 256)
			   (single-key-description char)
			 (char-to-string char))
		       encoding-msg pos total percent beg end col hscroll)
	    (message "Char: %s %s point=%d of %d(%d%%)  column %d %s"
561 562 563
		     (if (< char 256)
			 (single-key-description char)
		       (char-to-string char))
564
		     encoding-msg pos total percent col hscroll)))))))
Jim Blandy's avatar
Jim Blandy committed
565 566 567 568 569 570 571

(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))

572
(defvar read-expression-map (cons 'keymap minibuffer-local-map)
573 574 575
  "Minibuffer keymap used for reading Lisp expressions.")
(define-key read-expression-map "\M-\t" 'lisp-complete-symbol)

576 577 578
(defvar read-expression-history nil)

;; We define this, rather than making `eval' interactive,
Jim Blandy's avatar
Jim Blandy committed
579
;; for the sake of completion of names like eval-region, eval-current-buffer.
580 581
(defun eval-expression (eval-expression-arg
			&optional eval-expression-insert-value)
Jim Blandy's avatar
Jim Blandy committed
582
  "Evaluate EXPRESSION and print value in minibuffer.
583
Value is also consed on to front of the variable `values'."
584
  (interactive
585 586
   (list (read-from-minibuffer "Eval: "
			       nil read-expression-map t
587 588
			       'read-expression-history)
	 current-prefix-arg))
589
  (setq values (cons (eval eval-expression-arg) values))
590 591
  (prin1 (car values)
	 (if eval-expression-insert-value (current-buffer) t)))
Jim Blandy's avatar
Jim Blandy committed
592 593 594 595 596

(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."
597 598 599 600
  (let ((command (read-from-minibuffer prompt
				       (prin1-to-string command)
				       read-expression-map t
				       '(command-history . 1))))
601
    ;; If command was added to command-history as a string,
602
    ;; get rid of that.  We want only evaluable expressions there.
603 604 605 606 607 608 609
    (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
610 611
    (eval command)))

612
(defun repeat-complex-command (arg)
Jim Blandy's avatar
Jim Blandy committed
613 614 615 616 617 618
  "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.
619 620
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
621
  (interactive "p")
622
  (let ((elt (nth (1- arg) command-history))
Jim Blandy's avatar
Jim Blandy committed
623 624
	newcmd)
    (if elt
625
	(progn
626
	  (setq newcmd
627 628
		(let ((print-level nil)
		      (minibuffer-history-position arg)
629
		      (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
630 631 632
		  (read-from-minibuffer
		   "Redo: " (prin1-to-string elt) read-expression-map t
		   (cons 'command-history arg))))
633

634
	  ;; If command was added to command-history as a string,
635
	  ;; get rid of that.  We want only evaluable expressions there.
636 637 638 639 640 641 642
	  (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
643 644
	  (eval newcmd))
      (ding))))
645

646 647 648 649 650
(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
651
  "Non-nil when doing history operations on `command-history'.
652
More generally, indicates that the history list being acted on
653 654 655
contains expressions rather than strings.
It is only valid if its value equals the current minibuffer depth,
to handle recursive uses of the minibuffer.")
656 657
(setq minibuffer-history-variable 'minibuffer-history)
(setq minibuffer-history-position nil)
658
(defvar minibuffer-history-search-history nil)
659

Jim Blandy's avatar
Jim Blandy committed
660
(mapcar
661 662 663 664 665 666 667 668 669 670
 (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)
671 672 673 674
	      ;; (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
675
		  (progn (error "EMACS BUG!") (cdr command))
676 677 678 679 680 681 682
		(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))))
683 684 685 686
 '(("\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
687 688
   ("\er" . previous-matching-history-element)
   ("\es" . next-matching-history-element)))
689

690 691 692 693 694 695 696 697 698 699
(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))

700 701 702 703 704 705 706 707
(defcustom minibuffer-history-case-insensitive-variables nil
  "*Minibuffer history variables for which matching should ignore case.
If a history variable is a member of this list, then the
\\[previous-matching-history-element] and \\[next-matching-history-element]\
 commands ignore case when searching it, regardless of `case-fold-search'."
  :type '(repeat variable)
  :group 'minibuffer)

708
(defun previous-matching-history-element (regexp n)
709 710 711
  "Find the previous history element that matches REGEXP.
\(Previous history elements refer to earlier actions.)
With prefix argument N, search for Nth previous match.
712
If N is negative, find the next or Nth next match.
713 714
An uppercase letter in REGEXP makes the search case-sensitive.
See also `minibuffer-history-case-insensitive-variables'."
715
  (interactive
716 717 718 719 720 721 722 723
   (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 "")
724 725 726
	       (if minibuffer-history-search-history
		   (car minibuffer-history-search-history)
		 (error "No previous history search regexp"))
727
	     regexp)
728
	   (prefix-numeric-value current-prefix-arg))))
729 730 731
  (if (and (zerop minibuffer-history-position)
	   (null minibuffer-text-before-history))
      (setq minibuffer-text-before-history (buffer-string)))
732
  (let ((history (symbol-value minibuffer-history-variable))
733 734
	(case-fold-search
	 (if (isearch-no-upper-case-p regexp t)	; assume isearch.el is dumped
735 736 737 738 739 740
	     ;; On some systems, ignore case for file names.
	     (if (memq minibuffer-history-variable
		       minibuffer-history-case-insensitive-variables)
		 t
	       ;; Respect the user's setting for case-fold-search:
	       case-fold-search)
741
	   nil))
742
	prevpos
743 744 745 746 747 748
	(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)
749 750
		     "No later matching history item"
		   "No earlier matching history item")))
751
      (if (string-match regexp
752 753
			(if (eq minibuffer-history-sexp-flag
				(minibuffer-depth))
754 755
			    (let ((print-level nil))
			      (prin1-to-string (nth (1- pos) history)))
756
			  (nth (1- pos) history)))
757
	  (setq n (+ n (if (< n 0) 1 -1)))))
758 759 760
    (setq minibuffer-history-position pos)
    (erase-buffer)
    (let ((elt (nth (1- pos) history)))
761
      (insert (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
762 763
		  (let ((print-level nil))
		    (prin1-to-string elt))
764
		elt)))
765 766 767 768
      (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))))
769 770

(defun next-matching-history-element (regexp n)
771 772 773
  "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.
774 775
If N is negative, find the previous or Nth previous match.
An uppercase letter in REGEXP makes the search case-sensitive."
776
  (interactive
777 778 779 780 781 782 783 784 785 786 787
   (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)
788
	   (prefix-numeric-value current-prefix-arg))))
789
  (previous-matching-history-element regexp (- n)))
Jim Blandy's avatar
Jim Blandy committed
790

791 792
(defun next-history-element (n)
  "Insert the next element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
793
  (interactive "p")
794
  (or (zerop n)
795 796 797 798 799 800 801
      (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)
802 803 804
	    (if minibuffer-default
		(error "End of history; no next item")
	      (error "End of history; no default available")))
805 806 807 808 809 810 811
	(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
812
	       (setq elt (or minibuffer-text-before-history ""))
813 814 815 816
	       (setq minibuffer-text-before-history nil))
	      (t (setq elt (nth (1- minibuffer-history-position)
				(symbol-value minibuffer-history-variable)))))
	(insert
817
	 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
818 819 820 821
	     (let ((print-level nil))
	       (prin1-to-string elt))
	   elt))
	(goto-char (point-min)))))
Jim Blandy's avatar
Jim Blandy committed
822

823
(defun previous-history-element (n)
Richard M. Stallman's avatar
Richard M. Stallman committed
824
  "Inserts the previous element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
825
  (interactive "p")
826
  (next-history-element (- n)))
827 828

(defun next-complete-history-element (n)
829
  "Get next element of history which is a completion of minibuffer contents."
830
  (interactive "p")
831 832 833 834 835 836 837
  (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)))
838 839

(defun previous-complete-history-element (n)
840 841
  "\
Get previous element of history which is a completion of minibuffer contents."
842 843
  (interactive "p")
  (next-complete-history-element (- n)))
844

Jim Blandy's avatar
Jim Blandy committed
845 846 847
(defun goto-line (arg)
  "Goto line ARG, counting from line 1 at beginning of buffer."
  (interactive "NGoto line: ")
848
  (setq arg (prefix-numeric-value arg))
Jim Blandy's avatar
Jim Blandy committed
849 850 851 852 853 854 855 856
  (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
857
(defalias 'advertised-undo 'undo)
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861

(defun undo (&optional arg)
  "Undo some previous changes.
Repeat this command to undo more changes.
862 863 864 865 866 867
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")
868 869 870
  ;; If we don't get all the way thru, make last-command indicate that
  ;; for the following command.
  (setq this-command t)
871 872
  (let ((modified (buffer-modified-p))
	(recent-save (recent-auto-save-p)))
Jim Blandy's avatar
Jim Blandy committed
873 874
    (or (eq (selected-window) (minibuffer-window))
	(message "Undo!"))
Jim Blandy's avatar
Jim Blandy committed
875
    (or (eq last-command 'undo)
876 877 878
	(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
879
	       (undo-more 1)))
880
    (undo-more (if arg (prefix-numeric-value arg) 1))
881 882 883 884 885 886 887 888 889 890
    ;; 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
891
    (and modified (not (buffer-modified-p))
892 893 894
	 (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
895

896 897 898
(defvar pending-undo-list nil
  "Within a run of consecutive undo commands, list remaining to be undone.")

899 900 901 902
(defvar undo-in-progress nil
  "Non-nil while performing an undo.
Some change-hooks test this variable to do something different.")

Jim Blandy's avatar
Jim Blandy committed
903 904
(defun undo-more (count)
  "Undo back N undo-boundaries beyond what was already undone recently.
905 906
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
907 908
  (or pending-undo-list
      (error "No further undo information"))
909 910
  (let ((undo-in-progress t))
    (setq pending-undo-list (primitive-undo count pending-undo-list))))
Jim Blandy's avatar
Jim Blandy committed
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 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 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
;; 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)))

1074 1075 1076
(defvar shell-command-history nil
  "History list for some commands that read shell commands.")

1077 1078 1079
(defvar shell-command-switch "-c"
  "Switch used to have the shell execute its command line argument.")

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

Jim Blandy's avatar
Jim Blandy committed
1083
If COMMAND ends in ampersand, execute it asynchronously.
1084
The output appears in the buffer `*Async Shell Command*'.
1085
That buffer is in shell mode.
1086

1087 1088
Otherwise, COMMAND is executed synchronously.  The output appears in the
buffer `*Shell Command Output*'.
1089 1090 1091 1092 1093
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.
1094

1095 1096 1097 1098 1099 1100 1101
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'.

1102 1103 1104 1105 1106 1107
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)."
1108 1109 1110
  (interactive (list (read-from-minibuffer "Shell command: "
					   nil nil nil 'shell-command-history)
		     current-prefix-arg))
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
  ;; 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)
		  ))
1163
	    (shell-command-on-region (point) (point) command output-buffer)
1164
	    ))))))
1165

Jim Blandy's avatar
Jim Blandy committed
1166 1167 1168
;; We have a sentinel to prevent insertion of a termination message
;; in the buffer itself.
(defun shell-command-sentinel (process signal)
1169 1170 1171 1172
  (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
1173

1174 1175 1176 1177 1178 1179
(defvar shell-command-on-region-default-error-buffer nil
  "*Name of buffer that `shell-command-on-region' uses for stderr.
This buffer is used when `shell-command-on-region' is run interactively.
A nil value for this variable means that output to stderr and stdout
will be intermixed in the output stream.")

1180
(defun shell-command-on-region (start end command
1181 1182
				      &optional output-buffer replace
				      error-buffer)
Jim Blandy's avatar
Jim Blandy committed
1183 1184
  "Execute string COMMAND in inferior shell with region as input.
Normally display output (if any) in temp buffer `*Shell Command Output*';
1185 1186
Prefix arg means replace the region with it.  Return the exit code of
COMMAND.
1187

1188 1189 1190 1191 1192 1193 1194
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.

1195 1196 1197 1198
The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
REPLACE, ERROR-BUFFER.  Noninteractive callers can specify coding
systems by binding `coding-system-for-read' and
`coding-system-for-write'.
Jim Blandy's avatar
Jim Blandy committed
1199 1200 1201

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

1206 1207
If the optional fourth argument OUTPUT-BUFFER is non-nil,
that says to put the output in some other buffer.
1208 1209 1210
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.
1211 1212
In either case, the output is inserted after point (leaving mark after it).

1213 1214 1215 1216
If REPLACE, the optional fifth argument, is non-nil, that means insert
the output in place of text from START to END, putting point and mark
around it.

1217
If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1218
or buffer name to which to direct the command's standard error output.
1219 1220 1221 1222
If it is nil, error output is mingled with regular output.
In an interactive call, the variable
`shell-command-on-region-default-error-buffer' specifies the value
of ERROR-BUFFER."
1223 1224 1225 1226 1227 1228 1229
  (interactive (let ((string
		      ;; Do this before calling region-beginning
		      ;; and region-end, in case subprocess output
		      ;; relocates them while we are in the minibuffer.
		      (read-from-minibuffer "Shell command on region: "
					    nil nil nil
					    'shell-command-history)))
1230 1231 1232
		 ;; call-interactively recognizes region-beginning and
		 ;; region-end specially, leaving them in the history.
		 (list (region-beginning) (region-end)
1233 1234
		       string
		       current-prefix-arg
1235 1236
		       current-prefix-arg
		       shell-command-on-region-default-error-buffer)))
1237 1238 1239 1240
  (let ((error-file
	 (if error-buffer 
	     (concat (file-name-directory temp-file-name-pattern)
		     (make-temp-name "scor"))
1241 1242
	   nil))
	exit-status)
1243 1244
    (if (or replace
	    (and output-buffer
1245
		 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1246 1247 1248 1249 1250
	;; Replace specified region with output from command.
	(let ((swap (and replace (< start end))))
	  ;; Don't muck with mark unless REPLACE says we should.
	  (goto-char start)
	  (and replace (push-mark))
1251 1252 1253 1254 1255 1256
	  (setq exit-status
		(call-process-region start end shell-file-name t
				     (if error-file
					 (list t error-file)
				       t)
				     nil shell-command-switch command))
1257 1258 1259 1260 1261 1262 1263 1264 1265
	  (let ((shell-buffer (get-buffer "*Shell Command Output*")))
	    (and shell-buffer (not (eq shell-buffer (current-buffer)))
		 (kill-buffer shell-buffer)))
	  ;; Don't muck with mark unless REPLACE says we should.
	  (and replace swap (exchange-point-and-mark)))
      ;; No prefix argument: put the output in a temp buffer,
      ;; replacing its entire contents.
      (let ((buffer (get-buffer-create
		     (or output-buffer "*Shell Command Output*")))
1266
	    (success nil))