simple.el 104 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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
(defun newline (&optional arg)
  "Insert a newline and move to left margin of the new line.
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")
  ;; 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)
		   (< (or (previous-property-change (point)) -2) 
		      (- (point) 2)))))
    (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.
	  (auto-fill-function (if arg nil auto-fill-function)))
      (self-insert-command (prefix-numeric-value arg)))
    ;; Mark the newline(s) `hard'.
    (if use-hard-newlines
	(let* ((from (- (point) (if arg (prefix-numeric-value arg) 1)))
	       (sticky (get-text-property from 'rear-nonsticky)))
	  (put-text-property from (point) '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)))))
    (if flag (forward-char 1)))
  (move-to-left-margin nil t)
  nil)

Jim Blandy's avatar
Jim Blandy committed
62
(defun open-line (arg)
63
  "Insert a newline and leave point before it.
64
If there is a fill prefix and/or a left-margin, insert them on the new line
65 66
if the line would have been empty.
With arg N, insert N newlines."
Jim Blandy's avatar
Jim Blandy committed
67
  (interactive "*p")
68
  (let* ((do-fill-prefix (and fill-prefix (bolp)))
69
	 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
70 71
	 (loc (point)))
    (while (> arg 0)
72
      (if do-left-margin (indent-to (current-left-margin)))
73
      (if do-fill-prefix (insert-and-inherit fill-prefix))
74 75 76 77
      (newline 1)
      (setq arg (1- arg)))
    (goto-char loc))
  (end-of-line))
Jim Blandy's avatar
Jim Blandy committed
78 79 80 81 82 83 84

(defun split-line ()
  "Split current line, moving portion beyond point vertically down."
  (interactive "*")
  (skip-chars-forward " \t")
  (let ((col (current-column))
	(pos (point)))
85
    (newline 1)
Jim Blandy's avatar
Jim Blandy committed
86 87 88 89 90
    (indent-to col 0)
    (goto-char pos)))

(defun quoted-insert (arg)
  "Read next input character and insert it.
91
This is useful for inserting control characters.
Jim Blandy's avatar
Jim Blandy committed
92
You may also type up to 3 octal digits, to insert a character with that code.
93 94 95 96 97 98 99 100 101

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
102
  (interactive "*p")
103 104 105 106
  (let ((char (if (or (not overwrite-mode)
		      (eq overwrite-mode 'overwrite-mode-binary))
		  (read-quoted-char)
		(read-char))))
107 108 109 110 111 112
    (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
113 114 115

(defun delete-indentation (&optional arg)
  "Join this line to previous and fix up whitespace at join.
116
If there is a fill prefix, delete it from the beginning of this line.
Jim Blandy's avatar
Jim Blandy committed
117 118 119 120 121 122 123
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)))
124 125 126
	;; If the second line started with the fill prefix,
	;; delete the prefix.
	(if (and fill-prefix
127
		 (<= (+ (point) (length fill-prefix)) (point-max))
128 129 130 131
		 (string= fill-prefix
			  (buffer-substring (point)
					    (+ (point) (length fill-prefix)))))
	    (delete-region (point) (+ (point) (length fill-prefix))))
Jim Blandy's avatar
Jim Blandy committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
	(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.
164
On nonblank line, delete any immediately following blank lines."
Jim Blandy's avatar
Jim Blandy committed
165 166 167 168 169
  (interactive "*")
  (let (thisblank singleblank)
    (save-excursion
      (beginning-of-line)
      (setq thisblank (looking-at "[ \t]*$"))
Jim Blandy's avatar
Jim Blandy committed
170
      ;; Set singleblank if there is just one blank line here.
Jim Blandy's avatar
Jim Blandy committed
171 172 173 174 175 176
      (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
177
    ;; Delete preceding blank lines, and this one too if it's the only one.
Jim Blandy's avatar
Jim Blandy committed
178 179 180 181 182 183 184 185
    (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
186 187
    ;; Delete following blank lines, unless the current line is blank
    ;; and there are no following blank lines.
Jim Blandy's avatar
Jim Blandy committed
188 189 190 191 192 193 194
    (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
195 196 197 198 199
			   (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
200 201 202 203 204 205 206 207 208

(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.
209
Indentation is done using the value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
210
In programming language modes, this is the same as TAB.
211
In some text modes, where TAB inserts a tab, this command indents to the
212
column specified by the function `current-left-margin'."
Jim Blandy's avatar
Jim Blandy committed
213 214
  (interactive "*")
  (delete-region (point) (progn (skip-chars-backward " \t") (point)))
