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