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