*** empty log message ***
[bpt/emacs.git] / lisp / simple.el
CommitLineData
c88ab9ce
ER
1;;; simple.el --- basic editing commands for Emacs
2
ec9f4754 3;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
69c1dd37 4;; Free Software Foundation, Inc.
2076c87c
JB
5
6;; This file is part of GNU Emacs.
7
8;; GNU Emacs is free software; you can redistribute it and/or modify
9;; it under the terms of the GNU General Public License as published by
3a801d0c 10;; the Free Software Foundation; either version 2, or (at your option)
2076c87c
JB
11;; any later version.
12
13;; GNU Emacs is distributed in the hope that it will be useful,
14;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16;; GNU General Public License for more details.
17
18;; You should have received a copy of the GNU General Public License
b578f267
EN
19;; along with GNU Emacs; see the file COPYING. If not, write to the
20;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21;; Boston, MA 02111-1307, USA.
2076c87c 22
d9ecc911
ER
23;;; Commentary:
24
25;; A grab-bag of basic Emacs commands not specifically related to some
26;; major mode or to file-handling.
27
3a801d0c 28;;; Code:
2076c87c 29
d01a33cf 30(eval-when-compile
a339f909 31 (autoload 'widget-convert "wid-edit")
9023837e 32 (autoload 'shell-mode "shell")
d01a33cf
GM
33 (require 'cl))
34
35
69c1dd37
RS
36(defgroup killing nil
37 "Killing and yanking commands"
38 :group 'editing)
39
69c1dd37
RS
40(defgroup paren-matching nil
41 "Highlight (un)matching of parens and expressions."
69c1dd37
RS
42 :group 'matching)
43
44
93be67de
KH
45(defun fundamental-mode ()
46 "Major mode not specialized for anything in particular.
47Other major modes are defined by comparison with this one."
48 (interactive)
49 (kill-all-local-variables))
eaae8106 50
93be67de
KH
51;; Making and deleting lines.
52
30bb9754 53(defun newline (&optional arg)
d133d835 54 "Insert a newline, and move to left margin of the new line if it's blank.
30bb9754 55The newline is marked with the text-property `hard'.
76c64e24 56With ARG, insert that many newlines.
30bb9754
BG
57In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
58 (interactive "*P")
4c4cbf11 59 (barf-if-buffer-read-only)
30bb9754
BG
60 ;; Inserting a newline at the end of a line produces better redisplay in
61 ;; try_window_id than inserting at the beginning of a line, and the textual
62 ;; result is the same. So, if we're at beginning of line, pretend to be at
63 ;; the end of the previous line.
1e722f9f 64 (let ((flag (and (not (bobp))
30bb9754 65 (bolp)
1cd24721
RS
66 ;; Make sure no functions want to be told about
67 ;; the range of the changes.
1cd24721
RS
68 (not after-change-functions)
69 (not before-change-functions)
fd977703
RS
70 ;; Make sure there are no markers here.
71 (not (buffer-has-markers-at (1- (point))))
2f047f6c 72 (not (buffer-has-markers-at (point)))
1cd24721
RS
73 ;; Make sure no text properties want to know
74 ;; where the change was.
75 (not (get-char-property (1- (point)) 'modification-hooks))
76 (not (get-char-property (1- (point)) 'insert-behind-hooks))
77 (or (eobp)
78 (not (get-char-property (point) 'insert-in-front-hooks)))
31a5333f
MB
79 ;; Make sure the newline before point isn't intangible.
80 (not (get-char-property (1- (point)) 'intangible))
81 ;; Make sure the newline before point isn't read-only.
82 (not (get-char-property (1- (point)) 'read-only))
83 ;; Make sure the newline before point isn't invisible.
84 (not (get-char-property (1- (point)) 'invisible))
85 ;; Make sure the newline before point has the same
86 ;; properties as the char before it (if any).
1e722f9f 87 (< (or (previous-property-change (point)) -2)
d133d835
RS
88 (- (point) 2))))
89 (was-page-start (and (bolp)
90 (looking-at page-delimiter)))
91 (beforepos (point)))
30bb9754
BG
92 (if flag (backward-char 1))
93 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
94 ;; Set last-command-char to tell self-insert what to insert.
95 (let ((last-command-char ?\n)
96 ;; Don't auto-fill if we have a numeric argument.
3954fff9
RS
97 ;; Also not if flag is true (it would fill wrong line);
98 ;; there is no need to since we're at BOL.
99 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
4cc9d0dc
RS
100 (unwind-protect
101 (self-insert-command (prefix-numeric-value arg))
102 ;; If we get an error in self-insert-command, put point at right place.
103 (if flag (forward-char 1))))
2f047f6c
KH
104 ;; Even if we did *not* get an error, keep that forward-char;
105 ;; all further processing should apply to the newline that the user
106 ;; thinks he inserted.
107
30bb9754
BG
108 ;; Mark the newline(s) `hard'.
109 (if use-hard-newlines
2f047f6c 110 (set-hard-newline-properties
55741b46 111 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
d133d835
RS
112 ;; If the newline leaves the previous line blank,
113 ;; and we have a left margin, delete that from the blank line.
114 (or flag
115 (save-excursion
116 (goto-char beforepos)
117 (beginning-of-line)
118 (and (looking-at "[ \t]$")
119 (> (current-left-margin) 0)
120 (delete-region (point) (progn (end-of-line) (point))))))
d133d835
RS
121 ;; Indent the line after the newline, except in one case:
122 ;; when we added the newline at the beginning of a line
123 ;; which starts a page.
124 (or was-page-start
125 (move-to-left-margin nil t)))
30bb9754
BG
126 nil)
127
55741b46
RS
128(defun set-hard-newline-properties (from to)
129 (let ((sticky (get-text-property from 'rear-nonsticky)))
130 (put-text-property from to 'hard 't)
131 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
132 (if (and (listp sticky) (not (memq 'hard sticky)))
133 (put-text-property from (point) 'rear-nonsticky
134 (cons 'hard sticky)))))
eaae8106 135
2076c87c 136(defun open-line (arg)
ff1fbe3e 137 "Insert a newline and leave point before it.
3db1e3b5 138If there is a fill prefix and/or a left-margin, insert them on the new line
d133d835 139if the line would have been blank.
616ed245 140With arg N, insert N newlines."
2076c87c 141 (interactive "*p")
616ed245 142 (let* ((do-fill-prefix (and fill-prefix (bolp)))
3db1e3b5 143 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
207d7545
GM
144 (loc (point))
145 ;; Don't expand an abbrev before point.
146 (abbrev-mode nil))
d133d835
RS
147 (newline arg)
148 (goto-char loc)
28191e20 149 (while (> arg 0)
d133d835
RS
150 (cond ((bolp)
151 (if do-left-margin (indent-to (current-left-margin)))
152 (if do-fill-prefix (insert-and-inherit fill-prefix))))
153 (forward-line 1)
28191e20 154 (setq arg (1- arg)))
d133d835
RS
155 (goto-char loc)
156 (end-of-line)))
2076c87c
JB
157
158(defun split-line ()
159 "Split current line, moving portion beyond point vertically down."
160 (interactive "*")
161 (skip-chars-forward " \t")
162 (let ((col (current-column))
163 (pos (point)))
28191e20 164 (newline 1)
2076c87c
JB
165 (indent-to col 0)
166 (goto-char pos)))
167
2076c87c
JB
168(defun delete-indentation (&optional arg)
169 "Join this line to previous and fix up whitespace at join.
ccc58657 170If there is a fill prefix, delete it from the beginning of this line.
2076c87c
JB
171With argument, join this line to following line."
172 (interactive "*P")
173 (beginning-of-line)
174 (if arg (forward-line 1))
175 (if (eq (preceding-char) ?\n)
176 (progn
177 (delete-region (point) (1- (point)))
ccc58657
RS
178 ;; If the second line started with the fill prefix,
179 ;; delete the prefix.
180 (if (and fill-prefix
01b8e020 181 (<= (+ (point) (length fill-prefix)) (point-max))
ccc58657
RS
182 (string= fill-prefix
183 (buffer-substring (point)
184 (+ (point) (length fill-prefix)))))
185 (delete-region (point) (+ (point) (length fill-prefix))))
2076c87c
JB
186 (fixup-whitespace))))
187
fc025090 188(defalias 'join-line #'delete-indentation) ; easier to find
eaae8106 189
2076c87c
JB
190(defun delete-blank-lines ()
191 "On blank line, delete all surrounding blank lines, leaving just one.
192On isolated blank line, delete that one.
6d30d416 193On nonblank line, delete any immediately following blank lines."
2076c87c
JB
194 (interactive "*")
195 (let (thisblank singleblank)
196 (save-excursion
197 (beginning-of-line)
198 (setq thisblank (looking-at "[ \t]*$"))
70e14c01 199 ;; Set singleblank if there is just one blank line here.
2076c87c
JB
200 (setq singleblank
201 (and thisblank
202 (not (looking-at "[ \t]*\n[ \t]*$"))
203 (or (bobp)
204 (progn (forward-line -1)
205 (not (looking-at "[ \t]*$")))))))
70e14c01 206 ;; Delete preceding blank lines, and this one too if it's the only one.
2076c87c
JB
207 (if thisblank
208 (progn
209 (beginning-of-line)
210 (if singleblank (forward-line 1))
211 (delete-region (point)
212 (if (re-search-backward "[^ \t\n]" nil t)
213 (progn (forward-line 1) (point))
214 (point-min)))))
70e14c01
JB
215 ;; Delete following blank lines, unless the current line is blank
216 ;; and there are no following blank lines.
2076c87c
JB
217 (if (not (and thisblank singleblank))
218 (save-excursion
219 (end-of-line)
220 (forward-line 1)
221 (delete-region (point)
222 (if (re-search-forward "[^ \t\n]" nil t)
223 (progn (beginning-of-line) (point))
70e14c01
JB
224 (point-max)))))
225 ;; Handle the special case where point is followed by newline and eob.
226 ;; Delete the line, leaving point at eob.
227 (if (looking-at "^[ \t]*\n\\'")
228 (delete-region (point) (point-max)))))
2076c87c 229
eaae8106
SS
230(defun delete-trailing-whitespace ()
231 "Delete all the trailing whitespace across the current buffer.
232All whitespace after the last non-whitespace character in a line is deleted.
233This respects narrowing, created by \\[narrow-to-region] and friends."
234 (interactive "*")
235 (save-match-data
236 (save-excursion
237 (goto-char (point-min))
5c9b3fac
MB
238 (while (re-search-forward "\\s-$" nil t)
239 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
3a768251
GM
240 ;; Don't delete formfeeds, even if they are considered whitespace.
241 (if (looking-at ".*\f")
242 (goto-char (match-end 0)))
7981d89f 243 (delete-region (point) (match-end 0))))))
eaae8106 244
2076c87c
JB
245(defun newline-and-indent ()
246 "Insert a newline, then indent according to major mode.
ff1fbe3e 247Indentation is done using the value of `indent-line-function'.
2076c87c 248In programming language modes, this is the same as TAB.
ff1fbe3e 249In some text modes, where TAB inserts a tab, this command indents to the
eed5698b 250column specified by the function `current-left-margin'."
2076c87c 251 (interactive "*")
5ff4ba3d 252 (delete-horizontal-space t)
46947372 253 (newline)
2076c87c
JB
254 (indent-according-to-mode))
255
256(defun reindent-then-newline-and-indent ()
257 "Reindent current line, insert newline, then indent the new line.
258Indentation of both lines is done according to the current major mode,
ff1fbe3e 259which means calling the current value of `indent-line-function'.
2076c87c
JB
260In programming language modes, this is the same as TAB.
261In some text modes, where TAB inserts a tab, this indents to the
eed5698b 262column specified by the function `current-left-margin'."
2076c87c
JB
263 (interactive "*")
264 (save-excursion
5ff4ba3d 265 (delete-horizontal-space t)
2076c87c 266 (indent-according-to-mode))
46947372 267 (newline)
2076c87c 268 (indent-according-to-mode))
eaae8106 269
93be67de
KH
270(defun quoted-insert (arg)
271 "Read next input character and insert it.
272This is useful for inserting control characters.
2076c87c 273
93be67de
KH
274If the first character you type after this command is an octal digit,
275you should type a sequence of octal digits which specify a character code.
276Any nondigit terminates the sequence. If the terminator is a RET,
277it is discarded; any other terminator is used itself as input.
278The variable `read-quoted-char-radix' specifies the radix for this feature;
279set it to 10 or 16 to use decimal or hex instead of octal.
dff7d67f 280
93be67de
KH
281In overwrite mode, this function inserts the character anyway, and
282does not handle octal digits specially. This means that if you use
283overwrite as your normal editing mode, you can use this function to
284insert characters when necessary.
dff7d67f 285
93be67de
KH
286In binary overwrite mode, this function does overwrite, and octal
287digits are interpreted as a character code. This is intended to be
288useful for editing binary files."
289 (interactive "*p")
290 (let ((char (if (or (not overwrite-mode)
291 (eq overwrite-mode 'overwrite-mode-binary))
292 (read-quoted-char)
293 (read-char))))
294 ;; Assume character codes 0240 - 0377 stand for characters in some
295 ;; single-byte character set, and convert them to Emacs
296 ;; characters.
297 (if (and enable-multibyte-characters
298 (>= char ?\240)
299 (<= char ?\377))
300 (setq char (unibyte-char-to-multibyte char)))
301 (if (> arg 0)
302 (if (eq overwrite-mode 'overwrite-mode-binary)
303 (delete-char arg)))
304 (while (> arg 0)
305 (insert-and-inherit char)
306 (setq arg (1- arg)))))
eaae8106 307
93be67de
KH
308(defun forward-to-indentation (arg)
309 "Move forward ARG lines and position at first nonblank character."
310 (interactive "p")
311 (forward-line arg)
312 (skip-chars-forward " \t"))
cc2b2b6c 313
93be67de
KH
314(defun backward-to-indentation (arg)
315 "Move backward ARG lines and position at first nonblank character."
316 (interactive "p")
317 (forward-line (- arg))
318 (skip-chars-forward " \t"))
2076c87c 319
93be67de
KH
320(defun back-to-indentation ()
321 "Move point to the first non-whitespace character on this line."
322 (interactive)
323 (beginning-of-line 1)
324 (skip-chars-forward " \t"))
325
326(defun fixup-whitespace ()
327 "Fixup white space between objects around point.
328Leave one space or none, according to the context."
329 (interactive "*")
330 (save-excursion
331 (delete-horizontal-space)
332 (if (or (looking-at "^\\|\\s)")
333 (save-excursion (forward-char -1)
334 (looking-at "$\\|\\s(\\|\\s'")))
335 nil
336 (insert ?\ ))))
337
5ff4ba3d
MB
338(defun delete-horizontal-space (&optional backward-only)
339 "Delete all spaces and tabs around point.
340If BACKWARD-ONLY is non-nil, only delete spaces before point."
93be67de 341 (interactive "*")
5ff4ba3d
MB
342 (delete-region
343 (if backward-only
344 (point)
345 (progn
346 (skip-chars-forward " \t" (field-end))
347 (point)))
348 (progn
349 (skip-chars-backward " \t" (field-beginning nil t))
350 (point))))
93be67de
KH
351
352(defun just-one-space ()
353 "Delete all spaces and tabs around point, leaving one space."
354 (interactive "*")
5ff4ba3d 355 (skip-chars-backward " \t" (field-beginning))
93be67de
KH
356 (if (= (following-char) ? )
357 (forward-char 1)
358 (insert ? ))
5ff4ba3d
MB
359 (delete-region
360 (point)
361 (progn
362 (skip-chars-forward " \t" (field-end nil t))
363 (point))))
eaae8106 364
2076c87c
JB
365(defun beginning-of-buffer (&optional arg)
366 "Move point to the beginning of the buffer; leave mark at previous position.
c66587fe
RS
367With arg N, put point N/10 of the way from the beginning.
368
369If the buffer is narrowed, this command uses the beginning and size
370of the accessible part of the buffer.
ff1fbe3e
RS
371
372Don't use this command in Lisp programs!
2076c87c
JB
373\(goto-char (point-min)) is faster and avoids clobbering the mark."
374 (interactive "P")
375 (push-mark)
c66587fe
RS
376 (let ((size (- (point-max) (point-min))))
377 (goto-char (if arg
378 (+ (point-min)
379 (if (> size 10000)
380 ;; Avoid overflow for large buffer sizes!
381 (* (prefix-numeric-value arg)
382 (/ size 10))
383 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
384 (point-min))))
2076c87c
JB
385 (if arg (forward-line 1)))
386
387(defun end-of-buffer (&optional arg)
388 "Move point to the end of the buffer; leave mark at previous position.
c66587fe
RS
389With arg N, put point N/10 of the way from the end.
390
391If the buffer is narrowed, this command uses the beginning and size
392of the accessible part of the buffer.
ff1fbe3e
RS
393
394Don't use this command in Lisp programs!
2076c87c
JB
395\(goto-char (point-max)) is faster and avoids clobbering the mark."
396 (interactive "P")
397 (push-mark)
c66587fe
RS
398 (let ((size (- (point-max) (point-min))))
399 (goto-char (if arg
400 (- (point-max)
401 (if (> size 10000)
402 ;; Avoid overflow for large buffer sizes!
403 (* (prefix-numeric-value arg)
404 (/ size 10))
405 (/ (* size (prefix-numeric-value arg)) 10)))
406 (point-max))))
3a801d0c
ER
407 ;; If we went to a place in the middle of the buffer,
408 ;; adjust it to the beginning of a line.
314808dc
GM
409 (cond (arg (forward-line 1))
410 ((< (point) (window-end nil t))
411 ;; If the end of the buffer is not already on the screen,
412 ;; then scroll specially to put it near, but not at, the bottom.
413 (overlay-recenter (point))
414 (recenter -3))))
2076c87c
JB
415
416(defun mark-whole-buffer ()
70e14c01
JB
417 "Put point at beginning and mark at end of buffer.
418You probably should not use this function in Lisp programs;
419it is usually a mistake for a Lisp function to use any subroutine
420that uses or sets the mark."
2076c87c
JB
421 (interactive)
422 (push-mark (point))
fd0f4056 423 (push-mark (point-max) nil t)
2076c87c 424 (goto-char (point-min)))
fa65f20b 425
eaae8106 426
93be67de
KH
427;; Counting lines, one way or another.
428
429(defun goto-line (arg)
430 "Goto line ARG, counting from line 1 at beginning of buffer."
431 (interactive "NGoto line: ")
432 (setq arg (prefix-numeric-value arg))
433 (save-restriction
434 (widen)
435 (goto-char 1)
436 (if (eq selective-display t)
437 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
438 (forward-line (1- arg)))))
2076c87c
JB
439
440(defun count-lines-region (start end)
eb8c3be9 441 "Print number of lines and characters in the region."
2076c87c
JB
442 (interactive "r")
443 (message "Region has %d lines, %d characters"
444 (count-lines start end) (- end start)))
445
446(defun what-line ()
2578be76 447 "Print the current buffer line number and narrowed line number of point."
2076c87c 448 (interactive)
2578be76 449 (let ((opoint (point)) start)
2076c87c 450 (save-excursion
2578be76
RS
451 (save-restriction
452 (goto-char (point-min))
453 (widen)
454 (beginning-of-line)
455 (setq start (point))
456 (goto-char opoint)
457 (beginning-of-line)
458 (if (/= start 1)
459 (message "line %d (narrowed line %d)"
460 (1+ (count-lines 1 (point)))
461 (1+ (count-lines start (point))))
462 (message "Line %d" (1+ (count-lines 1 (point)))))))))
463
2076c87c
JB
464(defun count-lines (start end)
465 "Return number of lines between START and END.
466This is usually the number of newlines between them,
ff1fbe3e 467but can be one more if START is not equal to END
2076c87c 468and the greater of them is not at the start of a line."
e406700d
RS
469 (save-excursion
470 (save-restriction
471 (narrow-to-region start end)
472 (goto-char (point-min))
473 (if (eq selective-display t)
474 (save-match-data
dde92ca6
RS
475 (let ((done 0))
476 (while (re-search-forward "[\n\C-m]" nil t 40)
477 (setq done (+ 40 done)))
478 (while (re-search-forward "[\n\C-m]" nil t 1)
479 (setq done (+ 1 done)))
043efc41
RS
480 (goto-char (point-max))
481 (if (and (/= start end)
482 (not (bolp)))
483 (1+ done)
e406700d
RS
484 done)))
485 (- (buffer-size) (forward-line (buffer-size)))))))
eaae8106 486
d5d99b80
KH
487(defun what-cursor-position (&optional detail)
488 "Print info on cursor position (on screen and within buffer).
e38dff0c 489Also describe the character after point, and give its character code
c6fcc518
KH
490in octal, decimal and hex.
491
492For a non-ASCII multibyte character, also give its encoding in the
493buffer's selected coding system if the coding system encodes the
494character safely. If the character is encoded into one byte, that
495code is shown in hex. If the character is encoded into more than one
496byte, just \"...\" is shown.
e5a902cf 497
24dad5d5
KH
498In addition, with prefix argument, show details about that character
499in *Help* buffer. See also the command `describe-char-after'."
d5d99b80 500 (interactive "P")
2076c87c
JB
501 (let* ((char (following-char))
502 (beg (point-min))
503 (end (point-max))
504 (pos (point))
505 (total (buffer-size))
506 (percent (if (> total 50000)
507 ;; Avoid overflow from multiplying by 100!
508 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
509 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
510 (hscroll (if (= (window-hscroll) 0)
511 ""
512 (format " Hscroll=%d" (window-hscroll))))
513 (col (current-column)))
514 (if (= pos end)
515 (if (or (/= beg 1) (/= end (1+ total)))
74fd2380 516 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
2076c87c 517 pos total percent beg end col hscroll)
74fd2380 518 (message "point=%d of %d (%d%%) column %d %s"
2076c87c 519 pos total percent col hscroll))
c6fcc518
KH
520 (let ((coding buffer-file-coding-system)
521 encoded encoding-msg)
522 (if (or (not coding)
523 (eq (coding-system-type coding) t))
524 (setq coding default-buffer-file-coding-system))
28fd4883
KH
525 (if (not (char-valid-p char))
526 (setq encoding-msg
527 (format "(0%o, %d, 0x%x, invalid)" char char char))
528 (setq encoded (and (>= char 128) (encode-coding-char char coding)))
529 (setq encoding-msg
530 (if encoded
24dad5d5 531 (format "(0%o, %d, 0x%x, file %s)"
28fd4883 532 char char char
24dad5d5 533 (if (> (length encoded) 1)
28fd4883 534 "..."
24dad5d5 535 (encoded-string-description encoded coding)))
28fd4883 536 (format "(0%o, %d, 0x%x)" char char char))))
e5e89e48 537 (if detail
24dad5d5
KH
538 ;; We show the detailed information about CHAR.
539 (describe-char-after (point)))
540 (if (or (/= beg 1) (/= end (1+ total)))
541 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
e5a902cf
KH
542 (if (< char 256)
543 (single-key-description char)
f0d16a7f 544 (buffer-substring-no-properties (point) (1+ (point))))
24dad5d5
KH
545 encoding-msg pos total percent beg end col hscroll)
546 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
547 (if (< char 256)
548 (single-key-description char)
549 (buffer-substring-no-properties (point) (1+ (point))))
550 encoding-msg pos total percent col hscroll))))))
eaae8106 551
76c64e24
SM
552(defvar read-expression-map
553 (let ((m (make-sparse-keymap)))
554 (define-key m "\M-\t" 'lisp-complete-symbol)
555 (set-keymap-parent m minibuffer-local-map)
556 m)
854c16c5 557 "Minibuffer keymap used for reading Lisp expressions.")
854c16c5 558
8570b0ca
RM
559(defvar read-expression-history nil)
560
b49df39d
RS
561(defcustom eval-expression-print-level 4
562 "*Value to use for `print-level' when printing value in `eval-expression'."
563 :group 'lisp
564 :type 'integer
565 :version "21.1")
566
567(defcustom eval-expression-print-length 12
568 "*Value to use for `print-length' when printing value in `eval-expression'."
569 :group 'lisp
56437999 570 :type '(choice (const nil) integer)
b49df39d
RS
571 :version "21.1")
572
573(defcustom eval-expression-debug-on-error t
ed8bcabe
GM
574 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
575If nil, don't change the value of `debug-on-error'."
b49df39d
RS
576 :group 'lisp
577 :type 'boolean
578 :version "21.1")
579
8570b0ca 580;; We define this, rather than making `eval' interactive,
2076c87c 581;; for the sake of completion of names like eval-region, eval-current-buffer.
ecb7ad00
RS
582(defun eval-expression (eval-expression-arg
583 &optional eval-expression-insert-value)
2076c87c 584 "Evaluate EXPRESSION and print value in minibuffer.
eb57c304 585Value is also consed on to front of the variable `values'."
adca5fa6 586 (interactive
b387ef9a
RS
587 (list (read-from-minibuffer "Eval: "
588 nil read-expression-map t
ecb7ad00
RS
589 'read-expression-history)
590 current-prefix-arg))
eaae8106 591
ed8bcabe
GM
592 (if (null eval-expression-debug-on-error)
593 (setq values (cons (eval eval-expression-arg) values))
594 (let ((old-value (make-symbol "t")) new-value)
595 ;; Bind debug-on-error to something unique so that we can
596 ;; detect when evaled code changes it.
597 (let ((debug-on-error old-value))
598 (setq values (cons (eval eval-expression-arg) values))
599 (setq new-value debug-on-error))
600 ;; If evaled code has changed the value of debug-on-error,
601 ;; propagate that change to the global binding.
602 (unless (eq old-value new-value)
603 (setq debug-on-error new-value))))
eaae8106 604
b49df39d
RS
605 (let ((print-length eval-expression-print-length)
606 (print-level eval-expression-print-level))
607 (prin1 (car values)
608 (if eval-expression-insert-value (current-buffer) t))))
2076c87c
JB
609
610(defun edit-and-eval-command (prompt command)
611 "Prompting with PROMPT, let user edit COMMAND and eval result.
612COMMAND is a Lisp expression. Let user edit that expression in
613the minibuffer, then read and evaluate the result."
b387ef9a
RS
614 (let ((command (read-from-minibuffer prompt
615 (prin1-to-string command)
616 read-expression-map t
617 '(command-history . 1))))
5d6c83ae 618 ;; If command was added to command-history as a string,
1f238ac2 619 ;; get rid of that. We want only evaluable expressions there.
5d6c83ae
KH
620 (if (stringp (car command-history))
621 (setq command-history (cdr command-history)))
622
623 ;; If command to be redone does not match front of history,
624 ;; add it to the history.
625 (or (equal command (car command-history))
626 (setq command-history (cons command command-history)))
2076c87c
JB
627 (eval command)))
628
ebb61177 629(defun repeat-complex-command (arg)
2076c87c
JB
630 "Edit and re-evaluate last complex command, or ARGth from last.
631A complex command is one which used the minibuffer.
632The command is placed in the minibuffer as a Lisp form for editing.
633The result is executed, repeating the command as changed.
634If the command has been changed or is not the most recent previous command
635it is added to the front of the command history.
eb6e9899
RS
636You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
637to get different commands to edit and resubmit."
2076c87c 638 (interactive "p")
ba343182 639 (let ((elt (nth (1- arg) command-history))
2076c87c
JB
640 newcmd)
641 (if elt
854c16c5 642 (progn
eab22e27 643 (setq newcmd
74ae5fab
RS
644 (let ((print-level nil)
645 (minibuffer-history-position arg)
99ea24de 646 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
7908d27c
RS
647 (read-from-minibuffer
648 "Redo: " (prin1-to-string elt) read-expression-map t
649 (cons 'command-history arg))))
eab22e27 650
db16f109 651 ;; If command was added to command-history as a string,
1f238ac2 652 ;; get rid of that. We want only evaluable expressions there.
db16f109
RS
653 (if (stringp (car command-history))
654 (setq command-history (cdr command-history)))
655
656 ;; If command to be redone does not match front of history,
657 ;; add it to the history.
658 (or (equal newcmd (car command-history))
659 (setq command-history (cons newcmd command-history)))
2076c87c
JB
660 (eval newcmd))
661 (ding))))
eaae8106 662
854c16c5
RS
663(defvar minibuffer-history nil
664 "Default minibuffer history list.
665This is used for all minibuffer input
666except when an alternate history list is specified.")
667(defvar minibuffer-history-sexp-flag nil
c2d4b6d9 668 "Non-nil when doing history operations on `command-history'.
854c16c5 669More generally, indicates that the history list being acted on
99ea24de
KH
670contains expressions rather than strings.
671It is only valid if its value equals the current minibuffer depth,
672to handle recursive uses of the minibuffer.")
e91f80c4
RS
673(setq minibuffer-history-variable 'minibuffer-history)
674(setq minibuffer-history-position nil)
854c16c5 675(defvar minibuffer-history-search-history nil)
e91f80c4 676
29929437 677(mapcar
d0678801
RM
678 (lambda (key-and-command)
679 (mapcar
680 (lambda (keymap-and-completionp)
681 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
682 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
683 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
684 (define-key (symbol-value (car keymap-and-completionp))
685 (car key-and-command)
686 (let ((command (cdr key-and-command)))
687 (if (consp command)
b5e6f936
RM
688 ;; (and ... nil) => ... turns back on the completion-oriented
689 ;; history commands which rms turned off since they seem to
690 ;; do things he doesn't like.
691 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
d81362b0 692 (progn (error "EMACS BUG!") (cdr command))
d0678801
RM
693 (car command))
694 command))))
695 '((minibuffer-local-map . nil)
696 (minibuffer-local-ns-map . nil)
697 (minibuffer-local-completion-map . t)
698 (minibuffer-local-must-match-map . t)
699 (read-expression-map . nil))))
d81362b0
RM
700 '(("\en" . (next-history-element . next-complete-history-element))
701 ([next] . (next-history-element . next-complete-history-element))
702 ("\ep" . (previous-history-element . previous-complete-history-element))
703 ([prior] . (previous-history-element . previous-complete-history-element))
29929437
JB
704 ("\er" . previous-matching-history-element)
705 ("\es" . next-matching-history-element)))
e91f80c4 706
93cee14b
RS
707(defvar minibuffer-text-before-history nil
708 "Text that was in this minibuffer before any history commands.
709This is nil if there have not yet been any history commands
710in this use of the minibuffer.")
711
712(add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
713
714(defun minibuffer-history-initialize ()
715 (setq minibuffer-text-before-history nil))
716
6e7d0ff7
MB
717(defun minibuffer-avoid-prompt (new old)
718 "A point-motion hook for the minibuffer, that moves point out of the prompt."
719 (constrain-to-field nil (point-max)))
720
6e30a99a
RS
721(defcustom minibuffer-history-case-insensitive-variables nil
722 "*Minibuffer history variables for which matching should ignore case.
723If a history variable is a member of this list, then the
724\\[previous-matching-history-element] and \\[next-matching-history-element]\
725 commands ignore case when searching it, regardless of `case-fold-search'."
726 :type '(repeat variable)
727 :group 'minibuffer)
728
e91f80c4 729(defun previous-matching-history-element (regexp n)
854c16c5
RS
730 "Find the previous history element that matches REGEXP.
731\(Previous history elements refer to earlier actions.)
732With prefix argument N, search for Nth previous match.
5c2010f0 733If N is negative, find the next or Nth next match.
9889af08
EZ
734Normally, history elements are matched case-insensitively if
735`case-fold-search' is non-nil, but an uppercase letter in REGEXP
736makes the search case-sensitive.
6e30a99a 737See also `minibuffer-history-case-insensitive-variables'."
854c16c5 738 (interactive
c1172a19 739 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
740 (regexp (read-from-minibuffer "Previous element matching (regexp): "
741 nil
742 minibuffer-local-map
743 nil
744 'minibuffer-history-search-history)))
745 ;; Use the last regexp specified, by default, if input is empty.
746 (list (if (string= regexp "")
a8e96cea
KH
747 (if minibuffer-history-search-history
748 (car minibuffer-history-search-history)
749 (error "No previous history search regexp"))
c1172a19 750 regexp)
854c16c5 751 (prefix-numeric-value current-prefix-arg))))
e276a14a
MB
752 (unless (zerop n)
753 (if (and (zerop minibuffer-history-position)
754 (null minibuffer-text-before-history))
755 (setq minibuffer-text-before-history (field-string (point-max))))
756 (let ((history (symbol-value minibuffer-history-variable))
757 (case-fold-search
758 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
759 ;; On some systems, ignore case for file names.
760 (if (memq minibuffer-history-variable
761 minibuffer-history-case-insensitive-variables)
762 t
763 ;; Respect the user's setting for case-fold-search:
764 case-fold-search)
765 nil))
766 prevpos
767 match-string
768 match-offset
769 (pos minibuffer-history-position))
770 (while (/= n 0)
771 (setq prevpos pos)
772 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
773 (when (= pos prevpos)
e91f80c4 774 (error (if (= pos 1)
ccc58657
RS
775 "No later matching history item"
776 "No earlier matching history item")))
e276a14a
MB
777 (setq match-string
778 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
7908d27c 779 (let ((print-level nil))
e276a14a
MB
780 (prin1-to-string (nth (1- pos) history)))
781 (nth (1- pos) history)))
782 (setq match-offset
783 (if (< n 0)
784 (and (string-match regexp match-string)
785 (match-end 0))
786 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
787 (match-beginning 1))))
788 (when match-offset
789 (setq n (+ n (if (< n 0) 1 -1)))))
790 (setq minibuffer-history-position pos)
791 (goto-char (point-max))
792 (delete-field)
793 (insert match-string)
794 (goto-char (+ (field-beginning) match-offset))))
854c16c5
RS
795 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
796 (eq (car (car command-history)) 'next-matching-history-element))
797 (setq command-history (cdr command-history))))
e91f80c4 798
e91f80c4 799(defun next-matching-history-element (regexp n)
854c16c5
RS
800 "Find the next history element that matches REGEXP.
801\(The next history element refers to a more recent action.)
802With prefix argument N, search for Nth next match.
5c2010f0 803If N is negative, find the previous or Nth previous match.
9889af08
EZ
804Normally, history elements are matched case-insensitively if
805`case-fold-search' is non-nil, but an uppercase letter in REGEXP
806makes the search case-sensitive."
854c16c5 807 (interactive
c1172a19 808 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
809 (regexp (read-from-minibuffer "Next element matching (regexp): "
810 nil
811 minibuffer-local-map
812 nil
813 'minibuffer-history-search-history)))
814 ;; Use the last regexp specified, by default, if input is empty.
815 (list (if (string= regexp "")
816 (setcar minibuffer-history-search-history
817 (nth 1 minibuffer-history-search-history))
818 regexp)
854c16c5 819 (prefix-numeric-value current-prefix-arg))))
e91f80c4 820 (previous-matching-history-element regexp (- n)))
2076c87c 821
8dc3ba7d
MB
822(defvar minibuffer-temporary-goal-position nil)
823
ebb61177
RS
824(defun next-history-element (n)
825 "Insert the next element of the minibuffer history into the minibuffer."
2076c87c 826 (interactive "p")
0818b15e 827 (or (zerop n)
93cee14b
RS
828 (let ((narg (- minibuffer-history-position n))
829 (minimum (if minibuffer-default -1 0))
068c712c 830 elt minibuffer-returned-to-present)
93cee14b
RS
831 (if (and (zerop minibuffer-history-position)
832 (null minibuffer-text-before-history))
a4d1159b 833 (setq minibuffer-text-before-history (field-string (point-max))))
93cee14b 834 (if (< narg minimum)
81091543
RS
835 (if minibuffer-default
836 (error "End of history; no next item")
837 (error "End of history; no default available")))
93cee14b
RS
838 (if (> narg (length (symbol-value minibuffer-history-variable)))
839 (error "Beginning of history; no preceding item"))
8dc3ba7d
MB
840 (unless (or (eq last-command 'next-history-element)
841 (eq last-command 'previous-history-element))
842 (let ((prompt-end (field-beginning (point-max))))
843 (set (make-local-variable 'minibuffer-temporary-goal-position)
844 (cond ((<= (point) prompt-end) prompt-end)
845 ((eobp) nil)
846 (t (point))))))
a4d1159b 847 (goto-char (point-max))
12de1411 848 (delete-field)
93cee14b
RS
849 (setq minibuffer-history-position narg)
850 (cond ((= narg -1)
851 (setq elt minibuffer-default))
852 ((= narg 0)
54c548db 853 (setq elt (or minibuffer-text-before-history ""))
068c712c 854 (setq minibuffer-returned-to-present t)
93cee14b
RS
855 (setq minibuffer-text-before-history nil))
856 (t (setq elt (nth (1- minibuffer-history-position)
857 (symbol-value minibuffer-history-variable)))))
858 (insert
068c712c
KH
859 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
860 (not minibuffer-returned-to-present))
93cee14b
RS
861 (let ((print-level nil))
862 (prin1-to-string elt))
863 elt))
8dc3ba7d 864 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
2076c87c 865
ebb61177 866(defun previous-history-element (n)
3ee3a076 867 "Inserts the previous element of the minibuffer history into the minibuffer."
2076c87c 868 (interactive "p")
2c5e21c1 869 (next-history-element (- n)))
d0678801
RM
870
871(defun next-complete-history-element (n)
a4d1159b
GM
872 "Get next history element which completes the minibuffer before the point.
873The contents of the minibuffer after the point are deleted, and replaced
874by the new completion."
d0678801 875 (interactive "p")
b5e6f936
RM
876 (let ((point-at-start (point)))
877 (next-matching-history-element
a4d1159b
GM
878 (concat
879 "^" (regexp-quote (buffer-substring (field-beginning) (point))))
880 n)
b5e6f936
RM
881 ;; next-matching-history-element always puts us at (point-min).
882 ;; Move to the position we were at before changing the buffer contents.
883 ;; This is still sensical, because the text before point has not changed.
884 (goto-char point-at-start)))
d0678801
RM
885
886(defun previous-complete-history-element (n)
1f6fcec3 887 "\
a4d1159b
GM
888Get previous history element which completes the minibuffer before the point.
889The contents of the minibuffer after the point are deleted, and replaced
890by the new completion."
d0678801
RM
891 (interactive "p")
892 (next-complete-history-element (- n)))
a4d1159b
GM
893
894;; These two functions are for compatibility with the old subrs of the
895;; same name.
896
897(defun minibuffer-prompt-width ()
898 "Return the display width of the minibuffer prompt.
899Return 0 if current buffer is not a mini-buffer."
900 ;; Return the width of everything before the field at the end of
901 ;; the buffer; this should be 0 for normal buffers.
902 (1- (field-beginning (point-max))))
903
904(defun minibuffer-prompt-end ()
905 "Return the buffer position of the end of the minibuffer prompt.
b90d06b0 906Return (point-min) if current buffer is not a mini-buffer."
bf2083f9
GM
907 (field-beginning (point-max)))
908
b90d06b0
MB
909(defun minibuffer-contents ()
910 "Return the user input in a minbuffer as a string.
911The current buffer must be a minibuffer."
912 (field-string (point-max)))
913
914(defun minibuffer-contents-no-properties ()
915 "Return the user input in a minbuffer as a string, without text-properties.
916The current buffer must be a minibuffer."
917 (field-string-no-properties (point-max)))
918
919(defun delete-minibuffer-contents ()
920 "Delete all user input in a minibuffer.
921The current buffer must be a minibuffer."
922 (delete-field (point-max)))
eaae8106 923
2076c87c 924;Put this on C-x u, so we can force that rather than C-_ into startup msg
e462e42f 925(defalias 'advertised-undo 'undo)
2076c87c
JB
926
927(defun undo (&optional arg)
928 "Undo some previous changes.
929Repeat this command to undo more changes.
65627aad
RS
930A numeric argument serves as a repeat count.
931
3c1b77ca
MB
932In Transient Mark mode when the mark is active, only undo changes within
933the current region. Similarly, when not in Transient Mark mode, just C-u
934as an argument limits undo to changes within the current region."
65627aad 935 (interactive "*P")
456c617c
RS
936 ;; If we don't get all the way thru, make last-command indicate that
937 ;; for the following command.
938 (setq this-command t)
b553cffa
RS
939 (let ((modified (buffer-modified-p))
940 (recent-save (recent-auto-save-p)))
71e40adf
JB
941 (or (eq (selected-window) (minibuffer-window))
942 (message "Undo!"))
3c1b77ca
MB
943 (unless (eq last-command 'undo)
944 (if (if transient-mark-mode mark-active (and arg (not (numberp arg))))
945 (undo-start (region-beginning) (region-end))
946 (undo-start))
947 ;; get rid of initial undo boundary
948 (undo-more 1))
949 (undo-more
950 (if (or transient-mark-mode (numberp arg))
951 (prefix-numeric-value arg)
952 1))
2512c9f0
RS
953 ;; Don't specify a position in the undo record for the undo command.
954 ;; Instead, undoing this should move point to where the change is.
955 (let ((tail buffer-undo-list)
956 done)
957 (while (and tail (not done) (not (null (car tail))))
958 (if (integerp (car tail))
959 (progn
960 (setq done t)
961 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
962 (setq tail (cdr tail))))
2076c87c 963 (and modified (not (buffer-modified-p))
456c617c
RS
964 (delete-auto-save-file-if-necessary recent-save)))
965 ;; If we do get all the way thru, make this-command indicate that.
966 (setq this-command 'undo))
2076c87c 967
278b0a58
RS
968(defvar pending-undo-list nil
969 "Within a run of consecutive undo commands, list remaining to be undone.")
970
52d1110d
RS
971(defvar undo-in-progress nil
972 "Non-nil while performing an undo.
973Some change-hooks test this variable to do something different.")
974
2076c87c
JB
975(defun undo-more (count)
976 "Undo back N undo-boundaries beyond what was already undone recently.
ff1fbe3e
RS
977Call `undo-start' to get ready to undo recent changes,
978then call `undo-more' one or more times to undo them."
2076c87c
JB
979 (or pending-undo-list
980 (error "No further undo information"))
52d1110d
RS
981 (let ((undo-in-progress t))
982 (setq pending-undo-list (primitive-undo count pending-undo-list))))
2076c87c 983
65627aad
RS
984;; Deep copy of a list
985(defun undo-copy-list (list)
986 "Make a copy of undo list LIST."
987 (mapcar 'undo-copy-list-1 list))
988
989(defun undo-copy-list-1 (elt)
990 (if (consp elt)
991 (cons (car elt) (undo-copy-list-1 (cdr elt)))
992 elt))
993
994(defun undo-start (&optional beg end)
995 "Set `pending-undo-list' to the front of the undo list.
996The next call to `undo-more' will undo the most recently made change.
997If BEG and END are specified, then only undo elements
998that apply to text between BEG and END are used; other undo elements
999are ignored. If BEG and END are nil, all undo elements are used."
1000 (if (eq buffer-undo-list t)
1001 (error "No undo information in this buffer"))
1e722f9f 1002 (setq pending-undo-list
65627aad
RS
1003 (if (and beg end (not (= beg end)))
1004 (undo-make-selective-list (min beg end) (max beg end))
1005 buffer-undo-list)))
1006
1007(defvar undo-adjusted-markers)
1008
1009(defun undo-make-selective-list (start end)
1010 "Return a list of undo elements for the region START to END.
1011The elements come from `buffer-undo-list', but we keep only
1012the elements inside this region, and discard those outside this region.
1013If we find an element that crosses an edge of this region,
1014we stop and ignore all further elements."
1015 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1016 (undo-list (list nil))
1017 undo-adjusted-markers
1018 some-rejected
1019 undo-elt undo-elt temp-undo-list delta)
1020 (while undo-list-copy
1021 (setq undo-elt (car undo-list-copy))
1022 (let ((keep-this
1023 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1024 ;; This is a "was unmodified" element.
1025 ;; Keep it if we have kept everything thus far.
1026 (not some-rejected))
1027 (t
1028 (undo-elt-in-region undo-elt start end)))))
1029 (if keep-this
1030 (progn
1031 (setq end (+ end (cdr (undo-delta undo-elt))))
1032 ;; Don't put two nils together in the list
1033 (if (not (and (eq (car undo-list) nil)
1034 (eq undo-elt nil)))
1035 (setq undo-list (cons undo-elt undo-list))))
1036 (if (undo-elt-crosses-region undo-elt start end)
1037 (setq undo-list-copy nil)
1038 (setq some-rejected t)
1039 (setq temp-undo-list (cdr undo-list-copy))
1040 (setq delta (undo-delta undo-elt))
1041
1042 (when (/= (cdr delta) 0)
1043 (let ((position (car delta))
1044 (offset (cdr delta)))
1045
1046 ;; Loop down the earlier events adjusting their buffer positions
1047 ;; to reflect the fact that a change to the buffer isn't being
1048 ;; undone. We only need to process those element types which
1049 ;; undo-elt-in-region will return as being in the region since
1050 ;; only those types can ever get into the output
1051
1052 (while temp-undo-list
1053 (setq undo-elt (car temp-undo-list))
1054 (cond ((integerp undo-elt)
1055 (if (>= undo-elt position)
1056 (setcar temp-undo-list (- undo-elt offset))))
1057 ((atom undo-elt) nil)
1058 ((stringp (car undo-elt))
1059 ;; (TEXT . POSITION)
1060 (let ((text-pos (abs (cdr undo-elt)))
1061 (point-at-end (< (cdr undo-elt) 0 )))
1062 (if (>= text-pos position)
1e722f9f 1063 (setcdr undo-elt (* (if point-at-end -1 1)
65627aad
RS
1064 (- text-pos offset))))))
1065 ((integerp (car undo-elt))
1066 ;; (BEGIN . END)
1067 (when (>= (car undo-elt) position)
1068 (setcar undo-elt (- (car undo-elt) offset))
1069 (setcdr undo-elt (- (cdr undo-elt) offset))))
1070 ((null (car undo-elt))
1071 ;; (nil PROPERTY VALUE BEG . END)
1072 (let ((tail (nthcdr 3 undo-elt)))
1073 (when (>= (car tail) position)
1074 (setcar tail (- (car tail) offset))
1075 (setcdr tail (- (cdr tail) offset))))))
1076 (setq temp-undo-list (cdr temp-undo-list))))))))
1077 (setq undo-list-copy (cdr undo-list-copy)))
1078 (nreverse undo-list)))
1079
1080(defun undo-elt-in-region (undo-elt start end)
1081 "Determine whether UNDO-ELT falls inside the region START ... END.
1082If it crosses the edge, we return nil."
1083 (cond ((integerp undo-elt)
1084 (and (>= undo-elt start)
1085 (< undo-elt end)))
1086 ((eq undo-elt nil)
1087 t)
1088 ((atom undo-elt)
1089 nil)
1090 ((stringp (car undo-elt))
1091 ;; (TEXT . POSITION)
1092 (and (>= (abs (cdr undo-elt)) start)
1093 (< (abs (cdr undo-elt)) end)))
1094 ((and (consp undo-elt) (markerp (car undo-elt)))
1095 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1096 ;; See if MARKER is inside the region.
1097 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1098 (unless alist-elt
1099 (setq alist-elt (cons (car undo-elt)
1100 (marker-position (car undo-elt))))
1101 (setq undo-adjusted-markers
1102 (cons alist-elt undo-adjusted-markers)))
1103 (and (cdr alist-elt)
1104 (>= (cdr alist-elt) start)
1105 (< (cdr alist-elt) end))))
1106 ((null (car undo-elt))
1107 ;; (nil PROPERTY VALUE BEG . END)
1108 (let ((tail (nthcdr 3 undo-elt)))
1109 (and (>= (car tail) start)
1110 (< (cdr tail) end))))
1111 ((integerp (car undo-elt))
1112 ;; (BEGIN . END)
1113 (and (>= (car undo-elt) start)
1114 (< (cdr undo-elt) end)))))
1115
1116(defun undo-elt-crosses-region (undo-elt start end)
1117 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1118This assumes we have already decided that UNDO-ELT
1119is not *inside* the region START...END."
1120 (cond ((atom undo-elt) nil)
1121 ((null (car undo-elt))
1122 ;; (nil PROPERTY VALUE BEG . END)
1123 (let ((tail (nthcdr 3 undo-elt)))
1124 (not (or (< (car tail) end)
1125 (> (cdr tail) start)))))
1126 ((integerp (car undo-elt))
1127 ;; (BEGIN . END)
1128 (not (or (< (car undo-elt) end)
1129 (> (cdr undo-elt) start))))))
1130
1131;; Return the first affected buffer position and the delta for an undo element
1132;; delta is defined as the change in subsequent buffer positions if we *did*
1133;; the undo.
1134(defun undo-delta (undo-elt)
1135 (if (consp undo-elt)
1136 (cond ((stringp (car undo-elt))
1137 ;; (TEXT . POSITION)
1138 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1139 ((integerp (car undo-elt))
1140 ;; (BEGIN . END)
1141 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1142 (t
1143 '(0 . 0)))
1144 '(0 . 0)))
eaae8106 1145
009ef402
RS
1146(defvar shell-command-history nil
1147 "History list for some commands that read shell commands.")
1148
59fc41e5
RS
1149(defvar shell-command-switch "-c"
1150 "Switch used to have the shell execute its command line argument.")
1151
cc039f78
KH
1152(defvar shell-command-default-error-buffer nil
1153 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1154This buffer is used when `shell-command' or 'shell-command-on-region'
1155is run interactively. A value of nil means that output to stderr and
1156stdout will be intermixed in the output stream.")
1157
1158(defun shell-command (command &optional output-buffer error-buffer)
2076c87c 1159 "Execute string COMMAND in inferior shell; display output, if any.
0b3f96d4 1160With prefix argument, insert the COMMAND's output at point.
d382f610 1161
2076c87c 1162If COMMAND ends in ampersand, execute it asynchronously.
d382f610 1163The output appears in the buffer `*Async Shell Command*'.
bcad4985 1164That buffer is in shell mode.
d382f610 1165
939ac10c
GM
1166Otherwise, COMMAND is executed synchronously. The output appears in
1167the buffer `*Shell Command Output*'. If the output is short enough to
1168display in the echo area (which is determined by the variables
1169`resize-mini-windows' and `max-mini-window-height'), it is shown
1170there, but it is nonetheless available in buffer `*Shell Command
1171Output*' even though that buffer is not automatically displayed. If
1172there is no output, or if output is inserted in the current buffer,
1173then `*Shell Command Output*' is deleted.
d0d74413 1174
07f458c1
RS
1175To specify a coding system for converting non-ASCII characters
1176in the shell command output, use \\[universal-coding-system-argument]
1177before this command.
1178
1179Noninteractive callers can specify coding systems by binding
1180`coding-system-for-read' and `coding-system-for-write'.
1181
d0d74413
RS
1182The optional second argument OUTPUT-BUFFER, if non-nil,
1183says to put the output in some other buffer.
1184If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1185If OUTPUT-BUFFER is not a buffer and not nil,
1186insert output in current buffer. (This cannot be done asynchronously.)
cc039f78
KH
1187In either case, the output is inserted after point (leaving mark after it).
1188
1189If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1190or buffer name to which to direct the command's standard error output.
1191If it is nil, error output is mingled with regular output.
1192In an interactive call, the variable `shell-command-default-error-buffer'
1193specifies the value of ERROR-BUFFER."
1194
aa00b92d
RS
1195 (interactive (list (read-from-minibuffer "Shell command: "
1196 nil nil nil 'shell-command-history)
cc039f78
KH
1197 current-prefix-arg
1198 shell-command-default-error-buffer))
c7edd03c
KH
1199 ;; Look for a handler in case default-directory is a remote file name.
1200 (let ((handler
1201 (find-file-name-handler (directory-file-name default-directory)
1202 'shell-command)))
1203 (if handler
cc039f78 1204 (funcall handler 'shell-command command output-buffer error-buffer)
c7edd03c
KH
1205 (if (and output-buffer
1206 (not (or (bufferp output-buffer) (stringp output-buffer))))
cc039f78 1207 (let ((error-file
1e722f9f 1208 (if error-buffer
b005abd5 1209 (make-temp-file
171a45d9
EZ
1210 (expand-file-name "scor"
1211 (or small-temporary-file-directory
1212 temporary-file-directory)))
cc039f78
KH
1213 nil)))
1214 (barf-if-buffer-read-only)
63437623 1215 (push-mark nil t)
cc039f78
KH
1216 ;; We do not use -f for csh; we will not support broken use of
1217 ;; .cshrcs. Even the BSD csh manual says to use
1218 ;; "if ($?prompt) exit" before things which are not useful
1219 ;; non-interactively. Besides, if someone wants their other
1220 ;; aliases for shell commands then they can still have them.
1e722f9f 1221 (call-process shell-file-name nil
cc039f78
KH
1222 (if error-file
1223 (list t error-file)
1224 t)
1225 nil shell-command-switch command)
1226 (when (and error-file (file-exists-p error-file))
1227 (if (< 0 (nth 7 (file-attributes error-file)))
1228 (with-current-buffer (get-buffer-create error-buffer)
1229 (let ((pos-from-end (- (point-max) (point))))
1230 (or (bobp)
1231 (insert "\f\n"))
1232 ;; Do no formatting while reading error file,
1233 ;; because that can run a shell command, and we
1234 ;; don't want that to cause an infinite recursion.
1235 (format-insert-file error-file nil)
1236 ;; Put point after the inserted errors.
1237 (goto-char (- (point-max) pos-from-end)))
1238 (display-buffer (current-buffer))))
1239 (delete-file error-file))
1240 ;; This is like exchange-point-and-mark, but doesn't
1241 ;; activate the mark. It is cleaner to avoid activation,
1242 ;; even though the command loop would deactivate the mark
1243 ;; because we inserted text.
1244 (goto-char (prog1 (mark t)
1245 (set-marker (mark-marker) (point)
1246 (current-buffer)))))
c7edd03c
KH
1247 ;; Preserve the match data in case called from a program.
1248 (save-match-data
1249 (if (string-match "[ \t]*&[ \t]*$" command)
1250 ;; Command ending with ampersand means asynchronous.
1251 (let ((buffer (get-buffer-create
1252 (or output-buffer "*Async Shell Command*")))
1253 (directory default-directory)
1254 proc)
1255 ;; Remove the ampersand.
1256 (setq command (substring command 0 (match-beginning 0)))
1257 ;; If will kill a process, query first.
1258 (setq proc (get-buffer-process buffer))
1259 (if proc
1260 (if (yes-or-no-p "A command is running. Kill it? ")
1261 (kill-process proc)
1262 (error "Shell command in progress")))
1263 (save-excursion
1264 (set-buffer buffer)
1265 (setq buffer-read-only nil)
1266 (erase-buffer)
1267 (display-buffer buffer)
1268 (setq default-directory directory)
1e722f9f 1269 (setq proc (start-process "Shell" buffer shell-file-name
c7edd03c
KH
1270 shell-command-switch command))
1271 (setq mode-line-process '(":%s"))
1272 (require 'shell) (shell-mode)
1273 (set-process-sentinel proc 'shell-command-sentinel)
1274 ))
cc039f78
KH
1275 (shell-command-on-region (point) (point) command
1276 output-buffer nil error-buffer)))))))
eaae8106 1277
f69aad2b
MB
1278(defun display-message-or-buffer (message
1279 &optional buffer-name not-this-window frame)
1280 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1281MESSAGE may be either a string or a buffer.
1282
1283A buffer is displayed using `display-buffer' if MESSAGE is too long for
939ac10c
GM
1284the maximum height of the echo area, as defined by `max-mini-window-height'
1285if `resize-mini-windows' is non-nil.
f69aad2b 1286
2a3f00bf
MB
1287Returns either the string shown in the echo area, or when a pop-up
1288buffer is used, the window used to display it.
1289
f69aad2b
MB
1290If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1291name of the buffer used to display it in the case where a pop-up buffer
1292is used, defaulting to `*Message*'. In the case where MESSAGE is a
1293string and it is displayed in the echo area, it is not specified whether
1294the contents are inserted into the buffer anyway.
1295
1296Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1297and only used if a buffer is displayed."
1298 (cond ((and (stringp message) (not (string-match "\n" message)))
1299 ;; Trivial case where we can use the echo area
1300 (message "%s" message))
1301 ((and (stringp message)
1302 (= (string-match "\n" message) (1- (length message))))
1303 ;; Trivial case where we can just remove single trailing newline
1304 (message "%s" (substring message 0 (1- (length message)))))
1305 (t
1306 ;; General case
1307 (with-current-buffer
1308 (if (bufferp message)
1309 message
1310 (get-buffer-create (or buffer-name "*Message*")))
1311
1312 (unless (bufferp message)
1313 (erase-buffer)
1314 (insert message))
1315
1316 (let ((lines
1317 (if (= (buffer-size) 0)
1318 0
1319 (count-lines (point-min) (point-max)))))
1320 (cond ((or (<= lines 1)
1321 (<= lines
939ac10c
GM
1322 (if resize-mini-windows
1323 (cond ((floatp max-mini-window-height)
1324 (* (frame-height)
1325 max-mini-window-height))
1326 ((integerp max-mini-window-height)
1327 max-mini-window-height)
1328 (t
1329 1))
1330 1)))
f69aad2b
MB
1331 ;; Echo area
1332 (goto-char (point-max))
1333 (when (bolp)
1334 (backward-char 1))
1335 (message "%s" (buffer-substring (point-min) (point))))
1336 (t
1337 ;; Buffer
1338 (goto-char (point-min))
1339 (display-buffer message not-this-window frame))))))))
1340
1341
2076c87c
JB
1342;; We have a sentinel to prevent insertion of a termination message
1343;; in the buffer itself.
1344(defun shell-command-sentinel (process signal)
bcad4985 1345 (if (memq (process-status process) '(exit signal))
1e722f9f 1346 (message "%s: %s."
bcad4985
KH
1347 (car (cdr (cdr (process-command process))))
1348 (substring signal 0 -1))))
2076c87c 1349
d0d74413 1350(defun shell-command-on-region (start end command
cce1c318
RS
1351 &optional output-buffer replace
1352 error-buffer)
2076c87c
JB
1353 "Execute string COMMAND in inferior shell with region as input.
1354Normally display output (if any) in temp buffer `*Shell Command Output*';
a0184aeb
DL
1355Prefix arg means replace the region with it. Return the exit code of
1356COMMAND.
56c0450e 1357
07f458c1
RS
1358To specify a coding system for converting non-ASCII characters
1359in the input and output to the shell command, use \\[universal-coding-system-argument]
1360before this command. By default, the input (from the current buffer)
1361is encoded in the same coding system that will be used to save the file,
1362`buffer-file-coding-system'. If the output is going to replace the region,
1363then it is decoded from that same coding system.
1364
8923a211
RS
1365The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1366REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1367systems by binding `coding-system-for-read' and
1368`coding-system-for-write'.
2076c87c 1369
06933804 1370If the output is short enough to display in the echo area (which is
939ac10c
GM
1371determined by the variable `max-mini-window-height' if
1372`resize-mini-windows' is non-nil), it is shown there, but it is
1373nonetheless available in buffer `*Shell Command Output*' even though
1374that buffer is not automatically displayed. If there is no output, or
1375if output is inserted in the current buffer, then `*Shell Command
1376Output*' is deleted.
d0d74413 1377
56c0450e
RS
1378If the optional fourth argument OUTPUT-BUFFER is non-nil,
1379that says to put the output in some other buffer.
d0d74413
RS
1380If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1381If OUTPUT-BUFFER is not a buffer and not nil,
1382insert output in the current buffer.
cce1c318
RS
1383In either case, the output is inserted after point (leaving mark after it).
1384
8923a211
RS
1385If REPLACE, the optional fifth argument, is non-nil, that means insert
1386the output in place of text from START to END, putting point and mark
1387around it.
1388
b735c991 1389If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
cce1c318 1390or buffer name to which to direct the command's standard error output.
7fd47839 1391If it is nil, error output is mingled with regular output.
cc039f78
KH
1392In an interactive call, the variable `shell-command-default-error-buffer'
1393specifies the value of ERROR-BUFFER."
cae49185
RS
1394 (interactive (let ((string
1395 ;; Do this before calling region-beginning
1396 ;; and region-end, in case subprocess output
1397 ;; relocates them while we are in the minibuffer.
1398 (read-from-minibuffer "Shell command on region: "
1399 nil nil nil
1400 'shell-command-history)))
2b03c506
RS
1401 ;; call-interactively recognizes region-beginning and
1402 ;; region-end specially, leaving them in the history.
1403 (list (region-beginning) (region-end)
cae49185
RS
1404 string
1405 current-prefix-arg
7fd47839 1406 current-prefix-arg
cc039f78 1407 shell-command-default-error-buffer)))
cce1c318 1408 (let ((error-file
171a45d9 1409 (if error-buffer
b005abd5 1410 (make-temp-file
171a45d9
EZ
1411 (expand-file-name "scor"
1412 (or small-temporary-file-directory
1413 temporary-file-directory)))
a0184aeb
DL
1414 nil))
1415 exit-status)
7fd47839
RS
1416 (if (or replace
1417 (and output-buffer
748d6ca4 1418 (not (or (bufferp output-buffer) (stringp output-buffer)))))
7fd47839
RS
1419 ;; Replace specified region with output from command.
1420 (let ((swap (and replace (< start end))))
1421 ;; Don't muck with mark unless REPLACE says we should.
1422 (goto-char start)
1423 (and replace (push-mark))
a0184aeb
DL
1424 (setq exit-status
1425 (call-process-region start end shell-file-name t
1426 (if error-file
1427 (list t error-file)
1428 t)
1429 nil shell-command-switch command))
7fd47839
RS
1430 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1431 (and shell-buffer (not (eq shell-buffer (current-buffer)))
1432 (kill-buffer shell-buffer)))
1433 ;; Don't muck with mark unless REPLACE says we should.
1434 (and replace swap (exchange-point-and-mark)))
1435 ;; No prefix argument: put the output in a temp buffer,
1436 ;; replacing its entire contents.
1437 (let ((buffer (get-buffer-create
1438 (or output-buffer "*Shell Command Output*")))
a0184aeb 1439 (success nil))
7fd47839
RS
1440 (unwind-protect
1441 (if (eq buffer (current-buffer))
1442 ;; If the input is the same buffer as the output,
1443 ;; delete everything but the specified region,
1444 ;; then replace that region with the output.
1445 (progn (setq buffer-read-only nil)
1446 (delete-region (max start end) (point-max))
1447 (delete-region (point-min) (min start end))
1448 (setq exit-status
1449 (call-process-region (point-min) (point-max)
1e722f9f 1450 shell-file-name t
7fd47839
RS
1451 (if error-file
1452 (list t error-file)
1453 t)
a0184aeb
DL
1454 nil shell-command-switch
1455 command)))
1456 ;; Clear the output buffer, then run the command with
1457 ;; output there.
c2e303c8
GM
1458 (let ((directory default-directory))
1459 (save-excursion
1460 (set-buffer buffer)
1461 (setq buffer-read-only nil)
1462 (if (not output-buffer)
1463 (setq default-directory directory))
1464 (erase-buffer)))
7fd47839
RS
1465 (setq exit-status
1466 (call-process-region start end shell-file-name nil
1467 (if error-file
1468 (list buffer error-file)
1469 buffer)
a0184aeb 1470 nil shell-command-switch command)))
a92da273 1471 (setq success (and exit-status (equal 0 exit-status)))
7fd47839 1472 ;; Report the amount of output.
f69aad2b
MB
1473 (if (with-current-buffer buffer (> (point-max) (point-min)))
1474 ;; There's some output, display it
1475 (display-message-or-buffer buffer)
1476 ;; No output; error?
1477 (message (if (and error-file
1478 (< 0 (nth 7 (file-attributes error-file))))
1479 "(Shell command %sed with some error output)"
1480 "(Shell command %sed with no output)")
1481 (if (equal 0 exit-status) "succeed" "fail"))
1482 (kill-buffer buffer)))))
1483
cc039f78
KH
1484 (when (and error-file (file-exists-p error-file))
1485 (if (< 0 (nth 7 (file-attributes error-file)))
1486 (with-current-buffer (get-buffer-create error-buffer)
1487 (let ((pos-from-end (- (point-max) (point))))
1488 (or (bobp)
1489 (insert "\f\n"))
1490 ;; Do no formatting while reading error file,
1491 ;; because that can run a shell command, and we
1492 ;; don't want that to cause an infinite recursion.
1493 (format-insert-file error-file nil)
1494 ;; Put point after the inserted errors.
1495 (goto-char (- (point-max) pos-from-end)))
1496 (display-buffer (current-buffer))))
1497 (delete-file error-file))
a0184aeb 1498 exit-status))
1e722f9f 1499
d589bd99
RS
1500(defun shell-command-to-string (command)
1501 "Execute shell command COMMAND and return its output as a string."
1502 (with-output-to-string
17cc9013
RS
1503 (with-current-buffer
1504 standard-output
1505 (call-process shell-file-name nil t nil shell-command-switch command))))
eaae8106 1506
1b43f83f 1507(defvar universal-argument-map
69d4c3c4
KH
1508 (let ((map (make-sparse-keymap)))
1509 (define-key map [t] 'universal-argument-other-key)
b9ff190d 1510 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
69d4c3c4
KH
1511 (define-key map [switch-frame] nil)
1512 (define-key map [?\C-u] 'universal-argument-more)
1513 (define-key map [?-] 'universal-argument-minus)
1514 (define-key map [?0] 'digit-argument)
1515 (define-key map [?1] 'digit-argument)
1516 (define-key map [?2] 'digit-argument)
1517 (define-key map [?3] 'digit-argument)
1518 (define-key map [?4] 'digit-argument)
1519 (define-key map [?5] 'digit-argument)
1520 (define-key map [?6] 'digit-argument)
1521 (define-key map [?7] 'digit-argument)
1522 (define-key map [?8] 'digit-argument)
1523 (define-key map [?9] 'digit-argument)
bd7acc8d
GM
1524 (define-key map [kp-0] 'digit-argument)
1525 (define-key map [kp-1] 'digit-argument)
1526 (define-key map [kp-2] 'digit-argument)
1527 (define-key map [kp-3] 'digit-argument)
1528 (define-key map [kp-4] 'digit-argument)
1529 (define-key map [kp-5] 'digit-argument)
1530 (define-key map [kp-6] 'digit-argument)
1531 (define-key map [kp-7] 'digit-argument)
1532 (define-key map [kp-8] 'digit-argument)
1533 (define-key map [kp-9] 'digit-argument)
1534 (define-key map [kp-subtract] 'universal-argument-minus)
69d4c3c4
KH
1535 map)
1536 "Keymap used while processing \\[universal-argument].")
1537
0de84e16
RS
1538(defvar universal-argument-num-events nil
1539 "Number of argument-specifying events read by `universal-argument'.
1540`universal-argument-other-key' uses this to discard those events
1541from (this-command-keys), and reread only the final command.")
1542
e8d1a377
KH
1543(defun universal-argument ()
1544 "Begin a numeric argument for the following command.
1545Digits or minus sign following \\[universal-argument] make up the numeric argument.
1546\\[universal-argument] following the digits or minus sign ends the argument.
1547\\[universal-argument] without digits or minus sign provides 4 as argument.
1548Repeating \\[universal-argument] without digits or minus sign
0565d307
RS
1549 multiplies the argument by 4 each time.
1550For some commands, just \\[universal-argument] by itself serves as a flag
a697fc62
RS
1551which is different in effect from any particular numeric argument.
1552These commands include \\[set-mark-command] and \\[start-kbd-macro]."
69d4c3c4
KH
1553 (interactive)
1554 (setq prefix-arg (list 4))
0de84e16 1555 (setq universal-argument-num-events (length (this-command-keys)))
69d4c3c4 1556 (setq overriding-terminal-local-map universal-argument-map))
e8d1a377 1557
69d4c3c4
KH
1558;; A subsequent C-u means to multiply the factor by 4 if we've typed
1559;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1560(defun universal-argument-more (arg)
e8d1a377 1561 (interactive "P")
69d4c3c4
KH
1562 (if (consp arg)
1563 (setq prefix-arg (list (* 4 (car arg))))
1cd24721
RS
1564 (if (eq arg '-)
1565 (setq prefix-arg (list -4))
1566 (setq prefix-arg arg)
1567 (setq overriding-terminal-local-map nil)))
0de84e16 1568 (setq universal-argument-num-events (length (this-command-keys))))
e8d1a377
KH
1569
1570(defun negative-argument (arg)
1571 "Begin a negative numeric argument for the next command.
1572\\[universal-argument] following digits or minus sign ends the argument."
1573 (interactive "P")
69d4c3c4
KH
1574 (cond ((integerp arg)
1575 (setq prefix-arg (- arg)))
1576 ((eq arg '-)
1577 (setq prefix-arg nil))
1578 (t
b9ff190d 1579 (setq prefix-arg '-)))
0de84e16 1580 (setq universal-argument-num-events (length (this-command-keys)))
b9ff190d 1581 (setq overriding-terminal-local-map universal-argument-map))
69d4c3c4
KH
1582
1583(defun digit-argument (arg)
1584 "Part of the numeric argument for the next command.
1585\\[universal-argument] following digits or minus sign ends the argument."
1586 (interactive "P")
bd7acc8d
GM
1587 (let* ((char (if (integerp last-command-char)
1588 last-command-char
1589 (get last-command-char 'ascii-character)))
1590 (digit (- (logand char ?\177) ?0)))
69d4c3c4
KH
1591 (cond ((integerp arg)
1592 (setq prefix-arg (+ (* arg 10)
1593 (if (< arg 0) (- digit) digit))))
1594 ((eq arg '-)
1595 ;; Treat -0 as just -, so that -01 will work.
1596 (setq prefix-arg (if (zerop digit) '- (- digit))))
1597 (t
b9ff190d 1598 (setq prefix-arg digit))))
0de84e16 1599 (setq universal-argument-num-events (length (this-command-keys)))
b9ff190d 1600 (setq overriding-terminal-local-map universal-argument-map))
69d4c3c4
KH
1601
1602;; For backward compatibility, minus with no modifiers is an ordinary
1603;; command if digits have already been entered.
1604(defun universal-argument-minus (arg)
1605 (interactive "P")
1606 (if (integerp arg)
1607 (universal-argument-other-key arg)
1608 (negative-argument arg)))
1609
1610;; Anything else terminates the argument and is left in the queue to be
1611;; executed as a command.
1612(defun universal-argument-other-key (arg)
1613 (interactive "P")
1614 (setq prefix-arg arg)
0de84e16
RS
1615 (let* ((key (this-command-keys))
1616 (keylist (listify-key-sequence key)))
1617 (setq unread-command-events
06697cdb
RS
1618 (append (nthcdr universal-argument-num-events keylist)
1619 unread-command-events)))
f0ef2555 1620 (reset-this-command-lengths)
69d4c3c4 1621 (setq overriding-terminal-local-map nil))
eaae8106 1622
93be67de 1623;;;; Window system cut and paste hooks.
70e14c01
JB
1624
1625(defvar interprogram-cut-function nil
1626 "Function to call to make a killed region available to other programs.
1627
1628Most window systems provide some sort of facility for cutting and
9f112a3d
RS
1629pasting text between the windows of different programs.
1630This variable holds a function that Emacs calls whenever text
1631is put in the kill ring, to make the new kill available to other
70e14c01
JB
1632programs.
1633
9f112a3d
RS
1634The function takes one or two arguments.
1635The first argument, TEXT, is a string containing
1636the text which should be made available.
1637The second, PUSH, if non-nil means this is a \"new\" kill;
1638nil means appending to an \"old\" kill.")
70e14c01
JB
1639
1640(defvar interprogram-paste-function nil
1641 "Function to call to get text cut from other programs.
1642
1643Most window systems provide some sort of facility for cutting and
9f112a3d
RS
1644pasting text between the windows of different programs.
1645This variable holds a function that Emacs calls to obtain
70e14c01
JB
1646text that other programs have provided for pasting.
1647
1648The function should be called with no arguments. If the function
1649returns nil, then no other program has provided such text, and the top
1650of the Emacs kill ring should be used. If the function returns a
daa37602
JB
1651string, that string should be put in the kill ring as the latest kill.
1652
1653Note that the function should return a string only if a program other
1654than Emacs has provided a string for pasting; if Emacs provided the
1655most recent string, the function should return nil. If it is
1656difficult to tell whether Emacs or some other program provided the
1657current string, it is probably good enough to return nil if the string
1658is equal (according to `string=') to the last text Emacs provided.")
70e14c01
JB
1659
1660
eaae8106 1661
70e14c01 1662;;;; The kill ring data structure.
2076c87c
JB
1663
1664(defvar kill-ring nil
70e14c01
JB
1665 "List of killed text sequences.
1666Since the kill ring is supposed to interact nicely with cut-and-paste
1667facilities offered by window systems, use of this variable should
1668interact nicely with `interprogram-cut-function' and
1669`interprogram-paste-function'. The functions `kill-new',
1670`kill-append', and `current-kill' are supposed to implement this
1671interaction; you may want to use them instead of manipulating the kill
1672ring directly.")
2076c87c 1673
bffa4d92 1674(defcustom kill-ring-max 60
69c1dd37
RS
1675 "*Maximum length of kill ring before oldest elements are thrown away."
1676 :type 'integer
1677 :group 'killing)
2076c87c
JB
1678
1679(defvar kill-ring-yank-pointer nil
1680 "The tail of the kill ring whose car is the last thing yanked.")
1681
f914dc91 1682(defun kill-new (string &optional replace)
70e14c01
JB
1683 "Make STRING the latest kill in the kill ring.
1684Set the kill-ring-yank pointer to point to it.
f914dc91
KH
1685If `interprogram-cut-function' is non-nil, apply it to STRING.
1686Optional second argument REPLACE non-nil means that STRING will replace
1687the front of the kill ring, rather than being added to the list."
f1d01ba2
KH
1688 (and (fboundp 'menu-bar-update-yank-menu)
1689 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
ab7e20d5 1690 (if (and replace kill-ring)
f914dc91
KH
1691 (setcar kill-ring string)
1692 (setq kill-ring (cons string kill-ring))
1693 (if (> (length kill-ring) kill-ring-max)
1694 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
70e14c01
JB
1695 (setq kill-ring-yank-pointer kill-ring)
1696 (if interprogram-cut-function
657a33ab 1697 (funcall interprogram-cut-function string (not replace))))
70e14c01 1698
2076c87c 1699(defun kill-append (string before-p)
70e14c01
JB
1700 "Append STRING to the end of the latest kill in the kill ring.
1701If BEFORE-P is non-nil, prepend STRING to the kill.
88c1aa79 1702If `interprogram-cut-function' is set, pass the resulting kill to
70e14c01 1703it."
f914dc91
KH
1704 (kill-new (if before-p
1705 (concat string (car kill-ring))
1706 (concat (car kill-ring) string)) t))
70e14c01
JB
1707
1708(defun current-kill (n &optional do-not-move)
1709 "Rotate the yanking point by N places, and then return that kill.
1710If N is zero, `interprogram-paste-function' is set, and calling it
1711returns a string, then that string is added to the front of the
1712kill ring and returned as the latest kill.
1e722f9f 1713If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
70e14c01
JB
1714yanking point; just return the Nth kill forward."
1715 (let ((interprogram-paste (and (= n 0)
1716 interprogram-paste-function
1717 (funcall interprogram-paste-function))))
1718 (if interprogram-paste
1719 (progn
1720 ;; Disable the interprogram cut function when we add the new
1721 ;; text to the kill ring, so Emacs doesn't try to own the
1722 ;; selection, with identical text.
1723 (let ((interprogram-cut-function nil))
1724 (kill-new interprogram-paste))
1725 interprogram-paste)
1726 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
1727 (let ((ARGth-kill-element
1728 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1729 (length kill-ring))
1730 kill-ring)))
70e14c01
JB
1731 (or do-not-move
1732 (setq kill-ring-yank-pointer ARGth-kill-element))
1733 (car ARGth-kill-element)))))
c88ab9ce 1734
c88ab9ce 1735
eaae8106 1736
70e14c01 1737;;;; Commands for manipulating the kill ring.
c88ab9ce 1738
69c1dd37
RS
1739(defcustom kill-read-only-ok nil
1740 "*Non-nil means don't signal an error for killing read-only text."
1741 :type 'boolean
1742 :group 'killing)
e6291fe1 1743
3a5da8a8
RS
1744(put 'text-read-only 'error-conditions
1745 '(text-read-only buffer-read-only error))
1746(put 'text-read-only 'error-message "Text is read-only")
1747
2076c87c
JB
1748(defun kill-region (beg end)
1749 "Kill between point and mark.
1750The text is deleted but saved in the kill ring.
1751The command \\[yank] can retrieve it from there.
1752\(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
2aa7a8bf
JB
1753If the buffer is read-only, Emacs will beep and refrain from deleting
1754the text, but put the text in the kill ring anyway. This means that
1755you can use the killing commands to copy text from a read-only buffer.
2076c87c
JB
1756
1757This is the primitive for programs to kill text (as opposed to deleting it).
1758Supply two arguments, character numbers indicating the stretch of text
1759 to be killed.
1760Any command that calls this function is a \"kill command\".
1761If the previous command was also a kill command,
1762the text killed this time appends to the text killed last time
1763to make one entry in the kill ring."
e761e42c 1764 (interactive "r")
ccd19b9f 1765 (condition-case nil
a1eb02bd
SM
1766 (let ((string (delete-and-extract-region beg end)))
1767 (when string ;STRING is nil if BEG = END
1768 ;; Add that string to the kill ring, one way or another.
1769 (if (eq last-command 'kill-region)
1770 (kill-append string (< end beg))
1771 (kill-new string)))
ccd19b9f
KH
1772 (setq this-command 'kill-region))
1773 ((buffer-read-only text-read-only)
1774 ;; The code above failed because the buffer, or some of the characters
1775 ;; in the region, are read-only.
1776 ;; We should beep, in case the user just isn't aware of this.
1777 ;; However, there's no harm in putting
1778 ;; the region's text in the kill ring, anyway.
1779 (copy-region-as-kill beg end)
cb3e1b4c
RS
1780 ;; Set this-command now, so it will be set even if we get an error.
1781 (setq this-command 'kill-region)
1782 ;; This should barf, if appropriate, and give us the correct error.
ccd19b9f
KH
1783 (if kill-read-only-ok
1784 (message "Read only text copied to kill ring")
ccd19b9f
KH
1785 ;; Signal an error if the buffer is read-only.
1786 (barf-if-buffer-read-only)
1787 ;; If the buffer isn't read-only, the text is.
1788 (signal 'text-read-only (list (current-buffer)))))))
2076c87c 1789
a382890a
KH
1790;; copy-region-as-kill no longer sets this-command, because it's confusing
1791;; to get two copies of the text when the user accidentally types M-w and
1792;; then corrects it with the intended C-w.
2076c87c
JB
1793(defun copy-region-as-kill (beg end)
1794 "Save the region as if killed, but don't kill it.
0e264847 1795In Transient Mark mode, deactivate the mark.
46947372
JB
1796If `interprogram-cut-function' is non-nil, also save the text for a window
1797system cut and paste."
2076c87c
JB
1798 (interactive "r")
1799 (if (eq last-command 'kill-region)
1800 (kill-append (buffer-substring beg end) (< end beg))
70e14c01 1801 (kill-new (buffer-substring beg end)))
1e722f9f 1802 (if transient-mark-mode
5c7319b6 1803 (setq deactivate-mark t))
2076c87c
JB
1804 nil)
1805
1806(defun kill-ring-save (beg end)
0964e562 1807 "Save the region as if killed, but don't kill it.
0e264847 1808In Transient Mark mode, deactivate the mark.
0964e562 1809If `interprogram-cut-function' is non-nil, also save the text for a window
0e264847
RS
1810system cut and paste.
1811
1812This command is similar to `copy-region-as-kill', except that it gives
1813visual feedback indicating the extent of the region being copied."
2076c87c
JB
1814 (interactive "r")
1815 (copy-region-as-kill beg end)
3a801d0c 1816 (if (interactive-p)
66050f10
RS
1817 (let ((other-end (if (= (point) beg) end beg))
1818 (opoint (point))
1819 ;; Inhibit quitting so we can make a quit here
1820 ;; look like a C-g typed as a command.
1821 (inhibit-quit t))
1822 (if (pos-visible-in-window-p other-end (selected-window))
1823 (progn
1824 ;; Swap point and mark.
1825 (set-marker (mark-marker) (point) (current-buffer))
1826 (goto-char other-end)
1827 (sit-for 1)
1828 ;; Swap back.
1829 (set-marker (mark-marker) other-end (current-buffer))
1830 (goto-char opoint)
1831 ;; If user quit, deactivate the mark
1832 ;; as C-g would as a command.
e4e593ae 1833 (and quit-flag mark-active
fcadf1c7 1834 (deactivate-mark)))
66050f10
RS
1835 (let* ((killed-text (current-kill 0))
1836 (message-len (min (length killed-text) 40)))
1837 (if (= (point) beg)
1838 ;; Don't say "killed"; that is misleading.
1839 (message "Saved text until \"%s\""
1840 (substring killed-text (- message-len)))
1841 (message "Saved text from \"%s\""
1842 (substring killed-text 0 message-len))))))))
2076c87c 1843
c75d4986
KH
1844(defun append-next-kill (&optional interactive)
1845 "Cause following command, if it kills, to append to previous kill.
1846The argument is used for internal purposes; do not supply one."
1847 (interactive "p")
1848 ;; We don't use (interactive-p), since that breaks kbd macros.
1849 (if interactive
2076c87c
JB
1850 (progn
1851 (setq this-command 'kill-region)
1852 (message "If the next command is a kill, it will append"))
1853 (setq last-command 'kill-region)))
eaae8106 1854
93be67de 1855;; Yanking.
2076c87c 1856
2076c87c 1857(defun yank-pop (arg)
ff1fbe3e
RS
1858 "Replace just-yanked stretch of killed text with a different stretch.
1859This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 1860At such a time, the region contains a stretch of reinserted
ff1fbe3e 1861previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
1862place a different stretch of killed text.
1863
1864With no argument, the previous kill is inserted.
ff1fbe3e
RS
1865With argument N, insert the Nth previous kill.
1866If N is negative, this is a more recent kill.
2076c87c
JB
1867
1868The sequence of kills wraps around, so that after the oldest one
1869comes the newest one."
1870 (interactive "*p")
1871 (if (not (eq last-command 'yank))
1872 (error "Previous command was not a yank"))
1873 (setq this-command 'yank)
3a5da8a8
RS
1874 (let ((inhibit-read-only t)
1875 (before (< (point) (mark t))))
9a1277dd 1876 (delete-region (point) (mark t))
fd0f4056 1877 (set-marker (mark-marker) (point) (current-buffer))
6cd829a8 1878 (let ((opoint (point)))
7ae13091 1879 (insert (current-kill arg))
6cd829a8
RS
1880 (let ((inhibit-read-only t))
1881 (remove-text-properties opoint (point) '(read-only nil))))
fd0f4056
RS
1882 (if before
1883 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1884 ;; It is cleaner to avoid activation, even though the command
1885 ;; loop would deactivate the mark because we inserted text.
1886 (goto-char (prog1 (mark t)
1887 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 1888 nil)
2076c87c
JB
1889
1890(defun yank (&optional arg)
1891 "Reinsert the last stretch of killed text.
1892More precisely, reinsert the stretch of killed text most recently
ff1fbe3e
RS
1893killed OR yanked. Put point at end, and set mark at beginning.
1894With just C-u as argument, same but put point at beginning (and mark at end).
1895With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c
JB
1896text.
1897See also the command \\[yank-pop]."
1898 (interactive "*P")
456c617c
RS
1899 ;; If we don't get all the way thru, make last-command indicate that
1900 ;; for the following command.
1901 (setq this-command t)
2076c87c 1902 (push-mark (point))
6cd829a8 1903 (let ((opoint (point)))
7ae13091
RS
1904 (insert (current-kill (cond
1905 ((listp arg) 0)
1906 ((eq arg '-) -1)
1907 (t (1- arg)))))
6cd829a8
RS
1908 (let ((inhibit-read-only t))
1909 (remove-text-properties opoint (point) '(read-only nil))))
2076c87c 1910 (if (consp arg)
fd0f4056
RS
1911 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1912 ;; It is cleaner to avoid activation, even though the command
1913 ;; loop would deactivate the mark because we inserted text.
1914 (goto-char (prog1 (mark t)
1915 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c
RS
1916 ;; If we do get all the way thru, make this-command indicate that.
1917 (setq this-command 'yank)
0964e562 1918 nil)
70e14c01
JB
1919
1920(defun rotate-yank-pointer (arg)
1921 "Rotate the yanking point in the kill ring.
1922With argument, rotate that many kills forward (or backward, if negative)."
1923 (interactive "p")
1924 (current-kill arg))
eaae8106 1925
93be67de
KH
1926;; Some kill commands.
1927
1928;; Internal subroutine of delete-char
1929(defun kill-forward-chars (arg)
1930 (if (listp arg) (setq arg (car arg)))
1931 (if (eq arg '-) (setq arg -1))
1932 (kill-region (point) (forward-point arg)))
1933
1934;; Internal subroutine of backward-delete-char
1935(defun kill-backward-chars (arg)
1936 (if (listp arg) (setq arg (car arg)))
1937 (if (eq arg '-) (setq arg -1))
1938 (kill-region (point) (forward-point (- arg))))
1939
1940(defcustom backward-delete-char-untabify-method 'untabify
1941 "*The method for untabifying when deleting backward.
1e722f9f
SS
1942Can be `untabify' -- turn a tab to many spaces, then delete one space;
1943 `hungry' -- delete all whitespace, both tabs and spaces;
1944 `all' -- delete all whitespace, including tabs, spaces and newlines;
93be67de 1945 nil -- just delete one character."
1e722f9f 1946 :type '(choice (const untabify) (const hungry) (const all) (const nil))
03167a34 1947 :version "20.3"
93be67de
KH
1948 :group 'killing)
1949
1950(defun backward-delete-char-untabify (arg &optional killp)
1951 "Delete characters backward, changing tabs into spaces.
1952The exact behavior depends on `backward-delete-char-untabify-method'.
1953Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
1954Interactively, ARG is the prefix arg (default 1)
1955and KILLP is t if a prefix arg was specified."
1956 (interactive "*p\nP")
1957 (when (eq backward-delete-char-untabify-method 'untabify)
1958 (let ((count arg))
1959 (save-excursion
1960 (while (and (> count 0) (not (bobp)))
1961 (if (= (preceding-char) ?\t)
1962 (let ((col (current-column)))
1963 (forward-char -1)
1964 (setq col (- col (current-column)))
1965 (insert-char ?\ col)
1966 (delete-char 1)))
1967 (forward-char -1)
1968 (setq count (1- count))))))
1969 (delete-backward-char
1e722f9f
SS
1970 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1971 ((eq backward-delete-char-untabify-method 'all)
1972 " \t\n\r"))))
1973 (if skip
1974 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
93be67de
KH
1975 (point)))))
1976 (+ arg (if (zerop wh) 0 (1- wh))))
1e722f9f 1977 arg))
93be67de
KH
1978 killp))
1979
1980(defun zap-to-char (arg char)
1981 "Kill up to and including ARG'th occurrence of CHAR.
1982Case is ignored if `case-fold-search' is non-nil in the current buffer.
1983Goes backward if ARG is negative; error if CHAR not found."
e761e42c 1984 (interactive "p\ncZap to char: ")
93be67de
KH
1985 (kill-region (point) (progn
1986 (search-forward (char-to-string char) nil nil arg)
1987; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
1988 (point))))
eaae8106 1989
93be67de
KH
1990;; kill-line and its subroutines.
1991
1992(defcustom kill-whole-line nil
1993 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
1994 :type 'boolean
1995 :group 'killing)
1996
1997(defun kill-line (&optional arg)
1998 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1999With prefix argument, kill that many lines from point.
2000Negative arguments kill lines backward.
8be7408c 2001With zero argument, kills the text before point on the current line.
93be67de
KH
2002
2003When calling from a program, nil means \"no arg\",
2004a number counts as a prefix arg.
2005
2006To kill a whole line, when point is not at the beginning, type \
2007\\[beginning-of-line] \\[kill-line] \\[kill-line].
2008
2009If `kill-whole-line' is non-nil, then this command kills the whole line
2010including its terminating newline, when used at the beginning of a line
2011with no argument. As a consequence, you can always kill a whole line
d3f22784
EZ
2012by typing \\[beginning-of-line] \\[kill-line].
2013
2014If the buffer is read-only, Emacs will beep and refrain from deleting
2015the line, but put the line in the kill ring anyway. This means that
2016you can use this command to copy text from a read-only buffer."
e761e42c 2017 (interactive "P")
93be67de
KH
2018 (kill-region (point)
2019 ;; It is better to move point to the other end of the kill
2020 ;; before killing. That way, in a read-only buffer, point
2021 ;; moves across the text that is copied to the kill ring.
2022 ;; The choice has no effect on undo now that undo records
2023 ;; the value of point from before the command was run.
2024 (progn
2025 (if arg
2026 (forward-visible-line (prefix-numeric-value arg))
2027 (if (eobp)
2028 (signal 'end-of-buffer nil))
2029 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
2030 (forward-visible-line 1)
2031 (end-of-visible-line)))
2032 (point))))
2033
2034(defun forward-visible-line (arg)
2035 "Move forward by ARG lines, ignoring currently invisible newlines only.
2036If ARG is negative, move backward -ARG lines.
2037If ARG is zero, move to the beginning of the current line."
2038 (condition-case nil
2039 (if (> arg 0)
2040 (while (> arg 0)
2041 (or (zerop (forward-line 1))
2042 (signal 'end-of-buffer nil))
2043 ;; If the following character is currently invisible,
2044 ;; skip all characters with that same `invisible' property value,
2045 ;; then find the next newline.
2046 (while (and (not (eobp))
2047 (let ((prop
2048 (get-char-property (point) 'invisible)))
2049 (if (eq buffer-invisibility-spec t)
2050 prop
2051 (or (memq prop buffer-invisibility-spec)
2052 (assq prop buffer-invisibility-spec)))))
2053 (goto-char
2054 (if (get-text-property (point) 'invisible)
2055 (or (next-single-property-change (point) 'invisible)
2056 (point-max))
2057 (next-overlay-change (point))))
2058 (or (zerop (forward-line 1))
2059 (signal 'end-of-buffer nil)))
2060 (setq arg (1- arg)))
2061 (let ((first t))
2062 (while (or first (< arg 0))
2063 (if (zerop arg)
2064 (beginning-of-line)
2065 (or (zerop (forward-line -1))
2066 (signal 'beginning-of-buffer nil)))
2067 (while (and (not (bobp))
2068 (let ((prop
2069 (get-char-property (1- (point)) 'invisible)))
2070 (if (eq buffer-invisibility-spec t)
2071 prop
2072 (or (memq prop buffer-invisibility-spec)
2073 (assq prop buffer-invisibility-spec)))))
2074 (goto-char
2075 (if (get-text-property (1- (point)) 'invisible)
2076 (or (previous-single-property-change (point) 'invisible)
2077 (point-min))
2078 (previous-overlay-change (point))))
2079 (or (zerop (forward-line -1))
2080 (signal 'beginning-of-buffer nil)))
2081 (setq first nil)
2082 (setq arg (1+ arg)))))
2083 ((beginning-of-buffer end-of-buffer)
2084 nil)))
70e14c01 2085
93be67de
KH
2086(defun end-of-visible-line ()
2087 "Move to end of current visible line."
2088 (end-of-line)
2089 ;; If the following character is currently invisible,
2090 ;; skip all characters with that same `invisible' property value,
2091 ;; then find the next newline.
2092 (while (and (not (eobp))
2093 (let ((prop
2094 (get-char-property (point) 'invisible)))
2095 (if (eq buffer-invisibility-spec t)
2096 prop
2097 (or (memq prop buffer-invisibility-spec)
2098 (assq prop buffer-invisibility-spec)))))
2099 (if (get-text-property (point) 'invisible)
2100 (goto-char (next-single-property-change (point) 'invisible))
2101 (goto-char (next-overlay-change (point))))
2102 (end-of-line)))
eaae8106 2103
2076c87c
JB
2104(defun insert-buffer (buffer)
2105 "Insert after point the contents of BUFFER.
2106Puts mark after the inserted text.
6cb6e7a2
GM
2107BUFFER may be a buffer or a buffer name.
2108
2109This function is meant for the user to run interactively.
2110Don't call it from programs!"
c3d4f949 2111 (interactive
a3e7c391
FP
2112 (list
2113 (progn
2114 (barf-if-buffer-read-only)
2115 (read-buffer "Insert buffer: "
2116 (if (eq (selected-window) (next-window (selected-window)))
2117 (other-buffer (current-buffer))
2118 (window-buffer (next-window (selected-window))))
2119 t))))
2076c87c
JB
2120 (or (bufferp buffer)
2121 (setq buffer (get-buffer buffer)))
2122 (let (start end newmark)
2123 (save-excursion
2124 (save-excursion
2125 (set-buffer buffer)
2126 (setq start (point-min) end (point-max)))
2127 (insert-buffer-substring buffer start end)
2128 (setq newmark (point)))
1537a263
JB
2129 (push-mark newmark))
2130 nil)
2076c87c
JB
2131
2132(defun append-to-buffer (buffer start end)
2133 "Append to specified buffer the text of the region.
2134It is inserted into that buffer before its point.
2135
2136When calling from a program, give three arguments:
2137BUFFER (or buffer name), START and END.
2138START and END specify the portion of the current buffer to be copied."
70e14c01 2139 (interactive
5d771766 2140 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 2141 (region-beginning) (region-end)))
2076c87c
JB
2142 (let ((oldbuf (current-buffer)))
2143 (save-excursion
c069a480
GM
2144 (let* ((append-to (get-buffer-create buffer))
2145 (windows (get-buffer-window-list append-to t t))
2146 point)
2147 (set-buffer append-to)
2148 (setq point (point))
2149 (barf-if-buffer-read-only)
2150 (insert-buffer-substring oldbuf start end)
2151 (dolist (window windows)
2152 (when (= (window-point window) point)
2153 (set-window-point window (point))))))))
2076c87c
JB
2154
2155(defun prepend-to-buffer (buffer start end)
2156 "Prepend to specified buffer the text of the region.
2157It is inserted into that buffer after its point.
2158
2159When calling from a program, give three arguments:
2160BUFFER (or buffer name), START and END.
2161START and END specify the portion of the current buffer to be copied."
2162 (interactive "BPrepend to buffer: \nr")
2163 (let ((oldbuf (current-buffer)))
2164 (save-excursion
2165 (set-buffer (get-buffer-create buffer))
74399eac 2166 (barf-if-buffer-read-only)
2076c87c
JB
2167 (save-excursion
2168 (insert-buffer-substring oldbuf start end)))))
2169
2170(defun copy-to-buffer (buffer start end)
2171 "Copy to specified buffer the text of the region.
2172It is inserted into that buffer, replacing existing text there.
2173
2174When calling from a program, give three arguments:
2175BUFFER (or buffer name), START and END.
2176START and END specify the portion of the current buffer to be copied."
2177 (interactive "BCopy to buffer: \nr")
2178 (let ((oldbuf (current-buffer)))
2179 (save-excursion
2180 (set-buffer (get-buffer-create buffer))
74399eac 2181 (barf-if-buffer-read-only)
2076c87c
JB
2182 (erase-buffer)
2183 (save-excursion
2184 (insert-buffer-substring oldbuf start end)))))
eaae8106 2185
62d1c1fc
RM
2186(put 'mark-inactive 'error-conditions '(mark-inactive error))
2187(put 'mark-inactive 'error-message "The mark is not active now")
2188
af39530e 2189(defun mark (&optional force)
c7c8b31e 2190 "Return this buffer's mark value as integer; error if mark inactive.
af39530e 2191If optional argument FORCE is non-nil, access the mark value
c7c8b31e
RS
2192even if the mark is not currently active, and return nil
2193if there is no mark at all.
af39530e 2194
2076c87c
JB
2195If you are using this in an editing command, you are most likely making
2196a mistake; see the documentation of `set-mark'."
0e3a7b14 2197 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
af39530e 2198 (marker-position (mark-marker))
62d1c1fc 2199 (signal 'mark-inactive nil)))
2076c87c 2200
19d35374
RM
2201;; Many places set mark-active directly, and several of them failed to also
2202;; run deactivate-mark-hook. This shorthand should simplify.
2203(defsubst deactivate-mark ()
2204 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 2205\(That makes a difference only in Transient Mark mode.)
19d35374 2206Also runs the hook `deactivate-mark-hook'."
a4b9d3da
RS
2207 (if transient-mark-mode
2208 (progn
2209 (setq mark-active nil)
2210 (run-hooks 'deactivate-mark-hook))))
19d35374 2211
2076c87c
JB
2212(defun set-mark (pos)
2213 "Set this buffer's mark to POS. Don't use this function!
2214That is to say, don't use this function unless you want
2215the user to see that the mark has moved, and you want the previous
2216mark position to be lost.
2217
2218Normally, when a new mark is set, the old one should go on the stack.
2219This is why most applications should use push-mark, not set-mark.
2220
ff1fbe3e 2221Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
2222purposes. The mark saves a location for the user's convenience.
2223Most editing commands should not alter the mark.
2224To remember a location for internal use in the Lisp program,
2225store it in a Lisp variable. Example:
2226
2227 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2228
fcadf1c7
RS
2229 (if pos
2230 (progn
2231 (setq mark-active t)
2232 (run-hooks 'activate-mark-hook)
2233 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
2234 ;; Normally we never clear mark-active except in Transient Mark mode.
2235 ;; But when we actually clear out the mark value too,
2236 ;; we must clear mark-active in any mode.
2237 (setq mark-active nil)
2238 (run-hooks 'deactivate-mark-hook)
2239 (set-marker (mark-marker) nil)))
2076c87c
JB
2240
2241(defvar mark-ring nil
e55e2267 2242 "The list of former marks of the current buffer, most recent first.")
2076c87c 2243(make-variable-buffer-local 'mark-ring)
e55e2267 2244(put 'mark-ring 'permanent-local t)
2076c87c 2245
69c1dd37
RS
2246(defcustom mark-ring-max 16
2247 "*Maximum size of mark ring. Start discarding off end if gets this big."
2248 :type 'integer
2249 :group 'editing-basics)
2076c87c 2250
dc029f0b
RM
2251(defvar global-mark-ring nil
2252 "The list of saved global marks, most recent first.")
2253
69c1dd37 2254(defcustom global-mark-ring-max 16
dc029f0b 2255 "*Maximum size of global mark ring. \
69c1dd37
RS
2256Start discarding off end if gets this big."
2257 :type 'integer
2258 :group 'editing-basics)
dc029f0b 2259
2076c87c
JB
2260(defun set-mark-command (arg)
2261 "Set mark at where point is, or jump to mark.
dc029f0b
RM
2262With no prefix argument, set mark, push old mark position on local mark
2263ring, and push mark on global mark ring.
2264With argument, jump to mark, and pop a new position for mark off the ring
2265\(does not affect global mark ring\).
2076c87c 2266
ff1fbe3e 2267Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
2268purposes. See the documentation of `set-mark' for more information."
2269 (interactive "P")
2270 (if (null arg)
9a1277dd 2271 (progn
fd0f4056 2272 (push-mark nil nil t))
af39530e 2273 (if (null (mark t))
2076c87c 2274 (error "No mark set in this buffer")
9a1277dd 2275 (goto-char (mark t))
2076c87c
JB
2276 (pop-mark))))
2277
fd0f4056 2278(defun push-mark (&optional location nomsg activate)
2076c87c 2279 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
2280If the last global mark pushed was not in the current buffer,
2281also push LOCATION on the global mark ring.
fd0f4056 2282Display `Mark set' unless the optional second arg NOMSG is non-nil.
8cdc660f 2283In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2076c87c 2284
ff1fbe3e 2285Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
2286purposes. See the documentation of `set-mark' for more information.
2287
2288In Transient Mark mode, this does not activate the mark."
af39530e 2289 (if (null (mark t))
2076c87c
JB
2290 nil
2291 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2292 (if (> (length mark-ring) mark-ring-max)
2293 (progn
2294 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2295 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
9a1277dd 2296 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 2297 ;; Now push the mark on the global mark ring.
f1382a3d 2298 (if (and global-mark-ring
e08d3f7c 2299 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
2300 ;; The last global mark pushed was in this same buffer.
2301 ;; Don't push another one.
2302 nil
2303 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
dc029f0b
RM
2304 (if (> (length global-mark-ring) global-mark-ring-max)
2305 (progn
2306 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2307 nil)
f1382a3d 2308 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
efcf38c7 2309 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2076c87c 2310 (message "Mark set"))
8cdc660f
RS
2311 (if (or activate (not transient-mark-mode))
2312 (set-mark (mark t)))
2076c87c
JB
2313 nil)
2314
2315(defun pop-mark ()
2316 "Pop off mark ring into the buffer's actual mark.
2317Does not set point. Does nothing if mark ring is empty."
2318 (if mark-ring
2319 (progn
2320 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
9a1277dd 2321 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
19d35374 2322 (deactivate-mark)
2076c87c 2323 (move-marker (car mark-ring) nil)
9a1277dd 2324 (if (null (mark t)) (ding))
2076c87c
JB
2325 (setq mark-ring (cdr mark-ring)))))
2326
e462e42f 2327(defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2076c87c 2328(defun exchange-point-and-mark ()
af39530e
RS
2329 "Put the mark where point is now, and point where the mark is now.
2330This command works even when the mark is not active,
2331and it reactivates the mark."
2076c87c 2332 (interactive nil)
af39530e 2333 (let ((omark (mark t)))
2076c87c
JB
2334 (if (null omark)
2335 (error "No mark set in this buffer"))
2336 (set-mark (point))
2337 (goto-char omark)
2338 nil))
e23c2c21 2339
22c3935a 2340(defun transient-mark-mode (arg)
e23c2c21 2341 "Toggle Transient Mark mode.
b411b5fa 2342With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 2343
5dd1220d
RS
2344In Transient Mark mode, when the mark is active, the region is highlighted.
2345Changing the buffer \"deactivates\" the mark.
2346So do certain other operations that set the mark
2347but whose main purpose is something else--for example,
cfa70244
EZ
2348incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
2349
2350Many commands change their behavior when Transient Mark mode is in effect
2351and the mark is active, by acting on the region instead of their usual
4c5f7215 2352default part of the buffer's text. Examples of such commands include
cfa70244
EZ
2353\\[comment-dwim], \\[flush-lines], \\[ispell], \\[keep-lines],
2354\\[query-replace], \\[query-replace-regexp], and \\[undo]. Invoke
c4e39bdd
EZ
2355\\[apropos-documentation] and type \"transient\" or \"mark.*active\" at
2356the prompt, to see the documentation of commands which are sensitive to
2357the Transient Mark mode."
22c3935a 2358 (interactive "P")
e23c2c21
RS
2359 (setq transient-mark-mode
2360 (if (null arg)
2361 (not transient-mark-mode)
2c5d387c 2362 (> (prefix-numeric-value arg) 0)))
22c3935a
RS
2363 (if (interactive-p)
2364 (if transient-mark-mode
2365 (message "Transient Mark mode enabled")
2366 (message "Transient Mark mode disabled"))))
dc029f0b
RM
2367
2368(defun pop-global-mark ()
2369 "Pop off global mark ring and jump to the top location."
2370 (interactive)
52b6d445
RS
2371 ;; Pop entries which refer to non-existent buffers.
2372 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2373 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
2374 (or global-mark-ring
2375 (error "No global mark set"))
2376 (let* ((marker (car global-mark-ring))
2377 (buffer (marker-buffer marker))
2378 (position (marker-position marker)))
34c31301
RS
2379 (setq global-mark-ring (nconc (cdr global-mark-ring)
2380 (list (car global-mark-ring))))
dc029f0b
RM
2381 (set-buffer buffer)
2382 (or (and (>= position (point-min))
2383 (<= position (point-max)))
2384 (widen))
2385 (goto-char position)
2386 (switch-to-buffer buffer)))
eaae8106 2387
95791033 2388(defcustom next-line-add-newlines nil
69c1dd37
RS
2389 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2390 :type 'boolean
e1d6e383 2391 :version "21.1"
69c1dd37 2392 :group 'editing-basics)
38ebcf29 2393
2076c87c
JB
2394(defun next-line (arg)
2395 "Move cursor vertically down ARG lines.
2396If there is no character in the target line exactly under the current column,
2397the cursor is positioned after the character in that line which spans this
2398column, or at the end of the line if it is not long enough.
38ebcf29 2399If there is no line in the buffer after this one, behavior depends on the
1a2c3941
RS
2400value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2401to create a line, and moves the cursor to that line. Otherwise it moves the
e47d38f6 2402cursor to the end of the buffer.
2076c87c
JB
2403
2404The command \\[set-goal-column] can be used to create
85969cb1
RS
2405a semipermanent goal column for this command.
2406Then instead of trying to move exactly vertically (or as close as possible),
2407this command moves to the specified goal column (or as close as possible).
2408The goal column is stored in the variable `goal-column', which is nil
2409when there is no goal column.
2076c87c
JB
2410
2411If you are thinking of using this in a Lisp program, consider
2412using `forward-line' instead. It is usually easier to use
2413and more reliable (no dependence on goal column, etc.)."
2414 (interactive "p")
028922cf 2415 (if (and next-line-add-newlines (= arg 1))
207d7545
GM
2416 (if (save-excursion (end-of-line) (eobp))
2417 ;; When adding a newline, don't expand an abbrev.
2418 (let ((abbrev-mode nil))
24886813
GM
2419 (end-of-line)
2420 (insert "\n"))
207d7545 2421 (line-move arg))
1a2c3941
RS
2422 (if (interactive-p)
2423 (condition-case nil
2424 (line-move arg)
2425 ((beginning-of-buffer end-of-buffer) (ding)))
2426 (line-move arg)))
2076c87c
JB
2427 nil)
2428
2429(defun previous-line (arg)
2430 "Move cursor vertically up ARG lines.
2431If there is no character in the target line exactly over the current column,
2432the cursor is positioned after the character in that line which spans this
2433column, or at the end of the line if it is not long enough.
2434
2435The command \\[set-goal-column] can be used to create
85969cb1
RS
2436a semipermanent goal column for this command.
2437Then instead of trying to move exactly vertically (or as close as possible),
2438this command moves to the specified goal column (or as close as possible).
2439The goal column is stored in the variable `goal-column', which is nil
2440when there is no goal column.
2076c87c
JB
2441
2442If you are thinking of using this in a Lisp program, consider using
c2e8a012 2443`forward-line' with a negative argument instead. It is usually easier
2076c87c
JB
2444to use and more reliable (no dependence on goal column, etc.)."
2445 (interactive "p")
1a2c3941
RS
2446 (if (interactive-p)
2447 (condition-case nil
2448 (line-move (- arg))
2449 ((beginning-of-buffer end-of-buffer) (ding)))
2450 (line-move (- arg)))
2076c87c 2451 nil)
eaae8106 2452
69c1dd37 2453(defcustom track-eol nil
2076c87c
JB
2454 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2455This means moving to the end of each line moved onto.
69c1dd37
RS
2456The beginning of a blank line does not count as the end of a line."
2457 :type 'boolean
2458 :group 'editing-basics)
2459
2460(defcustom goal-column nil
2461 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2462 :type '(choice integer
2463 (const :tag "None" nil))
2464 :group 'editing-basics)
912c6728 2465(make-variable-buffer-local 'goal-column)
2076c87c
JB
2466
2467(defvar temporary-goal-column 0
2468 "Current goal column for vertical motion.
2469It is the column where point was
2470at the start of current run of vertical motion commands.
c637ae6f 2471When the `track-eol' feature is doing its job, the value is 9999.")
2076c87c 2472
69c1dd37 2473(defcustom line-move-ignore-invisible nil
098fc1fb 2474 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
69c1dd37
RS
2475Outline mode sets this."
2476 :type 'boolean
2477 :group 'editing-basics)
098fc1fb 2478
8c745744
RS
2479;; This is the guts of next-line and previous-line.
2480;; Arg says how many lines to move.
2076c87c 2481(defun line-move (arg)
2596511d
RS
2482 ;; Don't run any point-motion hooks, and disregard intangibility,
2483 ;; for intermediate positions.
2484 (let ((inhibit-point-motion-hooks t)
2485 (opoint (point))
6c8499b9 2486 new line-end line-beg)
2596511d
RS
2487 (unwind-protect
2488 (progn
2489 (if (not (or (eq last-command 'next-line)
2490 (eq last-command 'previous-line)))
2491 (setq temporary-goal-column
2492 (if (and track-eol (eolp)
2493 ;; Don't count beg of empty line as end of line
2494 ;; unless we just did explicit end-of-line.
2495 (or (not (bolp)) (eq last-command 'end-of-line)))
2496 9999
2497 (current-column))))
2498 (if (and (not (integerp selective-display))
2499 (not line-move-ignore-invisible))
2500 ;; Use just newline characters.
2501 (or (if (> arg 0)
2502 (progn (if (> arg 1) (forward-line (1- arg)))
2503 ;; This way of moving forward ARG lines
2504 ;; verifies that we have a newline after the last one.
2505 ;; It doesn't get confused by intangible text.
2506 (end-of-line)
2507 (zerop (forward-line 1)))
2508 (and (zerop (forward-line arg))
2509 (bolp)))
2510 (signal (if (< arg 0)
2511 'beginning-of-buffer
2512 'end-of-buffer)
2513 nil))
2514 ;; Move by arg lines, but ignore invisible ones.
2515 (while (> arg 0)
2516 (end-of-line)
2517 (and (zerop (vertical-motion 1))
2518 (signal 'end-of-buffer nil))
2519 ;; If the following character is currently invisible,
2520 ;; skip all characters with that same `invisible' property value.
2521 (while (and (not (eobp))
2522 (let ((prop
2523 (get-char-property (point) 'invisible)))
2524 (if (eq buffer-invisibility-spec t)
2525 prop
2526 (or (memq prop buffer-invisibility-spec)
2527 (assq prop buffer-invisibility-spec)))))
2528 (if (get-text-property (point) 'invisible)
2529 (goto-char (next-single-property-change (point) 'invisible))
2530 (goto-char (next-overlay-change (point)))))
2531 (setq arg (1- arg)))
2532 (while (< arg 0)
2533 (beginning-of-line)
2534 (and (zerop (vertical-motion -1))
2535 (signal 'beginning-of-buffer nil))
2536 (while (and (not (bobp))
2537 (let ((prop
2538 (get-char-property (1- (point)) 'invisible)))
2539 (if (eq buffer-invisibility-spec t)
2540 prop
2541 (or (memq prop buffer-invisibility-spec)
2542 (assq prop buffer-invisibility-spec)))))
2543 (if (get-text-property (1- (point)) 'invisible)
2544 (goto-char (previous-single-property-change (point) 'invisible))
2545 (goto-char (previous-overlay-change (point)))))
2546 (setq arg (1+ arg))))
0565d307
RS
2547 (let ((buffer-invisibility-spec nil))
2548 (move-to-column (or goal-column temporary-goal-column))))
50be475d
RS
2549 (setq new (point))
2550 ;; If we are moving into some intangible text,
2551 ;; look for following text on the same line which isn't intangible
2552 ;; and move there.
6c8499b9
RS
2553 (setq line-end (save-excursion (end-of-line) (point)))
2554 (setq line-beg (save-excursion (beginning-of-line) (point)))
50be475d
RS
2555 (let ((after (and (< new (point-max))
2556 (get-char-property new 'intangible)))
2557 (before (and (> new (point-min))
6c8499b9
RS
2558 (get-char-property (1- new) 'intangible))))
2559 (when (and before (eq before after)
2560 (not (bolp)))
50be475d
RS
2561 (goto-char (point-min))
2562 (let ((inhibit-point-motion-hooks nil))
2563 (goto-char new))
2564 (if (<= new line-end)
2565 (setq new (point)))))
6c8499b9
RS
2566 ;; NEW is where we want to move to.
2567 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2568 ;; Move there in just one step, from our starting position,
2569 ;; with intangibility and point-motion hooks enabled this time.
2596511d
RS
2570 (goto-char opoint)
2571 (setq inhibit-point-motion-hooks nil)
59b19d32
MB
2572 (goto-char (constrain-to-field new opoint nil t
2573 'inhibit-line-move-field-capture))
6c8499b9
RS
2574 ;; If intangibility processing moved us to a different line,
2575 ;; readjust the horizontal position within the line we ended up at.
2576 (when (or (< (point) line-beg) (> (point) line-end))
2577 (setq new (point))
2578 (setq inhibit-point-motion-hooks t)
2579 (setq line-end (save-excursion (end-of-line) (point)))
2580 (beginning-of-line)
2581 (setq line-beg (point))
2582 (let ((buffer-invisibility-spec nil))
2583 (move-to-column (or goal-column temporary-goal-column)))
2584 (if (<= (point) line-end)
2585 (setq new (point)))
2586 (goto-char (point-min))
2587 (setq inhibit-point-motion-hooks nil)
59b19d32
MB
2588 (goto-char (constrain-to-field new opoint nil t
2589 'inhibit-line-move-field-capture))
6c8499b9 2590 )))
2596511d 2591 nil)
2076c87c 2592
d5ab2033
JB
2593;;; Many people have said they rarely use this feature, and often type
2594;;; it by accident. Maybe it shouldn't even be on a key.
2595(put 'set-goal-column 'disabled t)
2076c87c
JB
2596
2597(defun set-goal-column (arg)
2598 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2599Those commands will move to this position in the line moved to
2600rather than trying to keep the same horizontal position.
2601With a non-nil argument, clears out the goal column
912c6728
RS
2602so that \\[next-line] and \\[previous-line] resume vertical motion.
2603The goal column is stored in the variable `goal-column'."
2076c87c
JB
2604 (interactive "P")
2605 (if arg
2606 (progn
2607 (setq goal-column nil)
2608 (message "No goal column"))
2609 (setq goal-column (current-column))
2610 (message (substitute-command-keys
2611 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2612 goal-column))
2613 nil)
eaae8106 2614
7492f5a6
RS
2615
2616(defun scroll-other-window-down (lines)
e47d38f6
RS
2617 "Scroll the \"other window\" down.
2618For more details, see the documentation for `scroll-other-window'."
7492f5a6
RS
2619 (interactive "P")
2620 (scroll-other-window
2621 ;; Just invert the argument's meaning.
2622 ;; We can do that without knowing which window it will be.
2623 (if (eq lines '-) nil
2624 (if (null lines) '-
2625 (- (prefix-numeric-value lines))))))
e47d38f6 2626(define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
3aef9604
RS
2627
2628(defun beginning-of-buffer-other-window (arg)
2629 "Move point to the beginning of the buffer in the other window.
2630Leave mark at previous position.
2631With arg N, put point N/10 of the way from the true beginning."
2632 (interactive "P")
2633 (let ((orig-window (selected-window))
2634 (window (other-window-for-scrolling)))
2635 ;; We use unwind-protect rather than save-window-excursion
2636 ;; because the latter would preserve the things we want to change.
2637 (unwind-protect
2638 (progn
2639 (select-window window)
2640 ;; Set point and mark in that window's buffer.
2641 (beginning-of-buffer arg)
2642 ;; Set point accordingly.
2643 (recenter '(t)))
2644 (select-window orig-window))))
2645
2646(defun end-of-buffer-other-window (arg)
2647 "Move point to the end of the buffer in the other window.
2648Leave mark at previous position.
2649With arg N, put point N/10 of the way from the true end."
2650 (interactive "P")
2651 ;; See beginning-of-buffer-other-window for comments.
2652 (let ((orig-window (selected-window))
2653 (window (other-window-for-scrolling)))
2654 (unwind-protect
2655 (progn
2656 (select-window window)
4500ff36 2657 (end-of-buffer arg)
3aef9604
RS
2658 (recenter '(t)))
2659 (select-window orig-window))))
eaae8106 2660
2076c87c
JB
2661(defun transpose-chars (arg)
2662 "Interchange characters around point, moving forward one character.
2663With prefix arg ARG, effect is to take character before point
2664and drag it forward past ARG other characters (backward if ARG negative).
2665If no argument and at end of line, the previous two chars are exchanged."
2666 (interactive "*P")
2667 (and (null arg) (eolp) (forward-char -1))
2668 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2669
2670(defun transpose-words (arg)
2671 "Interchange words around point, leaving point at end of them.
2672With prefix arg ARG, effect is to take word before or around point
2673and drag it forward past ARG other words (backward if ARG negative).
2674If ARG is zero, the words around or after point and around or after mark
2675are interchanged."
2676 (interactive "*p")
2677 (transpose-subr 'forward-word arg))
2678
2679(defun transpose-sexps (arg)
2680 "Like \\[transpose-words] but applies to sexps.
2681Does not work on a sexp that point is in the middle of
2682if it is a list or string."
2683 (interactive "*p")
2684 (transpose-subr 'forward-sexp arg))
2685
2686(defun transpose-lines (arg)
2687 "Exchange current line and previous line, leaving point after both.
2688With argument ARG, takes previous line and moves it past ARG lines.
2689With argument 0, interchanges line point is in with line mark is in."
2690 (interactive "*p")
2691 (transpose-subr (function
2692 (lambda (arg)
d3f4ef3f 2693 (if (> arg 0)
2076c87c 2694 (progn
d3f4ef3f
AS
2695 ;; Move forward over ARG lines,
2696 ;; but create newlines if necessary.
2697 (setq arg (forward-line arg))
2698 (if (/= (preceding-char) ?\n)
2699 (setq arg (1+ arg)))
2700 (if (> arg 0)
2701 (newline arg)))
2076c87c
JB
2702 (forward-line arg))))
2703 arg))
2704
8b56e02d
RS
2705(defvar transpose-subr-start1)
2706(defvar transpose-subr-start2)
2707(defvar transpose-subr-end1)
2708(defvar transpose-subr-end2)
2709
2076c87c 2710(defun transpose-subr (mover arg)
8b56e02d
RS
2711 (let (transpose-subr-start1
2712 transpose-subr-end1
2713 transpose-subr-start2
2714 transpose-subr-end2)
2076c87c
JB
2715 (if (= arg 0)
2716 (progn
2717 (save-excursion
2718 (funcall mover 1)
8b56e02d 2719 (setq transpose-subr-end2 (point))
2076c87c 2720 (funcall mover -1)
8b56e02d 2721 (setq transpose-subr-start2 (point))
2076c87c
JB
2722 (goto-char (mark))
2723 (funcall mover 1)
8b56e02d 2724 (setq transpose-subr-end1 (point))
2076c87c 2725 (funcall mover -1)
8b56e02d 2726 (setq transpose-subr-start1 (point))
2076c87c 2727 (transpose-subr-1))
d3f4ef3f
AS
2728 (exchange-point-and-mark))
2729 (if (> arg 0)
2730 (progn
2731 (funcall mover -1)
8b56e02d 2732 (setq transpose-subr-start1 (point))
d3f4ef3f 2733 (funcall mover 1)
8b56e02d 2734 (setq transpose-subr-end1 (point))
d3f4ef3f 2735 (funcall mover arg)
8b56e02d 2736 (setq transpose-subr-end2 (point))
d3f4ef3f 2737 (funcall mover (- arg))
8b56e02d 2738 (setq transpose-subr-start2 (point))
d3f4ef3f 2739 (transpose-subr-1)
8b56e02d 2740 (goto-char transpose-subr-end2))
d3f4ef3f 2741 (funcall mover -1)
8b56e02d 2742 (setq transpose-subr-start2 (point))
d3f4ef3f 2743 (funcall mover 1)
8b56e02d 2744 (setq transpose-subr-end2 (point))
d3f4ef3f 2745 (funcall mover (1- arg))
8b56e02d 2746 (setq transpose-subr-start1 (point))
d3f4ef3f 2747 (funcall mover (- arg))
8b56e02d 2748 (setq transpose-subr-end1 (point))
d3f4ef3f 2749 (transpose-subr-1)))))
2076c87c
JB
2750
2751(defun transpose-subr-1 ()
8b56e02d
RS
2752 (if (> (min transpose-subr-end1 transpose-subr-end2)
2753 (max transpose-subr-start1 transpose-subr-start2))
2076c87c 2754 (error "Don't have two things to transpose"))
8b56e02d 2755 (let* ((word1 (buffer-substring transpose-subr-start1 transpose-subr-end1))
d5d99b80 2756 (len1 (length word1))
8b56e02d 2757 (word2 (buffer-substring transpose-subr-start2 transpose-subr-end2))
d5d99b80 2758 (len2 (length word2)))
8b56e02d
RS
2759 (delete-region transpose-subr-start2 transpose-subr-end2)
2760 (goto-char transpose-subr-start2)
2076c87c 2761 (insert word1)
8b56e02d
RS
2762 (goto-char (if (< transpose-subr-start1 transpose-subr-start2)
2763 transpose-subr-start1
2764 (+ transpose-subr-start1 (- len1 len2))))
d5d99b80 2765 (delete-region (point) (+ (point) len1))
2076c87c 2766 (insert word2)))
eaae8106 2767
2076c87c
JB
2768(defun backward-word (arg)
2769 "Move backward until encountering the end of a word.
20ecc110 2770With argument, do this that many times."
9e50756b 2771 (interactive "p")
2076c87c
JB
2772 (forward-word (- arg)))
2773
2774(defun mark-word (arg)
2775 "Set mark arg words away from point."
2776 (interactive "p")
2777 (push-mark
2778 (save-excursion
2779 (forward-word arg)
fd0f4056
RS
2780 (point))
2781 nil t))
2076c87c
JB
2782
2783(defun kill-word (arg)
2784 "Kill characters forward until encountering the end of a word.
2785With argument, do this that many times."
e761e42c 2786 (interactive "p")
89ee2bf6 2787 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
2788
2789(defun backward-kill-word (arg)
2790 "Kill characters backward until encountering the end of a word.
2791With argument, do this that many times."
e761e42c 2792 (interactive "p")
2076c87c 2793 (kill-word (- arg)))
d7c64071 2794
1e8c5ac4
RS
2795(defun current-word (&optional strict)
2796 "Return the word point is on (or a nearby word) as a string.
2797If optional arg STRICT is non-nil, return nil unless point is within
2798or adjacent to a word."
d7c64071
ER
2799 (save-excursion
2800 (let ((oldpoint (point)) (start (point)) (end (point)))
2801 (skip-syntax-backward "w_") (setq start (point))
2802 (goto-char oldpoint)
2803 (skip-syntax-forward "w_") (setq end (point))
2804 (if (and (eq start oldpoint) (eq end oldpoint))
1e8c5ac4
RS
2805 ;; Point is neither within nor adjacent to a word.
2806 (and (not strict)
2807 (progn
2808 ;; Look for preceding word in same line.
2809 (skip-syntax-backward "^w_"
2810 (save-excursion (beginning-of-line)
2811 (point)))
2812 (if (bolp)
2813 ;; No preceding word in same line.
2814 ;; Look for following word in same line.
2815 (progn
2816 (skip-syntax-forward "^w_"
2817 (save-excursion (end-of-line)
2818 (point)))
2819 (setq start (point))
2820 (skip-syntax-forward "w_")
2821 (setq end (point)))
2822 (setq end (point))
2823 (skip-syntax-backward "w_")
2824 (setq start (point)))
020db25f
RS
2825 (buffer-substring-no-properties start end)))
2826 (buffer-substring-no-properties start end)))))
eaae8106 2827
69c1dd37 2828(defcustom fill-prefix nil
2076c87c 2829 "*String for filling to insert at front of new line, or nil for none.
69c1dd37
RS
2830Setting this variable automatically makes it local to the current buffer."
2831 :type '(choice (const :tag "None" nil)
2832 string)
2833 :group 'fill)
2076c87c
JB
2834(make-variable-buffer-local 'fill-prefix)
2835
69c1dd37
RS
2836(defcustom auto-fill-inhibit-regexp nil
2837 "*Regexp to match lines which should not be auto-filled."
2838 :type '(choice (const :tag "None" nil)
2839 regexp)
2840 :group 'fill)
2076c87c 2841
58dd38f1 2842(defvar comment-line-break-function 'comment-indent-new-line
b3ac9fa9
RS
2843 "*Mode-specific function which line breaks and continues a comment.
2844
2845This function is only called during auto-filling of a comment section.
2846The function should take a single optional argument, which is a flag
2847indicating whether it should use soft newlines.
2848
2849Setting this variable automatically makes it local to the current buffer.")
2850
dbe524b6 2851;; This function is used as the auto-fill-function of a buffer
e2504204
KH
2852;; when Auto-Fill mode is enabled.
2853;; It returns t if it really did any work.
dbe524b6
RS
2854;; (Actually some major modes use a different auto-fill function,
2855;; but this one is the default one.)
2076c87c 2856(defun do-auto-fill ()
a0170800
RS
2857 (let (fc justify bol give-up
2858 (fill-prefix fill-prefix))
c18465c4 2859 (if (or (not (setq justify (current-justification)))
8f066a20
RS
2860 (null (setq fc (current-fill-column)))
2861 (and (eq justify 'left)
2862 (<= (current-column) fc))
1e722f9f 2863 (save-excursion (beginning-of-line)
eed5698b
RS
2864 (setq bol (point))
2865 (and auto-fill-inhibit-regexp
2866 (looking-at auto-fill-inhibit-regexp))))
2867 nil ;; Auto-filling not required
3db1e3b5
BG
2868 (if (memq justify '(full center right))
2869 (save-excursion (unjustify-current-line)))
a0170800
RS
2870
2871 ;; Choose a fill-prefix automatically.
2872 (if (and adaptive-fill-mode
2873 (or (null fill-prefix) (string= fill-prefix "")))
e4b62d7c
RS
2874 (let ((prefix
2875 (fill-context-prefix
2876 (save-excursion (backward-paragraph 1) (point))
50be475d 2877 (save-excursion (forward-paragraph 1) (point)))))
e4b62d7c
RS
2878 (and prefix (not (equal prefix ""))
2879 (setq fill-prefix prefix))))
a0170800 2880
eed5698b 2881 (while (and (not give-up) (> (current-column) fc))
e47d38f6 2882 ;; Determine where to split the line.
db893d00
RS
2883 (let* (after-prefix
2884 (fill-point
2885 (let ((opoint (point))
2886 bounce
2887 (first t))
2888 (save-excursion
2889 (beginning-of-line)
2890 (setq after-prefix (point))
2891 (and fill-prefix
2892 (looking-at (regexp-quote fill-prefix))
2893 (setq after-prefix (match-end 0)))
2894 (move-to-column (1+ fc))
dbe524b6
RS
2895 ;; Move back to the point where we can break the line.
2896 ;; We break the line between word or
db893d00
RS
2897 ;; after/before the character which has character
2898 ;; category `|'. We search space, \c| followed by
dbe524b6 2899 ;; a character, or \c| following a character. If
db893d00
RS
2900 ;; not found, place the point at beginning of line.
2901 (while (or first
2902 ;; If this is after period and a single space,
2903 ;; move back once more--we don't want to break
2904 ;; the line there and make it look like a
2905 ;; sentence end.
2906 (and (not (bobp))
2907 (not bounce)
2908 sentence-end-double-space
2909 (save-excursion (forward-char -1)
2910 (and (looking-at "\\. ")
dbe524b6
RS
2911 (not (looking-at "\\. ")))))
2912 (and (not (bobp))
2913 (not bounce)
2914 fill-nobreak-predicate
2915 (funcall fill-nobreak-predicate)))
db893d00
RS
2916 (setq first nil)
2917 (re-search-backward "[ \t]\\|\\c|.\\|.\\c|\\|^")
2918 ;; If we find nowhere on the line to break it,
2919 ;; break after one word. Set bounce to t
2920 ;; so we will not keep going in this while loop.
2921 (if (<= (point) after-prefix)
2922 (progn
2923 (goto-char after-prefix)
2924 (re-search-forward "[ \t]" opoint t)
2925 (setq bounce t))
2926 (if (looking-at "[ \t]")
2927 ;; Break the line at word boundary.
2928 (skip-chars-backward " \t")
2929 ;; Break the line after/before \c|.
2930 (forward-char 1))))
22c47bc5 2931 (if enable-multibyte-characters
eb400532
KH
2932 ;; If we are going to break the line after or
2933 ;; before a non-ascii character, we may have
2934 ;; to run a special function for the charset
2935 ;; of the character to find the correct break
2936 ;; point.
2937 (if (not (and (eq (charset-after (1- (point))) 'ascii)
2938 (eq (charset-after (point)) 'ascii)))
2939 (fill-find-break-point after-prefix)))
2940
db893d00 2941 ;; Let fill-point be set to the place where we end up.
4b9c8a06
RS
2942 ;; But move back before any whitespace here.
2943 (skip-chars-backward " \t")
db893d00
RS
2944 (point)))))
2945
2946 ;; See whether the place we found is any good.
e47d38f6
RS
2947 (if (save-excursion
2948 (goto-char fill-point)
07f458c1 2949 (and (not (bolp))
db893d00
RS
2950 ;; There is no use breaking at end of line.
2951 (not (save-excursion (skip-chars-forward " ") (eolp)))
2952 ;; It is futile to split at the end of the prefix
2953 ;; since we would just insert the prefix again.
2954 (not (and after-prefix (<= (point) after-prefix)))
07f458c1
RS
2955 ;; Don't split right after a comment starter
2956 ;; since we would just make another comment starter.
2957 (not (and comment-start-skip
2958 (let ((limit (point)))
2959 (beginning-of-line)
2960 (and (re-search-forward comment-start-skip
2961 limit t)
2962 (eq (point) limit)))))))
db893d00 2963 ;; Ok, we have a useful place to break the line. Do it.
e47d38f6
RS
2964 (let ((prev-column (current-column)))
2965 ;; If point is at the fill-point, do not `save-excursion'.
2966 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2967 ;; point will end up before it rather than after it.
2968 (if (save-excursion
2969 (skip-chars-backward " \t")
2970 (= (point) fill-point))
b3ac9fa9 2971 (funcall comment-line-break-function t)
e47d38f6
RS
2972 (save-excursion
2973 (goto-char fill-point)
b3ac9fa9 2974 (funcall comment-line-break-function t)))
e47d38f6
RS
2975 ;; Now do justification, if required
2976 (if (not (eq justify 'left))
1e722f9f 2977 (save-excursion
e47d38f6
RS
2978 (end-of-line 0)
2979 (justify-current-line justify nil t)))
2980 ;; If making the new line didn't reduce the hpos of
2981 ;; the end of the line, then give up now;
2982 ;; trying again will not help.
2983 (if (>= (current-column) prev-column)
2984 (setq give-up t)))
db893d00 2985 ;; No good place to break => stop trying.
e47d38f6 2986 (setq give-up t))))
24ebf92e 2987 ;; Justify last line.
e2504204 2988 (justify-current-line justify t t)
1e722f9f 2989 t)))
2076c87c 2990
24ebf92e
RS
2991(defvar normal-auto-fill-function 'do-auto-fill
2992 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
2993Some major modes set this.")
2994
d7465b15 2995(defun auto-fill-mode (&optional arg)
24ebf92e
RS
2996 "Toggle Auto Fill mode.
2997With arg, turn Auto Fill mode on if and only if arg is positive.
2998In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
2999automatically breaks the line at a previous space.
3000
3001The value of `normal-auto-fill-function' specifies the function to use
3002for `auto-fill-function' when turning Auto Fill mode on."
d7465b15
RS
3003 (interactive "P")
3004 (prog1 (setq auto-fill-function
3005 (if (if (null arg)
3006 (not auto-fill-function)
3007 (> (prefix-numeric-value arg) 0))
24ebf92e 3008 normal-auto-fill-function
d7465b15 3009 nil))
7911ecc8 3010 (force-mode-line-update)))
d7465b15
RS
3011
3012;; This holds a document string used to document auto-fill-mode.
3013(defun auto-fill-function ()
3014 "Automatically break line at a previous space, in insertion of text."
3015 nil)
3016
3017(defun turn-on-auto-fill ()
3018 "Unconditionally turn on Auto Fill mode."
3019 (auto-fill-mode 1))
3a99c819
GM
3020
3021(defun turn-off-auto-fill ()
3022 "Unconditionally turn off Auto Fill mode."
3023 (auto-fill-mode -1))
3024
7cbf1dc1 3025(custom-add-option 'text-mode-hook 'turn-on-auto-fill)
d7465b15
RS
3026
3027(defun set-fill-column (arg)
4cc0ea11 3028 "Set `fill-column' to specified argument.
923efb99 3029Use \\[universal-argument] followed by a number to specify a column.
4cc0ea11 3030Just \\[universal-argument] as argument means to use the current column."
d7465b15 3031 (interactive "P")
f4520363
RS
3032 (if (consp arg)
3033 (setq arg (current-column)))
3034 (if (not (integerp arg))
3035 ;; Disallow missing argument; it's probably a typo for C-x C-f.
3036 (error "set-fill-column requires an explicit argument")
3037 (message "Fill column set to %d (was %d)" arg fill-column)
3038 (setq fill-column arg)))
eaae8106 3039
2076c87c 3040(defun set-selective-display (arg)
ff1fbe3e
RS
3041 "Set `selective-display' to ARG; clear it if no arg.
3042When the value of `selective-display' is a number > 0,
3043lines whose indentation is >= that value are not displayed.
3044The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
3045 (interactive "P")
3046 (if (eq selective-display t)
3047 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
3048 (let ((current-vpos
3049 (save-restriction
3050 (narrow-to-region (point-min) (point))
3051 (goto-char (window-start))
3052 (vertical-motion (window-height)))))
3053 (setq selective-display
3054 (and arg (prefix-numeric-value arg)))
3055 (recenter current-vpos))
2076c87c
JB
3056 (set-window-start (selected-window) (window-start (selected-window)))
3057 (princ "selective-display set to " t)
3058 (prin1 selective-display t)
3059 (princ "." t))
3060
4f8f7f9f 3061(defvar overwrite-mode-textual " Ovwrt"
b6a22db0 3062 "The string displayed in the mode line when in overwrite mode.")
4f8f7f9f 3063(defvar overwrite-mode-binary " Bin Ovwrt"
b6a22db0
JB
3064 "The string displayed in the mode line when in binary overwrite mode.")
3065
2076c87c
JB
3066(defun overwrite-mode (arg)
3067 "Toggle overwrite mode.
3068With arg, turn overwrite mode on iff arg is positive.
3069In overwrite mode, printing characters typed in replace existing text
b6a22db0
JB
3070on a one-for-one basis, rather than pushing it to the right. At the
3071end of a line, such characters extend the line. Before a tab,
3072such characters insert until the tab is filled in.
3073\\[quoted-insert] still inserts characters in overwrite mode; this
3074is supposed to make it easier to insert characters when necessary."
3075 (interactive "P")
3076 (setq overwrite-mode
3077 (if (if (null arg) (not overwrite-mode)
3078 (> (prefix-numeric-value arg) 0))
3079 'overwrite-mode-textual))
3080 (force-mode-line-update))
3081
3082(defun binary-overwrite-mode (arg)
3083 "Toggle binary overwrite mode.
3084With arg, turn binary overwrite mode on iff arg is positive.
3085In binary overwrite mode, printing characters typed in replace
3086existing text. Newlines are not treated specially, so typing at the
3087end of a line joins the line to the next, with the typed character
3088between them. Typing before a tab character simply replaces the tab
3089with the character typed.
3090\\[quoted-insert] replaces the text at the cursor, just as ordinary
3091typing characters do.
3092
3093Note that binary overwrite mode is not its own minor mode; it is a
3094specialization of overwrite-mode, entered by setting the
3095`overwrite-mode' variable to `overwrite-mode-binary'."
2076c87c
JB
3096 (interactive "P")
3097 (setq overwrite-mode
b6a22db0 3098 (if (if (null arg)
a61099dd 3099 (not (eq overwrite-mode 'overwrite-mode-binary))
b6a22db0
JB
3100 (> (prefix-numeric-value arg) 0))
3101 'overwrite-mode-binary))
3102 (force-mode-line-update))
eaae8106 3103
69c1dd37
RS
3104(defcustom line-number-mode t
3105 "*Non-nil means display line number in mode line."
3106 :type 'boolean
3107 :group 'editing-basics)
a61099dd
RS
3108
3109(defun line-number-mode (arg)
3110 "Toggle Line Number mode.
3111With arg, turn Line Number mode on iff arg is positive.
3112When Line Number mode is enabled, the line number appears
8dc9e2ef
KH
3113in the mode line.
3114
3115Line numbers do not appear for very large buffers, see variable
3116`line-number-display-limit'."
a61099dd
RS
3117 (interactive "P")
3118 (setq line-number-mode
3119 (if (null arg) (not line-number-mode)
3120 (> (prefix-numeric-value arg) 0)))
3121 (force-mode-line-update))
3122
69c1dd37
RS
3123(defcustom column-number-mode nil
3124 "*Non-nil means display column number in mode line."
3125 :type 'boolean
3126 :group 'editing-basics)
bcad4985
KH
3127
3128(defun column-number-mode (arg)
3129 "Toggle Column Number mode.
3130With arg, turn Column Number mode on iff arg is positive.
3131When Column Number mode is enabled, the column number appears
3132in the mode line."
3133 (interactive "P")
3134 (setq column-number-mode
3135 (if (null arg) (not column-number-mode)
3136 (> (prefix-numeric-value arg) 0)))
3137 (force-mode-line-update))
3138
4b384a8f 3139(defgroup paren-blinking nil
020db25f 3140 "Blinking matching of parens and expressions."
4b384a8f
SM
3141 :prefix "blink-matching-"
3142 :group 'paren-matching)
3143
69c1dd37
RS
3144(defcustom blink-matching-paren t
3145 "*Non-nil means show matching open-paren when close-paren is inserted."
3146 :type 'boolean
4b384a8f 3147 :group 'paren-blinking)
2076c87c 3148
69c1dd37 3149(defcustom blink-matching-paren-on-screen t
29fc44dd 3150 "*Non-nil means show matching open-paren when it is on screen.
4b384a8f
SM
3151If nil, means don't show it (but the open-paren can still be shown
3152when it is off screen)."
69c1dd37 3153 :type 'boolean
4b384a8f 3154 :group 'paren-blinking)
29fc44dd 3155
4b384a8f 3156(defcustom blink-matching-paren-distance (* 25 1024)
69c1dd37
RS
3157 "*If non-nil, is maximum distance to search for matching open-paren."
3158 :type 'integer
4b384a8f 3159 :group 'paren-blinking)
2076c87c 3160
69c1dd37 3161(defcustom blink-matching-delay 1
4b384a8f
SM
3162 "*Time in seconds to delay after showing a matching paren."
3163 :type 'number
3164 :group 'paren-blinking)
72dddf8b 3165
69c1dd37 3166(defcustom blink-matching-paren-dont-ignore-comments nil
4b384a8f 3167 "*Non-nil means `blink-matching-paren' will not ignore comments."
69c1dd37 3168 :type 'boolean
4b384a8f 3169 :group 'paren-blinking)
903b7f65 3170
2076c87c
JB
3171(defun blink-matching-open ()
3172 "Move cursor momentarily to the beginning of the sexp before point."
3173 (interactive)
3174 (and (> (point) (1+ (point-min)))
2076c87c 3175 blink-matching-paren
7e1ddd45
RS
3176 ;; Verify an even number of quoting characters precede the close.
3177 (= 1 (logand 1 (- (point)
3178 (save-excursion
3179 (forward-char -1)
3180 (skip-syntax-backward "/\\")
3181 (point)))))
2076c87c
JB
3182 (let* ((oldpos (point))
3183 (blinkpos)
3184 (mismatch))
3185 (save-excursion
3186 (save-restriction
3187 (if blink-matching-paren-distance
3188 (narrow-to-region (max (point-min)
3189 (- (point) blink-matching-paren-distance))
3190 oldpos))
3191 (condition-case ()
903b7f65
RS
3192 (let ((parse-sexp-ignore-comments
3193 (and parse-sexp-ignore-comments
3194 (not blink-matching-paren-dont-ignore-comments))))
3195 (setq blinkpos (scan-sexps oldpos -1)))
2076c87c 3196 (error nil)))
903b7f65
RS
3197 (and blinkpos
3198 (/= (char-syntax (char-after blinkpos))
3199 ?\$)
2076c87c 3200 (setq mismatch
903b7f65
RS
3201 (or (null (matching-paren (char-after blinkpos)))
3202 (/= (char-after (1- oldpos))
3203 (matching-paren (char-after blinkpos))))))
2076c87c
JB
3204 (if mismatch (setq blinkpos nil))
3205 (if blinkpos
a117eaee
KH
3206 ;; Don't log messages about paren matching.
3207 (let (message-log-max)
2076c87c
JB
3208 (goto-char blinkpos)
3209 (if (pos-visible-in-window-p)
29fc44dd
KH
3210 (and blink-matching-paren-on-screen
3211 (sit-for blink-matching-delay))
2076c87c
JB
3212 (goto-char blinkpos)
3213 (message
3214 "Matches %s"
e9f1d66d 3215 ;; Show what precedes the open in its line, if anything.
2076c87c
JB
3216 (if (save-excursion
3217 (skip-chars-backward " \t")
3218 (not (bolp)))
3219 (buffer-substring (progn (beginning-of-line) (point))
3220 (1+ blinkpos))
e9f1d66d
RS
3221 ;; Show what follows the open in its line, if anything.
3222 (if (save-excursion
3223 (forward-char 1)
3224 (skip-chars-forward " \t")
3225 (not (eolp)))
3226 (buffer-substring blinkpos
3227 (progn (end-of-line) (point)))
267935b9
RS
3228 ;; Otherwise show the previous nonblank line,
3229 ;; if there is one.
3230 (if (save-excursion
3231 (skip-chars-backward "\n \t")
3232 (not (bobp)))
3233 (concat
3234 (buffer-substring (progn
3235 (skip-chars-backward "\n \t")
3236 (beginning-of-line)
3237 (point))
3238 (progn (end-of-line)
3239 (skip-chars-backward " \t")
3240 (point)))
3241 ;; Replace the newline and other whitespace with `...'.
3242 "..."
3243 (buffer-substring blinkpos (1+ blinkpos)))
3244 ;; There is nothing to show except the char itself.
3245 (buffer-substring blinkpos (1+ blinkpos))))))))
2076c87c
JB
3246 (cond (mismatch
3247 (message "Mismatched parentheses"))
3248 ((not blink-matching-paren-distance)
3249 (message "Unmatched parenthesis"))))))))
3250
3251;Turned off because it makes dbx bomb out.
3252(setq blink-paren-function 'blink-matching-open)
3253
9a1277dd
RS
3254;; This executes C-g typed while Emacs is waiting for a command.
3255;; Quitting out of a program does not go through here;
3256;; that happens in the QUIT macro at the C code level.
2076c87c 3257(defun keyboard-quit ()
d5dae4e1 3258 "Signal a `quit' condition.
af39530e
RS
3259During execution of Lisp code, this character causes a quit directly.
3260At top-level, as an editor command, this simply beeps."
2076c87c 3261 (interactive)
19d35374 3262 (deactivate-mark)
2076c87c
JB
3263 (signal 'quit nil))
3264
3265(define-key global-map "\C-g" 'keyboard-quit)
c66587fe 3266
1c6c6fde
RS
3267(defvar buffer-quit-function nil
3268 "Function to call to \"quit\" the current buffer, or nil if none.
3269\\[keyboard-escape-quit] calls this function when its more local actions
3270\(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3271
c66587fe
RS
3272(defun keyboard-escape-quit ()
3273 "Exit the current \"mode\" (in a generalized sense of the word).
3274This command can exit an interactive command such as `query-replace',
3275can clear out a prefix argument or a region,
3276can get out of the minibuffer or other recursive edit,
1c6c6fde
RS
3277cancel the use of the current buffer (for special-purpose buffers),
3278or go back to just one window (by deleting all but the selected window)."
c66587fe
RS
3279 (interactive)
3280 (cond ((eq last-command 'mode-exited) nil)
3281 ((> (minibuffer-depth) 0)
3282 (abort-recursive-edit))
3283 (current-prefix-arg
3284 nil)
3285 ((and transient-mark-mode
3286 mark-active)
3287 (deactivate-mark))
1b657835
RS
3288 ((> (recursion-depth) 0)
3289 (exit-recursive-edit))
1c6c6fde
RS
3290 (buffer-quit-function
3291 (funcall buffer-quit-function))
c66587fe 3292 ((not (one-window-p t))
1b657835
RS
3293 (delete-other-windows))
3294 ((string-match "^ \\*" (buffer-name (current-buffer)))
3295 (bury-buffer))))
c66587fe 3296
1c6c6fde 3297(define-key global-map "\e\e\e" 'keyboard-escape-quit)
22e4ec98 3298
7683b5c2
DL
3299(defcustom read-mail-command 'rmail
3300 "*Your preference for a mail reading package.
9023837e
DL
3301This is used by some keybindings which support reading mail.
3302See also `mail-user-agent' concerning sending mail."
7683b5c2
DL
3303 :type '(choice (function-item rmail)
3304 (function-item gnus)
3305 (function-item mh-rmail)
3306 (function :tag "Other"))
3307 :version "21.1"
3308 :group 'mail)
3309
69c1dd37 3310(defcustom mail-user-agent 'sendmail-user-agent
a31ca314 3311 "*Your preference for a mail composition package.
9023837e 3312Various Emacs Lisp packages (e.g. Reporter) require you to compose an
a31ca314
RS
3313outgoing email message. This variable lets you specify which
3314mail-sending package you prefer.
3315
3316Valid values include:
3317
9023837e
DL
3318 `sendmail-user-agent' -- use the default Emacs Mail package.
3319 See Info node `(emacs)Sending Mail'.
3320 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
3321 See Info node `(mh-e)'.
3322 `message-user-agent' -- use the Gnus Message package.
3323 See Info node `(message)'.
3324 `gnus-user-agent' -- like `message-user-agent', but with Gnus
3325 paraphernalia, particularly the Gcc: header for
3326 archiving.
a31ca314
RS
3327
3328Additional valid symbols may be available; check with the author of
15d0c9b1
DL
3329your package for details. The function should return non-nil if it
3330succeeds.
9023837e
DL
3331
3332See also `read-mail-command' concerning reading mail."
69c1dd37
RS
3333 :type '(radio (function-item :tag "Default Emacs mail"
3334 :format "%t\n"
3335 sendmail-user-agent)
3336 (function-item :tag "Emacs interface to MH"
3337 :format "%t\n"
3338 mh-e-user-agent)
9023837e 3339 (function-item :tag "Gnus Message package"
69c1dd37
RS
3340 :format "%t\n"
3341 message-user-agent)
9023837e
DL
3342 (function-item :tag "Gnus Message with full Gnus features"
3343 :format "%t\n"
3344 gnus-user-agent)
69c1dd37
RS
3345 (function :tag "Other"))
3346 :group 'mail)
a31ca314
RS
3347
3348(defun define-mail-user-agent (symbol composefunc sendfunc
3349 &optional abortfunc hookvar)
3350 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3351
3352SYMBOL can be any Lisp symbol. Its function definition and/or
3353value as a variable do not matter for this usage; we use only certain
3354properties on its property list, to encode the rest of the arguments.
3355
3356COMPOSEFUNC is program callable function that composes an outgoing
3357mail message buffer. This function should set up the basics of the
3358buffer without requiring user interaction. It should populate the
3183b230
RS
3359standard mail headers, leaving the `to:' and `subject:' headers blank
3360by default.
a31ca314 3361
d0008a00
RS
3362COMPOSEFUNC should accept several optional arguments--the same
3363arguments that `compose-mail' takes. See that function's documentation.
a31ca314 3364
3183b230
RS
3365SENDFUNC is the command a user would run to send the message.
3366
3367Optional ABORTFUNC is the command a user would run to abort the
a31ca314
RS
3368message. For mail packages that don't have a separate abort function,
3369this can be `kill-buffer' (the equivalent of omitting this argument).
3370
3371Optional HOOKVAR is a hook variable that gets run before the message
3183b230
RS
3372is actually sent. Callers that use the `mail-user-agent' may
3373install a hook function temporarily on this hook variable.
3374If HOOKVAR is nil, `mail-send-hook' is used.
a31ca314
RS
3375
3376The properties used on SYMBOL are `composefunc', `sendfunc',
3377`abortfunc', and `hookvar'."
3378 (put symbol 'composefunc composefunc)
3379 (put symbol 'sendfunc sendfunc)
3380 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3381 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3382
3383(define-mail-user-agent 'sendmail-user-agent
34fbcdf3 3384 'sendmail-user-agent-compose
a31ca314
RS
3385 'mail-send-and-exit)
3386
360b5483
RS
3387(defun rfc822-goto-eoh ()
3388 ;; Go to header delimiter line in a mail message, following RFC822 rules
3389 (goto-char (point-min))
3390 (while (looking-at "^[^: \n]+:\\|^[ \t]")
3391 (forward-line 1))
3392 (point))
3393
34fbcdf3
RS
3394(defun sendmail-user-agent-compose (&optional to subject other-headers continue
3395 switch-function yank-action
3396 send-actions)
3397 (if switch-function
3398 (let ((special-display-buffer-names nil)
3399 (special-display-regexps nil)
3400 (same-window-buffer-names nil)
3401 (same-window-regexps nil))
3402 (funcall switch-function "*mail*")))
3403 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
0740c738
GM
3404 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3405 (body (cdr (assoc-ignore-case "body" other-headers))))
34fbcdf3
RS
3406 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3407 continue
3408 (error "Message aborted"))
3409 (save-excursion
360b5483 3410 (rfc822-goto-eoh)
34fbcdf3 3411 (while other-headers
0740c738
GM
3412 (unless (member-ignore-case (car (car other-headers))
3413 '("in-reply-to" "cc" "body"))
34fbcdf3
RS
3414 (insert (car (car other-headers)) ": "
3415 (cdr (car other-headers)) "\n"))
3416 (setq other-headers (cdr other-headers)))
0740c738
GM
3417 (when body
3418 (forward-line 1)
3419 (insert body))
34fbcdf3
RS
3420 t)))
3421
a31ca314
RS
3422(define-mail-user-agent 'mh-e-user-agent
3423 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3424 'mh-before-send-letter-hook)
d0008a00
RS
3425
3426(defun compose-mail (&optional to subject other-headers continue
3427 switch-function yank-action send-actions)
3428 "Start composing a mail message to send.
3429This uses the user's chosen mail composition package
3430as selected with the variable `mail-user-agent'.
3431The optional arguments TO and SUBJECT specify recipients
3432and the initial Subject field, respectively.
3433
3434OTHER-HEADERS is an alist specifying additional
3435header fields. Elements look like (HEADER . VALUE) where both
3436HEADER and VALUE are strings.
3437
3438CONTINUE, if non-nil, says to continue editing a message already
3439being composed.
3440
3441SWITCH-FUNCTION, if non-nil, is a function to use to
3442switch to and display the buffer used for mail composition.
3443
3444YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
06720de2
RS
3445to insert the raw text of the message being replied to.
3446It has the form (FUNCTION . ARGS). The user agent will apply
3447FUNCTION to ARGS, to insert the raw text of the original message.
3448\(The user agent will also run `mail-citation-hook', *after* the
3449original text has been inserted in this way.)
d0008a00
RS
3450
3451SEND-ACTIONS is a list of actions to call when the message is sent.
3452Each action has the form (FUNCTION . ARGS)."
b5f019be
RS
3453 (interactive
3454 (list nil nil nil current-prefix-arg))
d0008a00
RS
3455 (let ((function (get mail-user-agent 'composefunc)))
3456 (funcall function to subject other-headers continue
3457 switch-function yank-action send-actions)))
b5f019be
RS
3458
3459(defun compose-mail-other-window (&optional to subject other-headers continue
3460 yank-action send-actions)
3461 "Like \\[compose-mail], but edit the outgoing message in another window."
3462 (interactive
3463 (list nil nil nil current-prefix-arg))
3464 (compose-mail to subject other-headers continue
3465 'switch-to-buffer-other-window yank-action send-actions))
3466
3467
3468(defun compose-mail-other-frame (&optional to subject other-headers continue
3469 yank-action send-actions)
3470 "Like \\[compose-mail], but edit the outgoing message in another frame."
3471 (interactive
3472 (list nil nil nil current-prefix-arg))
3473 (compose-mail to subject other-headers continue
3474 'switch-to-buffer-other-frame yank-action send-actions))
eaae8106 3475
610c1c68
RS
3476(defvar set-variable-value-history nil
3477 "History of values entered with `set-variable'.")
3478
3479(defun set-variable (var val)
3480 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3481When using this interactively, enter a Lisp object for VALUE.
3482If you want VALUE to be a string, you must surround it with doublequotes.
3483VALUE is used literally, not evaluated.
3484
3485If VARIABLE has a `variable-interactive' property, that is used as if
3486it were the arg to `interactive' (which see) to interactively read VALUE.
3487
3488If VARIABLE has been defined with `defcustom', then the type information
3489in the definition is used to check that VALUE is valid."
e9dfb72e
RS
3490 (interactive
3491 (let* ((default-var (variable-at-point))
3492 (var (if (symbolp default-var)
3493 (read-variable (format "Set variable (default %s): " default-var)
3494 default-var)
3495 (read-variable "Set variable: ")))
610c1c68
RS
3496 (minibuffer-help-form '(describe-variable var))
3497 (prop (get var 'variable-interactive))
3498 (prompt (format "Set %s to value: " var))
3499 (val (if prop
3500 ;; Use VAR's `variable-interactive' property
3501 ;; as an interactive spec for prompting.
3502 (call-interactively `(lambda (arg)
3503 (interactive ,prop)
3504 arg))
3505 (read
3506 (read-string prompt nil
3507 'set-variable-value-history)))))
3508 (list var val)))
3509
f8496faa 3510 (let ((type (get var 'custom-type)))
610c1c68
RS
3511 (when type
3512 ;; Match with custom type.
3513 (require 'wid-edit)
610c1c68
RS
3514 (setq type (widget-convert type))
3515 (unless (widget-apply type :match val)
1e722f9f 3516 (error "Value `%S' does not match type %S of %S"
610c1c68 3517 val (car type) var))))
a2aef080
GM
3518 (set var val)
3519
3520 ;; Force a thorough redisplay for the case that the variable
3521 ;; has an effect on the display, like `tab-width' has.
3522 (force-mode-line-update))
eaae8106 3523
e8a700bf
RS
3524;; Define the major mode for lists of completions.
3525
98b45886
RS
3526(defvar completion-list-mode-map nil
3527 "Local map for completion list buffers.")
ac29eb79 3528(or completion-list-mode-map
e8a700bf
RS
3529 (let ((map (make-sparse-keymap)))
3530 (define-key map [mouse-2] 'mouse-choose-completion)
eaf76065 3531 (define-key map [down-mouse-2] nil)
80298193 3532 (define-key map "\C-m" 'choose-completion)
1c6c6fde 3533 (define-key map "\e\e\e" 'delete-completion-window)
dde69dbe
RS
3534 (define-key map [left] 'previous-completion)
3535 (define-key map [right] 'next-completion)
ac29eb79 3536 (setq completion-list-mode-map map)))
e8a700bf
RS
3537
3538;; Completion mode is suitable only for specially formatted data.
ac29eb79 3539(put 'completion-list-mode 'mode-class 'special)
e8a700bf 3540
98b45886
RS
3541(defvar completion-reference-buffer nil
3542 "Record the buffer that was current when the completion list was requested.
3543This is a local variable in the completion list buffer.
ec39964e 3544Initial value is nil to avoid some compiler warnings.")
3819736b 3545
83434bda
RS
3546(defvar completion-no-auto-exit nil
3547 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3548This also applies to other functions such as `choose-completion'
3549and `mouse-choose-completion'.")
3550
98b45886
RS
3551(defvar completion-base-size nil
3552 "Number of chars at beginning of minibuffer not involved in completion.
3553This is a local variable in the completion list buffer
3554but it talks about the buffer in `completion-reference-buffer'.
3555If this is nil, it means to compare text to determine which part
3556of the tail end of the buffer's text is involved in completion.")
f6b293e3 3557
1c6c6fde
RS
3558(defun delete-completion-window ()
3559 "Delete the completion list window.
3560Go to the window from which completion was requested."
3561 (interactive)
3562 (let ((buf completion-reference-buffer))
ddb2b181
RS
3563 (if (one-window-p t)
3564 (if (window-dedicated-p (selected-window))
3565 (delete-frame (selected-frame)))
3566 (delete-window (selected-window))
3567 (if (get-buffer-window buf)
3568 (select-window (get-buffer-window buf))))))
1c6c6fde 3569
dde69dbe
RS
3570(defun previous-completion (n)
3571 "Move to the previous item in the completion list."
3572 (interactive "p")
3573 (next-completion (- n)))
3574
3575(defun next-completion (n)
3576 "Move to the next item in the completion list.
1f238ac2 3577With prefix argument N, move N items (negative N means move backward)."
dde69dbe 3578 (interactive "p")
58dd38f1
SM
3579 (let ((beg (point-min)) (end (point-max)))
3580 (while (and (> n 0) (not (eobp)))
dde69dbe 3581 ;; If in a completion, move to the end of it.
58dd38f1
SM
3582 (when (get-text-property (point) 'mouse-face)
3583 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe 3584 ;; Move to start of next one.
58dd38f1
SM
3585 (unless (get-text-property (point) 'mouse-face)
3586 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3587 (setq n (1- n)))
3588 (while (and (< n 0) (not (bobp)))
3589 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
3590 ;; If in a completion, move to the start of it.
3591 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
b61a81c2 3592 (goto-char (previous-single-property-change
58dd38f1
SM
3593 (point) 'mouse-face nil beg)))
3594 ;; Move to end of the previous completion.
3595 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
3596 (goto-char (previous-single-property-change
3597 (point) 'mouse-face nil beg)))
3598 ;; Move to the start of that one.
3599 (goto-char (previous-single-property-change
3600 (point) 'mouse-face nil beg))
3601 (setq n (1+ n))))))
dde69dbe 3602
80298193
RS
3603(defun choose-completion ()
3604 "Choose the completion that point is in or next to."
3605 (interactive)
f6b293e3
RS
3606 (let (beg end completion (buffer completion-reference-buffer)
3607 (base-size completion-base-size))
6096f362
RS
3608 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3609 (setq end (point) beg (1+ (point))))
3610 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3f299281 3611 (setq end (1- (point)) beg (point)))
6096f362
RS
3612 (if (null beg)
3613 (error "No completion here"))
3614 (setq beg (previous-single-property-change beg 'mouse-face))
88dd3c24 3615 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
ab63960f
RS
3616 (setq completion (buffer-substring beg end))
3617 (let ((owindow (selected-window)))
3618 (if (and (one-window-p t 'selected-frame)
3619 (window-dedicated-p (selected-window)))
3620 ;; This is a special buffer's frame
3621 (iconify-frame (selected-frame))
3622 (or (window-dedicated-p (selected-window))
3623 (bury-buffer)))
3624 (select-window owindow))
f6b293e3 3625 (choose-completion-string completion buffer base-size)))
80298193
RS
3626
3627;; Delete the longest partial match for STRING
3628;; that can be found before POINT.
3629(defun choose-completion-delete-max-match (string)
3630 (let ((opoint (point))
3631 (len (min (length string)
3632 (- (point) (point-min)))))
3633 (goto-char (- (point) (length string)))
61bbf6fe
RS
3634 (if completion-ignore-case
3635 (setq string (downcase string)))
80298193
RS
3636 (while (and (> len 0)
3637 (let ((tail (buffer-substring (point)
3638 (+ (point) len))))
61bbf6fe
RS
3639 (if completion-ignore-case
3640 (setq tail (downcase tail)))
80298193
RS
3641 (not (string= tail (substring string 0 len)))))
3642 (setq len (1- len))
3643 (forward-char 1))
3644 (delete-char len)))
3645
98b45886
RS
3646;; Switch to BUFFER and insert the completion choice CHOICE.
3647;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3648;; to keep. If it is nil, use choose-completion-delete-max-match instead.
74d0290b
RS
3649
3650;; If BUFFER is the minibuffer, exit the minibuffer
83434bda
RS
3651;; unless it is reading a file name and CHOICE is a directory,
3652;; or completion-no-auto-exit is non-nil.
f6b293e3 3653(defun choose-completion-string (choice &optional buffer base-size)
f436a90a
RS
3654 (let ((buffer (or buffer completion-reference-buffer))
3655 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))))
cf52ad58
RS
3656 ;; If BUFFER is a minibuffer, barf unless it's the currently
3657 ;; active minibuffer.
f436a90a 3658 (if (and mini-p
45486731
RS
3659 (or (not (active-minibuffer-window))
3660 (not (equal buffer
3661 (window-buffer (active-minibuffer-window))))))
cf52ad58
RS
3662 (error "Minibuffer is not active for completion")
3663 ;; Insert the completion into the buffer where completion was requested.
3664 (set-buffer buffer)
f6b293e3 3665 (if base-size
f436a90a
RS
3666 (delete-region (+ base-size (if mini-p
3667 (minibuffer-prompt-end)
3668 (point-min)))
3669 (point))
f6b293e3 3670 (choose-completion-delete-max-match choice))
cf52ad58 3671 (insert choice)
63240af1
RS
3672 (remove-text-properties (- (point) (length choice)) (point)
3673 '(mouse-face nil))
cf52ad58
RS
3674 ;; Update point in the window that BUFFER is showing in.
3675 (let ((window (get-buffer-window buffer t)))
3676 (set-window-point window (point)))
3677 ;; If completing for the minibuffer, exit it with this choice.
83434bda
RS
3678 (and (not completion-no-auto-exit)
3679 (equal buffer (window-buffer (minibuffer-window)))
8881ad9a 3680 minibuffer-completion-table
74d0290b
RS
3681 ;; If this is reading a file name, and the file name chosen
3682 ;; is a directory, don't exit the minibuffer.
3683 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
a4d1159b 3684 (file-directory-p (field-string (point-max))))
74d0290b
RS
3685 (select-window (active-minibuffer-window))
3686 (exit-minibuffer))))))
80298193 3687
ac29eb79 3688(defun completion-list-mode ()
e8a700bf 3689 "Major mode for buffers showing lists of possible completions.
80298193
RS
3690Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3691 to select the completion near point.
3692Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3693 with the mouse."
e8a700bf
RS
3694 (interactive)
3695 (kill-all-local-variables)
ac29eb79
RS
3696 (use-local-map completion-list-mode-map)
3697 (setq mode-name "Completion List")
3698 (setq major-mode 'completion-list-mode)
f6b293e3
RS
3699 (make-local-variable 'completion-base-size)
3700 (setq completion-base-size nil)
ac29eb79 3701 (run-hooks 'completion-list-mode-hook))
e8a700bf 3702
747a0e2f
RS
3703(defvar completion-setup-hook nil
3704 "Normal hook run at the end of setting up a completion list buffer.
3705When this hook is run, the current buffer is the one in which the
3706command to display the completion list buffer was run.
3707The completion list buffer is available as the value of `standard-output'.")
3708
98b45886
RS
3709;; This function goes in completion-setup-hook, so that it is called
3710;; after the text of the completion list buffer is written.
6096f362 3711
e8a700bf
RS
3712(defun completion-setup-function ()
3713 (save-excursion
98b45886 3714 (let ((mainbuf (current-buffer)))
3819736b
RS
3715 (set-buffer standard-output)
3716 (completion-list-mode)
3717 (make-local-variable 'completion-reference-buffer)
3718 (setq completion-reference-buffer mainbuf)
50be475d
RS
3719 (if (eq minibuffer-completion-table 'read-file-name-internal)
3720 ;; For file name completion,
3721 ;; use the number of chars before the start of the
3722 ;; last file name component.
3723 (setq completion-base-size
3724 (save-excursion
3725 (set-buffer mainbuf)
3726 (goto-char (point-max))
3727 (skip-chars-backward (format "^%c" directory-sep-char))
0aad4805 3728 (- (point) (minibuffer-prompt-end))))
19183a29
RS
3729 ;; Otherwise, in minibuffer, the whole input is being completed.
3730 (save-match-data
3731 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3732 (buffer-name mainbuf))
3733 (setq completion-base-size 0))))
3819736b 3734 (goto-char (point-min))
0d6e23cf 3735 (if (display-mouse-p)
3819736b 3736 (insert (substitute-command-keys
80298193
RS
3737 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
3738 (insert (substitute-command-keys
3739 "In this buffer, type \\[choose-completion] to \
7d22ed15 3740select the completion near point.\n\n")))))
c88ab9ce 3741
e8a700bf 3742(add-hook 'completion-setup-hook 'completion-setup-function)
dde69dbe
RS
3743
3744(define-key minibuffer-local-completion-map [prior]
3745 'switch-to-completions)
3746(define-key minibuffer-local-must-match-map [prior]
3747 'switch-to-completions)
3748(define-key minibuffer-local-completion-map "\M-v"
3749 'switch-to-completions)
3750(define-key minibuffer-local-must-match-map "\M-v"
3751 'switch-to-completions)
3752
3753(defun switch-to-completions ()
3754 "Select the completion list window."
3755 (interactive)
9595fbdb
RS
3756 ;; Make sure we have a completions window.
3757 (or (get-buffer-window "*Completions*")
3758 (minibuffer-completion-help))
fdbd7c4d
KH
3759 (let ((window (get-buffer-window "*Completions*")))
3760 (when window
3761 (select-window window)
3762 (goto-char (point-min))
3763 (search-forward "\n\n")
3764 (forward-line 1))))
eaae8106 3765
82072f33
RS
3766;; Support keyboard commands to turn on various modifiers.
3767
3768;; These functions -- which are not commands -- each add one modifier
3769;; to the following event.
3770
3771(defun event-apply-alt-modifier (ignore-prompt)
70cf9f08
KH
3772 "Add the Alt modifier to the following event.
3773For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
82072f33
RS
3774 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3775(defun event-apply-super-modifier (ignore-prompt)
70cf9f08
KH
3776 "Add the Super modifier to the following event.
3777For example, type \\[event-apply-super-modifier] & to enter Super-&."
82072f33
RS
3778 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3779(defun event-apply-hyper-modifier (ignore-prompt)
70cf9f08
KH
3780 "Add the Hyper modifier to the following event.
3781For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
82072f33
RS
3782 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3783(defun event-apply-shift-modifier (ignore-prompt)
70cf9f08
KH
3784 "Add the Shift modifier to the following event.
3785For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
82072f33
RS
3786 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3787(defun event-apply-control-modifier (ignore-prompt)
70cf9f08
KH
3788 "Add the Ctrl modifier to the following event.
3789For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
82072f33
RS
3790 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3791(defun event-apply-meta-modifier (ignore-prompt)
70cf9f08
KH
3792 "Add the Meta modifier to the following event.
3793For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
82072f33
RS
3794 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3795
3796(defun event-apply-modifier (event symbol lshiftby prefix)
3797 "Apply a modifier flag to event EVENT.
3798SYMBOL is the name of this modifier, as a symbol.
3799LSHIFTBY is the numeric value of this modifier, in keyboard events.
3800PREFIX is the string that represents this modifier in an event type symbol."
3801 (if (numberp event)
3802 (cond ((eq symbol 'control)
90bebcb0
KH
3803 (if (and (<= (downcase event) ?z)
3804 (>= (downcase event) ?a))
82072f33 3805 (- (downcase event) ?a -1)
90bebcb0
KH
3806 (if (and (<= (downcase event) ?Z)
3807 (>= (downcase event) ?A))
82072f33
RS
3808 (- (downcase event) ?A -1)
3809 (logior (lsh 1 lshiftby) event))))
3810 ((eq symbol 'shift)
3811 (if (and (<= (downcase event) ?z)
3812 (>= (downcase event) ?a))
3813 (upcase event)
3814 (logior (lsh 1 lshiftby) event)))
3815 (t
3816 (logior (lsh 1 lshiftby) event)))
3817 (if (memq symbol (event-modifiers event))
3818 event
3819 (let ((event-type (if (symbolp event) event (car event))))
3820 (setq event-type (intern (concat prefix (symbol-name event-type))))
3821 (if (symbolp event)
3822 event-type
3823 (cons event-type (cdr event)))))))
3824
e5fff738
KH
3825(define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3826(define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3827(define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3828(define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3829(define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3830(define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
eaae8106 3831
a3d1480b
JB
3832;;;; Keypad support.
3833
3834;;; Make the keypad keys act like ordinary typing keys. If people add
3835;;; bindings for the function key symbols, then those bindings will
3836;;; override these, so this shouldn't interfere with any existing
3837;;; bindings.
3838
0d173134 3839;; Also tell read-char how to handle these keys.
a3d1480b
JB
3840(mapcar
3841 (lambda (keypad-normal)
3842 (let ((keypad (nth 0 keypad-normal))
3843 (normal (nth 1 keypad-normal)))
0d173134 3844 (put keypad 'ascii-character normal)
a3d1480b
JB
3845 (define-key function-key-map (vector keypad) (vector normal))))
3846 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3847 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3848 (kp-space ?\ )
3849 (kp-tab ?\t)
3850 (kp-enter ?\r)
3851 (kp-multiply ?*)
3852 (kp-add ?+)
3853 (kp-separator ?,)
3854 (kp-subtract ?-)
3855 (kp-decimal ?.)
3856 (kp-divide ?/)
3857 (kp-equal ?=)))
3858
1e722f9f 3859;;;;
b005abd5 3860;;;; forking a twin copy of a buffer.
1e722f9f 3861;;;;
b005abd5
SM
3862
3863(defvar clone-buffer-hook nil
3864 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
3865
3866(defun clone-process (process &optional newname)
3867 "Create a twin copy of PROCESS.
3868If NEWNAME is nil, it defaults to PROCESS' name;
3869NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3870If PROCESS is associated with a buffer, the new process will be associated
3871 with the current buffer instead.
3872Returns nil if PROCESS has already terminated."
3873 (setq newname (or newname (process-name process)))
3874 (if (string-match "<[0-9]+>\\'" newname)
3875 (setq newname (substring newname 0 (match-beginning 0))))
3876 (when (memq (process-status process) '(run stop open))
3877 (let* ((process-connection-type (process-tty-name process))
3878 (old-kwoq (process-kill-without-query process nil))
3879 (new-process
3880 (if (memq (process-status process) '(open))
3881 (apply 'open-network-stream newname
3882 (if (process-buffer process) (current-buffer))
3883 (process-contact process))
3884 (apply 'start-process newname
3885 (if (process-buffer process) (current-buffer))
3886 (process-command process)))))
3887 (process-kill-without-query new-process old-kwoq)
3888 (process-kill-without-query process old-kwoq)
3889 (set-process-inherit-coding-system-flag
3890 new-process (process-inherit-coding-system-flag process))
3891 (set-process-filter new-process (process-filter process))
3892 (set-process-sentinel new-process (process-sentinel process))
3893 new-process)))
3894
3895;; things to maybe add (currently partly covered by `funcall mode':
3896;; - syntax-table
3897;; - overlays
3898(defun clone-buffer (&optional newname display-flag)
3899 "Create a twin copy of the current buffer.
3900If NEWNAME is nil, it defaults to the current buffer's name;
3901NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3902
3903If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
3904This runs the normal hook `clone-buffer-hook' in the new buffer
3905after it has been set up properly in other respects."
3906 (interactive (list (if current-prefix-arg (read-string "Name: "))
3907 t))
3908 (if buffer-file-name
3909 (error "Cannot clone a file-visiting buffer"))
3910 (if (get major-mode 'no-clone)
3911 (error "Cannot clone a buffer in %s mode" mode-name))
3912 (setq newname (or newname (buffer-name)))
3913 (if (string-match "<[0-9]+>\\'" newname)
3914 (setq newname (substring newname 0 (match-beginning 0))))
3915 (let ((buf (current-buffer))
3916 (ptmin (point-min))
3917 (ptmax (point-max))
3918 (pt (point))
3919 (mk (if mark-active (mark t)))
3920 (modified (buffer-modified-p))
3921 (mode major-mode)
3922 (lvars (buffer-local-variables))
3923 (process (get-buffer-process (current-buffer)))
3924 (new (generate-new-buffer (or newname (buffer-name)))))
3925 (save-restriction
3926 (widen)
3927 (with-current-buffer new
3928 (insert-buffer-substring buf)))
3929 (with-current-buffer new
3930 (narrow-to-region ptmin ptmax)
3931 (goto-char pt)
3932 (if mk (set-mark mk))
3933 (set-buffer-modified-p modified)
3934
3935 ;; Clone the old buffer's process, if any.
3936 (when process (clone-process process))
3937
3938 ;; Now set up the major mode.
3939 (funcall mode)
3940
3941 ;; Set up other local variables.
3942 (mapcar (lambda (v)
3943 (condition-case () ;in case var is read-only
3944 (if (symbolp v)
3945 (makunbound v)
3946 (set (make-local-variable (car v)) (cdr v)))
3947 (error nil)))
3948 lvars)
3949
3950 ;; Run any hooks (typically set up by the major mode
3951 ;; for cloning to work properly).
3952 (run-hooks 'clone-buffer-hook))
3953 (if display-flag (pop-to-buffer new))
3954 new))
3955
fa65f20b 3956
7e3afb04 3957(defun clone-indirect-buffer (newname display-flag &optional norecord)
fa65f20b
GM
3958 "Create an indirect buffer that is a twin copy of the current buffer.
3959
3960Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
3961from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
3962or if not called with a prefix arg, NEWNAME defaults to the current
3963buffer's name. The name is modified by adding a `<N>' suffix to it
3964or by incrementing the N in an existing suffix.
3965
3966DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7e3afb04
GM
3967This is always done when called interactively.
3968
3969Optional last arg NORECORD non-nil means do not put this buffer at the
3970front of the list of recently selected ones."
fa65f20b
GM
3971 (interactive (list (if current-prefix-arg
3972 (read-string "BName of indirect buffer: "))
3973 t))
3974 (setq newname (or newname (buffer-name)))
3975 (if (string-match "<[0-9]+>\\'" newname)
3976 (setq newname (substring newname 0 (match-beginning 0))))
3977 (let* ((name (generate-new-buffer-name newname))
3978 (buffer (make-indirect-buffer (current-buffer) name t)))
3979 (when display-flag
58dd38f1 3980 (pop-to-buffer buffer norecord))
fa65f20b
GM
3981 buffer))
3982
3983
7e3afb04
GM
3984(defun clone-indirect-buffer-other-window (buffer &optional norecord)
3985 "Create an indirect buffer that is a twin copy of BUFFER.
3986Select the new buffer in another window.
3987Optional second arg NORECORD non-nil means do not put this buffer at
3988the front of the list of recently selected ones."
3989 (interactive "bClone buffer in other window: ")
3990 (let ((popup-windows t))
3991 (set-buffer buffer)
3992 (clone-indirect-buffer nil t norecord)))
3993
14583cb1 3994(define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
7e3afb04 3995
eaae8106 3996
f1a9c7b9
GM
3997;;; Syntax stuff.
3998
3999(defconst syntax-code-table
24dad5d5
KH
4000 '((?\ 0 "whitespace")
4001 (?- 0 "whitespace")
4002 (?. 1 "punctuation")
4003 (?w 2 "word")
4004 (?_ 3 "symbol")
4005 (?\( 4 "open parenthesis")
4006 (?\) 5 "close parenthesis")
4007 (?\' 6 "expression prefix")
4008 (?\" 7 "string quote")
4009 (?$ 8 "paired delimiter")
4010 (?\\ 9 "escape")
4011 (?/ 10 "character quote")
4012 (?< 11 "comment start")
4013 (?> 12 "comment end")
4014 (?@ 13 "inherit")
4015 (nil 14 "comment fence")
4016 (nil 15 "string fence"))
4017 "Alist of forms (CHAR CODE DESCRIPTION) mapping characters to syntax info.
f1a9c7b9
GM
4018CHAR is a character that is allowed as first char in the string
4019specifying the syntax when calling `modify-syntax-entry'. CODE is the
4020corresponing syntax code as it is stored in a syntax cell, and
24dad5d5
KH
4021can be used as value of a `syntax-table' property.
4022DESCRIPTION is the descriptive string for the syntax.")
f1a9c7b9 4023
eaae8106 4024
1d4b11bf
GM
4025;;; Handling of Backspace and Delete keys.
4026
4027(defcustom delete-key-deletes-forward nil
4028 "Whether the Delete key should delete forward or not.
4029
4030On window systems, the default value of this option is chosen
4031according to the keyboard used. If the keyboard has both a Backspace
4032key and a Delete key, and both are mapped to their usual meanings, the
4033option's default value is set to t, so that Backspace can be used to
4034delete backward, and Delete can be used used to delete forward
4035
4036If not running under a window system, setting this option accomplishes
4037a similar effect by mapping C-h, which is usually generated by the
4038Backspace key, to DEL, and by mapping DEL to C-d via
4039`keyboard-translate'. The former functionality of C-h is available on
4040the F1 key. You should probably not use this setting if you don't
f060b834
GM
4041have both Backspace, Delete and F1 keys.
4042
4043Setting this variable with setq doesn't take effect. Programmatically,
4044call `delete-key-deleted-forward-mode' instead."
1d4b11bf
GM
4045 :type 'boolean
4046 :group 'editing-basics
4047 :version "21.1"
4048 :set (lambda (symbol value)
4049 ;; The fboundp is because of a problem with :set when
4050 ;; dumping Emacs. It doesn't really matter.
4051 (if (fboundp 'delete-key-deletes-forward-mode)
4052 (delete-key-deletes-forward-mode (or value 0))
4053 (set-default symbol value))))
4054
4055
4056(defun delete-key-deletes-forward-mode (&optional arg)
4057 "Toggle Delete key deleting forward or backward.
4058With numeric arg, turn the mode on if and only iff ARG is positive.
741e56a0 4059For more details, see `delete-key-deletes-forward'."
1d4b11bf
GM
4060 (interactive "P")
4061 (setq delete-key-deletes-forward
4062 (if arg
4063 (> (prefix-numeric-value arg) 0)
4064 (not delete-key-deletes-forward)))
4065
13a9eed7
EZ
4066 (cond ((or (memq window-system '(x w32 mac pc))
4067 (memq system-type '(ms-dos windows-nt)))
d25cc9a9 4068 (let ((bindings
ec9f4754 4069 `(([C-delete] [C-backspace] kill-word backward-kill-word)
d25cc9a9
GM
4070 ([M-delete] [M-backspace] kill-word backward-kill-word)
4071 ([C-M-delete] [C-M-backspace] kill-sexp backward-kill-sexp)
ec9f4754
GM
4072 (,esc-map
4073 [C-delete] [C-backspace]
4074 kill-sexp backward-kill-sexp))))
4075
4076 (if delete-key-deletes-forward
4077 (progn
4078 (define-key function-key-map [delete] [?\C-d])
be4f1e41 4079 (define-key function-key-map [kp-delete] [?\C-d])
ec9f4754
GM
4080 (define-key function-key-map [backspace] [?\C-?]))
4081 (define-key function-key-map [delete] [?\C-?])
be4f1e41 4082 (define-key function-key-map [kp-delete] [?\C-?])
ec9f4754
GM
4083 (define-key function-key-map [backspace] [?\C-?]))
4084
d25cc9a9
GM
4085 (dolist (binding bindings)
4086 (let ((map global-map))
4087 (when (keymapp (car binding))
4088 (setq map (car binding) binding (cdr binding)))
4089 (let ((key1 (nth 0 binding))
4090 (key2 (nth 1 binding))
4091 (binding1 (nth 2 binding))
4092 (binding2 (nth 3 binding)))
4093 (unless delete-key-deletes-forward
4094 (let ((temp binding1))
4095 (setq binding1 binding2 binding2 temp)))
4096 (define-key map key1 binding1)
4097 (define-key map key2 binding2))))))
1d4b11bf
GM
4098 (t
4099 (if delete-key-deletes-forward
4100 (progn
4101 (keyboard-translate ?\C-h ?\C-?)
4102 (keyboard-translate ?\C-? ?\C-d))
4103 (keyboard-translate ?\C-h ?\C-h)
4104 (keyboard-translate ?\C-? ?\C-?))))
4105
4106 (run-hooks 'delete-key-deletes-forward-hook)
4107 (if (interactive-p)
4108 (message "Delete key deletes %s"
4109 (if delete-key-deletes-forward "forward" "backward"))))
4110
4111
9985d391
GM
4112;;; Misc
4113
4114(defun byte-compiling-files-p ()
4115 "Return t if currently byte-compiling files."
4116 (and (boundp 'byte-compile-current-file)
4117 (stringp byte-compile-current-file)))
eaae8106 4118
c88ab9ce 4119;;; simple.el ends here