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