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