Jim Blandy's avatar
Jim Blandy committed
215
  (newline)
Jim Blandy's avatar
Jim Blandy committed
216 217 218 219 220
  (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,
221
which means calling the current value of `indent-line-function'.
Jim Blandy's avatar
Jim Blandy committed
222 223
In programming language modes, this is the same as TAB.
In some text modes, where TAB inserts a tab, this indents to the
224
column specified by the function `current-left-margin'."
Jim Blandy's avatar
Jim Blandy committed
225 226 227 228
  (interactive "*")
  (save-excursion
    (delete-region (point) (progn (skip-chars-backward " \t") (point)))
    (indent-according-to-mode))
Jim Blandy's avatar
Jim Blandy committed
229
  (newline)
Jim Blandy's avatar
Jim Blandy committed
230 231
  (indent-according-to-mode))

232 233 234 235 236 237 238 239 240 241 242 243
;; 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
244 245 246 247
(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)
248
and KILLP is t if a prefix arg was specified."
Jim Blandy's avatar
Jim Blandy committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
  (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.
278 279 280 281
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.
282 283

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
284 285 286
\(goto-char (point-min)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
287 288 289 290 291 292 293 294 295
  (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
296 297 298 299
  (if arg (forward-line 1)))

(defun end-of-buffer (&optional arg)
  "Move point to the end of the buffer; leave mark at previous position.
300 301 302 303
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.
304 305

Don't use this command in Lisp programs!
Jim Blandy's avatar
Jim Blandy committed
306 307 308
\(goto-char (point-max)) is faster and avoids clobbering the mark."
  (interactive "P")
  (push-mark)
309 310 311 312 313 314 315 316 317
  (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
318 319
  ;; 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
320
  (if arg (forward-line 1)
Eric S. Raymond's avatar
Eric S. Raymond committed
321 322 323 324 325 326 327
    ;; 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)))
328 329 330
	(progn
	  (overlay-recenter (point))
	  (recenter -3)))))
Jim Blandy's avatar
Jim Blandy committed
331 332

(defun mark-whole-buffer ()
Jim Blandy's avatar
Jim Blandy committed
333 334 335 336
  "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
337 338
  (interactive)
  (push-mark (point))
339
  (push-mark (point-max) nil t)
Jim Blandy's avatar
Jim Blandy committed
340 341 342
  (goto-char (point-min)))

(defun count-lines-region (start end)
343
  "Print number of lines and characters in the region."
Jim Blandy's avatar
Jim Blandy committed
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
  (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,
361
but can be one more if START is not equal to END
Jim Blandy's avatar
Jim Blandy committed
362
and the greater of them is not at the start of a line."
363 364 365 366 367 368
  (save-excursion
    (save-restriction
      (narrow-to-region start end)
      (goto-char (point-min))
      (if (eq selective-display t)
	  (save-match-data
369 370 371 372 373
	    (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)))
374 375 376 377
	      (goto-char (point-max))
	      (if (and (/= start end)
		       (not (bolp)))
		  (1+ done)
378 379
		done)))
	(- (buffer-size) (forward-line (buffer-size)))))))
Jim Blandy's avatar
Jim Blandy committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403

(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)))
404 405 406 407
	  (message "Char: %s (0%o, %d, 0x%x)  point=%d of %d(%d%%) <%d - %d>  column %d %s"
		   (single-key-description char) char char char pos total percent beg end col hscroll)
	(message "Char: %s (0%o, %d, 0x%x)  point=%d of %d(%d%%)  column %d %s"
		 (single-key-description char) char char char pos total percent col hscroll)))))
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412 413 414

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

