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