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