415
(defvar read-expression-map (cons 'keymap minibuffer-local-map)
416 417 418
  "Minibuffer keymap used for reading Lisp expressions.")
(define-key read-expression-map "\M-\t" 'lisp-complete-symbol)

Jim Blandy's avatar
Jim Blandy committed
419 420
(put 'eval-expression 'disabled t)

421 422 423
(defvar read-expression-history nil)

;; We define this, rather than making `eval' interactive,
Jim Blandy's avatar
Jim Blandy committed
424 425 426
;; for the sake of completion of names like eval-region, eval-current-buffer.
(defun eval-expression (expression)
  "Evaluate EXPRESSION and print value in minibuffer.
427
Value is also consed on to front of the variable `values'."
428
  (interactive
429 430 431
   (list (read-from-minibuffer "Eval: "
			       nil read-expression-map t
			       'read-expression-history)))
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435 436 437 438
  (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."
439 440 441 442
  (let ((command (read-from-minibuffer prompt
				       (prin1-to-string command)
				       read-expression-map t
				       '(command-history . 1))))
443 444 445 446 447 448 449 450 451
    ;; 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 command (car command-history))
	(setq command-history (cons command command-history)))
Jim Blandy's avatar
Jim Blandy committed
452 453
    (eval command)))

454
(defun repeat-complex-command (arg)
Jim Blandy's avatar
Jim Blandy committed
455 456 457 458 459 460
  "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.
461 462
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
463
  (interactive "p")
464
  (let ((elt (nth (1- arg) command-history))
465
	(minibuffer-history-position arg)
466
	(minibuffer-history-sexp-flag t)
Jim Blandy's avatar
Jim Blandy committed
467 468
	newcmd)
    (if elt
469
	(progn
470
	  (setq newcmd
471 472 473 474
		(let ((print-level nil))
		  (read-from-minibuffer
		   "Redo: " (prin1-to-string elt) read-expression-map t
		   (cons 'command-history arg))))
475

476 477 478 479 480 481 482 483 484
	  ;; 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
485 486
	  (eval newcmd))
      (ding))))
487

488 489 490 491 492
(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
493
  "Non-nil when doing history operations on `command-history'.
494 495
More generally, indicates that the history list being acted on
contains expressions rather than strings.")
496 497
(setq minibuffer-history-variable 'minibuffer-history)
(setq minibuffer-history-position nil)
498
(defvar minibuffer-history-search-history nil)
499

Jim Blandy's avatar
Jim Blandy committed
500
(mapcar
501 502 503 504 505 506 507 508 509 510
 (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)
511 512 513 514
	      ;; (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
515
		  (progn (error "EMACS BUG!") (cdr command))
516 517 518 519 520 521 522
		(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))))
523 524 525 526
 '(("\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
527 528
   ("\er" . previous-matching-history-element)
   ("\es" . next-matching-history-element)))
529 530

(defun previous-matching-history-element (regexp n)
531 532 533 534 535
  "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
536 537 538 539 540 541 542 543 544 545 546 547
   (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)
548
	   (prefix-numeric-value current-prefix-arg))))
549
  (let ((history (symbol-value minibuffer-history-variable))
550
	prevpos
551 552 553 554 555 556
	(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)
557 558
		     "No later matching history item"
		   "No earlier matching history item")))
559 560
      (if (string-match regexp
			(if minibuffer-history-sexp-flag
561 562
			    (let ((print-level nil))
			      (prin1-to-string (nth (1- pos) history)))
563
			  (nth (1- pos) history)))
564
	  (setq n (+ n (if (< n 0) 1 -1)))))
565 566 567 568
    (setq minibuffer-history-position pos)
    (erase-buffer)
    (let ((elt (nth (1- pos) history)))
      (insert (if minibuffer-history-sexp-flag
569 570
		  (let ((print-level nil))
		    (prin1-to-string elt))
571
		elt)))
572 573 574 575
      (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))))
576 577

(defun next-matching-history-element (regexp n)
578 579 580 581 582
  "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
583 584 585 586 587 588 589 590 591 592 593 594
   (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)
595
	   (prefix-numeric-value current-prefix-arg))))
596
  (previous-matching-history-element regexp (- n)))
Jim Blandy's avatar
Jim Blandy committed
597

598 599
(defun next-history-element (n)
  "Insert the next element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
600
  (interactive "p")
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
  (or (zerop n)
      (let ((narg (min (max 1 (- minibuffer-history-position n))
		       (length (symbol-value minibuffer-history-variable)))))
	    (if (or (zerop narg)
		    (= minibuffer-history-position narg))
		(error (if (if (zerop narg)
			       (> n 0)
			     (= minibuffer-history-position 1))
		       "End of history; no next item"
		     "Beginning of history; no preceding item"))
	  (erase-buffer)
	  (setq minibuffer-history-position narg)
	  (let ((elt (nth (1- minibuffer-history-position)
			  (symbol-value minibuffer-history-variable))))
	    (insert
	     (if minibuffer-history-sexp-flag
		 (let ((print-level nil))
		   (prin1-to-string elt))
	       elt)))
	  (goto-char (point-min))))))
