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