*** empty log message ***
[emacs.git] / lisp / simple.el
blob6a382d8c5503a0a3ca4b9dda9a1a24a2290e0540
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 98, 99,
4 ;; 2000, 2001, 2002, 2003
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: internal
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; A grab-bag of basic Emacs commands not specifically related to some
30 ;; major mode or to file-handling.
32 ;;; Code:
34 (eval-when-compile
35 (autoload 'widget-convert "wid-edit")
36 (autoload 'shell-mode "shell"))
39 (defgroup killing nil
40 "Killing and yanking commands"
41 :group 'editing)
43 (defgroup paren-matching nil
44 "Highlight (un)matching of parens and expressions."
45 :group 'matching)
47 (define-key global-map [?\C-x right] 'next-buffer)
48 (define-key global-map [?\C-x left] 'prev-buffer)
49 (defun next-buffer ()
50 "Switch to the next buffer in cyclic order."
51 (interactive)
52 (let ((buffer (current-buffer)))
53 (switch-to-buffer (other-buffer buffer))
54 (bury-buffer buffer)))
56 (defun prev-buffer ()
57 "Switch to the previous buffer in cyclic order."
58 (interactive)
59 (let ((list (nreverse (buffer-list)))
60 found)
61 (while (and (not found) list)
62 (let ((buffer (car list)))
63 (if (and (not (get-buffer-window buffer))
64 (not (string-match "\\` " (buffer-name buffer))))
65 (setq found buffer)))
66 (setq list (cdr list)))
67 (switch-to-buffer found)))
69 (defun fundamental-mode ()
70 "Major mode not specialized for anything in particular.
71 Other major modes are defined by comparison with this one."
72 (interactive)
73 (kill-all-local-variables))
75 ;; Making and deleting lines.
77 (defun newline (&optional arg)
78 "Insert a newline, and move to left margin of the new line if it's blank.
79 If `use-hard-newlines' is non-nil, the newline is marked with the
80 text-property `hard'.
81 With ARG, insert that many newlines.
82 Call `auto-fill-function' if the current column number is greater
83 than the value of `fill-column' and ARG is nil."
84 (interactive "*P")
85 (barf-if-buffer-read-only)
86 ;; Inserting a newline at the end of a line produces better redisplay in
87 ;; try_window_id than inserting at the beginning of a line, and the textual
88 ;; result is the same. So, if we're at beginning of line, pretend to be at
89 ;; the end of the previous line.
90 (let ((flag (and (not (bobp))
91 (bolp)
92 ;; Make sure no functions want to be told about
93 ;; the range of the changes.
94 (not after-change-functions)
95 (not before-change-functions)
96 ;; Make sure there are no markers here.
97 (not (buffer-has-markers-at (1- (point))))
98 (not (buffer-has-markers-at (point)))
99 ;; Make sure no text properties want to know
100 ;; where the change was.
101 (not (get-char-property (1- (point)) 'modification-hooks))
102 (not (get-char-property (1- (point)) 'insert-behind-hooks))
103 (or (eobp)
104 (not (get-char-property (point) 'insert-in-front-hooks)))
105 ;; Make sure the newline before point isn't intangible.
106 (not (get-char-property (1- (point)) 'intangible))
107 ;; Make sure the newline before point isn't read-only.
108 (not (get-char-property (1- (point)) 'read-only))
109 ;; Make sure the newline before point isn't invisible.
110 (not (get-char-property (1- (point)) 'invisible))
111 ;; Make sure the newline before point has the same
112 ;; properties as the char before it (if any).
113 (< (or (previous-property-change (point)) -2)
114 (- (point) 2))))
115 (was-page-start (and (bolp)
116 (looking-at page-delimiter)))
117 (beforepos (point)))
118 (if flag (backward-char 1))
119 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
120 ;; Set last-command-char to tell self-insert what to insert.
121 (let ((last-command-char ?\n)
122 ;; Don't auto-fill if we have a numeric argument.
123 ;; Also not if flag is true (it would fill wrong line);
124 ;; there is no need to since we're at BOL.
125 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
126 (unwind-protect
127 (self-insert-command (prefix-numeric-value arg))
128 ;; If we get an error in self-insert-command, put point at right place.
129 (if flag (forward-char 1))))
130 ;; Even if we did *not* get an error, keep that forward-char;
131 ;; all further processing should apply to the newline that the user
132 ;; thinks he inserted.
134 ;; Mark the newline(s) `hard'.
135 (if use-hard-newlines
136 (set-hard-newline-properties
137 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
138 ;; If the newline leaves the previous line blank,
139 ;; and we have a left margin, delete that from the blank line.
140 (or flag
141 (save-excursion
142 (goto-char beforepos)
143 (beginning-of-line)
144 (and (looking-at "[ \t]$")
145 (> (current-left-margin) 0)
146 (delete-region (point) (progn (end-of-line) (point))))))
147 ;; Indent the line after the newline, except in one case:
148 ;; when we added the newline at the beginning of a line
149 ;; which starts a page.
150 (or was-page-start
151 (move-to-left-margin nil t)))
152 nil)
154 (defun set-hard-newline-properties (from to)
155 (let ((sticky (get-text-property from 'rear-nonsticky)))
156 (put-text-property from to 'hard 't)
157 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
158 (if (and (listp sticky) (not (memq 'hard sticky)))
159 (put-text-property from (point) 'rear-nonsticky
160 (cons 'hard sticky)))))
162 (defun open-line (arg)
163 "Insert a newline and leave point before it.
164 If there is a fill prefix and/or a left-margin, insert them on the new line
165 if the line would have been blank.
166 With arg N, insert N newlines."
167 (interactive "*p")
168 (let* ((do-fill-prefix (and fill-prefix (bolp)))
169 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
170 (loc (point))
171 ;; Don't expand an abbrev before point.
172 (abbrev-mode nil))
173 (newline arg)
174 (goto-char loc)
175 (while (> arg 0)
176 (cond ((bolp)
177 (if do-left-margin (indent-to (current-left-margin)))
178 (if do-fill-prefix (insert-and-inherit fill-prefix))))
179 (forward-line 1)
180 (setq arg (1- arg)))
181 (goto-char loc)
182 (end-of-line)))
184 (defun split-line (&optional arg)
185 "Split current line, moving portion beyond point vertically down.
186 If the current line starts with `fill-prefix', insert it on the new
187 line as well. With prefix arg, don't insert fill-prefix on new line.
189 When called from Lisp code, the arg may be a prefix string to copy."
190 (interactive "*P")
191 (skip-chars-forward " \t")
192 (let* ((col (current-column))
193 (pos (point))
194 ;; What prefix should we check for (nil means don't).
195 (prefix (cond ((stringp arg) arg)
196 (arg nil)
197 (t fill-prefix)))
198 ;; Does this line start with it?
199 (have-prfx (and prefix
200 (save-excursion
201 (beginning-of-line)
202 (looking-at (regexp-quote prefix))))))
203 (newline 1)
204 (if have-prfx (insert-and-inherit prefix))
205 (indent-to col 0)
206 (goto-char pos)))
208 (defun delete-indentation (&optional arg)
209 "Join this line to previous and fix up whitespace at join.
210 If there is a fill prefix, delete it from the beginning of this line.
211 With argument, join this line to following line."
212 (interactive "*P")
213 (beginning-of-line)
214 (if arg (forward-line 1))
215 (if (eq (preceding-char) ?\n)
216 (progn
217 (delete-region (point) (1- (point)))
218 ;; If the second line started with the fill prefix,
219 ;; delete the prefix.
220 (if (and fill-prefix
221 (<= (+ (point) (length fill-prefix)) (point-max))
222 (string= fill-prefix
223 (buffer-substring (point)
224 (+ (point) (length fill-prefix)))))
225 (delete-region (point) (+ (point) (length fill-prefix))))
226 (fixup-whitespace))))
228 (defalias 'join-line #'delete-indentation) ; easier to find
230 (defun delete-blank-lines ()
231 "On blank line, delete all surrounding blank lines, leaving just one.
232 On isolated blank line, delete that one.
233 On nonblank line, delete any immediately following blank lines."
234 (interactive "*")
235 (let (thisblank singleblank)
236 (save-excursion
237 (beginning-of-line)
238 (setq thisblank (looking-at "[ \t]*$"))
239 ;; Set singleblank if there is just one blank line here.
240 (setq singleblank
241 (and thisblank
242 (not (looking-at "[ \t]*\n[ \t]*$"))
243 (or (bobp)
244 (progn (forward-line -1)
245 (not (looking-at "[ \t]*$")))))))
246 ;; Delete preceding blank lines, and this one too if it's the only one.
247 (if thisblank
248 (progn
249 (beginning-of-line)
250 (if singleblank (forward-line 1))
251 (delete-region (point)
252 (if (re-search-backward "[^ \t\n]" nil t)
253 (progn (forward-line 1) (point))
254 (point-min)))))
255 ;; Delete following blank lines, unless the current line is blank
256 ;; and there are no following blank lines.
257 (if (not (and thisblank singleblank))
258 (save-excursion
259 (end-of-line)
260 (forward-line 1)
261 (delete-region (point)
262 (if (re-search-forward "[^ \t\n]" nil t)
263 (progn (beginning-of-line) (point))
264 (point-max)))))
265 ;; Handle the special case where point is followed by newline and eob.
266 ;; Delete the line, leaving point at eob.
267 (if (looking-at "^[ \t]*\n\\'")
268 (delete-region (point) (point-max)))))
270 (defun delete-trailing-whitespace ()
271 "Delete all the trailing whitespace across the current buffer.
272 All whitespace after the last non-whitespace character in a line is deleted.
273 This respects narrowing, created by \\[narrow-to-region] and friends.
274 A formfeed is not considered whitespace by this function."
275 (interactive "*")
276 (save-match-data
277 (save-excursion
278 (goto-char (point-min))
279 (while (re-search-forward "\\s-$" nil t)
280 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
281 ;; Don't delete formfeeds, even if they are considered whitespace.
282 (save-match-data
283 (if (looking-at ".*\f")
284 (goto-char (match-end 0))))
285 (delete-region (point) (match-end 0))))))
287 (defun newline-and-indent ()
288 "Insert a newline, then indent according to major mode.
289 Indentation is done using the value of `indent-line-function'.
290 In programming language modes, this is the same as TAB.
291 In some text modes, where TAB inserts a tab, this command indents to the
292 column specified by the function `current-left-margin'."
293 (interactive "*")
294 (delete-horizontal-space t)
295 (newline)
296 (indent-according-to-mode))
298 (defun reindent-then-newline-and-indent ()
299 "Reindent current line, insert newline, then indent the new line.
300 Indentation of both lines is done according to the current major mode,
301 which means calling the current value of `indent-line-function'.
302 In programming language modes, this is the same as TAB.
303 In some text modes, where TAB inserts a tab, this indents to the
304 column specified by the function `current-left-margin'."
305 (interactive "*")
306 (delete-horizontal-space t)
307 (let ((pos (point)))
308 ;; Be careful to insert the newline before indenting the line.
309 ;; Otherwise, the indentation might be wrong.
310 (newline)
311 (save-excursion
312 (goto-char pos)
313 (indent-according-to-mode))
314 (indent-according-to-mode)))
316 (defun quoted-insert (arg)
317 "Read next input character and insert it.
318 This is useful for inserting control characters.
320 If the first character you type after this command is an octal digit,
321 you should type a sequence of octal digits which specify a character code.
322 Any nondigit terminates the sequence. If the terminator is a RET,
323 it is discarded; any other terminator is used itself as input.
324 The variable `read-quoted-char-radix' specifies the radix for this feature;
325 set it to 10 or 16 to use decimal or hex instead of octal.
327 In overwrite mode, this function inserts the character anyway, and
328 does not handle octal digits specially. This means that if you use
329 overwrite as your normal editing mode, you can use this function to
330 insert characters when necessary.
332 In binary overwrite mode, this function does overwrite, and octal
333 digits are interpreted as a character code. This is intended to be
334 useful for editing binary files."
335 (interactive "*p")
336 (let* ((char (let (translation-table-for-input)
337 (if (or (not overwrite-mode)
338 (eq overwrite-mode 'overwrite-mode-binary))
339 (read-quoted-char)
340 (read-char)))))
341 ;; Assume character codes 0240 - 0377 stand for characters in some
342 ;; single-byte character set, and convert them to Emacs
343 ;; characters.
344 (if (and enable-multibyte-characters
345 (>= char ?\240)
346 (<= char ?\377))
347 (setq char (unibyte-char-to-multibyte char)))
348 (if (> arg 0)
349 (if (eq overwrite-mode 'overwrite-mode-binary)
350 (delete-char arg)))
351 (while (> arg 0)
352 (insert-and-inherit char)
353 (setq arg (1- arg)))))
355 (defun forward-to-indentation (arg)
356 "Move forward ARG lines and position at first nonblank character."
357 (interactive "p")
358 (forward-line arg)
359 (skip-chars-forward " \t"))
361 (defun backward-to-indentation (arg)
362 "Move backward ARG lines and position at first nonblank character."
363 (interactive "p")
364 (forward-line (- arg))
365 (skip-chars-forward " \t"))
367 (defun back-to-indentation ()
368 "Move point to the first non-whitespace character on this line."
369 (interactive)
370 (beginning-of-line 1)
371 (skip-syntax-forward " " (line-end-position))
372 ;; Move back over chars that have whitespace syntax but have the p flag.
373 (backward-prefix-chars))
375 (defun fixup-whitespace ()
376 "Fixup white space between objects around point.
377 Leave one space or none, according to the context."
378 (interactive "*")
379 (save-excursion
380 (delete-horizontal-space)
381 (if (or (looking-at "^\\|\\s)")
382 (save-excursion (forward-char -1)
383 (looking-at "$\\|\\s(\\|\\s'")))
385 (insert ?\ ))))
387 (defun delete-horizontal-space (&optional backward-only)
388 "Delete all spaces and tabs around point.
389 If BACKWARD-ONLY is non-nil, only delete spaces before point."
390 (interactive "*")
391 (let ((orig-pos (point)))
392 (delete-region
393 (if backward-only
394 orig-pos
395 (progn
396 (skip-chars-forward " \t")
397 (constrain-to-field nil orig-pos t)))
398 (progn
399 (skip-chars-backward " \t")
400 (constrain-to-field nil orig-pos)))))
402 (defun just-one-space ()
403 "Delete all spaces and tabs around point, leaving one space."
404 (interactive "*")
405 (let ((orig-pos (point)))
406 (skip-chars-backward " \t")
407 (constrain-to-field nil orig-pos)
408 (if (= (following-char) ? )
409 (forward-char 1)
410 (insert ? ))
411 (delete-region
412 (point)
413 (progn
414 (skip-chars-forward " \t")
415 (constrain-to-field nil orig-pos t)))))
417 (defun beginning-of-buffer (&optional arg)
418 "Move point to the beginning of the buffer; leave mark at previous position.
419 With arg N, put point N/10 of the way from the beginning.
421 If the buffer is narrowed, this command uses the beginning and size
422 of the accessible part of the buffer.
424 Don't use this command in Lisp programs!
425 \(goto-char (point-min)) is faster and avoids clobbering the mark."
426 (interactive "P")
427 (push-mark)
428 (let ((size (- (point-max) (point-min))))
429 (goto-char (if arg
430 (+ (point-min)
431 (if (> size 10000)
432 ;; Avoid overflow for large buffer sizes!
433 (* (prefix-numeric-value arg)
434 (/ size 10))
435 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
436 (point-min))))
437 (if arg (forward-line 1)))
439 (defun end-of-buffer (&optional arg)
440 "Move point to the end of the buffer; leave mark at previous position.
441 With arg N, put point N/10 of the way from the end.
443 If the buffer is narrowed, this command uses the beginning and size
444 of the accessible part of the buffer.
446 Don't use this command in Lisp programs!
447 \(goto-char (point-max)) is faster and avoids clobbering the mark."
448 (interactive "P")
449 (push-mark)
450 (let ((size (- (point-max) (point-min))))
451 (goto-char (if arg
452 (- (point-max)
453 (if (> size 10000)
454 ;; Avoid overflow for large buffer sizes!
455 (* (prefix-numeric-value arg)
456 (/ size 10))
457 (/ (* size (prefix-numeric-value arg)) 10)))
458 (point-max))))
459 ;; If we went to a place in the middle of the buffer,
460 ;; adjust it to the beginning of a line.
461 (cond (arg (forward-line 1))
462 ((> (point) (window-end nil t))
463 ;; If the end of the buffer is not already on the screen,
464 ;; then scroll specially to put it near, but not at, the bottom.
465 (overlay-recenter (point))
466 (recenter -3))))
468 (defun mark-whole-buffer ()
469 "Put point at beginning and mark at end of buffer.
470 You probably should not use this function in Lisp programs;
471 it is usually a mistake for a Lisp function to use any subroutine
472 that uses or sets the mark."
473 (interactive)
474 (push-mark (point))
475 (push-mark (point-max) nil t)
476 (goto-char (point-min)))
479 ;; Counting lines, one way or another.
481 (defun goto-line (arg)
482 "Goto line ARG, counting from line 1 at beginning of buffer."
483 (interactive "NGoto line: ")
484 (setq arg (prefix-numeric-value arg))
485 (save-restriction
486 (widen)
487 (goto-char 1)
488 (if (eq selective-display t)
489 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
490 (forward-line (1- arg)))))
492 (defun count-lines-region (start end)
493 "Print number of lines and characters in the region."
494 (interactive "r")
495 (message "Region has %d lines, %d characters"
496 (count-lines start end) (- end start)))
498 (defun what-line ()
499 "Print the current buffer line number and narrowed line number of point."
500 (interactive)
501 (let ((opoint (point)) start)
502 (save-excursion
503 (save-restriction
504 (goto-char (point-min))
505 (widen)
506 (forward-line 0)
507 (setq start (point))
508 (goto-char opoint)
509 (forward-line 0)
510 (if (/= start (point-min))
511 (message "line %d (narrowed line %d)"
512 (1+ (count-lines (point-min) (point)))
513 (1+ (count-lines start (point))))
514 (message "Line %d" (1+ (count-lines (point-min) (point)))))))))
516 (defun count-lines (start end)
517 "Return number of lines between START and END.
518 This is usually the number of newlines between them,
519 but can be one more if START is not equal to END
520 and the greater of them is not at the start of a line."
521 (save-excursion
522 (save-restriction
523 (narrow-to-region start end)
524 (goto-char (point-min))
525 (if (eq selective-display t)
526 (save-match-data
527 (let ((done 0))
528 (while (re-search-forward "[\n\C-m]" nil t 40)
529 (setq done (+ 40 done)))
530 (while (re-search-forward "[\n\C-m]" nil t 1)
531 (setq done (+ 1 done)))
532 (goto-char (point-max))
533 (if (and (/= start end)
534 (not (bolp)))
535 (1+ done)
536 done)))
537 (- (buffer-size) (forward-line (buffer-size)))))))
539 (defun what-cursor-position (&optional detail)
540 "Print info on cursor position (on screen and within buffer).
541 Also describe the character after point, and give its character code
542 in octal, decimal and hex.
544 For a non-ASCII multibyte character, also give its encoding in the
545 buffer's selected coding system if the coding system encodes the
546 character safely. If the character is encoded into one byte, that
547 code is shown in hex. If the character is encoded into more than one
548 byte, just \"...\" is shown.
550 In addition, with prefix argument, show details about that character
551 in *Help* buffer. See also the command `describe-char'."
552 (interactive "P")
553 (let* ((char (following-char))
554 (beg (point-min))
555 (end (point-max))
556 (pos (point))
557 (total (buffer-size))
558 (percent (if (> total 50000)
559 ;; Avoid overflow from multiplying by 100!
560 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
561 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
562 (hscroll (if (= (window-hscroll) 0)
564 (format " Hscroll=%d" (window-hscroll))))
565 (col (current-column)))
566 (if (= pos end)
567 (if (or (/= beg 1) (/= end (1+ total)))
568 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
569 pos total percent beg end col hscroll)
570 (message "point=%d of %d (%d%%) column %d %s"
571 pos total percent col hscroll))
572 (let ((coding buffer-file-coding-system)
573 encoded encoding-msg)
574 (if (or (not coding)
575 (eq (coding-system-type coding) t))
576 (setq coding default-buffer-file-coding-system))
577 (if (not (char-valid-p char))
578 (setq encoding-msg
579 (format "(0%o, %d, 0x%x, invalid)" char char char))
580 (setq encoded (and (>= char 128) (encode-coding-char char coding)))
581 (setq encoding-msg
582 (if encoded
583 (format "(0%o, %d, 0x%x, file %s)"
584 char char char
585 (if (> (length encoded) 1)
586 "..."
587 (encoded-string-description encoded coding)))
588 (format "(0%o, %d, 0x%x)" char char char))))
589 (if detail
590 ;; We show the detailed information about CHAR.
591 (describe-char (point)))
592 (if (or (/= beg 1) (/= end (1+ total)))
593 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
594 (if (< char 256)
595 (single-key-description char)
596 (buffer-substring-no-properties (point) (1+ (point))))
597 encoding-msg pos total percent beg end col hscroll)
598 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
599 (if (< char 256)
600 (single-key-description char)
601 (buffer-substring-no-properties (point) (1+ (point))))
602 encoding-msg pos total percent col hscroll))))))
604 (defvar read-expression-map
605 (let ((m (make-sparse-keymap)))
606 (define-key m "\M-\t" 'lisp-complete-symbol)
607 (set-keymap-parent m minibuffer-local-map)
609 "Minibuffer keymap used for reading Lisp expressions.")
611 (defvar read-expression-history nil)
613 (defcustom eval-expression-print-level 4
614 "*Value to use for `print-level' when printing value in `eval-expression'.
615 A value of nil means no limit."
616 :group 'lisp
617 :type '(choice (const :tag "No Limit" nil) integer)
618 :version "21.1")
620 (defcustom eval-expression-print-length 12
621 "*Value to use for `print-length' when printing value in `eval-expression'.
622 A value of nil means no limit."
623 :group 'lisp
624 :type '(choice (const :tag "No Limit" nil) integer)
625 :version "21.1")
627 (defcustom eval-expression-debug-on-error t
628 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
629 If nil, don't change the value of `debug-on-error'."
630 :group 'lisp
631 :type 'boolean
632 :version "21.1")
634 ;; We define this, rather than making `eval' interactive,
635 ;; for the sake of completion of names like eval-region, eval-current-buffer.
636 (defun eval-expression (eval-expression-arg
637 &optional eval-expression-insert-value)
638 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
639 Value is also consed on to front of the variable `values'.
640 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
641 insert the result into the current buffer instead of printing it in
642 the echo area."
643 (interactive
644 (list (read-from-minibuffer "Eval: "
645 nil read-expression-map t
646 'read-expression-history)
647 current-prefix-arg))
649 (if (null eval-expression-debug-on-error)
650 (setq values (cons (eval eval-expression-arg) values))
651 (let ((old-value (make-symbol "t")) new-value)
652 ;; Bind debug-on-error to something unique so that we can
653 ;; detect when evaled code changes it.
654 (let ((debug-on-error old-value))
655 (setq values (cons (eval eval-expression-arg) values))
656 (setq new-value debug-on-error))
657 ;; If evaled code has changed the value of debug-on-error,
658 ;; propagate that change to the global binding.
659 (unless (eq old-value new-value)
660 (setq debug-on-error new-value))))
662 (let ((print-length eval-expression-print-length)
663 (print-level eval-expression-print-level))
664 (prin1 (car values)
665 (if eval-expression-insert-value (current-buffer) t))))
667 (defun edit-and-eval-command (prompt command)
668 "Prompting with PROMPT, let user edit COMMAND and eval result.
669 COMMAND is a Lisp expression. Let user edit that expression in
670 the minibuffer, then read and evaluate the result."
671 (let ((command
672 (unwind-protect
673 (read-from-minibuffer prompt
674 (prin1-to-string command)
675 read-expression-map t
676 '(command-history . 1))
677 ;; If command was added to command-history as a string,
678 ;; get rid of that. We want only evaluable expressions there.
679 (if (stringp (car command-history))
680 (setq command-history (cdr command-history))))))
682 ;; If command to be redone does not match front of history,
683 ;; add it to the history.
684 (or (equal command (car command-history))
685 (setq command-history (cons command command-history)))
686 (eval command)))
688 (defun repeat-complex-command (arg)
689 "Edit and re-evaluate last complex command, or ARGth from last.
690 A complex command is one which used the minibuffer.
691 The command is placed in the minibuffer as a Lisp form for editing.
692 The result is executed, repeating the command as changed.
693 If the command has been changed or is not the most recent previous command
694 it is added to the front of the command history.
695 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
696 to get different commands to edit and resubmit."
697 (interactive "p")
698 (let ((elt (nth (1- arg) command-history))
699 newcmd)
700 (if elt
701 (progn
702 (setq newcmd
703 (let ((print-level nil)
704 (minibuffer-history-position arg)
705 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
706 (unwind-protect
707 (read-from-minibuffer
708 "Redo: " (prin1-to-string elt) read-expression-map t
709 (cons 'command-history arg))
711 ;; If command was added to command-history as a
712 ;; string, get rid of that. We want only
713 ;; evaluable expressions there.
714 (if (stringp (car command-history))
715 (setq command-history (cdr command-history))))))
717 ;; If command to be redone does not match front of history,
718 ;; add it to the history.
719 (or (equal newcmd (car command-history))
720 (setq command-history (cons newcmd command-history)))
721 (eval newcmd))
722 (if command-history
723 (error "Argument %d is beyond length of command history" arg)
724 (error "There are no previous complex commands to repeat")))))
726 (defvar minibuffer-history nil
727 "Default minibuffer history list.
728 This is used for all minibuffer input
729 except when an alternate history list is specified.")
730 (defvar minibuffer-history-sexp-flag nil
731 "Non-nil when doing history operations on the variable `command-history'.
732 More generally, indicates that the history list being acted on
733 contains expressions rather than strings.
734 It is only valid if its value equals the current minibuffer depth,
735 to handle recursive uses of the minibuffer.")
736 (setq minibuffer-history-variable 'minibuffer-history)
737 (setq minibuffer-history-position nil)
738 (defvar minibuffer-history-search-history nil)
740 (defvar minibuffer-text-before-history nil
741 "Text that was in this minibuffer before any history commands.
742 This is nil if there have not yet been any history commands
743 in this use of the minibuffer.")
745 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
747 (defun minibuffer-history-initialize ()
748 (setq minibuffer-text-before-history nil))
750 (defun minibuffer-avoid-prompt (new old)
751 "A point-motion hook for the minibuffer, that moves point out of the prompt."
752 (constrain-to-field nil (point-max)))
754 (defcustom minibuffer-history-case-insensitive-variables nil
755 "*Minibuffer history variables for which matching should ignore case.
756 If a history variable is a member of this list, then the
757 \\[previous-matching-history-element] and \\[next-matching-history-element]\
758 commands ignore case when searching it, regardless of `case-fold-search'."
759 :type '(repeat variable)
760 :group 'minibuffer)
762 (defun previous-matching-history-element (regexp n)
763 "Find the previous history element that matches REGEXP.
764 \(Previous history elements refer to earlier actions.)
765 With prefix argument N, search for Nth previous match.
766 If N is negative, find the next or Nth next match.
767 Normally, history elements are matched case-insensitively if
768 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
769 makes the search case-sensitive.
770 See also `minibuffer-history-case-insensitive-variables'."
771 (interactive
772 (let* ((enable-recursive-minibuffers t)
773 (regexp (read-from-minibuffer "Previous element matching (regexp): "
775 minibuffer-local-map
777 'minibuffer-history-search-history)))
778 ;; Use the last regexp specified, by default, if input is empty.
779 (list (if (string= regexp "")
780 (if minibuffer-history-search-history
781 (car minibuffer-history-search-history)
782 (error "No previous history search regexp"))
783 regexp)
784 (prefix-numeric-value current-prefix-arg))))
785 (unless (zerop n)
786 (if (and (zerop minibuffer-history-position)
787 (null minibuffer-text-before-history))
788 (setq minibuffer-text-before-history
789 (minibuffer-contents-no-properties)))
790 (let ((history (symbol-value minibuffer-history-variable))
791 (case-fold-search
792 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
793 ;; On some systems, ignore case for file names.
794 (if (memq minibuffer-history-variable
795 minibuffer-history-case-insensitive-variables)
797 ;; Respect the user's setting for case-fold-search:
798 case-fold-search)
799 nil))
800 prevpos
801 match-string
802 match-offset
803 (pos minibuffer-history-position))
804 (while (/= n 0)
805 (setq prevpos pos)
806 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
807 (when (= pos prevpos)
808 (error (if (= pos 1)
809 "No later matching history item"
810 "No earlier matching history item")))
811 (setq match-string
812 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
813 (let ((print-level nil))
814 (prin1-to-string (nth (1- pos) history)))
815 (nth (1- pos) history)))
816 (setq match-offset
817 (if (< n 0)
818 (and (string-match regexp match-string)
819 (match-end 0))
820 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
821 (match-beginning 1))))
822 (when match-offset
823 (setq n (+ n (if (< n 0) 1 -1)))))
824 (setq minibuffer-history-position pos)
825 (goto-char (point-max))
826 (delete-minibuffer-contents)
827 (insert match-string)
828 (goto-char (+ (minibuffer-prompt-end) match-offset))))
829 (if (memq (car (car command-history)) '(previous-matching-history-element
830 next-matching-history-element))
831 (setq command-history (cdr command-history))))
833 (defun next-matching-history-element (regexp n)
834 "Find the next history element that matches REGEXP.
835 \(The next history element refers to a more recent action.)
836 With prefix argument N, search for Nth next match.
837 If N is negative, find the previous or Nth previous match.
838 Normally, history elements are matched case-insensitively if
839 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
840 makes the search case-sensitive."
841 (interactive
842 (let* ((enable-recursive-minibuffers t)
843 (regexp (read-from-minibuffer "Next element matching (regexp): "
845 minibuffer-local-map
847 'minibuffer-history-search-history)))
848 ;; Use the last regexp specified, by default, if input is empty.
849 (list (if (string= regexp "")
850 (setcar minibuffer-history-search-history
851 (nth 1 minibuffer-history-search-history))
852 regexp)
853 (prefix-numeric-value current-prefix-arg))))
854 (previous-matching-history-element regexp (- n)))
856 (defvar minibuffer-temporary-goal-position nil)
858 (defun next-history-element (n)
859 "Insert the next element of the minibuffer history into the minibuffer."
860 (interactive "p")
861 (or (zerop n)
862 (let ((narg (- minibuffer-history-position n))
863 (minimum (if minibuffer-default -1 0))
864 elt minibuffer-returned-to-present)
865 (if (and (zerop minibuffer-history-position)
866 (null minibuffer-text-before-history))
867 (setq minibuffer-text-before-history
868 (minibuffer-contents-no-properties)))
869 (if (< narg minimum)
870 (if minibuffer-default
871 (error "End of history; no next item")
872 (error "End of history; no default available")))
873 (if (> narg (length (symbol-value minibuffer-history-variable)))
874 (error "Beginning of history; no preceding item"))
875 (unless (memq last-command '(next-history-element
876 previous-history-element))
877 (let ((prompt-end (minibuffer-prompt-end)))
878 (set (make-local-variable 'minibuffer-temporary-goal-position)
879 (cond ((<= (point) prompt-end) prompt-end)
880 ((eobp) nil)
881 (t (point))))))
882 (goto-char (point-max))
883 (delete-minibuffer-contents)
884 (setq minibuffer-history-position narg)
885 (cond ((= narg -1)
886 (setq elt minibuffer-default))
887 ((= narg 0)
888 (setq elt (or minibuffer-text-before-history ""))
889 (setq minibuffer-returned-to-present t)
890 (setq minibuffer-text-before-history nil))
891 (t (setq elt (nth (1- minibuffer-history-position)
892 (symbol-value minibuffer-history-variable)))))
893 (insert
894 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
895 (not minibuffer-returned-to-present))
896 (let ((print-level nil))
897 (prin1-to-string elt))
898 elt))
899 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
901 (defun previous-history-element (n)
902 "Inserts the previous element of the minibuffer history into the minibuffer."
903 (interactive "p")
904 (next-history-element (- n)))
906 (defun next-complete-history-element (n)
907 "Get next history element which completes the minibuffer before the point.
908 The contents of the minibuffer after the point are deleted, and replaced
909 by the new completion."
910 (interactive "p")
911 (let ((point-at-start (point)))
912 (next-matching-history-element
913 (concat
914 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
916 ;; next-matching-history-element always puts us at (point-min).
917 ;; Move to the position we were at before changing the buffer contents.
918 ;; This is still sensical, because the text before point has not changed.
919 (goto-char point-at-start)))
921 (defun previous-complete-history-element (n)
923 Get previous history element which completes the minibuffer before the point.
924 The contents of the minibuffer after the point are deleted, and replaced
925 by the new completion."
926 (interactive "p")
927 (next-complete-history-element (- n)))
929 ;; For compatibility with the old subr of the same name.
930 (defun minibuffer-prompt-width ()
931 "Return the display width of the minibuffer prompt.
932 Return 0 if current buffer is not a mini-buffer."
933 ;; Return the width of everything before the field at the end of
934 ;; the buffer; this should be 0 for normal buffers.
935 (1- (minibuffer-prompt-end)))
937 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
938 (defalias 'advertised-undo 'undo)
940 (defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
941 "Table mapping redo records to the corresponding undo one.")
943 (defvar undo-in-region nil
944 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
946 (defvar undo-no-redo nil
947 "If t, `undo' doesn't go through redo entries.")
949 (defun undo (&optional arg)
950 "Undo some previous changes.
951 Repeat this command to undo more changes.
952 A numeric argument serves as a repeat count.
954 In Transient Mark mode when the mark is active, only undo changes within
955 the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
956 as an argument limits undo to changes within the current region."
957 (interactive "*P")
958 ;; Make last-command indicate for the next command that this was an undo.
959 ;; That way, another undo will undo more.
960 ;; If we get to the end of the undo history and get an error,
961 ;; another undo command will find the undo history empty
962 ;; and will get another error. To begin undoing the undos,
963 ;; you must type some other command.
964 (setq this-command 'undo)
965 (let ((modified (buffer-modified-p))
966 (recent-save (recent-auto-save-p)))
967 (unless (eq last-command 'undo)
968 (setq undo-in-region
969 (if transient-mark-mode mark-active (and arg (not (numberp arg)))))
970 (if undo-in-region
971 (undo-start (region-beginning) (region-end))
972 (undo-start))
973 ;; get rid of initial undo boundary
974 (undo-more 1))
975 ;; Check to see whether we're hitting a redo record, and if
976 ;; so, ask the user whether she wants to skip the redo/undo pair.
977 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
978 (or (eq (selected-window) (minibuffer-window))
979 (message (if undo-in-region
980 (if equiv "Redo in region!" "Undo in region!")
981 (if equiv "Redo!" "Undo!"))))
982 (when (and equiv undo-no-redo)
983 ;; The equiv entry might point to another redo record if we have done
984 ;; undo-redo-undo-redo-... so skip to the very last equiv.
985 (while (let ((next (gethash equiv undo-equiv-table)))
986 (if next (setq equiv next))))
987 (setq pending-undo-list equiv)))
988 (undo-more
989 (if (or transient-mark-mode (numberp arg))
990 (prefix-numeric-value arg)
992 ;; Record the fact that the just-generated undo records come from an
993 ;; undo operation, so we can skip them later on.
994 ;; I don't know how to do that in the undo-in-region case.
995 (unless undo-in-region
996 (puthash buffer-undo-list pending-undo-list undo-equiv-table))
997 ;; Don't specify a position in the undo record for the undo command.
998 ;; Instead, undoing this should move point to where the change is.
999 (let ((tail buffer-undo-list)
1000 (prev nil))
1001 (while (car tail)
1002 (when (integerp (car tail))
1003 (let ((pos (car tail)))
1004 (if prev
1005 (setcdr prev (cdr tail))
1006 (setq buffer-undo-list (cdr tail)))
1007 (setq tail (cdr tail))
1008 (while (car tail)
1009 (if (eq pos (car tail))
1010 (if prev
1011 (setcdr prev (cdr tail))
1012 (setq buffer-undo-list (cdr tail)))
1013 (setq prev tail))
1014 (setq tail (cdr tail)))
1015 (setq tail nil)))
1016 (setq prev tail tail (cdr tail))))
1018 (and modified (not (buffer-modified-p))
1019 (delete-auto-save-file-if-necessary recent-save))))
1021 (defun undo-only (&optional arg)
1022 "Undo some previous changes.
1023 Repeat this command to undo more changes.
1024 A numeric argument serves as a repeat count.
1025 Contrary to `undo', this will not redo a previous undo."
1026 (interactive "*p")
1027 (let ((undo-no-redo t)) (undo arg)))
1028 ;; Richard said that we should not use C-x <uppercase letter> and I have
1029 ;; no idea whereas to bind it. Any suggestion welcome. -stef
1030 ;; (define-key ctl-x-map "U" 'undo-only)
1032 (defvar pending-undo-list nil
1033 "Within a run of consecutive undo commands, list remaining to be undone.")
1035 (defvar undo-in-progress nil
1036 "Non-nil while performing an undo.
1037 Some change-hooks test this variable to do something different.")
1039 (defun undo-more (count)
1040 "Undo back N undo-boundaries beyond what was already undone recently.
1041 Call `undo-start' to get ready to undo recent changes,
1042 then call `undo-more' one or more times to undo them."
1043 (or pending-undo-list
1044 (error (format "No further undo information%s"
1045 (if (and transient-mark-mode mark-active)
1046 " for region" ""))))
1047 (let ((undo-in-progress t))
1048 (setq pending-undo-list (primitive-undo count pending-undo-list))))
1050 ;; Deep copy of a list
1051 (defun undo-copy-list (list)
1052 "Make a copy of undo list LIST."
1053 (mapcar 'undo-copy-list-1 list))
1055 (defun undo-copy-list-1 (elt)
1056 (if (consp elt)
1057 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1058 elt))
1060 (defun undo-start (&optional beg end)
1061 "Set `pending-undo-list' to the front of the undo list.
1062 The next call to `undo-more' will undo the most recently made change.
1063 If BEG and END are specified, then only undo elements
1064 that apply to text between BEG and END are used; other undo elements
1065 are ignored. If BEG and END are nil, all undo elements are used."
1066 (if (eq buffer-undo-list t)
1067 (error "No undo information in this buffer"))
1068 (setq pending-undo-list
1069 (if (and beg end (not (= beg end)))
1070 (undo-make-selective-list (min beg end) (max beg end))
1071 buffer-undo-list)))
1073 (defvar undo-adjusted-markers)
1075 (defun undo-make-selective-list (start end)
1076 "Return a list of undo elements for the region START to END.
1077 The elements come from `buffer-undo-list', but we keep only
1078 the elements inside this region, and discard those outside this region.
1079 If we find an element that crosses an edge of this region,
1080 we stop and ignore all further elements."
1081 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1082 (undo-list (list nil))
1083 undo-adjusted-markers
1084 some-rejected
1085 undo-elt undo-elt temp-undo-list delta)
1086 (while undo-list-copy
1087 (setq undo-elt (car undo-list-copy))
1088 (let ((keep-this
1089 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1090 ;; This is a "was unmodified" element.
1091 ;; Keep it if we have kept everything thus far.
1092 (not some-rejected))
1094 (undo-elt-in-region undo-elt start end)))))
1095 (if keep-this
1096 (progn
1097 (setq end (+ end (cdr (undo-delta undo-elt))))
1098 ;; Don't put two nils together in the list
1099 (if (not (and (eq (car undo-list) nil)
1100 (eq undo-elt nil)))
1101 (setq undo-list (cons undo-elt undo-list))))
1102 (if (undo-elt-crosses-region undo-elt start end)
1103 (setq undo-list-copy nil)
1104 (setq some-rejected t)
1105 (setq temp-undo-list (cdr undo-list-copy))
1106 (setq delta (undo-delta undo-elt))
1108 (when (/= (cdr delta) 0)
1109 (let ((position (car delta))
1110 (offset (cdr delta)))
1112 ;; Loop down the earlier events adjusting their buffer
1113 ;; positions to reflect the fact that a change to the buffer
1114 ;; isn't being undone. We only need to process those element
1115 ;; types which undo-elt-in-region will return as being in
1116 ;; the region since only those types can ever get into the
1117 ;; output
1119 (while temp-undo-list
1120 (setq undo-elt (car temp-undo-list))
1121 (cond ((integerp undo-elt)
1122 (if (>= undo-elt position)
1123 (setcar temp-undo-list (- undo-elt offset))))
1124 ((atom undo-elt) nil)
1125 ((stringp (car undo-elt))
1126 ;; (TEXT . POSITION)
1127 (let ((text-pos (abs (cdr undo-elt)))
1128 (point-at-end (< (cdr undo-elt) 0 )))
1129 (if (>= text-pos position)
1130 (setcdr undo-elt (* (if point-at-end -1 1)
1131 (- text-pos offset))))))
1132 ((integerp (car undo-elt))
1133 ;; (BEGIN . END)
1134 (when (>= (car undo-elt) position)
1135 (setcar undo-elt (- (car undo-elt) offset))
1136 (setcdr undo-elt (- (cdr undo-elt) offset))))
1137 ((null (car undo-elt))
1138 ;; (nil PROPERTY VALUE BEG . END)
1139 (let ((tail (nthcdr 3 undo-elt)))
1140 (when (>= (car tail) position)
1141 (setcar tail (- (car tail) offset))
1142 (setcdr tail (- (cdr tail) offset))))))
1143 (setq temp-undo-list (cdr temp-undo-list))))))))
1144 (setq undo-list-copy (cdr undo-list-copy)))
1145 (nreverse undo-list)))
1147 (defun undo-elt-in-region (undo-elt start end)
1148 "Determine whether UNDO-ELT falls inside the region START ... END.
1149 If it crosses the edge, we return nil."
1150 (cond ((integerp undo-elt)
1151 (and (>= undo-elt start)
1152 (<= undo-elt end)))
1153 ((eq undo-elt nil)
1155 ((atom undo-elt)
1156 nil)
1157 ((stringp (car undo-elt))
1158 ;; (TEXT . POSITION)
1159 (and (>= (abs (cdr undo-elt)) start)
1160 (< (abs (cdr undo-elt)) end)))
1161 ((and (consp undo-elt) (markerp (car undo-elt)))
1162 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1163 ;; See if MARKER is inside the region.
1164 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1165 (unless alist-elt
1166 (setq alist-elt (cons (car undo-elt)
1167 (marker-position (car undo-elt))))
1168 (setq undo-adjusted-markers
1169 (cons alist-elt undo-adjusted-markers)))
1170 (and (cdr alist-elt)
1171 (>= (cdr alist-elt) start)
1172 (<= (cdr alist-elt) end))))
1173 ((null (car undo-elt))
1174 ;; (nil PROPERTY VALUE BEG . END)
1175 (let ((tail (nthcdr 3 undo-elt)))
1176 (and (>= (car tail) start)
1177 (<= (cdr tail) end))))
1178 ((integerp (car undo-elt))
1179 ;; (BEGIN . END)
1180 (and (>= (car undo-elt) start)
1181 (<= (cdr undo-elt) end)))))
1183 (defun undo-elt-crosses-region (undo-elt start end)
1184 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1185 This assumes we have already decided that UNDO-ELT
1186 is not *inside* the region START...END."
1187 (cond ((atom undo-elt) nil)
1188 ((null (car undo-elt))
1189 ;; (nil PROPERTY VALUE BEG . END)
1190 (let ((tail (nthcdr 3 undo-elt)))
1191 (not (or (< (car tail) end)
1192 (> (cdr tail) start)))))
1193 ((integerp (car undo-elt))
1194 ;; (BEGIN . END)
1195 (not (or (< (car undo-elt) end)
1196 (> (cdr undo-elt) start))))))
1198 ;; Return the first affected buffer position and the delta for an undo element
1199 ;; delta is defined as the change in subsequent buffer positions if we *did*
1200 ;; the undo.
1201 (defun undo-delta (undo-elt)
1202 (if (consp undo-elt)
1203 (cond ((stringp (car undo-elt))
1204 ;; (TEXT . POSITION)
1205 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1206 ((integerp (car undo-elt))
1207 ;; (BEGIN . END)
1208 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1210 '(0 . 0)))
1211 '(0 . 0)))
1213 (defvar shell-command-history nil
1214 "History list for some commands that read shell commands.")
1216 (defvar shell-command-switch "-c"
1217 "Switch used to have the shell execute its command line argument.")
1219 (defvar shell-command-default-error-buffer nil
1220 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1221 This buffer is used when `shell-command' or `shell-command-on-region'
1222 is run interactively. A value of nil means that output to stderr and
1223 stdout will be intermixed in the output stream.")
1225 (defun shell-command (command &optional output-buffer error-buffer)
1226 "Execute string COMMAND in inferior shell; display output, if any.
1227 With prefix argument, insert the COMMAND's output at point.
1229 If COMMAND ends in ampersand, execute it asynchronously.
1230 The output appears in the buffer `*Async Shell Command*'.
1231 That buffer is in shell mode.
1233 Otherwise, COMMAND is executed synchronously. The output appears in
1234 the buffer `*Shell Command Output*'. If the output is short enough to
1235 display in the echo area (which is determined by the variables
1236 `resize-mini-windows' and `max-mini-window-height'), it is shown
1237 there, but it is nonetheless available in buffer `*Shell Command
1238 Output*' even though that buffer is not automatically displayed.
1240 To specify a coding system for converting non-ASCII characters
1241 in the shell command output, use \\[universal-coding-system-argument]
1242 before this command.
1244 Noninteractive callers can specify coding systems by binding
1245 `coding-system-for-read' and `coding-system-for-write'.
1247 The optional second argument OUTPUT-BUFFER, if non-nil,
1248 says to put the output in some other buffer.
1249 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1250 If OUTPUT-BUFFER is not a buffer and not nil,
1251 insert output in current buffer. (This cannot be done asynchronously.)
1252 In either case, the output is inserted after point (leaving mark after it).
1254 If the command terminates without error, but generates output,
1255 and you did not specify \"insert it in the current buffer\",
1256 the output can be displayed in the echo area or in its buffer.
1257 If the output is short enough to display in the echo area
1258 \(determined by the variable `max-mini-window-height' if
1259 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1260 the buffer containing the output is displayed.
1262 If there is output and an error, and you did not specify \"insert it
1263 in the current buffer\", a message about the error goes at the end
1264 of the output.
1266 If there is no output, or if output is inserted in the current buffer,
1267 then `*Shell Command Output*' is deleted.
1269 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1270 or buffer name to which to direct the command's standard error output.
1271 If it is nil, error output is mingled with regular output.
1272 In an interactive call, the variable `shell-command-default-error-buffer'
1273 specifies the value of ERROR-BUFFER."
1275 (interactive (list (read-from-minibuffer "Shell command: "
1276 nil nil nil 'shell-command-history)
1277 current-prefix-arg
1278 shell-command-default-error-buffer))
1279 ;; Look for a handler in case default-directory is a remote file name.
1280 (let ((handler
1281 (find-file-name-handler (directory-file-name default-directory)
1282 'shell-command)))
1283 (if handler
1284 (funcall handler 'shell-command command output-buffer error-buffer)
1285 (if (and output-buffer
1286 (not (or (bufferp output-buffer) (stringp output-buffer))))
1287 ;; Output goes in current buffer.
1288 (let ((error-file
1289 (if error-buffer
1290 (make-temp-file
1291 (expand-file-name "scor"
1292 (or small-temporary-file-directory
1293 temporary-file-directory)))
1294 nil)))
1295 (barf-if-buffer-read-only)
1296 (push-mark nil t)
1297 ;; We do not use -f for csh; we will not support broken use of
1298 ;; .cshrcs. Even the BSD csh manual says to use
1299 ;; "if ($?prompt) exit" before things which are not useful
1300 ;; non-interactively. Besides, if someone wants their other
1301 ;; aliases for shell commands then they can still have them.
1302 (call-process shell-file-name nil
1303 (if error-file
1304 (list t error-file)
1306 nil shell-command-switch command)
1307 (when (and error-file (file-exists-p error-file))
1308 (if (< 0 (nth 7 (file-attributes error-file)))
1309 (with-current-buffer (get-buffer-create error-buffer)
1310 (let ((pos-from-end (- (point-max) (point))))
1311 (or (bobp)
1312 (insert "\f\n"))
1313 ;; Do no formatting while reading error file,
1314 ;; because that can run a shell command, and we
1315 ;; don't want that to cause an infinite recursion.
1316 (format-insert-file error-file nil)
1317 ;; Put point after the inserted errors.
1318 (goto-char (- (point-max) pos-from-end)))
1319 (display-buffer (current-buffer))))
1320 (delete-file error-file))
1321 ;; This is like exchange-point-and-mark, but doesn't
1322 ;; activate the mark. It is cleaner to avoid activation,
1323 ;; even though the command loop would deactivate the mark
1324 ;; because we inserted text.
1325 (goto-char (prog1 (mark t)
1326 (set-marker (mark-marker) (point)
1327 (current-buffer)))))
1328 ;; Output goes in a separate buffer.
1329 ;; Preserve the match data in case called from a program.
1330 (save-match-data
1331 (if (string-match "[ \t]*&[ \t]*\\'" command)
1332 ;; Command ending with ampersand means asynchronous.
1333 (let ((buffer (get-buffer-create
1334 (or output-buffer "*Async Shell Command*")))
1335 (directory default-directory)
1336 proc)
1337 ;; Remove the ampersand.
1338 (setq command (substring command 0 (match-beginning 0)))
1339 ;; If will kill a process, query first.
1340 (setq proc (get-buffer-process buffer))
1341 (if proc
1342 (if (yes-or-no-p "A command is running. Kill it? ")
1343 (kill-process proc)
1344 (error "Shell command in progress")))
1345 (with-current-buffer buffer
1346 (setq buffer-read-only nil)
1347 (erase-buffer)
1348 (display-buffer buffer)
1349 (setq default-directory directory)
1350 (setq proc (start-process "Shell" buffer shell-file-name
1351 shell-command-switch command))
1352 (setq mode-line-process '(":%s"))
1353 (require 'shell) (shell-mode)
1354 (set-process-sentinel proc 'shell-command-sentinel)
1356 (shell-command-on-region (point) (point) command
1357 output-buffer nil error-buffer)))))))
1359 (defun display-message-or-buffer (message
1360 &optional buffer-name not-this-window frame)
1361 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1362 MESSAGE may be either a string or a buffer.
1364 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1365 the maximum height of the echo area, as defined by `max-mini-window-height'
1366 if `resize-mini-windows' is non-nil.
1368 Returns either the string shown in the echo area, or when a pop-up
1369 buffer is used, the window used to display it.
1371 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1372 name of the buffer used to display it in the case where a pop-up buffer
1373 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1374 string and it is displayed in the echo area, it is not specified whether
1375 the contents are inserted into the buffer anyway.
1377 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1378 and only used if a buffer is displayed."
1379 (cond ((and (stringp message) (not (string-match "\n" message)))
1380 ;; Trivial case where we can use the echo area
1381 (message "%s" message))
1382 ((and (stringp message)
1383 (= (string-match "\n" message) (1- (length message))))
1384 ;; Trivial case where we can just remove single trailing newline
1385 (message "%s" (substring message 0 (1- (length message)))))
1387 ;; General case
1388 (with-current-buffer
1389 (if (bufferp message)
1390 message
1391 (get-buffer-create (or buffer-name "*Message*")))
1393 (unless (bufferp message)
1394 (erase-buffer)
1395 (insert message))
1397 (let ((lines
1398 (if (= (buffer-size) 0)
1400 (count-lines (point-min) (point-max)))))
1401 (cond ((= lines 0))
1402 ((and (or (<= lines 1)
1403 (<= lines
1404 (if resize-mini-windows
1405 (cond ((floatp max-mini-window-height)
1406 (* (frame-height)
1407 max-mini-window-height))
1408 ((integerp max-mini-window-height)
1409 max-mini-window-height)
1412 1)))
1413 ;; Don't use the echo area if the output buffer is
1414 ;; already dispayed in the selected frame.
1415 (not (get-buffer-window (current-buffer))))
1416 ;; Echo area
1417 (goto-char (point-max))
1418 (when (bolp)
1419 (backward-char 1))
1420 (message "%s" (buffer-substring (point-min) (point))))
1422 ;; Buffer
1423 (goto-char (point-min))
1424 (display-buffer (current-buffer)
1425 not-this-window frame))))))))
1428 ;; We have a sentinel to prevent insertion of a termination message
1429 ;; in the buffer itself.
1430 (defun shell-command-sentinel (process signal)
1431 (if (memq (process-status process) '(exit signal))
1432 (message "%s: %s."
1433 (car (cdr (cdr (process-command process))))
1434 (substring signal 0 -1))))
1436 (defun shell-command-on-region (start end command
1437 &optional output-buffer replace
1438 error-buffer)
1439 "Execute string COMMAND in inferior shell with region as input.
1440 Normally display output (if any) in temp buffer `*Shell Command Output*';
1441 Prefix arg means replace the region with it. Return the exit code of
1442 COMMAND.
1444 To specify a coding system for converting non-ASCII characters
1445 in the input and output to the shell command, use \\[universal-coding-system-argument]
1446 before this command. By default, the input (from the current buffer)
1447 is encoded in the same coding system that will be used to save the file,
1448 `buffer-file-coding-system'. If the output is going to replace the region,
1449 then it is decoded from that same coding system.
1451 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1452 REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1453 systems by binding `coding-system-for-read' and
1454 `coding-system-for-write'.
1456 If the command generates output, the output may be displayed
1457 in the echo area or in a buffer.
1458 If the output is short enough to display in the echo area
1459 \(determined by the variable `max-mini-window-height' if
1460 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1461 it is displayed in the buffer `*Shell Command Output*'. The output
1462 is available in that buffer in both cases.
1464 If there is output and an error, a message about the error
1465 appears at the end of the output.
1467 If there is no output, or if output is inserted in the current buffer,
1468 then `*Shell Command Output*' is deleted.
1470 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1471 that says to put the output in some other buffer.
1472 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1473 If OUTPUT-BUFFER is not a buffer and not nil,
1474 insert output in the current buffer.
1475 In either case, the output is inserted after point (leaving mark after it).
1477 If REPLACE, the optional fifth argument, is non-nil, that means insert
1478 the output in place of text from START to END, putting point and mark
1479 around it.
1481 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1482 or buffer name to which to direct the command's standard error output.
1483 If it is nil, error output is mingled with regular output.
1484 In an interactive call, the variable `shell-command-default-error-buffer'
1485 specifies the value of ERROR-BUFFER."
1486 (interactive (let (string)
1487 (unless (mark)
1488 (error "The mark is not set now, so there is no region"))
1489 ;; Do this before calling region-beginning
1490 ;; and region-end, in case subprocess output
1491 ;; relocates them while we are in the minibuffer.
1492 (setq string (read-from-minibuffer "Shell command on region: "
1493 nil nil nil
1494 'shell-command-history))
1495 ;; call-interactively recognizes region-beginning and
1496 ;; region-end specially, leaving them in the history.
1497 (list (region-beginning) (region-end)
1498 string
1499 current-prefix-arg
1500 current-prefix-arg
1501 shell-command-default-error-buffer)))
1502 (let ((error-file
1503 (if error-buffer
1504 (make-temp-file
1505 (expand-file-name "scor"
1506 (or small-temporary-file-directory
1507 temporary-file-directory)))
1508 nil))
1509 exit-status)
1510 (if (or replace
1511 (and output-buffer
1512 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1513 ;; Replace specified region with output from command.
1514 (let ((swap (and replace (< start end))))
1515 ;; Don't muck with mark unless REPLACE says we should.
1516 (goto-char start)
1517 (and replace (push-mark (point) 'nomsg))
1518 (setq exit-status
1519 (call-process-region start end shell-file-name t
1520 (if error-file
1521 (list t error-file)
1523 nil shell-command-switch command))
1524 ;; It is rude to delete a buffer which the command is not using.
1525 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1526 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
1527 ;; (kill-buffer shell-buffer)))
1528 ;; Don't muck with mark unless REPLACE says we should.
1529 (and replace swap (exchange-point-and-mark)))
1530 ;; No prefix argument: put the output in a temp buffer,
1531 ;; replacing its entire contents.
1532 (let ((buffer (get-buffer-create
1533 (or output-buffer "*Shell Command Output*"))))
1534 (unwind-protect
1535 (if (eq buffer (current-buffer))
1536 ;; If the input is the same buffer as the output,
1537 ;; delete everything but the specified region,
1538 ;; then replace that region with the output.
1539 (progn (setq buffer-read-only nil)
1540 (delete-region (max start end) (point-max))
1541 (delete-region (point-min) (min start end))
1542 (setq exit-status
1543 (call-process-region (point-min) (point-max)
1544 shell-file-name t
1545 (if error-file
1546 (list t error-file)
1548 nil shell-command-switch
1549 command)))
1550 ;; Clear the output buffer, then run the command with
1551 ;; output there.
1552 (let ((directory default-directory))
1553 (save-excursion
1554 (set-buffer buffer)
1555 (setq buffer-read-only nil)
1556 (if (not output-buffer)
1557 (setq default-directory directory))
1558 (erase-buffer)))
1559 (setq exit-status
1560 (call-process-region start end shell-file-name nil
1561 (if error-file
1562 (list buffer error-file)
1563 buffer)
1564 nil shell-command-switch command)))
1565 ;; Report the output.
1566 (with-current-buffer buffer
1567 (setq mode-line-process
1568 (cond ((null exit-status)
1569 " - Error")
1570 ((stringp exit-status)
1571 (format " - Signal [%s]" exit-status))
1572 ((not (equal 0 exit-status))
1573 (format " - Exit [%d]" exit-status)))))
1574 (if (with-current-buffer buffer (> (point-max) (point-min)))
1575 ;; There's some output, display it
1576 (display-message-or-buffer buffer)
1577 ;; No output; error?
1578 (let ((output
1579 (if (and error-file
1580 (< 0 (nth 7 (file-attributes error-file))))
1581 "some error output"
1582 "no output")))
1583 (cond ((null exit-status)
1584 (message "(Shell command failed with error)"))
1585 ((equal 0 exit-status)
1586 (message "(Shell command succeeded with %s)"
1587 output))
1588 ((stringp exit-status)
1589 (message "(Shell command killed by signal %s)"
1590 exit-status))
1592 (message "(Shell command failed with code %d and %s)"
1593 exit-status output))))
1594 ;; Don't kill: there might be useful info in the undo-log.
1595 ;; (kill-buffer buffer)
1596 ))))
1598 (when (and error-file (file-exists-p error-file))
1599 (if (< 0 (nth 7 (file-attributes error-file)))
1600 (with-current-buffer (get-buffer-create error-buffer)
1601 (let ((pos-from-end (- (point-max) (point))))
1602 (or (bobp)
1603 (insert "\f\n"))
1604 ;; Do no formatting while reading error file,
1605 ;; because that can run a shell command, and we
1606 ;; don't want that to cause an infinite recursion.
1607 (format-insert-file error-file nil)
1608 ;; Put point after the inserted errors.
1609 (goto-char (- (point-max) pos-from-end)))
1610 (display-buffer (current-buffer))))
1611 (delete-file error-file))
1612 exit-status))
1614 (defun shell-command-to-string (command)
1615 "Execute shell command COMMAND and return its output as a string."
1616 (with-output-to-string
1617 (with-current-buffer
1618 standard-output
1619 (call-process shell-file-name nil t nil shell-command-switch command))))
1621 (defvar universal-argument-map
1622 (let ((map (make-sparse-keymap)))
1623 (define-key map [t] 'universal-argument-other-key)
1624 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1625 (define-key map [switch-frame] nil)
1626 (define-key map [?\C-u] 'universal-argument-more)
1627 (define-key map [?-] 'universal-argument-minus)
1628 (define-key map [?0] 'digit-argument)
1629 (define-key map [?1] 'digit-argument)
1630 (define-key map [?2] 'digit-argument)
1631 (define-key map [?3] 'digit-argument)
1632 (define-key map [?4] 'digit-argument)
1633 (define-key map [?5] 'digit-argument)
1634 (define-key map [?6] 'digit-argument)
1635 (define-key map [?7] 'digit-argument)
1636 (define-key map [?8] 'digit-argument)
1637 (define-key map [?9] 'digit-argument)
1638 (define-key map [kp-0] 'digit-argument)
1639 (define-key map [kp-1] 'digit-argument)
1640 (define-key map [kp-2] 'digit-argument)
1641 (define-key map [kp-3] 'digit-argument)
1642 (define-key map [kp-4] 'digit-argument)
1643 (define-key map [kp-5] 'digit-argument)
1644 (define-key map [kp-6] 'digit-argument)
1645 (define-key map [kp-7] 'digit-argument)
1646 (define-key map [kp-8] 'digit-argument)
1647 (define-key map [kp-9] 'digit-argument)
1648 (define-key map [kp-subtract] 'universal-argument-minus)
1649 map)
1650 "Keymap used while processing \\[universal-argument].")
1652 (defvar universal-argument-num-events nil
1653 "Number of argument-specifying events read by `universal-argument'.
1654 `universal-argument-other-key' uses this to discard those events
1655 from (this-command-keys), and reread only the final command.")
1657 (defun universal-argument ()
1658 "Begin a numeric argument for the following command.
1659 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1660 \\[universal-argument] following the digits or minus sign ends the argument.
1661 \\[universal-argument] without digits or minus sign provides 4 as argument.
1662 Repeating \\[universal-argument] without digits or minus sign
1663 multiplies the argument by 4 each time.
1664 For some commands, just \\[universal-argument] by itself serves as a flag
1665 which is different in effect from any particular numeric argument.
1666 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1667 (interactive)
1668 (setq prefix-arg (list 4))
1669 (setq universal-argument-num-events (length (this-command-keys)))
1670 (setq overriding-terminal-local-map universal-argument-map))
1672 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1673 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1674 (defun universal-argument-more (arg)
1675 (interactive "P")
1676 (if (consp arg)
1677 (setq prefix-arg (list (* 4 (car arg))))
1678 (if (eq arg '-)
1679 (setq prefix-arg (list -4))
1680 (setq prefix-arg arg)
1681 (setq overriding-terminal-local-map nil)))
1682 (setq universal-argument-num-events (length (this-command-keys))))
1684 (defun negative-argument (arg)
1685 "Begin a negative numeric argument for the next command.
1686 \\[universal-argument] following digits or minus sign ends the argument."
1687 (interactive "P")
1688 (cond ((integerp arg)
1689 (setq prefix-arg (- arg)))
1690 ((eq arg '-)
1691 (setq prefix-arg nil))
1693 (setq prefix-arg '-)))
1694 (setq universal-argument-num-events (length (this-command-keys)))
1695 (setq overriding-terminal-local-map universal-argument-map))
1697 (defun digit-argument (arg)
1698 "Part of the numeric argument for the next command.
1699 \\[universal-argument] following digits or minus sign ends the argument."
1700 (interactive "P")
1701 (let* ((char (if (integerp last-command-char)
1702 last-command-char
1703 (get last-command-char 'ascii-character)))
1704 (digit (- (logand char ?\177) ?0)))
1705 (cond ((integerp arg)
1706 (setq prefix-arg (+ (* arg 10)
1707 (if (< arg 0) (- digit) digit))))
1708 ((eq arg '-)
1709 ;; Treat -0 as just -, so that -01 will work.
1710 (setq prefix-arg (if (zerop digit) '- (- digit))))
1712 (setq prefix-arg digit))))
1713 (setq universal-argument-num-events (length (this-command-keys)))
1714 (setq overriding-terminal-local-map universal-argument-map))
1716 ;; For backward compatibility, minus with no modifiers is an ordinary
1717 ;; command if digits have already been entered.
1718 (defun universal-argument-minus (arg)
1719 (interactive "P")
1720 (if (integerp arg)
1721 (universal-argument-other-key arg)
1722 (negative-argument arg)))
1724 ;; Anything else terminates the argument and is left in the queue to be
1725 ;; executed as a command.
1726 (defun universal-argument-other-key (arg)
1727 (interactive "P")
1728 (setq prefix-arg arg)
1729 (let* ((key (this-command-keys))
1730 (keylist (listify-key-sequence key)))
1731 (setq unread-command-events
1732 (append (nthcdr universal-argument-num-events keylist)
1733 unread-command-events)))
1734 (reset-this-command-lengths)
1735 (setq overriding-terminal-local-map nil))
1737 ;;;; Window system cut and paste hooks.
1739 (defvar interprogram-cut-function nil
1740 "Function to call to make a killed region available to other programs.
1742 Most window systems provide some sort of facility for cutting and
1743 pasting text between the windows of different programs.
1744 This variable holds a function that Emacs calls whenever text
1745 is put in the kill ring, to make the new kill available to other
1746 programs.
1748 The function takes one or two arguments.
1749 The first argument, TEXT, is a string containing
1750 the text which should be made available.
1751 The second, PUSH, if non-nil means this is a \"new\" kill;
1752 nil means appending to an \"old\" kill.")
1754 (defvar interprogram-paste-function nil
1755 "Function to call to get text cut from other programs.
1757 Most window systems provide some sort of facility for cutting and
1758 pasting text between the windows of different programs.
1759 This variable holds a function that Emacs calls to obtain
1760 text that other programs have provided for pasting.
1762 The function should be called with no arguments. If the function
1763 returns nil, then no other program has provided such text, and the top
1764 of the Emacs kill ring should be used. If the function returns a
1765 string, that string should be put in the kill ring as the latest kill.
1767 Note that the function should return a string only if a program other
1768 than Emacs has provided a string for pasting; if Emacs provided the
1769 most recent string, the function should return nil. If it is
1770 difficult to tell whether Emacs or some other program provided the
1771 current string, it is probably good enough to return nil if the string
1772 is equal (according to `string=') to the last text Emacs provided.")
1776 ;;;; The kill ring data structure.
1778 (defvar kill-ring nil
1779 "List of killed text sequences.
1780 Since the kill ring is supposed to interact nicely with cut-and-paste
1781 facilities offered by window systems, use of this variable should
1782 interact nicely with `interprogram-cut-function' and
1783 `interprogram-paste-function'. The functions `kill-new',
1784 `kill-append', and `current-kill' are supposed to implement this
1785 interaction; you may want to use them instead of manipulating the kill
1786 ring directly.")
1788 (defcustom kill-ring-max 60
1789 "*Maximum length of kill ring before oldest elements are thrown away."
1790 :type 'integer
1791 :group 'killing)
1793 (defvar kill-ring-yank-pointer nil
1794 "The tail of the kill ring whose car is the last thing yanked.")
1796 (defun kill-new (string &optional replace yank-handler)
1797 "Make STRING the latest kill in the kill ring.
1798 Set `kill-ring-yank-pointer' to point to it.
1799 If `interprogram-cut-function' is non-nil, apply it to STRING.
1800 Optional second argument REPLACE non-nil means that STRING will replace
1801 the front of the kill ring, rather than being added to the list.
1803 Optional third arguments YANK-HANDLER controls how the STRING is later
1804 inserted into a buffer; see `insert-for-yank' for details.
1805 When a yank handler is specified, STRING must be non-empty (the yank
1806 handler is stored as a `yank-handler'text property on STRING).
1808 When the yank handler has a non-nil PARAM element, the original STRING
1809 argument is not used by `insert-for-yank'. However, since Lisp code
1810 may access and use elements from the kill-ring directly, the STRING
1811 argument should still be a \"useful\" string for such uses."
1812 (if (> (length string) 0)
1813 (if yank-handler
1814 (put-text-property 0 1 'yank-handler yank-handler string)
1815 (remove-list-of-text-properties 0 1 '(yank-handler) string))
1816 (if yank-handler
1817 (signal 'args-out-of-range
1818 (list string "yank-handler specified for empty string"))))
1819 (if (fboundp 'menu-bar-update-yank-menu)
1820 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1821 (if (and replace kill-ring)
1822 (setcar kill-ring string)
1823 (setq kill-ring (cons string kill-ring))
1824 (if (> (length kill-ring) kill-ring-max)
1825 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1826 (setq kill-ring-yank-pointer kill-ring)
1827 (if interprogram-cut-function
1828 (funcall interprogram-cut-function string (not replace))))
1830 (defun kill-append (string before-p &optional yank-handler)
1831 "Append STRING to the end of the latest kill in the kill ring.
1832 If BEFORE-P is non-nil, prepend STRING to the kill.
1833 Optional third argument YANK-HANDLER specifies the yank-handler text
1834 property to be set on the combined kill ring string. If the specified
1835 yank-handler arg differs from the yank-handler property of the latest
1836 kill string, STRING is added as a new kill ring element instead of
1837 being appending to the last kill.
1838 If `interprogram-cut-function' is set, pass the resulting kill to it."
1839 (let* ((cur (car kill-ring)))
1840 (kill-new (if before-p (concat string cur) (concat cur string))
1841 (or (= (length cur) 0)
1842 (equal yank-handler (get-text-property 0 'yank-handler cur)))
1843 yank-handler)))
1845 (defun current-kill (n &optional do-not-move)
1846 "Rotate the yanking point by N places, and then return that kill.
1847 If N is zero, `interprogram-paste-function' is set, and calling it
1848 returns a string, then that string is added to the front of the
1849 kill ring and returned as the latest kill.
1850 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1851 yanking point; just return the Nth kill forward."
1852 (let ((interprogram-paste (and (= n 0)
1853 interprogram-paste-function
1854 (funcall interprogram-paste-function))))
1855 (if interprogram-paste
1856 (progn
1857 ;; Disable the interprogram cut function when we add the new
1858 ;; text to the kill ring, so Emacs doesn't try to own the
1859 ;; selection, with identical text.
1860 (let ((interprogram-cut-function nil))
1861 (kill-new interprogram-paste))
1862 interprogram-paste)
1863 (or kill-ring (error "Kill ring is empty"))
1864 (let ((ARGth-kill-element
1865 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1866 (length kill-ring))
1867 kill-ring)))
1868 (or do-not-move
1869 (setq kill-ring-yank-pointer ARGth-kill-element))
1870 (car ARGth-kill-element)))))
1874 ;;;; Commands for manipulating the kill ring.
1876 (defcustom kill-read-only-ok nil
1877 "*Non-nil means don't signal an error for killing read-only text."
1878 :type 'boolean
1879 :group 'killing)
1881 (put 'text-read-only 'error-conditions
1882 '(text-read-only buffer-read-only error))
1883 (put 'text-read-only 'error-message "Text is read-only")
1885 (defun kill-region (beg end &optional yank-handler)
1886 "Kill between point and mark.
1887 The text is deleted but saved in the kill ring.
1888 The command \\[yank] can retrieve it from there.
1889 \(If you want to kill and then yank immediately, use \\[kill-ring-save].)
1891 If you want to append the killed region to the last killed text,
1892 use \\[append-next-kill] before \\[kill-region].
1894 If the buffer is read-only, Emacs will beep and refrain from deleting
1895 the text, but put the text in the kill ring anyway. This means that
1896 you can use the killing commands to copy text from a read-only buffer.
1898 This is the primitive for programs to kill text (as opposed to deleting it).
1899 Supply two arguments, character numbers indicating the stretch of text
1900 to be killed.
1901 Any command that calls this function is a \"kill command\".
1902 If the previous command was also a kill command,
1903 the text killed this time appends to the text killed last time
1904 to make one entry in the kill ring.
1906 In Lisp code, optional third arg YANK-HANDLER specifies the yank-handler
1907 text property to be set on the killed text. See `insert-for-yank'."
1908 (interactive "r")
1909 (condition-case nil
1910 (let ((string (delete-and-extract-region beg end)))
1911 (when string ;STRING is nil if BEG = END
1912 ;; Add that string to the kill ring, one way or another.
1913 (if (eq last-command 'kill-region)
1914 (kill-append string (< end beg) yank-handler)
1915 (kill-new string nil yank-handler)))
1916 (when (or string (eq last-command 'kill-region))
1917 (setq this-command 'kill-region)))
1918 ((buffer-read-only text-read-only)
1919 ;; The code above failed because the buffer, or some of the characters
1920 ;; in the region, are read-only.
1921 ;; We should beep, in case the user just isn't aware of this.
1922 ;; However, there's no harm in putting
1923 ;; the region's text in the kill ring, anyway.
1924 (copy-region-as-kill beg end)
1925 ;; Set this-command now, so it will be set even if we get an error.
1926 (setq this-command 'kill-region)
1927 ;; This should barf, if appropriate, and give us the correct error.
1928 (if kill-read-only-ok
1929 (message "Read only text copied to kill ring")
1930 ;; Signal an error if the buffer is read-only.
1931 (barf-if-buffer-read-only)
1932 ;; If the buffer isn't read-only, the text is.
1933 (signal 'text-read-only (list (current-buffer)))))))
1935 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1936 ;; to get two copies of the text when the user accidentally types M-w and
1937 ;; then corrects it with the intended C-w.
1938 (defun copy-region-as-kill (beg end)
1939 "Save the region as if killed, but don't kill it.
1940 In Transient Mark mode, deactivate the mark.
1941 If `interprogram-cut-function' is non-nil, also save the text for a window
1942 system cut and paste."
1943 (interactive "r")
1944 (if (eq last-command 'kill-region)
1945 (kill-append (buffer-substring beg end) (< end beg))
1946 (kill-new (buffer-substring beg end)))
1947 (if transient-mark-mode
1948 (setq deactivate-mark t))
1949 nil)
1951 (defun kill-ring-save (beg end)
1952 "Save the region as if killed, but don't kill it.
1953 In Transient Mark mode, deactivate the mark.
1954 If `interprogram-cut-function' is non-nil, also save the text for a window
1955 system cut and paste.
1957 If you want to append the killed line to the last killed text,
1958 use \\[append-next-kill] before \\[kill-ring-save].
1960 This command is similar to `copy-region-as-kill', except that it gives
1961 visual feedback indicating the extent of the region being copied."
1962 (interactive "r")
1963 (copy-region-as-kill beg end)
1964 (if (interactive-p)
1965 (let ((other-end (if (= (point) beg) end beg))
1966 (opoint (point))
1967 ;; Inhibit quitting so we can make a quit here
1968 ;; look like a C-g typed as a command.
1969 (inhibit-quit t))
1970 (if (pos-visible-in-window-p other-end (selected-window))
1971 (unless transient-mark-mode
1972 ;; Swap point and mark.
1973 (set-marker (mark-marker) (point) (current-buffer))
1974 (goto-char other-end)
1975 (sit-for 1)
1976 ;; Swap back.
1977 (set-marker (mark-marker) other-end (current-buffer))
1978 (goto-char opoint)
1979 ;; If user quit, deactivate the mark
1980 ;; as C-g would as a command.
1981 (and quit-flag mark-active
1982 (deactivate-mark)))
1983 (let* ((killed-text (current-kill 0))
1984 (message-len (min (length killed-text) 40)))
1985 (if (= (point) beg)
1986 ;; Don't say "killed"; that is misleading.
1987 (message "Saved text until \"%s\""
1988 (substring killed-text (- message-len)))
1989 (message "Saved text from \"%s\""
1990 (substring killed-text 0 message-len))))))))
1992 (defun append-next-kill (&optional interactive)
1993 "Cause following command, if it kills, to append to previous kill.
1994 The argument is used for internal purposes; do not supply one."
1995 (interactive "p")
1996 ;; We don't use (interactive-p), since that breaks kbd macros.
1997 (if interactive
1998 (progn
1999 (setq this-command 'kill-region)
2000 (message "If the next command is a kill, it will append"))
2001 (setq last-command 'kill-region)))
2003 ;; Yanking.
2005 ;; This is actually used in subr.el but defcustom does not work there.
2006 (defcustom yank-excluded-properties
2007 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2008 yank-handler)
2009 "*Text properties to discard when yanking."
2010 :type '(choice (const :tag "All" t) (repeat symbol))
2011 :group 'editing
2012 :version "21.4")
2014 (defvar yank-window-start nil)
2015 (defvar yank-undo-function nil
2016 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2017 Function is called with two parameters, START and END corresponding to
2018 the value of the mark and point; it is guaranteed that START <= END.
2019 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2021 (defun yank-pop (arg)
2022 "Replace just-yanked stretch of killed text with a different stretch.
2023 This command is allowed only immediately after a `yank' or a `yank-pop'.
2024 At such a time, the region contains a stretch of reinserted
2025 previously-killed text. `yank-pop' deletes that text and inserts in its
2026 place a different stretch of killed text.
2028 With no argument, the previous kill is inserted.
2029 With argument N, insert the Nth previous kill.
2030 If N is negative, this is a more recent kill.
2032 The sequence of kills wraps around, so that after the oldest one
2033 comes the newest one."
2034 (interactive "*p")
2035 (if (not (eq last-command 'yank))
2036 (error "Previous command was not a yank"))
2037 (setq this-command 'yank)
2038 (let ((inhibit-read-only t)
2039 (before (< (point) (mark t))))
2040 (if before
2041 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2042 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2043 (setq yank-undo-function nil)
2044 (set-marker (mark-marker) (point) (current-buffer))
2045 (insert-for-yank (current-kill arg))
2046 ;; Set the window start back where it was in the yank command,
2047 ;; if possible.
2048 (set-window-start (selected-window) yank-window-start t)
2049 (if before
2050 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2051 ;; It is cleaner to avoid activation, even though the command
2052 ;; loop would deactivate the mark because we inserted text.
2053 (goto-char (prog1 (mark t)
2054 (set-marker (mark-marker) (point) (current-buffer))))))
2055 nil)
2057 (defun yank (&optional arg)
2058 "Reinsert the last stretch of killed text.
2059 More precisely, reinsert the stretch of killed text most recently
2060 killed OR yanked. Put point at end, and set mark at beginning.
2061 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2062 With argument N, reinsert the Nth most recently killed stretch of killed
2063 text.
2064 See also the command \\[yank-pop]."
2065 (interactive "*P")
2066 (setq yank-window-start (window-start))
2067 ;; If we don't get all the way thru, make last-command indicate that
2068 ;; for the following command.
2069 (setq this-command t)
2070 (push-mark (point))
2071 (insert-for-yank (current-kill (cond
2072 ((listp arg) 0)
2073 ((eq arg '-) -1)
2074 (t (1- arg)))))
2075 (if (consp arg)
2076 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2077 ;; It is cleaner to avoid activation, even though the command
2078 ;; loop would deactivate the mark because we inserted text.
2079 (goto-char (prog1 (mark t)
2080 (set-marker (mark-marker) (point) (current-buffer)))))
2081 ;; If we do get all the way thru, make this-command indicate that.
2082 (if (eq this-command t)
2083 (setq this-command 'yank))
2084 nil)
2086 (defun rotate-yank-pointer (arg)
2087 "Rotate the yanking point in the kill ring.
2088 With argument, rotate that many kills forward (or backward, if negative)."
2089 (interactive "p")
2090 (current-kill arg))
2092 ;; Some kill commands.
2094 ;; Internal subroutine of delete-char
2095 (defun kill-forward-chars (arg)
2096 (if (listp arg) (setq arg (car arg)))
2097 (if (eq arg '-) (setq arg -1))
2098 (kill-region (point) (forward-point arg)))
2100 ;; Internal subroutine of backward-delete-char
2101 (defun kill-backward-chars (arg)
2102 (if (listp arg) (setq arg (car arg)))
2103 (if (eq arg '-) (setq arg -1))
2104 (kill-region (point) (forward-point (- arg))))
2106 (defcustom backward-delete-char-untabify-method 'untabify
2107 "*The method for untabifying when deleting backward.
2108 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2109 `hungry' -- delete all whitespace, both tabs and spaces;
2110 `all' -- delete all whitespace, including tabs, spaces and newlines;
2111 nil -- just delete one character."
2112 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2113 :version "20.3"
2114 :group 'killing)
2116 (defun backward-delete-char-untabify (arg &optional killp)
2117 "Delete characters backward, changing tabs into spaces.
2118 The exact behavior depends on `backward-delete-char-untabify-method'.
2119 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2120 Interactively, ARG is the prefix arg (default 1)
2121 and KILLP is t if a prefix arg was specified."
2122 (interactive "*p\nP")
2123 (when (eq backward-delete-char-untabify-method 'untabify)
2124 (let ((count arg))
2125 (save-excursion
2126 (while (and (> count 0) (not (bobp)))
2127 (if (= (preceding-char) ?\t)
2128 (let ((col (current-column)))
2129 (forward-char -1)
2130 (setq col (- col (current-column)))
2131 (insert-char ?\ col)
2132 (delete-char 1)))
2133 (forward-char -1)
2134 (setq count (1- count))))))
2135 (delete-backward-char
2136 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
2137 ((eq backward-delete-char-untabify-method 'all)
2138 " \t\n\r"))))
2139 (if skip
2140 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2141 (point)))))
2142 (+ arg (if (zerop wh) 0 (1- wh))))
2143 arg))
2144 killp))
2146 (defun zap-to-char (arg char)
2147 "Kill up to and including ARG'th occurrence of CHAR.
2148 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2149 Goes backward if ARG is negative; error if CHAR not found."
2150 (interactive "p\ncZap to char: ")
2151 (kill-region (point) (progn
2152 (search-forward (char-to-string char) nil nil arg)
2153 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2154 (point))))
2156 ;; kill-line and its subroutines.
2158 (defcustom kill-whole-line nil
2159 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2160 :type 'boolean
2161 :group 'killing)
2163 (defun kill-line (&optional arg)
2164 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2165 With prefix argument, kill that many lines from point.
2166 Negative arguments kill lines backward.
2167 With zero argument, kills the text before point on the current line.
2169 When calling from a program, nil means \"no arg\",
2170 a number counts as a prefix arg.
2172 To kill a whole line, when point is not at the beginning, type \
2173 \\[beginning-of-line] \\[kill-line] \\[kill-line].
2175 If `kill-whole-line' is non-nil, then this command kills the whole line
2176 including its terminating newline, when used at the beginning of a line
2177 with no argument. As a consequence, you can always kill a whole line
2178 by typing \\[beginning-of-line] \\[kill-line].
2180 If you want to append the killed line to the last killed text,
2181 use \\[append-next-kill] before \\[kill-line].
2183 If the buffer is read-only, Emacs will beep and refrain from deleting
2184 the line, but put the line in the kill ring anyway. This means that
2185 you can use this command to copy text from a read-only buffer.
2186 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2187 even beep.)"
2188 (interactive "P")
2189 (kill-region (point)
2190 ;; It is better to move point to the other end of the kill
2191 ;; before killing. That way, in a read-only buffer, point
2192 ;; moves across the text that is copied to the kill ring.
2193 ;; The choice has no effect on undo now that undo records
2194 ;; the value of point from before the command was run.
2195 (progn
2196 (if arg
2197 (forward-visible-line (prefix-numeric-value arg))
2198 (if (eobp)
2199 (signal 'end-of-buffer nil))
2200 (let ((end
2201 (save-excursion
2202 (end-of-visible-line) (point))))
2203 (if (or (save-excursion
2204 (skip-chars-forward " \t" end)
2205 (= (point) end))
2206 (and kill-whole-line (bolp)))
2207 (forward-visible-line 1)
2208 (goto-char end))))
2209 (point))))
2211 (defun kill-whole-line (&optional arg)
2212 "Kill current line.
2213 With prefix arg, kill that many lines starting from the current line.
2214 If arg is negative, kill backward. Also kill the preceding newline.
2215 \(This is meant to make C-x z work well with negative arguments.\)
2216 If arg is zero, kill current line but exclude the trailing newline."
2217 (interactive "P")
2218 (setq arg (prefix-numeric-value arg))
2219 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2220 (signal 'end-of-buffer nil))
2221 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2222 (signal 'beginning-of-buffer nil))
2223 (unless (eq last-command 'kill-region)
2224 (kill-new "")
2225 (setq last-command 'kill-region))
2226 (cond ((zerop arg)
2227 ;; We need to kill in two steps, because the previous command
2228 ;; could have been a kill command, in which case the text
2229 ;; before point needs to be prepended to the current kill
2230 ;; ring entry and the text after point appended. Also, we
2231 ;; need to use save-excursion to avoid copying the same text
2232 ;; twice to the kill ring in read-only buffers.
2233 (save-excursion
2234 (kill-region (point) (progn (forward-visible-line 0) (point))))
2235 (kill-region (point) (progn (end-of-visible-line) (point))))
2236 ((< arg 0)
2237 (save-excursion
2238 (kill-region (point) (progn (end-of-visible-line) (point))))
2239 (kill-region (point)
2240 (progn (forward-visible-line (1+ arg))
2241 (unless (bobp) (backward-char))
2242 (point))))
2244 (save-excursion
2245 (kill-region (point) (progn (forward-visible-line 0) (point))))
2246 (kill-region (point)
2247 (progn (forward-visible-line arg) (point))))))
2249 (defun forward-visible-line (arg)
2250 "Move forward by ARG lines, ignoring currently invisible newlines only.
2251 If ARG is negative, move backward -ARG lines.
2252 If ARG is zero, move to the beginning of the current line."
2253 (condition-case nil
2254 (if (> arg 0)
2255 (progn
2256 (while (> arg 0)
2257 (or (zerop (forward-line 1))
2258 (signal 'end-of-buffer nil))
2259 ;; If the newline we just skipped is invisible,
2260 ;; don't count it.
2261 (let ((prop
2262 (get-char-property (1- (point)) 'invisible)))
2263 (if (if (eq buffer-invisibility-spec t)
2264 prop
2265 (or (memq prop buffer-invisibility-spec)
2266 (assq prop buffer-invisibility-spec)))
2267 (setq arg (1+ arg))))
2268 (setq arg (1- arg)))
2269 ;; If invisible text follows, and it is a number of complete lines,
2270 ;; skip it.
2271 (let ((opoint (point)))
2272 (while (and (not (eobp))
2273 (let ((prop
2274 (get-char-property (point) 'invisible)))
2275 (if (eq buffer-invisibility-spec t)
2276 prop
2277 (or (memq prop buffer-invisibility-spec)
2278 (assq prop buffer-invisibility-spec)))))
2279 (goto-char
2280 (if (get-text-property (point) 'invisible)
2281 (or (next-single-property-change (point) 'invisible)
2282 (point-max))
2283 (next-overlay-change (point)))))
2284 (unless (bolp)
2285 (goto-char opoint))))
2286 (let ((first t))
2287 (while (or first (<= arg 0))
2288 (if first
2289 (beginning-of-line)
2290 (or (zerop (forward-line -1))
2291 (signal 'beginning-of-buffer nil)))
2292 ;; If the newline we just moved to is invisible,
2293 ;; don't count it.
2294 (unless (bobp)
2295 (let ((prop
2296 (get-char-property (1- (point)) 'invisible)))
2297 (unless (if (eq buffer-invisibility-spec t)
2298 prop
2299 (or (memq prop buffer-invisibility-spec)
2300 (assq prop buffer-invisibility-spec)))
2301 (setq arg (1+ arg)))))
2302 (setq first nil))
2303 ;; If invisible text follows, and it is a number of complete lines,
2304 ;; skip it.
2305 (let ((opoint (point)))
2306 (while (and (not (bobp))
2307 (let ((prop
2308 (get-char-property (1- (point)) 'invisible)))
2309 (if (eq buffer-invisibility-spec t)
2310 prop
2311 (or (memq prop buffer-invisibility-spec)
2312 (assq prop buffer-invisibility-spec)))))
2313 (goto-char
2314 (if (get-text-property (1- (point)) 'invisible)
2315 (or (previous-single-property-change (point) 'invisible)
2316 (point-min))
2317 (previous-overlay-change (point)))))
2318 (unless (bolp)
2319 (goto-char opoint)))))
2320 ((beginning-of-buffer end-of-buffer)
2321 nil)))
2323 (defun end-of-visible-line ()
2324 "Move to end of current visible line."
2325 (end-of-line)
2326 ;; If the following character is currently invisible,
2327 ;; skip all characters with that same `invisible' property value,
2328 ;; then find the next newline.
2329 (while (and (not (eobp))
2330 (save-excursion
2331 (skip-chars-forward "^\n")
2332 (let ((prop
2333 (get-char-property (point) 'invisible)))
2334 (if (eq buffer-invisibility-spec t)
2335 prop
2336 (or (memq prop buffer-invisibility-spec)
2337 (assq prop buffer-invisibility-spec))))))
2338 (skip-chars-forward "^\n")
2339 (if (get-text-property (point) 'invisible)
2340 (goto-char (next-single-property-change (point) 'invisible))
2341 (goto-char (next-overlay-change (point))))
2342 (end-of-line)))
2344 (defun insert-buffer (buffer)
2345 "Insert after point the contents of BUFFER.
2346 Puts mark after the inserted text.
2347 BUFFER may be a buffer or a buffer name.
2349 This function is meant for the user to run interactively.
2350 Don't call it from programs: use `insert-buffer-substring' instead!"
2351 (interactive
2352 (list
2353 (progn
2354 (barf-if-buffer-read-only)
2355 (read-buffer "Insert buffer: "
2356 (if (eq (selected-window) (next-window (selected-window)))
2357 (other-buffer (current-buffer))
2358 (window-buffer (next-window (selected-window))))
2359 t))))
2360 (push-mark
2361 (save-excursion
2362 (insert-buffer-substring (get-buffer buffer))
2363 (point)))
2364 nil)
2366 (defun append-to-buffer (buffer start end)
2367 "Append to specified buffer the text of the region.
2368 It is inserted into that buffer before its point.
2370 When calling from a program, give three arguments:
2371 BUFFER (or buffer name), START and END.
2372 START and END specify the portion of the current buffer to be copied."
2373 (interactive
2374 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2375 (region-beginning) (region-end)))
2376 (let ((oldbuf (current-buffer)))
2377 (save-excursion
2378 (let* ((append-to (get-buffer-create buffer))
2379 (windows (get-buffer-window-list append-to t t))
2380 point)
2381 (set-buffer append-to)
2382 (setq point (point))
2383 (barf-if-buffer-read-only)
2384 (insert-buffer-substring oldbuf start end)
2385 (dolist (window windows)
2386 (when (= (window-point window) point)
2387 (set-window-point window (point))))))))
2389 (defun prepend-to-buffer (buffer start end)
2390 "Prepend to specified buffer the text of the region.
2391 It is inserted into that buffer after its point.
2393 When calling from a program, give three arguments:
2394 BUFFER (or buffer name), START and END.
2395 START and END specify the portion of the current buffer to be copied."
2396 (interactive "BPrepend to buffer: \nr")
2397 (let ((oldbuf (current-buffer)))
2398 (save-excursion
2399 (set-buffer (get-buffer-create buffer))
2400 (barf-if-buffer-read-only)
2401 (save-excursion
2402 (insert-buffer-substring oldbuf start end)))))
2404 (defun copy-to-buffer (buffer start end)
2405 "Copy to specified buffer the text of the region.
2406 It is inserted into that buffer, replacing existing text there.
2408 When calling from a program, give three arguments:
2409 BUFFER (or buffer name), START and END.
2410 START and END specify the portion of the current buffer to be copied."
2411 (interactive "BCopy to buffer: \nr")
2412 (let ((oldbuf (current-buffer)))
2413 (save-excursion
2414 (set-buffer (get-buffer-create buffer))
2415 (barf-if-buffer-read-only)
2416 (erase-buffer)
2417 (save-excursion
2418 (insert-buffer-substring oldbuf start end)))))
2420 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2421 (put 'mark-inactive 'error-message "The mark is not active now")
2423 (defun mark (&optional force)
2424 "Return this buffer's mark value as integer; error if mark inactive.
2425 If optional argument FORCE is non-nil, access the mark value
2426 even if the mark is not currently active, and return nil
2427 if there is no mark at all.
2429 If you are using this in an editing command, you are most likely making
2430 a mistake; see the documentation of `set-mark'."
2431 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2432 (marker-position (mark-marker))
2433 (signal 'mark-inactive nil)))
2435 ;; Many places set mark-active directly, and several of them failed to also
2436 ;; run deactivate-mark-hook. This shorthand should simplify.
2437 (defsubst deactivate-mark ()
2438 "Deactivate the mark by setting `mark-active' to nil.
2439 \(That makes a difference only in Transient Mark mode.)
2440 Also runs the hook `deactivate-mark-hook'."
2441 (cond
2442 ((eq transient-mark-mode 'lambda)
2443 (setq transient-mark-mode nil))
2444 (transient-mark-mode
2445 (setq mark-active nil)
2446 (run-hooks 'deactivate-mark-hook))))
2448 (defun set-mark (pos)
2449 "Set this buffer's mark to POS. Don't use this function!
2450 That is to say, don't use this function unless you want
2451 the user to see that the mark has moved, and you want the previous
2452 mark position to be lost.
2454 Normally, when a new mark is set, the old one should go on the stack.
2455 This is why most applications should use push-mark, not set-mark.
2457 Novice Emacs Lisp programmers often try to use the mark for the wrong
2458 purposes. The mark saves a location for the user's convenience.
2459 Most editing commands should not alter the mark.
2460 To remember a location for internal use in the Lisp program,
2461 store it in a Lisp variable. Example:
2463 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2465 (if pos
2466 (progn
2467 (setq mark-active t)
2468 (run-hooks 'activate-mark-hook)
2469 (set-marker (mark-marker) pos (current-buffer)))
2470 ;; Normally we never clear mark-active except in Transient Mark mode.
2471 ;; But when we actually clear out the mark value too,
2472 ;; we must clear mark-active in any mode.
2473 (setq mark-active nil)
2474 (run-hooks 'deactivate-mark-hook)
2475 (set-marker (mark-marker) nil)))
2477 (defvar mark-ring nil
2478 "The list of former marks of the current buffer, most recent first.")
2479 (make-variable-buffer-local 'mark-ring)
2480 (put 'mark-ring 'permanent-local t)
2482 (defcustom mark-ring-max 16
2483 "*Maximum size of mark ring. Start discarding off end if gets this big."
2484 :type 'integer
2485 :group 'editing-basics)
2487 (defvar global-mark-ring nil
2488 "The list of saved global marks, most recent first.")
2490 (defcustom global-mark-ring-max 16
2491 "*Maximum size of global mark ring. \
2492 Start discarding off end if gets this big."
2493 :type 'integer
2494 :group 'editing-basics)
2496 (defun pop-to-mark-command ()
2497 "Jump to mark, and pop a new position for mark off the ring
2498 \(does not affect global mark ring\)."
2499 (interactive)
2500 (if (null (mark t))
2501 (error "No mark set in this buffer")
2502 (goto-char (mark t))
2503 (pop-mark)))
2505 (defun push-mark-command (arg &optional nomsg)
2506 "Set mark at where point is.
2507 If no prefix arg and mark is already set there, just activate it.
2508 Display `Mark set' unless the optional second arg NOMSG is non-nil."
2509 (interactive "P")
2510 (let ((mark (marker-position (mark-marker))))
2511 (if (or arg (null mark) (/= mark (point)))
2512 (push-mark nil nomsg t)
2513 (setq mark-active t)
2514 (unless nomsg
2515 (message "Mark activated")))))
2517 (defun set-mark-command (arg)
2518 "Set mark at where point is, or jump to mark.
2519 With no prefix argument, set mark, and push old mark position on local
2520 mark ring; also push mark on global mark ring if last mark was set in
2521 another buffer. Immediately repeating the command activates
2522 `transient-mark-mode' temporarily.
2524 With argument, e.g. \\[universal-argument] \\[set-mark-command], \
2525 jump to mark, and pop a new position
2526 for mark off the local mark ring \(this does not affect the global
2527 mark ring\). Use \\[pop-global-mark] to jump to a mark off the global
2528 mark ring \(see `pop-global-mark'\).
2530 Repeating the \\[set-mark-command] command without the prefix jumps to
2531 the next position off the local (or global) mark ring.
2533 With a double \\[universal-argument] prefix argument, e.g. \\[universal-argument] \
2534 \\[universal-argument] \\[set-mark-command], unconditionally
2535 set mark where point is.
2537 Novice Emacs Lisp programmers often try to use the mark for the wrong
2538 purposes. See the documentation of `set-mark' for more information."
2539 (interactive "P")
2540 (if (eq transient-mark-mode 'lambda)
2541 (setq transient-mark-mode nil))
2542 (cond
2543 ((and (consp arg) (> (prefix-numeric-value arg) 4))
2544 (push-mark-command nil))
2545 ((not (eq this-command 'set-mark-command))
2546 (if arg
2547 (pop-to-mark-command)
2548 (push-mark-command t)))
2549 ((eq last-command 'pop-to-mark-command)
2550 (setq this-command 'pop-to-mark-command)
2551 (pop-to-mark-command))
2552 ((and (eq last-command 'pop-global-mark) (not arg))
2553 (setq this-command 'pop-global-mark)
2554 (pop-global-mark))
2555 (arg
2556 (setq this-command 'pop-to-mark-command)
2557 (pop-to-mark-command))
2558 ((and (eq last-command 'set-mark-command)
2559 mark-active (null transient-mark-mode))
2560 (setq transient-mark-mode 'lambda)
2561 (message "Transient-mark-mode temporarily enabled"))
2563 (push-mark-command nil))))
2565 (defun push-mark (&optional location nomsg activate)
2566 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
2567 If the last global mark pushed was not in the current buffer,
2568 also push LOCATION on the global mark ring.
2569 Display `Mark set' unless the optional second arg NOMSG is non-nil.
2570 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2572 Novice Emacs Lisp programmers often try to use the mark for the wrong
2573 purposes. See the documentation of `set-mark' for more information.
2575 In Transient Mark mode, this does not activate the mark."
2576 (if (null (mark t))
2578 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2579 (if (> (length mark-ring) mark-ring-max)
2580 (progn
2581 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2582 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
2583 (set-marker (mark-marker) (or location (point)) (current-buffer))
2584 ;; Now push the mark on the global mark ring.
2585 (if (and global-mark-ring
2586 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
2587 ;; The last global mark pushed was in this same buffer.
2588 ;; Don't push another one.
2590 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
2591 (if (> (length global-mark-ring) global-mark-ring-max)
2592 (progn
2593 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2594 nil)
2595 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2596 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2597 (message "Mark set"))
2598 (if (or activate (not transient-mark-mode))
2599 (set-mark (mark t)))
2600 nil)
2602 (defun pop-mark ()
2603 "Pop off mark ring into the buffer's actual mark.
2604 Does not set point. Does nothing if mark ring is empty."
2605 (if mark-ring
2606 (progn
2607 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
2608 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
2609 (deactivate-mark)
2610 (move-marker (car mark-ring) nil)
2611 (if (null (mark t)) (ding))
2612 (setq mark-ring (cdr mark-ring)))))
2614 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2615 (defun exchange-point-and-mark (&optional arg)
2616 "Put the mark where point is now, and point where the mark is now.
2617 This command works even when the mark is not active,
2618 and it reactivates the mark.
2619 With prefix arg, `transient-mark-mode' is enabled temporarily."
2620 (interactive "P")
2621 (if arg
2622 (if mark-active
2623 (if (null transient-mark-mode)
2624 (setq transient-mark-mode 'lambda))
2625 (setq arg nil)))
2626 (unless arg
2627 (let ((omark (mark t)))
2628 (if (null omark)
2629 (error "No mark set in this buffer"))
2630 (set-mark (point))
2631 (goto-char omark)
2632 nil)))
2634 (define-minor-mode transient-mark-mode
2635 "Toggle Transient Mark mode.
2636 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
2638 In Transient Mark mode, when the mark is active, the region is highlighted.
2639 Changing the buffer \"deactivates\" the mark.
2640 So do certain other operations that set the mark
2641 but whose main purpose is something else--for example,
2642 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
2644 You can also deactivate the mark by typing \\[keyboard-quit] or
2645 \\[keyboard-escape-quit].
2647 Many commands change their behavior when Transient Mark mode is in effect
2648 and the mark is active, by acting on the region instead of their usual
2649 default part of the buffer's text. Examples of such commands include
2650 \\[comment-dwim], \\[flush-lines], \\[ispell], \\[keep-lines],
2651 \\[query-replace], \\[query-replace-regexp], and \\[undo]. Invoke
2652 \\[apropos-documentation] and type \"transient\" or \"mark.*active\" at
2653 the prompt, to see the documentation of commands which are sensitive to
2654 the Transient Mark mode."
2655 :global t :group 'editing-basics :require nil)
2657 (defun pop-global-mark ()
2658 "Pop off global mark ring and jump to the top location."
2659 (interactive)
2660 ;; Pop entries which refer to non-existent buffers.
2661 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2662 (setq global-mark-ring (cdr global-mark-ring)))
2663 (or global-mark-ring
2664 (error "No global mark set"))
2665 (let* ((marker (car global-mark-ring))
2666 (buffer (marker-buffer marker))
2667 (position (marker-position marker)))
2668 (setq global-mark-ring (nconc (cdr global-mark-ring)
2669 (list (car global-mark-ring))))
2670 (set-buffer buffer)
2671 (or (and (>= position (point-min))
2672 (<= position (point-max)))
2673 (widen))
2674 (goto-char position)
2675 (switch-to-buffer buffer)))
2677 (defcustom next-line-add-newlines nil
2678 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2679 :type 'boolean
2680 :version "21.1"
2681 :group 'editing-basics)
2683 (defun next-line (&optional arg)
2684 "Move cursor vertically down ARG lines.
2685 If there is no character in the target line exactly under the current column,
2686 the cursor is positioned after the character in that line which spans this
2687 column, or at the end of the line if it is not long enough.
2688 If there is no line in the buffer after this one, behavior depends on the
2689 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2690 to create a line, and moves the cursor to that line. Otherwise it moves the
2691 cursor to the end of the buffer.
2693 The command \\[set-goal-column] can be used to create
2694 a semipermanent goal column for this command.
2695 Then instead of trying to move exactly vertically (or as close as possible),
2696 this command moves to the specified goal column (or as close as possible).
2697 The goal column is stored in the variable `goal-column', which is nil
2698 when there is no goal column.
2700 If you are thinking of using this in a Lisp program, consider
2701 using `forward-line' instead. It is usually easier to use
2702 and more reliable (no dependence on goal column, etc.)."
2703 (interactive "p")
2704 (unless arg (setq arg 1))
2705 (if (and next-line-add-newlines (= arg 1))
2706 (if (save-excursion (end-of-line) (eobp))
2707 ;; When adding a newline, don't expand an abbrev.
2708 (let ((abbrev-mode nil))
2709 (end-of-line)
2710 (insert "\n"))
2711 (line-move arg))
2712 (if (interactive-p)
2713 (condition-case nil
2714 (line-move arg)
2715 ((beginning-of-buffer end-of-buffer) (ding)))
2716 (line-move arg)))
2717 nil)
2719 (defun previous-line (&optional arg)
2720 "Move cursor vertically up ARG lines.
2721 If there is no character in the target line exactly over the current column,
2722 the cursor is positioned after the character in that line which spans this
2723 column, or at the end of the line if it is not long enough.
2725 The command \\[set-goal-column] can be used to create
2726 a semipermanent goal column for this command.
2727 Then instead of trying to move exactly vertically (or as close as possible),
2728 this command moves to the specified goal column (or as close as possible).
2729 The goal column is stored in the variable `goal-column', which is nil
2730 when there is no goal column.
2732 If you are thinking of using this in a Lisp program, consider using
2733 `forward-line' with a negative argument instead. It is usually easier
2734 to use and more reliable (no dependence on goal column, etc.)."
2735 (interactive "p")
2736 (unless arg (setq arg 1))
2737 (if (interactive-p)
2738 (condition-case nil
2739 (line-move (- arg))
2740 ((beginning-of-buffer end-of-buffer) (ding)))
2741 (line-move (- arg)))
2742 nil)
2744 (defcustom track-eol nil
2745 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2746 This means moving to the end of each line moved onto.
2747 The beginning of a blank line does not count as the end of a line."
2748 :type 'boolean
2749 :group 'editing-basics)
2751 (defcustom goal-column nil
2752 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2753 :type '(choice integer
2754 (const :tag "None" nil))
2755 :group 'editing-basics)
2756 (make-variable-buffer-local 'goal-column)
2758 (defvar temporary-goal-column 0
2759 "Current goal column for vertical motion.
2760 It is the column where point was
2761 at the start of current run of vertical motion commands.
2762 When the `track-eol' feature is doing its job, the value is 9999.")
2764 (defcustom line-move-ignore-invisible nil
2765 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2766 Outline mode sets this."
2767 :type 'boolean
2768 :group 'editing-basics)
2770 (defun line-move-invisible (pos)
2771 "Return non-nil if the character after POS is currently invisible."
2772 (let ((prop
2773 (get-char-property pos 'invisible)))
2774 (if (eq buffer-invisibility-spec t)
2775 prop
2776 (or (memq prop buffer-invisibility-spec)
2777 (assq prop buffer-invisibility-spec)))))
2779 ;; This is the guts of next-line and previous-line.
2780 ;; Arg says how many lines to move.
2781 (defun line-move (arg)
2782 ;; Don't run any point-motion hooks, and disregard intangibility,
2783 ;; for intermediate positions.
2784 (let ((inhibit-point-motion-hooks t)
2785 (opoint (point))
2786 new line-end line-beg)
2787 (unwind-protect
2788 (progn
2789 (if (not (memq last-command '(next-line previous-line)))
2790 (setq temporary-goal-column
2791 (if (and track-eol (eolp)
2792 ;; Don't count beg of empty line as end of line
2793 ;; unless we just did explicit end-of-line.
2794 (or (not (bolp)) (eq last-command 'end-of-line)))
2795 9999
2796 (current-column))))
2797 (if (and (not (integerp selective-display))
2798 (not line-move-ignore-invisible))
2799 ;; Use just newline characters.
2800 ;; Set ARG to 0 if we move as many lines as requested.
2801 (or (if (> arg 0)
2802 (progn (if (> arg 1) (forward-line (1- arg)))
2803 ;; This way of moving forward ARG lines
2804 ;; verifies that we have a newline after the last one.
2805 ;; It doesn't get confused by intangible text.
2806 (end-of-line)
2807 (if (zerop (forward-line 1))
2808 (setq arg 0)))
2809 (and (zerop (forward-line arg))
2810 (bolp)
2811 (setq arg 0)))
2812 (signal (if (< arg 0)
2813 'beginning-of-buffer
2814 'end-of-buffer)
2815 nil))
2816 ;; Move by arg lines, but ignore invisible ones.
2817 (while (> arg 0)
2818 ;; If the following character is currently invisible,
2819 ;; skip all characters with that same `invisible' property value.
2820 (while (and (not (eobp)) (line-move-invisible (point)))
2821 (goto-char (next-char-property-change (point))))
2822 ;; Now move a line.
2823 (end-of-line)
2824 (and (zerop (vertical-motion 1))
2825 (signal 'end-of-buffer nil))
2826 (setq arg (1- arg)))
2827 (while (< arg 0)
2828 (beginning-of-line)
2829 (and (zerop (vertical-motion -1))
2830 (signal 'beginning-of-buffer nil))
2831 (setq arg (1+ arg))
2832 (while (and (not (bobp)) (line-move-invisible (1- (point))))
2833 (goto-char (previous-char-property-change (point)))))))
2835 (cond ((> arg 0)
2836 ;; If we did not move down as far as desired,
2837 ;; at least go to end of line.
2838 (end-of-line))
2839 ((< arg 0)
2840 ;; If we did not move down as far as desired,
2841 ;; at least go to end of line.
2842 (beginning-of-line))
2844 (line-move-finish (or goal-column temporary-goal-column) opoint)))))
2845 nil)
2847 (defun line-move-finish (column opoint)
2848 (let ((repeat t))
2849 (while repeat
2850 ;; Set REPEAT to t to repeat the whole thing.
2851 (setq repeat nil)
2853 (let (new
2854 (line-beg (save-excursion (beginning-of-line) (point)))
2855 (line-end
2856 ;; Compute the end of the line
2857 ;; ignoring effectively intangible newlines.
2858 (let ((inhibit-point-motion-hooks nil)
2859 (inhibit-field-text-motion t))
2860 (save-excursion (end-of-line) (point)))))
2862 ;; Move to the desired column.
2863 (line-move-to-column column)
2864 (setq new (point))
2866 ;; Process intangibility within a line.
2867 ;; Move to the chosen destination position from above,
2868 ;; with intangibility processing enabled.
2870 (goto-char (point-min))
2871 (let ((inhibit-point-motion-hooks nil))
2872 (goto-char new)
2874 ;; If intangibility moves us to a different (later) place
2875 ;; in the same line, use that as the destination.
2876 (if (<= (point) line-end)
2877 (setq new (point))
2878 ;; If that position is "too late",
2879 ;; try the previous allowable position.
2880 ;; See if it is ok.
2881 (backward-char)
2882 (if (<= (point) line-end)
2883 (setq new (point))
2884 ;; As a last resort, use the end of the line.
2885 (setq new line-end))))
2887 ;; Now move to the updated destination, processing fields
2888 ;; as well as intangibility.
2889 (goto-char opoint)
2890 (let ((inhibit-point-motion-hooks nil))
2891 (goto-char
2892 (constrain-to-field new opoint nil t
2893 'inhibit-line-move-field-capture)))
2895 ;; If all this moved us to a different line,
2896 ;; retry everything within that new line.
2897 (when (or (< (point) line-beg) (> (point) line-end))
2898 ;; Repeat the intangibility and field processing.
2899 (setq repeat t))))))
2901 (defun line-move-to-column (col)
2902 "Try to find column COL, considering invisibility.
2903 This function works only in certain cases,
2904 because what we really need is for `move-to-column'
2905 and `current-column' to be able to ignore invisible text."
2906 (if (zerop col)
2907 (beginning-of-line)
2908 (move-to-column col))
2910 (when (and line-move-ignore-invisible
2911 (not (bolp)) (line-move-invisible (1- (point))))
2912 (let ((normal-location (point))
2913 (normal-column (current-column)))
2914 ;; If the following character is currently invisible,
2915 ;; skip all characters with that same `invisible' property value.
2916 (while (and (not (eobp))
2917 (line-move-invisible (point)))
2918 (goto-char (next-char-property-change (point))))
2919 ;; Have we advanced to a larger column position?
2920 (if (> (current-column) normal-column)
2921 ;; We have made some progress towards the desired column.
2922 ;; See if we can make any further progress.
2923 (line-move-to-column (+ (current-column) (- col normal-column)))
2924 ;; Otherwise, go to the place we originally found
2925 ;; and move back over invisible text.
2926 ;; that will get us to the same place on the screen
2927 ;; but with a more reasonable buffer position.
2928 (goto-char normal-location)
2929 (let ((line-beg (save-excursion (beginning-of-line) (point))))
2930 (while (and (not (bolp)) (line-move-invisible (1- (point))))
2931 (goto-char (previous-char-property-change (point) line-beg))))))))
2933 ;;; Many people have said they rarely use this feature, and often type
2934 ;;; it by accident. Maybe it shouldn't even be on a key.
2935 (put 'set-goal-column 'disabled t)
2937 (defun set-goal-column (arg)
2938 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2939 Those commands will move to this position in the line moved to
2940 rather than trying to keep the same horizontal position.
2941 With a non-nil argument, clears out the goal column
2942 so that \\[next-line] and \\[previous-line] resume vertical motion.
2943 The goal column is stored in the variable `goal-column'."
2944 (interactive "P")
2945 (if arg
2946 (progn
2947 (setq goal-column nil)
2948 (message "No goal column"))
2949 (setq goal-column (current-column))
2950 (message (substitute-command-keys
2951 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2952 goal-column))
2953 nil)
2956 (defun scroll-other-window-down (lines)
2957 "Scroll the \"other window\" down.
2958 For more details, see the documentation for `scroll-other-window'."
2959 (interactive "P")
2960 (scroll-other-window
2961 ;; Just invert the argument's meaning.
2962 ;; We can do that without knowing which window it will be.
2963 (if (eq lines '-) nil
2964 (if (null lines) '-
2965 (- (prefix-numeric-value lines))))))
2966 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2968 (defun beginning-of-buffer-other-window (arg)
2969 "Move point to the beginning of the buffer in the other window.
2970 Leave mark at previous position.
2971 With arg N, put point N/10 of the way from the true beginning."
2972 (interactive "P")
2973 (let ((orig-window (selected-window))
2974 (window (other-window-for-scrolling)))
2975 ;; We use unwind-protect rather than save-window-excursion
2976 ;; because the latter would preserve the things we want to change.
2977 (unwind-protect
2978 (progn
2979 (select-window window)
2980 ;; Set point and mark in that window's buffer.
2981 (beginning-of-buffer arg)
2982 ;; Set point accordingly.
2983 (recenter '(t)))
2984 (select-window orig-window))))
2986 (defun end-of-buffer-other-window (arg)
2987 "Move point to the end of the buffer in the other window.
2988 Leave mark at previous position.
2989 With arg N, put point N/10 of the way from the true end."
2990 (interactive "P")
2991 ;; See beginning-of-buffer-other-window for comments.
2992 (let ((orig-window (selected-window))
2993 (window (other-window-for-scrolling)))
2994 (unwind-protect
2995 (progn
2996 (select-window window)
2997 (end-of-buffer arg)
2998 (recenter '(t)))
2999 (select-window orig-window))))
3001 (defun transpose-chars (arg)
3002 "Interchange characters around point, moving forward one character.
3003 With prefix arg ARG, effect is to take character before point
3004 and drag it forward past ARG other characters (backward if ARG negative).
3005 If no argument and at end of line, the previous two chars are exchanged."
3006 (interactive "*P")
3007 (and (null arg) (eolp) (forward-char -1))
3008 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3010 (defun transpose-words (arg)
3011 "Interchange words around point, leaving point at end of them.
3012 With prefix arg ARG, effect is to take word before or around point
3013 and drag it forward past ARG other words (backward if ARG negative).
3014 If ARG is zero, the words around or after point and around or after mark
3015 are interchanged."
3016 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3017 (interactive "*p")
3018 (transpose-subr 'forward-word arg))
3020 (defun transpose-sexps (arg)
3021 "Like \\[transpose-words] but applies to sexps.
3022 Does not work on a sexp that point is in the middle of
3023 if it is a list or string."
3024 (interactive "*p")
3025 (transpose-subr
3026 (lambda (arg)
3027 ;; Here we should try to simulate the behavior of
3028 ;; (cons (progn (forward-sexp x) (point))
3029 ;; (progn (forward-sexp (- x)) (point)))
3030 ;; Except that we don't want to rely on the second forward-sexp
3031 ;; putting us back to where we want to be, since forward-sexp-function
3032 ;; might do funny things like infix-precedence.
3033 (if (if (> arg 0)
3034 (looking-at "\\sw\\|\\s_")
3035 (and (not (bobp))
3036 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
3037 ;; Jumping over a symbol. We might be inside it, mind you.
3038 (progn (funcall (if (> arg 0)
3039 'skip-syntax-backward 'skip-syntax-forward)
3040 "w_")
3041 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3042 ;; Otherwise, we're between sexps. Take a step back before jumping
3043 ;; to make sure we'll obey the same precedence no matter which direction
3044 ;; we're going.
3045 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3046 (cons (save-excursion (forward-sexp arg) (point))
3047 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3048 (not (zerop (funcall (if (> arg 0)
3049 'skip-syntax-forward
3050 'skip-syntax-backward)
3051 ".")))))
3052 (point)))))
3053 arg 'special))
3055 (defun transpose-lines (arg)
3056 "Exchange current line and previous line, leaving point after both.
3057 With argument ARG, takes previous line and moves it past ARG lines.
3058 With argument 0, interchanges line point is in with line mark is in."
3059 (interactive "*p")
3060 (transpose-subr (function
3061 (lambda (arg)
3062 (if (> arg 0)
3063 (progn
3064 ;; Move forward over ARG lines,
3065 ;; but create newlines if necessary.
3066 (setq arg (forward-line arg))
3067 (if (/= (preceding-char) ?\n)
3068 (setq arg (1+ arg)))
3069 (if (> arg 0)
3070 (newline arg)))
3071 (forward-line arg))))
3072 arg))
3074 (defun transpose-subr (mover arg &optional special)
3075 (let ((aux (if special mover
3076 (lambda (x)
3077 (cons (progn (funcall mover x) (point))
3078 (progn (funcall mover (- x)) (point))))))
3079 pos1 pos2)
3080 (cond
3081 ((= arg 0)
3082 (save-excursion
3083 (setq pos1 (funcall aux 1))
3084 (goto-char (mark))
3085 (setq pos2 (funcall aux 1))
3086 (transpose-subr-1 pos1 pos2))
3087 (exchange-point-and-mark))
3088 ((> arg 0)
3089 (setq pos1 (funcall aux -1))
3090 (setq pos2 (funcall aux arg))
3091 (transpose-subr-1 pos1 pos2)
3092 (goto-char (car pos2)))
3094 (setq pos1 (funcall aux -1))
3095 (goto-char (car pos1))
3096 (setq pos2 (funcall aux arg))
3097 (transpose-subr-1 pos1 pos2)))))
3099 (defun transpose-subr-1 (pos1 pos2)
3100 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3101 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3102 (when (> (car pos1) (car pos2))
3103 (let ((swap pos1))
3104 (setq pos1 pos2 pos2 swap)))
3105 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3106 (atomic-change-group
3107 (let (word2)
3108 ;; FIXME: We first delete the two pieces of text, so markers that
3109 ;; used to point to after the text end up pointing to before it :-(
3110 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3111 (goto-char (car pos2))
3112 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3113 (goto-char (car pos1))
3114 (insert word2))))
3116 (defun backward-word (arg)
3117 "Move backward until encountering the beginning of a word.
3118 With argument, do this that many times."
3119 (interactive "p")
3120 (forward-word (- arg)))
3122 (defun mark-word (arg)
3123 "Set mark arg words away from point.
3124 If this command is repeated, it marks the next ARG words after the ones
3125 already marked."
3126 (interactive "p")
3127 (cond ((and (eq last-command this-command) (mark t))
3128 (set-mark
3129 (save-excursion
3130 (goto-char (mark))
3131 (forward-word arg)
3132 (point))))
3134 (push-mark
3135 (save-excursion
3136 (forward-word arg)
3137 (point))
3138 nil t))))
3140 (defun kill-word (arg)
3141 "Kill characters forward until encountering the end of a word.
3142 With argument, do this that many times."
3143 (interactive "p")
3144 (kill-region (point) (progn (forward-word arg) (point))))
3146 (defun backward-kill-word (arg)
3147 "Kill characters backward until encountering the end of a word.
3148 With argument, do this that many times."
3149 (interactive "p")
3150 (kill-word (- arg)))
3152 (defun current-word (&optional strict)
3153 "Return the word point is on (or a nearby word) as a string.
3154 If optional arg STRICT is non-nil, return nil unless point is within
3155 or adjacent to a word."
3156 (save-excursion
3157 (let ((oldpoint (point)) (start (point)) (end (point)))
3158 (skip-syntax-backward "w_") (setq start (point))
3159 (goto-char oldpoint)
3160 (skip-syntax-forward "w_") (setq end (point))
3161 (if (and (eq start oldpoint) (eq end oldpoint))
3162 ;; Point is neither within nor adjacent to a word.
3163 (and (not strict)
3164 (progn
3165 ;; Look for preceding word in same line.
3166 (skip-syntax-backward "^w_"
3167 (save-excursion (beginning-of-line)
3168 (point)))
3169 (if (bolp)
3170 ;; No preceding word in same line.
3171 ;; Look for following word in same line.
3172 (progn
3173 (skip-syntax-forward "^w_"
3174 (save-excursion (end-of-line)
3175 (point)))
3176 (setq start (point))
3177 (skip-syntax-forward "w_")
3178 (setq end (point)))
3179 (setq end (point))
3180 (skip-syntax-backward "w_")
3181 (setq start (point)))
3182 (buffer-substring-no-properties start end)))
3183 (buffer-substring-no-properties start end)))))
3185 (defcustom fill-prefix nil
3186 "*String for filling to insert at front of new line, or nil for none."
3187 :type '(choice (const :tag "None" nil)
3188 string)
3189 :group 'fill)
3190 (make-variable-buffer-local 'fill-prefix)
3192 (defcustom auto-fill-inhibit-regexp nil
3193 "*Regexp to match lines which should not be auto-filled."
3194 :type '(choice (const :tag "None" nil)
3195 regexp)
3196 :group 'fill)
3198 (defvar comment-line-break-function 'comment-indent-new-line
3199 "*Mode-specific function which line breaks and continues a comment.
3201 This function is only called during auto-filling of a comment section.
3202 The function should take a single optional argument, which is a flag
3203 indicating whether it should use soft newlines.
3205 Setting this variable automatically makes it local to the current buffer.")
3207 ;; This function is used as the auto-fill-function of a buffer
3208 ;; when Auto-Fill mode is enabled.
3209 ;; It returns t if it really did any work.
3210 ;; (Actually some major modes use a different auto-fill function,
3211 ;; but this one is the default one.)
3212 (defun do-auto-fill ()
3213 (let (fc justify bol give-up
3214 (fill-prefix fill-prefix))
3215 (if (or (not (setq justify (current-justification)))
3216 (null (setq fc (current-fill-column)))
3217 (and (eq justify 'left)
3218 (<= (current-column) fc))
3219 (save-excursion (beginning-of-line)
3220 (setq bol (point))
3221 (and auto-fill-inhibit-regexp
3222 (looking-at auto-fill-inhibit-regexp))))
3223 nil ;; Auto-filling not required
3224 (if (memq justify '(full center right))
3225 (save-excursion (unjustify-current-line)))
3227 ;; Choose a fill-prefix automatically.
3228 (when (and adaptive-fill-mode
3229 (or (null fill-prefix) (string= fill-prefix "")))
3230 (let ((prefix
3231 (fill-context-prefix
3232 (save-excursion (backward-paragraph 1) (point))
3233 (save-excursion (forward-paragraph 1) (point)))))
3234 (and prefix (not (equal prefix ""))
3235 ;; Use auto-indentation rather than a guessed empty prefix.
3236 (not (and fill-indent-according-to-mode
3237 (string-match "\\`[ \t]*\\'" prefix)))
3238 (setq fill-prefix prefix))))
3240 (while (and (not give-up) (> (current-column) fc))
3241 ;; Determine where to split the line.
3242 (let* (after-prefix
3243 (fill-point
3244 (let ((opoint (point)))
3245 (save-excursion
3246 (beginning-of-line)
3247 (setq after-prefix (point))
3248 (and fill-prefix
3249 (looking-at (regexp-quote fill-prefix))
3250 (setq after-prefix (match-end 0)))
3251 (move-to-column (1+ fc))
3252 (fill-move-to-break-point after-prefix)
3253 (point)))))
3255 ;; See whether the place we found is any good.
3256 (if (save-excursion
3257 (goto-char fill-point)
3258 (or (bolp)
3259 ;; There is no use breaking at end of line.
3260 (save-excursion (skip-chars-forward " ") (eolp))
3261 ;; It is futile to split at the end of the prefix
3262 ;; since we would just insert the prefix again.
3263 (and after-prefix (<= (point) after-prefix))
3264 ;; Don't split right after a comment starter
3265 ;; since we would just make another comment starter.
3266 (and comment-start-skip
3267 (let ((limit (point)))
3268 (beginning-of-line)
3269 (and (re-search-forward comment-start-skip
3270 limit t)
3271 (eq (point) limit))))))
3272 ;; No good place to break => stop trying.
3273 (setq give-up t)
3274 ;; Ok, we have a useful place to break the line. Do it.
3275 (let ((prev-column (current-column)))
3276 ;; If point is at the fill-point, do not `save-excursion'.
3277 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3278 ;; point will end up before it rather than after it.
3279 (if (save-excursion
3280 (skip-chars-backward " \t")
3281 (= (point) fill-point))
3282 (funcall comment-line-break-function t)
3283 (save-excursion
3284 (goto-char fill-point)
3285 (funcall comment-line-break-function t)))
3286 ;; Now do justification, if required
3287 (if (not (eq justify 'left))
3288 (save-excursion
3289 (end-of-line 0)
3290 (justify-current-line justify nil t)))
3291 ;; If making the new line didn't reduce the hpos of
3292 ;; the end of the line, then give up now;
3293 ;; trying again will not help.
3294 (if (>= (current-column) prev-column)
3295 (setq give-up t))))))
3296 ;; Justify last line.
3297 (justify-current-line justify t t)
3298 t)))
3300 (defvar normal-auto-fill-function 'do-auto-fill
3301 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3302 Some major modes set this.")
3304 ;; FIXME: turn into a proper minor mode.
3305 ;; Add a global minor mode version of it.
3306 (defun auto-fill-mode (&optional arg)
3307 "Toggle Auto Fill mode.
3308 With arg, turn Auto Fill mode on if and only if arg is positive.
3309 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
3310 automatically breaks the line at a previous space.
3312 The value of `normal-auto-fill-function' specifies the function to use
3313 for `auto-fill-function' when turning Auto Fill mode on."
3314 (interactive "P")
3315 (prog1 (setq auto-fill-function
3316 (if (if (null arg)
3317 (not auto-fill-function)
3318 (> (prefix-numeric-value arg) 0))
3319 normal-auto-fill-function
3320 nil))
3321 (force-mode-line-update)))
3323 ;; This holds a document string used to document auto-fill-mode.
3324 (defun auto-fill-function ()
3325 "Automatically break line at a previous space, in insertion of text."
3326 nil)
3328 (defun turn-on-auto-fill ()
3329 "Unconditionally turn on Auto Fill mode."
3330 (auto-fill-mode 1))
3332 (defun turn-off-auto-fill ()
3333 "Unconditionally turn off Auto Fill mode."
3334 (auto-fill-mode -1))
3336 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
3338 (defun set-fill-column (arg)
3339 "Set `fill-column' to specified argument.
3340 Use \\[universal-argument] followed by a number to specify a column.
3341 Just \\[universal-argument] as argument means to use the current column."
3342 (interactive "P")
3343 (if (consp arg)
3344 (setq arg (current-column)))
3345 (if (not (integerp arg))
3346 ;; Disallow missing argument; it's probably a typo for C-x C-f.
3347 (error "set-fill-column requires an explicit argument")
3348 (message "Fill column set to %d (was %d)" arg fill-column)
3349 (setq fill-column arg)))
3351 (defun set-selective-display (arg)
3352 "Set `selective-display' to ARG; clear it if no arg.
3353 When the value of `selective-display' is a number > 0,
3354 lines whose indentation is >= that value are not displayed.
3355 The variable `selective-display' has a separate value for each buffer."
3356 (interactive "P")
3357 (if (eq selective-display t)
3358 (error "selective-display already in use for marked lines"))
3359 (let ((current-vpos
3360 (save-restriction
3361 (narrow-to-region (point-min) (point))
3362 (goto-char (window-start))
3363 (vertical-motion (window-height)))))
3364 (setq selective-display
3365 (and arg (prefix-numeric-value arg)))
3366 (recenter current-vpos))
3367 (set-window-start (selected-window) (window-start (selected-window)))
3368 (princ "selective-display set to " t)
3369 (prin1 selective-display t)
3370 (princ "." t))
3372 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
3373 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
3375 (defun toggle-truncate-lines (arg)
3376 "Toggle whether to fold or truncate long lines on the screen.
3377 With arg, truncate long lines iff arg is positive.
3378 Note that in side-by-side windows, truncation is always enabled."
3379 (interactive "P")
3380 (setq truncate-lines
3381 (if (null arg)
3382 (not truncate-lines)
3383 (> (prefix-numeric-value arg) 0)))
3384 (force-mode-line-update)
3385 (unless truncate-lines
3386 (let ((buffer (current-buffer)))
3387 (walk-windows (lambda (window)
3388 (if (eq buffer (window-buffer window))
3389 (set-window-hscroll window 0)))
3390 nil t)))
3391 (message "Truncate long lines %s"
3392 (if truncate-lines "enabled" "disabled")))
3394 (defvar overwrite-mode-textual " Ovwrt"
3395 "The string displayed in the mode line when in overwrite mode.")
3396 (defvar overwrite-mode-binary " Bin Ovwrt"
3397 "The string displayed in the mode line when in binary overwrite mode.")
3399 (defun overwrite-mode (arg)
3400 "Toggle overwrite mode.
3401 With arg, turn overwrite mode on iff arg is positive.
3402 In overwrite mode, printing characters typed in replace existing text
3403 on a one-for-one basis, rather than pushing it to the right. At the
3404 end of a line, such characters extend the line. Before a tab,
3405 such characters insert until the tab is filled in.
3406 \\[quoted-insert] still inserts characters in overwrite mode; this
3407 is supposed to make it easier to insert characters when necessary."
3408 (interactive "P")
3409 (setq overwrite-mode
3410 (if (if (null arg) (not overwrite-mode)
3411 (> (prefix-numeric-value arg) 0))
3412 'overwrite-mode-textual))
3413 (force-mode-line-update))
3415 (defun binary-overwrite-mode (arg)
3416 "Toggle binary overwrite mode.
3417 With arg, turn binary overwrite mode on iff arg is positive.
3418 In binary overwrite mode, printing characters typed in replace
3419 existing text. Newlines are not treated specially, so typing at the
3420 end of a line joins the line to the next, with the typed character
3421 between them. Typing before a tab character simply replaces the tab
3422 with the character typed.
3423 \\[quoted-insert] replaces the text at the cursor, just as ordinary
3424 typing characters do.
3426 Note that binary overwrite mode is not its own minor mode; it is a
3427 specialization of overwrite-mode, entered by setting the
3428 `overwrite-mode' variable to `overwrite-mode-binary'."
3429 (interactive "P")
3430 (setq overwrite-mode
3431 (if (if (null arg)
3432 (not (eq overwrite-mode 'overwrite-mode-binary))
3433 (> (prefix-numeric-value arg) 0))
3434 'overwrite-mode-binary))
3435 (force-mode-line-update))
3437 (define-minor-mode line-number-mode
3438 "Toggle Line Number mode.
3439 With arg, turn Line Number mode on iff arg is positive.
3440 When Line Number mode is enabled, the line number appears
3441 in the mode line.
3443 Line numbers do not appear for very large buffers and buffers
3444 with very long lines; see variables `line-number-display-limit'
3445 and `line-number-display-limit-width'."
3446 :init-value t :global t :group 'editing-basics :require nil)
3448 (define-minor-mode column-number-mode
3449 "Toggle Column Number mode.
3450 With arg, turn Column Number mode on iff arg is positive.
3451 When Column Number mode is enabled, the column number appears
3452 in the mode line."
3453 :global t :group 'editing-basics :require nil)
3455 (defgroup paren-blinking nil
3456 "Blinking matching of parens and expressions."
3457 :prefix "blink-matching-"
3458 :group 'paren-matching)
3460 (defcustom blink-matching-paren t
3461 "*Non-nil means show matching open-paren when close-paren is inserted."
3462 :type 'boolean
3463 :group 'paren-blinking)
3465 (defcustom blink-matching-paren-on-screen t
3466 "*Non-nil means show matching open-paren when it is on screen.
3467 If nil, means don't show it (but the open-paren can still be shown
3468 when it is off screen)."
3469 :type 'boolean
3470 :group 'paren-blinking)
3472 (defcustom blink-matching-paren-distance (* 25 1024)
3473 "*If non-nil, is maximum distance to search for matching open-paren."
3474 :type 'integer
3475 :group 'paren-blinking)
3477 (defcustom blink-matching-delay 1
3478 "*Time in seconds to delay after showing a matching paren."
3479 :type 'number
3480 :group 'paren-blinking)
3482 (defcustom blink-matching-paren-dont-ignore-comments nil
3483 "*Non-nil means `blink-matching-paren' will not ignore comments."
3484 :type 'boolean
3485 :group 'paren-blinking)
3487 (defun blink-matching-open ()
3488 "Move cursor momentarily to the beginning of the sexp before point."
3489 (interactive)
3490 (and (> (point) (1+ (point-min)))
3491 blink-matching-paren
3492 ;; Verify an even number of quoting characters precede the close.
3493 (= 1 (logand 1 (- (point)
3494 (save-excursion
3495 (forward-char -1)
3496 (skip-syntax-backward "/\\")
3497 (point)))))
3498 (let* ((oldpos (point))
3499 (blinkpos)
3500 (mismatch))
3501 (save-excursion
3502 (save-restriction
3503 (if blink-matching-paren-distance
3504 (narrow-to-region (max (point-min)
3505 (- (point) blink-matching-paren-distance))
3506 oldpos))
3507 (condition-case ()
3508 (let ((parse-sexp-ignore-comments
3509 (and parse-sexp-ignore-comments
3510 (not blink-matching-paren-dont-ignore-comments))))
3511 (setq blinkpos (scan-sexps oldpos -1)))
3512 (error nil)))
3513 (and blinkpos
3514 (/= (char-syntax (char-after blinkpos))
3515 ?\$)
3516 (setq mismatch
3517 (or (null (matching-paren (char-after blinkpos)))
3518 (/= (char-after (1- oldpos))
3519 (matching-paren (char-after blinkpos))))))
3520 (if mismatch (setq blinkpos nil))
3521 (if blinkpos
3522 ;; Don't log messages about paren matching.
3523 (let (message-log-max)
3524 (goto-char blinkpos)
3525 (if (pos-visible-in-window-p)
3526 (and blink-matching-paren-on-screen
3527 (sit-for blink-matching-delay))
3528 (goto-char blinkpos)
3529 (message
3530 "Matches %s"
3531 ;; Show what precedes the open in its line, if anything.
3532 (if (save-excursion
3533 (skip-chars-backward " \t")
3534 (not (bolp)))
3535 (buffer-substring (progn (beginning-of-line) (point))
3536 (1+ blinkpos))
3537 ;; Show what follows the open in its line, if anything.
3538 (if (save-excursion
3539 (forward-char 1)
3540 (skip-chars-forward " \t")
3541 (not (eolp)))
3542 (buffer-substring blinkpos
3543 (progn (end-of-line) (point)))
3544 ;; Otherwise show the previous nonblank line,
3545 ;; if there is one.
3546 (if (save-excursion
3547 (skip-chars-backward "\n \t")
3548 (not (bobp)))
3549 (concat
3550 (buffer-substring (progn
3551 (skip-chars-backward "\n \t")
3552 (beginning-of-line)
3553 (point))
3554 (progn (end-of-line)
3555 (skip-chars-backward " \t")
3556 (point)))
3557 ;; Replace the newline and other whitespace with `...'.
3558 "..."
3559 (buffer-substring blinkpos (1+ blinkpos)))
3560 ;; There is nothing to show except the char itself.
3561 (buffer-substring blinkpos (1+ blinkpos))))))))
3562 (cond (mismatch
3563 (message "Mismatched parentheses"))
3564 ((not blink-matching-paren-distance)
3565 (message "Unmatched parenthesis"))))))))
3567 ;Turned off because it makes dbx bomb out.
3568 (setq blink-paren-function 'blink-matching-open)
3570 ;; This executes C-g typed while Emacs is waiting for a command.
3571 ;; Quitting out of a program does not go through here;
3572 ;; that happens in the QUIT macro at the C code level.
3573 (defun keyboard-quit ()
3574 "Signal a `quit' condition.
3575 During execution of Lisp code, this character causes a quit directly.
3576 At top-level, as an editor command, this simply beeps."
3577 (interactive)
3578 (deactivate-mark)
3579 (setq defining-kbd-macro nil)
3580 (signal 'quit nil))
3582 (define-key global-map "\C-g" 'keyboard-quit)
3584 (defvar buffer-quit-function nil
3585 "Function to call to \"quit\" the current buffer, or nil if none.
3586 \\[keyboard-escape-quit] calls this function when its more local actions
3587 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3589 (defun keyboard-escape-quit ()
3590 "Exit the current \"mode\" (in a generalized sense of the word).
3591 This command can exit an interactive command such as `query-replace',
3592 can clear out a prefix argument or a region,
3593 can get out of the minibuffer or other recursive edit,
3594 cancel the use of the current buffer (for special-purpose buffers),
3595 or go back to just one window (by deleting all but the selected window)."
3596 (interactive)
3597 (cond ((eq last-command 'mode-exited) nil)
3598 ((> (minibuffer-depth) 0)
3599 (abort-recursive-edit))
3600 (current-prefix-arg
3601 nil)
3602 ((and transient-mark-mode
3603 mark-active)
3604 (deactivate-mark))
3605 ((> (recursion-depth) 0)
3606 (exit-recursive-edit))
3607 (buffer-quit-function
3608 (funcall buffer-quit-function))
3609 ((not (one-window-p t))
3610 (delete-other-windows))
3611 ((string-match "^ \\*" (buffer-name (current-buffer)))
3612 (bury-buffer))))
3614 (defun play-sound-file (file &optional volume device)
3615 "Play sound stored in FILE.
3616 VOLUME and DEVICE correspond to the keywords of the sound
3617 specification for `play-sound'."
3618 (interactive "fPlay sound file: ")
3619 (let ((sound (list :file file)))
3620 (if volume
3621 (plist-put sound :volume volume))
3622 (if device
3623 (plist-put sound :device device))
3624 (push 'sound sound)
3625 (play-sound sound)))
3627 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3629 (defcustom read-mail-command 'rmail
3630 "*Your preference for a mail reading package.
3631 This is used by some keybindings which support reading mail.
3632 See also `mail-user-agent' concerning sending mail."
3633 :type '(choice (function-item rmail)
3634 (function-item gnus)
3635 (function-item mh-rmail)
3636 (function :tag "Other"))
3637 :version "21.1"
3638 :group 'mail)
3640 (defcustom mail-user-agent 'sendmail-user-agent
3641 "*Your preference for a mail composition package.
3642 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
3643 outgoing email message. This variable lets you specify which
3644 mail-sending package you prefer.
3646 Valid values include:
3648 `sendmail-user-agent' -- use the default Emacs Mail package.
3649 See Info node `(emacs)Sending Mail'.
3650 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
3651 See Info node `(mh-e)'.
3652 `message-user-agent' -- use the Gnus Message package.
3653 See Info node `(message)'.
3654 `gnus-user-agent' -- like `message-user-agent', but with Gnus
3655 paraphernalia, particularly the Gcc: header for
3656 archiving.
3658 Additional valid symbols may be available; check with the author of
3659 your package for details. The function should return non-nil if it
3660 succeeds.
3662 See also `read-mail-command' concerning reading mail."
3663 :type '(radio (function-item :tag "Default Emacs mail"
3664 :format "%t\n"
3665 sendmail-user-agent)
3666 (function-item :tag "Emacs interface to MH"
3667 :format "%t\n"
3668 mh-e-user-agent)
3669 (function-item :tag "Gnus Message package"
3670 :format "%t\n"
3671 message-user-agent)
3672 (function-item :tag "Gnus Message with full Gnus features"
3673 :format "%t\n"
3674 gnus-user-agent)
3675 (function :tag "Other"))
3676 :group 'mail)
3678 (define-mail-user-agent 'sendmail-user-agent
3679 'sendmail-user-agent-compose
3680 'mail-send-and-exit)
3682 (defun rfc822-goto-eoh ()
3683 ;; Go to header delimiter line in a mail message, following RFC822 rules
3684 (goto-char (point-min))
3685 (when (re-search-forward
3686 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
3687 (goto-char (match-beginning 0))))
3689 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3690 switch-function yank-action
3691 send-actions)
3692 (if switch-function
3693 (let ((special-display-buffer-names nil)
3694 (special-display-regexps nil)
3695 (same-window-buffer-names nil)
3696 (same-window-regexps nil))
3697 (funcall switch-function "*mail*")))
3698 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3699 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3700 (body (cdr (assoc-ignore-case "body" other-headers))))
3701 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3702 continue
3703 (error "Message aborted"))
3704 (save-excursion
3705 (rfc822-goto-eoh)
3706 (while other-headers
3707 (unless (member-ignore-case (car (car other-headers))
3708 '("in-reply-to" "cc" "body"))
3709 (insert (car (car other-headers)) ": "
3710 (cdr (car other-headers)) "\n"))
3711 (setq other-headers (cdr other-headers)))
3712 (when body
3713 (forward-line 1)
3714 (insert body))
3715 t)))
3717 (define-mail-user-agent 'mh-e-user-agent
3718 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3719 'mh-before-send-letter-hook)
3721 (defun compose-mail (&optional to subject other-headers continue
3722 switch-function yank-action send-actions)
3723 "Start composing a mail message to send.
3724 This uses the user's chosen mail composition package
3725 as selected with the variable `mail-user-agent'.
3726 The optional arguments TO and SUBJECT specify recipients
3727 and the initial Subject field, respectively.
3729 OTHER-HEADERS is an alist specifying additional
3730 header fields. Elements look like (HEADER . VALUE) where both
3731 HEADER and VALUE are strings.
3733 CONTINUE, if non-nil, says to continue editing a message already
3734 being composed.
3736 SWITCH-FUNCTION, if non-nil, is a function to use to
3737 switch to and display the buffer used for mail composition.
3739 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3740 to insert the raw text of the message being replied to.
3741 It has the form (FUNCTION . ARGS). The user agent will apply
3742 FUNCTION to ARGS, to insert the raw text of the original message.
3743 \(The user agent will also run `mail-citation-hook', *after* the
3744 original text has been inserted in this way.)
3746 SEND-ACTIONS is a list of actions to call when the message is sent.
3747 Each action has the form (FUNCTION . ARGS)."
3748 (interactive
3749 (list nil nil nil current-prefix-arg))
3750 (let ((function (get mail-user-agent 'composefunc)))
3751 (funcall function to subject other-headers continue
3752 switch-function yank-action send-actions)))
3754 (defun compose-mail-other-window (&optional to subject other-headers continue
3755 yank-action send-actions)
3756 "Like \\[compose-mail], but edit the outgoing message in another window."
3757 (interactive
3758 (list nil nil nil current-prefix-arg))
3759 (compose-mail to subject other-headers continue
3760 'switch-to-buffer-other-window yank-action send-actions))
3763 (defun compose-mail-other-frame (&optional to subject other-headers continue
3764 yank-action send-actions)
3765 "Like \\[compose-mail], but edit the outgoing message in another frame."
3766 (interactive
3767 (list nil nil nil current-prefix-arg))
3768 (compose-mail to subject other-headers continue
3769 'switch-to-buffer-other-frame yank-action send-actions))
3771 (defvar set-variable-value-history nil
3772 "History of values entered with `set-variable'.")
3774 (defun set-variable (var val &optional make-local)
3775 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3776 When using this interactively, enter a Lisp object for VALUE.
3777 If you want VALUE to be a string, you must surround it with doublequotes.
3778 VALUE is used literally, not evaluated.
3780 If VARIABLE has a `variable-interactive' property, that is used as if
3781 it were the arg to `interactive' (which see) to interactively read VALUE.
3783 If VARIABLE has been defined with `defcustom', then the type information
3784 in the definition is used to check that VALUE is valid.
3786 With a prefix argument, set VARIABLE to VALUE buffer-locally."
3787 (interactive
3788 (let* ((default-var (variable-at-point))
3789 (var (if (symbolp default-var)
3790 (read-variable (format "Set variable (default %s): " default-var)
3791 default-var)
3792 (read-variable "Set variable: ")))
3793 (minibuffer-help-form '(describe-variable var))
3794 (prop (get var 'variable-interactive))
3795 (prompt (format "Set %s%s to value: " var
3796 (cond ((local-variable-p var)
3797 " (buffer-local)")
3798 ((or current-prefix-arg
3799 (local-variable-if-set-p var))
3800 " buffer-locally")
3801 (t " globally"))))
3802 (val (if prop
3803 ;; Use VAR's `variable-interactive' property
3804 ;; as an interactive spec for prompting.
3805 (call-interactively `(lambda (arg)
3806 (interactive ,prop)
3807 arg))
3808 (read
3809 (read-string prompt nil
3810 'set-variable-value-history)))))
3811 (list var val current-prefix-arg)))
3813 (and (custom-variable-p var)
3814 (not (get var 'custom-type))
3815 (custom-load-symbol var))
3816 (let ((type (get var 'custom-type)))
3817 (when type
3818 ;; Match with custom type.
3819 (require 'cus-edit)
3820 (setq type (widget-convert type))
3821 (unless (widget-apply type :match val)
3822 (error "Value `%S' does not match type %S of %S"
3823 val (car type) var))))
3825 (if make-local
3826 (make-local-variable var))
3828 (set var val)
3830 ;; Force a thorough redisplay for the case that the variable
3831 ;; has an effect on the display, like `tab-width' has.
3832 (force-mode-line-update))
3834 ;; Define the major mode for lists of completions.
3836 (defvar completion-list-mode-map nil
3837 "Local map for completion list buffers.")
3838 (or completion-list-mode-map
3839 (let ((map (make-sparse-keymap)))
3840 (define-key map [mouse-2] 'mouse-choose-completion)
3841 (define-key map [down-mouse-2] nil)
3842 (define-key map "\C-m" 'choose-completion)
3843 (define-key map "\e\e\e" 'delete-completion-window)
3844 (define-key map [left] 'previous-completion)
3845 (define-key map [right] 'next-completion)
3846 (setq completion-list-mode-map map)))
3848 ;; Completion mode is suitable only for specially formatted data.
3849 (put 'completion-list-mode 'mode-class 'special)
3851 (defvar completion-reference-buffer nil
3852 "Record the buffer that was current when the completion list was requested.
3853 This is a local variable in the completion list buffer.
3854 Initial value is nil to avoid some compiler warnings.")
3856 (defvar completion-no-auto-exit nil
3857 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3858 This also applies to other functions such as `choose-completion'
3859 and `mouse-choose-completion'.")
3861 (defvar completion-base-size nil
3862 "Number of chars at beginning of minibuffer not involved in completion.
3863 This is a local variable in the completion list buffer
3864 but it talks about the buffer in `completion-reference-buffer'.
3865 If this is nil, it means to compare text to determine which part
3866 of the tail end of the buffer's text is involved in completion.")
3868 (defun delete-completion-window ()
3869 "Delete the completion list window.
3870 Go to the window from which completion was requested."
3871 (interactive)
3872 (let ((buf completion-reference-buffer))
3873 (if (one-window-p t)
3874 (if (window-dedicated-p (selected-window))
3875 (delete-frame (selected-frame)))
3876 (delete-window (selected-window))
3877 (if (get-buffer-window buf)
3878 (select-window (get-buffer-window buf))))))
3880 (defun previous-completion (n)
3881 "Move to the previous item in the completion list."
3882 (interactive "p")
3883 (next-completion (- n)))
3885 (defun next-completion (n)
3886 "Move to the next item in the completion list.
3887 With prefix argument N, move N items (negative N means move backward)."
3888 (interactive "p")
3889 (let ((beg (point-min)) (end (point-max)))
3890 (while (and (> n 0) (not (eobp)))
3891 ;; If in a completion, move to the end of it.
3892 (when (get-text-property (point) 'mouse-face)
3893 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3894 ;; Move to start of next one.
3895 (unless (get-text-property (point) 'mouse-face)
3896 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3897 (setq n (1- n)))
3898 (while (and (< n 0) (not (bobp)))
3899 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
3900 ;; If in a completion, move to the start of it.
3901 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
3902 (goto-char (previous-single-property-change
3903 (point) 'mouse-face nil beg)))
3904 ;; Move to end of the previous completion.
3905 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
3906 (goto-char (previous-single-property-change
3907 (point) 'mouse-face nil beg)))
3908 ;; Move to the start of that one.
3909 (goto-char (previous-single-property-change
3910 (point) 'mouse-face nil beg))
3911 (setq n (1+ n))))))
3913 (defun choose-completion ()
3914 "Choose the completion that point is in or next to."
3915 (interactive)
3916 (let (beg end completion (buffer completion-reference-buffer)
3917 (base-size completion-base-size))
3918 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3919 (setq end (point) beg (1+ (point))))
3920 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3921 (setq end (1- (point)) beg (point)))
3922 (if (null beg)
3923 (error "No completion here"))
3924 (setq beg (previous-single-property-change beg 'mouse-face))
3925 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3926 (setq completion (buffer-substring beg end))
3927 (let ((owindow (selected-window)))
3928 (if (and (one-window-p t 'selected-frame)
3929 (window-dedicated-p (selected-window)))
3930 ;; This is a special buffer's frame
3931 (iconify-frame (selected-frame))
3932 (or (window-dedicated-p (selected-window))
3933 (bury-buffer)))
3934 (select-window owindow))
3935 (choose-completion-string completion buffer base-size)))
3937 ;; Delete the longest partial match for STRING
3938 ;; that can be found before POINT.
3939 (defun choose-completion-delete-max-match (string)
3940 (let ((opoint (point))
3941 len)
3942 ;; Try moving back by the length of the string.
3943 (goto-char (max (- (point) (length string))
3944 (minibuffer-prompt-end)))
3945 ;; See how far back we were actually able to move. That is the
3946 ;; upper bound on how much we can match and delete.
3947 (setq len (- opoint (point)))
3948 (if completion-ignore-case
3949 (setq string (downcase string)))
3950 (while (and (> len 0)
3951 (let ((tail (buffer-substring (point) opoint)))
3952 (if completion-ignore-case
3953 (setq tail (downcase tail)))
3954 (not (string= tail (substring string 0 len)))))
3955 (setq len (1- len))
3956 (forward-char 1))
3957 (delete-char len)))
3959 (defvar choose-completion-string-functions nil
3960 "Functions that may override the normal insertion of a completion choice.
3961 These functions are called in order with four arguments:
3962 CHOICE - the string to insert in the buffer,
3963 BUFFER - the buffer in which the choice should be inserted,
3964 MINI-P - non-nil iff BUFFER is a minibuffer, and
3965 BASE-SIZE - the number of characters in BUFFER before
3966 the string being completed.
3968 If a function in the list returns non-nil, that function is supposed
3969 to have inserted the CHOICE in the BUFFER, and possibly exited
3970 the minibuffer; no further functions will be called.
3972 If all functions in the list return nil, that means to use
3973 the default method of inserting the completion in BUFFER.")
3975 (defun choose-completion-string (choice &optional buffer base-size)
3976 "Switch to BUFFER and insert the completion choice CHOICE.
3977 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3978 to keep. If it is nil, we call `choose-completion-delete-max-match'
3979 to decide what to delete."
3981 ;; If BUFFER is the minibuffer, exit the minibuffer
3982 ;; unless it is reading a file name and CHOICE is a directory,
3983 ;; or completion-no-auto-exit is non-nil.
3985 (let ((buffer (or buffer completion-reference-buffer))
3986 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3987 (buffer-name buffer))))
3988 ;; If BUFFER is a minibuffer, barf unless it's the currently
3989 ;; active minibuffer.
3990 (if (and mini-p
3991 (or (not (active-minibuffer-window))
3992 (not (equal buffer
3993 (window-buffer (active-minibuffer-window))))))
3994 (error "Minibuffer is not active for completion")
3995 (unless (run-hook-with-args-until-success
3996 'choose-completion-string-functions
3997 choice buffer mini-p base-size)
3998 ;; Insert the completion into the buffer where it was requested.
3999 (set-buffer buffer)
4000 (if base-size
4001 (delete-region (+ base-size (if mini-p
4002 (minibuffer-prompt-end)
4003 (point-min)))
4004 (point))
4005 (choose-completion-delete-max-match choice))
4006 (insert choice)
4007 (remove-text-properties (- (point) (length choice)) (point)
4008 '(mouse-face nil))
4009 ;; Update point in the window that BUFFER is showing in.
4010 (let ((window (get-buffer-window buffer t)))
4011 (set-window-point window (point)))
4012 ;; If completing for the minibuffer, exit it with this choice.
4013 (and (not completion-no-auto-exit)
4014 (equal buffer (window-buffer (minibuffer-window)))
4015 minibuffer-completion-table
4016 ;; If this is reading a file name, and the file name chosen
4017 ;; is a directory, don't exit the minibuffer.
4018 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4019 (file-directory-p (field-string (point-max))))
4020 (let ((mini (active-minibuffer-window)))
4021 (select-window mini)
4022 (when minibuffer-auto-raise
4023 (raise-frame (window-frame mini))))
4024 (exit-minibuffer)))))))
4026 (defun completion-list-mode ()
4027 "Major mode for buffers showing lists of possible completions.
4028 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
4029 to select the completion near point.
4030 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
4031 with the mouse."
4032 (interactive)
4033 (kill-all-local-variables)
4034 (use-local-map completion-list-mode-map)
4035 (setq mode-name "Completion List")
4036 (setq major-mode 'completion-list-mode)
4037 (make-local-variable 'completion-base-size)
4038 (setq completion-base-size nil)
4039 (run-hooks 'completion-list-mode-hook))
4041 (defun completion-list-mode-finish ()
4042 "Finish setup of the completions buffer.
4043 Called from `temp-buffer-show-hook'."
4044 (when (eq major-mode 'completion-list-mode)
4045 (toggle-read-only 1)))
4047 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4049 (defvar completion-setup-hook nil
4050 "Normal hook run at the end of setting up a completion list buffer.
4051 When this hook is run, the current buffer is the one in which the
4052 command to display the completion list buffer was run.
4053 The completion list buffer is available as the value of `standard-output'.")
4055 ;; This function goes in completion-setup-hook, so that it is called
4056 ;; after the text of the completion list buffer is written.
4058 (defun completion-setup-function ()
4059 (save-excursion
4060 (let ((mainbuf (current-buffer))
4061 (mbuf-contents (minibuffer-contents)))
4062 ;; When reading a file name in the minibuffer,
4063 ;; set default-directory in the minibuffer
4064 ;; so it will get copied into the completion list buffer.
4065 (if minibuffer-completing-file-name
4066 (with-current-buffer mainbuf
4067 (setq default-directory (file-name-directory mbuf-contents))))
4068 (set-buffer standard-output)
4069 (completion-list-mode)
4070 (make-local-variable 'completion-reference-buffer)
4071 (setq completion-reference-buffer mainbuf)
4072 (if minibuffer-completing-file-name
4073 ;; For file name completion,
4074 ;; use the number of chars before the start of the
4075 ;; last file name component.
4076 (setq completion-base-size
4077 (save-excursion
4078 (set-buffer mainbuf)
4079 (goto-char (point-max))
4080 (skip-chars-backward "^/")
4081 (- (point) (minibuffer-prompt-end))))
4082 ;; Otherwise, in minibuffer, the whole input is being completed.
4083 (save-match-data
4084 (if (minibufferp mainbuf)
4085 (setq completion-base-size 0))))
4086 (goto-char (point-min))
4087 (if (display-mouse-p)
4088 (insert (substitute-command-keys
4089 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
4090 (insert (substitute-command-keys
4091 "In this buffer, type \\[choose-completion] to \
4092 select the completion near point.\n\n")))))
4094 (add-hook 'completion-setup-hook 'completion-setup-function)
4096 (define-key minibuffer-local-completion-map [prior]
4097 'switch-to-completions)
4098 (define-key minibuffer-local-must-match-map [prior]
4099 'switch-to-completions)
4100 (define-key minibuffer-local-completion-map "\M-v"
4101 'switch-to-completions)
4102 (define-key minibuffer-local-must-match-map "\M-v"
4103 'switch-to-completions)
4105 (defun switch-to-completions ()
4106 "Select the completion list window."
4107 (interactive)
4108 ;; Make sure we have a completions window.
4109 (or (get-buffer-window "*Completions*")
4110 (minibuffer-completion-help))
4111 (let ((window (get-buffer-window "*Completions*")))
4112 (when window
4113 (select-window window)
4114 (goto-char (point-min))
4115 (search-forward "\n\n")
4116 (forward-line 1))))
4118 ;; Support keyboard commands to turn on various modifiers.
4120 ;; These functions -- which are not commands -- each add one modifier
4121 ;; to the following event.
4123 (defun event-apply-alt-modifier (ignore-prompt)
4124 "\\<function-key-map>Add the Alt modifier to the following event.
4125 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
4126 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4127 (defun event-apply-super-modifier (ignore-prompt)
4128 "\\<function-key-map>Add the Super modifier to the following event.
4129 For example, type \\[event-apply-super-modifier] & to enter Super-&."
4130 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4131 (defun event-apply-hyper-modifier (ignore-prompt)
4132 "\\<function-key-map>Add the Hyper modifier to the following event.
4133 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
4134 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
4135 (defun event-apply-shift-modifier (ignore-prompt)
4136 "\\<function-key-map>Add the Shift modifier to the following event.
4137 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
4138 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
4139 (defun event-apply-control-modifier (ignore-prompt)
4140 "\\<function-key-map>Add the Ctrl modifier to the following event.
4141 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
4142 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
4143 (defun event-apply-meta-modifier (ignore-prompt)
4144 "\\<function-key-map>Add the Meta modifier to the following event.
4145 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
4146 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
4148 (defun event-apply-modifier (event symbol lshiftby prefix)
4149 "Apply a modifier flag to event EVENT.
4150 SYMBOL is the name of this modifier, as a symbol.
4151 LSHIFTBY is the numeric value of this modifier, in keyboard events.
4152 PREFIX is the string that represents this modifier in an event type symbol."
4153 (if (numberp event)
4154 (cond ((eq symbol 'control)
4155 (if (and (<= (downcase event) ?z)
4156 (>= (downcase event) ?a))
4157 (- (downcase event) ?a -1)
4158 (if (and (<= (downcase event) ?Z)
4159 (>= (downcase event) ?A))
4160 (- (downcase event) ?A -1)
4161 (logior (lsh 1 lshiftby) event))))
4162 ((eq symbol 'shift)
4163 (if (and (<= (downcase event) ?z)
4164 (>= (downcase event) ?a))
4165 (upcase event)
4166 (logior (lsh 1 lshiftby) event)))
4168 (logior (lsh 1 lshiftby) event)))
4169 (if (memq symbol (event-modifiers event))
4170 event
4171 (let ((event-type (if (symbolp event) event (car event))))
4172 (setq event-type (intern (concat prefix (symbol-name event-type))))
4173 (if (symbolp event)
4174 event-type
4175 (cons event-type (cdr event)))))))
4177 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
4178 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
4179 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
4180 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
4181 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
4182 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
4184 ;;;; Keypad support.
4186 ;;; Make the keypad keys act like ordinary typing keys. If people add
4187 ;;; bindings for the function key symbols, then those bindings will
4188 ;;; override these, so this shouldn't interfere with any existing
4189 ;;; bindings.
4191 ;; Also tell read-char how to handle these keys.
4192 (mapc
4193 (lambda (keypad-normal)
4194 (let ((keypad (nth 0 keypad-normal))
4195 (normal (nth 1 keypad-normal)))
4196 (put keypad 'ascii-character normal)
4197 (define-key function-key-map (vector keypad) (vector normal))))
4198 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
4199 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
4200 (kp-space ?\ )
4201 (kp-tab ?\t)
4202 (kp-enter ?\r)
4203 (kp-multiply ?*)
4204 (kp-add ?+)
4205 (kp-separator ?,)
4206 (kp-subtract ?-)
4207 (kp-decimal ?.)
4208 (kp-divide ?/)
4209 (kp-equal ?=)))
4211 ;;;;
4212 ;;;; forking a twin copy of a buffer.
4213 ;;;;
4215 (defvar clone-buffer-hook nil
4216 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
4218 (defun clone-process (process &optional newname)
4219 "Create a twin copy of PROCESS.
4220 If NEWNAME is nil, it defaults to PROCESS' name;
4221 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
4222 If PROCESS is associated with a buffer, the new process will be associated
4223 with the current buffer instead.
4224 Returns nil if PROCESS has already terminated."
4225 (setq newname (or newname (process-name process)))
4226 (if (string-match "<[0-9]+>\\'" newname)
4227 (setq newname (substring newname 0 (match-beginning 0))))
4228 (when (memq (process-status process) '(run stop open))
4229 (let* ((process-connection-type (process-tty-name process))
4230 (new-process
4231 (if (memq (process-status process) '(open))
4232 (let ((args (process-contact process t)))
4233 (setq args (plist-put args :name newname))
4234 (setq args (plist-put args :buffer
4235 (if (process-buffer process)
4236 (current-buffer))))
4237 (apply 'make-network-process args))
4238 (apply 'start-process newname
4239 (if (process-buffer process) (current-buffer))
4240 (process-command process)))))
4241 (set-process-query-on-exit-flag
4242 new-process (process-query-on-exit-flag process))
4243 (set-process-inherit-coding-system-flag
4244 new-process (process-inherit-coding-system-flag process))
4245 (set-process-filter new-process (process-filter process))
4246 (set-process-sentinel new-process (process-sentinel process))
4247 (set-process-plist new-process (copy-sequence (process-plist process)))
4248 new-process)))
4250 ;; things to maybe add (currently partly covered by `funcall mode'):
4251 ;; - syntax-table
4252 ;; - overlays
4253 (defun clone-buffer (&optional newname display-flag)
4254 "Create a twin copy of the current buffer.
4255 If NEWNAME is nil, it defaults to the current buffer's name;
4256 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
4258 If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
4259 This runs the normal hook `clone-buffer-hook' in the new buffer
4260 after it has been set up properly in other respects."
4261 (interactive
4262 (progn
4263 (if buffer-file-name
4264 (error "Cannot clone a file-visiting buffer"))
4265 (if (get major-mode 'no-clone)
4266 (error "Cannot clone a buffer in %s mode" mode-name))
4267 (list (if current-prefix-arg (read-string "Name: "))
4268 t)))
4269 (if buffer-file-name
4270 (error "Cannot clone a file-visiting buffer"))
4271 (if (get major-mode 'no-clone)
4272 (error "Cannot clone a buffer in %s mode" mode-name))
4273 (setq newname (or newname (buffer-name)))
4274 (if (string-match "<[0-9]+>\\'" newname)
4275 (setq newname (substring newname 0 (match-beginning 0))))
4276 (let ((buf (current-buffer))
4277 (ptmin (point-min))
4278 (ptmax (point-max))
4279 (pt (point))
4280 (mk (if mark-active (mark t)))
4281 (modified (buffer-modified-p))
4282 (mode major-mode)
4283 (lvars (buffer-local-variables))
4284 (process (get-buffer-process (current-buffer)))
4285 (new (generate-new-buffer (or newname (buffer-name)))))
4286 (save-restriction
4287 (widen)
4288 (with-current-buffer new
4289 (insert-buffer-substring buf)))
4290 (with-current-buffer new
4291 (narrow-to-region ptmin ptmax)
4292 (goto-char pt)
4293 (if mk (set-mark mk))
4294 (set-buffer-modified-p modified)
4296 ;; Clone the old buffer's process, if any.
4297 (when process (clone-process process))
4299 ;; Now set up the major mode.
4300 (funcall mode)
4302 ;; Set up other local variables.
4303 (mapcar (lambda (v)
4304 (condition-case () ;in case var is read-only
4305 (if (symbolp v)
4306 (makunbound v)
4307 (set (make-local-variable (car v)) (cdr v)))
4308 (error nil)))
4309 lvars)
4311 ;; Run any hooks (typically set up by the major mode
4312 ;; for cloning to work properly).
4313 (run-hooks 'clone-buffer-hook))
4314 (if display-flag (pop-to-buffer new))
4315 new))
4318 (defun clone-indirect-buffer (newname display-flag &optional norecord)
4319 "Create an indirect buffer that is a twin copy of the current buffer.
4321 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
4322 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
4323 or if not called with a prefix arg, NEWNAME defaults to the current
4324 buffer's name. The name is modified by adding a `<N>' suffix to it
4325 or by incrementing the N in an existing suffix.
4327 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
4328 This is always done when called interactively.
4330 Optional last arg NORECORD non-nil means do not put this buffer at the
4331 front of the list of recently selected ones."
4332 (interactive
4333 (progn
4334 (if (get major-mode 'no-clone-indirect)
4335 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
4336 (list (if current-prefix-arg
4337 (read-string "BName of indirect buffer: "))
4338 t)))
4339 (if (get major-mode 'no-clone-indirect)
4340 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
4341 (setq newname (or newname (buffer-name)))
4342 (if (string-match "<[0-9]+>\\'" newname)
4343 (setq newname (substring newname 0 (match-beginning 0))))
4344 (let* ((name (generate-new-buffer-name newname))
4345 (buffer (make-indirect-buffer (current-buffer) name t)))
4346 (when display-flag
4347 (pop-to-buffer buffer norecord))
4348 buffer))
4351 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
4352 "Create an indirect buffer that is a twin copy of BUFFER.
4353 Select the new buffer in another window.
4354 Optional second arg NORECORD non-nil means do not put this buffer at
4355 the front of the list of recently selected ones."
4356 (interactive "bClone buffer in other window: ")
4357 (let ((pop-up-windows t))
4358 (set-buffer buffer)
4359 (clone-indirect-buffer nil t norecord)))
4361 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
4363 ;;; Handling of Backspace and Delete keys.
4365 (defcustom normal-erase-is-backspace nil
4366 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
4368 On window systems, the default value of this option is chosen
4369 according to the keyboard used. If the keyboard has both a Backspace
4370 key and a Delete key, and both are mapped to their usual meanings, the
4371 option's default value is set to t, so that Backspace can be used to
4372 delete backward, and Delete can be used to delete forward.
4374 If not running under a window system, customizing this option accomplishes
4375 a similar effect by mapping C-h, which is usually generated by the
4376 Backspace key, to DEL, and by mapping DEL to C-d via
4377 `keyboard-translate'. The former functionality of C-h is available on
4378 the F1 key. You should probably not use this setting if you don't
4379 have both Backspace, Delete and F1 keys.
4381 Setting this variable with setq doesn't take effect. Programmatically,
4382 call `normal-erase-is-backspace-mode' (which see) instead."
4383 :type 'boolean
4384 :group 'editing-basics
4385 :version "21.1"
4386 :set (lambda (symbol value)
4387 ;; The fboundp is because of a problem with :set when
4388 ;; dumping Emacs. It doesn't really matter.
4389 (if (fboundp 'normal-erase-is-backspace-mode)
4390 (normal-erase-is-backspace-mode (or value 0))
4391 (set-default symbol value))))
4394 (defun normal-erase-is-backspace-mode (&optional arg)
4395 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
4397 With numeric arg, turn the mode on if and only if ARG is positive.
4399 On window systems, when this mode is on, Delete is mapped to C-d and
4400 Backspace is mapped to DEL; when this mode is off, both Delete and
4401 Backspace are mapped to DEL. (The remapping goes via
4402 `function-key-map', so binding Delete or Backspace in the global or
4403 local keymap will override that.)
4405 In addition, on window systems, the bindings of C-Delete, M-Delete,
4406 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
4407 the global keymap in accordance with the functionality of Delete and
4408 Backspace. For example, if Delete is remapped to C-d, which deletes
4409 forward, C-Delete is bound to `kill-word', but if Delete is remapped
4410 to DEL, which deletes backward, C-Delete is bound to
4411 `backward-kill-word'.
4413 If not running on a window system, a similar effect is accomplished by
4414 remapping C-h (normally produced by the Backspace key) and DEL via
4415 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
4416 to C-d; if it's off, the keys are not remapped.
4418 When not running on a window system, and this mode is turned on, the
4419 former functionality of C-h is available on the F1 key. You should
4420 probably not turn on this mode on a text-only terminal if you don't
4421 have both Backspace, Delete and F1 keys.
4423 See also `normal-erase-is-backspace'."
4424 (interactive "P")
4425 (setq normal-erase-is-backspace
4426 (if arg
4427 (> (prefix-numeric-value arg) 0)
4428 (not normal-erase-is-backspace)))
4430 (cond ((or (memq window-system '(x w32 mac pc))
4431 (memq system-type '(ms-dos windows-nt)))
4432 (let ((bindings
4433 `(([C-delete] [C-backspace])
4434 ([M-delete] [M-backspace])
4435 ([C-M-delete] [C-M-backspace])
4436 (,esc-map
4437 [C-delete] [C-backspace])))
4438 (old-state (lookup-key function-key-map [delete])))
4440 (if normal-erase-is-backspace
4441 (progn
4442 (define-key function-key-map [delete] [?\C-d])
4443 (define-key function-key-map [kp-delete] [?\C-d])
4444 (define-key function-key-map [backspace] [?\C-?]))
4445 (define-key function-key-map [delete] [?\C-?])
4446 (define-key function-key-map [kp-delete] [?\C-?])
4447 (define-key function-key-map [backspace] [?\C-?]))
4449 ;; Maybe swap bindings of C-delete and C-backspace, etc.
4450 (unless (equal old-state (lookup-key function-key-map [delete]))
4451 (dolist (binding bindings)
4452 (let ((map global-map))
4453 (when (keymapp (car binding))
4454 (setq map (car binding) binding (cdr binding)))
4455 (let* ((key1 (nth 0 binding))
4456 (key2 (nth 1 binding))
4457 (binding1 (lookup-key map key1))
4458 (binding2 (lookup-key map key2)))
4459 (define-key map key1 binding2)
4460 (define-key map key2 binding1)))))))
4462 (if normal-erase-is-backspace
4463 (progn
4464 (keyboard-translate ?\C-h ?\C-?)
4465 (keyboard-translate ?\C-? ?\C-d))
4466 (keyboard-translate ?\C-h ?\C-h)
4467 (keyboard-translate ?\C-? ?\C-?))))
4469 (run-hooks 'normal-erase-is-backspace-hook)
4470 (if (interactive-p)
4471 (message "Delete key deletes %s"
4472 (if normal-erase-is-backspace "forward" "backward"))))
4474 (defcustom idle-update-delay 0.5
4475 "*Idle time delay before updating various things on the screen.
4476 Various Emacs features that update auxiliary information when point moves
4477 wait this many seconds after Emacs becomes idle before doing an update."
4478 :type 'number
4479 :group 'display
4480 :version "21.4")
4483 ;; Minibuffer prompt stuff.
4485 ;(defun minibuffer-prompt-modification (start end)
4486 ; (error "You cannot modify the prompt"))
4489 ;(defun minibuffer-prompt-insertion (start end)
4490 ; (let ((inhibit-modification-hooks t))
4491 ; (delete-region start end)
4492 ; ;; Discard undo information for the text insertion itself
4493 ; ;; and for the text deletion.above.
4494 ; (when (consp buffer-undo-list)
4495 ; (setq buffer-undo-list (cddr buffer-undo-list)))
4496 ; (message "You cannot modify the prompt")))
4499 ;(setq minibuffer-prompt-properties
4500 ; (list 'modification-hooks '(minibuffer-prompt-modification)
4501 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
4504 (provide 'simple)
4505 ;;; simple.el ends here