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