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