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