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