Jim Blandy's avatar
Jim Blandy committed
621

622
(defun previous-history-element (n)
Richard M. Stallman's avatar
Richard M. Stallman committed
623
  "Inserts the previous element of the minibuffer history into the minibuffer."
Jim Blandy's avatar
Jim Blandy committed
624
  (interactive "p")
625
  (next-history-element (- n)))
626 627

(defun next-complete-history-element (n)
628
  "Get next element of history which is a completion of minibuffer contents."
629
  (interactive "p")
630 631 632 633 634 635 636
  (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)))
637 638

(defun previous-complete-history-element (n)
639 640
  "\
Get previous element of history which is a completion of minibuffer contents."
641 642
  (interactive "p")
  (next-complete-history-element (- n)))
643

Jim Blandy's avatar
Jim Blandy committed
644 645 646
(defun goto-line (arg)
  "Goto line ARG, counting from line 1 at beginning of buffer."
  (interactive "NGoto line: ")
647
  (setq arg (prefix-numeric-value arg))
Jim Blandy's avatar
Jim Blandy committed
648 649 650 651 652 653 654 655
  (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
656
(define-function 'advertised-undo 'undo)
Jim Blandy's avatar
Jim Blandy committed
657 658 659 660 661 662

(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")
663 664 665
  ;; If we don't get all the way thru, make last-command indicate that
  ;; for the following command.
  (setq this-command t)
666 667
  (let ((modified (buffer-modified-p))
	(recent-save (recent-auto-save-p)))
Jim Blandy's avatar
Jim Blandy committed
668 669
    (or (eq (selected-window) (minibuffer-window))
	(message "Undo!"))
Jim Blandy's avatar
Jim Blandy committed
670 671 672 673
    (or (eq last-command 'undo)
	(progn (undo-start)
	       (undo-more 1)))
    (undo-more (or arg 1))
674 675 676 677 678 679 680 681 682 683
    ;; 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
684
    (and modified (not (buffer-modified-p))
685 686 687
	 (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
688

689 690 691
(defvar pending-undo-list nil
  "Within a run of consecutive undo commands, list remaining to be undone.")

Jim Blandy's avatar
Jim Blandy committed
692
(defun undo-start ()
693 694
  "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
695 696 697 698 699 700
  (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.
701 702
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
703 704 705 706
  (or pending-undo-list
      (error "No further undo information"))
  (setq pending-undo-list (primitive-undo count pending-undo-list)))

707 708 709
(defvar shell-command-history nil
  "History list for some commands that read shell commands.")

710 711 712
(defvar shell-command-switch "-c"
  "Switch used to have the shell execute its command line argument.")

713
(defun shell-command (command &optional output-buffer)
Jim Blandy's avatar
Jim Blandy committed
714 715
  "Execute string COMMAND in inferior shell; display output, if any.
If COMMAND ends in ampersand, execute it asynchronously.
716 717 718 719 720 721 722 723
The output appears in the buffer `*Shell Command*'.

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)."
724 725 726
  (interactive (list (read-from-minibuffer "Shell command: "
					   nil nil nil 'shell-command-history)
		     current-prefix-arg))
727 728
  (if (and output-buffer
	   (not (or (bufferp output-buffer)  (stringp output-buffer))))
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732 733 734 735 736
      (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
737
			   shell-command-switch command)
738 739 740 741 742 743
	     ;; 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
744 745 746 747 748
    ;; 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.
749 750
	      (let ((buffer (get-buffer-create
			     (or output-buffer "*Shell-Command*")))
Jim Blandy's avatar
Jim Blandy committed
751 752 753 754 755 756 757 758 759 760 761 762
		    (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)
763
		  (setq buffer-read-only nil)
Jim Blandy's avatar
Jim Blandy committed
764 765 766 767
		  (erase-buffer)
		  (display-buffer buffer)
		  (setq default-directory directory)
		  (setq proc (start-process "Shell" buffer 
768 769
					    shell-file-name 
					    shell-command-switch command))
770
		  (setq mode-line-process '(":%s"))
Jim Blandy's avatar
Jim Blandy committed
771 772 773 774 775 776 777 778 779
		  (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)
780 781
  (if (and (memq (process-status process) '(exit signal))
	   (buffer-name (process-buffer process)))
Jim Blandy's avatar
Jim Blandy committed
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
      (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)
802 803
	  (or (= (point) (point-max))
	      (setq opoint (point)))
Jim Blandy's avatar
Jim Blandy committed
804 805 806 807 808
	  (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.
809 810
      (if opoint
	  (goto-char opoint))
Jim Blandy's avatar
Jim Blandy committed
811 812
      (set-buffer obuf))))

813
(defun shell-command-on-region (start end command
814
				      &optional output-buffer replace)
Jim Blandy's avatar
Jim Blandy committed
815 816 817
  "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.
818 819 820

The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER, REPLACE.
If REPLACE is non-nil, that means insert the output
821
in place of text from START to END, putting point and mark around it.
Jim Blandy's avatar
Jim Blandy committed
822 823 824

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

829 830
If the optional fourth argument OUTPUT-BUFFER is non-nil,
that says to put the output in some other buffer.
831 832 833 834
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.
In either case, the output is inserted after point (leaving mark after it)."
835 836 837 838 839 840 841 842 843 844
  (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)))
		 (list (region-beginning) (region-end)
		       string
		       current-prefix-arg
845 846 847 848
		       current-prefix-arg)))
  (if (or replace
	  (and output-buffer
	       (not (or (bufferp output-buffer) (stringp output-buffer)))))
Jim Blandy's avatar
Jim Blandy committed
849
      ;; Replace specified region with output from command.
850
      (let ((swap (and replace (< (point) (mark)))))
851 852
	;; Don't muck with mark unless REPLACE says we should.
	(goto-char start)
853
	(and replace (push-mark))
Jim Blandy's avatar
Jim Blandy committed
854
	(call-process-region start end shell-file-name t t nil
855
			     shell-command-switch command)
856 857 858
	(let ((shell-buffer (get-buffer "*Shell Command Output*")))
	  (and shell-buffer (not (eq shell-buffer (current-buffer)))
	       (kill-buffer shell-buffer)))
859
	;; Don't muck with mark unless REPLACE says we should.
860
	(and replace swap (exchange-point-and-mark)))
Jim Blandy's avatar
Jim Blandy committed
861 862
    ;; No prefix argument: put the output in a temp buffer,
    ;; replacing its entire contents.
863 864
    (let ((buffer (get-buffer-create
		   (or output-buffer "*Shell Command Output*")))
865 866 867 868 869 870
	  (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.
871 872
	      (progn (setq buffer-read-only nil)
		     (delete-region end (point-max))
873 874 875
		     (delete-region (point-min) start)
		     (call-process-region (point-min) (point-max)
					  shell-file-name t t nil
876
					  shell-command-switch command)
877 878 879 880
		     (setq success t))
	    ;; Clear the output buffer, then run the command with output there.
	    (save-excursion
	      (set-buffer buffer)
881
	      (setq buffer-read-only nil)
882 883 884
	      (erase-buffer))
	    (call-process-region start end shell-file-name
				 nil buffer nil
885
				 shell-command-switch command)
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
	    (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)
903
					      (progn (end-of-line) (point))))))
904 905
		(t 
		 (set-window-start (display-buffer buffer) 1))))))))
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909 910 911 912 913 914 915 916 917 918

(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"))

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

Jim Blandy's avatar
Jim Blandy committed
922
(defun kill-line (&optional arg)
923
  "Kill the rest of the current line; if no nonblanks there, kill thru newline.
Jim Blandy's avatar
Jim Blandy committed
924 925 926 927
With prefix argument, kill that many lines from point.
Negative arguments kill lines backward.

When calling from a program, nil means \"no arg\",
928 929 930 931
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
932 933
  (interactive "P")
  (kill-region (point)
934 935 936 937 938 939
	       ;; 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
940 941 942 943
		 (if arg
		     (forward-line (prefix-numeric-value arg))
		   (if (eobp)
		       (signal 'end-of-buffer nil))
944
		   (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
Jim Blandy's avatar
Jim Blandy committed
945 946 947 948
		       (forward-line 1)
		     (end-of-line)))
		 (point))))

Jim Blandy's avatar
Jim Blandy committed
949 950 951 952 953 954
;;;; 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
955 956 957
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
958 959
programs.

960 961 962 963 964
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
965 966 967 968 969

(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
970 971
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
972 973 974 975 976
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
977 978 979 980 981 982 983 984
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
985 986 987 988



;;;; The kill ring data structure.
Jim Blandy's avatar
Jim Blandy committed
989 990

(defvar kill-ring nil
Jim Blandy's avatar
Jim Blandy committed
991 992 993 994 995 996 997 998
  "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
999 1000 1001 1002 1003 1004 1005

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

1006
(defun kill-new (string &optional replace)
Jim Blandy's avatar
Jim Blandy committed
1007 1008
  "Make STRING the latest kill in the kill ring.
Set the kill-ring-yank pointer to point to it.
1009 1010 1011
If `interprogram-cut-function' is non-nil, apply it to STRING.
Optional second argument REPLACE non-nil means that STRING will replace
the front of the kill ring, rather than being added to the list."
1012 1013
  (and (fboundp 'menu-bar-update-yank-menu)
       (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1014 1015 1016 1017 1018
  (if replace
      (setcar kill-ring string)
    (setq kill-ring (cons string kill-ring))
    (if (> (length kill-ring) kill-ring-max)
	(setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
Jim Blandy's avatar
Jim Blandy committed
1019 1020
  (setq kill-ring-yank-pointer kill-ring)
  (if interprogram-cut-function
1021
      (funcall interprogram-cut-function string t)))
Jim Blandy's avatar
Jim Blandy committed
1022

Jim Blandy's avatar
Jim Blandy committed
1023
(defun kill-append (string before-p)
Jim Blandy's avatar
Jim Blandy committed
1024 1025
  "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
1026
If `interprogram-cut-function' is set, pass the resulting kill to
Jim Blandy's avatar
Jim Blandy committed
1027
it."
1028 1029 1030
  (kill-new (if before-p
		(concat string (car kill-ring))
	      (concat (car kill-ring) string)) t))
Jim Blandy's avatar
Jim Blandy committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050

(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"))
1051 1052 1053 1054
      (let ((ARGth-kill-element
	     (nthcdr (mod (- n (length kill-ring-yank-pointer))
			  (length kill-ring))
		     kill-ring)))
Jim Blandy's avatar
Jim Blandy committed
1055 1056 1057
	(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
1058 1059


Jim Blandy's avatar
Jim Blandy committed
1060 1061

;;;; Commands for manipulating the kill ring.
Eric S. Raymond's avatar
Eric S. Raymond committed
1062

1063 1064 1065
(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
1066 1067 1068 1069 1070
(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].)
1071 1072 1073
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
1074 1075 1076 1077 1078 1079 1080 1081

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."
1082
  (interactive "r")
Jim Blandy's avatar
Jim Blandy committed
1083
  (cond
1084 1085 1086 1087

   ;; 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.
1088 1089
   ((or (and buffer-read-only (not inhibit-read-only))
	(text-property-not-all beg end 'read-only nil))
1090
    (copy-region-as-kill beg end)
1091
    ;; This should always barf, and give us the correct error.
1092 1093
    (if kill-read-only-ok
	(message "Read only text copied to kill ring")
1094
      (setq this-command 'kill-region)
1095
      (barf-if-buffer-read-only)))
1096 1097 1098

   ;; 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
1099 1100
   ((not (or (eq buffer-undo-list t)
	     (eq last-command 'kill-region)
1101 1102
	     ;; Use = since positions may be numbers or markers.
	     (= beg end)))
Jim Blandy's avatar
Jim Blandy committed
1103
    ;; Don't let the undo list be truncated before we can even access it.
1104 1105 1106
    (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
	  (old-list buffer-undo-list)
	  tail)
Jim Blandy's avatar
Jim Blandy committed
1107
      (delete-region beg end)
1108 1109 1110 1111 1112
      ;; 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
1113 1114
      ;; Take the same string recorded for undo
      ;; and put it in the kill-ring.
1115
      (kill-new (car (car tail)))))