(w32_to_x_charset): Increase size of XLFD charset buffer.
[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
JB
265 (interactive "*")
266 (save-excursion
5ff4ba3d 267 (delete-horizontal-space t)
2076c87c 268 (indent-according-to-mode))
46947372 269 (newline)
2076c87c 270 (indent-according-to-mode))
eaae8106 271
93be67de
KH
272(defun quoted-insert (arg)
273 "Read next input character and insert it.
274This is useful for inserting control characters.
2076c87c 275
93be67de
KH
276If the first character you type after this command is an octal digit,
277you should type a sequence of octal digits which specify a character code.
278Any nondigit terminates the sequence. If the terminator is a RET,
279it is discarded; any other terminator is used itself as input.
280The variable `read-quoted-char-radix' specifies the radix for this feature;
281set it to 10 or 16 to use decimal or hex instead of octal.
dff7d67f 282
93be67de
KH
283In overwrite mode, this function inserts the character anyway, and
284does not handle octal digits specially. This means that if you use
285overwrite as your normal editing mode, you can use this function to
286insert characters when necessary.
dff7d67f 287
93be67de
KH
288In binary overwrite mode, this function does overwrite, and octal
289digits are interpreted as a character code. This is intended to be
290useful for editing binary files."
291 (interactive "*p")
292 (let ((char (if (or (not overwrite-mode)
293 (eq overwrite-mode 'overwrite-mode-binary))
294 (read-quoted-char)
295 (read-char))))
296 ;; Assume character codes 0240 - 0377 stand for characters in some
297 ;; single-byte character set, and convert them to Emacs
298 ;; characters.
299 (if (and enable-multibyte-characters
300 (>= char ?\240)
301 (<= char ?\377))
302 (setq char (unibyte-char-to-multibyte char)))
303 (if (> arg 0)
304 (if (eq overwrite-mode 'overwrite-mode-binary)
305 (delete-char arg)))
306 (while (> arg 0)
307 (insert-and-inherit char)
308 (setq arg (1- arg)))))
eaae8106 309
93be67de
KH
310(defun forward-to-indentation (arg)
311 "Move forward ARG lines and position at first nonblank character."
312 (interactive "p")
313 (forward-line arg)
314 (skip-chars-forward " \t"))
cc2b2b6c 315
93be67de
KH
316(defun backward-to-indentation (arg)
317 "Move backward ARG lines and position at first nonblank character."
318 (interactive "p")
319 (forward-line (- arg))
320 (skip-chars-forward " \t"))
2076c87c 321
93be67de
KH
322(defun back-to-indentation ()
323 "Move point to the first non-whitespace character on this line."
324 (interactive)
325 (beginning-of-line 1)
326 (skip-chars-forward " \t"))
327
328(defun fixup-whitespace ()
329 "Fixup white space between objects around point.
330Leave one space or none, according to the context."
331 (interactive "*")
332 (save-excursion
333 (delete-horizontal-space)
334 (if (or (looking-at "^\\|\\s)")
335 (save-excursion (forward-char -1)
336 (looking-at "$\\|\\s(\\|\\s'")))
337 nil
338 (insert ?\ ))))
339
5ff4ba3d
MB
340(defun delete-horizontal-space (&optional backward-only)
341 "Delete all spaces and tabs around point.
342If BACKWARD-ONLY is non-nil, only delete spaces before point."
93be67de 343 (interactive "*")
9ab59a1a
MB
344 (let ((orig-pos (point)))
345 (delete-region
346 (if backward-only
347 orig-pos
348 (progn
349 (skip-chars-forward " \t")
350 (constrain-to-field nil orig-pos t)))
5ff4ba3d 351 (progn
9ab59a1a
MB
352 (skip-chars-backward " \t")
353 (constrain-to-field nil orig-pos)))))
93be67de
KH
354
355(defun just-one-space ()
356 "Delete all spaces and tabs around point, leaving one space."
357 (interactive "*")
9ab59a1a
MB
358 (let ((orig-pos (point)))
359 (skip-chars-backward " \t")
360 (constrain-to-field nil orig-pos)
361 (if (= (following-char) ? )
362 (forward-char 1)
363 (insert ? ))
364 (delete-region
365 (point)
366 (progn
367 (skip-chars-forward " \t")
368 (constrain-to-field nil orig-pos t)))))
eaae8106 369
2076c87c
JB
370(defun beginning-of-buffer (&optional arg)
371 "Move point to the beginning of the buffer; leave mark at previous position.
c66587fe
RS
372With arg N, put point N/10 of the way from the beginning.
373
374If the buffer is narrowed, this command uses the beginning and size
375of the accessible part of the buffer.
ff1fbe3e
RS
376
377Don't use this command in Lisp programs!
2076c87c
JB
378\(goto-char (point-min)) is faster and avoids clobbering the mark."
379 (interactive "P")
380 (push-mark)
c66587fe
RS
381 (let ((size (- (point-max) (point-min))))
382 (goto-char (if arg
383 (+ (point-min)
384 (if (> size 10000)
385 ;; Avoid overflow for large buffer sizes!
386 (* (prefix-numeric-value arg)
387 (/ size 10))
388 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
389 (point-min))))
2076c87c
JB
390 (if arg (forward-line 1)))
391
392(defun end-of-buffer (&optional arg)
393 "Move point to the end of the buffer; leave mark at previous position.
c66587fe
RS
394With arg N, put point N/10 of the way from the end.
395
396If the buffer is narrowed, this command uses the beginning and size
397of the accessible part of the buffer.
ff1fbe3e
RS
398
399Don't use this command in Lisp programs!
2076c87c
JB
400\(goto-char (point-max)) is faster and avoids clobbering the mark."
401 (interactive "P")
402 (push-mark)
c66587fe
RS
403 (let ((size (- (point-max) (point-min))))
404 (goto-char (if arg
405 (- (point-max)
406 (if (> size 10000)
407 ;; Avoid overflow for large buffer sizes!
408 (* (prefix-numeric-value arg)
409 (/ size 10))
410 (/ (* size (prefix-numeric-value arg)) 10)))
411 (point-max))))
3a801d0c
ER
412 ;; If we went to a place in the middle of the buffer,
413 ;; adjust it to the beginning of a line.
314808dc 414 (cond (arg (forward-line 1))
919f2812 415 ((> (point) (window-end nil t))
314808dc
GM
416 ;; If the end of the buffer is not already on the screen,
417 ;; then scroll specially to put it near, but not at, the bottom.
418 (overlay-recenter (point))
419 (recenter -3))))
2076c87c
JB
420
421(defun mark-whole-buffer ()
70e14c01
JB
422 "Put point at beginning and mark at end of buffer.
423You probably should not use this function in Lisp programs;
424it is usually a mistake for a Lisp function to use any subroutine
425that uses or sets the mark."
2076c87c
JB
426 (interactive)
427 (push-mark (point))
fd0f4056 428 (push-mark (point-max) nil t)
2076c87c 429 (goto-char (point-min)))
fa65f20b 430
eaae8106 431
93be67de
KH
432;; Counting lines, one way or another.
433
434(defun goto-line (arg)
435 "Goto line ARG, counting from line 1 at beginning of buffer."
436 (interactive "NGoto line: ")
437 (setq arg (prefix-numeric-value arg))
438 (save-restriction
439 (widen)
440 (goto-char 1)
441 (if (eq selective-display t)
442 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
443 (forward-line (1- arg)))))
2076c87c
JB
444
445(defun count-lines-region (start end)
eb8c3be9 446 "Print number of lines and characters in the region."
2076c87c
JB
447 (interactive "r")
448 (message "Region has %d lines, %d characters"
449 (count-lines start end) (- end start)))
450
451(defun what-line ()
2578be76 452 "Print the current buffer line number and narrowed line number of point."
2076c87c 453 (interactive)
2578be76 454 (let ((opoint (point)) start)
2076c87c 455 (save-excursion
2578be76
RS
456 (save-restriction
457 (goto-char (point-min))
458 (widen)
4d251ae7 459 (forward-line 0)
2578be76
RS
460 (setq start (point))
461 (goto-char opoint)
4d251ae7 462 (forward-line 0)
2578be76
RS
463 (if (/= start 1)
464 (message "line %d (narrowed line %d)"
465 (1+ (count-lines 1 (point)))
466 (1+ (count-lines start (point))))
467 (message "Line %d" (1+ (count-lines 1 (point)))))))))
468
2076c87c
JB
469(defun count-lines (start end)
470 "Return number of lines between START and END.
471This is usually the number of newlines between them,
ff1fbe3e 472but can be one more if START is not equal to END
2076c87c 473and the greater of them is not at the start of a line."
e406700d
RS
474 (save-excursion
475 (save-restriction
476 (narrow-to-region start end)
477 (goto-char (point-min))
478 (if (eq selective-display t)
479 (save-match-data
dde92ca6
RS
480 (let ((done 0))
481 (while (re-search-forward "[\n\C-m]" nil t 40)
482 (setq done (+ 40 done)))
483 (while (re-search-forward "[\n\C-m]" nil t 1)
484 (setq done (+ 1 done)))
043efc41
RS
485 (goto-char (point-max))
486 (if (and (/= start end)
487 (not (bolp)))
488 (1+ done)
e406700d
RS
489 done)))
490 (- (buffer-size) (forward-line (buffer-size)))))))
eaae8106 491
d5d99b80
KH
492(defun what-cursor-position (&optional detail)
493 "Print info on cursor position (on screen and within buffer).
e38dff0c 494Also describe the character after point, and give its character code
c6fcc518
KH
495in octal, decimal and hex.
496
497For a non-ASCII multibyte character, also give its encoding in the
498buffer's selected coding system if the coding system encodes the
499character safely. If the character is encoded into one byte, that
500code is shown in hex. If the character is encoded into more than one
501byte, just \"...\" is shown.
e5a902cf 502
24dad5d5
KH
503In addition, with prefix argument, show details about that character
504in *Help* buffer. See also the command `describe-char-after'."
d5d99b80 505 (interactive "P")
2076c87c
JB
506 (let* ((char (following-char))
507 (beg (point-min))
508 (end (point-max))
509 (pos (point))
510 (total (buffer-size))
511 (percent (if (> total 50000)
512 ;; Avoid overflow from multiplying by 100!
513 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
514 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
515 (hscroll (if (= (window-hscroll) 0)
516 ""
517 (format " Hscroll=%d" (window-hscroll))))
518 (col (current-column)))
519 (if (= pos end)
520 (if (or (/= beg 1) (/= end (1+ total)))
74fd2380 521 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
2076c87c 522 pos total percent beg end col hscroll)
74fd2380 523 (message "point=%d of %d (%d%%) column %d %s"
2076c87c 524 pos total percent col hscroll))
c6fcc518
KH
525 (let ((coding buffer-file-coding-system)
526 encoded encoding-msg)
527 (if (or (not coding)
528 (eq (coding-system-type coding) t))
529 (setq coding default-buffer-file-coding-system))
28fd4883
KH
530 (if (not (char-valid-p char))
531 (setq encoding-msg
532 (format "(0%o, %d, 0x%x, invalid)" char char char))
533 (setq encoded (and (>= char 128) (encode-coding-char char coding)))
534 (setq encoding-msg
535 (if encoded
24dad5d5 536 (format "(0%o, %d, 0x%x, file %s)"
28fd4883 537 char char char
24dad5d5 538 (if (> (length encoded) 1)
28fd4883 539 "..."
24dad5d5 540 (encoded-string-description encoded coding)))
28fd4883 541 (format "(0%o, %d, 0x%x)" char char char))))
e5e89e48 542 (if detail
24dad5d5
KH
543 ;; We show the detailed information about CHAR.
544 (describe-char-after (point)))
545 (if (or (/= beg 1) (/= end (1+ total)))
546 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
e5a902cf
KH
547 (if (< char 256)
548 (single-key-description char)
f0d16a7f 549 (buffer-substring-no-properties (point) (1+ (point))))
24dad5d5
KH
550 encoding-msg pos total percent beg end col hscroll)
551 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
552 (if (< char 256)
553 (single-key-description char)
554 (buffer-substring-no-properties (point) (1+ (point))))
555 encoding-msg pos total percent col hscroll))))))
eaae8106 556
76c64e24
SM
557(defvar read-expression-map
558 (let ((m (make-sparse-keymap)))
559 (define-key m "\M-\t" 'lisp-complete-symbol)
560 (set-keymap-parent m minibuffer-local-map)
561 m)
854c16c5 562 "Minibuffer keymap used for reading Lisp expressions.")
854c16c5 563
8570b0ca
RM
564(defvar read-expression-history nil)
565
b49df39d
RS
566(defcustom eval-expression-print-level 4
567 "*Value to use for `print-level' when printing value in `eval-expression'."
568 :group 'lisp
e8b1643c 569 :type '(choice (const nil) integer)
b49df39d
RS
570 :version "21.1")
571
572(defcustom eval-expression-print-length 12
573 "*Value to use for `print-length' when printing value in `eval-expression'."
574 :group 'lisp
56437999 575 :type '(choice (const nil) integer)
b49df39d
RS
576 :version "21.1")
577
578(defcustom eval-expression-debug-on-error t
ed8bcabe
GM
579 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
580If nil, don't change the value of `debug-on-error'."
b49df39d
RS
581 :group 'lisp
582 :type 'boolean
583 :version "21.1")
584
8570b0ca 585;; We define this, rather than making `eval' interactive,
2076c87c 586;; for the sake of completion of names like eval-region, eval-current-buffer.
ecb7ad00
RS
587(defun eval-expression (eval-expression-arg
588 &optional eval-expression-insert-value)
a6a1ee53
EZ
589 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
590Value is also consed on to front of the variable `values'.
591Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
592insert the result into the current buffer instead of printing it in
593the echo area."
adca5fa6 594 (interactive
b387ef9a
RS
595 (list (read-from-minibuffer "Eval: "
596 nil read-expression-map t
ecb7ad00
RS
597 'read-expression-history)
598 current-prefix-arg))
eaae8106 599
ed8bcabe
GM
600 (if (null eval-expression-debug-on-error)
601 (setq values (cons (eval eval-expression-arg) values))
602 (let ((old-value (make-symbol "t")) new-value)
603 ;; Bind debug-on-error to something unique so that we can
604 ;; detect when evaled code changes it.
605 (let ((debug-on-error old-value))
606 (setq values (cons (eval eval-expression-arg) values))
607 (setq new-value debug-on-error))
608 ;; If evaled code has changed the value of debug-on-error,
609 ;; propagate that change to the global binding.
610 (unless (eq old-value new-value)
611 (setq debug-on-error new-value))))
eaae8106 612
b49df39d
RS
613 (let ((print-length eval-expression-print-length)
614 (print-level eval-expression-print-level))
615 (prin1 (car values)
616 (if eval-expression-insert-value (current-buffer) t))))
2076c87c
JB
617
618(defun edit-and-eval-command (prompt command)
619 "Prompting with PROMPT, let user edit COMMAND and eval result.
620COMMAND is a Lisp expression. Let user edit that expression in
621the minibuffer, then read and evaluate the result."
b387ef9a
RS
622 (let ((command (read-from-minibuffer prompt
623 (prin1-to-string command)
624 read-expression-map t
625 '(command-history . 1))))
5d6c83ae 626 ;; If command was added to command-history as a string,
1f238ac2 627 ;; get rid of that. We want only evaluable expressions there.
5d6c83ae
KH
628 (if (stringp (car command-history))
629 (setq command-history (cdr command-history)))
630
631 ;; If command to be redone does not match front of history,
632 ;; add it to the history.
633 (or (equal command (car command-history))
634 (setq command-history (cons command command-history)))
2076c87c
JB
635 (eval command)))
636
ebb61177 637(defun repeat-complex-command (arg)
2076c87c
JB
638 "Edit and re-evaluate last complex command, or ARGth from last.
639A complex command is one which used the minibuffer.
640The command is placed in the minibuffer as a Lisp form for editing.
641The result is executed, repeating the command as changed.
642If the command has been changed or is not the most recent previous command
643it is added to the front of the command history.
eb6e9899
RS
644You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
645to get different commands to edit and resubmit."
2076c87c 646 (interactive "p")
ba343182 647 (let ((elt (nth (1- arg) command-history))
2076c87c
JB
648 newcmd)
649 (if elt
854c16c5 650 (progn
eab22e27 651 (setq newcmd
74ae5fab
RS
652 (let ((print-level nil)
653 (minibuffer-history-position arg)
99ea24de 654 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
7908d27c
RS
655 (read-from-minibuffer
656 "Redo: " (prin1-to-string elt) read-expression-map t
657 (cons 'command-history arg))))
eab22e27 658
db16f109 659 ;; If command was added to command-history as a string,
1f238ac2 660 ;; get rid of that. We want only evaluable expressions there.
db16f109
RS
661 (if (stringp (car command-history))
662 (setq command-history (cdr command-history)))
663
664 ;; If command to be redone does not match front of history,
665 ;; add it to the history.
666 (or (equal newcmd (car command-history))
667 (setq command-history (cons newcmd command-history)))
2076c87c
JB
668 (eval newcmd))
669 (ding))))
eaae8106 670
854c16c5
RS
671(defvar minibuffer-history nil
672 "Default minibuffer history list.
673This is used for all minibuffer input
674except when an alternate history list is specified.")
675(defvar minibuffer-history-sexp-flag nil
c2d4b6d9 676 "Non-nil when doing history operations on `command-history'.
854c16c5 677More generally, indicates that the history list being acted on
99ea24de
KH
678contains expressions rather than strings.
679It is only valid if its value equals the current minibuffer depth,
680to handle recursive uses of the minibuffer.")
e91f80c4
RS
681(setq minibuffer-history-variable 'minibuffer-history)
682(setq minibuffer-history-position nil)
854c16c5 683(defvar minibuffer-history-search-history nil)
e91f80c4 684
93cee14b
RS
685(defvar minibuffer-text-before-history nil
686 "Text that was in this minibuffer before any history commands.
687This is nil if there have not yet been any history commands
688in this use of the minibuffer.")
689
690(add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
691
692(defun minibuffer-history-initialize ()
693 (setq minibuffer-text-before-history nil))
694
6e7d0ff7
MB
695(defun minibuffer-avoid-prompt (new old)
696 "A point-motion hook for the minibuffer, that moves point out of the prompt."
697 (constrain-to-field nil (point-max)))
698
6e30a99a
RS
699(defcustom minibuffer-history-case-insensitive-variables nil
700 "*Minibuffer history variables for which matching should ignore case.
701If a history variable is a member of this list, then the
702\\[previous-matching-history-element] and \\[next-matching-history-element]\
703 commands ignore case when searching it, regardless of `case-fold-search'."
704 :type '(repeat variable)
705 :group 'minibuffer)
706
e91f80c4 707(defun previous-matching-history-element (regexp n)
854c16c5
RS
708 "Find the previous history element that matches REGEXP.
709\(Previous history elements refer to earlier actions.)
710With prefix argument N, search for Nth previous match.
5c2010f0 711If N is negative, find the next or Nth next match.
9889af08
EZ
712Normally, history elements are matched case-insensitively if
713`case-fold-search' is non-nil, but an uppercase letter in REGEXP
714makes the search case-sensitive.
6e30a99a 715See also `minibuffer-history-case-insensitive-variables'."
854c16c5 716 (interactive
c1172a19 717 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
718 (regexp (read-from-minibuffer "Previous element matching (regexp): "
719 nil
720 minibuffer-local-map
721 nil
722 'minibuffer-history-search-history)))
723 ;; Use the last regexp specified, by default, if input is empty.
724 (list (if (string= regexp "")
a8e96cea
KH
725 (if minibuffer-history-search-history
726 (car minibuffer-history-search-history)
727 (error "No previous history search regexp"))
c1172a19 728 regexp)
854c16c5 729 (prefix-numeric-value current-prefix-arg))))
e276a14a
MB
730 (unless (zerop n)
731 (if (and (zerop minibuffer-history-position)
732 (null minibuffer-text-before-history))
efaac2e6 733 (setq minibuffer-text-before-history
6d74d713 734 (minibuffer-contents-no-properties)))
e276a14a
MB
735 (let ((history (symbol-value minibuffer-history-variable))
736 (case-fold-search
737 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
738 ;; On some systems, ignore case for file names.
739 (if (memq minibuffer-history-variable
740 minibuffer-history-case-insensitive-variables)
741 t
742 ;; Respect the user's setting for case-fold-search:
743 case-fold-search)
744 nil))
745 prevpos
746 match-string
747 match-offset
748 (pos minibuffer-history-position))
749 (while (/= n 0)
750 (setq prevpos pos)
751 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
752 (when (= pos prevpos)
e91f80c4 753 (error (if (= pos 1)
ccc58657
RS
754 "No later matching history item"
755 "No earlier matching history item")))
e276a14a
MB
756 (setq match-string
757 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
7908d27c 758 (let ((print-level nil))
e276a14a
MB
759 (prin1-to-string (nth (1- pos) history)))
760 (nth (1- pos) history)))
761 (setq match-offset
762 (if (< n 0)
763 (and (string-match regexp match-string)
764 (match-end 0))
765 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
766 (match-beginning 1))))
767 (when match-offset
768 (setq n (+ n (if (< n 0) 1 -1)))))
769 (setq minibuffer-history-position pos)
770 (goto-char (point-max))
efaac2e6 771 (delete-minibuffer-contents)
e276a14a 772 (insert match-string)
6d74d713 773 (goto-char (+ (minibuffer-prompt-end) match-offset))))
854c16c5
RS
774 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
775 (eq (car (car command-history)) 'next-matching-history-element))
776 (setq command-history (cdr command-history))))
e91f80c4 777
e91f80c4 778(defun next-matching-history-element (regexp n)
854c16c5
RS
779 "Find the next history element that matches REGEXP.
780\(The next history element refers to a more recent action.)
781With prefix argument N, search for Nth next match.
5c2010f0 782If N is negative, find the previous or Nth previous match.
9889af08
EZ
783Normally, history elements are matched case-insensitively if
784`case-fold-search' is non-nil, but an uppercase letter in REGEXP
785makes the search case-sensitive."
854c16c5 786 (interactive
c1172a19 787 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
788 (regexp (read-from-minibuffer "Next element matching (regexp): "
789 nil
790 minibuffer-local-map
791 nil
792 'minibuffer-history-search-history)))
793 ;; Use the last regexp specified, by default, if input is empty.
794 (list (if (string= regexp "")
795 (setcar minibuffer-history-search-history
796 (nth 1 minibuffer-history-search-history))
797 regexp)
854c16c5 798 (prefix-numeric-value current-prefix-arg))))
e91f80c4 799 (previous-matching-history-element regexp (- n)))
2076c87c 800
8dc3ba7d
MB
801(defvar minibuffer-temporary-goal-position nil)
802
ebb61177
RS
803(defun next-history-element (n)
804 "Insert the next element of the minibuffer history into the minibuffer."
2076c87c 805 (interactive "p")
0818b15e 806 (or (zerop n)
93cee14b
RS
807 (let ((narg (- minibuffer-history-position n))
808 (minimum (if minibuffer-default -1 0))
068c712c 809 elt minibuffer-returned-to-present)
93cee14b
RS
810 (if (and (zerop minibuffer-history-position)
811 (null minibuffer-text-before-history))
efaac2e6
MB
812 (setq minibuffer-text-before-history
813 (minibuffer-contents-no-properties)))
93cee14b 814 (if (< narg minimum)
81091543
RS
815 (if minibuffer-default
816 (error "End of history; no next item")
817 (error "End of history; no default available")))
93cee14b
RS
818 (if (> narg (length (symbol-value minibuffer-history-variable)))
819 (error "Beginning of history; no preceding item"))
8dc3ba7d
MB
820 (unless (or (eq last-command 'next-history-element)
821 (eq last-command 'previous-history-element))
efaac2e6 822 (let ((prompt-end (minibuffer-prompt-end)))
8dc3ba7d
MB
823 (set (make-local-variable 'minibuffer-temporary-goal-position)
824 (cond ((<= (point) prompt-end) prompt-end)
825 ((eobp) nil)
826 (t (point))))))
a4d1159b 827 (goto-char (point-max))
efaac2e6 828 (delete-minibuffer-contents)
93cee14b
RS
829 (setq minibuffer-history-position narg)
830 (cond ((= narg -1)
831 (setq elt minibuffer-default))
832 ((= narg 0)
54c548db 833 (setq elt (or minibuffer-text-before-history ""))
068c712c 834 (setq minibuffer-returned-to-present t)
93cee14b
RS
835 (setq minibuffer-text-before-history nil))
836 (t (setq elt (nth (1- minibuffer-history-position)
837 (symbol-value minibuffer-history-variable)))))
838 (insert
068c712c
KH
839 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
840 (not minibuffer-returned-to-present))
93cee14b
RS
841 (let ((print-level nil))
842 (prin1-to-string elt))
843 elt))
8dc3ba7d 844 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
2076c87c 845
ebb61177 846(defun previous-history-element (n)
3ee3a076 847 "Inserts the previous element of the minibuffer history into the minibuffer."
2076c87c 848 (interactive "p")
2c5e21c1 849 (next-history-element (- n)))
d0678801
RM
850
851(defun next-complete-history-element (n)
a4d1159b
GM
852 "Get next history element which completes the minibuffer before the point.
853The contents of the minibuffer after the point are deleted, and replaced
854by the new completion."
d0678801 855 (interactive "p")
b5e6f936
RM
856 (let ((point-at-start (point)))
857 (next-matching-history-element
a4d1159b 858 (concat
efaac2e6 859 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
a4d1159b 860 n)
b5e6f936
RM
861 ;; next-matching-history-element always puts us at (point-min).
862 ;; Move to the position we were at before changing the buffer contents.
863 ;; This is still sensical, because the text before point has not changed.
864 (goto-char point-at-start)))
d0678801
RM
865
866(defun previous-complete-history-element (n)
1f6fcec3 867 "\
a4d1159b
GM
868Get previous history element which completes the minibuffer before the point.
869The contents of the minibuffer after the point are deleted, and replaced
870by the new completion."
d0678801
RM
871 (interactive "p")
872 (next-complete-history-element (- n)))
a4d1159b 873
efaac2e6 874;; For compatibility with the old subr of the same name.
a4d1159b
GM
875(defun minibuffer-prompt-width ()
876 "Return the display width of the minibuffer prompt.
877Return 0 if current buffer is not a mini-buffer."
878 ;; Return the width of everything before the field at the end of
879 ;; the buffer; this should be 0 for normal buffers.
efaac2e6 880 (1- (minibuffer-prompt-end)))
eaae8106 881
2076c87c 882;Put this on C-x u, so we can force that rather than C-_ into startup msg
e462e42f 883(defalias 'advertised-undo 'undo)
2076c87c
JB
884
885(defun undo (&optional arg)
886 "Undo some previous changes.
887Repeat this command to undo more changes.
65627aad
RS
888A numeric argument serves as a repeat count.
889
3c1b77ca
MB
890In Transient Mark mode when the mark is active, only undo changes within
891the current region. Similarly, when not in Transient Mark mode, just C-u
892as an argument limits undo to changes within the current region."
65627aad 893 (interactive "*P")
456c617c
RS
894 ;; If we don't get all the way thru, make last-command indicate that
895 ;; for the following command.
896 (setq this-command t)
b553cffa
RS
897 (let ((modified (buffer-modified-p))
898 (recent-save (recent-auto-save-p)))
71e40adf
JB
899 (or (eq (selected-window) (minibuffer-window))
900 (message "Undo!"))
3c1b77ca
MB
901 (unless (eq last-command 'undo)
902 (if (if transient-mark-mode mark-active (and arg (not (numberp arg))))
903 (undo-start (region-beginning) (region-end))
904 (undo-start))
905 ;; get rid of initial undo boundary
906 (undo-more 1))
907 (undo-more
908 (if (or transient-mark-mode (numberp arg))
909 (prefix-numeric-value arg)
910 1))
2512c9f0
RS
911 ;; Don't specify a position in the undo record for the undo command.
912 ;; Instead, undoing this should move point to where the change is.
913 (let ((tail buffer-undo-list)
003550c5
GM
914 (prev nil))
915 (while (car tail)
916 (when (integerp (car tail))
917 (let ((pos (car tail)))
918 (if (null prev)
919 (setq buffer-undo-list (cdr tail))
920 (setcdr prev (cdr tail)))
921 (setq tail (cdr tail))
922 (while (car tail)
923 (if (eq pos (car tail))
924 (if prev
925 (setcdr prev (cdr tail))
926 (setq buffer-undo-list (cdr tail)))
927 (setq prev tail))
928 (setq tail (cdr tail)))
929 (setq tail nil)))
930 (setq prev tail tail (cdr tail))))
931
2076c87c 932 (and modified (not (buffer-modified-p))
456c617c
RS
933 (delete-auto-save-file-if-necessary recent-save)))
934 ;; If we do get all the way thru, make this-command indicate that.
935 (setq this-command 'undo))
2076c87c 936
278b0a58
RS
937(defvar pending-undo-list nil
938 "Within a run of consecutive undo commands, list remaining to be undone.")
939
52d1110d
RS
940(defvar undo-in-progress nil
941 "Non-nil while performing an undo.
942Some change-hooks test this variable to do something different.")
943
2076c87c
JB
944(defun undo-more (count)
945 "Undo back N undo-boundaries beyond what was already undone recently.
ff1fbe3e
RS
946Call `undo-start' to get ready to undo recent changes,
947then call `undo-more' one or more times to undo them."
2076c87c
JB
948 (or pending-undo-list
949 (error "No further undo information"))
52d1110d
RS
950 (let ((undo-in-progress t))
951 (setq pending-undo-list (primitive-undo count pending-undo-list))))
2076c87c 952
65627aad
RS
953;; Deep copy of a list
954(defun undo-copy-list (list)
955 "Make a copy of undo list LIST."
956 (mapcar 'undo-copy-list-1 list))
957
958(defun undo-copy-list-1 (elt)
959 (if (consp elt)
960 (cons (car elt) (undo-copy-list-1 (cdr elt)))
961 elt))
962
963(defun undo-start (&optional beg end)
964 "Set `pending-undo-list' to the front of the undo list.
965The next call to `undo-more' will undo the most recently made change.
966If BEG and END are specified, then only undo elements
967that apply to text between BEG and END are used; other undo elements
968are ignored. If BEG and END are nil, all undo elements are used."
969 (if (eq buffer-undo-list t)
970 (error "No undo information in this buffer"))
1e722f9f 971 (setq pending-undo-list
65627aad
RS
972 (if (and beg end (not (= beg end)))
973 (undo-make-selective-list (min beg end) (max beg end))
974 buffer-undo-list)))
975
976(defvar undo-adjusted-markers)
977
978(defun undo-make-selective-list (start end)
979 "Return a list of undo elements for the region START to END.
980The elements come from `buffer-undo-list', but we keep only
981the elements inside this region, and discard those outside this region.
982If we find an element that crosses an edge of this region,
983we stop and ignore all further elements."
984 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
985 (undo-list (list nil))
986 undo-adjusted-markers
987 some-rejected
988 undo-elt undo-elt temp-undo-list delta)
989 (while undo-list-copy
990 (setq undo-elt (car undo-list-copy))
991 (let ((keep-this
992 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
993 ;; This is a "was unmodified" element.
994 ;; Keep it if we have kept everything thus far.
995 (not some-rejected))
996 (t
997 (undo-elt-in-region undo-elt start end)))))
998 (if keep-this
999 (progn
1000 (setq end (+ end (cdr (undo-delta undo-elt))))
1001 ;; Don't put two nils together in the list
1002 (if (not (and (eq (car undo-list) nil)
1003 (eq undo-elt nil)))
1004 (setq undo-list (cons undo-elt undo-list))))
1005 (if (undo-elt-crosses-region undo-elt start end)
1006 (setq undo-list-copy nil)
1007 (setq some-rejected t)
1008 (setq temp-undo-list (cdr undo-list-copy))
1009 (setq delta (undo-delta undo-elt))
1010
1011 (when (/= (cdr delta) 0)
1012 (let ((position (car delta))
1013 (offset (cdr delta)))
1014
1015 ;; Loop down the earlier events adjusting their buffer positions
1016 ;; to reflect the fact that a change to the buffer isn't being
1017 ;; undone. We only need to process those element types which
1018 ;; undo-elt-in-region will return as being in the region since
1019 ;; only those types can ever get into the output
1020
1021 (while temp-undo-list
1022 (setq undo-elt (car temp-undo-list))
1023 (cond ((integerp undo-elt)
1024 (if (>= undo-elt position)
1025 (setcar temp-undo-list (- undo-elt offset))))
1026 ((atom undo-elt) nil)
1027 ((stringp (car undo-elt))
1028 ;; (TEXT . POSITION)
1029 (let ((text-pos (abs (cdr undo-elt)))
1030 (point-at-end (< (cdr undo-elt) 0 )))
1031 (if (>= text-pos position)
1e722f9f 1032 (setcdr undo-elt (* (if point-at-end -1 1)
65627aad
RS
1033 (- text-pos offset))))))
1034 ((integerp (car undo-elt))
1035 ;; (BEGIN . END)
1036 (when (>= (car undo-elt) position)
1037 (setcar undo-elt (- (car undo-elt) offset))
1038 (setcdr undo-elt (- (cdr undo-elt) offset))))
1039 ((null (car undo-elt))
1040 ;; (nil PROPERTY VALUE BEG . END)
1041 (let ((tail (nthcdr 3 undo-elt)))
1042 (when (>= (car tail) position)
1043 (setcar tail (- (car tail) offset))
1044 (setcdr tail (- (cdr tail) offset))))))
1045 (setq temp-undo-list (cdr temp-undo-list))))))))
1046 (setq undo-list-copy (cdr undo-list-copy)))
1047 (nreverse undo-list)))
1048
1049(defun undo-elt-in-region (undo-elt start end)
1050 "Determine whether UNDO-ELT falls inside the region START ... END.
1051If it crosses the edge, we return nil."
1052 (cond ((integerp undo-elt)
1053 (and (>= undo-elt start)
1054 (< undo-elt end)))
1055 ((eq undo-elt nil)
1056 t)
1057 ((atom undo-elt)
1058 nil)
1059 ((stringp (car undo-elt))
1060 ;; (TEXT . POSITION)
1061 (and (>= (abs (cdr undo-elt)) start)
1062 (< (abs (cdr undo-elt)) end)))
1063 ((and (consp undo-elt) (markerp (car undo-elt)))
1064 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1065 ;; See if MARKER is inside the region.
1066 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1067 (unless alist-elt
1068 (setq alist-elt (cons (car undo-elt)
1069 (marker-position (car undo-elt))))
1070 (setq undo-adjusted-markers
1071 (cons alist-elt undo-adjusted-markers)))
1072 (and (cdr alist-elt)
1073 (>= (cdr alist-elt) start)
1074 (< (cdr alist-elt) end))))
1075 ((null (car undo-elt))
1076 ;; (nil PROPERTY VALUE BEG . END)
1077 (let ((tail (nthcdr 3 undo-elt)))
1078 (and (>= (car tail) start)
1079 (< (cdr tail) end))))
1080 ((integerp (car undo-elt))
1081 ;; (BEGIN . END)
1082 (and (>= (car undo-elt) start)
1083 (< (cdr undo-elt) end)))))
1084
1085(defun undo-elt-crosses-region (undo-elt start end)
1086 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1087This assumes we have already decided that UNDO-ELT
1088is not *inside* the region START...END."
1089 (cond ((atom undo-elt) nil)
1090 ((null (car undo-elt))
1091 ;; (nil PROPERTY VALUE BEG . END)
1092 (let ((tail (nthcdr 3 undo-elt)))
1093 (not (or (< (car tail) end)
1094 (> (cdr tail) start)))))
1095 ((integerp (car undo-elt))
1096 ;; (BEGIN . END)
1097 (not (or (< (car undo-elt) end)
1098 (> (cdr undo-elt) start))))))
1099
1100;; Return the first affected buffer position and the delta for an undo element
1101;; delta is defined as the change in subsequent buffer positions if we *did*
1102;; the undo.
1103(defun undo-delta (undo-elt)
1104 (if (consp undo-elt)
1105 (cond ((stringp (car undo-elt))
1106 ;; (TEXT . POSITION)
1107 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1108 ((integerp (car undo-elt))
1109 ;; (BEGIN . END)
1110 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1111 (t
1112 '(0 . 0)))
1113 '(0 . 0)))
eaae8106 1114
009ef402
RS
1115(defvar shell-command-history nil
1116 "History list for some commands that read shell commands.")
1117
59fc41e5
RS
1118(defvar shell-command-switch "-c"
1119 "Switch used to have the shell execute its command line argument.")
1120
cc039f78
KH
1121(defvar shell-command-default-error-buffer nil
1122 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1123This buffer is used when `shell-command' or 'shell-command-on-region'
1124is run interactively. A value of nil means that output to stderr and
1125stdout will be intermixed in the output stream.")
1126
1127(defun shell-command (command &optional output-buffer error-buffer)
2076c87c 1128 "Execute string COMMAND in inferior shell; display output, if any.
0b3f96d4 1129With prefix argument, insert the COMMAND's output at point.
d382f610 1130
2076c87c 1131If COMMAND ends in ampersand, execute it asynchronously.
d382f610 1132The output appears in the buffer `*Async Shell Command*'.
bcad4985 1133That buffer is in shell mode.
d382f610 1134
939ac10c
GM
1135Otherwise, COMMAND is executed synchronously. The output appears in
1136the buffer `*Shell Command Output*'. If the output is short enough to
1137display in the echo area (which is determined by the variables
1138`resize-mini-windows' and `max-mini-window-height'), it is shown
1139there, but it is nonetheless available in buffer `*Shell Command
1140Output*' even though that buffer is not automatically displayed. If
1141there is no output, or if output is inserted in the current buffer,
1142then `*Shell Command Output*' is deleted.
d0d74413 1143
07f458c1
RS
1144To specify a coding system for converting non-ASCII characters
1145in the shell command output, use \\[universal-coding-system-argument]
1146before this command.
1147
1148Noninteractive callers can specify coding systems by binding
1149`coding-system-for-read' and `coding-system-for-write'.
1150
d0d74413
RS
1151The optional second argument OUTPUT-BUFFER, if non-nil,
1152says to put the output in some other buffer.
1153If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1154If OUTPUT-BUFFER is not a buffer and not nil,
1155insert output in current buffer. (This cannot be done asynchronously.)
cc039f78
KH
1156In either case, the output is inserted after point (leaving mark after it).
1157
1158If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1159or buffer name to which to direct the command's standard error output.
1160If it is nil, error output is mingled with regular output.
1161In an interactive call, the variable `shell-command-default-error-buffer'
1162specifies the value of ERROR-BUFFER."
1163
aa00b92d
RS
1164 (interactive (list (read-from-minibuffer "Shell command: "
1165 nil nil nil 'shell-command-history)
cc039f78
KH
1166 current-prefix-arg
1167 shell-command-default-error-buffer))
c7edd03c
KH
1168 ;; Look for a handler in case default-directory is a remote file name.
1169 (let ((handler
1170 (find-file-name-handler (directory-file-name default-directory)
1171 'shell-command)))
1172 (if handler
cc039f78 1173 (funcall handler 'shell-command command output-buffer error-buffer)
c7edd03c
KH
1174 (if (and output-buffer
1175 (not (or (bufferp output-buffer) (stringp output-buffer))))
cc039f78 1176 (let ((error-file
1e722f9f 1177 (if error-buffer
b005abd5 1178 (make-temp-file
171a45d9
EZ
1179 (expand-file-name "scor"
1180 (or small-temporary-file-directory
1181 temporary-file-directory)))
cc039f78
KH
1182 nil)))
1183 (barf-if-buffer-read-only)
63437623 1184 (push-mark nil t)
cc039f78
KH
1185 ;; We do not use -f for csh; we will not support broken use of
1186 ;; .cshrcs. Even the BSD csh manual says to use
1187 ;; "if ($?prompt) exit" before things which are not useful
1188 ;; non-interactively. Besides, if someone wants their other
1189 ;; aliases for shell commands then they can still have them.
1e722f9f 1190 (call-process shell-file-name nil
cc039f78
KH
1191 (if error-file
1192 (list t error-file)
1193 t)
1194 nil shell-command-switch command)
1195 (when (and error-file (file-exists-p error-file))
1196 (if (< 0 (nth 7 (file-attributes error-file)))
1197 (with-current-buffer (get-buffer-create error-buffer)
1198 (let ((pos-from-end (- (point-max) (point))))
1199 (or (bobp)
1200 (insert "\f\n"))
1201 ;; Do no formatting while reading error file,
1202 ;; because that can run a shell command, and we
1203 ;; don't want that to cause an infinite recursion.
1204 (format-insert-file error-file nil)
1205 ;; Put point after the inserted errors.
1206 (goto-char (- (point-max) pos-from-end)))
1207 (display-buffer (current-buffer))))
1208 (delete-file error-file))
1209 ;; This is like exchange-point-and-mark, but doesn't
1210 ;; activate the mark. It is cleaner to avoid activation,
1211 ;; even though the command loop would deactivate the mark
1212 ;; because we inserted text.
1213 (goto-char (prog1 (mark t)
1214 (set-marker (mark-marker) (point)
1215 (current-buffer)))))
c7edd03c
KH
1216 ;; Preserve the match data in case called from a program.
1217 (save-match-data
1218 (if (string-match "[ \t]*&[ \t]*$" command)
1219 ;; Command ending with ampersand means asynchronous.
1220 (let ((buffer (get-buffer-create
1221 (or output-buffer "*Async Shell Command*")))
1222 (directory default-directory)
1223 proc)
1224 ;; Remove the ampersand.
1225 (setq command (substring command 0 (match-beginning 0)))
1226 ;; If will kill a process, query first.
1227 (setq proc (get-buffer-process buffer))
1228 (if proc
1229 (if (yes-or-no-p "A command is running. Kill it? ")
1230 (kill-process proc)
1231 (error "Shell command in progress")))
1232 (save-excursion
1233 (set-buffer buffer)
1234 (setq buffer-read-only nil)
1235 (erase-buffer)
1236 (display-buffer buffer)
1237 (setq default-directory directory)
1e722f9f 1238 (setq proc (start-process "Shell" buffer shell-file-name
c7edd03c
KH
1239 shell-command-switch command))
1240 (setq mode-line-process '(":%s"))
1241 (require 'shell) (shell-mode)
1242 (set-process-sentinel proc 'shell-command-sentinel)
1243 ))
cc039f78
KH
1244 (shell-command-on-region (point) (point) command
1245 output-buffer nil error-buffer)))))))
eaae8106 1246
f69aad2b
MB
1247(defun display-message-or-buffer (message
1248 &optional buffer-name not-this-window frame)
1249 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1250MESSAGE may be either a string or a buffer.
1251
1252A buffer is displayed using `display-buffer' if MESSAGE is too long for
939ac10c
GM
1253the maximum height of the echo area, as defined by `max-mini-window-height'
1254if `resize-mini-windows' is non-nil.
f69aad2b 1255
2a3f00bf
MB
1256Returns either the string shown in the echo area, or when a pop-up
1257buffer is used, the window used to display it.
1258
f69aad2b
MB
1259If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1260name of the buffer used to display it in the case where a pop-up buffer
1261is used, defaulting to `*Message*'. In the case where MESSAGE is a
1262string and it is displayed in the echo area, it is not specified whether
1263the contents are inserted into the buffer anyway.
1264
1265Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1266and only used if a buffer is displayed."
1267 (cond ((and (stringp message) (not (string-match "\n" message)))
1268 ;; Trivial case where we can use the echo area
1269 (message "%s" message))
1270 ((and (stringp message)
1271 (= (string-match "\n" message) (1- (length message))))
1272 ;; Trivial case where we can just remove single trailing newline
1273 (message "%s" (substring message 0 (1- (length message)))))
1274 (t
1275 ;; General case
1276 (with-current-buffer
1277 (if (bufferp message)
1278 message
1279 (get-buffer-create (or buffer-name "*Message*")))
1280
1281 (unless (bufferp message)
1282 (erase-buffer)
1283 (insert message))
1284
1285 (let ((lines
1286 (if (= (buffer-size) 0)
1287 0
1288 (count-lines (point-min) (point-max)))))
1289 (cond ((or (<= lines 1)
1290 (<= lines
939ac10c
GM
1291 (if resize-mini-windows
1292 (cond ((floatp max-mini-window-height)
1293 (* (frame-height)
1294 max-mini-window-height))
1295 ((integerp max-mini-window-height)
1296 max-mini-window-height)
1297 (t
1298 1))
1299 1)))
f69aad2b
MB
1300 ;; Echo area
1301 (goto-char (point-max))
1302 (when (bolp)
1303 (backward-char 1))
1304 (message "%s" (buffer-substring (point-min) (point))))
1305 (t
1306 ;; Buffer
1307 (goto-char (point-min))
31252c00
MB
1308 (display-buffer (current-buffer)
1309 not-this-window frame))))))))
f69aad2b
MB
1310
1311
2076c87c
JB
1312;; We have a sentinel to prevent insertion of a termination message
1313;; in the buffer itself.
1314(defun shell-command-sentinel (process signal)
bcad4985 1315 (if (memq (process-status process) '(exit signal))
1e722f9f 1316 (message "%s: %s."
bcad4985
KH
1317 (car (cdr (cdr (process-command process))))
1318 (substring signal 0 -1))))
2076c87c 1319
d0d74413 1320(defun shell-command-on-region (start end command
cce1c318
RS
1321 &optional output-buffer replace
1322 error-buffer)
2076c87c
JB
1323 "Execute string COMMAND in inferior shell with region as input.
1324Normally display output (if any) in temp buffer `*Shell Command Output*';
a0184aeb
DL
1325Prefix arg means replace the region with it. Return the exit code of
1326COMMAND.
56c0450e 1327
07f458c1
RS
1328To specify a coding system for converting non-ASCII characters
1329in the input and output to the shell command, use \\[universal-coding-system-argument]
1330before this command. By default, the input (from the current buffer)
1331is encoded in the same coding system that will be used to save the file,
1332`buffer-file-coding-system'. If the output is going to replace the region,
1333then it is decoded from that same coding system.
1334
8923a211
RS
1335The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1336REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1337systems by binding `coding-system-for-read' and
1338`coding-system-for-write'.
2076c87c 1339
06933804 1340If the output is short enough to display in the echo area (which is
939ac10c
GM
1341determined by the variable `max-mini-window-height' if
1342`resize-mini-windows' is non-nil), it is shown there, but it is
1343nonetheless available in buffer `*Shell Command Output*' even though
1344that buffer is not automatically displayed. If there is no output, or
1345if output is inserted in the current buffer, then `*Shell Command
1346Output*' is deleted.
d0d74413 1347
56c0450e
RS
1348If the optional fourth argument OUTPUT-BUFFER is non-nil,
1349that says to put the output in some other buffer.
d0d74413
RS
1350If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1351If OUTPUT-BUFFER is not a buffer and not nil,
1352insert output in the current buffer.
cce1c318
RS
1353In either case, the output is inserted after point (leaving mark after it).
1354
8923a211
RS
1355If REPLACE, the optional fifth argument, is non-nil, that means insert
1356the output in place of text from START to END, putting point and mark
1357around it.
1358
b735c991 1359If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
cce1c318 1360or buffer name to which to direct the command's standard error output.
7fd47839 1361If it is nil, error output is mingled with regular output.
cc039f78
KH
1362In an interactive call, the variable `shell-command-default-error-buffer'
1363specifies the value of ERROR-BUFFER."
cae49185
RS
1364 (interactive (let ((string
1365 ;; Do this before calling region-beginning
1366 ;; and region-end, in case subprocess output
1367 ;; relocates them while we are in the minibuffer.
1368 (read-from-minibuffer "Shell command on region: "
1369 nil nil nil
1370 'shell-command-history)))
2b03c506
RS
1371 ;; call-interactively recognizes region-beginning and
1372 ;; region-end specially, leaving them in the history.
1373 (list (region-beginning) (region-end)
cae49185
RS
1374 string
1375 current-prefix-arg
7fd47839 1376 current-prefix-arg
cc039f78 1377 shell-command-default-error-buffer)))
cce1c318 1378 (let ((error-file
171a45d9 1379 (if error-buffer
b005abd5 1380 (make-temp-file
171a45d9
EZ
1381 (expand-file-name "scor"
1382 (or small-temporary-file-directory
1383 temporary-file-directory)))
a0184aeb
DL
1384 nil))
1385 exit-status)
7fd47839
RS
1386 (if (or replace
1387 (and output-buffer
748d6ca4 1388 (not (or (bufferp output-buffer) (stringp output-buffer)))))
7fd47839
RS
1389 ;; Replace specified region with output from command.
1390 (let ((swap (and replace (< start end))))
1391 ;; Don't muck with mark unless REPLACE says we should.
1392 (goto-char start)
1393 (and replace (push-mark))
a0184aeb
DL
1394 (setq exit-status
1395 (call-process-region start end shell-file-name t
1396 (if error-file
1397 (list t error-file)
1398 t)
1399 nil shell-command-switch command))
fd344fb7
RS
1400;;; It is rude to delete a buffer which the command is not using.
1401;;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1402;;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
1403;;; (kill-buffer shell-buffer)))
7fd47839
RS
1404 ;; Don't muck with mark unless REPLACE says we should.
1405 (and replace swap (exchange-point-and-mark)))
1406 ;; No prefix argument: put the output in a temp buffer,
1407 ;; replacing its entire contents.
1408 (let ((buffer (get-buffer-create
1409 (or output-buffer "*Shell Command Output*")))
a0184aeb 1410 (success nil))
7fd47839
RS
1411 (unwind-protect
1412 (if (eq buffer (current-buffer))
1413 ;; If the input is the same buffer as the output,
1414 ;; delete everything but the specified region,
1415 ;; then replace that region with the output.
1416 (progn (setq buffer-read-only nil)
1417 (delete-region (max start end) (point-max))
1418 (delete-region (point-min) (min start end))
1419 (setq exit-status
1420 (call-process-region (point-min) (point-max)
1e722f9f 1421 shell-file-name t
7fd47839
RS
1422 (if error-file
1423 (list t error-file)
1424 t)
a0184aeb
DL
1425 nil shell-command-switch
1426 command)))
1427 ;; Clear the output buffer, then run the command with
1428 ;; output there.
c2e303c8
GM
1429 (let ((directory default-directory))
1430 (save-excursion
1431 (set-buffer buffer)
1432 (setq buffer-read-only nil)
1433 (if (not output-buffer)
1434 (setq default-directory directory))
1435 (erase-buffer)))
7fd47839
RS
1436 (setq exit-status
1437 (call-process-region start end shell-file-name nil
1438 (if error-file
1439 (list buffer error-file)
1440 buffer)
a0184aeb 1441 nil shell-command-switch command)))
a92da273 1442 (setq success (and exit-status (equal 0 exit-status)))
7fd47839 1443 ;; Report the amount of output.
f69aad2b
MB
1444 (if (with-current-buffer buffer (> (point-max) (point-min)))
1445 ;; There's some output, display it
1446 (display-message-or-buffer buffer)
1447 ;; No output; error?
1448 (message (if (and error-file
1449 (< 0 (nth 7 (file-attributes error-file))))
1450 "(Shell command %sed with some error output)"
1451 "(Shell command %sed with no output)")
fd344fb7 1452 (if (equal 0 exit-status) "succeed" "fail"))))))
f69aad2b 1453
cc039f78
KH
1454 (when (and error-file (file-exists-p error-file))
1455 (if (< 0 (nth 7 (file-attributes error-file)))
1456 (with-current-buffer (get-buffer-create error-buffer)
1457 (let ((pos-from-end (- (point-max) (point))))
1458 (or (bobp)
1459 (insert "\f\n"))
1460 ;; Do no formatting while reading error file,
1461 ;; because that can run a shell command, and we
1462 ;; don't want that to cause an infinite recursion.
1463 (format-insert-file error-file nil)
1464 ;; Put point after the inserted errors.
1465 (goto-char (- (point-max) pos-from-end)))
1466 (display-buffer (current-buffer))))
1467 (delete-file error-file))
a0184aeb 1468 exit-status))
1e722f9f 1469
d589bd99
RS
1470(defun shell-command-to-string (command)
1471 "Execute shell command COMMAND and return its output as a string."
1472 (with-output-to-string
17cc9013
RS
1473 (with-current-buffer
1474 standard-output
1475 (call-process shell-file-name nil t nil shell-command-switch command))))
eaae8106 1476
1b43f83f 1477(defvar universal-argument-map
69d4c3c4
KH
1478 (let ((map (make-sparse-keymap)))
1479 (define-key map [t] 'universal-argument-other-key)
b9ff190d 1480 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
69d4c3c4
KH
1481 (define-key map [switch-frame] nil)
1482 (define-key map [?\C-u] 'universal-argument-more)
1483 (define-key map [?-] 'universal-argument-minus)
1484 (define-key map [?0] 'digit-argument)
1485 (define-key map [?1] 'digit-argument)
1486 (define-key map [?2] 'digit-argument)
1487 (define-key map [?3] 'digit-argument)
1488 (define-key map [?4] 'digit-argument)
1489 (define-key map [?5] 'digit-argument)
1490 (define-key map [?6] 'digit-argument)
1491 (define-key map [?7] 'digit-argument)
1492 (define-key map [?8] 'digit-argument)
1493 (define-key map [?9] 'digit-argument)
bd7acc8d
GM
1494 (define-key map [kp-0] 'digit-argument)
1495 (define-key map [kp-1] 'digit-argument)
1496 (define-key map [kp-2] 'digit-argument)
1497 (define-key map [kp-3] 'digit-argument)
1498 (define-key map [kp-4] 'digit-argument)
1499 (define-key map [kp-5] 'digit-argument)
1500 (define-key map [kp-6] 'digit-argument)
1501 (define-key map [kp-7] 'digit-argument)
1502 (define-key map [kp-8] 'digit-argument)
1503 (define-key map [kp-9] 'digit-argument)
1504 (define-key map [kp-subtract] 'universal-argument-minus)
69d4c3c4
KH
1505 map)
1506 "Keymap used while processing \\[universal-argument].")
1507
0de84e16
RS
1508(defvar universal-argument-num-events nil
1509 "Number of argument-specifying events read by `universal-argument'.
1510`universal-argument-other-key' uses this to discard those events
1511from (this-command-keys), and reread only the final command.")
1512
e8d1a377
KH
1513(defun universal-argument ()
1514 "Begin a numeric argument for the following command.
1515Digits or minus sign following \\[universal-argument] make up the numeric argument.
1516\\[universal-argument] following the digits or minus sign ends the argument.
1517\\[universal-argument] without digits or minus sign provides 4 as argument.
1518Repeating \\[universal-argument] without digits or minus sign
0565d307
RS
1519 multiplies the argument by 4 each time.
1520For some commands, just \\[universal-argument] by itself serves as a flag
a697fc62
RS
1521which is different in effect from any particular numeric argument.
1522These commands include \\[set-mark-command] and \\[start-kbd-macro]."
69d4c3c4
KH
1523 (interactive)
1524 (setq prefix-arg (list 4))
0de84e16 1525 (setq universal-argument-num-events (length (this-command-keys)))
69d4c3c4 1526 (setq overriding-terminal-local-map universal-argument-map))
e8d1a377 1527
69d4c3c4
KH
1528;; A subsequent C-u means to multiply the factor by 4 if we've typed
1529;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1530(defun universal-argument-more (arg)
e8d1a377 1531 (interactive "P")
69d4c3c4
KH
1532 (if (consp arg)
1533 (setq prefix-arg (list (* 4 (car arg))))
1cd24721
RS
1534 (if (eq arg '-)
1535 (setq prefix-arg (list -4))
1536 (setq prefix-arg arg)
1537 (setq overriding-terminal-local-map nil)))
0de84e16 1538 (setq universal-argument-num-events (length (this-command-keys))))
e8d1a377
KH
1539
1540(defun negative-argument (arg)
1541 "Begin a negative numeric argument for the next command.
1542\\[universal-argument] following digits or minus sign ends the argument."
1543 (interactive "P")
69d4c3c4
KH
1544 (cond ((integerp arg)
1545 (setq prefix-arg (- arg)))
1546 ((eq arg '-)
1547 (setq prefix-arg nil))
1548 (t
b9ff190d 1549 (setq prefix-arg '-)))
0de84e16 1550 (setq universal-argument-num-events (length (this-command-keys)))
b9ff190d 1551 (setq overriding-terminal-local-map universal-argument-map))
69d4c3c4
KH
1552
1553(defun digit-argument (arg)
1554 "Part of the numeric argument for the next command.
1555\\[universal-argument] following digits or minus sign ends the argument."
1556 (interactive "P")
bd7acc8d
GM
1557 (let* ((char (if (integerp last-command-char)
1558 last-command-char
1559 (get last-command-char 'ascii-character)))
1560 (digit (- (logand char ?\177) ?0)))
69d4c3c4
KH
1561 (cond ((integerp arg)
1562 (setq prefix-arg (+ (* arg 10)
1563 (if (< arg 0) (- digit) digit))))
1564 ((eq arg '-)
1565 ;; Treat -0 as just -, so that -01 will work.
1566 (setq prefix-arg (if (zerop digit) '- (- digit))))
1567 (t
b9ff190d 1568 (setq prefix-arg digit))))
0de84e16 1569 (setq universal-argument-num-events (length (this-command-keys)))
b9ff190d 1570 (setq overriding-terminal-local-map universal-argument-map))
69d4c3c4
KH
1571
1572;; For backward compatibility, minus with no modifiers is an ordinary
1573;; command if digits have already been entered.
1574(defun universal-argument-minus (arg)
1575 (interactive "P")
1576 (if (integerp arg)
1577 (universal-argument-other-key arg)
1578 (negative-argument arg)))
1579
1580;; Anything else terminates the argument and is left in the queue to be
1581;; executed as a command.
1582(defun universal-argument-other-key (arg)
1583 (interactive "P")
1584 (setq prefix-arg arg)
0de84e16
RS
1585 (let* ((key (this-command-keys))
1586 (keylist (listify-key-sequence key)))
1587 (setq unread-command-events
06697cdb
RS
1588 (append (nthcdr universal-argument-num-events keylist)
1589 unread-command-events)))
f0ef2555 1590 (reset-this-command-lengths)
69d4c3c4 1591 (setq overriding-terminal-local-map nil))
eaae8106 1592
93be67de 1593;;;; Window system cut and paste hooks.
70e14c01
JB
1594
1595(defvar interprogram-cut-function nil
1596 "Function to call to make a killed region available to other programs.
1597
1598Most window systems provide some sort of facility for cutting and
9f112a3d
RS
1599pasting text between the windows of different programs.
1600This variable holds a function that Emacs calls whenever text
1601is put in the kill ring, to make the new kill available to other
70e14c01
JB
1602programs.
1603
9f112a3d
RS
1604The function takes one or two arguments.
1605The first argument, TEXT, is a string containing
1606the text which should be made available.
1607The second, PUSH, if non-nil means this is a \"new\" kill;
1608nil means appending to an \"old\" kill.")
70e14c01
JB
1609
1610(defvar interprogram-paste-function nil
1611 "Function to call to get text cut from other programs.
1612
1613Most window systems provide some sort of facility for cutting and
9f112a3d
RS
1614pasting text between the windows of different programs.
1615This variable holds a function that Emacs calls to obtain
70e14c01
JB
1616text that other programs have provided for pasting.
1617
1618The function should be called with no arguments. If the function
1619returns nil, then no other program has provided such text, and the top
1620of the Emacs kill ring should be used. If the function returns a
daa37602
JB
1621string, that string should be put in the kill ring as the latest kill.
1622
1623Note that the function should return a string only if a program other
1624than Emacs has provided a string for pasting; if Emacs provided the
1625most recent string, the function should return nil. If it is
1626difficult to tell whether Emacs or some other program provided the
1627current string, it is probably good enough to return nil if the string
1628is equal (according to `string=') to the last text Emacs provided.")
70e14c01
JB
1629
1630
eaae8106 1631
70e14c01 1632;;;; The kill ring data structure.
2076c87c
JB
1633
1634(defvar kill-ring nil
70e14c01
JB
1635 "List of killed text sequences.
1636Since the kill ring is supposed to interact nicely with cut-and-paste
1637facilities offered by window systems, use of this variable should
1638interact nicely with `interprogram-cut-function' and
1639`interprogram-paste-function'. The functions `kill-new',
1640`kill-append', and `current-kill' are supposed to implement this
1641interaction; you may want to use them instead of manipulating the kill
1642ring directly.")
2076c87c 1643
bffa4d92 1644(defcustom kill-ring-max 60
69c1dd37
RS
1645 "*Maximum length of kill ring before oldest elements are thrown away."
1646 :type 'integer
1647 :group 'killing)
2076c87c
JB
1648
1649(defvar kill-ring-yank-pointer nil
1650 "The tail of the kill ring whose car is the last thing yanked.")
1651
f914dc91 1652(defun kill-new (string &optional replace)
70e14c01
JB
1653 "Make STRING the latest kill in the kill ring.
1654Set the kill-ring-yank pointer to point to it.
f914dc91
KH
1655If `interprogram-cut-function' is non-nil, apply it to STRING.
1656Optional second argument REPLACE non-nil means that STRING will replace
1657the front of the kill ring, rather than being added to the list."
f1d01ba2
KH
1658 (and (fboundp 'menu-bar-update-yank-menu)
1659 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
ab7e20d5 1660 (if (and replace kill-ring)
f914dc91
KH
1661 (setcar kill-ring string)
1662 (setq kill-ring (cons string kill-ring))
1663 (if (> (length kill-ring) kill-ring-max)
1664 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
70e14c01
JB
1665 (setq kill-ring-yank-pointer kill-ring)
1666 (if interprogram-cut-function
657a33ab 1667 (funcall interprogram-cut-function string (not replace))))
70e14c01 1668
2076c87c 1669(defun kill-append (string before-p)
70e14c01
JB
1670 "Append STRING to the end of the latest kill in the kill ring.
1671If BEFORE-P is non-nil, prepend STRING to the kill.
88c1aa79 1672If `interprogram-cut-function' is set, pass the resulting kill to
70e14c01 1673it."
f914dc91
KH
1674 (kill-new (if before-p
1675 (concat string (car kill-ring))
1676 (concat (car kill-ring) string)) t))
70e14c01
JB
1677
1678(defun current-kill (n &optional do-not-move)
1679 "Rotate the yanking point by N places, and then return that kill.
1680If N is zero, `interprogram-paste-function' is set, and calling it
1681returns a string, then that string is added to the front of the
1682kill ring and returned as the latest kill.
1e722f9f 1683If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
70e14c01
JB
1684yanking point; just return the Nth kill forward."
1685 (let ((interprogram-paste (and (= n 0)
1686 interprogram-paste-function
1687 (funcall interprogram-paste-function))))
1688 (if interprogram-paste
1689 (progn
1690 ;; Disable the interprogram cut function when we add the new
1691 ;; text to the kill ring, so Emacs doesn't try to own the
1692 ;; selection, with identical text.
1693 (let ((interprogram-cut-function nil))
1694 (kill-new interprogram-paste))
1695 interprogram-paste)
1696 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
1697 (let ((ARGth-kill-element
1698 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1699 (length kill-ring))
1700 kill-ring)))
70e14c01
JB
1701 (or do-not-move
1702 (setq kill-ring-yank-pointer ARGth-kill-element))
1703 (car ARGth-kill-element)))))
c88ab9ce 1704
c88ab9ce 1705
eaae8106 1706
70e14c01 1707;;;; Commands for manipulating the kill ring.
c88ab9ce 1708
69c1dd37
RS
1709(defcustom kill-read-only-ok nil
1710 "*Non-nil means don't signal an error for killing read-only text."
1711 :type 'boolean
1712 :group 'killing)
e6291fe1 1713
3a5da8a8
RS
1714(put 'text-read-only 'error-conditions
1715 '(text-read-only buffer-read-only error))
1716(put 'text-read-only 'error-message "Text is read-only")
1717
2076c87c
JB
1718(defun kill-region (beg end)
1719 "Kill between point and mark.
1720The text is deleted but saved in the kill ring.
1721The command \\[yank] can retrieve it from there.
81558867
EZ
1722\(If you want to kill and then yank immediately, use \\[kill-ring-save].)
1723
1724If you want to append the killed region to the last killed text,
1725use \\[append-next-kill] before \\[kill-region].
1726
2aa7a8bf
JB
1727If the buffer is read-only, Emacs will beep and refrain from deleting
1728the text, but put the text in the kill ring anyway. This means that
1729you can use the killing commands to copy text from a read-only buffer.
2076c87c
JB
1730
1731This is the primitive for programs to kill text (as opposed to deleting it).
1732Supply two arguments, character numbers indicating the stretch of text
1733 to be killed.
1734Any command that calls this function is a \"kill command\".
1735If the previous command was also a kill command,
1736the text killed this time appends to the text killed last time
1737to make one entry in the kill ring."
e761e42c 1738 (interactive "r")
ccd19b9f 1739 (condition-case nil
a1eb02bd
SM
1740 (let ((string (delete-and-extract-region beg end)))
1741 (when string ;STRING is nil if BEG = END
1742 ;; Add that string to the kill ring, one way or another.
1743 (if (eq last-command 'kill-region)
1744 (kill-append string (< end beg))
1745 (kill-new string)))
ccd19b9f
KH
1746 (setq this-command 'kill-region))
1747 ((buffer-read-only text-read-only)
1748 ;; The code above failed because the buffer, or some of the characters
1749 ;; in the region, are read-only.
1750 ;; We should beep, in case the user just isn't aware of this.
1751 ;; However, there's no harm in putting
1752 ;; the region's text in the kill ring, anyway.
1753 (copy-region-as-kill beg end)
cb3e1b4c
RS
1754 ;; Set this-command now, so it will be set even if we get an error.
1755 (setq this-command 'kill-region)
1756 ;; This should barf, if appropriate, and give us the correct error.
ccd19b9f
KH
1757 (if kill-read-only-ok
1758 (message "Read only text copied to kill ring")
ccd19b9f
KH
1759 ;; Signal an error if the buffer is read-only.
1760 (barf-if-buffer-read-only)
1761 ;; If the buffer isn't read-only, the text is.
1762 (signal 'text-read-only (list (current-buffer)))))))
2076c87c 1763
a382890a
KH
1764;; copy-region-as-kill no longer sets this-command, because it's confusing
1765;; to get two copies of the text when the user accidentally types M-w and
1766;; then corrects it with the intended C-w.
2076c87c
JB
1767(defun copy-region-as-kill (beg end)
1768 "Save the region as if killed, but don't kill it.
0e264847 1769In Transient Mark mode, deactivate the mark.
46947372
JB
1770If `interprogram-cut-function' is non-nil, also save the text for a window
1771system cut and paste."
2076c87c
JB
1772 (interactive "r")
1773 (if (eq last-command 'kill-region)
1774 (kill-append (buffer-substring beg end) (< end beg))
70e14c01 1775 (kill-new (buffer-substring beg end)))
1e722f9f 1776 (if transient-mark-mode
5c7319b6 1777 (setq deactivate-mark t))
2076c87c
JB
1778 nil)
1779
1780(defun kill-ring-save (beg end)
0964e562 1781 "Save the region as if killed, but don't kill it.
0e264847 1782In Transient Mark mode, deactivate the mark.
0964e562 1783If `interprogram-cut-function' is non-nil, also save the text for a window
0e264847
RS
1784system cut and paste.
1785
81558867
EZ
1786If you want to append the killed line to the last killed text,
1787use \\[append-next-kill] before \\[kill-ring-save].
1788
0e264847
RS
1789This command is similar to `copy-region-as-kill', except that it gives
1790visual feedback indicating the extent of the region being copied."
2076c87c
JB
1791 (interactive "r")
1792 (copy-region-as-kill beg end)
3a801d0c 1793 (if (interactive-p)
66050f10
RS
1794 (let ((other-end (if (= (point) beg) end beg))
1795 (opoint (point))
1796 ;; Inhibit quitting so we can make a quit here
1797 ;; look like a C-g typed as a command.
1798 (inhibit-quit t))
1799 (if (pos-visible-in-window-p other-end (selected-window))
db6f8ff1 1800 (unless transient-mark-mode
66050f10
RS
1801 ;; Swap point and mark.
1802 (set-marker (mark-marker) (point) (current-buffer))
1803 (goto-char other-end)
1804 (sit-for 1)
1805 ;; Swap back.
1806 (set-marker (mark-marker) other-end (current-buffer))
1807 (goto-char opoint)
1808 ;; If user quit, deactivate the mark
1809 ;; as C-g would as a command.
e4e593ae 1810 (and quit-flag mark-active
fcadf1c7 1811 (deactivate-mark)))
66050f10
RS
1812 (let* ((killed-text (current-kill 0))
1813 (message-len (min (length killed-text) 40)))
1814 (if (= (point) beg)
1815 ;; Don't say "killed"; that is misleading.
1816 (message "Saved text until \"%s\""
1817 (substring killed-text (- message-len)))
1818 (message "Saved text from \"%s\""
1819 (substring killed-text 0 message-len))))))))
2076c87c 1820
c75d4986
KH
1821(defun append-next-kill (&optional interactive)
1822 "Cause following command, if it kills, to append to previous kill.
1823The argument is used for internal purposes; do not supply one."
1824 (interactive "p")
1825 ;; We don't use (interactive-p), since that breaks kbd macros.
1826 (if interactive
2076c87c
JB
1827 (progn
1828 (setq this-command 'kill-region)
1829 (message "If the next command is a kill, it will append"))
1830 (setq last-command 'kill-region)))
eaae8106 1831
93be67de 1832;; Yanking.
2076c87c 1833
2076c87c 1834(defun yank-pop (arg)
ff1fbe3e
RS
1835 "Replace just-yanked stretch of killed text with a different stretch.
1836This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 1837At such a time, the region contains a stretch of reinserted
ff1fbe3e 1838previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
1839place a different stretch of killed text.
1840
1841With no argument, the previous kill is inserted.
ff1fbe3e
RS
1842With argument N, insert the Nth previous kill.
1843If N is negative, this is a more recent kill.
2076c87c
JB
1844
1845The sequence of kills wraps around, so that after the oldest one
1846comes the newest one."
1847 (interactive "*p")
1848 (if (not (eq last-command 'yank))
1849 (error "Previous command was not a yank"))
1850 (setq this-command 'yank)
3a5da8a8
RS
1851 (let ((inhibit-read-only t)
1852 (before (< (point) (mark t))))
9a1277dd 1853 (delete-region (point) (mark t))
fd0f4056 1854 (set-marker (mark-marker) (point) (current-buffer))
6cd829a8 1855 (let ((opoint (point)))
7ae13091 1856 (insert (current-kill arg))
6cd829a8
RS
1857 (let ((inhibit-read-only t))
1858 (remove-text-properties opoint (point) '(read-only nil))))
fd0f4056
RS
1859 (if before
1860 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1861 ;; It is cleaner to avoid activation, even though the command
1862 ;; loop would deactivate the mark because we inserted text.
1863 (goto-char (prog1 (mark t)
1864 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 1865 nil)
2076c87c
JB
1866
1867(defun yank (&optional arg)
1868 "Reinsert the last stretch of killed text.
1869More precisely, reinsert the stretch of killed text most recently
ff1fbe3e
RS
1870killed OR yanked. Put point at end, and set mark at beginning.
1871With just C-u as argument, same but put point at beginning (and mark at end).
1872With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c
JB
1873text.
1874See also the command \\[yank-pop]."
1875 (interactive "*P")
456c617c
RS
1876 ;; If we don't get all the way thru, make last-command indicate that
1877 ;; for the following command.
1878 (setq this-command t)
2076c87c 1879 (push-mark (point))
6cd829a8 1880 (let ((opoint (point)))
7ae13091
RS
1881 (insert (current-kill (cond
1882 ((listp arg) 0)
1883 ((eq arg '-) -1)
1884 (t (1- arg)))))
6cd829a8
RS
1885 (let ((inhibit-read-only t))
1886 (remove-text-properties opoint (point) '(read-only nil))))
2076c87c 1887 (if (consp arg)
fd0f4056
RS
1888 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1889 ;; It is cleaner to avoid activation, even though the command
1890 ;; loop would deactivate the mark because we inserted text.
1891 (goto-char (prog1 (mark t)
1892 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c
RS
1893 ;; If we do get all the way thru, make this-command indicate that.
1894 (setq this-command 'yank)
0964e562 1895 nil)
70e14c01
JB
1896
1897(defun rotate-yank-pointer (arg)
1898 "Rotate the yanking point in the kill ring.
1899With argument, rotate that many kills forward (or backward, if negative)."
1900 (interactive "p")
1901 (current-kill arg))
eaae8106 1902
93be67de
KH
1903;; Some kill commands.
1904
1905;; Internal subroutine of delete-char
1906(defun kill-forward-chars (arg)
1907 (if (listp arg) (setq arg (car arg)))
1908 (if (eq arg '-) (setq arg -1))
1909 (kill-region (point) (forward-point arg)))
1910
1911;; Internal subroutine of backward-delete-char
1912(defun kill-backward-chars (arg)
1913 (if (listp arg) (setq arg (car arg)))
1914 (if (eq arg '-) (setq arg -1))
1915 (kill-region (point) (forward-point (- arg))))
1916
1917(defcustom backward-delete-char-untabify-method 'untabify
1918 "*The method for untabifying when deleting backward.
1e722f9f
SS
1919Can be `untabify' -- turn a tab to many spaces, then delete one space;
1920 `hungry' -- delete all whitespace, both tabs and spaces;
1921 `all' -- delete all whitespace, including tabs, spaces and newlines;
93be67de 1922 nil -- just delete one character."
1e722f9f 1923 :type '(choice (const untabify) (const hungry) (const all) (const nil))
03167a34 1924 :version "20.3"
93be67de
KH
1925 :group 'killing)
1926
1927(defun backward-delete-char-untabify (arg &optional killp)
1928 "Delete characters backward, changing tabs into spaces.
1929The exact behavior depends on `backward-delete-char-untabify-method'.
1930Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
1931Interactively, ARG is the prefix arg (default 1)
1932and KILLP is t if a prefix arg was specified."
1933 (interactive "*p\nP")
1934 (when (eq backward-delete-char-untabify-method 'untabify)
1935 (let ((count arg))
1936 (save-excursion
1937 (while (and (> count 0) (not (bobp)))
1938 (if (= (preceding-char) ?\t)
1939 (let ((col (current-column)))
1940 (forward-char -1)
1941 (setq col (- col (current-column)))
1942 (insert-char ?\ col)
1943 (delete-char 1)))
1944 (forward-char -1)
1945 (setq count (1- count))))))
1946 (delete-backward-char
1e722f9f
SS
1947 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1948 ((eq backward-delete-char-untabify-method 'all)
1949 " \t\n\r"))))
1950 (if skip
1951 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
93be67de
KH
1952 (point)))))
1953 (+ arg (if (zerop wh) 0 (1- wh))))
1e722f9f 1954 arg))
93be67de
KH
1955 killp))
1956
1957(defun zap-to-char (arg char)
1958 "Kill up to and including ARG'th occurrence of CHAR.
1959Case is ignored if `case-fold-search' is non-nil in the current buffer.
1960Goes backward if ARG is negative; error if CHAR not found."
e761e42c 1961 (interactive "p\ncZap to char: ")
93be67de
KH
1962 (kill-region (point) (progn
1963 (search-forward (char-to-string char) nil nil arg)
1964; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
1965 (point))))
eaae8106 1966
93be67de
KH
1967;; kill-line and its subroutines.
1968
1969(defcustom kill-whole-line nil
1970 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
1971 :type 'boolean
1972 :group 'killing)
1973
1974(defun kill-line (&optional arg)
1975 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1976With prefix argument, kill that many lines from point.
1977Negative arguments kill lines backward.
8be7408c 1978With zero argument, kills the text before point on the current line.
93be67de
KH
1979
1980When calling from a program, nil means \"no arg\",
1981a number counts as a prefix arg.
1982
1983To kill a whole line, when point is not at the beginning, type \
1984\\[beginning-of-line] \\[kill-line] \\[kill-line].
1985
1986If `kill-whole-line' is non-nil, then this command kills the whole line
1987including its terminating newline, when used at the beginning of a line
1988with no argument. As a consequence, you can always kill a whole line
d3f22784
EZ
1989by typing \\[beginning-of-line] \\[kill-line].
1990
81558867
EZ
1991If you want to append the killed line to the last killed text,
1992use \\[append-next-kill] before \\[kill-line].
1993
d3f22784
EZ
1994If the buffer is read-only, Emacs will beep and refrain from deleting
1995the line, but put the line in the kill ring anyway. This means that
1996you can use this command to copy text from a read-only buffer."
e761e42c 1997 (interactive "P")
93be67de
KH
1998 (kill-region (point)
1999 ;; It is better to move point to the other end of the kill
2000 ;; before killing. That way, in a read-only buffer, point
2001 ;; moves across the text that is copied to the kill ring.
2002 ;; The choice has no effect on undo now that undo records
2003 ;; the value of point from before the command was run.
2004 (progn
2005 (if arg
2006 (forward-visible-line (prefix-numeric-value arg))
2007 (if (eobp)
2008 (signal 'end-of-buffer nil))
2009 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
2010 (forward-visible-line 1)
2011 (end-of-visible-line)))
2012 (point))))
2013
2014(defun forward-visible-line (arg)
2015 "Move forward by ARG lines, ignoring currently invisible newlines only.
2016If ARG is negative, move backward -ARG lines.
2017If ARG is zero, move to the beginning of the current line."
2018 (condition-case nil
2019 (if (> arg 0)
2020 (while (> arg 0)
2021 (or (zerop (forward-line 1))
2022 (signal 'end-of-buffer nil))
2023 ;; If the following character is currently invisible,
2024 ;; skip all characters with that same `invisible' property value,
2025 ;; then find the next newline.
2026 (while (and (not (eobp))
2027 (let ((prop
2028 (get-char-property (point) 'invisible)))
2029 (if (eq buffer-invisibility-spec t)
2030 prop
2031 (or (memq prop buffer-invisibility-spec)
2032 (assq prop buffer-invisibility-spec)))))
2033 (goto-char
2034 (if (get-text-property (point) 'invisible)
2035 (or (next-single-property-change (point) 'invisible)
2036 (point-max))
2037 (next-overlay-change (point))))
2038 (or (zerop (forward-line 1))
2039 (signal 'end-of-buffer nil)))
2040 (setq arg (1- arg)))
2041 (let ((first t))
2042 (while (or first (< arg 0))
2043 (if (zerop arg)
2044 (beginning-of-line)
2045 (or (zerop (forward-line -1))
2046 (signal 'beginning-of-buffer nil)))
2047 (while (and (not (bobp))
2048 (let ((prop
2049 (get-char-property (1- (point)) 'invisible)))
2050 (if (eq buffer-invisibility-spec t)
2051 prop
2052 (or (memq prop buffer-invisibility-spec)
2053 (assq prop buffer-invisibility-spec)))))
2054 (goto-char
2055 (if (get-text-property (1- (point)) 'invisible)
2056 (or (previous-single-property-change (point) 'invisible)
2057 (point-min))
2058 (previous-overlay-change (point))))
2059 (or (zerop (forward-line -1))
2060 (signal 'beginning-of-buffer nil)))
2061 (setq first nil)
2062 (setq arg (1+ arg)))))
2063 ((beginning-of-buffer end-of-buffer)
2064 nil)))
70e14c01 2065
93be67de
KH
2066(defun end-of-visible-line ()
2067 "Move to end of current visible line."
2068 (end-of-line)
2069 ;; If the following character is currently invisible,
2070 ;; skip all characters with that same `invisible' property value,
2071 ;; then find the next newline.
2072 (while (and (not (eobp))
2073 (let ((prop
2074 (get-char-property (point) 'invisible)))
2075 (if (eq buffer-invisibility-spec t)
2076 prop
2077 (or (memq prop buffer-invisibility-spec)
2078 (assq prop buffer-invisibility-spec)))))
2079 (if (get-text-property (point) 'invisible)
2080 (goto-char (next-single-property-change (point) 'invisible))
2081 (goto-char (next-overlay-change (point))))
2082 (end-of-line)))
eaae8106 2083
2076c87c
JB
2084(defun insert-buffer (buffer)
2085 "Insert after point the contents of BUFFER.
2086Puts mark after the inserted text.
6cb6e7a2
GM
2087BUFFER may be a buffer or a buffer name.
2088
2089This function is meant for the user to run interactively.
2090Don't call it from programs!"
c3d4f949 2091 (interactive
a3e7c391
FP
2092 (list
2093 (progn
2094 (barf-if-buffer-read-only)
2095 (read-buffer "Insert buffer: "
2096 (if (eq (selected-window) (next-window (selected-window)))
2097 (other-buffer (current-buffer))
2098 (window-buffer (next-window (selected-window))))
2099 t))))
2076c87c
JB
2100 (or (bufferp buffer)
2101 (setq buffer (get-buffer buffer)))
2102 (let (start end newmark)
2103 (save-excursion
2104 (save-excursion
2105 (set-buffer buffer)
2106 (setq start (point-min) end (point-max)))
2107 (insert-buffer-substring buffer start end)
2108 (setq newmark (point)))
1537a263
JB
2109 (push-mark newmark))
2110 nil)
2076c87c
JB
2111
2112(defun append-to-buffer (buffer start end)
2113 "Append to specified buffer the text of the region.
2114It is inserted into that buffer before its point.
2115
2116When calling from a program, give three arguments:
2117BUFFER (or buffer name), START and END.
2118START and END specify the portion of the current buffer to be copied."
70e14c01 2119 (interactive
5d771766 2120 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 2121 (region-beginning) (region-end)))
2076c87c
JB
2122 (let ((oldbuf (current-buffer)))
2123 (save-excursion
c069a480
GM
2124 (let* ((append-to (get-buffer-create buffer))
2125 (windows (get-buffer-window-list append-to t t))
2126 point)
2127 (set-buffer append-to)
2128 (setq point (point))
2129 (barf-if-buffer-read-only)
2130 (insert-buffer-substring oldbuf start end)
2131 (dolist (window windows)
2132 (when (= (window-point window) point)
2133 (set-window-point window (point))))))))
2076c87c
JB
2134
2135(defun prepend-to-buffer (buffer start end)
2136 "Prepend to specified buffer the text of the region.
2137It is inserted into that buffer after its point.
2138
2139When calling from a program, give three arguments:
2140BUFFER (or buffer name), START and END.
2141START and END specify the portion of the current buffer to be copied."
2142 (interactive "BPrepend to buffer: \nr")
2143 (let ((oldbuf (current-buffer)))
2144 (save-excursion
2145 (set-buffer (get-buffer-create buffer))
74399eac 2146 (barf-if-buffer-read-only)
2076c87c
JB
2147 (save-excursion
2148 (insert-buffer-substring oldbuf start end)))))
2149
2150(defun copy-to-buffer (buffer start end)
2151 "Copy to specified buffer the text of the region.
2152It is inserted into that buffer, replacing existing text there.
2153
2154When calling from a program, give three arguments:
2155BUFFER (or buffer name), START and END.
2156START and END specify the portion of the current buffer to be copied."
2157 (interactive "BCopy to buffer: \nr")
2158 (let ((oldbuf (current-buffer)))
2159 (save-excursion
2160 (set-buffer (get-buffer-create buffer))
74399eac 2161 (barf-if-buffer-read-only)
2076c87c
JB
2162 (erase-buffer)
2163 (save-excursion
2164 (insert-buffer-substring oldbuf start end)))))
eaae8106 2165
62d1c1fc
RM
2166(put 'mark-inactive 'error-conditions '(mark-inactive error))
2167(put 'mark-inactive 'error-message "The mark is not active now")
2168
af39530e 2169(defun mark (&optional force)
c7c8b31e 2170 "Return this buffer's mark value as integer; error if mark inactive.
af39530e 2171If optional argument FORCE is non-nil, access the mark value
c7c8b31e
RS
2172even if the mark is not currently active, and return nil
2173if there is no mark at all.
af39530e 2174
2076c87c
JB
2175If you are using this in an editing command, you are most likely making
2176a mistake; see the documentation of `set-mark'."
0e3a7b14 2177 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
af39530e 2178 (marker-position (mark-marker))
62d1c1fc 2179 (signal 'mark-inactive nil)))
2076c87c 2180
19d35374
RM
2181;; Many places set mark-active directly, and several of them failed to also
2182;; run deactivate-mark-hook. This shorthand should simplify.
2183(defsubst deactivate-mark ()
2184 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 2185\(That makes a difference only in Transient Mark mode.)
19d35374 2186Also runs the hook `deactivate-mark-hook'."
a4b9d3da
RS
2187 (if transient-mark-mode
2188 (progn
2189 (setq mark-active nil)
2190 (run-hooks 'deactivate-mark-hook))))
19d35374 2191
2076c87c
JB
2192(defun set-mark (pos)
2193 "Set this buffer's mark to POS. Don't use this function!
2194That is to say, don't use this function unless you want
2195the user to see that the mark has moved, and you want the previous
2196mark position to be lost.
2197
2198Normally, when a new mark is set, the old one should go on the stack.
2199This is why most applications should use push-mark, not set-mark.
2200
ff1fbe3e 2201Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
2202purposes. The mark saves a location for the user's convenience.
2203Most editing commands should not alter the mark.
2204To remember a location for internal use in the Lisp program,
2205store it in a Lisp variable. Example:
2206
2207 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2208
fcadf1c7
RS
2209 (if pos
2210 (progn
2211 (setq mark-active t)
2212 (run-hooks 'activate-mark-hook)
2213 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
2214 ;; Normally we never clear mark-active except in Transient Mark mode.
2215 ;; But when we actually clear out the mark value too,
2216 ;; we must clear mark-active in any mode.
2217 (setq mark-active nil)
2218 (run-hooks 'deactivate-mark-hook)
2219 (set-marker (mark-marker) nil)))
2076c87c
JB
2220
2221(defvar mark-ring nil
e55e2267 2222 "The list of former marks of the current buffer, most recent first.")
2076c87c 2223(make-variable-buffer-local 'mark-ring)
e55e2267 2224(put 'mark-ring 'permanent-local t)
2076c87c 2225
69c1dd37
RS
2226(defcustom mark-ring-max 16
2227 "*Maximum size of mark ring. Start discarding off end if gets this big."
2228 :type 'integer
2229 :group 'editing-basics)
2076c87c 2230
dc029f0b
RM
2231(defvar global-mark-ring nil
2232 "The list of saved global marks, most recent first.")
2233
69c1dd37 2234(defcustom global-mark-ring-max 16
dc029f0b 2235 "*Maximum size of global mark ring. \
69c1dd37
RS
2236Start discarding off end if gets this big."
2237 :type 'integer
2238 :group 'editing-basics)
dc029f0b 2239
2076c87c
JB
2240(defun set-mark-command (arg)
2241 "Set mark at where point is, or jump to mark.
dc029f0b
RM
2242With no prefix argument, set mark, push old mark position on local mark
2243ring, and push mark on global mark ring.
2244With argument, jump to mark, and pop a new position for mark off the ring
2245\(does not affect global mark ring\).
2076c87c 2246
ff1fbe3e 2247Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
2248purposes. See the documentation of `set-mark' for more information."
2249 (interactive "P")
2250 (if (null arg)
9a1277dd 2251 (progn
fd0f4056 2252 (push-mark nil nil t))
af39530e 2253 (if (null (mark t))
2076c87c 2254 (error "No mark set in this buffer")
9a1277dd 2255 (goto-char (mark t))
2076c87c
JB
2256 (pop-mark))))
2257
fd0f4056 2258(defun push-mark (&optional location nomsg activate)
2076c87c 2259 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
2260If the last global mark pushed was not in the current buffer,
2261also push LOCATION on the global mark ring.
fd0f4056 2262Display `Mark set' unless the optional second arg NOMSG is non-nil.
8cdc660f 2263In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2076c87c 2264
ff1fbe3e 2265Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
2266purposes. See the documentation of `set-mark' for more information.
2267
2268In Transient Mark mode, this does not activate the mark."
af39530e 2269 (if (null (mark t))
2076c87c
JB
2270 nil
2271 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2272 (if (> (length mark-ring) mark-ring-max)
2273 (progn
2274 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2275 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
9a1277dd 2276 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 2277 ;; Now push the mark on the global mark ring.
f1382a3d 2278 (if (and global-mark-ring
e08d3f7c 2279 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
2280 ;; The last global mark pushed was in this same buffer.
2281 ;; Don't push another one.
2282 nil
2283 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
dc029f0b
RM
2284 (if (> (length global-mark-ring) global-mark-ring-max)
2285 (progn
2286 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2287 nil)
f1382a3d 2288 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
efcf38c7 2289 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2076c87c 2290 (message "Mark set"))
8cdc660f
RS
2291 (if (or activate (not transient-mark-mode))
2292 (set-mark (mark t)))
2076c87c
JB
2293 nil)
2294
2295(defun pop-mark ()
2296 "Pop off mark ring into the buffer's actual mark.
2297Does not set point. Does nothing if mark ring is empty."
2298 (if mark-ring
2299 (progn
2300 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
9a1277dd 2301 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
19d35374 2302 (deactivate-mark)
2076c87c 2303 (move-marker (car mark-ring) nil)
9a1277dd 2304 (if (null (mark t)) (ding))
2076c87c
JB
2305 (setq mark-ring (cdr mark-ring)))))
2306
e462e42f 2307(defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2076c87c 2308(defun exchange-point-and-mark ()
af39530e
RS
2309 "Put the mark where point is now, and point where the mark is now.
2310This command works even when the mark is not active,
2311and it reactivates the mark."
2076c87c 2312 (interactive nil)
af39530e 2313 (let ((omark (mark t)))
2076c87c
JB
2314 (if (null omark)
2315 (error "No mark set in this buffer"))
2316 (set-mark (point))
2317 (goto-char omark)
2318 nil))
e23c2c21 2319
22c3935a 2320(defun transient-mark-mode (arg)
e23c2c21 2321 "Toggle Transient Mark mode.
b411b5fa 2322With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 2323
5dd1220d
RS
2324In Transient Mark mode, when the mark is active, the region is highlighted.
2325Changing the buffer \"deactivates\" the mark.
2326So do certain other operations that set the mark
2327but whose main purpose is something else--for example,
cfa70244
EZ
2328incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
2329
8e843bc4
EZ
2330You can also deactivate the mark by typing \\[keyboard-quit] or
2331\\[keyboard-escape-quit].
1465c66b 2332
cfa70244
EZ
2333Many commands change their behavior when Transient Mark mode is in effect
2334and the mark is active, by acting on the region instead of their usual
4c5f7215 2335default part of the buffer's text. Examples of such commands include
cfa70244
EZ
2336\\[comment-dwim], \\[flush-lines], \\[ispell], \\[keep-lines],
2337\\[query-replace], \\[query-replace-regexp], and \\[undo]. Invoke
c4e39bdd
EZ
2338\\[apropos-documentation] and type \"transient\" or \"mark.*active\" at
2339the prompt, to see the documentation of commands which are sensitive to
2340the Transient Mark mode."
22c3935a 2341 (interactive "P")
e23c2c21
RS
2342 (setq transient-mark-mode
2343 (if (null arg)
2344 (not transient-mark-mode)
2c5d387c 2345 (> (prefix-numeric-value arg) 0)))
22c3935a
RS
2346 (if (interactive-p)
2347 (if transient-mark-mode
2348 (message "Transient Mark mode enabled")
2349 (message "Transient Mark mode disabled"))))
dc029f0b
RM
2350
2351(defun pop-global-mark ()
2352 "Pop off global mark ring and jump to the top location."
2353 (interactive)
52b6d445
RS
2354 ;; Pop entries which refer to non-existent buffers.
2355 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2356 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
2357 (or global-mark-ring
2358 (error "No global mark set"))
2359 (let* ((marker (car global-mark-ring))
2360 (buffer (marker-buffer marker))
2361 (position (marker-position marker)))
34c31301
RS
2362 (setq global-mark-ring (nconc (cdr global-mark-ring)
2363 (list (car global-mark-ring))))
dc029f0b
RM
2364 (set-buffer buffer)
2365 (or (and (>= position (point-min))
2366 (<= position (point-max)))
2367 (widen))
2368 (goto-char position)
2369 (switch-to-buffer buffer)))
eaae8106 2370
95791033 2371(defcustom next-line-add-newlines nil
69c1dd37
RS
2372 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2373 :type 'boolean
e1d6e383 2374 :version "21.1"
69c1dd37 2375 :group 'editing-basics)
38ebcf29 2376
2076c87c
JB
2377(defun next-line (arg)
2378 "Move cursor vertically down ARG lines.
2379If there is no character in the target line exactly under the current column,
2380the cursor is positioned after the character in that line which spans this
2381column, or at the end of the line if it is not long enough.
38ebcf29 2382If there is no line in the buffer after this one, behavior depends on the
1a2c3941
RS
2383value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2384to create a line, and moves the cursor to that line. Otherwise it moves the
e47d38f6 2385cursor to the end of the buffer.
2076c87c
JB
2386
2387The command \\[set-goal-column] can be used to create
85969cb1
RS
2388a semipermanent goal column for this command.
2389Then instead of trying to move exactly vertically (or as close as possible),
2390this command moves to the specified goal column (or as close as possible).
2391The goal column is stored in the variable `goal-column', which is nil
2392when there is no goal column.
2076c87c
JB
2393
2394If you are thinking of using this in a Lisp program, consider
2395using `forward-line' instead. It is usually easier to use
2396and more reliable (no dependence on goal column, etc.)."
2397 (interactive "p")
028922cf 2398 (if (and next-line-add-newlines (= arg 1))
207d7545
GM
2399 (if (save-excursion (end-of-line) (eobp))
2400 ;; When adding a newline, don't expand an abbrev.
2401 (let ((abbrev-mode nil))
24886813
GM
2402 (end-of-line)
2403 (insert "\n"))
207d7545 2404 (line-move arg))
1a2c3941
RS
2405 (if (interactive-p)
2406 (condition-case nil
2407 (line-move arg)
2408 ((beginning-of-buffer end-of-buffer) (ding)))
2409 (line-move arg)))
2076c87c
JB
2410 nil)
2411
2412(defun previous-line (arg)
2413 "Move cursor vertically up ARG lines.
2414If there is no character in the target line exactly over the current column,
2415the cursor is positioned after the character in that line which spans this
2416column, or at the end of the line if it is not long enough.
2417
2418The command \\[set-goal-column] can be used to create
85969cb1
RS
2419a semipermanent goal column for this command.
2420Then instead of trying to move exactly vertically (or as close as possible),
2421this command moves to the specified goal column (or as close as possible).
2422The goal column is stored in the variable `goal-column', which is nil
2423when there is no goal column.
2076c87c
JB
2424
2425If you are thinking of using this in a Lisp program, consider using
c2e8a012 2426`forward-line' with a negative argument instead. It is usually easier
2076c87c
JB
2427to use and more reliable (no dependence on goal column, etc.)."
2428 (interactive "p")
1a2c3941
RS
2429 (if (interactive-p)
2430 (condition-case nil
2431 (line-move (- arg))
2432 ((beginning-of-buffer end-of-buffer) (ding)))
2433 (line-move (- arg)))
2076c87c 2434 nil)
eaae8106 2435
69c1dd37 2436(defcustom track-eol nil
2076c87c
JB
2437 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2438This means moving to the end of each line moved onto.
69c1dd37
RS
2439The beginning of a blank line does not count as the end of a line."
2440 :type 'boolean
2441 :group 'editing-basics)
2442
2443(defcustom goal-column nil
2444 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2445 :type '(choice integer
2446 (const :tag "None" nil))
2447 :group 'editing-basics)
912c6728 2448(make-variable-buffer-local 'goal-column)
2076c87c
JB
2449
2450(defvar temporary-goal-column 0
2451 "Current goal column for vertical motion.
2452It is the column where point was
2453at the start of current run of vertical motion commands.
c637ae6f 2454When the `track-eol' feature is doing its job, the value is 9999.")
2076c87c 2455
69c1dd37 2456(defcustom line-move-ignore-invisible nil
098fc1fb 2457 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
69c1dd37
RS
2458Outline mode sets this."
2459 :type 'boolean
2460 :group 'editing-basics)
098fc1fb 2461
8c745744
RS
2462;; This is the guts of next-line and previous-line.
2463;; Arg says how many lines to move.
2076c87c 2464(defun line-move (arg)
2596511d
RS
2465 ;; Don't run any point-motion hooks, and disregard intangibility,
2466 ;; for intermediate positions.
2467 (let ((inhibit-point-motion-hooks t)
2468 (opoint (point))
6c8499b9 2469 new line-end line-beg)
2596511d
RS
2470 (unwind-protect
2471 (progn
2472 (if (not (or (eq last-command 'next-line)
2473 (eq last-command 'previous-line)))
2474 (setq temporary-goal-column
2475 (if (and track-eol (eolp)
2476 ;; Don't count beg of empty line as end of line
2477 ;; unless we just did explicit end-of-line.
2478 (or (not (bolp)) (eq last-command 'end-of-line)))
2479 9999
2480 (current-column))))
2481 (if (and (not (integerp selective-display))
2482 (not line-move-ignore-invisible))
2483 ;; Use just newline characters.
2484 (or (if (> arg 0)
2485 (progn (if (> arg 1) (forward-line (1- arg)))
2486 ;; This way of moving forward ARG lines
2487 ;; verifies that we have a newline after the last one.
2488 ;; It doesn't get confused by intangible text.
2489 (end-of-line)
2490 (zerop (forward-line 1)))
2491 (and (zerop (forward-line arg))
2492 (bolp)))
2493 (signal (if (< arg 0)
2494 'beginning-of-buffer
2495 'end-of-buffer)
2496 nil))
2497 ;; Move by arg lines, but ignore invisible ones.
2498 (while (> arg 0)
2499 (end-of-line)
2500 (and (zerop (vertical-motion 1))
2501 (signal 'end-of-buffer nil))
2502 ;; If the following character is currently invisible,
2503 ;; skip all characters with that same `invisible' property value.
2504 (while (and (not (eobp))
2505 (let ((prop
2506 (get-char-property (point) 'invisible)))
2507 (if (eq buffer-invisibility-spec t)
2508 prop
2509 (or (memq prop buffer-invisibility-spec)
2510 (assq prop buffer-invisibility-spec)))))
2511 (if (get-text-property (point) 'invisible)
2512 (goto-char (next-single-property-change (point) 'invisible))
2513 (goto-char (next-overlay-change (point)))))
2514 (setq arg (1- arg)))
2515 (while (< arg 0)
2516 (beginning-of-line)
2517 (and (zerop (vertical-motion -1))
2518 (signal 'beginning-of-buffer nil))
2519 (while (and (not (bobp))
2520 (let ((prop
2521 (get-char-property (1- (point)) 'invisible)))
2522 (if (eq buffer-invisibility-spec t)
2523 prop
2524 (or (memq prop buffer-invisibility-spec)
2525 (assq prop buffer-invisibility-spec)))))
2526 (if (get-text-property (1- (point)) 'invisible)
2527 (goto-char (previous-single-property-change (point) 'invisible))
2528 (goto-char (previous-overlay-change (point)))))
2529 (setq arg (1+ arg))))
0565d307
RS
2530 (let ((buffer-invisibility-spec nil))
2531 (move-to-column (or goal-column temporary-goal-column))))
50be475d
RS
2532 (setq new (point))
2533 ;; If we are moving into some intangible text,
2534 ;; look for following text on the same line which isn't intangible
2535 ;; and move there.
6c8499b9
RS
2536 (setq line-end (save-excursion (end-of-line) (point)))
2537 (setq line-beg (save-excursion (beginning-of-line) (point)))
50be475d
RS
2538 (let ((after (and (< new (point-max))
2539 (get-char-property new 'intangible)))
2540 (before (and (> new (point-min))
6c8499b9
RS
2541 (get-char-property (1- new) 'intangible))))
2542 (when (and before (eq before after)
2543 (not (bolp)))
50be475d
RS
2544 (goto-char (point-min))
2545 (let ((inhibit-point-motion-hooks nil))
2546 (goto-char new))
2547 (if (<= new line-end)
2548 (setq new (point)))))
6c8499b9
RS
2549 ;; NEW is where we want to move to.
2550 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2551 ;; Move there in just one step, from our starting position,
2552 ;; with intangibility and point-motion hooks enabled this time.
2596511d
RS
2553 (goto-char opoint)
2554 (setq inhibit-point-motion-hooks nil)
1369261b 2555 (goto-char
50af0a5b 2556 (constrain-to-field new opoint nil t 'inhibit-line-move-field-capture))
6c8499b9
RS
2557 ;; If intangibility processing moved us to a different line,
2558 ;; readjust the horizontal position within the line we ended up at.
2559 (when (or (< (point) line-beg) (> (point) line-end))
2560 (setq new (point))
2561 (setq inhibit-point-motion-hooks t)
2562 (setq line-end (save-excursion (end-of-line) (point)))
2563 (beginning-of-line)
2564 (setq line-beg (point))
2565 (let ((buffer-invisibility-spec nil))
2566 (move-to-column (or goal-column temporary-goal-column)))
2567 (if (<= (point) line-end)
2568 (setq new (point)))
2569 (goto-char (point-min))
2570 (setq inhibit-point-motion-hooks nil)
1369261b 2571 (goto-char
50af0a5b
MB
2572 (constrain-to-field new opoint nil t
2573 'inhibit-line-move-field-capture)))))
2596511d 2574 nil)
2076c87c 2575
d5ab2033
JB
2576;;; Many people have said they rarely use this feature, and often type
2577;;; it by accident. Maybe it shouldn't even be on a key.
2578(put 'set-goal-column 'disabled t)
2076c87c
JB
2579
2580(defun set-goal-column (arg)
2581 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2582Those commands will move to this position in the line moved to
2583rather than trying to keep the same horizontal position.
2584With a non-nil argument, clears out the goal column
912c6728
RS
2585so that \\[next-line] and \\[previous-line] resume vertical motion.
2586The goal column is stored in the variable `goal-column'."
2076c87c
JB
2587 (interactive "P")
2588 (if arg
2589 (progn
2590 (setq goal-column nil)
2591 (message "No goal column"))
2592 (setq goal-column (current-column))
2593 (message (substitute-command-keys
2594 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2595 goal-column))
2596 nil)
eaae8106 2597
7492f5a6
RS
2598
2599(defun scroll-other-window-down (lines)
e47d38f6
RS
2600 "Scroll the \"other window\" down.
2601For more details, see the documentation for `scroll-other-window'."
7492f5a6
RS
2602 (interactive "P")
2603 (scroll-other-window
2604 ;; Just invert the argument's meaning.
2605 ;; We can do that without knowing which window it will be.
2606 (if (eq lines '-) nil
2607 (if (null lines) '-
2608 (- (prefix-numeric-value lines))))))
e47d38f6 2609(define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
3aef9604
RS
2610
2611(defun beginning-of-buffer-other-window (arg)
2612 "Move point to the beginning of the buffer in the other window.
2613Leave mark at previous position.
2614With arg N, put point N/10 of the way from the true beginning."
2615 (interactive "P")
2616 (let ((orig-window (selected-window))
2617 (window (other-window-for-scrolling)))
2618 ;; We use unwind-protect rather than save-window-excursion
2619 ;; because the latter would preserve the things we want to change.
2620 (unwind-protect
2621 (progn
2622 (select-window window)
2623 ;; Set point and mark in that window's buffer.
2624 (beginning-of-buffer arg)
2625 ;; Set point accordingly.
2626 (recenter '(t)))
2627 (select-window orig-window))))
2628
2629(defun end-of-buffer-other-window (arg)
2630 "Move point to the end of the buffer in the other window.
2631Leave mark at previous position.
2632With arg N, put point N/10 of the way from the true end."
2633 (interactive "P")
2634 ;; See beginning-of-buffer-other-window for comments.
2635 (let ((orig-window (selected-window))
2636 (window (other-window-for-scrolling)))
2637 (unwind-protect
2638 (progn
2639 (select-window window)
4500ff36 2640 (end-of-buffer arg)
3aef9604
RS
2641 (recenter '(t)))
2642 (select-window orig-window))))
eaae8106 2643
2076c87c
JB
2644(defun transpose-chars (arg)
2645 "Interchange characters around point, moving forward one character.
2646With prefix arg ARG, effect is to take character before point
2647and drag it forward past ARG other characters (backward if ARG negative).
2648If no argument and at end of line, the previous two chars are exchanged."
2649 (interactive "*P")
2650 (and (null arg) (eolp) (forward-char -1))
2651 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2652
2653(defun transpose-words (arg)
2654 "Interchange words around point, leaving point at end of them.
2655With prefix arg ARG, effect is to take word before or around point
2656and drag it forward past ARG other words (backward if ARG negative).
2657If ARG is zero, the words around or after point and around or after mark
2658are interchanged."
2659 (interactive "*p")
2660 (transpose-subr 'forward-word arg))
2661
2662(defun transpose-sexps (arg)
2663 "Like \\[transpose-words] but applies to sexps.
2664Does not work on a sexp that point is in the middle of
2665if it is a list or string."
2666 (interactive "*p")
2667 (transpose-subr 'forward-sexp arg))
2668
2669(defun transpose-lines (arg)
2670 "Exchange current line and previous line, leaving point after both.
2671With argument ARG, takes previous line and moves it past ARG lines.
2672With argument 0, interchanges line point is in with line mark is in."
2673 (interactive "*p")
2674 (transpose-subr (function
2675 (lambda (arg)
d3f4ef3f 2676 (if (> arg 0)
2076c87c 2677 (progn
d3f4ef3f
AS
2678 ;; Move forward over ARG lines,
2679 ;; but create newlines if necessary.
2680 (setq arg (forward-line arg))
2681 (if (/= (preceding-char) ?\n)
2682 (setq arg (1+ arg)))
2683 (if (> arg 0)
2684 (newline arg)))
2076c87c
JB
2685 (forward-line arg))))
2686 arg))
2687
8b56e02d
RS
2688(defvar transpose-subr-start1)
2689(defvar transpose-subr-start2)
2690(defvar transpose-subr-end1)
2691(defvar transpose-subr-end2)
2692
2076c87c 2693(defun transpose-subr (mover arg)
8b56e02d
RS
2694 (let (transpose-subr-start1
2695 transpose-subr-end1
2696 transpose-subr-start2
2697 transpose-subr-end2)
2076c87c
JB
2698 (if (= arg 0)
2699 (progn
2700 (save-excursion
2701 (funcall mover 1)
8b56e02d 2702 (setq transpose-subr-end2 (point))
2076c87c 2703 (funcall mover -1)
8b56e02d 2704 (setq transpose-subr-start2 (point))
2076c87c
JB
2705 (goto-char (mark))
2706 (funcall mover 1)
8b56e02d 2707 (setq transpose-subr-end1 (point))
2076c87c 2708 (funcall mover -1)
8b56e02d 2709 (setq transpose-subr-start1 (point))
2076c87c 2710 (transpose-subr-1))
d3f4ef3f
AS
2711 (exchange-point-and-mark))
2712 (if (> arg 0)
2713 (progn
2714 (funcall mover -1)
8b56e02d 2715 (setq transpose-subr-start1 (point))
d3f4ef3f 2716 (funcall mover 1)
8b56e02d 2717 (setq transpose-subr-end1 (point))
d3f4ef3f 2718 (funcall mover arg)
8b56e02d 2719 (setq transpose-subr-end2 (point))
d3f4ef3f 2720 (funcall mover (- arg))
8b56e02d 2721 (setq transpose-subr-start2 (point))
d3f4ef3f 2722 (transpose-subr-1)
8b56e02d 2723 (goto-char transpose-subr-end2))
d3f4ef3f 2724 (funcall mover -1)
8b56e02d 2725 (setq transpose-subr-start2 (point))
d3f4ef3f 2726 (funcall mover 1)
8b56e02d 2727 (setq transpose-subr-end2 (point))
d3f4ef3f 2728 (funcall mover (1- arg))
8b56e02d 2729 (setq transpose-subr-start1 (point))
d3f4ef3f 2730 (funcall mover (- arg))
8b56e02d 2731 (setq transpose-subr-end1 (point))
d3f4ef3f 2732 (transpose-subr-1)))))
2076c87c
JB
2733
2734(defun transpose-subr-1 ()
8b56e02d
RS
2735 (if (> (min transpose-subr-end1 transpose-subr-end2)
2736 (max transpose-subr-start1 transpose-subr-start2))
2076c87c 2737 (error "Don't have two things to transpose"))
8b56e02d 2738 (let* ((word1 (buffer-substring transpose-subr-start1 transpose-subr-end1))
d5d99b80 2739 (len1 (length word1))
8b56e02d 2740 (word2 (buffer-substring transpose-subr-start2 transpose-subr-end2))
d5d99b80 2741 (len2 (length word2)))
8b56e02d
RS
2742 (delete-region transpose-subr-start2 transpose-subr-end2)
2743 (goto-char transpose-subr-start2)
2076c87c 2744 (insert word1)
8b56e02d
RS
2745 (goto-char (if (< transpose-subr-start1 transpose-subr-start2)
2746 transpose-subr-start1
2747 (+ transpose-subr-start1 (- len1 len2))))
d5d99b80 2748 (delete-region (point) (+ (point) len1))
2076c87c 2749 (insert word2)))
eaae8106 2750
2076c87c 2751(defun backward-word (arg)
b7e91b0c 2752 "Move backward until encountering the beginning of a word.
20ecc110 2753With argument, do this that many times."
9e50756b 2754 (interactive "p")
2076c87c
JB
2755 (forward-word (- arg)))
2756
2757(defun mark-word (arg)
2758 "Set mark arg words away from point."
2759 (interactive "p")
2760 (push-mark
2761 (save-excursion
2762 (forward-word arg)
fd0f4056
RS
2763 (point))
2764 nil t))
2076c87c
JB
2765
2766(defun kill-word (arg)
2767 "Kill characters forward until encountering the end of a word.
2768With argument, do this that many times."
e761e42c 2769 (interactive "p")
89ee2bf6 2770 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
2771
2772(defun backward-kill-word (arg)
2773 "Kill characters backward until encountering the end of a word.
2774With argument, do this that many times."
e761e42c 2775 (interactive "p")
2076c87c 2776 (kill-word (- arg)))
d7c64071 2777
1e8c5ac4
RS
2778(defun current-word (&optional strict)
2779 "Return the word point is on (or a nearby word) as a string.
2780If optional arg STRICT is non-nil, return nil unless point is within
2781or adjacent to a word."
d7c64071
ER
2782 (save-excursion
2783 (let ((oldpoint (point)) (start (point)) (end (point)))
2784 (skip-syntax-backward "w_") (setq start (point))
2785 (goto-char oldpoint)
2786 (skip-syntax-forward "w_") (setq end (point))
2787 (if (and (eq start oldpoint) (eq end oldpoint))
1e8c5ac4
RS
2788 ;; Point is neither within nor adjacent to a word.
2789 (and (not strict)
2790 (progn
2791 ;; Look for preceding word in same line.
2792 (skip-syntax-backward "^w_"
2793 (save-excursion (beginning-of-line)
2794 (point)))
2795 (if (bolp)
2796 ;; No preceding word in same line.
2797 ;; Look for following word in same line.
2798 (progn
2799 (skip-syntax-forward "^w_"
2800 (save-excursion (end-of-line)
2801 (point)))
2802 (setq start (point))
2803 (skip-syntax-forward "w_")
2804 (setq end (point)))
2805 (setq end (point))
2806 (skip-syntax-backward "w_")
2807 (setq start (point)))
020db25f
RS
2808 (buffer-substring-no-properties start end)))
2809 (buffer-substring-no-properties start end)))))
eaae8106 2810
69c1dd37 2811(defcustom fill-prefix nil
2076c87c 2812 "*String for filling to insert at front of new line, or nil for none.
69c1dd37
RS
2813Setting this variable automatically makes it local to the current buffer."
2814 :type '(choice (const :tag "None" nil)
2815 string)
2816 :group 'fill)
2076c87c
JB
2817(make-variable-buffer-local 'fill-prefix)
2818
69c1dd37
RS
2819(defcustom auto-fill-inhibit-regexp nil
2820 "*Regexp to match lines which should not be auto-filled."
2821 :type '(choice (const :tag "None" nil)
2822 regexp)
2823 :group 'fill)
2076c87c 2824
58dd38f1 2825(defvar comment-line-break-function 'comment-indent-new-line
b3ac9fa9
RS
2826 "*Mode-specific function which line breaks and continues a comment.
2827
2828This function is only called during auto-filling of a comment section.
2829The function should take a single optional argument, which is a flag
2830indicating whether it should use soft newlines.
2831
2832Setting this variable automatically makes it local to the current buffer.")
2833
dbe524b6 2834;; This function is used as the auto-fill-function of a buffer
e2504204
KH
2835;; when Auto-Fill mode is enabled.
2836;; It returns t if it really did any work.
dbe524b6
RS
2837;; (Actually some major modes use a different auto-fill function,
2838;; but this one is the default one.)
2076c87c 2839(defun do-auto-fill ()
a0170800
RS
2840 (let (fc justify bol give-up
2841 (fill-prefix fill-prefix))
c18465c4 2842 (if (or (not (setq justify (current-justification)))
8f066a20
RS
2843 (null (setq fc (current-fill-column)))
2844 (and (eq justify 'left)
2845 (<= (current-column) fc))
1e722f9f 2846 (save-excursion (beginning-of-line)
eed5698b
RS
2847 (setq bol (point))
2848 (and auto-fill-inhibit-regexp
2849 (looking-at auto-fill-inhibit-regexp))))
2850 nil ;; Auto-filling not required
3db1e3b5
BG
2851 (if (memq justify '(full center right))
2852 (save-excursion (unjustify-current-line)))
a0170800
RS
2853
2854 ;; Choose a fill-prefix automatically.
2855 (if (and adaptive-fill-mode
2856 (or (null fill-prefix) (string= fill-prefix "")))
e4b62d7c
RS
2857 (let ((prefix
2858 (fill-context-prefix
2859 (save-excursion (backward-paragraph 1) (point))
50be475d 2860 (save-excursion (forward-paragraph 1) (point)))))
e4b62d7c
RS
2861 (and prefix (not (equal prefix ""))
2862 (setq fill-prefix prefix))))
a0170800 2863
eed5698b 2864 (while (and (not give-up) (> (current-column) fc))
e47d38f6 2865 ;; Determine where to split the line.
db893d00
RS
2866 (let* (after-prefix
2867 (fill-point
2868 (let ((opoint (point))
2869 bounce
2870 (first t))
2871 (save-excursion
2872 (beginning-of-line)
2873 (setq after-prefix (point))
2874 (and fill-prefix
2875 (looking-at (regexp-quote fill-prefix))
2876 (setq after-prefix (match-end 0)))
2877 (move-to-column (1+ fc))
dbe524b6
RS
2878 ;; Move back to the point where we can break the line.
2879 ;; We break the line between word or
db893d00
RS
2880 ;; after/before the character which has character
2881 ;; category `|'. We search space, \c| followed by
dbe524b6 2882 ;; a character, or \c| following a character. If
db893d00
RS
2883 ;; not found, place the point at beginning of line.
2884 (while (or first
2885 ;; If this is after period and a single space,
2886 ;; move back once more--we don't want to break
2887 ;; the line there and make it look like a
2888 ;; sentence end.
2889 (and (not (bobp))
2890 (not bounce)
2891 sentence-end-double-space
2892 (save-excursion (forward-char -1)
2893 (and (looking-at "\\. ")
dbe524b6
RS
2894 (not (looking-at "\\. ")))))
2895 (and (not (bobp))
2896 (not bounce)
2897 fill-nobreak-predicate
2898 (funcall fill-nobreak-predicate)))
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
e47d38f6
RS
2961 (end-of-line 0)
2962 (justify-current-line justify nil t)))
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))
3374 (while (looking-at "^[^: \n]+:\\|^[ \t]")
3375 (forward-line 1))
3376 (point))
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.
a3d1480b
JB
3835(mapcar
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
GM
4139
4140;;; Minibuffer prompt stuff.
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