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