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