simple.el 94.8 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, 1986, 1987, 1993, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

;; This file is part of GNU Emacs.

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

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

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

21 22 23 24 25
;;; 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
26
;;; Code:
Jim Blandy's avatar
Jim Blandy committed
27 28

(defun open-line (arg)
29
  "Insert a newline and leave point before it.
30 31 32
If there is a fill prefix, insert the fill prefix on the new line
if the line would have been empty.
With arg N, insert N newlines."
Jim Blandy's avatar
Jim Blandy committed
33
  (interactive "*p")
34 35
  (let* ((do-fill-prefix (and fill-prefix (bolp)))
	 (flag (and (null do-fill-prefix) (bolp) (not (bobp)))))
36 37 38 39 40 41 42 43
    ;; If this is a simple case, and we are at the beginning of a line,
    ;; actually insert the newline *before* the preceding newline
    ;; instead of after.  That makes better display behavior.
    (if flag
	(progn
	  ;; If undo is enabled, don't let this hack be visible:
	  ;; record the real value of point as the place to move back to
	  ;; if we undo this insert.
44
	  (if (not (eq buffer-undo-list t))
45 46
	      (setq buffer-undo-list (cons (point) buffer-undo-list)))
	  (forward-char -1)))
47 48 49 50 51 52
    (save-excursion
      (while (> arg 0)
	(if do-fill-prefix (insert fill-prefix))
	(insert ?\n)
	(setq arg (1- arg))))
    (end-of-line)
Jim Blandy's avatar
Jim Blandy committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66
    (if flag (forward-char 1))))

(defun split-line ()
  "Split current line, moving portion beyond point vertically down."
  (interactive "*")
  (skip-chars-forward " \t")
  (let ((col (current-column))
	(pos (point)))
    (insert ?\n)
    (indent-to col 0)
    (goto-char pos)))

