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