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