(defun quoted-insert (arg)
  "Read next input character and insert it.
67
This is useful for inserting control characters.
Jim Blandy's avatar
Jim Blandy committed
68
You may also type up to 3 octal digits, to insert a character with that code.
69 70 71 72 73 74 75 76 77

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
digits are interpreted as a character code.  This is supposed to make
this function useful in editing binary files."
Jim Blandy's avatar
Jim Blandy committed
78
  (interactive "*p")
79 80 81 82 83 84
  (let ((char (if (or (not overwrite-mode)
		      (eq overwrite-mode 'overwrite-mode-binary))
		  (read-quoted-char)
		(read-char))))
    (if (eq overwrite-mode 'overwrite-mode-binary)
	(delete-char arg))
85
    (insert-char char arg)))
Jim Blandy's avatar
Jim Blandy committed
86 87 88

(defun delete-indentation (&optional arg)
  "Join this line to previous and fix up whitespace at join.
89
If there is a fill prefix, delete it from the beginning of this line.
Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94 95 96
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)))
97 98 99
	;; If the second line started with the fill prefix,
	;; delete the prefix.
	(if (and fill-prefix
100
		 (<= (+ (point) (length fill-prefix)) (point-max))
101 102 103 104
		 (string= fill-prefix
			  (buffer-substring (point)
					    (+ (point) (length fill-prefix)))))
	    (delete-region (point) (+ (point) (length fill-prefix))))
Jim Blandy's avatar
Jim Blandy committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
	(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.
137
On nonblank line, delete any immediately following blank lines."
Jim Blandy's avatar
Jim Blandy committed
138 139 140 141 142
  (interactive "*")
  (let (thisblank singleblank)
    (save-excursion
      (beginning-of-line)
      (setq thisblank (looking-at "[ \t]*$"))
Jim Blandy's avatar
Jim Blandy committed
143
      ;; Set singleblank if there is just one blank line here.
Jim Blandy's avatar
Jim Blandy committed
144 145 146 147 148 149
      (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
150
    ;; Delete preceding blank lines, and this one too if it's the only one.
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156 157 158
    (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
159 160
    ;; Delete following blank lines, unless the current line is blank
    ;; and there are no following blank lines.
Jim Blandy's avatar
Jim Blandy committed
161 162 163 164 165 166 167
    (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
168 169 170 171 172
			   (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
173 174 175 176 177 178 179 180 181

(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.
182
Indentation is done using the value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
183
In programming language modes, this is the same as TAB.
184 185
In some text modes, where TAB inserts a tab, this command indents to the
column specified by the variable `left-margin'."
Jim Blandy's avatar
Jim Blandy committed
186 187
  (interactive "*")
  (delete-region (point) (progn (skip-chars-backward " \t") (point)))
Jim Blandy's avatar
Jim Blandy committed
188
  (newline)
Jim Blandy's avatar
Jim Blandy committed
189 190 191 192 193
  (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,
194
which means calling the current value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
195 196
In programming language modes, this is the same as TAB.
In some text modes, where TAB inserts a tab, this indents to the
197
column specified by the variable `left-margin'."
Jim Blandy's avatar
Jim Blandy committed
198 199 200 201
  (interactive "*")
  (save-excursion
    (delete-region (point) (progn (skip-chars-backward " \t") (point)))
    (indent-according-to-mode))
Jim Blandy's avatar
Jim Blandy committed
202
  (newline)
Jim Blandy's avatar
Jim Blandy committed
203 204
  (indent-according-to-mode))

205 206 207 208 209 210 211 212 213 214 215 216
;; Internal subroutine of delete-char
(defun kill-forward-chars (arg)
  (if (listp arg) (setq arg (car arg)))
  (if (eq arg '-) (setq arg -1))
  (kill-region (point) (+ (point) arg)))

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

Jim Blandy's avatar
Jim Blandy committed
217 218 219 220
(defun backward-delete-char-untabify (arg &optional killp)
  "Delete characters backward, changing tabs into spaces.
Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
Interactively, ARG is the prefix arg (default 1)
221
and KILLP is t if a prefix arg was specified."
Jim Blandy's avatar
Jim Blandy committed
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 249 250 251
  (interactive "*p\nP")
  (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)))))
  (delete-backward-char arg killp)
  ;; In overwrite mode, back over columns while clearing them out,
  ;; unless at end of line.
  (and overwrite-mode (not (eolp))
       (save-excursion (insert-char ?\  arg))))

(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.
With arg N, put point N/10 of the way from the true beginning.
252 253

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
\(goto-char (point-min)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
  (goto-char (if arg
		 (if (> (buffer-size) 10000)
		     ;; Avoid overflow for large buffer sizes!
		     (* (prefix-numeric-value arg)
			(/ (buffer-size) 10))
		   (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
	       (point-min)))
  (if arg (forward-line 1)))

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

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274 275 276 277 278 279 280 281
\(goto-char (point-max)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
  (goto-char (if arg
		 (- (1+ (buffer-size))
		    (if (> (buffer-size) 10000)
			;; Avoid overflow for large buffer sizes!
			(* (prefix-numeric-value arg)
			   (/ (buffer-size) 10))
		      (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
	       (point-max)))
Eric S. Raymond's avatar
Eric S. Raymond committed
282 283
  ;; 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
284
  (if arg (forward-line 1)
Eric S. Raymond's avatar
Eric S. Raymond committed
285 286 287 288 289 290 291
    ;; 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)))
292 293 294
	(progn
	  (overlay-recenter (point))
	  (recenter -3)))))
Jim Blandy's avatar
Jim Blandy committed
295 296

(defun mark-whole-buffer ()
Jim Blandy's avatar
Jim Blandy committed
297 298 299 300
  "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
301 302
  (interactive)
  (push-mark (point))
303
  (push-mark (point-max) nil t)
Jim Blandy's avatar
Jim Blandy committed
304 305 306
  (goto-char (point-min)))

(defun count-lines-region (start end)
307
  "Print number of lines and characters in the region."
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  (interactive "r")
  (message "Region has %d lines, %d characters"
	   (count-lines start end) (- end start)))

(defun what-line ()
  "Print the current line number (in the buffer) of point."
  (interactive)
  (save-restriction
    (widen)
    (save-excursion
      (beginning-of-line)
      (message "Line %d"
	       (1+ (count-lines 1 (point)))))))

(defun count-lines (start end)
  "Return number of lines between START and END.
This is usually the number of newlines between them,
325
but can be one more if START is not equal to END
Jim Blandy's avatar
Jim Blandy committed
326
and the greater of them is not at the start of a line."
327 328 329 330 331 332 333 334 335 336 337
  (save-match-data
    (save-excursion
      (save-restriction
	(narrow-to-region start end)
	(goto-char (point-min))
	(if (eq selective-display t)
	    (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)))
338 339 340 341 342
	      (goto-char (point-max))
	      (if (and (/= start end)
		       (not (bolp)))
		  (1+ done)
		done))
343
	  (- (buffer-size) (forward-line (buffer-size))))))))
Jim Blandy's avatar
Jim Blandy committed
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378

(defun what-cursor-position ()
  "Print info on cursor position (on screen and within buffer)."
  (interactive)
  (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))
      (if (or (/= beg 1) (/= end (1+ total)))
	  (message "Char: %s (0%o)  point=%d of %d(%d%%) <%d - %d>  column %d %s"
		   (single-key-description char) char pos total percent beg end col hscroll)
	(message "Char: %s (0%o)  point=%d of %d(%d%%)  column %d %s"
		 (single-key-description char) char pos total percent col hscroll)))))

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

379
(defvar read-expression-map (cons 'keymap minibuffer-local-map)
380 381 382
  "Minibuffer keymap used for reading Lisp expressions.")
(define-key read-expression-map "\M-\t" 'lisp-complete-symbol)

Jim Blandy's avatar
Jim Blandy committed
383 384
(put 'eval-expression 'disabled t)

385 386 387
(defvar read-expression-history nil)

;; We define this, rather than making `eval' interactive,
Jim Blandy's avatar
Jim Blandy committed
388 389 390
;; for the sake of completion of names like eval-region, eval-current-buffer.
(defun eval-expression (expression)
  "Evaluate EXPRESSION and print value in minibuffer.
391
Value is also consed on to front of the variable `values'."
392
  (interactive
393 394 395
   (list (read-from-minibuffer "Eval: "
			       nil read-expression-map t
			       'read-expression-history)))
Jim Blandy's avatar
Jim Blandy committed
396 397 398 399 400 401 402
  (setq values (cons (eval expression) values))
  (prin1 (car values) t))

(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."
403 404 405 406
  (let ((command (read-from-minibuffer prompt
				       (prin1-to-string command)
				       read-expression-map t
				       '(command-history . 1))))
Jim Blandy's avatar
Jim Blandy committed
407 408
    (eval command)))

409
(defun repeat-complex-command (arg)
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414 415
  "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.
416 417
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
418
  (interactive "p")
419
  (let ((elt (nth (1- arg) command-history))
420
	(minibuffer-history-position arg)
421
	(minibuffer-history-sexp-flag t)
Jim Blandy's avatar
Jim Blandy committed
422 423
	newcmd)
    (if elt
424
	(progn
425 426 427 428 429
	  (setq newcmd
		(read-from-minibuffer
		 "Redo: " (prin1-to-string elt) read-expression-map t
		 (cons 'command-history arg)))

430 431 432 433 434 435 436 437 438
	  ;; If command was added to command-history as a string,
	  ;; get rid of that.  We want only evallable expressions there.
	  (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
439 440
	  (eval newcmd))
      (ding))))
441

442 443 444 445 446
(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
447
  "Non-nil when doing history operations on `command-history'.
448 449
More generally, indicates that the history list being acted on
contains expressions rather than strings.")
450 451
(setq minibuffer-history-variable 'minibuffer-history)
(setq minibuffer-history-position nil)
452
(defvar minibuffer-history-search-history nil)
453

Jim Blandy's avatar
Jim Blandy committed
454
(mapcar
455 456 457 458 459 460 461 462 463 464
 (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)
465 466 467 468
	      ;; (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
469
		  (progn (error "EMACS BUG!") (cdr command))
470 471 472 473 474 475 476
		(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))))
477 478 479 480
 '(("\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
481 482
   ("\er" . previous-matching-history-element)
   ("\es" . next-matching-history-element)))
483 484

(defun previous-matching-history-element (regexp n)
485 486 487 488 489
  "Find the previous history element that matches REGEXP.
\(Previous history elements refer to earlier actions.)
With prefix argument N, search for Nth previous match.
If N is negative, find the next or Nth next match."
  (interactive
490 491 492 493 494 495 496 497 498 499 500 501
   (let* ((enable-recursive-minibuffers t)
	  (minibuffer-history-sexp-flag nil)
	  (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 "")
	       (setcar minibuffer-history-search-history
		       (nth 1 minibuffer-history-search-history))
	     regexp)
502
	   (prefix-numeric-value current-prefix-arg))))
503
  (let ((history (symbol-value minibuffer-history-variable))
504
	prevpos
505 506 507 508 509 510
	(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)
511 512
		     "No later matching history item"
		   "No earlier matching history item")))
513 514 515 516
      (if (string-match regexp
			(if minibuffer-history-sexp-flag
			    (prin1-to-string (nth (1- pos) history))
			  (nth (1- pos) history)))
517
	  (setq n (+ n (if (< n 0) 1 -1)))))
518 519 520 521 522 523
    (setq minibuffer-history-position pos)
    (erase-buffer)
    (let ((elt (nth (1- pos) history)))
      (insert (if minibuffer-history-sexp-flag
		  (prin1-to-string elt)
		elt)))
524 525 526 527
      (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))))
528 529

(defun next-matching-history-element (regexp n)
530 531 532 533 534
  "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.
If N is negative, find the previous or Nth previous match."
  (interactive
535 536 537 538 539 540 541 542 543 544 545 546
   (let* ((enable-recursive-minibuffers t)
	  (minibuffer-history-sexp-flag nil)
	  (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)
547
	   (prefix-numeric-value current-prefix-arg))))
548
  (previous-matching-history-element regexp (- n)))
Jim Blandy's avatar
Jim Blandy committed
549

550 551
(defun next-history-element (n)
  "Insert the next element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
552
  (interactive "p")
553 554 555 556
  (let ((narg (min (max 1 (- minibuffer-history-position n))
		   (length (symbol-value minibuffer-history-variable)))))
    (if (= minibuffer-history-position narg)
	(error (if (= minibuffer-history-position 1)
557 558
		   "End of history; no next item"
		 "Beginning of history; no preceding item"))
Jim Blandy's avatar
Jim Blandy committed
559
      (erase-buffer)
560
      (setq minibuffer-history-position narg)
561 562 563 564 565
      (let ((elt (nth (1- minibuffer-history-position)
		      (symbol-value minibuffer-history-variable))))
	(insert
	 (if minibuffer-history-sexp-flag
	     (prin1-to-string elt)
566
	   elt)))
Jim Blandy's avatar
Jim Blandy committed
567 568
      (goto-char (point-min)))))

569
(defun previous-history-element (n)
Richard M. Stallman's avatar
Richard M. Stallman committed
570
  "Inserts the previous element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
571
  (interactive "p")
572
  (next-history-element (- n)))
573 574

(defun next-complete-history-element (n)
575
  "Get next element of history which is a completion of minibuffer contents."
576
  (interactive "p")
577 578 579 580 581 582 583
  (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)))
584 585

(defun previous-complete-history-element (n)
586 587
  "\
Get previous element of history which is a completion of minibuffer contents."
588 589
  (interactive "p")
  (next-complete-history-element (- n)))
590

Jim Blandy's avatar
Jim Blandy committed
591 592 593 594 595 596 597 598 599 600 601
(defun goto-line (arg)
  "Goto line ARG, counting from line 1 at beginning of buffer."
  (interactive "NGoto line: ")
  (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
602
(define-function 'advertised-undo 'undo)
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606 607 608

(defun undo (&optional arg)
  "Undo some previous changes.
Repeat this command to undo more changes.
A numeric argument serves as a repeat count."
  (interactive "*p")
609 610 611
  ;; If we don't get all the way thru, make last-command indicate that
  ;; for the following command.
  (setq this-command t)
612 613
  (let ((modified (buffer-modified-p))
	(recent-save (recent-auto-save-p)))
Jim Blandy's avatar
Jim Blandy committed
614 615
    (or (eq (selected-window) (minibuffer-window))
	(message "Undo!"))
Jim Blandy's avatar
Jim Blandy committed
616 617 618 619
    (or (eq last-command 'undo)
	(progn (undo-start)
	       (undo-more 1)))
    (undo-more (or arg 1))
620 621 622 623 624 625 626 627 628 629
    ;; 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
630
    (and modified (not (buffer-modified-p))
631 632 633
	 (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
634

635 636 637
(defvar pending-undo-list nil
  "Within a run of consecutive undo commands, list remaining to be undone.")

Jim Blandy's avatar
Jim Blandy committed
638
(defun undo-start ()
639 640
  "Set `pending-undo-list' to the front of the undo list.
The next call to `undo-more' will undo the most recently made change."
Jim Blandy's avatar
Jim Blandy committed
641 642 643 644 645 646
  (if (eq buffer-undo-list t)
      (error "No undo information in this buffer"))
  (setq pending-undo-list buffer-undo-list))

(defun undo-more (count)
  "Undo back N undo-boundaries beyond what was already undone recently.
647 648
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
649 650 651 652
  (or pending-undo-list
      (error "No further undo information"))
  (setq pending-undo-list (primitive-undo count pending-undo-list)))

653 654 655
(defvar shell-command-history nil
  "History list for some commands that read shell commands.")

Jim Blandy's avatar
Jim Blandy committed
656 657 658 659 660 661 662
(defun shell-command (command &optional flag)
  "Execute string COMMAND in inferior shell; display output, if any.
If COMMAND ends in ampersand, execute it asynchronously.
 
Optional second arg non-nil (prefix arg, if interactive)
means insert output in current buffer after point (leave mark after it).
This cannot be done asynchronously."
663 664 665
  (interactive (list (read-from-minibuffer "Shell command: "
					   nil nil nil 'shell-command-history)
		     current-prefix-arg))
Jim Blandy's avatar
Jim Blandy committed
666 667 668 669 670 671 672 673 674 675
  (if flag
      (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
			   "-c" command)
676 677 678 679 680 681
	     ;; 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)))))
Jim Blandy's avatar
Jim Blandy committed
682 683 684 685 686
    ;; Preserve the match data in case called from a program.
    (let ((data (match-data)))
      (unwind-protect
	  (if (string-match "[ \t]*&[ \t]*$" command)
	      ;; Command ending with ampersand means asynchronous.
687
	      (let ((buffer (get-buffer-create "*Shell-Command*")) 
Jim Blandy's avatar
Jim Blandy committed
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
		    (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)
		  (erase-buffer)
		  (display-buffer buffer)
		  (setq default-directory directory)
		  (setq proc (start-process "Shell" buffer 
					    shell-file-name "-c" command))
705
		  (setq mode-line-process '(":%s"))
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709 710 711 712 713 714
		  (set-process-sentinel proc 'shell-command-sentinel)
		  (set-process-filter proc 'shell-command-filter)
		  ))
	    (shell-command-on-region (point) (point) command nil))
	(store-match-data data)))))

;; We have a sentinel to prevent insertion of a termination message
;; in the buffer itself.
(defun shell-command-sentinel (process signal)
715 716
  (if (and (memq (process-status process) '(exit signal))
	   (buffer-name (process-buffer process)))
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
      (progn
	(message "%s: %s." 
		 (car (cdr (cdr (process-command process))))
		 (substring signal 0 -1))
	(save-excursion
	  (set-buffer (process-buffer process))
	  (setq mode-line-process nil))
	(delete-process process))))

(defun shell-command-filter (proc string)
  ;; Do save-excursion by hand so that we can leave point numerically unchanged
  ;; despite an insertion immediately after it.
  (let* ((obuf (current-buffer))
	 (buffer (process-buffer proc))
	 opoint
	 (window (get-buffer-window buffer))
	 (pos (window-start window)))
    (unwind-protect
	(progn
	  (set-buffer buffer)
737 738
	  (or (= (point) (point-max))
	      (setq opoint (point)))
Jim Blandy's avatar
Jim Blandy committed
739 740 741 742 743
	  (goto-char (point-max))
	  (insert-before-markers string))
      ;; insert-before-markers moved this marker: set it back.
      (set-window-start window pos)
      ;; Finish our save-excursion.
744 745
      (if opoint
	  (goto-char opoint))
Jim Blandy's avatar
Jim Blandy committed
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
      (set-buffer obuf))))

(defun shell-command-on-region (start end command &optional flag interactive)
  "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.
Noninteractive args are START, END, COMMAND, FLAG.
Noninteractively FLAG means insert output in place of text from START to END,
and put point at the end, but don't alter the mark.

If the output is one line, it is displayed in the echo area,
but it is nonetheless available in buffer `*Shell Command Output*'
even though that buffer is not automatically displayed.  If there is no output
or output is inserted in the current buffer then `*Shell Command Output*' is
deleted." 
761
  (interactive (list (region-beginning) (region-end)
762 763
		     (read-from-minibuffer "Shell command on region: "
					   nil nil nil 'shell-command-history)
Jim Blandy's avatar
Jim Blandy committed
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
		     current-prefix-arg
		     (prefix-numeric-value current-prefix-arg)))
  (if flag
      ;; Replace specified region with output from command.
      (let ((swap (and interactive (< (point) (mark)))))
	;; Don't muck with mark
	;; unless called interactively.
	(and interactive (push-mark))
	(call-process-region start end shell-file-name t t nil
			     "-c" command)
	(if (get-buffer "*Shell Command Output*")
	    (kill-buffer "*Shell Command Output*"))
	(and interactive swap (exchange-point-and-mark)))
    ;; No prefix argument: put the output in a temp buffer,
    ;; replacing its entire contents.
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
    (let ((buffer (get-buffer-create "*Shell Command Output*"))
	  (success nil))
      (unwind-protect
	  (if (eq buffer (current-buffer))
	      ;; If the input is the same buffer as the output,
	      ;; delete everything but the specified region,
	      ;; then replace that region with the output.
	      (progn (delete-region end (point-max))
		     (delete-region (point-min) start)
		     (call-process-region (point-min) (point-max)
					  shell-file-name t t nil
					  "-c" command)
		     (setq success t))
	    ;; Clear the output buffer, then run the command with output there.
	    (save-excursion
	      (set-buffer buffer)
	      (erase-buffer))
	    (call-process-region start end shell-file-name
				 nil buffer nil
				 "-c" command)
	    (setq success t))
	;; Report the amount of output.
	(let ((lines (save-excursion
		       (set-buffer buffer)
		       (if (= (buffer-size) 0)
			   0
			 (count-lines (point-min) (point-max))))))
	  (cond ((= lines 0)
		 (if success
		     (message "(Shell command completed with no output)"))
		 (kill-buffer buffer))
		((and success (= lines 1))
		 (message "%s"
			  (save-excursion
			    (set-buffer buffer)
			    (goto-char (point-min))
			    (buffer-substring (point)
816
					      (progn (end-of-line) (point))))))
817 818
		(t 
		 (set-window-start (display-buffer buffer) 1))))))))
Jim Blandy's avatar
Jim Blandy committed
819 820 821 822 823 824 825 826 827

(defun universal-argument ()
  "Begin a numeric argument for the following command.
Digits or minus sign following \\[universal-argument] make up the numeric argument.
\\[universal-argument] following the digits or minus sign ends the argument.
\\[universal-argument] without digits or minus sign provides 4 as argument.
Repeating \\[universal-argument] without digits or minus sign
 multiplies the argument by 4 each time."
  (interactive nil)
Jim Blandy's avatar
Jim Blandy committed
828 829
  (let ((factor 4)
	key)
Jim Blandy's avatar
Jim Blandy committed
830 831
;;    (describe-arg (list factor) 1)
    (setq key (read-key-sequence nil t))
Jim Blandy's avatar
Jim Blandy committed
832 833
    (while (equal (key-binding key) 'universal-argument)
      (setq factor (* 4 factor))
Jim Blandy's avatar
Jim Blandy committed
834 835
;;      (describe-arg (list factor) 1)
      (setq key (read-key-sequence nil t)))
Jim Blandy's avatar
Jim Blandy committed
836 837 838
    (prefix-arg-internal key factor nil)))

(defun prefix-arg-internal (key factor value)
Jim Blandy's avatar
Jim Blandy committed
839 840 841 842 843
  (let ((sign 1))
    (if (and (numberp value) (< value 0))
	(setq sign -1 value (- value)))
    (if (eq value '-)
	(setq sign -1 value nil))
Jim Blandy's avatar
Jim Blandy committed
844
;;    (describe-arg value sign)
Jim Blandy's avatar
Jim Blandy committed
845 846
    (while (equal key "-")
      (setq sign (- sign) factor nil)
Jim Blandy's avatar
Jim Blandy committed
847 848
;;      (describe-arg value sign)
      (setq key (read-key-sequence nil t)))
Jim Blandy's avatar
Jim Blandy committed
849 850
    (while (and (stringp key)
		(= (length key) 1)
Jim Blandy's avatar
Jim Blandy committed
851 852 853 854 855
		(not (string< key "0"))
		(not (string< "9" key)))
      (setq value (+ (* (if (numberp value) value 0) 10)
		     (- (aref key 0) ?0))
	    factor nil)
Jim Blandy's avatar
Jim Blandy committed
856 857
;;      (describe-arg value sign)
      (setq key (read-key-sequence nil t)))
Jim Blandy's avatar
Jim Blandy committed
858
    (setq prefix-arg
Jim Blandy's avatar
Jim Blandy committed
859
	  (cond (factor (list factor))
Jim Blandy's avatar
Jim Blandy committed
860 861
		((numberp value) (* value sign))
		((= sign -1) '-)))
Jim Blandy's avatar
Jim Blandy committed
862 863 864 865 866
    ;; Calling universal-argument after digits
    ;; terminates the argument but is ignored.
    (if (eq (key-binding key) 'universal-argument)
	(progn
	  (describe-arg value sign)
Jim Blandy's avatar
Jim Blandy committed
867
	  (setq key (read-key-sequence nil t))))
868
    (setq unread-command-events (listify-key-sequence key))))
Jim Blandy's avatar
Jim Blandy committed
869 870 871 872 873 874 875 876

(defun describe-arg (value sign)
  (cond ((numberp value)
	 (message "Arg: %d" (* value sign)))
	((consp value)
	 (message "Arg: [%d]" (car value)))
	((< sign 0)
	 (message "Arg: -"))))
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880 881

(defun digit-argument (arg)
  "Part of the numeric argument for the next command.
\\[universal-argument] following digits or minus sign ends the argument."
  (interactive "P")
Jim Blandy's avatar
Jim Blandy committed
882 883
  (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
		       nil arg))
Jim Blandy's avatar
Jim Blandy committed
884 885 886 887 888

(defun negative-argument (arg)
  "Begin a negative numeric argument for the next command.
\\[universal-argument] following digits or minus sign ends the argument."
  (interactive "P")
Jim Blandy's avatar
Jim Blandy committed
889
  (prefix-arg-internal "-" nil arg))
Jim Blandy's avatar
Jim Blandy committed
890 891 892 893 894 895 896 897 898 899 900 901 902

(defun forward-to-indentation (arg)
  "Move forward ARG lines and position at first nonblank character."
  (interactive "p")
  (forward-line arg)
  (skip-chars-forward " \t"))

(defun backward-to-indentation (arg)
  "Move backward ARG lines and position at first nonblank character."
  (interactive "p")
  (forward-line (- arg))
  (skip-chars-forward " \t"))

903
(defvar kill-whole-line nil
904
  "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
905

Jim Blandy's avatar
Jim Blandy committed
906
(defun kill-line (&optional arg)
907
  "Kill the rest of the current line; if no nonblanks there, kill thru newline.
Jim Blandy's avatar
Jim Blandy committed
908 909 910 911
With prefix argument, kill that many lines from point.
Negative arguments kill lines backward.

When calling from a program, nil means \"no arg\",
912 913 914 915
a number counts as a prefix arg.

If `kill-whole-line' is non-nil, then kill the whole line
when given no argument at the beginning of a line."
Jim Blandy's avatar
Jim Blandy committed
916 917
  (interactive "P")
  (kill-region (point)
918 919 920 921 922 923
	       ;; It is better to move point to the other end of the kill
	       ;; before killing.  That way, in a read-only buffer, point
	       ;; moves across the text that is copied to the kill ring.
	       ;; The choice has no effect on undo now that undo records
	       ;; the value of point from before the command was run.
	       (progn
Jim Blandy's avatar
Jim Blandy committed
924 925 926 927
		 (if arg
		     (forward-line (prefix-numeric-value arg))
		   (if (eobp)
		       (signal 'end-of-buffer nil))
928
		   (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
Jim Blandy's avatar
Jim Blandy committed
929 930 931 932
		       (forward-line 1)
		     (end-of-line)))
		 (point))))

Jim Blandy's avatar
Jim Blandy committed
933 934 935 936 937 938
;;;; Window system cut and paste hooks.

(defvar interprogram-cut-function nil
  "Function to call to make a killed region available to other programs.

Most window systems provide some sort of facility for cutting and
939 940 941
pasting text between the windows of different programs.
This variable holds a function that Emacs calls whenever text
is put in the kill ring, to make the new kill available to other
Jim Blandy's avatar
Jim Blandy committed
942 943
programs.

944 945 946 947 948
The function takes one or two arguments.
The first argument, TEXT, is a string containing
the text which should be made available.
The second, PUSH, if non-nil means this is a \"new\" kill;
nil means appending to an \"old\" kill.")
Jim Blandy's avatar
Jim Blandy committed
949 950 951 952 953

(defvar interprogram-paste-function nil
  "Function to call to get text cut from other programs.

Most window systems provide some sort of facility for cutting and
954 955
pasting text between the windows of different programs.
This variable holds a function that Emacs calls to obtain
Jim Blandy's avatar
Jim Blandy committed
956 957 958 959 960
text that other programs have provided for pasting.

The function should be called with no arguments.  If the function
returns nil, then no other program has provided such text, and the top
of the Emacs kill ring should be used.  If the function returns a
Jim Blandy's avatar
Jim Blandy committed
961 962 963 964 965 966 967 968
string, that string should be put in the kill ring as the latest kill.

Note that the function should return a string only if a program other
than Emacs has provided a string for pasting; if Emacs provided the
most recent string, the function should return nil.  If it is
difficult to tell whether Emacs or some other program provided the
current string, it is probably good enough to return nil if the string
is equal (according to `string=') to the last text Emacs provided.")
Jim Blandy's avatar
Jim Blandy committed
969 970 971 972



;;;; The kill ring data structure.
Jim Blandy's avatar
Jim Blandy committed
973 974

(defvar kill-ring nil
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978 979 980 981 982
  "List of killed text sequences.
Since the kill ring is supposed to interact nicely with cut-and-paste
facilities offered by window systems, use of this variable should
interact nicely with `interprogram-cut-function' and
`interprogram-paste-function'.  The functions `kill-new',
`kill-append', and `current-kill' are supposed to implement this
interaction; you may want to use them instead of manipulating the kill
ring directly.")
Jim Blandy's avatar
Jim Blandy committed
983 984 985 986 987 988 989

(defconst kill-ring-max 30
  "*Maximum length of kill ring before oldest elements are thrown away.")

(defvar kill-ring-yank-pointer nil
  "The tail of the kill ring whose car is the last thing yanked.")

Jim Blandy's avatar
Jim Blandy committed
990 991 992 993 994 995 996 997 998
(defun kill-new (string)
  "Make STRING the latest kill in the kill ring.
Set the kill-ring-yank pointer to point to it.
If `interprogram-cut-function' is non-nil, apply it to STRING."
  (setq kill-ring (cons string kill-ring))
  (if (> (length kill-ring) kill-ring-max)
      (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))
  (setq kill-ring-yank-pointer kill-ring)
  (if interprogram-cut-function
999
      (funcall interprogram-cut-function string t)))
Jim Blandy's avatar
Jim Blandy committed
1000

Jim Blandy's avatar
Jim Blandy committed
1001
(defun kill-append (string before-p)
Jim Blandy's avatar
Jim Blandy committed
1002 1003
  "Append STRING to the end of the latest kill in the kill ring.
If BEFORE-P is non-nil, prepend STRING to the kill.
Richard M. Stallman's avatar
Richard M. Stallman committed
1004
If `interprogram-cut-function' is set, pass the resulting kill to
Jim Blandy's avatar
Jim Blandy committed
1005
it."
Jim Blandy's avatar
Jim Blandy committed
1006 1007 1008
  (setcar kill-ring
	  (if before-p
	      (concat string (car kill-ring))
Jim Blandy's avatar
Jim Blandy committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
	    (concat (car kill-ring) string)))
  (if interprogram-cut-function
      (funcall interprogram-cut-function (car kill-ring))))

(defun current-kill (n &optional do-not-move)
  "Rotate the yanking point by N places, and then return that kill.
If N is zero, `interprogram-paste-function' is set, and calling it
returns a string, then that string is added to the front of the
kill ring and returned as the latest kill.
If optional arg DO-NOT-MOVE is non-nil, then don't actually move the 
yanking point; just return the Nth kill forward."
  (let ((interprogram-paste (and (= n 0)
				 interprogram-paste-function
				 (funcall interprogram-paste-function))))
    (if interprogram-paste
	(progn
	  ;; Disable the interprogram cut function when we add the new
	  ;; text to the kill ring, so Emacs doesn't try to own the
	  ;; selection, with identical text.
	  (let ((interprogram-cut-function nil))
	    (kill-new interprogram-paste))
	  interprogram-paste)
      (or kill-ring (error "Kill ring is empty"))
1032 1033 1034 1035
      (let ((ARGth-kill-element
	     (nthcdr (mod (- n (length kill-ring-yank-pointer))
			  (length kill-ring))
		     kill-ring)))
Jim Blandy's avatar
Jim Blandy committed
1036 1037 1038
	(or do-not-move
	    (setq kill-ring-yank-pointer ARGth-kill-element))
	(car ARGth-kill-element)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
1039 1040


Jim Blandy's avatar
Jim Blandy committed
1041 1042

;;;; Commands for manipulating the kill ring.
Eric S. Raymond's avatar
Eric S. Raymond committed
1043

1044 1045 1046
(defvar kill-read-only-ok nil
  "*Non-nil means don't signal an error for killing read-only text.")

Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049 1050 1051
(defun kill-region (beg end)
  "Kill between point and mark.
The text is deleted but saved in the kill ring.
The command \\[yank] can retrieve it from there.
\(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1052 1053 1054
If the buffer is read-only, Emacs will beep and refrain from deleting
the text, but put the text in the kill ring anyway.  This means that
you can use the killing commands to copy text from a read-only buffer.
Jim Blandy's avatar
Jim Blandy committed
1055 1056 1057 1058 1059 1060 1061 1062

This is the primitive for programs to kill text (as opposed to deleting it).
Supply two arguments, character numbers indicating the stretch of text
 to be killed.
Any command that calls this function is a \"kill command\".
If the previous command was also a kill command,
the text killed this time appends to the text killed last time
to make one entry in the kill ring."
1063
  (interactive "r")
Jim Blandy's avatar
Jim Blandy committed
1064
  (cond
1065 1066 1067 1068

   ;; If the buffer is read-only, we should beep, in case the person
   ;; just isn't aware of this.  However, there's no harm in putting
   ;; the region's text in the kill ring, anyway.
1069 1070
   ((or (and buffer-read-only (not inhibit-read-only))
	(text-property-not-all beg end 'read-only nil))
1071
    (copy-region-as-kill beg end)
1072
    ;; This should always barf, and give us the correct error.
1073 1074 1075
    (if kill-read-only-ok
	(message "Read only text copied to kill ring")
      (barf-if-buffer-read-only)))
1076 1077 1078

   ;; In certain cases, we can arrange for the undo list and the kill
   ;; ring to share the same string object.  This code does that.
Jim Blandy's avatar
Jim Blandy committed
1079 1080
   ((not (or (eq buffer-undo-list t)
	     (eq last-command 'kill-region)
1081
	     (equal beg end)))
Jim Blandy's avatar
Jim Blandy committed
1082
    ;; Don't let the undo list be truncated before we can even access it.
1083 1084 1085
    (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
	  (old-list buffer-undo-list)
	  tail)
Jim Blandy's avatar
Jim Blandy committed
1086
      (delete-region beg end)
1087 1088 1089 1090 1091
      ;; Search back in buffer-undo-list for this string,
      ;; in case a change hook made property changes.
      (setq tail buffer-undo-list)
      (while (not (stringp (car (car tail))))
	(setq tail (cdr tail)))
Jim Blandy's avatar
Jim Blandy committed
1092 1093
      ;; Take the same string recorded for undo
      ;; and put it in the kill-ring.
1094
      (kill-new (car (car tail)))
Jim Blandy's avatar
Jim Blandy committed
1095
      (setq this-command 'kill-region)))
1096

Jim Blandy's avatar
Jim Blandy committed
1097
   (t
Jim Blandy's avatar
Jim Blandy committed
1098
    (copy-region-as-kill beg end)
Jim Blandy's avatar
Jim Blandy committed
1099
    (delete-region beg end))))
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102

(defun copy-region-as-kill (beg end)
  "Save the region as if killed, but don't kill it.
Jim Blandy's avatar
Jim Blandy committed
1103 1104
If `interprogram-cut-function' is non-nil, also save the text for a window
system cut and paste."
Jim Blandy's avatar
Jim Blandy committed
1105 1106 1107
  (interactive "r")
  (if (eq last-command 'kill-region)
      (kill-append (buffer-substring beg end) (< end beg))
Jim Blandy's avatar
Jim Blandy committed
1108 1109
    (kill-new (buffer-substring beg end)))
  (setq this-command 'kill-region)
Jim Blandy's avatar
Jim Blandy committed
1110 1111 1112
  nil)

(defun kill-ring-save (beg end)
1113
  "Save the region as if killed, but don't kill it.
1114
This command is similar to `copy-region-as-kill', except that it gives
1115 1116 1117
visual feedback indicating the extent of the region being copied.
If `interprogram-cut-function' is non-nil, also save the text for a window
system cut and paste."
Jim Blandy's avatar
Jim Blandy committed
1118 1119
  (interactive "r")
  (copy-region-as-kill beg end)
Eric S. Raymond's avatar
Eric S. Raymond committed
1120
  (if (interactive-p)
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
      (let ((other-end (if (= (point) beg) end beg))
	    (opoint (point))
	    ;; Inhibit quitting so we can make a quit here
	    ;; look like a C-g typed as a command.
	    (inhibit-quit t))
	(if (pos-visible-in-window-p other-end (selected-window))
	    (progn
	      ;; Swap point and mark.
	      (set-marker (mark-marker) (point) (current-buffer))
	      (goto-char other-end)
	      (sit-for 1)
	      ;; Swap back.
	      (set-marker (mark-marker) other-end (current-buffer))
	      (goto-char opoint)
	      ;; If user quit, deactivate the mark
	      ;; as C-g would as a command.
1137
	      (and quit-flag mark-active
1138
		   (deactivate-mark)))
1139 1140 1141 1142 1143 1144 1145 1146
	  (let* ((killed-text (current-kill 0))
		 (message-len (min (length killed-text) 40)))
	    (if (= (point) beg)
		;; Don't say "killed"; that is misleading.
		(message "Saved text until \"%s\""
			(substring killed-text (- message-len)))
	      (message "Saved text from \"%s\""
		      (substring killed-text 0 message-len))))))))
Jim Blandy's avatar
Jim Blandy committed
1147 1148

(defun append-next-kill ()
1149
  "Cause following command, if it kills, to append to previous kill."
Jim Blandy's avatar
Jim Blandy committed
1150 1151 1152 1153 1154 1155 1156 1157
  (interactive)
  (if (interactive-p)
      (progn
	(setq this-command 'kill-region)
	(message "If the next command is a kill, it will append"))
    (setq last-command 'kill-region)))

(defun yank-pop (arg)
1158 1159
  "Replace just-yanked stretch of killed text with a different stretch.
This command is allowed only immediately after a `yank' or a `yank-pop'.
Jim Blandy's avatar
Jim Blandy committed
1160
At such a time, the region contains a stretch of reinserted
1161
previously-killed text.  `yank-pop' deletes that text and inserts in its
Jim Blandy's avatar
Jim Blandy committed
1162 1163 1164
place a different stretch of killed text.

With no argument, the previous kill is inserted.
1165 1166
With argument N, insert the Nth previous kill.
If N is negative, this is a more recent kill.
Jim Blandy's avatar
Jim Blandy committed
1167 1168 1169 1170 1171 1172 1173

The sequence o