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