(cvs-retrieve-revision): Make sure HEAD gets you the head of the branch.
[emacs.git] / lisp / simple.el
blobf0c119e4a631cb5894914c51e5e6bde18706aec5
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 (let ((limit (line-end-position)))
372 (skip-syntax-forward " " limit))
373 ;; Move back over chars that have whitespace syntax but have the p flag.
374 (backward-prefix-chars))
376 (defun fixup-whitespace ()
377 "Fixup white space between objects around point.
378 Leave one space or none, according to the context."
379 (interactive "*")
380 (save-excursion
381 (delete-horizontal-space)
382 (if (or (looking-at "^\\|\\s)")
383 (save-excursion (forward-char -1)
384 (looking-at "$\\|\\s(\\|\\s'")))
386 (insert ?\ ))))
388 (defun delete-horizontal-space (&optional backward-only)
389 "Delete all spaces and tabs around point.
390 If BACKWARD-ONLY is non-nil, only delete spaces before point."
391 (interactive "*")
392 (let ((orig-pos (point)))
393 (delete-region
394 (if backward-only
395 orig-pos
396 (progn
397 (skip-chars-forward " \t")
398 (constrain-to-field nil orig-pos t)))
399 (progn
400 (skip-chars-backward " \t")
401 (constrain-to-field nil orig-pos)))))
403 (defun just-one-space ()
404 "Delete all spaces and tabs around point, leaving one space."
405 (interactive "*")
406 (let ((orig-pos (point)))
407 (skip-chars-backward " \t")
408 (constrain-to-field nil orig-pos)
409 (if (= (following-char) ? )
410 (forward-char 1)
411 (insert ? ))
412 (delete-region
413 (point)
414 (progn
415 (skip-chars-forward " \t")
416 (constrain-to-field nil orig-pos t)))))
418 (defun beginning-of-buffer (&optional arg)
419 "Move point to the beginning of the buffer; leave mark at previous position.
420 With arg N, put point N/10 of the way from the beginning.
422 If the buffer is narrowed, this command uses the beginning and size
423 of the accessible part of the buffer.
425 Don't use this command in Lisp programs!
426 \(goto-char (point-min)) is faster and avoids clobbering the mark."
427 (interactive "P")
428 (push-mark)
429 (let ((size (- (point-max) (point-min))))
430 (goto-char (if arg
431 (+ (point-min)
432 (if (> size 10000)
433 ;; Avoid overflow for large buffer sizes!
434 (* (prefix-numeric-value arg)
435 (/ size 10))
436 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
437 (point-min))))
438 (if arg (forward-line 1)))
440 (defun end-of-buffer (&optional arg)
441 "Move point to the end of the buffer; leave mark at previous position.
442 With arg N, put point N/10 of the way from the end.
444 If the buffer is narrowed, this command uses the beginning and size
445 of the accessible part of the buffer.
447 Don't use this command in Lisp programs!
448 \(goto-char (point-max)) is faster and avoids clobbering the mark."
449 (interactive "P")
450 (push-mark)
451 (let ((size (- (point-max) (point-min))))
452 (goto-char (if arg
453 (- (point-max)
454 (if (> size 10000)
455 ;; Avoid overflow for large buffer sizes!
456 (* (prefix-numeric-value arg)
457 (/ size 10))
458 (/ (* size (prefix-numeric-value arg)) 10)))
459 (point-max))))
460 ;; If we went to a place in the middle of the buffer,
461 ;; adjust it to the beginning of a line.
462 (cond (arg (forward-line 1))
463 ((> (point) (window-end nil t))
464 ;; If the end of the buffer is not already on the screen,
465 ;; then scroll specially to put it near, but not at, the bottom.
466 (overlay-recenter (point))
467 (recenter -3))))
469 (defun mark-whole-buffer ()
470 "Put point at beginning and mark at end of buffer.
471 You probably should not use this function in Lisp programs;
472 it is usually a mistake for a Lisp function to use any subroutine
473 that uses or sets the mark."
474 (interactive)
475 (push-mark (point))
476 (push-mark (point-max) nil t)
477 (goto-char (point-min)))
480 ;; Counting lines, one way or another.
482 (defun goto-line (arg)
483 "Goto line ARG, counting from line 1 at beginning of buffer."
484 (interactive "NGoto line: ")
485 (setq arg (prefix-numeric-value arg))
486 (save-restriction
487 (widen)
488 (goto-char 1)
489 (if (eq selective-display t)
490 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
491 (forward-line (1- arg)))))
493 (defun count-lines-region (start end)
494 "Print number of lines and characters in the region."
495 (interactive "r")
496 (message "Region has %d lines, %d characters"
497 (count-lines start end) (- end start)))
499 (defun what-line ()
500 "Print the current buffer line number and narrowed line number of point."
501 (interactive)
502 (let ((opoint (point)) start)
503 (save-excursion
504 (save-restriction
505 (goto-char (point-min))
506 (widen)
507 (forward-line 0)
508 (setq start (point))
509 (goto-char opoint)
510 (forward-line 0)
511 (if (/= start (point-min))
512 (message "line %d (narrowed line %d)"
513 (1+ (count-lines (point-min) (point)))
514 (1+ (count-lines start (point))))
515 (message "Line %d" (1+ (count-lines (point-min) (point)))))))))
517 (defun count-lines (start end)
518 "Return number of lines between START and END.
519 This is usually the number of newlines between them,
520 but can be one more if START is not equal to END
521 and the greater of them is not at the start of a line."
522 (save-excursion
523 (save-restriction
524 (narrow-to-region start end)
525 (goto-char (point-min))
526 (if (eq selective-display t)
527 (save-match-data
528 (let ((done 0))
529 (while (re-search-forward "[\n\C-m]" nil t 40)
530 (setq done (+ 40 done)))
531 (while (re-search-forward "[\n\C-m]" nil t 1)
532 (setq done (+ 1 done)))
533 (goto-char (point-max))
534 (if (and (/= start end)
535 (not (bolp)))
536 (1+ done)
537 done)))
538 (- (buffer-size) (forward-line (buffer-size)))))))
540 (defun what-cursor-position (&optional detail)
541 "Print info on cursor position (on screen and within buffer).
542 Also describe the character after point, and give its character code
543 in octal, decimal and hex.
545 For a non-ASCII multibyte character, also give its encoding in the
546 buffer's selected coding system if the coding system encodes the
547 character safely. If the character is encoded into one byte, that
548 code is shown in hex. If the character is encoded into more than one
549 byte, just \"...\" is shown.
551 In addition, with prefix argument, show details about that character
552 in *Help* buffer. See also the command `describe-char'."
553 (interactive "P")
554 (let* ((char (following-char))
555 (beg (point-min))
556 (end (point-max))
557 (pos (point))
558 (total (buffer-size))
559 (percent (if (> total 50000)
560 ;; Avoid overflow from multiplying by 100!
561 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
562 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
563 (hscroll (if (= (window-hscroll) 0)
565 (format " Hscroll=%d" (window-hscroll))))
566 (col (current-column)))
567 (if (= pos end)
568 (if (or (/= beg 1) (/= end (1+ total)))
569 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
570 pos total percent beg end col hscroll)
571 (message "point=%d of %d (%d%%) column %d %s"
572 pos total percent col hscroll))
573 (let ((coding buffer-file-coding-system)
574 encoded encoding-msg)
575 (if (or (not coding)
576 (eq (coding-system-type coding) t))
577 (setq coding default-buffer-file-coding-system))
578 (if (not (char-valid-p char))
579 (setq encoding-msg
580 (format "(0%o, %d, 0x%x, invalid)" char char char))
581 (setq encoded (and (>= char 128) (encode-coding-char char coding)))
582 (setq encoding-msg
583 (if encoded
584 (format "(0%o, %d, 0x%x, file %s)"
585 char char char
586 (if (> (length encoded) 1)
587 "..."
588 (encoded-string-description encoded coding)))
589 (format "(0%o, %d, 0x%x)" char char char))))
590 (if detail
591 ;; We show the detailed information about CHAR.
592 (describe-char (point)))
593 (if (or (/= beg 1) (/= end (1+ total)))
594 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
595 (if (< char 256)
596 (single-key-description char)
597 (buffer-substring-no-properties (point) (1+ (point))))
598 encoding-msg pos total percent beg end col hscroll)
599 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
600 (if (< char 256)
601 (single-key-description char)
602 (buffer-substring-no-properties (point) (1+ (point))))
603 encoding-msg pos total percent col hscroll))))))
605 (defvar read-expression-map
606 (let ((m (make-sparse-keymap)))
607 (define-key m "\M-\t" 'lisp-complete-symbol)
608 (set-keymap-parent m minibuffer-local-map)
610 "Minibuffer keymap used for reading Lisp expressions.")
612 (defvar read-expression-history nil)
614 (defcustom eval-expression-print-level 4
615 "*Value to use for `print-level' when printing value in `eval-expression'.
616 A value of nil means no limit."
617 :group 'lisp
618 :type '(choice (const :tag "No Limit" nil) integer)
619 :version "21.1")
621 (defcustom eval-expression-print-length 12
622 "*Value to use for `print-length' when printing value in `eval-expression'.
623 A value of nil means no limit."
624 :group 'lisp
625 :type '(choice (const :tag "No Limit" nil) integer)
626 :version "21.1")
628 (defcustom eval-expression-debug-on-error t
629 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
630 If nil, don't change the value of `debug-on-error'."
631 :group 'lisp
632 :type 'boolean
633 :version "21.1")
635 ;; We define this, rather than making `eval' interactive,
636 ;; for the sake of completion of names like eval-region, eval-current-buffer.
637 (defun eval-expression (eval-expression-arg
638 &optional eval-expression-insert-value)
639 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
640 Value is also consed on to front of the variable `values'.
641 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
642 insert the result into the current buffer instead of printing it in
643 the echo area."
644 (interactive
645 (list (read-from-minibuffer "Eval: "
646 nil read-expression-map t
647 'read-expression-history)
648 current-prefix-arg))
650 (if (null eval-expression-debug-on-error)
651 (setq values (cons (eval eval-expression-arg) values))
652 (let ((old-value (make-symbol "t")) new-value)
653 ;; Bind debug-on-error to something unique so that we can
654 ;; detect when evaled code changes it.
655 (let ((debug-on-error old-value))
656 (setq values (cons (eval eval-expression-arg) values))
657 (setq new-value debug-on-error))
658 ;; If evaled code has changed the value of debug-on-error,
659 ;; propagate that change to the global binding.
660 (unless (eq old-value new-value)
661 (setq debug-on-error new-value))))
663 (let ((print-length eval-expression-print-length)
664 (print-level eval-expression-print-level))
665 (prin1 (car values)
666 (if eval-expression-insert-value (current-buffer) t))))
668 (defun edit-and-eval-command (prompt command)
669 "Prompting with PROMPT, let user edit COMMAND and eval result.
670 COMMAND is a Lisp expression. Let user edit that expression in
671 the minibuffer, then read and evaluate the result."
672 (let ((command
673 (unwind-protect
674 (read-from-minibuffer prompt
675 (prin1-to-string command)
676 read-expression-map t
677 '(command-history . 1))
678 ;; If command was added to command-history as a string,
679 ;; get rid of that. We want only evaluable expressions there.
680 (if (stringp (car command-history))
681 (setq command-history (cdr command-history))))))
683 ;; If command to be redone does not match front of history,
684 ;; add it to the history.
685 (or (equal command (car command-history))
686 (setq command-history (cons command command-history)))
687 (eval command)))
689 (defun repeat-complex-command (arg)
690 "Edit and re-evaluate last complex command, or ARGth from last.
691 A complex command is one which used the minibuffer.
692 The command is placed in the minibuffer as a Lisp form for editing.
693 The result is executed, repeating the command as changed.
694 If the command has been changed or is not the most recent previous command
695 it is added to the front of the command history.
696 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
697 to get different commands to edit and resubmit."
698 (interactive "p")
699 (let ((elt (nth (1- arg) command-history))
700 newcmd)
701 (if elt
702 (progn
703 (setq newcmd
704 (let ((print-level nil)
705 (minibuffer-history-position arg)
706 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
707 (unwind-protect
708 (read-from-minibuffer
709 "Redo: " (prin1-to-string elt) read-expression-map t
710 (cons 'command-history arg))
712 ;; If command was added to command-history as a
713 ;; string, get rid of that. We want only
714 ;; evaluable expressions there.
715 (if (stringp (car command-history))
716 (setq command-history (cdr command-history))))))
718 ;; If command to be redone does not match front of history,
719 ;; add it to the history.
720 (or (equal newcmd (car command-history))
721 (setq command-history (cons newcmd command-history)))
722 (eval newcmd))
723 (if command-history
724 (error "Argument %d is beyond length of command history" arg)
725 (error "There are no previous complex commands to repeat")))))
727 (defvar minibuffer-history nil
728 "Default minibuffer history list.
729 This is used for all minibuffer input
730 except when an alternate history list is specified.")
731 (defvar minibuffer-history-sexp-flag nil
732 "Non-nil when doing history operations on the variable `command-history'.
733 More generally, indicates that the history list being acted on
734 contains expressions rather than strings.
735 It is only valid if its value equals the current minibuffer depth,
736 to handle recursive uses of the minibuffer.")
737 (setq minibuffer-history-variable 'minibuffer-history)
738 (setq minibuffer-history-position nil)
739 (defvar minibuffer-history-search-history nil)
741 (defvar minibuffer-text-before-history nil
742 "Text that was in this minibuffer before any history commands.
743 This is nil if there have not yet been any history commands
744 in this use of the minibuffer.")
746 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
748 (defun minibuffer-history-initialize ()
749 (setq minibuffer-text-before-history nil))
751 (defun minibuffer-avoid-prompt (new old)
752 "A point-motion hook for the minibuffer, that moves point out of the prompt."
753 (constrain-to-field nil (point-max)))
755 (defcustom minibuffer-history-case-insensitive-variables nil
756 "*Minibuffer history variables for which matching should ignore case.
757 If a history variable is a member of this list, then the
758 \\[previous-matching-history-element] and \\[next-matching-history-element]\
759 commands ignore case when searching it, regardless of `case-fold-search'."
760 :type '(repeat variable)
761 :group 'minibuffer)
763 (defun previous-matching-history-element (regexp n)
764 "Find the previous history element that matches REGEXP.
765 \(Previous history elements refer to earlier actions.)
766 With prefix argument N, search for Nth previous match.
767 If N is negative, find the next or Nth next match.
768 Normally, history elements are matched case-insensitively if
769 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
770 makes the search case-sensitive.
771 See also `minibuffer-history-case-insensitive-variables'."
772 (interactive
773 (let* ((enable-recursive-minibuffers t)
774 (regexp (read-from-minibuffer "Previous element matching (regexp): "
776 minibuffer-local-map
778 'minibuffer-history-search-history)))
779 ;; Use the last regexp specified, by default, if input is empty.
780 (list (if (string= regexp "")
781 (if minibuffer-history-search-history
782 (car minibuffer-history-search-history)
783 (error "No previous history search regexp"))
784 regexp)
785 (prefix-numeric-value current-prefix-arg))))
786 (unless (zerop n)
787 (if (and (zerop minibuffer-history-position)
788 (null minibuffer-text-before-history))
789 (setq minibuffer-text-before-history
790 (minibuffer-contents-no-properties)))
791 (let ((history (symbol-value minibuffer-history-variable))
792 (case-fold-search
793 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
794 ;; On some systems, ignore case for file names.
795 (if (memq minibuffer-history-variable
796 minibuffer-history-case-insensitive-variables)
798 ;; Respect the user's setting for case-fold-search:
799 case-fold-search)
800 nil))
801 prevpos
802 match-string
803 match-offset
804 (pos minibuffer-history-position))
805 (while (/= n 0)
806 (setq prevpos pos)
807 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
808 (when (= pos prevpos)
809 (error (if (= pos 1)
810 "No later matching history item"
811 "No earlier matching history item")))
812 (setq match-string
813 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
814 (let ((print-level nil))
815 (prin1-to-string (nth (1- pos) history)))
816 (nth (1- pos) history)))
817 (setq match-offset
818 (if (< n 0)
819 (and (string-match regexp match-string)
820 (match-end 0))
821 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
822 (match-beginning 1))))
823 (when match-offset
824 (setq n (+ n (if (< n 0) 1 -1)))))
825 (setq minibuffer-history-position pos)
826 (goto-char (point-max))
827 (delete-minibuffer-contents)
828 (insert match-string)
829 (goto-char (+ (minibuffer-prompt-end) match-offset))))
830 (if (memq (car (car command-history)) '(previous-matching-history-element
831 next-matching-history-element))
832 (setq command-history (cdr command-history))))
834 (defun next-matching-history-element (regexp n)
835 "Find the next history element that matches REGEXP.
836 \(The next history element refers to a more recent action.)
837 With prefix argument N, search for Nth next match.
838 If N is negative, find the previous or Nth previous match.
839 Normally, history elements are matched case-insensitively if
840 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
841 makes the search case-sensitive."
842 (interactive
843 (let* ((enable-recursive-minibuffers t)
844 (regexp (read-from-minibuffer "Next element matching (regexp): "
846 minibuffer-local-map
848 'minibuffer-history-search-history)))
849 ;; Use the last regexp specified, by default, if input is empty.
850 (list (if (string= regexp "")
851 (setcar minibuffer-history-search-history
852 (nth 1 minibuffer-history-search-history))
853 regexp)
854 (prefix-numeric-value current-prefix-arg))))
855 (previous-matching-history-element regexp (- n)))
857 (defvar minibuffer-temporary-goal-position nil)
859 (defun next-history-element (n)
860 "Insert the next element of the minibuffer history into the minibuffer."
861 (interactive "p")
862 (or (zerop n)
863 (let ((narg (- minibuffer-history-position n))
864 (minimum (if minibuffer-default -1 0))
865 elt minibuffer-returned-to-present)
866 (if (and (zerop minibuffer-history-position)
867 (null minibuffer-text-before-history))
868 (setq minibuffer-text-before-history
869 (minibuffer-contents-no-properties)))
870 (if (< narg minimum)
871 (if minibuffer-default
872 (error "End of history; no next item")
873 (error "End of history; no default available")))
874 (if (> narg (length (symbol-value minibuffer-history-variable)))
875 (error "Beginning of history; no preceding item"))
876 (unless (memq last-command '(next-history-element
877 previous-history-element))
878 (let ((prompt-end (minibuffer-prompt-end)))
879 (set (make-local-variable 'minibuffer-temporary-goal-position)
880 (cond ((<= (point) prompt-end) prompt-end)
881 ((eobp) nil)
882 (t (point))))))
883 (goto-char (point-max))
884 (delete-minibuffer-contents)
885 (setq minibuffer-history-position narg)
886 (cond ((= narg -1)
887 (setq elt minibuffer-default))
888 ((= narg 0)
889 (setq elt (or minibuffer-text-before-history ""))
890 (setq minibuffer-returned-to-present t)
891 (setq minibuffer-text-before-history nil))
892 (t (setq elt (nth (1- minibuffer-history-position)
893 (symbol-value minibuffer-history-variable)))))
894 (insert
895 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
896 (not minibuffer-returned-to-present))
897 (let ((print-level nil))
898 (prin1-to-string elt))
899 elt))
900 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
902 (defun previous-history-element (n)
903 "Inserts the previous element of the minibuffer history into the minibuffer."
904 (interactive "p")
905 (next-history-element (- n)))
907 (defun next-complete-history-element (n)
908 "Get next history element which completes the minibuffer before the point.
909 The contents of the minibuffer after the point are deleted, and replaced
910 by the new completion."
911 (interactive "p")
912 (let ((point-at-start (point)))
913 (next-matching-history-element
914 (concat
915 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
917 ;; next-matching-history-element always puts us at (point-min).
918 ;; Move to the position we were at before changing the buffer contents.
919 ;; This is still sensical, because the text before point has not changed.
920 (goto-char point-at-start)))
922 (defun previous-complete-history-element (n)
924 Get previous history element which completes the minibuffer before the point.
925 The contents of the minibuffer after the point are deleted, and replaced
926 by the new completion."
927 (interactive "p")
928 (next-complete-history-element (- n)))
930 ;; For compatibility with the old subr of the same name.
931 (defun minibuffer-prompt-width ()
932 "Return the display width of the minibuffer prompt.
933 Return 0 if current buffer is not a mini-buffer."
934 ;; Return the width of everything before the field at the end of
935 ;; the buffer; this should be 0 for normal buffers.
936 (1- (minibuffer-prompt-end)))
938 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
939 (defalias 'advertised-undo 'undo)
941 (defun undo (&optional arg)
942 "Undo some previous changes.
943 Repeat this command to undo more changes.
944 A numeric argument serves as a repeat count.
946 In Transient Mark mode when the mark is active, only undo changes within
947 the current region. Similarly, when not in Transient Mark mode, just C-u
948 as an argument limits undo to changes within the current region."
949 (interactive "*P")
950 ;; Make last-command indicate for the next command that this was an undo.
951 ;; That way, another undo will undo more.
952 ;; If we get to the end of the undo history and get an error,
953 ;; another undo command will find the undo history empty
954 ;; and will get another error. To begin undoing the undos,
955 ;; you must type some other command.
956 (setq this-command 'undo)
957 (let ((modified (buffer-modified-p))
958 (recent-save (recent-auto-save-p)))
959 (or (eq (selected-window) (minibuffer-window))
960 (message (if (and transient-mark-mode mark-active)
961 "Undo in region!"
962 "Undo!")))
963 (unless (eq last-command 'undo)
964 (if (if transient-mark-mode mark-active (and arg (not (numberp arg))))
965 (undo-start (region-beginning) (region-end))
966 (undo-start))
967 ;; get rid of initial undo boundary
968 (undo-more 1))
969 (undo-more
970 (if (or transient-mark-mode (numberp arg))
971 (prefix-numeric-value arg)
973 ;; Don't specify a position in the undo record for the undo command.
974 ;; Instead, undoing this should move point to where the change is.
975 (let ((tail buffer-undo-list)
976 (prev nil))
977 (while (car tail)
978 (when (integerp (car tail))
979 (let ((pos (car tail)))
980 (if (null prev)
981 (setq buffer-undo-list (cdr tail))
982 (setcdr prev (cdr tail)))
983 (setq tail (cdr tail))
984 (while (car tail)
985 (if (eq pos (car tail))
986 (if prev
987 (setcdr prev (cdr tail))
988 (setq buffer-undo-list (cdr tail)))
989 (setq prev tail))
990 (setq tail (cdr tail)))
991 (setq tail nil)))
992 (setq prev tail tail (cdr tail))))
994 (and modified (not (buffer-modified-p))
995 (delete-auto-save-file-if-necessary recent-save))))
997 (defvar pending-undo-list nil
998 "Within a run of consecutive undo commands, list remaining to be undone.")
1000 (defvar undo-in-progress nil
1001 "Non-nil while performing an undo.
1002 Some change-hooks test this variable to do something different.")
1004 (defun undo-more (count)
1005 "Undo back N undo-boundaries beyond what was already undone recently.
1006 Call `undo-start' to get ready to undo recent changes,
1007 then call `undo-more' one or more times to undo them."
1008 (or pending-undo-list
1009 (error (format "No further undo information%s"
1010 (if (and transient-mark-mode mark-active)
1011 " for region" ""))))
1012 (let ((undo-in-progress t))
1013 (setq pending-undo-list (primitive-undo count pending-undo-list))))
1015 ;; Deep copy of a list
1016 (defun undo-copy-list (list)
1017 "Make a copy of undo list LIST."
1018 (mapcar 'undo-copy-list-1 list))
1020 (defun undo-copy-list-1 (elt)
1021 (if (consp elt)
1022 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1023 elt))
1025 (defun undo-start (&optional beg end)
1026 "Set `pending-undo-list' to the front of the undo list.
1027 The next call to `undo-more' will undo the most recently made change.
1028 If BEG and END are specified, then only undo elements
1029 that apply to text between BEG and END are used; other undo elements
1030 are ignored. If BEG and END are nil, all undo elements are used."
1031 (if (eq buffer-undo-list t)
1032 (error "No undo information in this buffer"))
1033 (setq pending-undo-list
1034 (if (and beg end (not (= beg end)))
1035 (undo-make-selective-list (min beg end) (max beg end))
1036 buffer-undo-list)))
1038 (defvar undo-adjusted-markers)
1040 (defun undo-make-selective-list (start end)
1041 "Return a list of undo elements for the region START to END.
1042 The elements come from `buffer-undo-list', but we keep only
1043 the elements inside this region, and discard those outside this region.
1044 If we find an element that crosses an edge of this region,
1045 we stop and ignore all further elements."
1046 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1047 (undo-list (list nil))
1048 undo-adjusted-markers
1049 some-rejected
1050 undo-elt undo-elt temp-undo-list delta)
1051 (while undo-list-copy
1052 (setq undo-elt (car undo-list-copy))
1053 (let ((keep-this
1054 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1055 ;; This is a "was unmodified" element.
1056 ;; Keep it if we have kept everything thus far.
1057 (not some-rejected))
1059 (undo-elt-in-region undo-elt start end)))))
1060 (if keep-this
1061 (progn
1062 (setq end (+ end (cdr (undo-delta undo-elt))))
1063 ;; Don't put two nils together in the list
1064 (if (not (and (eq (car undo-list) nil)
1065 (eq undo-elt nil)))
1066 (setq undo-list (cons undo-elt undo-list))))
1067 (if (undo-elt-crosses-region undo-elt start end)
1068 (setq undo-list-copy nil)
1069 (setq some-rejected t)
1070 (setq temp-undo-list (cdr undo-list-copy))
1071 (setq delta (undo-delta undo-elt))
1073 (when (/= (cdr delta) 0)
1074 (let ((position (car delta))
1075 (offset (cdr delta)))
1077 ;; Loop down the earlier events adjusting their buffer
1078 ;; positions to reflect the fact that a change to the buffer
1079 ;; isn't being undone. We only need to process those element
1080 ;; types which undo-elt-in-region will return as being in
1081 ;; the region since only those types can ever get into the
1082 ;; output
1084 (while temp-undo-list
1085 (setq undo-elt (car temp-undo-list))
1086 (cond ((integerp undo-elt)
1087 (if (>= undo-elt position)
1088 (setcar temp-undo-list (- undo-elt offset))))
1089 ((atom undo-elt) nil)
1090 ((stringp (car undo-elt))
1091 ;; (TEXT . POSITION)
1092 (let ((text-pos (abs (cdr undo-elt)))
1093 (point-at-end (< (cdr undo-elt) 0 )))
1094 (if (>= text-pos position)
1095 (setcdr undo-elt (* (if point-at-end -1 1)
1096 (- text-pos offset))))))
1097 ((integerp (car undo-elt))
1098 ;; (BEGIN . END)
1099 (when (>= (car undo-elt) position)
1100 (setcar undo-elt (- (car undo-elt) offset))
1101 (setcdr undo-elt (- (cdr undo-elt) offset))))
1102 ((null (car undo-elt))
1103 ;; (nil PROPERTY VALUE BEG . END)
1104 (let ((tail (nthcdr 3 undo-elt)))
1105 (when (>= (car tail) position)
1106 (setcar tail (- (car tail) offset))
1107 (setcdr tail (- (cdr tail) offset))))))
1108 (setq temp-undo-list (cdr temp-undo-list))))))))
1109 (setq undo-list-copy (cdr undo-list-copy)))
1110 (nreverse undo-list)))
1112 (defun undo-elt-in-region (undo-elt start end)
1113 "Determine whether UNDO-ELT falls inside the region START ... END.
1114 If it crosses the edge, we return nil."
1115 (cond ((integerp undo-elt)
1116 (and (>= undo-elt start)
1117 (<= undo-elt end)))
1118 ((eq undo-elt nil)
1120 ((atom undo-elt)
1121 nil)
1122 ((stringp (car undo-elt))
1123 ;; (TEXT . POSITION)
1124 (and (>= (abs (cdr undo-elt)) start)
1125 (< (abs (cdr undo-elt)) end)))
1126 ((and (consp undo-elt) (markerp (car undo-elt)))
1127 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1128 ;; See if MARKER is inside the region.
1129 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1130 (unless alist-elt
1131 (setq alist-elt (cons (car undo-elt)
1132 (marker-position (car undo-elt))))
1133 (setq undo-adjusted-markers
1134 (cons alist-elt undo-adjusted-markers)))
1135 (and (cdr alist-elt)
1136 (>= (cdr alist-elt) start)
1137 (<= (cdr alist-elt) end))))
1138 ((null (car undo-elt))
1139 ;; (nil PROPERTY VALUE BEG . END)
1140 (let ((tail (nthcdr 3 undo-elt)))
1141 (and (>= (car tail) start)
1142 (<= (cdr tail) end))))
1143 ((integerp (car undo-elt))
1144 ;; (BEGIN . END)
1145 (and (>= (car undo-elt) start)
1146 (<= (cdr undo-elt) end)))))
1148 (defun undo-elt-crosses-region (undo-elt start end)
1149 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1150 This assumes we have already decided that UNDO-ELT
1151 is not *inside* the region START...END."
1152 (cond ((atom undo-elt) nil)
1153 ((null (car undo-elt))
1154 ;; (nil PROPERTY VALUE BEG . END)
1155 (let ((tail (nthcdr 3 undo-elt)))
1156 (not (or (< (car tail) end)
1157 (> (cdr tail) start)))))
1158 ((integerp (car undo-elt))
1159 ;; (BEGIN . END)
1160 (not (or (< (car undo-elt) end)
1161 (> (cdr undo-elt) start))))))
1163 ;; Return the first affected buffer position and the delta for an undo element
1164 ;; delta is defined as the change in subsequent buffer positions if we *did*
1165 ;; the undo.
1166 (defun undo-delta (undo-elt)
1167 (if (consp undo-elt)
1168 (cond ((stringp (car undo-elt))
1169 ;; (TEXT . POSITION)
1170 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1171 ((integerp (car undo-elt))
1172 ;; (BEGIN . END)
1173 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1175 '(0 . 0)))
1176 '(0 . 0)))
1178 (defvar shell-command-history nil
1179 "History list for some commands that read shell commands.")
1181 (defvar shell-command-switch "-c"
1182 "Switch used to have the shell execute its command line argument.")
1184 (defvar shell-command-default-error-buffer nil
1185 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1186 This buffer is used when `shell-command' or `shell-command-on-region'
1187 is run interactively. A value of nil means that output to stderr and
1188 stdout will be intermixed in the output stream.")
1190 (defun shell-command (command &optional output-buffer error-buffer)
1191 "Execute string COMMAND in inferior shell; display output, if any.
1192 With prefix argument, insert the COMMAND's output at point.
1194 If COMMAND ends in ampersand, execute it asynchronously.
1195 The output appears in the buffer `*Async Shell Command*'.
1196 That buffer is in shell mode.
1198 Otherwise, COMMAND is executed synchronously. The output appears in
1199 the buffer `*Shell Command Output*'. If the output is short enough to
1200 display in the echo area (which is determined by the variables
1201 `resize-mini-windows' and `max-mini-window-height'), it is shown
1202 there, but it is nonetheless available in buffer `*Shell Command
1203 Output*' even though that buffer is not automatically displayed.
1205 To specify a coding system for converting non-ASCII characters
1206 in the shell command output, use \\[universal-coding-system-argument]
1207 before this command.
1209 Noninteractive callers can specify coding systems by binding
1210 `coding-system-for-read' and `coding-system-for-write'.
1212 The optional second argument OUTPUT-BUFFER, if non-nil,
1213 says to put the output in some other buffer.
1214 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1215 If OUTPUT-BUFFER is not a buffer and not nil,
1216 insert output in current buffer. (This cannot be done asynchronously.)
1217 In either case, the output is inserted after point (leaving mark after it).
1219 If the command terminates without error, but generates output,
1220 and you did not specify \"insert it in the current buffer\",
1221 the output can be displayed in the echo area or in its buffer.
1222 If the output is short enough to display in the echo area
1223 \(determined by the variable `max-mini-window-height' if
1224 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1225 the buffer containing the output is displayed.
1227 If there is output and an error, and you did not specify \"insert it
1228 in the current buffer\", a message about the error goes at the end
1229 of the output.
1231 If there is no output, or if output is inserted in the current buffer,
1232 then `*Shell Command Output*' is deleted.
1234 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1235 or buffer name to which to direct the command's standard error output.
1236 If it is nil, error output is mingled with regular output.
1237 In an interactive call, the variable `shell-command-default-error-buffer'
1238 specifies the value of ERROR-BUFFER."
1240 (interactive (list (read-from-minibuffer "Shell command: "
1241 nil nil nil 'shell-command-history)
1242 current-prefix-arg
1243 shell-command-default-error-buffer))
1244 ;; Look for a handler in case default-directory is a remote file name.
1245 (let ((handler
1246 (find-file-name-handler (directory-file-name default-directory)
1247 'shell-command)))
1248 (if handler
1249 (funcall handler 'shell-command command output-buffer error-buffer)
1250 (if (and output-buffer
1251 (not (or (bufferp output-buffer) (stringp output-buffer))))
1252 ;; Output goes in current buffer.
1253 (let ((error-file
1254 (if error-buffer
1255 (make-temp-file
1256 (expand-file-name "scor"
1257 (or small-temporary-file-directory
1258 temporary-file-directory)))
1259 nil)))
1260 (barf-if-buffer-read-only)
1261 (push-mark nil t)
1262 ;; We do not use -f for csh; we will not support broken use of
1263 ;; .cshrcs. Even the BSD csh manual says to use
1264 ;; "if ($?prompt) exit" before things which are not useful
1265 ;; non-interactively. Besides, if someone wants their other
1266 ;; aliases for shell commands then they can still have them.
1267 (call-process shell-file-name nil
1268 (if error-file
1269 (list t error-file)
1271 nil shell-command-switch command)
1272 (when (and error-file (file-exists-p error-file))
1273 (if (< 0 (nth 7 (file-attributes error-file)))
1274 (with-current-buffer (get-buffer-create error-buffer)
1275 (let ((pos-from-end (- (point-max) (point))))
1276 (or (bobp)
1277 (insert "\f\n"))
1278 ;; Do no formatting while reading error file,
1279 ;; because that can run a shell command, and we
1280 ;; don't want that to cause an infinite recursion.
1281 (format-insert-file error-file nil)
1282 ;; Put point after the inserted errors.
1283 (goto-char (- (point-max) pos-from-end)))
1284 (display-buffer (current-buffer))))
1285 (delete-file error-file))
1286 ;; This is like exchange-point-and-mark, but doesn't
1287 ;; activate the mark. It is cleaner to avoid activation,
1288 ;; even though the command loop would deactivate the mark
1289 ;; because we inserted text.
1290 (goto-char (prog1 (mark t)
1291 (set-marker (mark-marker) (point)
1292 (current-buffer)))))
1293 ;; Output goes in a separate buffer.
1294 ;; Preserve the match data in case called from a program.
1295 (save-match-data
1296 (if (string-match "[ \t]*&[ \t]*\\'" command)
1297 ;; Command ending with ampersand means asynchronous.
1298 (let ((buffer (get-buffer-create
1299 (or output-buffer "*Async Shell Command*")))
1300 (directory default-directory)
1301 proc)
1302 ;; Remove the ampersand.
1303 (setq command (substring command 0 (match-beginning 0)))
1304 ;; If will kill a process, query first.
1305 (setq proc (get-buffer-process buffer))
1306 (if proc
1307 (if (yes-or-no-p "A command is running. Kill it? ")
1308 (kill-process proc)
1309 (error "Shell command in progress")))
1310 (save-excursion
1311 (set-buffer buffer)
1312 (setq buffer-read-only nil)
1313 (erase-buffer)
1314 (display-buffer buffer)
1315 (setq default-directory directory)
1316 (setq proc (start-process "Shell" buffer shell-file-name
1317 shell-command-switch command))
1318 (setq mode-line-process '(":%s"))
1319 (require 'shell) (shell-mode)
1320 (set-process-sentinel proc 'shell-command-sentinel)
1322 (shell-command-on-region (point) (point) command
1323 output-buffer nil error-buffer)))))))
1325 (defun display-message-or-buffer (message
1326 &optional buffer-name not-this-window frame)
1327 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1328 MESSAGE may be either a string or a buffer.
1330 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1331 the maximum height of the echo area, as defined by `max-mini-window-height'
1332 if `resize-mini-windows' is non-nil.
1334 Returns either the string shown in the echo area, or when a pop-up
1335 buffer is used, the window used to display it.
1337 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1338 name of the buffer used to display it in the case where a pop-up buffer
1339 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1340 string and it is displayed in the echo area, it is not specified whether
1341 the contents are inserted into the buffer anyway.
1343 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1344 and only used if a buffer is displayed."
1345 (cond ((and (stringp message) (not (string-match "\n" message)))
1346 ;; Trivial case where we can use the echo area
1347 (message "%s" message))
1348 ((and (stringp message)
1349 (= (string-match "\n" message) (1- (length message))))
1350 ;; Trivial case where we can just remove single trailing newline
1351 (message "%s" (substring message 0 (1- (length message)))))
1353 ;; General case
1354 (with-current-buffer
1355 (if (bufferp message)
1356 message
1357 (get-buffer-create (or buffer-name "*Message*")))
1359 (unless (bufferp message)
1360 (erase-buffer)
1361 (insert message))
1363 (let ((lines
1364 (if (= (buffer-size) 0)
1366 (count-lines (point-min) (point-max)))))
1367 (cond ((= lines 0))
1368 ((and (or (<= lines 1)
1369 (<= lines
1370 (if resize-mini-windows
1371 (cond ((floatp max-mini-window-height)
1372 (* (frame-height)
1373 max-mini-window-height))
1374 ((integerp max-mini-window-height)
1375 max-mini-window-height)
1378 1)))
1379 ;; Don't use the echo area if the output buffer is
1380 ;; already dispayed in the selected frame.
1381 (not (get-buffer-window (current-buffer))))
1382 ;; Echo area
1383 (goto-char (point-max))
1384 (when (bolp)
1385 (backward-char 1))
1386 (message "%s" (buffer-substring (point-min) (point))))
1388 ;; Buffer
1389 (goto-char (point-min))
1390 (display-buffer (current-buffer)
1391 not-this-window frame))))))))
1394 ;; We have a sentinel to prevent insertion of a termination message
1395 ;; in the buffer itself.
1396 (defun shell-command-sentinel (process signal)
1397 (if (memq (process-status process) '(exit signal))
1398 (message "%s: %s."
1399 (car (cdr (cdr (process-command process))))
1400 (substring signal 0 -1))))
1402 (defun shell-command-on-region (start end command
1403 &optional output-buffer replace
1404 error-buffer)
1405 "Execute string COMMAND in inferior shell with region as input.
1406 Normally display output (if any) in temp buffer `*Shell Command Output*';
1407 Prefix arg means replace the region with it. Return the exit code of
1408 COMMAND.
1410 To specify a coding system for converting non-ASCII characters
1411 in the input and output to the shell command, use \\[universal-coding-system-argument]
1412 before this command. By default, the input (from the current buffer)
1413 is encoded in the same coding system that will be used to save the file,
1414 `buffer-file-coding-system'. If the output is going to replace the region,
1415 then it is decoded from that same coding system.
1417 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1418 REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1419 systems by binding `coding-system-for-read' and
1420 `coding-system-for-write'.
1422 If the command generates output, the output may be displayed
1423 in the echo area or in a buffer.
1424 If the output is short enough to display in the echo area
1425 \(determined by the variable `max-mini-window-height' if
1426 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1427 it is displayed in the buffer `*Shell Command Output*'. The output
1428 is available in that buffer in both cases.
1430 If there is output and an error, a message about the error
1431 appears at the end of the output.
1433 If there is no output, or if output is inserted in the current buffer,
1434 then `*Shell Command Output*' is deleted.
1436 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1437 that says to put the output in some other buffer.
1438 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1439 If OUTPUT-BUFFER is not a buffer and not nil,
1440 insert output in the current buffer.
1441 In either case, the output is inserted after point (leaving mark after it).
1443 If REPLACE, the optional fifth argument, is non-nil, that means insert
1444 the output in place of text from START to END, putting point and mark
1445 around it.
1447 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1448 or buffer name to which to direct the command's standard error output.
1449 If it is nil, error output is mingled with regular output.
1450 In an interactive call, the variable `shell-command-default-error-buffer'
1451 specifies the value of ERROR-BUFFER."
1452 (interactive (let (string)
1453 (unless (mark)
1454 (error "The mark is not set now, so there is no region"))
1455 ;; Do this before calling region-beginning
1456 ;; and region-end, in case subprocess output
1457 ;; relocates them while we are in the minibuffer.
1458 (setq string (read-from-minibuffer "Shell command on region: "
1459 nil nil nil
1460 'shell-command-history))
1461 ;; call-interactively recognizes region-beginning and
1462 ;; region-end specially, leaving them in the history.
1463 (list (region-beginning) (region-end)
1464 string
1465 current-prefix-arg
1466 current-prefix-arg
1467 shell-command-default-error-buffer)))
1468 (let ((error-file
1469 (if error-buffer
1470 (make-temp-file
1471 (expand-file-name "scor"
1472 (or small-temporary-file-directory
1473 temporary-file-directory)))
1474 nil))
1475 exit-status)
1476 (if (or replace
1477 (and output-buffer
1478 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1479 ;; Replace specified region with output from command.
1480 (let ((swap (and replace (< start end))))
1481 ;; Don't muck with mark unless REPLACE says we should.
1482 (goto-char start)
1483 (and replace (push-mark (point) 'nomsg))
1484 (setq exit-status
1485 (call-process-region start end shell-file-name t
1486 (if error-file
1487 (list t error-file)
1489 nil shell-command-switch command))
1490 ;; It is rude to delete a buffer which the command is not using.
1491 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1492 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
1493 ;; (kill-buffer shell-buffer)))
1494 ;; Don't muck with mark unless REPLACE says we should.
1495 (and replace swap (exchange-point-and-mark)))
1496 ;; No prefix argument: put the output in a temp buffer,
1497 ;; replacing its entire contents.
1498 (let ((buffer (get-buffer-create
1499 (or output-buffer "*Shell Command Output*"))))
1500 (unwind-protect
1501 (if (eq buffer (current-buffer))
1502 ;; If the input is the same buffer as the output,
1503 ;; delete everything but the specified region,
1504 ;; then replace that region with the output.
1505 (progn (setq buffer-read-only nil)
1506 (delete-region (max start end) (point-max))
1507 (delete-region (point-min) (min start end))
1508 (setq exit-status
1509 (call-process-region (point-min) (point-max)
1510 shell-file-name t
1511 (if error-file
1512 (list t error-file)
1514 nil shell-command-switch
1515 command)))
1516 ;; Clear the output buffer, then run the command with
1517 ;; output there.
1518 (let ((directory default-directory))
1519 (save-excursion
1520 (set-buffer buffer)
1521 (setq buffer-read-only nil)
1522 (if (not output-buffer)
1523 (setq default-directory directory))
1524 (erase-buffer)))
1525 (setq exit-status
1526 (call-process-region start end shell-file-name nil
1527 (if error-file
1528 (list buffer error-file)
1529 buffer)
1530 nil shell-command-switch command)))
1531 ;; Report the output.
1532 (with-current-buffer buffer
1533 (setq mode-line-process
1534 (cond ((null exit-status)
1535 " - Error")
1536 ((stringp exit-status)
1537 (format " - Signal [%s]" exit-status))
1538 ((not (equal 0 exit-status))
1539 (format " - Exit [%d]" exit-status)))))
1540 (if (with-current-buffer buffer (> (point-max) (point-min)))
1541 ;; There's some output, display it
1542 (display-message-or-buffer buffer)
1543 ;; No output; error?
1544 (let ((output
1545 (if (and error-file
1546 (< 0 (nth 7 (file-attributes error-file))))
1547 "some error output"
1548 "no output")))
1549 (cond ((null exit-status)
1550 (message "(Shell command failed with error)"))
1551 ((equal 0 exit-status)
1552 (message "(Shell command succeeded with %s)"
1553 output))
1554 ((stringp exit-status)
1555 (message "(Shell command killed by signal %s)"
1556 exit-status))
1558 (message "(Shell command failed with code %d and %s)"
1559 exit-status output))))
1560 ;; Don't kill: there might be useful info in the undo-log.
1561 ;; (kill-buffer buffer)
1562 ))))
1564 (when (and error-file (file-exists-p error-file))
1565 (if (< 0 (nth 7 (file-attributes error-file)))
1566 (with-current-buffer (get-buffer-create error-buffer)
1567 (let ((pos-from-end (- (point-max) (point))))
1568 (or (bobp)
1569 (insert "\f\n"))
1570 ;; Do no formatting while reading error file,
1571 ;; because that can run a shell command, and we
1572 ;; don't want that to cause an infinite recursion.
1573 (format-insert-file error-file nil)
1574 ;; Put point after the inserted errors.
1575 (goto-char (- (point-max) pos-from-end)))
1576 (display-buffer (current-buffer))))
1577 (delete-file error-file))
1578 exit-status))
1580 (defun shell-command-to-string (command)
1581 "Execute shell command COMMAND and return its output as a string."
1582 (with-output-to-string
1583 (with-current-buffer
1584 standard-output
1585 (call-process shell-file-name nil t nil shell-command-switch command))))
1587 (defvar universal-argument-map
1588 (let ((map (make-sparse-keymap)))
1589 (define-key map [t] 'universal-argument-other-key)
1590 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1591 (define-key map [switch-frame] nil)
1592 (define-key map [?\C-u] 'universal-argument-more)
1593 (define-key map [?-] 'universal-argument-minus)
1594 (define-key map [?0] 'digit-argument)
1595 (define-key map [?1] 'digit-argument)
1596 (define-key map [?2] 'digit-argument)
1597 (define-key map [?3] 'digit-argument)
1598 (define-key map [?4] 'digit-argument)
1599 (define-key map [?5] 'digit-argument)
1600 (define-key map [?6] 'digit-argument)
1601 (define-key map [?7] 'digit-argument)
1602 (define-key map [?8] 'digit-argument)
1603 (define-key map [?9] 'digit-argument)
1604 (define-key map [kp-0] 'digit-argument)
1605 (define-key map [kp-1] 'digit-argument)
1606 (define-key map [kp-2] 'digit-argument)
1607 (define-key map [kp-3] 'digit-argument)
1608 (define-key map [kp-4] 'digit-argument)
1609 (define-key map [kp-5] 'digit-argument)
1610 (define-key map [kp-6] 'digit-argument)
1611 (define-key map [kp-7] 'digit-argument)
1612 (define-key map [kp-8] 'digit-argument)
1613 (define-key map [kp-9] 'digit-argument)
1614 (define-key map [kp-subtract] 'universal-argument-minus)
1615 map)
1616 "Keymap used while processing \\[universal-argument].")
1618 (defvar universal-argument-num-events nil
1619 "Number of argument-specifying events read by `universal-argument'.
1620 `universal-argument-other-key' uses this to discard those events
1621 from (this-command-keys), and reread only the final command.")
1623 (defun universal-argument ()
1624 "Begin a numeric argument for the following command.
1625 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1626 \\[universal-argument] following the digits or minus sign ends the argument.
1627 \\[universal-argument] without digits or minus sign provides 4 as argument.
1628 Repeating \\[universal-argument] without digits or minus sign
1629 multiplies the argument by 4 each time.
1630 For some commands, just \\[universal-argument] by itself serves as a flag
1631 which is different in effect from any particular numeric argument.
1632 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1633 (interactive)
1634 (setq prefix-arg (list 4))
1635 (setq universal-argument-num-events (length (this-command-keys)))
1636 (setq overriding-terminal-local-map universal-argument-map))
1638 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1639 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1640 (defun universal-argument-more (arg)
1641 (interactive "P")
1642 (if (consp arg)
1643 (setq prefix-arg (list (* 4 (car arg))))
1644 (if (eq arg '-)
1645 (setq prefix-arg (list -4))
1646 (setq prefix-arg arg)
1647 (setq overriding-terminal-local-map nil)))
1648 (setq universal-argument-num-events (length (this-command-keys))))
1650 (defun negative-argument (arg)
1651 "Begin a negative numeric argument for the next command.
1652 \\[universal-argument] following digits or minus sign ends the argument."
1653 (interactive "P")
1654 (cond ((integerp arg)
1655 (setq prefix-arg (- arg)))
1656 ((eq arg '-)
1657 (setq prefix-arg nil))
1659 (setq prefix-arg '-)))
1660 (setq universal-argument-num-events (length (this-command-keys)))
1661 (setq overriding-terminal-local-map universal-argument-map))
1663 (defun digit-argument (arg)
1664 "Part of the numeric argument for the next command.
1665 \\[universal-argument] following digits or minus sign ends the argument."
1666 (interactive "P")
1667 (let* ((char (if (integerp last-command-char)
1668 last-command-char
1669 (get last-command-char 'ascii-character)))
1670 (digit (- (logand char ?\177) ?0)))
1671 (cond ((integerp arg)
1672 (setq prefix-arg (+ (* arg 10)
1673 (if (< arg 0) (- digit) digit))))
1674 ((eq arg '-)
1675 ;; Treat -0 as just -, so that -01 will work.
1676 (setq prefix-arg (if (zerop digit) '- (- digit))))
1678 (setq prefix-arg digit))))
1679 (setq universal-argument-num-events (length (this-command-keys)))
1680 (setq overriding-terminal-local-map universal-argument-map))
1682 ;; For backward compatibility, minus with no modifiers is an ordinary
1683 ;; command if digits have already been entered.
1684 (defun universal-argument-minus (arg)
1685 (interactive "P")
1686 (if (integerp arg)
1687 (universal-argument-other-key arg)
1688 (negative-argument arg)))
1690 ;; Anything else terminates the argument and is left in the queue to be
1691 ;; executed as a command.
1692 (defun universal-argument-other-key (arg)
1693 (interactive "P")
1694 (setq prefix-arg arg)
1695 (let* ((key (this-command-keys))
1696 (keylist (listify-key-sequence key)))
1697 (setq unread-command-events
1698 (append (nthcdr universal-argument-num-events keylist)
1699 unread-command-events)))
1700 (reset-this-command-lengths)
1701 (setq overriding-terminal-local-map nil))
1703 ;;;; Window system cut and paste hooks.
1705 (defvar interprogram-cut-function nil
1706 "Function to call to make a killed region available to other programs.
1708 Most window systems provide some sort of facility for cutting and
1709 pasting text between the windows of different programs.
1710 This variable holds a function that Emacs calls whenever text
1711 is put in the kill ring, to make the new kill available to other
1712 programs.
1714 The function takes one or two arguments.
1715 The first argument, TEXT, is a string containing
1716 the text which should be made available.
1717 The second, PUSH, if non-nil means this is a \"new\" kill;
1718 nil means appending to an \"old\" kill.")
1720 (defvar interprogram-paste-function nil
1721 "Function to call to get text cut from other programs.
1723 Most window systems provide some sort of facility for cutting and
1724 pasting text between the windows of different programs.
1725 This variable holds a function that Emacs calls to obtain
1726 text that other programs have provided for pasting.
1728 The function should be called with no arguments. If the function
1729 returns nil, then no other program has provided such text, and the top
1730 of the Emacs kill ring should be used. If the function returns a
1731 string, that string should be put in the kill ring as the latest kill.
1733 Note that the function should return a string only if a program other
1734 than Emacs has provided a string for pasting; if Emacs provided the
1735 most recent string, the function should return nil. If it is
1736 difficult to tell whether Emacs or some other program provided the
1737 current string, it is probably good enough to return nil if the string
1738 is equal (according to `string=') to the last text Emacs provided.")
1742 ;;;; The kill ring data structure.
1744 (defvar kill-ring nil
1745 "List of killed text sequences.
1746 Since the kill ring is supposed to interact nicely with cut-and-paste
1747 facilities offered by window systems, use of this variable should
1748 interact nicely with `interprogram-cut-function' and
1749 `interprogram-paste-function'. The functions `kill-new',
1750 `kill-append', and `current-kill' are supposed to implement this
1751 interaction; you may want to use them instead of manipulating the kill
1752 ring directly.")
1754 (defcustom kill-ring-max 60
1755 "*Maximum length of kill ring before oldest elements are thrown away."
1756 :type 'integer
1757 :group 'killing)
1759 (defvar kill-ring-yank-pointer nil
1760 "The tail of the kill ring whose car is the last thing yanked.")
1762 (defun kill-new (string &optional replace yank-handler)
1763 "Make STRING the latest kill in the kill ring.
1764 Set `kill-ring-yank-pointer' to point to it.
1765 If `interprogram-cut-function' is non-nil, apply it to STRING.
1766 Optional second argument REPLACE non-nil means that STRING will replace
1767 the front of the kill ring, rather than being added to the list.
1769 Optional third arguments YANK-HANDLER controls how the STRING is later
1770 inserted into a buffer; see `insert-for-yank' for details.
1771 When a yank handler is specified, STRING must be non-empty (the yank
1772 handler is stored as a `yank-handler'text property on STRING).
1774 When the yank handler has a non-nil PARAM element, the original STRING
1775 argument is not used by `insert-for-yank'. However, since Lisp code
1776 may access and use elements from the kill-ring directly, the STRING
1777 argument should still be a \"useful\" string for such uses."
1778 (if (> (length string) 0)
1779 (if yank-handler
1780 (put-text-property 0 1 'yank-handler yank-handler string)
1781 (remove-list-of-text-properties 0 1 '(yank-handler) string))
1782 (if yank-handler
1783 (signal 'args-out-of-range
1784 (list string "yank-handler specified for empty string"))))
1785 (if (fboundp 'menu-bar-update-yank-menu)
1786 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1787 (if (and replace kill-ring)
1788 (setcar kill-ring string)
1789 (setq kill-ring (cons string kill-ring))
1790 (if (> (length kill-ring) kill-ring-max)
1791 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1792 (setq kill-ring-yank-pointer kill-ring)
1793 (if interprogram-cut-function
1794 (funcall interprogram-cut-function string (not replace))))
1796 (defun kill-append (string before-p &optional yank-handler)
1797 "Append STRING to the end of the latest kill in the kill ring.
1798 If BEFORE-P is non-nil, prepend STRING to the kill.
1799 Optional third argument YANK-HANDLER specifies the yank-handler text
1800 property to be set on the combined kill ring string. If the specified
1801 yank-handler arg differs from the yank-handler property of the latest
1802 kill string, STRING is added as a new kill ring element instead of
1803 being appending to the last kill.
1804 If `interprogram-cut-function' is set, pass the resulting kill to it."
1805 (let* ((cur (car kill-ring)))
1806 (kill-new (if before-p (concat string cur) (concat cur string))
1807 (or (= (length cur) 0)
1808 (equal yank-handler (get-text-property 0 'yank-handler cur)))
1809 yank-handler)))
1811 (defun current-kill (n &optional do-not-move)
1812 "Rotate the yanking point by N places, and then return that kill.
1813 If N is zero, `interprogram-paste-function' is set, and calling it
1814 returns a string, then that string is added to the front of the
1815 kill ring and returned as the latest kill.
1816 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1817 yanking point; just return the Nth kill forward."
1818 (let ((interprogram-paste (and (= n 0)
1819 interprogram-paste-function
1820 (funcall interprogram-paste-function))))
1821 (if interprogram-paste
1822 (progn
1823 ;; Disable the interprogram cut function when we add the new
1824 ;; text to the kill ring, so Emacs doesn't try to own the
1825 ;; selection, with identical text.
1826 (let ((interprogram-cut-function nil))
1827 (kill-new interprogram-paste))
1828 interprogram-paste)
1829 (or kill-ring (error "Kill ring is empty"))
1830 (let ((ARGth-kill-element
1831 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1832 (length kill-ring))
1833 kill-ring)))
1834 (or do-not-move
1835 (setq kill-ring-yank-pointer ARGth-kill-element))
1836 (car ARGth-kill-element)))))
1840 ;;;; Commands for manipulating the kill ring.
1842 (defcustom kill-read-only-ok nil
1843 "*Non-nil means don't signal an error for killing read-only text."
1844 :type 'boolean
1845 :group 'killing)
1847 (put 'text-read-only 'error-conditions
1848 '(text-read-only buffer-read-only error))
1849 (put 'text-read-only 'error-message "Text is read-only")
1851 (defun kill-region (beg end &optional yank-handler)
1852 "Kill between point and mark.
1853 The text is deleted but saved in the kill ring.
1854 The command \\[yank] can retrieve it from there.
1855 \(If you want to kill and then yank immediately, use \\[kill-ring-save].)
1857 If you want to append the killed region to the last killed text,
1858 use \\[append-next-kill] before \\[kill-region].
1860 If the buffer is read-only, Emacs will beep and refrain from deleting
1861 the text, but put the text in the kill ring anyway. This means that
1862 you can use the killing commands to copy text from a read-only buffer.
1864 This is the primitive for programs to kill text (as opposed to deleting it).
1865 Supply two arguments, character numbers indicating the stretch of text
1866 to be killed.
1867 Any command that calls this function is a \"kill command\".
1868 If the previous command was also a kill command,
1869 the text killed this time appends to the text killed last time
1870 to make one entry in the kill ring.
1872 In Lisp code, optional third arg YANK-HANDLER specifies the yank-handler
1873 text property to be set on the killed text. See `insert-for-yank'."
1874 (interactive "r")
1875 (condition-case nil
1876 (let ((string (delete-and-extract-region beg end)))
1877 (when string ;STRING is nil if BEG = END
1878 ;; Add that string to the kill ring, one way or another.
1879 (if (eq last-command 'kill-region)
1880 (kill-append string (< end beg) yank-handler)
1881 (kill-new string nil yank-handler)))
1882 (setq this-command 'kill-region))
1883 ((buffer-read-only text-read-only)
1884 ;; The code above failed because the buffer, or some of the characters
1885 ;; in the region, are read-only.
1886 ;; We should beep, in case the user just isn't aware of this.
1887 ;; However, there's no harm in putting
1888 ;; the region's text in the kill ring, anyway.
1889 (copy-region-as-kill beg end)
1890 ;; Set this-command now, so it will be set even if we get an error.
1891 (setq this-command 'kill-region)
1892 ;; This should barf, if appropriate, and give us the correct error.
1893 (if kill-read-only-ok
1894 (message "Read only text copied to kill ring")
1895 ;; Signal an error if the buffer is read-only.
1896 (barf-if-buffer-read-only)
1897 ;; If the buffer isn't read-only, the text is.
1898 (signal 'text-read-only (list (current-buffer)))))))
1900 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1901 ;; to get two copies of the text when the user accidentally types M-w and
1902 ;; then corrects it with the intended C-w.
1903 (defun copy-region-as-kill (beg end)
1904 "Save the region as if killed, but don't kill it.
1905 In Transient Mark mode, deactivate the mark.
1906 If `interprogram-cut-function' is non-nil, also save the text for a window
1907 system cut and paste."
1908 (interactive "r")
1909 (if (eq last-command 'kill-region)
1910 (kill-append (buffer-substring beg end) (< end beg))
1911 (kill-new (buffer-substring beg end)))
1912 (if transient-mark-mode
1913 (setq deactivate-mark t))
1914 nil)
1916 (defun kill-ring-save (beg end)
1917 "Save the region as if killed, but don't kill it.
1918 In Transient Mark mode, deactivate the mark.
1919 If `interprogram-cut-function' is non-nil, also save the text for a window
1920 system cut and paste.
1922 If you want to append the killed line to the last killed text,
1923 use \\[append-next-kill] before \\[kill-ring-save].
1925 This command is similar to `copy-region-as-kill', except that it gives
1926 visual feedback indicating the extent of the region being copied."
1927 (interactive "r")
1928 (copy-region-as-kill beg end)
1929 (if (interactive-p)
1930 (let ((other-end (if (= (point) beg) end beg))
1931 (opoint (point))
1932 ;; Inhibit quitting so we can make a quit here
1933 ;; look like a C-g typed as a command.
1934 (inhibit-quit t))
1935 (if (pos-visible-in-window-p other-end (selected-window))
1936 (unless transient-mark-mode
1937 ;; Swap point and mark.
1938 (set-marker (mark-marker) (point) (current-buffer))
1939 (goto-char other-end)
1940 (sit-for 1)
1941 ;; Swap back.
1942 (set-marker (mark-marker) other-end (current-buffer))
1943 (goto-char opoint)
1944 ;; If user quit, deactivate the mark
1945 ;; as C-g would as a command.
1946 (and quit-flag mark-active
1947 (deactivate-mark)))
1948 (let* ((killed-text (current-kill 0))
1949 (message-len (min (length killed-text) 40)))
1950 (if (= (point) beg)
1951 ;; Don't say "killed"; that is misleading.
1952 (message "Saved text until \"%s\""
1953 (substring killed-text (- message-len)))
1954 (message "Saved text from \"%s\""
1955 (substring killed-text 0 message-len))))))))
1957 (defun append-next-kill (&optional interactive)
1958 "Cause following command, if it kills, to append to previous kill.
1959 The argument is used for internal purposes; do not supply one."
1960 (interactive "p")
1961 ;; We don't use (interactive-p), since that breaks kbd macros.
1962 (if interactive
1963 (progn
1964 (setq this-command 'kill-region)
1965 (message "If the next command is a kill, it will append"))
1966 (setq last-command 'kill-region)))
1968 ;; Yanking.
1970 ;; This is actually used in subr.el but defcustom does not work there.
1971 (defcustom yank-excluded-properties
1972 '(read-only invisible intangible field mouse-face help-echo local-map keymap
1973 yank-handler)
1974 "*Text properties to discard when yanking."
1975 :type '(choice (const :tag "All" t) (repeat symbol))
1976 :group 'editing
1977 :version "21.4")
1979 (defvar yank-window-start nil)
1980 (defvar yank-undo-function nil
1981 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
1982 Function is called with two parameters, START and END corresponding to
1983 the value of the mark and point; it is guaranteed that START <= END.
1984 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
1986 (defun yank-pop (arg)
1987 "Replace just-yanked stretch of killed text with a different stretch.
1988 This command is allowed only immediately after a `yank' or a `yank-pop'.
1989 At such a time, the region contains a stretch of reinserted
1990 previously-killed text. `yank-pop' deletes that text and inserts in its
1991 place a different stretch of killed text.
1993 With no argument, the previous kill is inserted.
1994 With argument N, insert the Nth previous kill.
1995 If N is negative, this is a more recent kill.
1997 The sequence of kills wraps around, so that after the oldest one
1998 comes the newest one."
1999 (interactive "*p")
2000 (if (not (eq last-command 'yank))
2001 (error "Previous command was not a yank"))
2002 (setq this-command 'yank)
2003 (let ((inhibit-read-only t)
2004 (before (< (point) (mark t))))
2005 (if before
2006 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2007 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2008 (setq yank-undo-function nil)
2009 (set-marker (mark-marker) (point) (current-buffer))
2010 (insert-for-yank (current-kill arg))
2011 ;; Set the window start back where it was in the yank command,
2012 ;; if possible.
2013 (set-window-start (selected-window) yank-window-start t)
2014 (if before
2015 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2016 ;; It is cleaner to avoid activation, even though the command
2017 ;; loop would deactivate the mark because we inserted text.
2018 (goto-char (prog1 (mark t)
2019 (set-marker (mark-marker) (point) (current-buffer))))))
2020 nil)
2022 (defun yank (&optional arg)
2023 "Reinsert the last stretch of killed text.
2024 More precisely, reinsert the stretch of killed text most recently
2025 killed OR yanked. Put point at end, and set mark at beginning.
2026 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2027 With argument N, reinsert the Nth most recently killed stretch of killed
2028 text.
2029 See also the command \\[yank-pop]."
2030 (interactive "*P")
2031 (setq yank-window-start (window-start))
2032 ;; If we don't get all the way thru, make last-command indicate that
2033 ;; for the following command.
2034 (setq this-command t)
2035 (push-mark (point))
2036 (insert-for-yank (current-kill (cond
2037 ((listp arg) 0)
2038 ((eq arg '-) -1)
2039 (t (1- arg)))))
2040 (if (consp arg)
2041 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2042 ;; It is cleaner to avoid activation, even though the command
2043 ;; loop would deactivate the mark because we inserted text.
2044 (goto-char (prog1 (mark t)
2045 (set-marker (mark-marker) (point) (current-buffer)))))
2046 ;; If we do get all the way thru, make this-command indicate that.
2047 (if (eq this-command t)
2048 (setq this-command 'yank))
2049 nil)
2051 (defun rotate-yank-pointer (arg)
2052 "Rotate the yanking point in the kill ring.
2053 With argument, rotate that many kills forward (or backward, if negative)."
2054 (interactive "p")
2055 (current-kill arg))
2057 ;; Some kill commands.
2059 ;; Internal subroutine of delete-char
2060 (defun kill-forward-chars (arg)
2061 (if (listp arg) (setq arg (car arg)))
2062 (if (eq arg '-) (setq arg -1))
2063 (kill-region (point) (forward-point arg)))
2065 ;; Internal subroutine of backward-delete-char
2066 (defun kill-backward-chars (arg)
2067 (if (listp arg) (setq arg (car arg)))
2068 (if (eq arg '-) (setq arg -1))
2069 (kill-region (point) (forward-point (- arg))))
2071 (defcustom backward-delete-char-untabify-method 'untabify
2072 "*The method for untabifying when deleting backward.
2073 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2074 `hungry' -- delete all whitespace, both tabs and spaces;
2075 `all' -- delete all whitespace, including tabs, spaces and newlines;
2076 nil -- just delete one character."
2077 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2078 :version "20.3"
2079 :group 'killing)
2081 (defun backward-delete-char-untabify (arg &optional killp)
2082 "Delete characters backward, changing tabs into spaces.
2083 The exact behavior depends on `backward-delete-char-untabify-method'.
2084 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2085 Interactively, ARG is the prefix arg (default 1)
2086 and KILLP is t if a prefix arg was specified."
2087 (interactive "*p\nP")
2088 (when (eq backward-delete-char-untabify-method 'untabify)
2089 (let ((count arg))
2090 (save-excursion
2091 (while (and (> count 0) (not (bobp)))
2092 (if (= (preceding-char) ?\t)
2093 (let ((col (current-column)))
2094 (forward-char -1)
2095 (setq col (- col (current-column)))
2096 (insert-char ?\ col)
2097 (delete-char 1)))
2098 (forward-char -1)
2099 (setq count (1- count))))))
2100 (delete-backward-char
2101 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
2102 ((eq backward-delete-char-untabify-method 'all)
2103 " \t\n\r"))))
2104 (if skip
2105 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2106 (point)))))
2107 (+ arg (if (zerop wh) 0 (1- wh))))
2108 arg))
2109 killp))
2111 (defun zap-to-char (arg char)
2112 "Kill up to and including ARG'th occurrence of CHAR.
2113 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2114 Goes backward if ARG is negative; error if CHAR not found."
2115 (interactive "p\ncZap to char: ")
2116 (kill-region (point) (progn
2117 (search-forward (char-to-string char) nil nil arg)
2118 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2119 (point))))
2121 ;; kill-line and its subroutines.
2123 (defcustom kill-whole-line nil
2124 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2125 :type 'boolean
2126 :group 'killing)
2128 (defun kill-line (&optional arg)
2129 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2130 With prefix argument, kill that many lines from point.
2131 Negative arguments kill lines backward.
2132 With zero argument, kills the text before point on the current line.
2134 When calling from a program, nil means \"no arg\",
2135 a number counts as a prefix arg.
2137 To kill a whole line, when point is not at the beginning, type \
2138 \\[beginning-of-line] \\[kill-line] \\[kill-line].
2140 If `kill-whole-line' is non-nil, then this command kills the whole line
2141 including its terminating newline, when used at the beginning of a line
2142 with no argument. As a consequence, you can always kill a whole line
2143 by typing \\[beginning-of-line] \\[kill-line].
2145 If you want to append the killed line to the last killed text,
2146 use \\[append-next-kill] before \\[kill-line].
2148 If the buffer is read-only, Emacs will beep and refrain from deleting
2149 the line, but put the line in the kill ring anyway. This means that
2150 you can use this command to copy text from a read-only buffer.
2151 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2152 even beep.)"
2153 (interactive "P")
2154 (kill-region (point)
2155 ;; It is better to move point to the other end of the kill
2156 ;; before killing. That way, in a read-only buffer, point
2157 ;; moves across the text that is copied to the kill ring.
2158 ;; The choice has no effect on undo now that undo records
2159 ;; the value of point from before the command was run.
2160 (progn
2161 (if arg
2162 (forward-visible-line (prefix-numeric-value arg))
2163 (if (eobp)
2164 (signal 'end-of-buffer nil))
2165 (let ((end
2166 (save-excursion
2167 (end-of-visible-line) (point))))
2168 (if (or (save-excursion
2169 (skip-chars-forward " \t" end)
2170 (= (point) end))
2171 (and kill-whole-line (bolp)))
2172 (forward-visible-line 1)
2173 (goto-char end))))
2174 (point))))
2177 (defun forward-visible-line (arg)
2178 "Move forward by ARG lines, ignoring currently invisible newlines only.
2179 If ARG is negative, move backward -ARG lines.
2180 If ARG is zero, move to the beginning of the current line."
2181 (condition-case nil
2182 (if (> arg 0)
2183 (progn
2184 (while (> arg 0)
2185 (or (zerop (forward-line 1))
2186 (signal 'end-of-buffer nil))
2187 ;; If the newline we just skipped is invisible,
2188 ;; don't count it.
2189 (let ((prop
2190 (get-char-property (1- (point)) 'invisible)))
2191 (if (if (eq buffer-invisibility-spec t)
2192 prop
2193 (or (memq prop buffer-invisibility-spec)
2194 (assq prop buffer-invisibility-spec)))
2195 (setq arg (1+ arg))))
2196 (setq arg (1- arg)))
2197 ;; If invisible text follows, and it is a number of complete lines,
2198 ;; skip it.
2199 (let ((opoint (point)))
2200 (while (and (not (eobp))
2201 (let ((prop
2202 (get-char-property (point) 'invisible)))
2203 (if (eq buffer-invisibility-spec t)
2204 prop
2205 (or (memq prop buffer-invisibility-spec)
2206 (assq prop buffer-invisibility-spec)))))
2207 (goto-char
2208 (if (get-text-property (point) 'invisible)
2209 (or (next-single-property-change (point) 'invisible)
2210 (point-max))
2211 (next-overlay-change (point)))))
2212 (unless (bolp)
2213 (goto-char opoint))))
2214 (let ((first t))
2215 (while (or first (< arg 0))
2216 (if (zerop arg)
2217 (beginning-of-line)
2218 (or (zerop (forward-line -1))
2219 (signal 'beginning-of-buffer nil)))
2220 ;; If the newline we just moved to is invisible,
2221 ;; don't count it.
2222 (unless (bobp)
2223 (let ((prop
2224 (get-char-property (1- (point)) 'invisible)))
2225 (if (if (eq buffer-invisibility-spec t)
2226 prop
2227 (or (memq prop buffer-invisibility-spec)
2228 (assq prop buffer-invisibility-spec)))
2229 (setq arg (1+ arg)))))
2230 (setq first nil)
2231 (setq arg (1+ arg)))
2232 ;; If invisible text follows, and it is a number of complete lines,
2233 ;; skip it.
2234 (let ((opoint (point)))
2235 (while (and (not (bobp))
2236 (let ((prop
2237 (get-char-property (1- (point)) 'invisible)))
2238 (if (eq buffer-invisibility-spec t)
2239 prop
2240 (or (memq prop buffer-invisibility-spec)
2241 (assq prop buffer-invisibility-spec)))))
2242 (goto-char
2243 (if (get-text-property (1- (point)) 'invisible)
2244 (or (previous-single-property-change (point) 'invisible)
2245 (point-min))
2246 (previous-overlay-change (point)))))
2247 (unless (bolp)
2248 (goto-char opoint)))))
2249 ((beginning-of-buffer end-of-buffer)
2250 nil)))
2252 (defun end-of-visible-line ()
2253 "Move to end of current visible line."
2254 (end-of-line)
2255 ;; If the following character is currently invisible,
2256 ;; skip all characters with that same `invisible' property value,
2257 ;; then find the next newline.
2258 (while (and (not (eobp))
2259 (save-excursion
2260 (skip-chars-forward "^\n")
2261 (let ((prop
2262 (get-char-property (point) 'invisible)))
2263 (if (eq buffer-invisibility-spec t)
2264 prop
2265 (or (memq prop buffer-invisibility-spec)
2266 (assq prop buffer-invisibility-spec))))))
2267 (skip-chars-forward "^\n")
2268 (if (get-text-property (point) 'invisible)
2269 (goto-char (next-single-property-change (point) 'invisible))
2270 (goto-char (next-overlay-change (point))))
2271 (end-of-line)))
2273 (defun insert-buffer (buffer)
2274 "Insert after point the contents of BUFFER.
2275 Puts mark after the inserted text.
2276 BUFFER may be a buffer or a buffer name.
2278 This function is meant for the user to run interactively.
2279 Don't call it from programs!"
2280 (interactive
2281 (list
2282 (progn
2283 (barf-if-buffer-read-only)
2284 (read-buffer "Insert buffer: "
2285 (if (eq (selected-window) (next-window (selected-window)))
2286 (other-buffer (current-buffer))
2287 (window-buffer (next-window (selected-window))))
2288 t))))
2289 (or (bufferp buffer)
2290 (setq buffer (get-buffer buffer)))
2291 (let (start end newmark)
2292 (save-excursion
2293 (save-excursion
2294 (set-buffer buffer)
2295 (setq start (point-min) end (point-max)))
2296 (insert-buffer-substring buffer start end)
2297 (setq newmark (point)))
2298 (push-mark newmark))
2299 nil)
2301 (defun append-to-buffer (buffer start end)
2302 "Append to specified buffer the text of the region.
2303 It is inserted into that buffer before its point.
2305 When calling from a program, give three arguments:
2306 BUFFER (or buffer name), START and END.
2307 START and END specify the portion of the current buffer to be copied."
2308 (interactive
2309 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2310 (region-beginning) (region-end)))
2311 (let ((oldbuf (current-buffer)))
2312 (save-excursion
2313 (let* ((append-to (get-buffer-create buffer))
2314 (windows (get-buffer-window-list append-to t t))
2315 point)
2316 (set-buffer append-to)
2317 (setq point (point))
2318 (barf-if-buffer-read-only)
2319 (insert-buffer-substring oldbuf start end)
2320 (dolist (window windows)
2321 (when (= (window-point window) point)
2322 (set-window-point window (point))))))))
2324 (defun prepend-to-buffer (buffer start end)
2325 "Prepend to specified buffer the text of the region.
2326 It is inserted into that buffer after its point.
2328 When calling from a program, give three arguments:
2329 BUFFER (or buffer name), START and END.
2330 START and END specify the portion of the current buffer to be copied."
2331 (interactive "BPrepend to buffer: \nr")
2332 (let ((oldbuf (current-buffer)))
2333 (save-excursion
2334 (set-buffer (get-buffer-create buffer))
2335 (barf-if-buffer-read-only)
2336 (save-excursion
2337 (insert-buffer-substring oldbuf start end)))))
2339 (defun copy-to-buffer (buffer start end)
2340 "Copy to specified buffer the text of the region.
2341 It is inserted into that buffer, replacing existing text there.
2343 When calling from a program, give three arguments:
2344 BUFFER (or buffer name), START and END.
2345 START and END specify the portion of the current buffer to be copied."
2346 (interactive "BCopy to buffer: \nr")
2347 (let ((oldbuf (current-buffer)))
2348 (save-excursion
2349 (set-buffer (get-buffer-create buffer))
2350 (barf-if-buffer-read-only)
2351 (erase-buffer)
2352 (save-excursion
2353 (insert-buffer-substring oldbuf start end)))))
2355 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2356 (put 'mark-inactive 'error-message "The mark is not active now")
2358 (defun mark (&optional force)
2359 "Return this buffer's mark value as integer; error if mark inactive.
2360 If optional argument FORCE is non-nil, access the mark value
2361 even if the mark is not currently active, and return nil
2362 if there is no mark at all.
2364 If you are using this in an editing command, you are most likely making
2365 a mistake; see the documentation of `set-mark'."
2366 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2367 (marker-position (mark-marker))
2368 (signal 'mark-inactive nil)))
2370 ;; Many places set mark-active directly, and several of them failed to also
2371 ;; run deactivate-mark-hook. This shorthand should simplify.
2372 (defsubst deactivate-mark ()
2373 "Deactivate the mark by setting `mark-active' to nil.
2374 \(That makes a difference only in Transient Mark mode.)
2375 Also runs the hook `deactivate-mark-hook'."
2376 (cond
2377 ((eq transient-mark-mode 'lambda)
2378 (setq transient-mark-mode nil))
2379 (transient-mark-mode
2380 (setq mark-active nil)
2381 (run-hooks 'deactivate-mark-hook))))
2383 (defun set-mark (pos)
2384 "Set this buffer's mark to POS. Don't use this function!
2385 That is to say, don't use this function unless you want
2386 the user to see that the mark has moved, and you want the previous
2387 mark position to be lost.
2389 Normally, when a new mark is set, the old one should go on the stack.
2390 This is why most applications should use push-mark, not set-mark.
2392 Novice Emacs Lisp programmers often try to use the mark for the wrong
2393 purposes. The mark saves a location for the user's convenience.
2394 Most editing commands should not alter the mark.
2395 To remember a location for internal use in the Lisp program,
2396 store it in a Lisp variable. Example:
2398 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2400 (if pos
2401 (progn
2402 (setq mark-active t)
2403 (run-hooks 'activate-mark-hook)
2404 (set-marker (mark-marker) pos (current-buffer)))
2405 ;; Normally we never clear mark-active except in Transient Mark mode.
2406 ;; But when we actually clear out the mark value too,
2407 ;; we must clear mark-active in any mode.
2408 (setq mark-active nil)
2409 (run-hooks 'deactivate-mark-hook)
2410 (set-marker (mark-marker) nil)))
2412 (defvar mark-ring nil
2413 "The list of former marks of the current buffer, most recent first.")
2414 (make-variable-buffer-local 'mark-ring)
2415 (put 'mark-ring 'permanent-local t)
2417 (defcustom mark-ring-max 16
2418 "*Maximum size of mark ring. Start discarding off end if gets this big."
2419 :type 'integer
2420 :group 'editing-basics)
2422 (defvar global-mark-ring nil
2423 "The list of saved global marks, most recent first.")
2425 (defcustom global-mark-ring-max 16
2426 "*Maximum size of global mark ring. \
2427 Start discarding off end if gets this big."
2428 :type 'integer
2429 :group 'editing-basics)
2431 (defun pop-to-mark-command ()
2432 "Jump to mark, and pop a new position for mark off the ring
2433 \(does not affect global mark ring\)."
2434 (interactive)
2435 (if (null (mark t))
2436 (error "No mark set in this buffer")
2437 (goto-char (mark t))
2438 (pop-mark)))
2440 (defun push-mark-command (arg &optional nomsg)
2441 "Set mark at where point is.
2442 If no prefix arg and mark is already set there, just activate it.
2443 Display `Mark set' unless the optional second arg NOMSG is non-nil."
2444 (interactive "P")
2445 (let ((mark (marker-position (mark-marker))))
2446 (if (or arg (null mark) (/= mark (point)))
2447 (push-mark nil nomsg t)
2448 (setq mark-active t)
2449 (unless nomsg
2450 (message "Mark activated")))))
2452 (defun set-mark-command (arg)
2453 "Set mark at where point is, or jump to mark.
2454 With no prefix argument, set mark, and push old mark position on local
2455 mark ring; also push mark on global mark ring if last mark was set in
2456 another buffer. Immediately repeating the command activates
2457 `transient-mark-mode' temporarily.
2459 With argument, e.g. \\[universal-argument] \\[set-mark-command], \
2460 jump to mark, and pop a new position
2461 for mark off the local mark ring \(this does not affect the global
2462 mark ring\). Use \\[pop-global-mark] to jump to a mark off the global
2463 mark ring \(see `pop-global-mark'\).
2465 Repeating the \\[set-mark-command] command without the prefix jumps to
2466 the next position off the local (or global) mark ring.
2468 With a double \\[universal-argument] prefix argument, e.g. \\[universal-argument] \
2469 \\[universal-argument] \\[set-mark-command], unconditionally
2470 set mark where point is.
2472 Novice Emacs Lisp programmers often try to use the mark for the wrong
2473 purposes. See the documentation of `set-mark' for more information."
2474 (interactive "P")
2475 (if (eq transient-mark-mode 'lambda)
2476 (setq transient-mark-mode nil))
2477 (cond
2478 ((and (consp arg) (> (prefix-numeric-value arg) 4))
2479 (push-mark-command nil))
2480 ((not (eq this-command 'set-mark-command))
2481 (if arg
2482 (pop-to-mark-command)
2483 (push-mark-command t)))
2484 ((eq last-command 'pop-to-mark-command)
2485 (setq this-command 'pop-to-mark-command)
2486 (pop-to-mark-command))
2487 ((and (eq last-command 'pop-global-mark) (not arg))
2488 (setq this-command 'pop-global-mark)
2489 (pop-global-mark))
2490 (arg
2491 (setq this-command 'pop-to-mark-command)
2492 (pop-to-mark-command))
2493 ((and (eq last-command 'set-mark-command)
2494 mark-active (null transient-mark-mode))
2495 (setq transient-mark-mode 'lambda)
2496 (message "Transient-mark-mode temporarily enabled"))
2498 (push-mark-command nil))))
2500 (defun push-mark (&optional location nomsg activate)
2501 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
2502 If the last global mark pushed was not in the current buffer,
2503 also push LOCATION on the global mark ring.
2504 Display `Mark set' unless the optional second arg NOMSG is non-nil.
2505 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2507 Novice Emacs Lisp programmers often try to use the mark for the wrong
2508 purposes. See the documentation of `set-mark' for more information.
2510 In Transient Mark mode, this does not activate the mark."
2511 (if (null (mark t))
2513 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2514 (if (> (length mark-ring) mark-ring-max)
2515 (progn
2516 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2517 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
2518 (set-marker (mark-marker) (or location (point)) (current-buffer))
2519 ;; Now push the mark on the global mark ring.
2520 (if (and global-mark-ring
2521 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
2522 ;; The last global mark pushed was in this same buffer.
2523 ;; Don't push another one.
2525 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
2526 (if (> (length global-mark-ring) global-mark-ring-max)
2527 (progn
2528 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2529 nil)
2530 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2531 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2532 (message "Mark set"))
2533 (if (or activate (not transient-mark-mode))
2534 (set-mark (mark t)))
2535 nil)
2537 (defun pop-mark ()
2538 "Pop off mark ring into the buffer's actual mark.
2539 Does not set point. Does nothing if mark ring is empty."
2540 (if mark-ring
2541 (progn
2542 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
2543 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
2544 (deactivate-mark)
2545 (move-marker (car mark-ring) nil)
2546 (if (null (mark t)) (ding))
2547 (setq mark-ring (cdr mark-ring)))))
2549 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2550 (defun exchange-point-and-mark (&optional arg)
2551 "Put the mark where point is now, and point where the mark is now.
2552 This command works even when the mark is not active,
2553 and it reactivates the mark.
2554 With prefix arg, `transient-mark-mode' is enabled temporarily."
2555 (interactive "P")
2556 (if arg
2557 (if mark-active
2558 (if (null transient-mark-mode)
2559 (setq transient-mark-mode 'lambda))
2560 (setq arg nil)))
2561 (unless arg
2562 (let ((omark (mark t)))
2563 (if (null omark)
2564 (error "No mark set in this buffer"))
2565 (set-mark (point))
2566 (goto-char omark)
2567 nil)))
2569 (define-minor-mode transient-mark-mode
2570 "Toggle Transient Mark mode.
2571 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
2573 In Transient Mark mode, when the mark is active, the region is highlighted.
2574 Changing the buffer \"deactivates\" the mark.
2575 So do certain other operations that set the mark
2576 but whose main purpose is something else--for example,
2577 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
2579 You can also deactivate the mark by typing \\[keyboard-quit] or
2580 \\[keyboard-escape-quit].
2582 Many commands change their behavior when Transient Mark mode is in effect
2583 and the mark is active, by acting on the region instead of their usual
2584 default part of the buffer's text. Examples of such commands include
2585 \\[comment-dwim], \\[flush-lines], \\[ispell], \\[keep-lines],
2586 \\[query-replace], \\[query-replace-regexp], and \\[undo]. Invoke
2587 \\[apropos-documentation] and type \"transient\" or \"mark.*active\" at
2588 the prompt, to see the documentation of commands which are sensitive to
2589 the Transient Mark mode."
2590 :global t :group 'editing-basics :require nil)
2592 (defun pop-global-mark ()
2593 "Pop off global mark ring and jump to the top location."
2594 (interactive)
2595 ;; Pop entries which refer to non-existent buffers.
2596 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2597 (setq global-mark-ring (cdr global-mark-ring)))
2598 (or global-mark-ring
2599 (error "No global mark set"))
2600 (let* ((marker (car global-mark-ring))
2601 (buffer (marker-buffer marker))
2602 (position (marker-position marker)))
2603 (setq global-mark-ring (nconc (cdr global-mark-ring)
2604 (list (car global-mark-ring))))
2605 (set-buffer buffer)
2606 (or (and (>= position (point-min))
2607 (<= position (point-max)))
2608 (widen))
2609 (goto-char position)
2610 (switch-to-buffer buffer)))
2612 (defcustom next-line-add-newlines nil
2613 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2614 :type 'boolean
2615 :version "21.1"
2616 :group 'editing-basics)
2618 (defun next-line (&optional arg)
2619 "Move cursor vertically down ARG lines.
2620 If there is no character in the target line exactly under the current column,
2621 the cursor is positioned after the character in that line which spans this
2622 column, or at the end of the line if it is not long enough.
2623 If there is no line in the buffer after this one, behavior depends on the
2624 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2625 to create a line, and moves the cursor to that line. Otherwise it moves the
2626 cursor to the end of the buffer.
2628 The command \\[set-goal-column] can be used to create
2629 a semipermanent goal column for this command.
2630 Then instead of trying to move exactly vertically (or as close as possible),
2631 this command moves to the specified goal column (or as close as possible).
2632 The goal column is stored in the variable `goal-column', which is nil
2633 when there is no goal column.
2635 If you are thinking of using this in a Lisp program, consider
2636 using `forward-line' instead. It is usually easier to use
2637 and more reliable (no dependence on goal column, etc.)."
2638 (interactive "p")
2639 (unless arg (setq arg 1))
2640 (if (and next-line-add-newlines (= arg 1))
2641 (if (save-excursion (end-of-line) (eobp))
2642 ;; When adding a newline, don't expand an abbrev.
2643 (let ((abbrev-mode nil))
2644 (end-of-line)
2645 (insert "\n"))
2646 (line-move arg))
2647 (if (interactive-p)
2648 (condition-case nil
2649 (line-move arg)
2650 ((beginning-of-buffer end-of-buffer) (ding)))
2651 (line-move arg)))
2652 nil)
2654 (defun previous-line (&optional arg)
2655 "Move cursor vertically up ARG lines.
2656 If there is no character in the target line exactly over the current column,
2657 the cursor is positioned after the character in that line which spans this
2658 column, or at the end of the line if it is not long enough.
2660 The command \\[set-goal-column] can be used to create
2661 a semipermanent goal column for this command.
2662 Then instead of trying to move exactly vertically (or as close as possible),
2663 this command moves to the specified goal column (or as close as possible).
2664 The goal column is stored in the variable `goal-column', which is nil
2665 when there is no goal column.
2667 If you are thinking of using this in a Lisp program, consider using
2668 `forward-line' with a negative argument instead. It is usually easier
2669 to use and more reliable (no dependence on goal column, etc.)."
2670 (interactive "p")
2671 (unless arg (setq arg 1))
2672 (if (interactive-p)
2673 (condition-case nil
2674 (line-move (- arg))
2675 ((beginning-of-buffer end-of-buffer) (ding)))
2676 (line-move (- arg)))
2677 nil)
2679 (defcustom track-eol nil
2680 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2681 This means moving to the end of each line moved onto.
2682 The beginning of a blank line does not count as the end of a line."
2683 :type 'boolean
2684 :group 'editing-basics)
2686 (defcustom goal-column nil
2687 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2688 :type '(choice integer
2689 (const :tag "None" nil))
2690 :group 'editing-basics)
2691 (make-variable-buffer-local 'goal-column)
2693 (defvar temporary-goal-column 0
2694 "Current goal column for vertical motion.
2695 It is the column where point was
2696 at the start of current run of vertical motion commands.
2697 When the `track-eol' feature is doing its job, the value is 9999.")
2699 (defcustom line-move-ignore-invisible nil
2700 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2701 Outline mode sets this."
2702 :type 'boolean
2703 :group 'editing-basics)
2705 (defun line-move-invisible (pos)
2706 "Return non-nil if the character after POS is currently invisible."
2707 (let ((prop
2708 (get-char-property pos 'invisible)))
2709 (if (eq buffer-invisibility-spec t)
2710 prop
2711 (or (memq prop buffer-invisibility-spec)
2712 (assq prop buffer-invisibility-spec)))))
2714 ;; This is the guts of next-line and previous-line.
2715 ;; Arg says how many lines to move.
2716 (defun line-move (arg)
2717 ;; Don't run any point-motion hooks, and disregard intangibility,
2718 ;; for intermediate positions.
2719 (let ((inhibit-point-motion-hooks t)
2720 (opoint (point))
2721 new line-end line-beg)
2722 (unwind-protect
2723 (progn
2724 (if (not (memq last-command '(next-line previous-line)))
2725 (setq temporary-goal-column
2726 (if (and track-eol (eolp)
2727 ;; Don't count beg of empty line as end of line
2728 ;; unless we just did explicit end-of-line.
2729 (or (not (bolp)) (eq last-command 'end-of-line)))
2730 9999
2731 (current-column))))
2732 (if (and (not (integerp selective-display))
2733 (not line-move-ignore-invisible))
2734 ;; Use just newline characters.
2735 ;; Set ARG to 0 if we move as many lines as requested.
2736 (or (if (> arg 0)
2737 (progn (if (> arg 1) (forward-line (1- arg)))
2738 ;; This way of moving forward ARG lines
2739 ;; verifies that we have a newline after the last one.
2740 ;; It doesn't get confused by intangible text.
2741 (end-of-line)
2742 (if (zerop (forward-line 1))
2743 (setq arg 0)))
2744 (and (zerop (forward-line arg))
2745 (bolp)
2746 (setq arg 0)))
2747 (signal (if (< arg 0)
2748 'beginning-of-buffer
2749 'end-of-buffer)
2750 nil))
2751 ;; Move by arg lines, but ignore invisible ones.
2752 (while (> arg 0)
2753 ;; If the following character is currently invisible,
2754 ;; skip all characters with that same `invisible' property value.
2755 (while (and (not (eobp)) (line-move-invisible (point)))
2756 (goto-char (next-char-property-change (point))))
2757 ;; Now move a line.
2758 (end-of-line)
2759 (and (zerop (vertical-motion 1))
2760 (signal 'end-of-buffer nil))
2761 (setq arg (1- arg)))
2762 (while (< arg 0)
2763 (beginning-of-line)
2764 (and (zerop (vertical-motion -1))
2765 (signal 'beginning-of-buffer nil))
2766 (setq arg (1+ arg))
2767 (while (and (not (bobp)) (line-move-invisible (1- (point))))
2768 (goto-char (previous-char-property-change (point)))))))
2770 (cond ((> arg 0)
2771 ;; If we did not move down as far as desired,
2772 ;; at least go to end of line.
2773 (end-of-line))
2774 ((< arg 0)
2775 ;; If we did not move down as far as desired,
2776 ;; at least go to end of line.
2777 (beginning-of-line))
2779 (line-move-finish (or goal-column temporary-goal-column) opoint)))))
2780 nil)
2782 (defun line-move-finish (column opoint)
2783 (let ((repeat t))
2784 (while repeat
2785 ;; Set REPEAT to t to repeat the whole thing.
2786 (setq repeat nil)
2788 (let (new
2789 (line-beg (save-excursion (beginning-of-line) (point)))
2790 (line-end
2791 ;; Compute the end of the line
2792 ;; ignoring effectively intangible newlines.
2793 (let ((inhibit-point-motion-hooks nil)
2794 (inhibit-field-text-motion t))
2795 (save-excursion (end-of-line) (point)))))
2797 ;; Move to the desired column.
2798 (line-move-to-column column)
2799 (setq new (point))
2801 ;; Process intangibility within a line.
2802 ;; Move to the chosen destination position from above,
2803 ;; with intangibility processing enabled.
2805 (goto-char (point-min))
2806 (let ((inhibit-point-motion-hooks nil))
2807 (goto-char new)
2809 ;; If intangibility moves us to a different (later) place
2810 ;; in the same line, use that as the destination.
2811 (if (<= (point) line-end)
2812 (setq new (point))
2813 ;; If that position is "too late",
2814 ;; try the previous allowable position.
2815 ;; See if it is ok.
2816 (backward-char)
2817 (if (<= (point) line-end)
2818 (setq new (point))
2819 ;; As a last resort, use the end of the line.
2820 (setq new line-end))))
2822 ;; Now move to the updated destination, processing fields
2823 ;; as well as intangibility.
2824 (goto-char opoint)
2825 (let ((inhibit-point-motion-hooks nil))
2826 (goto-char
2827 (constrain-to-field new opoint nil t
2828 'inhibit-line-move-field-capture)))
2830 ;; If all this moved us to a different line,
2831 ;; retry everything within that new line.
2832 (when (or (< (point) line-beg) (> (point) line-end))
2833 ;; Repeat the intangibility and field processing.
2834 (setq repeat t))))))
2836 (defun line-move-to-column (col)
2837 "Try to find column COL, considering invisibility.
2838 This function works only in certain cases,
2839 because what we really need is for `move-to-column'
2840 and `current-column' to be able to ignore invisible text."
2841 (if (zerop col)
2842 (beginning-of-line)
2843 (move-to-column col))
2845 (when (and line-move-ignore-invisible
2846 (not (bolp)) (line-move-invisible (1- (point))))
2847 (let ((normal-location (point))
2848 (normal-column (current-column)))
2849 ;; If the following character is currently invisible,
2850 ;; skip all characters with that same `invisible' property value.
2851 (while (and (not (eobp))
2852 (line-move-invisible (point)))
2853 (goto-char (next-char-property-change (point))))
2854 ;; Have we advanced to a larger column position?
2855 (if (> (current-column) normal-column)
2856 ;; We have made some progress towards the desired column.
2857 ;; See if we can make any further progress.
2858 (line-move-to-column (+ (current-column) (- col normal-column)))
2859 ;; Otherwise, go to the place we originally found
2860 ;; and move back over invisible text.
2861 ;; that will get us to the same place on the screen
2862 ;; but with a more reasonable buffer position.
2863 (goto-char normal-location)
2864 (let ((line-beg (save-excursion (beginning-of-line) (point))))
2865 (while (and (not (bolp)) (line-move-invisible (1- (point))))
2866 (goto-char (previous-char-property-change (point) line-beg))))))))
2868 ;;; Many people have said they rarely use this feature, and often type
2869 ;;; it by accident. Maybe it shouldn't even be on a key.
2870 (put 'set-goal-column 'disabled t)
2872 (defun set-goal-column (arg)
2873 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2874 Those commands will move to this position in the line moved to
2875 rather than trying to keep the same horizontal position.
2876 With a non-nil argument, clears out the goal column
2877 so that \\[next-line] and \\[previous-line] resume vertical motion.
2878 The goal column is stored in the variable `goal-column'."
2879 (interactive "P")
2880 (if arg
2881 (progn
2882 (setq goal-column nil)
2883 (message "No goal column"))
2884 (setq goal-column (current-column))
2885 (message (substitute-command-keys
2886 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2887 goal-column))
2888 nil)
2891 (defun scroll-other-window-down (lines)
2892 "Scroll the \"other window\" down.
2893 For more details, see the documentation for `scroll-other-window'."
2894 (interactive "P")
2895 (scroll-other-window
2896 ;; Just invert the argument's meaning.
2897 ;; We can do that without knowing which window it will be.
2898 (if (eq lines '-) nil
2899 (if (null lines) '-
2900 (- (prefix-numeric-value lines))))))
2901 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2903 (defun beginning-of-buffer-other-window (arg)
2904 "Move point to the beginning of the buffer in the other window.
2905 Leave mark at previous position.
2906 With arg N, put point N/10 of the way from the true beginning."
2907 (interactive "P")
2908 (let ((orig-window (selected-window))
2909 (window (other-window-for-scrolling)))
2910 ;; We use unwind-protect rather than save-window-excursion
2911 ;; because the latter would preserve the things we want to change.
2912 (unwind-protect
2913 (progn
2914 (select-window window)
2915 ;; Set point and mark in that window's buffer.
2916 (beginning-of-buffer arg)
2917 ;; Set point accordingly.
2918 (recenter '(t)))
2919 (select-window orig-window))))
2921 (defun end-of-buffer-other-window (arg)
2922 "Move point to the end of the buffer in the other window.
2923 Leave mark at previous position.
2924 With arg N, put point N/10 of the way from the true end."
2925 (interactive "P")
2926 ;; See beginning-of-buffer-other-window for comments.
2927 (let ((orig-window (selected-window))
2928 (window (other-window-for-scrolling)))
2929 (unwind-protect
2930 (progn
2931 (select-window window)
2932 (end-of-buffer arg)
2933 (recenter '(t)))
2934 (select-window orig-window))))
2936 (defun transpose-chars (arg)
2937 "Interchange characters around point, moving forward one character.
2938 With prefix arg ARG, effect is to take character before point
2939 and drag it forward past ARG other characters (backward if ARG negative).
2940 If no argument and at end of line, the previous two chars are exchanged."
2941 (interactive "*P")
2942 (and (null arg) (eolp) (forward-char -1))
2943 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2945 (defun transpose-words (arg)
2946 "Interchange words around point, leaving point at end of them.
2947 With prefix arg ARG, effect is to take word before or around point
2948 and drag it forward past ARG other words (backward if ARG negative).
2949 If ARG is zero, the words around or after point and around or after mark
2950 are interchanged."
2951 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
2952 (interactive "*p")
2953 (transpose-subr 'forward-word arg))
2955 (defun transpose-sexps (arg)
2956 "Like \\[transpose-words] but applies to sexps.
2957 Does not work on a sexp that point is in the middle of
2958 if it is a list or string."
2959 (interactive "*p")
2960 (transpose-subr
2961 (lambda (arg)
2962 ;; Here we should try to simulate the behavior of
2963 ;; (cons (progn (forward-sexp x) (point))
2964 ;; (progn (forward-sexp (- x)) (point)))
2965 ;; Except that we don't want to rely on the second forward-sexp
2966 ;; putting us back to where we want to be, since forward-sexp-function
2967 ;; might do funny things like infix-precedence.
2968 (if (if (> arg 0)
2969 (looking-at "\\sw\\|\\s_")
2970 (and (not (bobp))
2971 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
2972 ;; Jumping over a symbol. We might be inside it, mind you.
2973 (progn (funcall (if (> arg 0)
2974 'skip-syntax-backward 'skip-syntax-forward)
2975 "w_")
2976 (cons (save-excursion (forward-sexp arg) (point)) (point)))
2977 ;; Otherwise, we're between sexps. Take a step back before jumping
2978 ;; to make sure we'll obey the same precedence no matter which direction
2979 ;; we're going.
2980 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
2981 (cons (save-excursion (forward-sexp arg) (point))
2982 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
2983 (not (zerop (funcall (if (> arg 0)
2984 'skip-syntax-forward
2985 'skip-syntax-backward)
2986 ".")))))
2987 (point)))))
2988 arg 'special))
2990 (defun transpose-lines (arg)
2991 "Exchange current line and previous line, leaving point after both.
2992 With argument ARG, takes previous line and moves it past ARG lines.
2993 With argument 0, interchanges line point is in with line mark is in."
2994 (interactive "*p")
2995 (transpose-subr (function
2996 (lambda (arg)
2997 (if (> arg 0)
2998 (progn
2999 ;; Move forward over ARG lines,
3000 ;; but create newlines if necessary.
3001 (setq arg (forward-line arg))
3002 (if (/= (preceding-char) ?\n)
3003 (setq arg (1+ arg)))
3004 (if (> arg 0)
3005 (newline arg)))
3006 (forward-line arg))))
3007 arg))
3009 (defun transpose-subr (mover arg &optional special)
3010 (let ((aux (if special mover
3011 (lambda (x)
3012 (cons (progn (funcall mover x) (point))
3013 (progn (funcall mover (- x)) (point))))))
3014 pos1 pos2)
3015 (cond
3016 ((= arg 0)
3017 (save-excursion
3018 (setq pos1 (funcall aux 1))
3019 (goto-char (mark))
3020 (setq pos2 (funcall aux 1))
3021 (transpose-subr-1 pos1 pos2))
3022 (exchange-point-and-mark))
3023 ((> arg 0)
3024 (setq pos1 (funcall aux -1))
3025 (setq pos2 (funcall aux arg))
3026 (transpose-subr-1 pos1 pos2)
3027 (goto-char (car pos2)))
3029 (setq pos1 (funcall aux -1))
3030 (goto-char (car pos1))
3031 (setq pos2 (funcall aux arg))
3032 (transpose-subr-1 pos1 pos2)))))
3034 (defun transpose-subr-1 (pos1 pos2)
3035 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3036 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3037 (when (> (car pos1) (car pos2))
3038 (let ((swap pos1))
3039 (setq pos1 pos2 pos2 swap)))
3040 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3041 (atomic-change-group
3042 (let (word2)
3043 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3044 (goto-char (car pos2))
3045 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3046 (goto-char (car pos1))
3047 (insert word2))))
3049 (defun backward-word (arg)
3050 "Move backward until encountering the beginning of a word.
3051 With argument, do this that many times."
3052 (interactive "p")
3053 (forward-word (- arg)))
3055 (defun mark-word (arg)
3056 "Set mark arg words away from point.
3057 If this command is repeated, it marks the next ARG words after the ones
3058 already marked."
3059 (interactive "p")
3060 (cond ((and (eq last-command this-command) (mark t))
3061 (set-mark
3062 (save-excursion
3063 (goto-char (mark))
3064 (forward-word arg)
3065 (point))))
3067 (push-mark
3068 (save-excursion
3069 (forward-word arg)
3070 (point))
3071 nil t))))
3073 (defun kill-word (arg)
3074 "Kill characters forward until encountering the end of a word.
3075 With argument, do this that many times."
3076 (interactive "p")
3077 (kill-region (point) (progn (forward-word arg) (point))))
3079 (defun backward-kill-word (arg)
3080 "Kill characters backward until encountering the end of a word.
3081 With argument, do this that many times."
3082 (interactive "p")
3083 (kill-word (- arg)))
3085 (defun current-word (&optional strict)
3086 "Return the word point is on (or a nearby word) as a string.
3087 If optional arg STRICT is non-nil, return nil unless point is within
3088 or adjacent to a word."
3089 (save-excursion
3090 (let ((oldpoint (point)) (start (point)) (end (point)))
3091 (skip-syntax-backward "w_") (setq start (point))
3092 (goto-char oldpoint)
3093 (skip-syntax-forward "w_") (setq end (point))
3094 (if (and (eq start oldpoint) (eq end oldpoint))
3095 ;; Point is neither within nor adjacent to a word.
3096 (and (not strict)
3097 (progn
3098 ;; Look for preceding word in same line.
3099 (skip-syntax-backward "^w_"
3100 (save-excursion (beginning-of-line)
3101 (point)))
3102 (if (bolp)
3103 ;; No preceding word in same line.
3104 ;; Look for following word in same line.
3105 (progn
3106 (skip-syntax-forward "^w_"
3107 (save-excursion (end-of-line)
3108 (point)))
3109 (setq start (point))
3110 (skip-syntax-forward "w_")
3111 (setq end (point)))
3112 (setq end (point))
3113 (skip-syntax-backward "w_")
3114 (setq start (point)))
3115 (buffer-substring-no-properties start end)))
3116 (buffer-substring-no-properties start end)))))
3118 (defcustom fill-prefix nil
3119 "*String for filling to insert at front of new line, or nil for none."
3120 :type '(choice (const :tag "None" nil)
3121 string)
3122 :group 'fill)
3123 (make-variable-buffer-local 'fill-prefix)
3125 (defcustom auto-fill-inhibit-regexp nil
3126 "*Regexp to match lines which should not be auto-filled."
3127 :type '(choice (const :tag "None" nil)
3128 regexp)
3129 :group 'fill)
3131 (defvar comment-line-break-function 'comment-indent-new-line
3132 "*Mode-specific function which line breaks and continues a comment.
3134 This function is only called during auto-filling of a comment section.
3135 The function should take a single optional argument, which is a flag
3136 indicating whether it should use soft newlines.
3138 Setting this variable automatically makes it local to the current buffer.")
3140 ;; This function is used as the auto-fill-function of a buffer
3141 ;; when Auto-Fill mode is enabled.
3142 ;; It returns t if it really did any work.
3143 ;; (Actually some major modes use a different auto-fill function,
3144 ;; but this one is the default one.)
3145 (defun do-auto-fill ()
3146 (let (fc justify bol give-up
3147 (fill-prefix fill-prefix))
3148 (if (or (not (setq justify (current-justification)))
3149 (null (setq fc (current-fill-column)))
3150 (and (eq justify 'left)
3151 (<= (current-column) fc))
3152 (save-excursion (beginning-of-line)
3153 (setq bol (point))
3154 (and auto-fill-inhibit-regexp
3155 (looking-at auto-fill-inhibit-regexp))))
3156 nil ;; Auto-filling not required
3157 (if (memq justify '(full center right))
3158 (save-excursion (unjustify-current-line)))
3160 ;; Choose a fill-prefix automatically.
3161 (when (and adaptive-fill-mode
3162 (or (null fill-prefix) (string= fill-prefix "")))
3163 (let ((prefix
3164 (fill-context-prefix
3165 (save-excursion (backward-paragraph 1) (point))
3166 (save-excursion (forward-paragraph 1) (point)))))
3167 (and prefix (not (equal prefix ""))
3168 ;; Use auto-indentation rather than a guessed empty prefix.
3169 (not (and fill-indent-according-to-mode
3170 (string-match "\\`[ \t]*\\'" prefix)))
3171 (setq fill-prefix prefix))))
3173 (while (and (not give-up) (> (current-column) fc))
3174 ;; Determine where to split the line.
3175 (let* (after-prefix
3176 (fill-point
3177 (let ((opoint (point)))
3178 (save-excursion
3179 (beginning-of-line)
3180 (setq after-prefix (point))
3181 (and fill-prefix
3182 (looking-at (regexp-quote fill-prefix))
3183 (setq after-prefix (match-end 0)))
3184 (move-to-column (1+ fc))
3185 (fill-move-to-break-point after-prefix)
3186 (point)))))
3188 ;; See whether the place we found is any good.
3189 (if (save-excursion
3190 (goto-char fill-point)
3191 (or (bolp)
3192 ;; There is no use breaking at end of line.
3193 (save-excursion (skip-chars-forward " ") (eolp))
3194 ;; It is futile to split at the end of the prefix
3195 ;; since we would just insert the prefix again.
3196 (and after-prefix (<= (point) after-prefix))
3197 ;; Don't split right after a comment starter
3198 ;; since we would just make another comment starter.
3199 (and comment-start-skip
3200 (let ((limit (point)))
3201 (beginning-of-line)
3202 (and (re-search-forward comment-start-skip
3203 limit t)
3204 (eq (point) limit))))))
3205 ;; No good place to break => stop trying.
3206 (setq give-up t)
3207 ;; Ok, we have a useful place to break the line. Do it.
3208 (let ((prev-column (current-column)))
3209 ;; If point is at the fill-point, do not `save-excursion'.
3210 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3211 ;; point will end up before it rather than after it.
3212 (if (save-excursion
3213 (skip-chars-backward " \t")
3214 (= (point) fill-point))
3215 (funcall comment-line-break-function t)
3216 (save-excursion
3217 (goto-char fill-point)
3218 (funcall comment-line-break-function t)))
3219 ;; Now do justification, if required
3220 (if (not (eq justify 'left))
3221 (save-excursion
3222 (end-of-line 0)
3223 (justify-current-line justify nil t)))
3224 ;; If making the new line didn't reduce the hpos of
3225 ;; the end of the line, then give up now;
3226 ;; trying again will not help.
3227 (if (>= (current-column) prev-column)
3228 (setq give-up t))))))
3229 ;; Justify last line.
3230 (justify-current-line justify t t)
3231 t)))
3233 (defvar normal-auto-fill-function 'do-auto-fill
3234 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3235 Some major modes set this.")
3237 ;; FIXME: turn into a proper minor mode.
3238 ;; Add a global minor mode version of it.
3239 (defun auto-fill-mode (&optional arg)
3240 "Toggle Auto Fill mode.
3241 With arg, turn Auto Fill mode on if and only if arg is positive.
3242 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
3243 automatically breaks the line at a previous space.
3245 The value of `normal-auto-fill-function' specifies the function to use
3246 for `auto-fill-function' when turning Auto Fill mode on."
3247 (interactive "P")
3248 (prog1 (setq auto-fill-function
3249 (if (if (null arg)
3250 (not auto-fill-function)
3251 (> (prefix-numeric-value arg) 0))
3252 normal-auto-fill-function
3253 nil))
3254 (force-mode-line-update)))
3256 ;; This holds a document string used to document auto-fill-mode.
3257 (defun auto-fill-function ()
3258 "Automatically break line at a previous space, in insertion of text."
3259 nil)
3261 (defun turn-on-auto-fill ()
3262 "Unconditionally turn on Auto Fill mode."
3263 (auto-fill-mode 1))
3265 (defun turn-off-auto-fill ()
3266 "Unconditionally turn off Auto Fill mode."
3267 (auto-fill-mode -1))
3269 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
3271 (defun set-fill-column (arg)
3272 "Set `fill-column' to specified argument.
3273 Use \\[universal-argument] followed by a number to specify a column.
3274 Just \\[universal-argument] as argument means to use the current column."
3275 (interactive "P")
3276 (if (consp arg)
3277 (setq arg (current-column)))
3278 (if (not (integerp arg))
3279 ;; Disallow missing argument; it's probably a typo for C-x C-f.
3280 (error "set-fill-column requires an explicit argument")
3281 (message "Fill column set to %d (was %d)" arg fill-column)
3282 (setq fill-column arg)))
3284 (defun set-selective-display (arg)
3285 "Set `selective-display' to ARG; clear it if no arg.
3286 When the value of `selective-display' is a number > 0,
3287 lines whose indentation is >= that value are not displayed.
3288 The variable `selective-display' has a separate value for each buffer."
3289 (interactive "P")
3290 (if (eq selective-display t)
3291 (error "selective-display already in use for marked lines"))
3292 (let ((current-vpos
3293 (save-restriction
3294 (narrow-to-region (point-min) (point))
3295 (goto-char (window-start))
3296 (vertical-motion (window-height)))))
3297 (setq selective-display
3298 (and arg (prefix-numeric-value arg)))
3299 (recenter current-vpos))
3300 (set-window-start (selected-window) (window-start (selected-window)))
3301 (princ "selective-display set to " t)
3302 (prin1 selective-display t)
3303 (princ "." t))
3305 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
3306 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
3308 (defun toggle-truncate-lines (arg)
3309 "Toggle whether to fold or truncate long lines on the screen.
3310 With arg, truncate long lines iff arg is positive.
3311 Note that in side-by-side windows, truncation is always enabled."
3312 (interactive "P")
3313 (setq truncate-lines
3314 (if (null arg)
3315 (not truncate-lines)
3316 (> (prefix-numeric-value arg) 0)))
3317 (force-mode-line-update)
3318 (unless truncate-lines
3319 (let ((buffer (current-buffer)))
3320 (walk-windows (lambda (window)
3321 (if (eq buffer (window-buffer window))
3322 (set-window-hscroll window 0)))
3323 nil t)))
3324 (message "Truncate long lines %s"
3325 (if truncate-lines "enabled" "disabled")))
3327 (defvar overwrite-mode-textual " Ovwrt"
3328 "The string displayed in the mode line when in overwrite mode.")
3329 (defvar overwrite-mode-binary " Bin Ovwrt"
3330 "The string displayed in the mode line when in binary overwrite mode.")
3332 (defun overwrite-mode (arg)
3333 "Toggle overwrite mode.
3334 With arg, turn overwrite mode on iff arg is positive.
3335 In overwrite mode, printing characters typed in replace existing text
3336 on a one-for-one basis, rather than pushing it to the right. At the
3337 end of a line, such characters extend the line. Before a tab,
3338 such characters insert until the tab is filled in.
3339 \\[quoted-insert] still inserts characters in overwrite mode; this
3340 is supposed to make it easier to insert characters when necessary."
3341 (interactive "P")
3342 (setq overwrite-mode
3343 (if (if (null arg) (not overwrite-mode)
3344 (> (prefix-numeric-value arg) 0))
3345 'overwrite-mode-textual))
3346 (force-mode-line-update))
3348 (defun binary-overwrite-mode (arg)
3349 "Toggle binary overwrite mode.
3350 With arg, turn binary overwrite mode on iff arg is positive.
3351 In binary overwrite mode, printing characters typed in replace
3352 existing text. Newlines are not treated specially, so typing at the
3353 end of a line joins the line to the next, with the typed character
3354 between them. Typing before a tab character simply replaces the tab
3355 with the character typed.
3356 \\[quoted-insert] replaces the text at the cursor, just as ordinary
3357 typing characters do.
3359 Note that binary overwrite mode is not its own minor mode; it is a
3360 specialization of overwrite-mode, entered by setting the
3361 `overwrite-mode' variable to `overwrite-mode-binary'."
3362 (interactive "P")
3363 (setq overwrite-mode
3364 (if (if (null arg)
3365 (not (eq overwrite-mode 'overwrite-mode-binary))
3366 (> (prefix-numeric-value arg) 0))
3367 'overwrite-mode-binary))
3368 (force-mode-line-update))
3370 (define-minor-mode line-number-mode
3371 "Toggle Line Number mode.
3372 With arg, turn Line Number mode on iff arg is positive.
3373 When Line Number mode is enabled, the line number appears
3374 in the mode line.
3376 Line numbers do not appear for very large buffers and buffers
3377 with very long lines; see variables `line-number-display-limit'
3378 and `line-number-display-limit-width'."
3379 :init-value t :global t :group 'editing-basics :require nil)
3381 (define-minor-mode column-number-mode
3382 "Toggle Column Number mode.
3383 With arg, turn Column Number mode on iff arg is positive.
3384 When Column Number mode is enabled, the column number appears
3385 in the mode line."
3386 :global t :group 'editing-basics :require nil)
3388 (defgroup paren-blinking nil
3389 "Blinking matching of parens and expressions."
3390 :prefix "blink-matching-"
3391 :group 'paren-matching)
3393 (defcustom blink-matching-paren t
3394 "*Non-nil means show matching open-paren when close-paren is inserted."
3395 :type 'boolean
3396 :group 'paren-blinking)
3398 (defcustom blink-matching-paren-on-screen t
3399 "*Non-nil means show matching open-paren when it is on screen.
3400 If nil, means don't show it (but the open-paren can still be shown
3401 when it is off screen)."
3402 :type 'boolean
3403 :group 'paren-blinking)
3405 (defcustom blink-matching-paren-distance (* 25 1024)
3406 "*If non-nil, is maximum distance to search for matching open-paren."
3407 :type 'integer
3408 :group 'paren-blinking)
3410 (defcustom blink-matching-delay 1
3411 "*Time in seconds to delay after showing a matching paren."
3412 :type 'number
3413 :group 'paren-blinking)
3415 (defcustom blink-matching-paren-dont-ignore-comments nil
3416 "*Non-nil means `blink-matching-paren' will not ignore comments."
3417 :type 'boolean
3418 :group 'paren-blinking)
3420 (defun blink-matching-open ()
3421 "Move cursor momentarily to the beginning of the sexp before point."
3422 (interactive)
3423 (and (> (point) (1+ (point-min)))
3424 blink-matching-paren
3425 ;; Verify an even number of quoting characters precede the close.
3426 (= 1 (logand 1 (- (point)
3427 (save-excursion
3428 (forward-char -1)
3429 (skip-syntax-backward "/\\")
3430 (point)))))
3431 (let* ((oldpos (point))
3432 (blinkpos)
3433 (mismatch))
3434 (save-excursion
3435 (save-restriction
3436 (if blink-matching-paren-distance
3437 (narrow-to-region (max (point-min)
3438 (- (point) blink-matching-paren-distance))
3439 oldpos))
3440 (condition-case ()
3441 (let ((parse-sexp-ignore-comments
3442 (and parse-sexp-ignore-comments
3443 (not blink-matching-paren-dont-ignore-comments))))
3444 (setq blinkpos (scan-sexps oldpos -1)))
3445 (error nil)))
3446 (and blinkpos
3447 (/= (char-syntax (char-after blinkpos))
3448 ?\$)
3449 (setq mismatch
3450 (or (null (matching-paren (char-after blinkpos)))
3451 (/= (char-after (1- oldpos))
3452 (matching-paren (char-after blinkpos))))))
3453 (if mismatch (setq blinkpos nil))
3454 (if blinkpos
3455 ;; Don't log messages about paren matching.
3456 (let (message-log-max)
3457 (goto-char blinkpos)
3458 (if (pos-visible-in-window-p)
3459 (and blink-matching-paren-on-screen
3460 (sit-for blink-matching-delay))
3461 (goto-char blinkpos)
3462 (message
3463 "Matches %s"
3464 ;; Show what precedes the open in its line, if anything.
3465 (if (save-excursion
3466 (skip-chars-backward " \t")
3467 (not (bolp)))
3468 (buffer-substring (progn (beginning-of-line) (point))
3469 (1+ blinkpos))
3470 ;; Show what follows the open in its line, if anything.
3471 (if (save-excursion
3472 (forward-char 1)
3473 (skip-chars-forward " \t")
3474 (not (eolp)))
3475 (buffer-substring blinkpos
3476 (progn (end-of-line) (point)))
3477 ;; Otherwise show the previous nonblank line,
3478 ;; if there is one.
3479 (if (save-excursion
3480 (skip-chars-backward "\n \t")
3481 (not (bobp)))
3482 (concat
3483 (buffer-substring (progn
3484 (skip-chars-backward "\n \t")
3485 (beginning-of-line)
3486 (point))
3487 (progn (end-of-line)
3488 (skip-chars-backward " \t")
3489 (point)))
3490 ;; Replace the newline and other whitespace with `...'.
3491 "..."
3492 (buffer-substring blinkpos (1+ blinkpos)))
3493 ;; There is nothing to show except the char itself.
3494 (buffer-substring blinkpos (1+ blinkpos))))))))
3495 (cond (mismatch
3496 (message "Mismatched parentheses"))
3497 ((not blink-matching-paren-distance)
3498 (message "Unmatched parenthesis"))))))))
3500 ;Turned off because it makes dbx bomb out.
3501 (setq blink-paren-function 'blink-matching-open)
3503 ;; This executes C-g typed while Emacs is waiting for a command.
3504 ;; Quitting out of a program does not go through here;
3505 ;; that happens in the QUIT macro at the C code level.
3506 (defun keyboard-quit ()
3507 "Signal a `quit' condition.
3508 During execution of Lisp code, this character causes a quit directly.
3509 At top-level, as an editor command, this simply beeps."
3510 (interactive)
3511 (deactivate-mark)
3512 (setq defining-kbd-macro nil)
3513 (signal 'quit nil))
3515 (define-key global-map "\C-g" 'keyboard-quit)
3517 (defvar buffer-quit-function nil
3518 "Function to call to \"quit\" the current buffer, or nil if none.
3519 \\[keyboard-escape-quit] calls this function when its more local actions
3520 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3522 (defun keyboard-escape-quit ()
3523 "Exit the current \"mode\" (in a generalized sense of the word).
3524 This command can exit an interactive command such as `query-replace',
3525 can clear out a prefix argument or a region,
3526 can get out of the minibuffer or other recursive edit,
3527 cancel the use of the current buffer (for special-purpose buffers),
3528 or go back to just one window (by deleting all but the selected window)."
3529 (interactive)
3530 (cond ((eq last-command 'mode-exited) nil)
3531 ((> (minibuffer-depth) 0)
3532 (abort-recursive-edit))
3533 (current-prefix-arg
3534 nil)
3535 ((and transient-mark-mode
3536 mark-active)
3537 (deactivate-mark))
3538 ((> (recursion-depth) 0)
3539 (exit-recursive-edit))
3540 (buffer-quit-function
3541 (funcall buffer-quit-function))
3542 ((not (one-window-p t))
3543 (delete-other-windows))
3544 ((string-match "^ \\*" (buffer-name (current-buffer)))
3545 (bury-buffer))))
3547 (defun play-sound-file (file &optional volume device)
3548 "Play sound stored in FILE.
3549 VOLUME and DEVICE correspond to the keywords of the sound
3550 specification for `play-sound'."
3551 (interactive "fPlay sound file: ")
3552 (let ((sound (list :file file)))
3553 (if volume
3554 (plist-put sound :volume volume))
3555 (if device
3556 (plist-put sound :device device))
3557 (push 'sound sound)
3558 (play-sound sound)))
3560 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3562 (defcustom read-mail-command 'rmail
3563 "*Your preference for a mail reading package.
3564 This is used by some keybindings which support reading mail.
3565 See also `mail-user-agent' concerning sending mail."
3566 :type '(choice (function-item rmail)
3567 (function-item gnus)
3568 (function-item mh-rmail)
3569 (function :tag "Other"))
3570 :version "21.1"
3571 :group 'mail)
3573 (defcustom mail-user-agent 'sendmail-user-agent
3574 "*Your preference for a mail composition package.
3575 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
3576 outgoing email message. This variable lets you specify which
3577 mail-sending package you prefer.
3579 Valid values include:
3581 `sendmail-user-agent' -- use the default Emacs Mail package.
3582 See Info node `(emacs)Sending Mail'.
3583 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
3584 See Info node `(mh-e)'.
3585 `message-user-agent' -- use the Gnus Message package.
3586 See Info node `(message)'.
3587 `gnus-user-agent' -- like `message-user-agent', but with Gnus
3588 paraphernalia, particularly the Gcc: header for
3589 archiving.
3591 Additional valid symbols may be available; check with the author of
3592 your package for details. The function should return non-nil if it
3593 succeeds.
3595 See also `read-mail-command' concerning reading mail."
3596 :type '(radio (function-item :tag "Default Emacs mail"
3597 :format "%t\n"
3598 sendmail-user-agent)
3599 (function-item :tag "Emacs interface to MH"
3600 :format "%t\n"
3601 mh-e-user-agent)
3602 (function-item :tag "Gnus Message package"
3603 :format "%t\n"
3604 message-user-agent)
3605 (function-item :tag "Gnus Message with full Gnus features"
3606 :format "%t\n"
3607 gnus-user-agent)
3608 (function :tag "Other"))
3609 :group 'mail)
3611 (define-mail-user-agent 'sendmail-user-agent
3612 'sendmail-user-agent-compose
3613 'mail-send-and-exit)
3615 (defun rfc822-goto-eoh ()
3616 ;; Go to header delimiter line in a mail message, following RFC822 rules
3617 (goto-char (point-min))
3618 (when (re-search-forward
3619 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
3620 (goto-char (match-beginning 0))))
3622 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3623 switch-function yank-action
3624 send-actions)
3625 (if switch-function
3626 (let ((special-display-buffer-names nil)
3627 (special-display-regexps nil)
3628 (same-window-buffer-names nil)
3629 (same-window-regexps nil))
3630 (funcall switch-function "*mail*")))
3631 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3632 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3633 (body (cdr (assoc-ignore-case "body" other-headers))))
3634 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3635 continue
3636 (error "Message aborted"))
3637 (save-excursion
3638 (rfc822-goto-eoh)
3639 (while other-headers
3640 (unless (member-ignore-case (car (car other-headers))
3641 '("in-reply-to" "cc" "body"))
3642 (insert (car (car other-headers)) ": "
3643 (cdr (car other-headers)) "\n"))
3644 (setq other-headers (cdr other-headers)))
3645 (when body
3646 (forward-line 1)
3647 (insert body))
3648 t)))
3650 (define-mail-user-agent 'mh-e-user-agent
3651 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3652 'mh-before-send-letter-hook)
3654 (defun compose-mail (&optional to subject other-headers continue
3655 switch-function yank-action send-actions)
3656 "Start composing a mail message to send.
3657 This uses the user's chosen mail composition package
3658 as selected with the variable `mail-user-agent'.
3659 The optional arguments TO and SUBJECT specify recipients
3660 and the initial Subject field, respectively.
3662 OTHER-HEADERS is an alist specifying additional
3663 header fields. Elements look like (HEADER . VALUE) where both
3664 HEADER and VALUE are strings.
3666 CONTINUE, if non-nil, says to continue editing a message already
3667 being composed.
3669 SWITCH-FUNCTION, if non-nil, is a function to use to
3670 switch to and display the buffer used for mail composition.
3672 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3673 to insert the raw text of the message being replied to.
3674 It has the form (FUNCTION . ARGS). The user agent will apply
3675 FUNCTION to ARGS, to insert the raw text of the original message.
3676 \(The user agent will also run `mail-citation-hook', *after* the
3677 original text has been inserted in this way.)
3679 SEND-ACTIONS is a list of actions to call when the message is sent.
3680 Each action has the form (FUNCTION . ARGS)."
3681 (interactive
3682 (list nil nil nil current-prefix-arg))
3683 (let ((function (get mail-user-agent 'composefunc)))
3684 (funcall function to subject other-headers continue
3685 switch-function yank-action send-actions)))
3687 (defun compose-mail-other-window (&optional to subject other-headers continue
3688 yank-action send-actions)
3689 "Like \\[compose-mail], but edit the outgoing message in another window."
3690 (interactive
3691 (list nil nil nil current-prefix-arg))
3692 (compose-mail to subject other-headers continue
3693 'switch-to-buffer-other-window yank-action send-actions))
3696 (defun compose-mail-other-frame (&optional to subject other-headers continue
3697 yank-action send-actions)
3698 "Like \\[compose-mail], but edit the outgoing message in another frame."
3699 (interactive
3700 (list nil nil nil current-prefix-arg))
3701 (compose-mail to subject other-headers continue
3702 'switch-to-buffer-other-frame yank-action send-actions))
3704 (defvar set-variable-value-history nil
3705 "History of values entered with `set-variable'.")
3707 (defun set-variable (var val &optional make-local)
3708 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3709 When using this interactively, enter a Lisp object for VALUE.
3710 If you want VALUE to be a string, you must surround it with doublequotes.
3711 VALUE is used literally, not evaluated.
3713 If VARIABLE has a `variable-interactive' property, that is used as if
3714 it were the arg to `interactive' (which see) to interactively read VALUE.
3716 If VARIABLE has been defined with `defcustom', then the type information
3717 in the definition is used to check that VALUE is valid.
3719 With a prefix argument, set VARIABLE to VALUE buffer-locally."
3720 (interactive
3721 (let* ((default-var (variable-at-point))
3722 (var (if (symbolp default-var)
3723 (read-variable (format "Set variable (default %s): " default-var)
3724 default-var)
3725 (read-variable "Set variable: ")))
3726 (minibuffer-help-form '(describe-variable var))
3727 (prop (get var 'variable-interactive))
3728 (prompt (format "Set %s%s to value: " var
3729 (cond ((local-variable-p var)
3730 " (buffer-local)")
3731 ((or current-prefix-arg
3732 (local-variable-if-set-p var))
3733 " buffer-locally")
3734 (t " globally"))))
3735 (val (if prop
3736 ;; Use VAR's `variable-interactive' property
3737 ;; as an interactive spec for prompting.
3738 (call-interactively `(lambda (arg)
3739 (interactive ,prop)
3740 arg))
3741 (read
3742 (read-string prompt nil
3743 'set-variable-value-history)))))
3744 (list var val current-prefix-arg)))
3746 (and (custom-variable-p var)
3747 (not (get var 'custom-type))
3748 (custom-load-symbol var))
3749 (let ((type (get var 'custom-type)))
3750 (when type
3751 ;; Match with custom type.
3752 (require 'cus-edit)
3753 (setq type (widget-convert type))
3754 (unless (widget-apply type :match val)
3755 (error "Value `%S' does not match type %S of %S"
3756 val (car type) var))))
3758 (if make-local
3759 (make-local-variable var))
3761 (set var val)
3763 ;; Force a thorough redisplay for the case that the variable
3764 ;; has an effect on the display, like `tab-width' has.
3765 (force-mode-line-update))
3767 ;; Define the major mode for lists of completions.
3769 (defvar completion-list-mode-map nil
3770 "Local map for completion list buffers.")
3771 (or completion-list-mode-map
3772 (let ((map (make-sparse-keymap)))
3773 (define-key map [mouse-2] 'mouse-choose-completion)
3774 (define-key map [down-mouse-2] nil)
3775 (define-key map "\C-m" 'choose-completion)
3776 (define-key map "\e\e\e" 'delete-completion-window)
3777 (define-key map [left] 'previous-completion)
3778 (define-key map [right] 'next-completion)
3779 (setq completion-list-mode-map map)))
3781 ;; Completion mode is suitable only for specially formatted data.
3782 (put 'completion-list-mode 'mode-class 'special)
3784 (defvar completion-reference-buffer nil
3785 "Record the buffer that was current when the completion list was requested.
3786 This is a local variable in the completion list buffer.
3787 Initial value is nil to avoid some compiler warnings.")
3789 (defvar completion-no-auto-exit nil
3790 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3791 This also applies to other functions such as `choose-completion'
3792 and `mouse-choose-completion'.")
3794 (defvar completion-base-size nil
3795 "Number of chars at beginning of minibuffer not involved in completion.
3796 This is a local variable in the completion list buffer
3797 but it talks about the buffer in `completion-reference-buffer'.
3798 If this is nil, it means to compare text to determine which part
3799 of the tail end of the buffer's text is involved in completion.")
3801 (defun delete-completion-window ()
3802 "Delete the completion list window.
3803 Go to the window from which completion was requested."
3804 (interactive)
3805 (let ((buf completion-reference-buffer))
3806 (if (one-window-p t)
3807 (if (window-dedicated-p (selected-window))
3808 (delete-frame (selected-frame)))
3809 (delete-window (selected-window))
3810 (if (get-buffer-window buf)
3811 (select-window (get-buffer-window buf))))))
3813 (defun previous-completion (n)
3814 "Move to the previous item in the completion list."
3815 (interactive "p")
3816 (next-completion (- n)))
3818 (defun next-completion (n)
3819 "Move to the next item in the completion list.
3820 With prefix argument N, move N items (negative N means move backward)."
3821 (interactive "p")
3822 (let ((beg (point-min)) (end (point-max)))
3823 (while (and (> n 0) (not (eobp)))
3824 ;; If in a completion, move to the end of it.
3825 (when (get-text-property (point) 'mouse-face)
3826 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3827 ;; Move to start of next one.
3828 (unless (get-text-property (point) 'mouse-face)
3829 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3830 (setq n (1- n)))
3831 (while (and (< n 0) (not (bobp)))
3832 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
3833 ;; If in a completion, move to the start of it.
3834 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
3835 (goto-char (previous-single-property-change
3836 (point) 'mouse-face nil beg)))
3837 ;; Move to end of the previous completion.
3838 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
3839 (goto-char (previous-single-property-change
3840 (point) 'mouse-face nil beg)))
3841 ;; Move to the start of that one.
3842 (goto-char (previous-single-property-change
3843 (point) 'mouse-face nil beg))
3844 (setq n (1+ n))))))
3846 (defun choose-completion ()
3847 "Choose the completion that point is in or next to."
3848 (interactive)
3849 (let (beg end completion (buffer completion-reference-buffer)
3850 (base-size completion-base-size))
3851 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3852 (setq end (point) beg (1+ (point))))
3853 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3854 (setq end (1- (point)) beg (point)))
3855 (if (null beg)
3856 (error "No completion here"))
3857 (setq beg (previous-single-property-change beg 'mouse-face))
3858 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3859 (setq completion (buffer-substring beg end))
3860 (let ((owindow (selected-window)))
3861 (if (and (one-window-p t 'selected-frame)
3862 (window-dedicated-p (selected-window)))
3863 ;; This is a special buffer's frame
3864 (iconify-frame (selected-frame))
3865 (or (window-dedicated-p (selected-window))
3866 (bury-buffer)))
3867 (select-window owindow))
3868 (choose-completion-string completion buffer base-size)))
3870 ;; Delete the longest partial match for STRING
3871 ;; that can be found before POINT.
3872 (defun choose-completion-delete-max-match (string)
3873 (let ((opoint (point))
3874 len)
3875 ;; Try moving back by the length of the string.
3876 (goto-char (max (- (point) (length string))
3877 (minibuffer-prompt-end)))
3878 ;; See how far back we were actually able to move. That is the
3879 ;; upper bound on how much we can match and delete.
3880 (setq len (- opoint (point)))
3881 (if completion-ignore-case
3882 (setq string (downcase string)))
3883 (while (and (> len 0)
3884 (let ((tail (buffer-substring (point) opoint)))
3885 (if completion-ignore-case
3886 (setq tail (downcase tail)))
3887 (not (string= tail (substring string 0 len)))))
3888 (setq len (1- len))
3889 (forward-char 1))
3890 (delete-char len)))
3892 (defvar choose-completion-string-functions nil
3893 "Functions that may override the normal insertion of a completion choice.
3894 These functions are called in order with four arguments:
3895 CHOICE - the string to insert in the buffer,
3896 BUFFER - the buffer in which the choice should be inserted,
3897 MINI-P - non-nil iff BUFFER is a minibuffer, and
3898 BASE-SIZE - the number of characters in BUFFER before
3899 the string being completed.
3901 If a function in the list returns non-nil, that function is supposed
3902 to have inserted the CHOICE in the BUFFER, and possibly exited
3903 the minibuffer; no further functions will be called.
3905 If all functions in the list return nil, that means to use
3906 the default method of inserting the completion in BUFFER.")
3908 (defun choose-completion-string (choice &optional buffer base-size)
3909 "Switch to BUFFER and insert the completion choice CHOICE.
3910 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3911 to keep. If it is nil, we call `choose-completion-delete-max-match'
3912 to decide what to delete."
3914 ;; If BUFFER is the minibuffer, exit the minibuffer
3915 ;; unless it is reading a file name and CHOICE is a directory,
3916 ;; or completion-no-auto-exit is non-nil.
3918 (let ((buffer (or buffer completion-reference-buffer))
3919 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3920 (buffer-name buffer))))
3921 ;; If BUFFER is a minibuffer, barf unless it's the currently
3922 ;; active minibuffer.
3923 (if (and mini-p
3924 (or (not (active-minibuffer-window))
3925 (not (equal buffer
3926 (window-buffer (active-minibuffer-window))))))
3927 (error "Minibuffer is not active for completion")
3928 (unless (run-hook-with-args-until-success
3929 'choose-completion-string-functions
3930 choice buffer mini-p base-size)
3931 ;; Insert the completion into the buffer where it was requested.
3932 (set-buffer buffer)
3933 (if base-size
3934 (delete-region (+ base-size (if mini-p
3935 (minibuffer-prompt-end)
3936 (point-min)))
3937 (point))
3938 (choose-completion-delete-max-match choice))
3939 (insert choice)
3940 (remove-text-properties (- (point) (length choice)) (point)
3941 '(mouse-face nil))
3942 ;; Update point in the window that BUFFER is showing in.
3943 (let ((window (get-buffer-window buffer t)))
3944 (set-window-point window (point)))
3945 ;; If completing for the minibuffer, exit it with this choice.
3946 (and (not completion-no-auto-exit)
3947 (equal buffer (window-buffer (minibuffer-window)))
3948 minibuffer-completion-table
3949 ;; If this is reading a file name, and the file name chosen
3950 ;; is a directory, don't exit the minibuffer.
3951 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
3952 (file-directory-p (field-string (point-max))))
3953 (let ((mini (active-minibuffer-window)))
3954 (select-window mini)
3955 (when minibuffer-auto-raise
3956 (raise-frame (window-frame mini))))
3957 (exit-minibuffer)))))))
3959 (defun completion-list-mode ()
3960 "Major mode for buffers showing lists of possible completions.
3961 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3962 to select the completion near point.
3963 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3964 with the mouse."
3965 (interactive)
3966 (kill-all-local-variables)
3967 (use-local-map completion-list-mode-map)
3968 (setq mode-name "Completion List")
3969 (setq major-mode 'completion-list-mode)
3970 (make-local-variable 'completion-base-size)
3971 (setq completion-base-size nil)
3972 (run-hooks 'completion-list-mode-hook))
3974 (defun completion-list-mode-finish ()
3975 "Finish setup of the completions buffer.
3976 Called from `temp-buffer-show-hook'."
3977 (when (eq major-mode 'completion-list-mode)
3978 (toggle-read-only 1)))
3980 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
3982 (defvar completion-setup-hook nil
3983 "Normal hook run at the end of setting up a completion list buffer.
3984 When this hook is run, the current buffer is the one in which the
3985 command to display the completion list buffer was run.
3986 The completion list buffer is available as the value of `standard-output'.")
3988 ;; This function goes in completion-setup-hook, so that it is called
3989 ;; after the text of the completion list buffer is written.
3991 (defun completion-setup-function ()
3992 (save-excursion
3993 (let ((mainbuf (current-buffer))
3994 (mbuf-contents (minibuffer-contents)))
3995 ;; When reading a file name in the minibuffer,
3996 ;; set default-directory in the minibuffer
3997 ;; so it will get copied into the completion list buffer.
3998 (if minibuffer-completing-file-name
3999 (with-current-buffer mainbuf
4000 (setq default-directory (file-name-directory mbuf-contents))))
4001 (set-buffer standard-output)
4002 (completion-list-mode)
4003 (make-local-variable 'completion-reference-buffer)
4004 (setq completion-reference-buffer mainbuf)
4005 (if minibuffer-completing-file-name
4006 ;; For file name completion,
4007 ;; use the number of chars before the start of the
4008 ;; last file name component.
4009 (setq completion-base-size
4010 (save-excursion
4011 (set-buffer mainbuf)
4012 (goto-char (point-max))
4013 (skip-chars-backward "^/")
4014 (- (point) (minibuffer-prompt-end))))
4015 ;; Otherwise, in minibuffer, the whole input is being completed.
4016 (save-match-data
4017 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
4018 (buffer-name mainbuf))
4019 (setq completion-base-size 0))))
4020 (goto-char (point-min))
4021 (if (display-mouse-p)
4022 (insert (substitute-command-keys
4023 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
4024 (insert (substitute-command-keys
4025 "In this buffer, type \\[choose-completion] to \
4026 select the completion near point.\n\n")))))
4028 (add-hook 'completion-setup-hook 'completion-setup-function)
4030 (define-key minibuffer-local-completion-map [prior]
4031 'switch-to-completions)
4032 (define-key minibuffer-local-must-match-map [prior]
4033 'switch-to-completions)
4034 (define-key minibuffer-local-completion-map "\M-v"
4035 'switch-to-completions)
4036 (define-key minibuffer-local-must-match-map "\M-v"
4037 'switch-to-completions)
4039 (defun switch-to-completions ()
4040 "Select the completion list window."
4041 (interactive)
4042 ;; Make sure we have a completions window.
4043 (or (get-buffer-window "*Completions*")
4044 (minibuffer-completion-help))
4045 (let ((window (get-buffer-window "*Completions*")))
4046 (when window
4047 (select-window window)
4048 (goto-char (point-min))
4049 (search-forward "\n\n")
4050 (forward-line 1))))
4052 ;; Support keyboard commands to turn on various modifiers.
4054 ;; These functions -- which are not commands -- each add one modifier
4055 ;; to the following event.
4057 (defun event-apply-alt-modifier (ignore-prompt)
4058 "Add the Alt modifier to the following event.
4059 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
4060 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4061 (defun event-apply-super-modifier (ignore-prompt)
4062 "Add the Super modifier to the following event.
4063 For example, type \\[event-apply-super-modifier] & to enter Super-&."
4064 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4065 (defun event-apply-hyper-modifier (ignore-prompt)
4066 "Add the Hyper modifier to the following event.
4067 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
4068 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
4069 (defun event-apply-shift-modifier (ignore-prompt)
4070 "Add the Shift modifier to the following event.
4071 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
4072 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
4073 (defun event-apply-control-modifier (ignore-prompt)
4074 "Add the Ctrl modifier to the following event.
4075 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
4076 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
4077 (defun event-apply-meta-modifier (ignore-prompt)
4078 "Add the Meta modifier to the following event.
4079 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
4080 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
4082 (defun event-apply-modifier (event symbol lshiftby prefix)
4083 "Apply a modifier flag to event EVENT.
4084 SYMBOL is the name of this modifier, as a symbol.
4085 LSHIFTBY is the numeric value of this modifier, in keyboard events.
4086 PREFIX is the string that represents this modifier in an event type symbol."
4087 (if (numberp event)
4088 (cond ((eq symbol 'control)
4089 (if (and (<= (downcase event) ?z)
4090 (>= (downcase event) ?a))
4091 (- (downcase event) ?a -1)
4092 (if (and (<= (downcase event) ?Z)
4093 (>= (downcase event) ?A))
4094 (- (downcase event) ?A -1)
4095 (logior (lsh 1 lshiftby) event))))
4096 ((eq symbol 'shift)
4097 (if (and (<= (downcase event) ?z)
4098 (>= (downcase event) ?a))
4099 (upcase event)
4100 (logior (lsh 1 lshiftby) event)))
4102 (logior (lsh 1 lshiftby) event)))
4103 (if (memq symbol (event-modifiers event))
4104 event
4105 (let ((event-type (if (symbolp event) event (car event))))
4106 (setq event-type (intern (concat prefix (symbol-name event-type))))
4107 (if (symbolp event)
4108 event-type
4109 (cons event-type (cdr event)))))))
4111 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
4112 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
4113 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
4114 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
4115 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
4116 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
4118 ;;;; Keypad support.
4120 ;;; Make the keypad keys act like ordinary typing keys. If people add
4121 ;;; bindings for the function key symbols, then those bindings will
4122 ;;; override these, so this shouldn't interfere with any existing
4123 ;;; bindings.
4125 ;; Also tell read-char how to handle these keys.
4126 (mapc
4127 (lambda (keypad-normal)
4128 (let ((keypad (nth 0 keypad-normal))
4129 (normal (nth 1 keypad-normal)))
4130 (put keypad 'ascii-character normal)
4131 (define-key function-key-map (vector keypad) (vector normal))))
4132 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
4133 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
4134 (kp-space ?\ )
4135 (kp-tab ?\t)
4136 (kp-enter ?\r)
4137 (kp-multiply ?*)
4138 (kp-add ?+)
4139 (kp-separator ?,)
4140 (kp-subtract ?-)
4141 (kp-decimal ?.)
4142 (kp-divide ?/)
4143 (kp-equal ?=)))
4145 ;;;;
4146 ;;;; forking a twin copy of a buffer.
4147 ;;;;
4149 (defvar clone-buffer-hook nil
4150 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
4152 (defun clone-process (process &optional newname)
4153 "Create a twin copy of PROCESS.
4154 If NEWNAME is nil, it defaults to PROCESS' name;
4155 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
4156 If PROCESS is associated with a buffer, the new process will be associated
4157 with the current buffer instead.
4158 Returns nil if PROCESS has already terminated."
4159 (setq newname (or newname (process-name process)))
4160 (if (string-match "<[0-9]+>\\'" newname)
4161 (setq newname (substring newname 0 (match-beginning 0))))
4162 (when (memq (process-status process) '(run stop open))
4163 (let* ((process-connection-type (process-tty-name process))
4164 (new-process
4165 (if (memq (process-status process) '(open))
4166 (let ((args (process-contact process t)))
4167 (setq args (plist-put args :name newname))
4168 (setq args (plist-put args :buffer
4169 (if (process-buffer process)
4170 (current-buffer))))
4171 (apply 'make-network-process args))
4172 (apply 'start-process newname
4173 (if (process-buffer process) (current-buffer))
4174 (process-command process)))))
4175 (set-process-query-on-exit-flag
4176 new-process (process-query-on-exit-flag process))
4177 (set-process-inherit-coding-system-flag
4178 new-process (process-inherit-coding-system-flag process))
4179 (set-process-filter new-process (process-filter process))
4180 (set-process-sentinel new-process (process-sentinel process))
4181 (set-process-plist new-process (copy-sequence (process-plist process)))
4182 new-process)))
4184 ;; things to maybe add (currently partly covered by `funcall mode'):
4185 ;; - syntax-table
4186 ;; - overlays
4187 (defun clone-buffer (&optional newname display-flag)
4188 "Create a twin copy of the current buffer.
4189 If NEWNAME is nil, it defaults to the current buffer's name;
4190 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
4192 If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
4193 This runs the normal hook `clone-buffer-hook' in the new buffer
4194 after it has been set up properly in other respects."
4195 (interactive
4196 (progn
4197 (if buffer-file-name
4198 (error "Cannot clone a file-visiting buffer"))
4199 (if (get major-mode 'no-clone)
4200 (error "Cannot clone a buffer in %s mode" mode-name))
4201 (list (if current-prefix-arg (read-string "Name: "))
4202 t)))
4203 (if buffer-file-name
4204 (error "Cannot clone a file-visiting buffer"))
4205 (if (get major-mode 'no-clone)
4206 (error "Cannot clone a buffer in %s mode" mode-name))
4207 (setq newname (or newname (buffer-name)))
4208 (if (string-match "<[0-9]+>\\'" newname)
4209 (setq newname (substring newname 0 (match-beginning 0))))
4210 (let ((buf (current-buffer))
4211 (ptmin (point-min))
4212 (ptmax (point-max))
4213 (pt (point))
4214 (mk (if mark-active (mark t)))
4215 (modified (buffer-modified-p))
4216 (mode major-mode)
4217 (lvars (buffer-local-variables))
4218 (process (get-buffer-process (current-buffer)))
4219 (new (generate-new-buffer (or newname (buffer-name)))))
4220 (save-restriction
4221 (widen)
4222 (with-current-buffer new
4223 (insert-buffer-substring buf)))
4224 (with-current-buffer new
4225 (narrow-to-region ptmin ptmax)
4226 (goto-char pt)
4227 (if mk (set-mark mk))
4228 (set-buffer-modified-p modified)
4230 ;; Clone the old buffer's process, if any.
4231 (when process (clone-process process))
4233 ;; Now set up the major mode.
4234 (funcall mode)
4236 ;; Set up other local variables.
4237 (mapcar (lambda (v)
4238 (condition-case () ;in case var is read-only
4239 (if (symbolp v)
4240 (makunbound v)
4241 (set (make-local-variable (car v)) (cdr v)))
4242 (error nil)))
4243 lvars)
4245 ;; Run any hooks (typically set up by the major mode
4246 ;; for cloning to work properly).
4247 (run-hooks 'clone-buffer-hook))
4248 (if display-flag (pop-to-buffer new))
4249 new))
4252 (defun clone-indirect-buffer (newname display-flag &optional norecord)
4253 "Create an indirect buffer that is a twin copy of the current buffer.
4255 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
4256 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
4257 or if not called with a prefix arg, NEWNAME defaults to the current
4258 buffer's name. The name is modified by adding a `<N>' suffix to it
4259 or by incrementing the N in an existing suffix.
4261 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
4262 This is always done when called interactively.
4264 Optional last arg NORECORD non-nil means do not put this buffer at the
4265 front of the list of recently selected ones."
4266 (interactive
4267 (progn
4268 (if (get major-mode 'no-clone-indirect)
4269 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
4270 (list (if current-prefix-arg
4271 (read-string "BName of indirect buffer: "))
4272 t)))
4273 (if (get major-mode 'no-clone-indirect)
4274 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
4275 (setq newname (or newname (buffer-name)))
4276 (if (string-match "<[0-9]+>\\'" newname)
4277 (setq newname (substring newname 0 (match-beginning 0))))
4278 (let* ((name (generate-new-buffer-name newname))
4279 (buffer (make-indirect-buffer (current-buffer) name t)))
4280 (when display-flag
4281 (pop-to-buffer buffer norecord))
4282 buffer))
4285 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
4286 "Create an indirect buffer that is a twin copy of BUFFER.
4287 Select the new buffer in another window.
4288 Optional second arg NORECORD non-nil means do not put this buffer at
4289 the front of the list of recently selected ones."
4290 (interactive "bClone buffer in other window: ")
4291 (let ((pop-up-windows t))
4292 (set-buffer buffer)
4293 (clone-indirect-buffer nil t norecord)))
4295 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
4297 ;;; Handling of Backspace and Delete keys.
4299 (defcustom normal-erase-is-backspace nil
4300 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
4302 On window systems, the default value of this option is chosen
4303 according to the keyboard used. If the keyboard has both a Backspace
4304 key and a Delete key, and both are mapped to their usual meanings, the
4305 option's default value is set to t, so that Backspace can be used to
4306 delete backward, and Delete can be used to delete forward.
4308 If not running under a window system, customizing this option accomplishes
4309 a similar effect by mapping C-h, which is usually generated by the
4310 Backspace key, to DEL, and by mapping DEL to C-d via
4311 `keyboard-translate'. The former functionality of C-h is available on
4312 the F1 key. You should probably not use this setting if you don't
4313 have both Backspace, Delete and F1 keys.
4315 Setting this variable with setq doesn't take effect. Programmatically,
4316 call `normal-erase-is-backspace-mode' (which see) instead."
4317 :type 'boolean
4318 :group 'editing-basics
4319 :version "21.1"
4320 :set (lambda (symbol value)
4321 ;; The fboundp is because of a problem with :set when
4322 ;; dumping Emacs. It doesn't really matter.
4323 (if (fboundp 'normal-erase-is-backspace-mode)
4324 (normal-erase-is-backspace-mode (or value 0))
4325 (set-default symbol value))))
4328 (defun normal-erase-is-backspace-mode (&optional arg)
4329 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
4331 With numeric arg, turn the mode on if and only if ARG is positive.
4333 On window systems, when this mode is on, Delete is mapped to C-d and
4334 Backspace is mapped to DEL; when this mode is off, both Delete and
4335 Backspace are mapped to DEL. (The remapping goes via
4336 `function-key-map', so binding Delete or Backspace in the global or
4337 local keymap will override that.)
4339 In addition, on window systems, the bindings of C-Delete, M-Delete,
4340 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
4341 the global keymap in accordance with the functionality of Delete and
4342 Backspace. For example, if Delete is remapped to C-d, which deletes
4343 forward, C-Delete is bound to `kill-word', but if Delete is remapped
4344 to DEL, which deletes backward, C-Delete is bound to
4345 `backward-kill-word'.
4347 If not running on a window system, a similar effect is accomplished by
4348 remapping C-h (normally produced by the Backspace key) and DEL via
4349 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
4350 to C-d; if it's off, the keys are not remapped.
4352 When not running on a window system, and this mode is turned on, the
4353 former functionality of C-h is available on the F1 key. You should
4354 probably not turn on this mode on a text-only terminal if you don't
4355 have both Backspace, Delete and F1 keys.
4357 See also `normal-erase-is-backspace'."
4358 (interactive "P")
4359 (setq normal-erase-is-backspace
4360 (if arg
4361 (> (prefix-numeric-value arg) 0)
4362 (not normal-erase-is-backspace)))
4364 (cond ((or (memq window-system '(x w32 mac pc))
4365 (memq system-type '(ms-dos windows-nt)))
4366 (let ((bindings
4367 `(([C-delete] [C-backspace])
4368 ([M-delete] [M-backspace])
4369 ([C-M-delete] [C-M-backspace])
4370 (,esc-map
4371 [C-delete] [C-backspace])))
4372 (old-state (lookup-key function-key-map [delete])))
4374 (if normal-erase-is-backspace
4375 (progn
4376 (define-key function-key-map [delete] [?\C-d])
4377 (define-key function-key-map [kp-delete] [?\C-d])
4378 (define-key function-key-map [backspace] [?\C-?]))
4379 (define-key function-key-map [delete] [?\C-?])
4380 (define-key function-key-map [kp-delete] [?\C-?])
4381 (define-key function-key-map [backspace] [?\C-?]))
4383 ;; Maybe swap bindings of C-delete and C-backspace, etc.
4384 (unless (equal old-state (lookup-key function-key-map [delete]))
4385 (dolist (binding bindings)
4386 (let ((map global-map))
4387 (when (keymapp (car binding))
4388 (setq map (car binding) binding (cdr binding)))
4389 (let* ((key1 (nth 0 binding))
4390 (key2 (nth 1 binding))
4391 (binding1 (lookup-key map key1))
4392 (binding2 (lookup-key map key2)))
4393 (define-key map key1 binding2)
4394 (define-key map key2 binding1)))))))
4396 (if normal-erase-is-backspace
4397 (progn
4398 (keyboard-translate ?\C-h ?\C-?)
4399 (keyboard-translate ?\C-? ?\C-d))
4400 (keyboard-translate ?\C-h ?\C-h)
4401 (keyboard-translate ?\C-? ?\C-?))))
4403 (run-hooks 'normal-erase-is-backspace-hook)
4404 (if (interactive-p)
4405 (message "Delete key deletes %s"
4406 (if normal-erase-is-backspace "forward" "backward"))))
4409 ;; Minibuffer prompt stuff.
4411 ;(defun minibuffer-prompt-modification (start end)
4412 ; (error "You cannot modify the prompt"))
4415 ;(defun minibuffer-prompt-insertion (start end)
4416 ; (let ((inhibit-modification-hooks t))
4417 ; (delete-region start end)
4418 ; ;; Discard undo information for the text insertion itself
4419 ; ;; and for the text deletion.above.
4420 ; (when (consp buffer-undo-list)
4421 ; (setq buffer-undo-list (cddr buffer-undo-list)))
4422 ; (message "You cannot modify the prompt")))
4425 ;(setq minibuffer-prompt-properties
4426 ; (list 'modification-hooks '(minibuffer-prompt-modification)
4427 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
4430 (provide 'simple)
4431 ;;; simple.el ends here