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)
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.
25 ;; A grab-bag of basic Emacs commands not specifically related to some
26 ;; major mode or to file-handling.
31 (autoload 'widget-convert
"wid-edit")
32 (autoload 'shell-mode
"shell")
37 "Killing and yanking commands"
40 (defgroup paren-matching nil
41 "Highlight (un)matching of parens and expressions."
45 (defun fundamental-mode ()
46 "Major mode not specialized for anything in particular.
47 Other major modes are defined by comparison with this one."
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."
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))
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
))
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)
89 (was-page-start (and (bolp)
90 (looking-at page-delimiter
)))
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
)))
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.
116 (goto-char beforepos
)
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.
125 (move-to-left-margin nil t
)))
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."
142 (let* ((do-fill-prefix (and fill-prefix
(bolp)))
143 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
145 ;; Don't expand an abbrev before point.
151 (if do-left-margin
(indent-to (current-left-margin)))
152 (if do-fill-prefix
(insert-and-inherit fill-prefix
))))
159 "Split current line, moving portion beyond point vertically down."
161 (skip-chars-forward " \t")
162 (let ((col (current-column))
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."
174 (if arg
(forward-line 1))
175 (if (eq (preceding-char) ?
\n)
177 (delete-region (point) (1- (point)))
178 ;; If the second line started with the fill prefix,
179 ;; delete the prefix.
181 (<= (+ (point) (length fill-prefix
)) (point-max))
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."
195 (let (thisblank singleblank
)
198 (setq thisblank
(looking-at "[ \t]*$"))
199 ;; Set singleblank if there is just one blank line here.
202 (not (looking-at "[ \t]*\n[ \t]*$"))
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.
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))
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
))
221 (delete-region (point)
222 (if (re-search-forward "[^ \t\n]" nil t
)
223 (progn (beginning-of-line) (point))
225 ;; Handle the special case where point is followed by newline and eob.
226 ;; Delete the line, leaving point at eob.
227 (if (looking-at "^[ \t]*\n\\'")
228 (delete-region (point) (point-max)))))
230 (defun delete-trailing-whitespace ()
231 "Delete all the trailing whitespace across the current buffer.
232 All whitespace after the last non-whitespace character in a line is deleted.
233 This respects narrowing, created by \\[narrow-to-region] and friends.
234 A formfeed is not considered whitespace by this function."
238 (goto-char (point-min))
239 (while (re-search-forward "\\s-$" nil t
)
240 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
241 ;; Don't delete formfeeds, even if they are considered whitespace.
242 (if (looking-at ".*\f")
243 (goto-char (match-end 0)))
244 (delete-region (point) (match-end 0))))))
246 (defun newline-and-indent ()
247 "Insert a newline, then indent according to major mode.
248 Indentation is done using the value of `indent-line-function'.
249 In programming language modes, this is the same as TAB.
250 In some text modes, where TAB inserts a tab, this command indents to the
251 column specified by the function `current-left-margin'."
253 (delete-horizontal-space t
)
255 (indent-according-to-mode))
257 (defun reindent-then-newline-and-indent ()
258 "Reindent current line, insert newline, then indent the new line.
259 Indentation of both lines is done according to the current major mode,
260 which means calling the current value of `indent-line-function'.
261 In programming language modes, this is the same as TAB.
262 In some text modes, where TAB inserts a tab, this indents to the
263 column specified by the function `current-left-margin'."
266 (delete-horizontal-space t
)
267 (indent-according-to-mode))
269 (indent-according-to-mode))
271 (defun quoted-insert (arg)
272 "Read next input character and insert it.
273 This is useful for inserting control characters.
275 If the first character you type after this command is an octal digit,
276 you should type a sequence of octal digits which specify a character code.
277 Any nondigit terminates the sequence. If the terminator is a RET,
278 it is discarded; any other terminator is used itself as input.
279 The variable `read-quoted-char-radix' specifies the radix for this feature;
280 set it to 10 or 16 to use decimal or hex instead of octal.
282 In overwrite mode, this function inserts the character anyway, and
283 does not handle octal digits specially. This means that if you use
284 overwrite as your normal editing mode, you can use this function to
285 insert characters when necessary.
287 In binary overwrite mode, this function does overwrite, and octal
288 digits are interpreted as a character code. This is intended to be
289 useful for editing binary files."
291 (let ((char (if (or (not overwrite-mode
)
292 (eq overwrite-mode
'overwrite-mode-binary
))
295 ;; Assume character codes 0240 - 0377 stand for characters in some
296 ;; single-byte character set, and convert them to Emacs
298 (if (and enable-multibyte-characters
301 (setq char
(unibyte-char-to-multibyte char
)))
303 (if (eq overwrite-mode
'overwrite-mode-binary
)
306 (insert-and-inherit char
)
307 (setq arg
(1- arg
)))))
309 (defun forward-to-indentation (arg)
310 "Move forward ARG lines and position at first nonblank character."
313 (skip-chars-forward " \t"))
315 (defun backward-to-indentation (arg)
316 "Move backward ARG lines and position at first nonblank character."
318 (forward-line (- arg
))
319 (skip-chars-forward " \t"))
321 (defun back-to-indentation ()
322 "Move point to the first non-whitespace character on this line."
324 (beginning-of-line 1)
325 (skip-chars-forward " \t"))
327 (defun fixup-whitespace ()
328 "Fixup white space between objects around point.
329 Leave one space or none, according to the context."
332 (delete-horizontal-space)
333 (if (or (looking-at "^\\|\\s)")
334 (save-excursion (forward-char -
1)
335 (looking-at "$\\|\\s(\\|\\s'")))
339 (defun delete-horizontal-space (&optional backward-only
)
340 "Delete all spaces and tabs around point.
341 If BACKWARD-ONLY is non-nil, only delete spaces before point."
347 (skip-chars-forward " \t" (field-end))
350 (skip-chars-backward " \t" (field-beginning nil t
))
353 (defun just-one-space ()
354 "Delete all spaces and tabs around point, leaving one space."
356 (skip-chars-backward " \t" (field-beginning))
357 (if (= (following-char) ?
)
363 (skip-chars-forward " \t" (field-end nil t
))
366 (defun beginning-of-buffer (&optional arg
)
367 "Move point to the beginning of the buffer; leave mark at previous position.
368 With arg N, put point N/10 of the way from the beginning.
370 If the buffer is narrowed, this command uses the beginning and size
371 of the accessible part of the buffer.
373 Don't use this command in Lisp programs!
374 \(goto-char (point-min)) is faster and avoids clobbering the mark."
377 (let ((size (- (point-max) (point-min))))
381 ;; Avoid overflow for large buffer sizes!
382 (* (prefix-numeric-value arg
)
384 (/ (+ 10 (* size
(prefix-numeric-value arg
))) 10)))
386 (if arg
(forward-line 1)))
388 (defun end-of-buffer (&optional arg
)
389 "Move point to the end of the buffer; leave mark at previous position.
390 With arg N, put point N/10 of the way from the end.
392 If the buffer is narrowed, this command uses the beginning and size
393 of the accessible part of the buffer.
395 Don't use this command in Lisp programs!
396 \(goto-char (point-max)) is faster and avoids clobbering the mark."
399 (let ((size (- (point-max) (point-min))))
403 ;; Avoid overflow for large buffer sizes!
404 (* (prefix-numeric-value arg
)
406 (/ (* size
(prefix-numeric-value arg
)) 10)))
408 ;; If we went to a place in the middle of the buffer,
409 ;; adjust it to the beginning of a line.
410 (cond (arg (forward-line 1))
411 ((< (point) (window-end nil t
))
412 ;; If the end of the buffer is not already on the screen,
413 ;; then scroll specially to put it near, but not at, the bottom.
414 (overlay-recenter (point))
417 (defun mark-whole-buffer ()
418 "Put point at beginning and mark at end of buffer.
419 You probably should not use this function in Lisp programs;
420 it is usually a mistake for a Lisp function to use any subroutine
421 that uses or sets the mark."
424 (push-mark (point-max) nil t
)
425 (goto-char (point-min)))
428 ;; Counting lines, one way or another.
430 (defun goto-line (arg)
431 "Goto line ARG, counting from line 1 at beginning of buffer."
432 (interactive "NGoto line: ")
433 (setq arg
(prefix-numeric-value arg
))
437 (if (eq selective-display t
)
438 (re-search-forward "[\n\C-m]" nil
'end
(1- arg
))
439 (forward-line (1- arg
)))))
441 (defun count-lines-region (start end
)
442 "Print number of lines and characters in the region."
444 (message "Region has %d lines, %d characters"
445 (count-lines start end
) (- end start
)))
448 "Print the current buffer line number and narrowed line number of point."
450 (let ((opoint (point)) start
)
453 (goto-char (point-min))
460 (message "line %d (narrowed line %d)"
461 (1+ (count-lines 1 (point)))
462 (1+ (count-lines start
(point))))
463 (message "Line %d" (1+ (count-lines 1 (point)))))))))
465 (defun count-lines (start end
)
466 "Return number of lines between START and END.
467 This is usually the number of newlines between them,
468 but can be one more if START is not equal to END
469 and the greater of them is not at the start of a line."
472 (narrow-to-region start end
)
473 (goto-char (point-min))
474 (if (eq selective-display t
)
477 (while (re-search-forward "[\n\C-m]" nil t
40)
478 (setq done
(+ 40 done
)))
479 (while (re-search-forward "[\n\C-m]" nil t
1)
480 (setq done
(+ 1 done
)))
481 (goto-char (point-max))
482 (if (and (/= start end
)
486 (- (buffer-size) (forward-line (buffer-size)))))))
488 (defun what-cursor-position (&optional detail
)
489 "Print info on cursor position (on screen and within buffer).
490 Also describe the character after point, and give its character code
491 in octal, decimal and hex.
493 For a non-ASCII multibyte character, also give its encoding in the
494 buffer's selected coding system if the coding system encodes the
495 character safely. If the character is encoded into one byte, that
496 code is shown in hex. If the character is encoded into more than one
497 byte, just \"...\" is shown.
499 In addition, with prefix argument, show details about that character
500 in *Help* buffer. See also the command `describe-char-after'."
502 (let* ((char (following-char))
506 (total (buffer-size))
507 (percent (if (> total
50000)
508 ;; Avoid overflow from multiplying by 100!
509 (/ (+ (/ total
200) (1- pos
)) (max (/ total
100) 1))
510 (/ (+ (/ total
2) (* 100 (1- pos
))) (max total
1))))
511 (hscroll (if (= (window-hscroll) 0)
513 (format " Hscroll=%d" (window-hscroll))))
514 (col (current-column)))
516 (if (or (/= beg
1) (/= end
(1+ total
)))
517 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
518 pos total percent beg end col hscroll
)
519 (message "point=%d of %d (%d%%) column %d %s"
520 pos total percent col hscroll
))
521 (let ((coding buffer-file-coding-system
)
522 encoded encoding-msg
)
524 (eq (coding-system-type coding
) t
))
525 (setq coding default-buffer-file-coding-system
))
526 (if (not (char-valid-p char
))
528 (format "(0%o, %d, 0x%x, invalid)" char char char
))
529 (setq encoded
(and (>= char
128) (encode-coding-char char coding
)))
532 (format "(0%o, %d, 0x%x, file %s)"
534 (if (> (length encoded
) 1)
536 (encoded-string-description encoded coding
)))
537 (format "(0%o, %d, 0x%x)" char char char
))))
539 ;; We show the detailed information about CHAR.
540 (describe-char-after (point)))
541 (if (or (/= beg
1) (/= end
(1+ total
)))
542 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
544 (single-key-description char
)
545 (buffer-substring-no-properties (point) (1+ (point))))
546 encoding-msg pos total percent beg end col hscroll
)
547 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
549 (single-key-description char
)
550 (buffer-substring-no-properties (point) (1+ (point))))
551 encoding-msg pos total percent col hscroll
))))))
553 (defvar read-expression-map
554 (let ((m (make-sparse-keymap)))
555 (define-key m
"\M-\t" 'lisp-complete-symbol
)
556 (set-keymap-parent m minibuffer-local-map
)
558 "Minibuffer keymap used for reading Lisp expressions.")
560 (defvar read-expression-history nil
)
562 (defcustom eval-expression-print-level
4
563 "*Value to use for `print-level' when printing value in `eval-expression'."
568 (defcustom eval-expression-print-length
12
569 "*Value to use for `print-length' when printing value in `eval-expression'."
571 :type
'(choice (const nil
) integer
)
574 (defcustom eval-expression-debug-on-error t
575 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
576 If nil, don't change the value of `debug-on-error'."
581 ;; We define this, rather than making `eval' interactive,
582 ;; for the sake of completion of names like eval-region, eval-current-buffer.
583 (defun eval-expression (eval-expression-arg
584 &optional eval-expression-insert-value
)
585 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
586 Value is also consed on to front of the variable `values'.
587 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
588 insert the result into the current buffer instead of printing it in
591 (list (read-from-minibuffer "Eval: "
592 nil read-expression-map t
593 'read-expression-history
)
596 (if (null eval-expression-debug-on-error
)
597 (setq values
(cons (eval eval-expression-arg
) values
))
598 (let ((old-value (make-symbol "t")) new-value
)
599 ;; Bind debug-on-error to something unique so that we can
600 ;; detect when evaled code changes it.
601 (let ((debug-on-error old-value
))
602 (setq values
(cons (eval eval-expression-arg
) values
))
603 (setq new-value debug-on-error
))
604 ;; If evaled code has changed the value of debug-on-error,
605 ;; propagate that change to the global binding.
606 (unless (eq old-value new-value
)
607 (setq debug-on-error new-value
))))
609 (let ((print-length eval-expression-print-length
)
610 (print-level eval-expression-print-level
))
612 (if eval-expression-insert-value
(current-buffer) t
))))
614 (defun edit-and-eval-command (prompt command
)
615 "Prompting with PROMPT, let user edit COMMAND and eval result.
616 COMMAND is a Lisp expression. Let user edit that expression in
617 the minibuffer, then read and evaluate the result."
618 (let ((command (read-from-minibuffer prompt
619 (prin1-to-string command
)
620 read-expression-map t
621 '(command-history .
1))))
622 ;; If command was added to command-history as a string,
623 ;; get rid of that. We want only evaluable expressions there.
624 (if (stringp (car command-history
))
625 (setq command-history
(cdr command-history
)))
627 ;; If command to be redone does not match front of history,
628 ;; add it to the history.
629 (or (equal command
(car command-history
))
630 (setq command-history
(cons command command-history
)))
633 (defun repeat-complex-command (arg)
634 "Edit and re-evaluate last complex command, or ARGth from last.
635 A complex command is one which used the minibuffer.
636 The command is placed in the minibuffer as a Lisp form for editing.
637 The result is executed, repeating the command as changed.
638 If the command has been changed or is not the most recent previous command
639 it is added to the front of the command history.
640 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
641 to get different commands to edit and resubmit."
643 (let ((elt (nth (1- arg
) command-history
))
648 (let ((print-level nil
)
649 (minibuffer-history-position arg
)
650 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
651 (read-from-minibuffer
652 "Redo: " (prin1-to-string elt
) read-expression-map t
653 (cons 'command-history arg
))))
655 ;; If command was added to command-history as a string,
656 ;; get rid of that. We want only evaluable expressions there.
657 (if (stringp (car command-history
))
658 (setq command-history
(cdr command-history
)))
660 ;; If command to be redone does not match front of history,
661 ;; add it to the history.
662 (or (equal newcmd
(car command-history
))
663 (setq command-history
(cons newcmd command-history
)))
667 (defvar minibuffer-history nil
668 "Default minibuffer history list.
669 This is used for all minibuffer input
670 except when an alternate history list is specified.")
671 (defvar minibuffer-history-sexp-flag nil
672 "Non-nil when doing history operations on `command-history'.
673 More generally, indicates that the history list being acted on
674 contains expressions rather than strings.
675 It is only valid if its value equals the current minibuffer depth,
676 to handle recursive uses of the minibuffer.")
677 (setq minibuffer-history-variable
'minibuffer-history
)
678 (setq minibuffer-history-position nil
)
679 (defvar minibuffer-history-search-history nil
)
682 (lambda (key-and-command)
684 (lambda (keymap-and-completionp)
685 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
686 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
687 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
688 (define-key (symbol-value (car keymap-and-completionp
))
689 (car key-and-command
)
690 (let ((command (cdr key-and-command
)))
692 ;; (and ... nil) => ... turns back on the completion-oriented
693 ;; history commands which rms turned off since they seem to
694 ;; do things he doesn't like.
695 (if (and (cdr keymap-and-completionp
) nil
) ;XXX turned off
696 (progn (error "EMACS BUG!") (cdr command
))
699 '((minibuffer-local-map . nil
)
700 (minibuffer-local-ns-map . nil
)
701 (minibuffer-local-completion-map . t
)
702 (minibuffer-local-must-match-map . t
)
703 (read-expression-map . nil
))))
704 '(("\en" .
(next-history-element . next-complete-history-element
))
705 ([next] . (next-history-element . next-complete-history-element))
706 ("\ep" . (previous-history-element . previous-complete-history-element))
707 ([prior] . (previous-history-element . previous-complete-history-element))
708 ("\er" . previous-matching-history-element)
709 ("\es" . next-matching-history-element)))
711 (defvar minibuffer-text-before-history nil
712 "Text that was in this minibuffer before any history commands.
713 This is nil if there have not yet been any history commands
714 in this use of the minibuffer.")
716 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
718 (defun minibuffer-history-initialize ()
719 (setq minibuffer-text-before-history nil))
721 (defun minibuffer-avoid-prompt (new old)
722 "A point-motion hook for the minibuffer, that moves point out of the prompt."
723 (constrain-to-field nil (point-max)))
725 (defcustom minibuffer-history-case-insensitive-variables nil
726 "*Minibuffer history variables for which matching should ignore case.
727 If a history variable is a member of this list, then the
728 \\[previous-matching-history-element] and \\[next-matching-history-element]\
729 commands ignore case when searching it, regardless of `case-fold-search'."
730 :type '(repeat variable)
733 (defun previous-matching-history-element (regexp n)
734 "Find the previous history element that matches REGEXP.
735 \(Previous history elements refer to earlier actions.)
736 With prefix argument N, search for Nth previous match.
737 If N is negative, find the next or Nth next match.
738 Normally, history elements are matched case-insensitively if
739 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
740 makes the search case-sensitive.
741 See also `minibuffer-history-case-insensitive-variables'."
743 (let* ((enable-recursive-minibuffers t)
744 (regexp (read-from-minibuffer "Previous element matching (regexp): "
748 'minibuffer-history-search-history)))
749 ;; Use the last regexp specified, by default, if input is empty.
750 (list (if (string= regexp "")
751 (if minibuffer-history-search-history
752 (car minibuffer-history-search-history)
753 (error "No previous history search regexp"))
755 (prefix-numeric-value current-prefix-arg))))
757 (if (and (zerop minibuffer-history-position)
758 (null minibuffer-text-before-history))
759 (setq minibuffer-text-before-history (field-string (point-max))))
760 (let ((history (symbol-value minibuffer-history-variable))
762 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
763 ;; On some systems, ignore case for file names.
764 (if (memq minibuffer-history-variable
765 minibuffer-history-case-insensitive-variables)
767 ;; Respect the user's setting for case-fold-search:
773 (pos minibuffer-history-position))
776 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
777 (when (= pos prevpos)
779 "No later matching history item"
780 "No earlier matching history item")))
782 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
783 (let ((print-level nil))
784 (prin1-to-string (nth (1- pos) history)))
785 (nth (1- pos) history)))
788 (and (string-match regexp match-string)
790 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
791 (match-beginning 1))))
793 (setq n (+ n (if (< n 0) 1 -1)))))
794 (setq minibuffer-history-position pos)
795 (goto-char (point-max))
797 (insert match-string)
798 (goto-char (+ (field-beginning) match-offset))))
799 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
800 (eq (car (car command-history)) 'next-matching-history-element))
801 (setq command-history (cdr command-history))))
803 (defun next-matching-history-element (regexp n)
804 "Find the next history element that matches REGEXP.
805 \(The next history element refers to a more recent action.)
806 With prefix argument N, search for Nth next match.
807 If N is negative, find the previous or Nth previous match.
808 Normally, history elements are matched case-insensitively if
809 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
810 makes the search case-sensitive."
812 (let* ((enable-recursive-minibuffers t)
813 (regexp (read-from-minibuffer "Next element matching (regexp): "
817 'minibuffer-history-search-history)))
818 ;; Use the last regexp specified, by default, if input is empty.
819 (list (if (string= regexp "")
820 (setcar minibuffer-history-search-history
821 (nth 1 minibuffer-history-search-history))
823 (prefix-numeric-value current-prefix-arg))))
824 (previous-matching-history-element regexp (- n)))
826 (defvar minibuffer-temporary-goal-position nil)
828 (defun next-history-element (n)
829 "Insert the next element of the minibuffer history into the minibuffer."
832 (let ((narg (- minibuffer-history-position n))
833 (minimum (if minibuffer-default -1 0))
834 elt minibuffer-returned-to-present)
835 (if (and (zerop minibuffer-history-position)
836 (null minibuffer-text-before-history))
837 (setq minibuffer-text-before-history (field-string (point-max))))
839 (if minibuffer-default
840 (error "End of history; no next item")
841 (error "End of history; no default available")))
842 (if (> narg (length (symbol-value minibuffer-history-variable)))
843 (error "Beginning of history; no preceding item"))
844 (unless (or (eq last-command 'next-history-element)
845 (eq last-command 'previous-history-element))
846 (let ((prompt-end (field-beginning (point-max))))
847 (set (make-local-variable 'minibuffer-temporary-goal-position)
848 (cond ((<= (point) prompt-end) prompt-end)
851 (goto-char (point-max))
853 (setq minibuffer-history-position narg)
855 (setq elt minibuffer-default))
857 (setq elt (or minibuffer-text-before-history ""))
858 (setq minibuffer-returned-to-present t)
859 (setq minibuffer-text-before-history nil))
860 (t (setq elt (nth (1- minibuffer-history-position)
861 (symbol-value minibuffer-history-variable)))))
863 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
864 (not minibuffer-returned-to-present))
865 (let ((print-level nil))
866 (prin1-to-string elt))
868 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
870 (defun previous-history-element (n)
871 "Inserts the previous element of the minibuffer history into the minibuffer."
873 (next-history-element (- n)))
875 (defun next-complete-history-element (n)
876 "Get next history element which completes the minibuffer before the point.
877 The contents of the minibuffer after the point are deleted, and replaced
878 by the new completion."
880 (let ((point-at-start (point)))
881 (next-matching-history-element
883 "^" (regexp-quote (buffer-substring (field-beginning) (point))))
885 ;; next-matching-history-element always puts us at (point-min).
886 ;; Move to the position we were at before changing the buffer contents.
887 ;; This is still sensical, because the text before point has not changed.
888 (goto-char point-at-start)))
890 (defun previous-complete-history-element (n)
892 Get previous history element which completes the minibuffer before the point.
893 The contents of the minibuffer after the point are deleted, and replaced
894 by the new completion."
896 (next-complete-history-element (- n)))
898 ;; These two functions are for compatibility with the old subrs of the
901 (defun minibuffer-prompt-width ()
902 "Return the display width of the minibuffer prompt.
903 Return 0 if current buffer is not a mini-buffer."
904 ;; Return the width of everything before the field at the end of
905 ;; the buffer; this should be 0 for normal buffers.
906 (1- (field-beginning (point-max))))
908 (defun minibuffer-prompt-end ()
909 "Return the buffer position of the end of the minibuffer prompt.
910 Return (point-min) if current buffer is not a mini-buffer."
911 (field-beginning (point-max)))
913 (defun minibuffer-contents ()
914 "Return the user input in a minbuffer as a string.
915 The current buffer must be a minibuffer."
916 (field-string (point-max)))
918 (defun minibuffer-contents-no-properties ()
919 "Return the user input in a minbuffer as a string, without text-properties.
920 The current buffer must be a minibuffer."
921 (field-string-no-properties (point-max)))
923 (defun delete-minibuffer-contents ()
924 "Delete all user input in a minibuffer.
925 The current buffer must be a minibuffer."
926 (delete-field (point-max)))
928 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
929 (defalias 'advertised-undo 'undo)
931 (defun undo (&optional arg)
932 "Undo some previous changes.
933 Repeat this command to undo more changes.
934 A numeric argument serves as a repeat count.
936 In Transient Mark mode when the mark is active, only undo changes within
937 the current region. Similarly, when not in Transient Mark mode, just C-u
938 as an argument limits undo to changes within the current region."
940 ;; If we don't get all the way thru, make last-command indicate that
941 ;; for the following command.
942 (setq this-command t)
943 (let ((modified (buffer-modified-p))
944 (recent-save (recent-auto-save-p)))
945 (or (eq (selected-window) (minibuffer-window))
947 (unless (eq last-command 'undo)
948 (if (if transient-mark-mode mark-active (and arg (not (numberp arg))))
949 (undo-start (region-beginning) (region-end))
951 ;; get rid of initial undo boundary
954 (if (or transient-mark-mode (numberp arg))
955 (prefix-numeric-value arg)
957 ;; Don't specify a position in the undo record for the undo command.
958 ;; Instead, undoing this should move point to where the change is.
959 (let ((tail buffer-undo-list)
961 (while (and tail (not done) (not (null (car tail))))
962 (if (integerp (car tail))
965 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
966 (setq tail (cdr tail))))
967 (and modified (not (buffer-modified-p))
968 (delete-auto-save-file-if-necessary recent-save)))
969 ;; If we do get all the way thru, make this-command indicate that.
970 (setq this-command 'undo))
972 (defvar pending-undo-list nil
973 "Within a run of consecutive undo commands, list remaining to be undone.")
975 (defvar undo-in-progress nil
976 "Non-nil while performing an undo.
977 Some change-hooks test this variable to do something different.")
979 (defun undo-more (count)
980 "Undo back N undo-boundaries beyond what was already undone recently.
981 Call `undo-start' to get ready to undo recent changes,
982 then call `undo-more' one or more times to undo them."
983 (or pending-undo-list
984 (error "No further undo information"))
985 (let ((undo-in-progress t))
986 (setq pending-undo-list (primitive-undo count pending-undo-list))))
988 ;; Deep copy of a list
989 (defun undo-copy-list (list)
990 "Make a copy of undo list LIST."
991 (mapcar 'undo-copy-list-1 list))
993 (defun undo-copy-list-1 (elt)
995 (cons (car elt) (undo-copy-list-1 (cdr elt)))
998 (defun undo-start (&optional beg end)
999 "Set `pending-undo-list' to the front of the undo list.
1000 The next call to `undo-more' will undo the most recently made change.
1001 If BEG and END are specified, then only undo elements
1002 that apply to text between BEG and END are used; other undo elements
1003 are ignored. If BEG and END are nil, all undo elements are used."
1004 (if (eq buffer-undo-list t)
1005 (error "No undo information in this buffer"))
1006 (setq pending-undo-list
1007 (if (and beg end (not (= beg end)))
1008 (undo-make-selective-list (min beg end) (max beg end))
1011 (defvar undo-adjusted-markers)
1013 (defun undo-make-selective-list (start end)
1014 "Return a list of undo elements for the region START to END.
1015 The elements come from `buffer-undo-list', but we keep only
1016 the elements inside this region, and discard those outside this region.
1017 If we find an element that crosses an edge of this region,
1018 we stop and ignore all further elements."
1019 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1020 (undo-list (list nil))
1021 undo-adjusted-markers
1023 undo-elt undo-elt temp-undo-list delta)
1024 (while undo-list-copy
1025 (setq undo-elt (car undo-list-copy))
1027 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1028 ;; This is a "was unmodified" element.
1029 ;; Keep it if we have kept everything thus far.
1030 (not some-rejected))
1032 (undo-elt-in-region undo-elt start end)))))
1035 (setq end (+ end (cdr (undo-delta undo-elt))))
1036 ;; Don't put two nils together in the list
1037 (if (not (and (eq (car undo-list) nil)
1039 (setq undo-list (cons undo-elt undo-list))))
1040 (if (undo-elt-crosses-region undo-elt start end)
1041 (setq undo-list-copy nil)
1042 (setq some-rejected t)
1043 (setq temp-undo-list (cdr undo-list-copy))
1044 (setq delta (undo-delta undo-elt))
1046 (when (/= (cdr delta) 0)
1047 (let ((position (car delta))
1048 (offset (cdr delta)))
1050 ;; Loop down the earlier events adjusting their buffer positions
1051 ;; to reflect the fact that a change to the buffer isn't being
1052 ;; undone. We only need to process those element types which
1053 ;; undo-elt-in-region will return as being in the region since
1054 ;; only those types can ever get into the output
1056 (while temp-undo-list
1057 (setq undo-elt (car temp-undo-list))
1058 (cond ((integerp undo-elt)
1059 (if (>= undo-elt position)
1060 (setcar temp-undo-list (- undo-elt offset))))
1061 ((atom undo-elt) nil)
1062 ((stringp (car undo-elt))
1063 ;; (TEXT . POSITION)
1064 (let ((text-pos (abs (cdr undo-elt)))
1065 (point-at-end (< (cdr undo-elt) 0 )))
1066 (if (>= text-pos position)
1067 (setcdr undo-elt (* (if point-at-end -1 1)
1068 (- text-pos offset))))))
1069 ((integerp (car undo-elt))
1071 (when (>= (car undo-elt) position)
1072 (setcar undo-elt (- (car undo-elt) offset))
1073 (setcdr undo-elt (- (cdr undo-elt) offset))))
1074 ((null (car undo-elt))
1075 ;; (nil PROPERTY VALUE BEG . END)
1076 (let ((tail (nthcdr 3 undo-elt)))
1077 (when (>= (car tail) position)
1078 (setcar tail (- (car tail) offset))
1079 (setcdr tail (- (cdr tail) offset))))))
1080 (setq temp-undo-list (cdr temp-undo-list))))))))
1081 (setq undo-list-copy (cdr undo-list-copy)))
1082 (nreverse undo-list)))
1084 (defun undo-elt-in-region (undo-elt start end)
1085 "Determine whether UNDO-ELT falls inside the region START ... END.
1086 If it crosses the edge, we return nil."
1087 (cond ((integerp undo-elt)
1088 (and (>= undo-elt start)
1094 ((stringp (car undo-elt))
1095 ;; (TEXT . POSITION)
1096 (and (>= (abs (cdr undo-elt)) start)
1097 (< (abs (cdr undo-elt)) end)))
1098 ((and (consp undo-elt) (markerp (car undo-elt)))
1099 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1100 ;; See if MARKER is inside the region.
1101 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1103 (setq alist-elt (cons (car undo-elt)
1104 (marker-position (car undo-elt))))
1105 (setq undo-adjusted-markers
1106 (cons alist-elt undo-adjusted-markers)))
1107 (and (cdr alist-elt)
1108 (>= (cdr alist-elt) start)
1109 (< (cdr alist-elt) end))))
1110 ((null (car undo-elt))
1111 ;; (nil PROPERTY VALUE BEG . END)
1112 (let ((tail (nthcdr 3 undo-elt)))
1113 (and (>= (car tail) start)
1114 (< (cdr tail) end))))
1115 ((integerp (car undo-elt))
1117 (and (>= (car undo-elt) start)
1118 (< (cdr undo-elt) end)))))
1120 (defun undo-elt-crosses-region (undo-elt start end)
1121 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1122 This assumes we have already decided that UNDO-ELT
1123 is not *inside* the region START...END."
1124 (cond ((atom undo-elt) nil)
1125 ((null (car undo-elt))
1126 ;; (nil PROPERTY VALUE BEG . END)
1127 (let ((tail (nthcdr 3 undo-elt)))
1128 (not (or (< (car tail) end)
1129 (> (cdr tail) start)))))
1130 ((integerp (car undo-elt))
1132 (not (or (< (car undo-elt) end)
1133 (> (cdr undo-elt) start))))))
1135 ;; Return the first affected buffer position and the delta for an undo element
1136 ;; delta is defined as the change in subsequent buffer positions if we *did*
1138 (defun undo-delta (undo-elt)
1139 (if (consp undo-elt)
1140 (cond ((stringp (car undo-elt))
1141 ;; (TEXT . POSITION)
1142 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1143 ((integerp (car undo-elt))
1145 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1150 (defvar shell-command-history nil
1151 "History list for some commands that read shell commands.")
1153 (defvar shell-command-switch "-c"
1154 "Switch used to have the shell execute its command line argument.")
1156 (defvar shell-command-default-error-buffer nil
1157 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1158 This buffer is used when `shell-command' or 'shell-command-on-region'
1159 is run interactively. A value of nil means that output to stderr and
1160 stdout will be intermixed in the output stream.")
1162 (defun shell-command (command &optional output-buffer error-buffer)
1163 "Execute string COMMAND in inferior shell; display output, if any.
1164 With prefix argument, insert the COMMAND's output at point.
1166 If COMMAND ends in ampersand, execute it asynchronously.
1167 The output appears in the buffer `*Async Shell Command*'.
1168 That buffer is in shell mode.
1170 Otherwise, COMMAND is executed synchronously. The output appears in
1171 the buffer `*Shell Command Output*'. If the output is short enough to
1172 display in the echo area (which is determined by the variables
1173 `resize-mini-windows' and `max-mini-window-height'), it is shown
1174 there, but it is nonetheless available in buffer `*Shell Command
1175 Output*' even though that buffer is not automatically displayed. If
1176 there is no output, or if output is inserted in the current buffer,
1177 then `*Shell Command Output*' is deleted.
1179 To specify a coding system for converting non-ASCII characters
1180 in the shell command output, use \\[universal-coding-system-argument]
1181 before this command.
1183 Noninteractive callers can specify coding systems by binding
1184 `coding-system-for-read' and `coding-system-for-write'.
1186 The optional second argument OUTPUT-BUFFER, if non-nil,
1187 says to put the output in some other buffer.
1188 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1189 If OUTPUT-BUFFER is not a buffer and not nil,
1190 insert output in current buffer. (This cannot be done asynchronously.)
1191 In either case, the output is inserted after point (leaving mark after it).
1193 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1194 or buffer name to which to direct the command's standard error output.
1195 If it is nil, error output is mingled with regular output.
1196 In an interactive call, the variable `shell-command-default-error-buffer'
1197 specifies the value of ERROR-BUFFER."
1199 (interactive (list (read-from-minibuffer "Shell command: "
1200 nil nil nil 'shell-command-history)
1202 shell-command-default-error-buffer))
1203 ;; Look for a handler in case default-directory is a remote file name.
1205 (find-file-name-handler (directory-file-name default-directory)
1208 (funcall handler 'shell-command command output-buffer error-buffer)
1209 (if (and output-buffer
1210 (not (or (bufferp output-buffer) (stringp output-buffer))))
1214 (expand-file-name "scor"
1215 (or small-temporary-file-directory
1216 temporary-file-directory)))
1218 (barf-if-buffer-read-only)
1220 ;; We do not use -f for csh; we will not support broken use of
1221 ;; .cshrcs. Even the BSD csh manual says to use
1222 ;; "if ($?prompt) exit" before things which are not useful
1223 ;; non-interactively. Besides, if someone wants their other
1224 ;; aliases for shell commands then they can still have them.
1225 (call-process shell-file-name nil
1229 nil shell-command-switch command)
1230 (when (and error-file (file-exists-p error-file))
1231 (if (< 0 (nth 7 (file-attributes error-file)))
1232 (with-current-buffer (get-buffer-create error-buffer)
1233 (let ((pos-from-end (- (point-max) (point))))
1236 ;; Do no formatting while reading error file,
1237 ;; because that can run a shell command, and we
1238 ;; don't want that to cause an infinite recursion.
1239 (format-insert-file error-file nil)
1240 ;; Put point after the inserted errors.
1241 (goto-char (- (point-max) pos-from-end)))
1242 (display-buffer (current-buffer))))
1243 (delete-file error-file))
1244 ;; This is like exchange-point-and-mark, but doesn't
1245 ;; activate the mark. It is cleaner to avoid activation,
1246 ;; even though the command loop would deactivate the mark
1247 ;; because we inserted text.
1248 (goto-char (prog1 (mark t)
1249 (set-marker (mark-marker) (point)
1250 (current-buffer)))))
1251 ;; Preserve the match data in case called from a program.
1253 (if (string-match "[ \t]*&[ \t]*$" command)
1254 ;; Command ending with ampersand means asynchronous.
1255 (let ((buffer (get-buffer-create
1256 (or output-buffer "*Async Shell Command*")))
1257 (directory default-directory)
1259 ;; Remove the ampersand.
1260 (setq command (substring command 0 (match-beginning 0)))
1261 ;; If will kill a process, query first.
1262 (setq proc (get-buffer-process buffer))
1264 (if (yes-or-no-p "A command is running. Kill it? ")
1266 (error "Shell command in progress")))
1269 (setq buffer-read-only nil)
1271 (display-buffer buffer)
1272 (setq default-directory directory)
1273 (setq proc (start-process "Shell" buffer shell-file-name
1274 shell-command-switch command))
1275 (setq mode-line-process '(":%s"))
1276 (require 'shell) (shell-mode)
1277 (set-process-sentinel proc 'shell-command-sentinel)
1279 (shell-command-on-region (point) (point) command
1280 output-buffer nil error-buffer)))))))
1282 (defun display-message-or-buffer (message
1283 &optional buffer-name not-this-window frame)
1284 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1285 MESSAGE may be either a string or a buffer.
1287 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1288 the maximum height of the echo area, as defined by `max-mini-window-height'
1289 if `resize-mini-windows' is non-nil.
1291 Returns either the string shown in the echo area, or when a pop-up
1292 buffer is used, the window used to display it.
1294 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1295 name of the buffer used to display it in the case where a pop-up buffer
1296 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1297 string and it is displayed in the echo area, it is not specified whether
1298 the contents are inserted into the buffer anyway.
1300 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1301 and only used if a buffer is displayed."
1302 (cond ((and (stringp message) (not (string-match "\n" message)))
1303 ;; Trivial case where we can use the echo area
1304 (message "%s" message))
1305 ((and (stringp message)
1306 (= (string-match "\n" message) (1- (length message))))
1307 ;; Trivial case where we can just remove single trailing newline
1308 (message "%s" (substring message 0 (1- (length message)))))
1311 (with-current-buffer
1312 (if (bufferp message)
1314 (get-buffer-create (or buffer-name "*Message*")))
1316 (unless (bufferp message)
1321 (if (= (buffer-size) 0)
1323 (count-lines (point-min) (point-max)))))
1324 (cond ((or (<= lines 1)
1326 (if resize-mini-windows
1327 (cond ((floatp max-mini-window-height)
1329 max-mini-window-height))
1330 ((integerp max-mini-window-height)
1331 max-mini-window-height)
1336 (goto-char (point-max))
1339 (message "%s" (buffer-substring (point-min) (point))))
1342 (goto-char (point-min))
1343 (display-buffer message not-this-window frame))))))))
1346 ;; We have a sentinel to prevent insertion of a termination message
1347 ;; in the buffer itself.
1348 (defun shell-command-sentinel (process signal)
1349 (if (memq (process-status process) '(exit signal))
1351 (car (cdr (cdr (process-command process))))
1352 (substring signal 0 -1))))
1354 (defun shell-command-on-region (start end command
1355 &optional output-buffer replace
1357 "Execute string COMMAND in inferior shell with region as input.
1358 Normally display output (if any) in temp buffer `*Shell Command Output*';
1359 Prefix arg means replace the region with it. Return the exit code of
1362 To specify a coding system for converting non-ASCII characters
1363 in the input and output to the shell command, use \\[universal-coding-system-argument]
1364 before this command. By default, the input (from the current buffer)
1365 is encoded in the same coding system that will be used to save the file,
1366 `buffer-file-coding-system'. If the output is going to replace the region,
1367 then it is decoded from that same coding system.
1369 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1370 REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1371 systems by binding `coding-system-for-read' and
1372 `coding-system-for-write'.
1374 If the output is short enough to display in the echo area (which is
1375 determined by the variable `max-mini-window-height' if
1376 `resize-mini-windows' is non-nil), it is shown there, but it is
1377 nonetheless available in buffer `*Shell Command Output*' even though
1378 that buffer is not automatically displayed. If there is no output, or
1379 if output is inserted in the current buffer, then `*Shell Command
1380 Output*' is deleted.
1382 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1383 that says to put the output in some other buffer.
1384 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1385 If OUTPUT-BUFFER is not a buffer and not nil,
1386 insert output in the current buffer.
1387 In either case, the output is inserted after point (leaving mark after it).
1389 If REPLACE, the optional fifth argument, is non-nil, that means insert
1390 the output in place of text from START to END, putting point and mark
1393 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1394 or buffer name to which to direct the command's standard error output.
1395 If it is nil, error output is mingled with regular output.
1396 In an interactive call, the variable `shell-command-default-error-buffer'
1397 specifies the value of ERROR-BUFFER."
1398 (interactive (let ((string
1399 ;; Do this before calling region-beginning
1400 ;; and region-end, in case subprocess output
1401 ;; relocates them while we are in the minibuffer.
1402 (read-from-minibuffer "Shell command on region: "
1404 'shell-command-history)))
1405 ;; call-interactively recognizes region-beginning and
1406 ;; region-end specially, leaving them in the history.
1407 (list (region-beginning) (region-end)
1411 shell-command-default-error-buffer)))
1415 (expand-file-name "scor"
1416 (or small-temporary-file-directory
1417 temporary-file-directory)))
1422 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1423 ;; Replace specified region with output from command.
1424 (let ((swap (and replace (< start end))))
1425 ;; Don't muck with mark unless REPLACE says we should.
1427 (and replace (push-mark))
1429 (call-process-region start end shell-file-name t
1433 nil shell-command-switch command))
1434 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1435 (and shell-buffer (not (eq shell-buffer (current-buffer)))
1436 (kill-buffer shell-buffer)))
1437 ;; Don't muck with mark unless REPLACE says we should.
1438 (and replace swap (exchange-point-and-mark)))
1439 ;; No prefix argument: put the output in a temp buffer,
1440 ;; replacing its entire contents.
1441 (let ((buffer (get-buffer-create
1442 (or output-buffer "*Shell Command Output*")))
1445 (if (eq buffer (current-buffer))
1446 ;; If the input is the same buffer as the output,
1447 ;; delete everything but the specified region,
1448 ;; then replace that region with the output.
1449 (progn (setq buffer-read-only nil)
1450 (delete-region (max start end) (point-max))
1451 (delete-region (point-min) (min start end))
1453 (call-process-region (point-min) (point-max)
1458 nil shell-command-switch
1460 ;; Clear the output buffer, then run the command with
1462 (let ((directory default-directory))
1465 (setq buffer-read-only nil)
1466 (if (not output-buffer)
1467 (setq default-directory directory))
1470 (call-process-region start end shell-file-name nil
1472 (list buffer error-file)
1474 nil shell-command-switch command)))
1475 (setq success (and exit-status (equal 0 exit-status)))
1476 ;; Report the amount of output.
1477 (if (with-current-buffer buffer (> (point-max) (point-min)))
1478 ;; There's some output, display it
1479 (display-message-or-buffer buffer)
1480 ;; No output; error?
1481 (message (if (and error-file
1482 (< 0 (nth 7 (file-attributes error-file))))
1483 "(Shell command %sed with some error output)"
1484 "(Shell command %sed with no output)")
1485 (if (equal 0 exit-status) "succeed" "fail"))
1486 (kill-buffer buffer)))))
1488 (when (and error-file (file-exists-p error-file))
1489 (if (< 0 (nth 7 (file-attributes error-file)))
1490 (with-current-buffer (get-buffer-create error-buffer)
1491 (let ((pos-from-end (- (point-max) (point))))
1494 ;; Do no formatting while reading error file,
1495 ;; because that can run a shell command, and we
1496 ;; don't want that to cause an infinite recursion.
1497 (format-insert-file error-file nil)
1498 ;; Put point after the inserted errors.
1499 (goto-char (- (point-max) pos-from-end)))
1500 (display-buffer (current-buffer))))
1501 (delete-file error-file))
1504 (defun shell-command-to-string (command)
1505 "Execute shell command COMMAND and return its output as a string."
1506 (with-output-to-string
1507 (with-current-buffer
1509 (call-process shell-file-name nil t nil shell-command-switch command))))
1511 (defvar universal-argument-map
1512 (let ((map (make-sparse-keymap)))
1513 (define-key map [t] 'universal-argument-other-key)
1514 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1515 (define-key map [switch-frame] nil)
1516 (define-key map [?\C-u] 'universal-argument-more)
1517 (define-key map [?-] 'universal-argument-minus)
1518 (define-key map [?0] 'digit-argument)
1519 (define-key map [?1] 'digit-argument)
1520 (define-key map [?2] 'digit-argument)
1521 (define-key map [?3] 'digit-argument)
1522 (define-key map [?4] 'digit-argument)
1523 (define-key map [?5] 'digit-argument)
1524 (define-key map [?6] 'digit-argument)
1525 (define-key map [?7] 'digit-argument)
1526 (define-key map [?8] 'digit-argument)
1527 (define-key map [?9] 'digit-argument)
1528 (define-key map [kp-0] 'digit-argument)
1529 (define-key map [kp-1] 'digit-argument)
1530 (define-key map [kp-2] 'digit-argument)
1531 (define-key map [kp-3] 'digit-argument)
1532 (define-key map [kp-4] 'digit-argument)
1533 (define-key map [kp-5] 'digit-argument)
1534 (define-key map [kp-6] 'digit-argument)
1535 (define-key map [kp-7] 'digit-argument)
1536 (define-key map [kp-8] 'digit-argument)
1537 (define-key map [kp-9] 'digit-argument)
1538 (define-key map [kp-subtract] 'universal-argument-minus)
1540 "Keymap used while processing \\[universal-argument].")
1542 (defvar universal-argument-num-events nil
1543 "Number of argument-specifying events read by `universal-argument'.
1544 `universal-argument-other-key' uses this to discard those events
1545 from (this-command-keys), and reread only the final command.")
1547 (defun universal-argument ()
1548 "Begin a numeric argument for the following command.
1549 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1550 \\[universal-argument] following the digits or minus sign ends the argument.
1551 \\[universal-argument] without digits or minus sign provides 4 as argument.
1552 Repeating \\[universal-argument] without digits or minus sign
1553 multiplies the argument by 4 each time.
1554 For some commands, just \\[universal-argument] by itself serves as a flag
1555 which is different in effect from any particular numeric argument.
1556 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1558 (setq prefix-arg (list 4))
1559 (setq universal-argument-num-events (length (this-command-keys)))
1560 (setq overriding-terminal-local-map universal-argument-map))
1562 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1563 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1564 (defun universal-argument-more (arg)
1567 (setq prefix-arg (list (* 4 (car arg))))
1569 (setq prefix-arg (list -4))
1570 (setq prefix-arg arg)
1571 (setq overriding-terminal-local-map nil)))
1572 (setq universal-argument-num-events (length (this-command-keys))))
1574 (defun negative-argument (arg)
1575 "Begin a negative numeric argument for the next command.
1576 \\[universal-argument] following digits or minus sign ends the argument."
1578 (cond ((integerp arg)
1579 (setq prefix-arg (- arg)))
1581 (setq prefix-arg nil))
1583 (setq prefix-arg '-)))
1584 (setq universal-argument-num-events (length (this-command-keys)))
1585 (setq overriding-terminal-local-map universal-argument-map))
1587 (defun digit-argument (arg)
1588 "Part of the numeric argument for the next command.
1589 \\[universal-argument] following digits or minus sign ends the argument."
1591 (let* ((char (if (integerp last-command-char)
1593 (get last-command-char 'ascii-character)))
1594 (digit (- (logand char ?\177) ?0)))
1595 (cond ((integerp arg)
1596 (setq prefix-arg (+ (* arg 10)
1597 (if (< arg 0) (- digit) digit))))
1599 ;; Treat -0 as just -, so that -01 will work.
1600 (setq prefix-arg (if (zerop digit) '- (- digit))))
1602 (setq prefix-arg digit))))
1603 (setq universal-argument-num-events (length (this-command-keys)))
1604 (setq overriding-terminal-local-map universal-argument-map))
1606 ;; For backward compatibility, minus with no modifiers is an ordinary
1607 ;; command if digits have already been entered.
1608 (defun universal-argument-minus (arg)
1611 (universal-argument-other-key arg)
1612 (negative-argument arg)))
1614 ;; Anything else terminates the argument and is left in the queue to be
1615 ;; executed as a command.
1616 (defun universal-argument-other-key (arg)
1618 (setq prefix-arg arg)
1619 (let* ((key (this-command-keys))
1620 (keylist (listify-key-sequence key)))
1621 (setq unread-command-events
1622 (append (nthcdr universal-argument-num-events keylist)
1623 unread-command-events)))
1624 (reset-this-command-lengths)
1625 (setq overriding-terminal-local-map nil))
1627 ;;;; Window system cut and paste hooks.
1629 (defvar interprogram-cut-function nil
1630 "Function to call to make a killed region available to other programs.
1632 Most window systems provide some sort of facility for cutting and
1633 pasting text between the windows of different programs.
1634 This variable holds a function that Emacs calls whenever text
1635 is put in the kill ring, to make the new kill available to other
1638 The function takes one or two arguments.
1639 The first argument, TEXT, is a string containing
1640 the text which should be made available.
1641 The second, PUSH, if non-nil means this is a \"new\" kill;
1642 nil means appending to an \"old\" kill.")
1644 (defvar interprogram-paste-function nil
1645 "Function to call to get text cut from other programs.
1647 Most window systems provide some sort of facility for cutting and
1648 pasting text between the windows of different programs.
1649 This variable holds a function that Emacs calls to obtain
1650 text that other programs have provided for pasting.
1652 The function should be called with no arguments. If the function
1653 returns nil, then no other program has provided such text, and the top
1654 of the Emacs kill ring should be used. If the function returns a
1655 string, that string should be put in the kill ring as the latest kill.
1657 Note that the function should return a string only if a program other
1658 than Emacs has provided a string for pasting; if Emacs provided the
1659 most recent string, the function should return nil. If it is
1660 difficult to tell whether Emacs or some other program provided the
1661 current string, it is probably good enough to return nil if the string
1662 is equal (according to `string=') to the last text Emacs provided.")
1666 ;;;; The kill ring data structure.
1668 (defvar kill-ring nil
1669 "List of killed text sequences.
1670 Since the kill ring is supposed to interact nicely with cut-and-paste
1671 facilities offered by window systems, use of this variable should
1672 interact nicely with `interprogram-cut-function' and
1673 `interprogram-paste-function'. The functions `kill-new',
1674 `kill-append', and `current-kill' are supposed to implement this
1675 interaction; you may want to use them instead of manipulating the kill
1678 (defcustom kill-ring-max 60
1679 "*Maximum length of kill ring before oldest elements are thrown away."
1683 (defvar kill-ring-yank-pointer nil
1684 "The tail of the kill ring whose car is the last thing yanked.")
1686 (defun kill-new (string &optional replace)
1687 "Make STRING the latest kill in the kill ring.
1688 Set the kill-ring-yank pointer to point to it.
1689 If `interprogram-cut-function' is non-nil, apply it to STRING.
1690 Optional second argument REPLACE non-nil means that STRING will replace
1691 the front of the kill ring, rather than being added to the list."
1692 (and (fboundp 'menu-bar-update-yank-menu)
1693 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1694 (if (and replace kill-ring)
1695 (setcar kill-ring string)
1696 (setq kill-ring (cons string kill-ring))
1697 (if (> (length kill-ring) kill-ring-max)
1698 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1699 (setq kill-ring-yank-pointer kill-ring)
1700 (if interprogram-cut-function
1701 (funcall interprogram-cut-function string (not replace))))
1703 (defun kill-append (string before-p)
1704 "Append STRING to the end of the latest kill in the kill ring.
1705 If BEFORE-P is non-nil, prepend STRING to the kill.
1706 If `interprogram-cut-function' is set, pass the resulting kill to
1708 (kill-new (if before-p
1709 (concat string (car kill-ring))
1710 (concat (car kill-ring) string)) t))
1712 (defun current-kill (n &optional do-not-move)
1713 "Rotate the yanking point by N places, and then return that kill.
1714 If N is zero, `interprogram-paste-function' is set, and calling it
1715 returns a string, then that string is added to the front of the
1716 kill ring and returned as the latest kill.
1717 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1718 yanking point; just return the Nth kill forward."
1719 (let ((interprogram-paste (and (= n 0)
1720 interprogram-paste-function
1721 (funcall interprogram-paste-function))))
1722 (if interprogram-paste
1724 ;; Disable the interprogram cut function when we add the new
1725 ;; text to the kill ring, so Emacs doesn't try to own the
1726 ;; selection, with identical text.
1727 (let ((interprogram-cut-function nil))
1728 (kill-new interprogram-paste))
1730 (or kill-ring (error "Kill ring is empty"))
1731 (let ((ARGth-kill-element
1732 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1736 (setq kill-ring-yank-pointer ARGth-kill-element))
1737 (car ARGth-kill-element)))))
1741 ;;;; Commands for manipulating the kill ring.
1743 (defcustom kill-read-only-ok nil
1744 "*Non-nil means don't signal an error for killing read-only text."
1748 (put 'text-read-only 'error-conditions
1749 '(text-read-only buffer-read-only error))
1750 (put 'text-read-only 'error-message "Text is read-only")
1752 (defun kill-region (beg end)
1753 "Kill between point and mark.
1754 The text is deleted but saved in the kill ring.
1755 The command \\[yank] can retrieve it from there.
1756 \(If you want to kill and then yank immediately, use \\[kill-ring-save].)
1758 If you want to append the killed region to the last killed text,
1759 use \\[append-next-kill] before \\[kill-region].
1761 If the buffer is read-only, Emacs will beep and refrain from deleting
1762 the text, but put the text in the kill ring anyway. This means that
1763 you can use the killing commands to copy text from a read-only buffer.
1765 This is the primitive for programs to kill text (as opposed to deleting it).
1766 Supply two arguments, character numbers indicating the stretch of text
1768 Any command that calls this function is a \"kill command\".
1769 If the previous command was also a kill command,
1770 the text killed this time appends to the text killed last time
1771 to make one entry in the kill ring."
1774 (let ((string (delete-and-extract-region beg end)))
1775 (when string ;STRING is nil if BEG = END
1776 ;; Add that string to the kill ring, one way or another.
1777 (if (eq last-command 'kill-region)
1778 (kill-append string (< end beg))
1780 (setq this-command 'kill-region))
1781 ((buffer-read-only text-read-only)
1782 ;; The code above failed because the buffer, or some of the characters
1783 ;; in the region, are read-only.
1784 ;; We should beep, in case the user just isn't aware of this.
1785 ;; However, there's no harm in putting
1786 ;; the region's text in the kill ring, anyway.
1787 (copy-region-as-kill beg end)
1788 ;; Set this-command now, so it will be set even if we get an error.
1789 (setq this-command 'kill-region)
1790 ;; This should barf, if appropriate, and give us the correct error.
1791 (if kill-read-only-ok
1792 (message "Read only text copied to kill ring")
1793 ;; Signal an error if the buffer is read-only.
1794 (barf-if-buffer-read-only)
1795 ;; If the buffer isn't read-only, the text is.
1796 (signal 'text-read-only (list (current-buffer)))))))
1798 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1799 ;; to get two copies of the text when the user accidentally types M-w and
1800 ;; then corrects it with the intended C-w.
1801 (defun copy-region-as-kill (beg end)
1802 "Save the region as if killed, but don't kill it.
1803 In Transient Mark mode, deactivate the mark.
1804 If `interprogram-cut-function' is non-nil, also save the text for a window
1805 system cut and paste."
1807 (if (eq last-command 'kill-region)
1808 (kill-append (buffer-substring beg end) (< end beg))
1809 (kill-new (buffer-substring beg end)))
1810 (if transient-mark-mode
1811 (setq deactivate-mark t))
1814 (defun kill-ring-save (beg end)
1815 "Save the region as if killed, but don't kill it.
1816 In Transient Mark mode, deactivate the mark.
1817 If `interprogram-cut-function' is non-nil, also save the text for a window
1818 system cut and paste.
1820 If you want to append the killed line to the last killed text,
1821 use \\[append-next-kill] before \\[kill-ring-save].
1823 This command is similar to `copy-region-as-kill', except that it gives
1824 visual feedback indicating the extent of the region being copied."
1826 (copy-region-as-kill beg end)
1828 (let ((other-end (if (= (point) beg) end beg))
1830 ;; Inhibit quitting so we can make a quit here
1831 ;; look like a C-g typed as a command.
1833 (if (pos-visible-in-window-p other-end (selected-window))
1835 ;; Swap point and mark.
1836 (set-marker (mark-marker) (point) (current-buffer))
1837 (goto-char other-end)
1840 (set-marker (mark-marker) other-end (current-buffer))
1842 ;; If user quit, deactivate the mark
1843 ;; as C-g would as a command.
1844 (and quit-flag mark-active
1846 (let* ((killed-text (current-kill 0))
1847 (message-len (min (length killed-text) 40)))
1849 ;; Don't say "killed"; that is misleading.
1850 (message "Saved text until \"%s\""
1851 (substring killed-text (- message-len)))
1852 (message "Saved text from \"%s\""
1853 (substring killed-text 0 message-len))))))))
1855 (defun append-next-kill (&optional interactive)
1856 "Cause following command, if it kills, to append to previous kill.
1857 The argument is used for internal purposes; do not supply one."
1859 ;; We don't use (interactive-p), since that breaks kbd macros.
1862 (setq this-command 'kill-region)
1863 (message "If the next command is a kill, it will append"))
1864 (setq last-command 'kill-region)))
1868 (defun yank-pop (arg)
1869 "Replace just-yanked stretch of killed text with a different stretch.
1870 This command is allowed only immediately after a `yank' or a `yank-pop'.
1871 At such a time, the region contains a stretch of reinserted
1872 previously-killed text. `yank-pop' deletes that text and inserts in its
1873 place a different stretch of killed text.
1875 With no argument, the previous kill is inserted.
1876 With argument N, insert the Nth previous kill.
1877 If N is negative, this is a more recent kill.
1879 The sequence of kills wraps around, so that after the oldest one
1880 comes the newest one."
1882 (if (not (eq last-command 'yank))
1883 (error "Previous command was not a yank"))
1884 (setq this-command 'yank)
1885 (let ((inhibit-read-only t)
1886 (before (< (point) (mark t))))
1887 (delete-region (point) (mark t))
1888 (set-marker (mark-marker) (point) (current-buffer))
1889 (let ((opoint (point)))
1890 (insert (current-kill arg))
1891 (let ((inhibit-read-only t))
1892 (remove-text-properties opoint (point) '(read-only nil))))
1894 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1895 ;; It is cleaner to avoid activation, even though the command
1896 ;; loop would deactivate the mark because we inserted text.
1897 (goto-char (prog1 (mark t)
1898 (set-marker (mark-marker) (point) (current-buffer))))))
1901 (defun yank (&optional arg)
1902 "Reinsert the last stretch of killed text.
1903 More precisely, reinsert the stretch of killed text most recently
1904 killed OR yanked. Put point at end, and set mark at beginning.
1905 With just C-u as argument, same but put point at beginning (and mark at end).
1906 With argument N, reinsert the Nth most recently killed stretch of killed
1908 See also the command \\[yank-pop]."
1910 ;; If we don't get all the way thru, make last-command indicate that
1911 ;; for the following command.
1912 (setq this-command t)
1914 (let ((opoint (point)))
1915 (insert (current-kill (cond
1919 (let ((inhibit-read-only t))
1920 (remove-text-properties opoint (point) '(read-only nil))))
1922 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1923 ;; It is cleaner to avoid activation, even though the command
1924 ;; loop would deactivate the mark because we inserted text.
1925 (goto-char (prog1 (mark t)
1926 (set-marker (mark-marker) (point) (current-buffer)))))
1927 ;; If we do get all the way thru, make this-command indicate that.
1928 (setq this-command 'yank)
1931 (defun rotate-yank-pointer (arg)
1932 "Rotate the yanking point in the kill ring.
1933 With argument, rotate that many kills forward (or backward, if negative)."
1937 ;; Some kill commands.
1939 ;; Internal subroutine of delete-char
1940 (defun kill-forward-chars (arg)
1941 (if (listp arg) (setq arg (car arg)))
1942 (if (eq arg '-) (setq arg -1))
1943 (kill-region (point) (forward-point arg)))
1945 ;; Internal subroutine of backward-delete-char
1946 (defun kill-backward-chars (arg)
1947 (if (listp arg) (setq arg (car arg)))
1948 (if (eq arg '-) (setq arg -1))
1949 (kill-region (point) (forward-point (- arg))))
1951 (defcustom backward-delete-char-untabify-method 'untabify
1952 "*The method for untabifying when deleting backward.
1953 Can be `untabify' -- turn a tab to many spaces, then delete one space;
1954 `hungry' -- delete all whitespace, both tabs and spaces;
1955 `all' -- delete all whitespace, including tabs, spaces and newlines;
1956 nil -- just delete one character."
1957 :type '(choice (const untabify) (const hungry) (const all) (const nil))
1961 (defun backward-delete-char-untabify (arg &optional killp)
1962 "Delete characters backward, changing tabs into spaces.
1963 The exact behavior depends on `backward-delete-char-untabify-method'.
1964 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
1965 Interactively, ARG is the prefix arg (default 1)
1966 and KILLP is t if a prefix arg was specified."
1967 (interactive "*p\nP")
1968 (when (eq backward-delete-char-untabify-method 'untabify)
1971 (while (and (> count 0) (not (bobp)))
1972 (if (= (preceding-char) ?\t)
1973 (let ((col (current-column)))
1975 (setq col (- col (current-column)))
1976 (insert-char ?\ col)
1979 (setq count (1- count))))))
1980 (delete-backward-char
1981 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1982 ((eq backward-delete-char-untabify-method 'all)
1985 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
1987 (+ arg (if (zerop wh) 0 (1- wh))))
1991 (defun zap-to-char (arg char)
1992 "Kill up to and including ARG'th occurrence of CHAR.
1993 Case is ignored if `case-fold-search' is non-nil in the current buffer.
1994 Goes backward if ARG is negative; error if CHAR not found."
1995 (interactive "p\ncZap to char: ")
1996 (kill-region (point) (progn
1997 (search-forward (char-to-string char) nil nil arg)
1998 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2001 ;; kill-line and its subroutines.
2003 (defcustom kill-whole-line nil
2004 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2008 (defun kill-line (&optional arg)
2009 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2010 With prefix argument, kill that many lines from point.
2011 Negative arguments kill lines backward.
2012 With zero argument, kills the text before point on the current line.
2014 When calling from a program, nil means \"no arg\",
2015 a number counts as a prefix arg.
2017 To kill a whole line, when point is not at the beginning, type \
2018 \\[beginning-of-line] \\[kill-line] \\[kill-line].
2020 If `kill-whole-line' is non-nil, then this command kills the whole line
2021 including its terminating newline, when used at the beginning of a line
2022 with no argument. As a consequence, you can always kill a whole line
2023 by typing \\[beginning-of-line] \\[kill-line].
2025 If you want to append the killed line to the last killed text,
2026 use \\[append-next-kill] before \\[kill-line].
2028 If the buffer is read-only, Emacs will beep and refrain from deleting
2029 the line, but put the line in the kill ring anyway. This means that
2030 you can use this command to copy text from a read-only buffer."
2032 (kill-region (point)
2033 ;; It is better to move point to the other end of the kill
2034 ;; before killing. That way, in a read-only buffer, point
2035 ;; moves across the text that is copied to the kill ring.
2036 ;; The choice has no effect on undo now that undo records
2037 ;; the value of point from before the command was run.
2040 (forward-visible-line (prefix-numeric-value arg))
2042 (signal 'end-of-buffer nil))
2043 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
2044 (forward-visible-line 1)
2045 (end-of-visible-line)))
2048 (defun forward-visible-line (arg)
2049 "Move forward by ARG lines, ignoring currently invisible newlines only.
2050 If ARG is negative, move backward -ARG lines.
2051 If ARG is zero, move to the beginning of the current line."
2055 (or (zerop (forward-line 1))
2056 (signal 'end-of-buffer nil))
2057 ;; If the following character is currently invisible,
2058 ;; skip all characters with that same `invisible' property value,
2059 ;; then find the next newline.
2060 (while (and (not (eobp))
2062 (get-char-property (point) 'invisible)))
2063 (if (eq buffer-invisibility-spec t)
2065 (or (memq prop buffer-invisibility-spec)
2066 (assq prop buffer-invisibility-spec)))))
2068 (if (get-text-property (point) 'invisible)
2069 (or (next-single-property-change (point) 'invisible)
2071 (next-overlay-change (point))))
2072 (or (zerop (forward-line 1))
2073 (signal 'end-of-buffer nil)))
2074 (setq arg (1- arg)))
2076 (while (or first (< arg 0))
2079 (or (zerop (forward-line -1))
2080 (signal 'beginning-of-buffer nil)))
2081 (while (and (not (bobp))
2083 (get-char-property (1- (point)) 'invisible)))
2084 (if (eq buffer-invisibility-spec t)
2086 (or (memq prop buffer-invisibility-spec)
2087 (assq prop buffer-invisibility-spec)))))
2089 (if (get-text-property (1- (point)) 'invisible)
2090 (or (previous-single-property-change (point) 'invisible)
2092 (previous-overlay-change (point))))
2093 (or (zerop (forward-line -1))
2094 (signal 'beginning-of-buffer nil)))
2096 (setq arg (1+ arg)))))
2097 ((beginning-of-buffer end-of-buffer)
2100 (defun end-of-visible-line ()
2101 "Move to end of current visible line."
2103 ;; If the following character is currently invisible,
2104 ;; skip all characters with that same `invisible' property value,
2105 ;; then find the next newline.
2106 (while (and (not (eobp))
2108 (get-char-property (point) 'invisible)))
2109 (if (eq buffer-invisibility-spec t)
2111 (or (memq prop buffer-invisibility-spec)
2112 (assq prop buffer-invisibility-spec)))))
2113 (if (get-text-property (point) 'invisible)
2114 (goto-char (next-single-property-change (point) 'invisible))
2115 (goto-char (next-overlay-change (point))))
2118 (defun insert-buffer (buffer)
2119 "Insert after point the contents of BUFFER.
2120 Puts mark after the inserted text.
2121 BUFFER may be a buffer or a buffer name.
2123 This function is meant for the user to run interactively.
2124 Don't call it from programs!"
2128 (barf-if-buffer-read-only)
2129 (read-buffer "Insert buffer: "
2130 (if (eq (selected-window) (next-window (selected-window)))
2131 (other-buffer (current-buffer))
2132 (window-buffer (next-window (selected-window))))
2134 (or (bufferp buffer)
2135 (setq buffer (get-buffer buffer)))
2136 (let (start end newmark)
2140 (setq start (point-min) end (point-max)))
2141 (insert-buffer-substring buffer start end)
2142 (setq newmark (point)))
2143 (push-mark newmark))
2146 (defun append-to-buffer (buffer start end)
2147 "Append to specified buffer the text of the region.
2148 It is inserted into that buffer before its point.
2150 When calling from a program, give three arguments:
2151 BUFFER (or buffer name), START and END.
2152 START and END specify the portion of the current buffer to be copied."
2154 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2155 (region-beginning) (region-end)))
2156 (let ((oldbuf (current-buffer)))
2158 (let* ((append-to (get-buffer-create buffer))
2159 (windows (get-buffer-window-list append-to t t))
2161 (set-buffer append-to)
2162 (setq point (point))
2163 (barf-if-buffer-read-only)
2164 (insert-buffer-substring oldbuf start end)
2165 (dolist (window windows)
2166 (when (= (window-point window) point)
2167 (set-window-point window (point))))))))
2169 (defun prepend-to-buffer (buffer start end)
2170 "Prepend to specified buffer the text of the region.
2171 It is inserted into that buffer after its point.
2173 When calling from a program, give three arguments:
2174 BUFFER (or buffer name), START and END.
2175 START and END specify the portion of the current buffer to be copied."
2176 (interactive "BPrepend to buffer: \nr")
2177 (let ((oldbuf (current-buffer)))
2179 (set-buffer (get-buffer-create buffer))
2180 (barf-if-buffer-read-only)
2182 (insert-buffer-substring oldbuf start end)))))
2184 (defun copy-to-buffer (buffer start end)
2185 "Copy to specified buffer the text of the region.
2186 It is inserted into that buffer, replacing existing text there.
2188 When calling from a program, give three arguments:
2189 BUFFER (or buffer name), START and END.
2190 START and END specify the portion of the current buffer to be copied."
2191 (interactive "BCopy to buffer: \nr")
2192 (let ((oldbuf (current-buffer)))
2194 (set-buffer (get-buffer-create buffer))
2195 (barf-if-buffer-read-only)
2198 (insert-buffer-substring oldbuf start end)))))
2200 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2201 (put 'mark-inactive 'error-message "The mark is not active now")
2203 (defun mark (&optional force)
2204 "Return this buffer's mark value as integer; error if mark inactive.
2205 If optional argument FORCE is non-nil, access the mark value
2206 even if the mark is not currently active, and return nil
2207 if there is no mark at all.
2209 If you are using this in an editing command, you are most likely making
2210 a mistake; see the documentation of `set-mark'."
2211 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2212 (marker-position (mark-marker))
2213 (signal 'mark-inactive nil)))
2215 ;; Many places set mark-active directly, and several of them failed to also
2216 ;; run deactivate-mark-hook. This shorthand should simplify.
2217 (defsubst deactivate-mark ()
2218 "Deactivate the mark by setting `mark-active' to nil.
2219 \(That makes a difference only in Transient Mark mode.)
2220 Also runs the hook `deactivate-mark-hook'."
2221 (if transient-mark-mode
2223 (setq mark-active nil)
2224 (run-hooks 'deactivate-mark-hook))))
2226 (defun set-mark (pos)
2227 "Set this buffer's mark to POS. Don't use this function!
2228 That is to say, don't use this function unless you want
2229 the user to see that the mark has moved, and you want the previous
2230 mark position to be lost.
2232 Normally, when a new mark is set, the old one should go on the stack.
2233 This is why most applications should use push-mark, not set-mark.
2235 Novice Emacs Lisp programmers often try to use the mark for the wrong
2236 purposes. The mark saves a location for the user's convenience.
2237 Most editing commands should not alter the mark.
2238 To remember a location for internal use in the Lisp program,
2239 store it in a Lisp variable. Example:
2241 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2245 (setq mark-active t)
2246 (run-hooks 'activate-mark-hook)
2247 (set-marker (mark-marker) pos (current-buffer)))
2248 ;; Normally we never clear mark-active except in Transient Mark mode.
2249 ;; But when we actually clear out the mark value too,
2250 ;; we must clear mark-active in any mode.
2251 (setq mark-active nil)
2252 (run-hooks 'deactivate-mark-hook)
2253 (set-marker (mark-marker) nil)))
2255 (defvar mark-ring nil
2256 "The list of former marks of the current buffer, most recent first.")
2257 (make-variable-buffer-local 'mark-ring)
2258 (put 'mark-ring 'permanent-local t)
2260 (defcustom mark-ring-max 16
2261 "*Maximum size of mark ring. Start discarding off end if gets this big."
2263 :group 'editing-basics)
2265 (defvar global-mark-ring nil
2266 "The list of saved global marks, most recent first.")
2268 (defcustom global-mark-ring-max 16
2269 "*Maximum size of global mark ring. \
2270 Start discarding off end if gets this big."
2272 :group 'editing-basics)
2274 (defun set-mark-command (arg)
2275 "Set mark at where point is, or jump to mark.
2276 With no prefix argument, set mark, push old mark position on local mark
2277 ring, and push mark on global mark ring.
2278 With argument, jump to mark, and pop a new position for mark off the ring
2279 \(does not affect global mark ring\).
2281 Novice Emacs Lisp programmers often try to use the mark for the wrong
2282 purposes. See the documentation of `set-mark' for more information."
2286 (push-mark nil nil t))
2288 (error "No mark set in this buffer")
2289 (goto-char (mark t))
2292 (defun push-mark (&optional location nomsg activate)
2293 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
2294 If the last global mark pushed was not in the current buffer,
2295 also push LOCATION on the global mark ring.
2296 Display `Mark set' unless the optional second arg NOMSG is non-nil.
2297 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2299 Novice Emacs Lisp programmers often try to use the mark for the wrong
2300 purposes. See the documentation of `set-mark' for more information.
2302 In Transient Mark mode, this does not activate the mark."
2305 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2306 (if (> (length mark-ring) mark-ring-max)
2308 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2309 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
2310 (set-marker (mark-marker) (or location (point)) (current-buffer))
2311 ;; Now push the mark on the global mark ring.
2312 (if (and global-mark-ring
2313 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
2314 ;; The last global mark pushed was in this same buffer.
2315 ;; Don't push another one.
2317 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
2318 (if (> (length global-mark-ring) global-mark-ring-max)
2320 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2322 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2323 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2324 (message "Mark set"))
2325 (if (or activate (not transient-mark-mode))
2326 (set-mark (mark t)))
2330 "Pop off mark ring into the buffer's actual mark.
2331 Does not set point. Does nothing if mark ring is empty."
2334 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
2335 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
2337 (move-marker (car mark-ring) nil)
2338 (if (null (mark t)) (ding))
2339 (setq mark-ring (cdr mark-ring)))))
2341 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2342 (defun exchange-point-and-mark ()
2343 "Put the mark where point is now, and point where the mark is now.
2344 This command works even when the mark is not active,
2345 and it reactivates the mark."
2347 (let ((omark (mark t)))
2349 (error "No mark set in this buffer"))
2354 (defun transient-mark-mode (arg)
2355 "Toggle Transient Mark mode.
2356 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
2358 In Transient Mark mode, when the mark is active, the region is highlighted.
2359 Changing the buffer \"deactivates\" the mark.
2360 So do certain other operations that set the mark
2361 but whose main purpose is something else--for example,
2362 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
2364 You can also deactivate the mark by typing \\[keyboard-quit] or
2365 \\[keyboard-escape-quit].
2367 Many commands change their behavior when Transient Mark mode is in effect
2368 and the mark is active, by acting on the region instead of their usual
2369 default part of the buffer's text. Examples of such commands include
2370 \\[comment-dwim], \\[flush-lines], \\[ispell], \\[keep-lines],
2371 \\[query-replace], \\[query-replace-regexp], and \\[undo]. Invoke
2372 \\[apropos-documentation] and type \"transient\" or \"mark.*active\" at
2373 the prompt, to see the documentation of commands which are sensitive to
2374 the Transient Mark mode."
2376 (setq transient-mark-mode
2378 (not transient-mark-mode)
2379 (> (prefix-numeric-value arg) 0)))
2381 (if transient-mark-mode
2382 (message "Transient Mark mode enabled")
2383 (message "Transient Mark mode disabled"))))
2385 (defun pop-global-mark ()
2386 "Pop off global mark ring and jump to the top location."
2388 ;; Pop entries which refer to non-existent buffers.
2389 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2390 (setq global-mark-ring (cdr global-mark-ring)))
2391 (or global-mark-ring
2392 (error "No global mark set"))
2393 (let* ((marker (car global-mark-ring))
2394 (buffer (marker-buffer marker))
2395 (position (marker-position marker)))
2396 (setq global-mark-ring (nconc (cdr global-mark-ring)
2397 (list (car global-mark-ring))))
2399 (or (and (>= position (point-min))
2400 (<= position (point-max)))
2402 (goto-char position)
2403 (switch-to-buffer buffer)))
2405 (defcustom next-line-add-newlines nil
2406 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2409 :group 'editing-basics)
2411 (defun next-line (arg)
2412 "Move cursor vertically down ARG lines.
2413 If there is no character in the target line exactly under the current column,
2414 the cursor is positioned after the character in that line which spans this
2415 column, or at the end of the line if it is not long enough.
2416 If there is no line in the buffer after this one, behavior depends on the
2417 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2418 to create a line, and moves the cursor to that line. Otherwise it moves the
2419 cursor to the end of the buffer.
2421 The command \\[set-goal-column] can be used to create
2422 a semipermanent goal column for this command.
2423 Then instead of trying to move exactly vertically (or as close as possible),
2424 this command moves to the specified goal column (or as close as possible).
2425 The goal column is stored in the variable `goal-column', which is nil
2426 when there is no goal column.
2428 If you are thinking of using this in a Lisp program, consider
2429 using `forward-line' instead. It is usually easier to use
2430 and more reliable (no dependence on goal column, etc.)."
2432 (if (and next-line-add-newlines (= arg 1))
2433 (if (save-excursion (end-of-line) (eobp))
2434 ;; When adding a newline, don't expand an abbrev.
2435 (let ((abbrev-mode nil))
2442 ((beginning-of-buffer end-of-buffer) (ding)))
2446 (defun previous-line (arg)
2447 "Move cursor vertically up ARG lines.
2448 If there is no character in the target line exactly over the current column,
2449 the cursor is positioned after the character in that line which spans this
2450 column, or at the end of the line if it is not long enough.
2452 The command \\[set-goal-column] can be used to create
2453 a semipermanent goal column for this command.
2454 Then instead of trying to move exactly vertically (or as close as possible),
2455 this command moves to the specified goal column (or as close as possible).
2456 The goal column is stored in the variable `goal-column', which is nil
2457 when there is no goal column.
2459 If you are thinking of using this in a Lisp program, consider using
2460 `forward-line' with a negative argument instead. It is usually easier
2461 to use and more reliable (no dependence on goal column, etc.)."
2466 ((beginning-of-buffer end-of-buffer) (ding)))
2467 (line-move (- arg)))
2470 (defcustom track-eol nil
2471 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2472 This means moving to the end of each line moved onto.
2473 The beginning of a blank line does not count as the end of a line."
2475 :group 'editing-basics)
2477 (defcustom goal-column nil
2478 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2479 :type '(choice integer
2480 (const :tag "None" nil))
2481 :group 'editing-basics)
2482 (make-variable-buffer-local 'goal-column)
2484 (defvar temporary-goal-column 0
2485 "Current goal column for vertical motion.
2486 It is the column where point was
2487 at the start of current run of vertical motion commands.
2488 When the `track-eol' feature is doing its job, the value is 9999.")
2490 (defcustom line-move-ignore-invisible nil
2491 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2492 Outline mode sets this."
2494 :group 'editing-basics)
2496 ;; This is the guts of next-line and previous-line.
2497 ;; Arg says how many lines to move.
2498 (defun line-move (arg)
2499 ;; Don't run any point-motion hooks, and disregard intangibility,
2500 ;; for intermediate positions.
2501 (let ((inhibit-point-motion-hooks t)
2503 new line-end line-beg)
2506 (if (not (or (eq last-command 'next-line)
2507 (eq last-command 'previous-line)))
2508 (setq temporary-goal-column
2509 (if (and track-eol (eolp)
2510 ;; Don't count beg of empty line as end of line
2511 ;; unless we just did explicit end-of-line.
2512 (or (not (bolp)) (eq last-command 'end-of-line)))
2515 (if (and (not (integerp selective-display))
2516 (not line-move-ignore-invisible))
2517 ;; Use just newline characters.
2519 (progn (if (> arg 1) (forward-line (1- arg)))
2520 ;; This way of moving forward ARG lines
2521 ;; verifies that we have a newline after the last one.
2522 ;; It doesn't get confused by intangible text.
2524 (zerop (forward-line 1)))
2525 (and (zerop (forward-line arg))
2527 (signal (if (< arg 0)
2528 'beginning-of-buffer
2531 ;; Move by arg lines, but ignore invisible ones.
2534 (and (zerop (vertical-motion 1))
2535 (signal 'end-of-buffer nil))
2536 ;; If the following character is currently invisible,
2537 ;; skip all characters with that same `invisible' property value.
2538 (while (and (not (eobp))
2540 (get-char-property (point) 'invisible)))
2541 (if (eq buffer-invisibility-spec t)
2543 (or (memq prop buffer-invisibility-spec)
2544 (assq prop buffer-invisibility-spec)))))
2545 (if (get-text-property (point) 'invisible)
2546 (goto-char (next-single-property-change (point) 'invisible))
2547 (goto-char (next-overlay-change (point)))))
2548 (setq arg (1- arg)))
2551 (and (zerop (vertical-motion -1))
2552 (signal 'beginning-of-buffer nil))
2553 (while (and (not (bobp))
2555 (get-char-property (1- (point)) 'invisible)))
2556 (if (eq buffer-invisibility-spec t)
2558 (or (memq prop buffer-invisibility-spec)
2559 (assq prop buffer-invisibility-spec)))))
2560 (if (get-text-property (1- (point)) 'invisible)
2561 (goto-char (previous-single-property-change (point) 'invisible))
2562 (goto-char (previous-overlay-change (point)))))
2563 (setq arg (1+ arg))))
2564 (let ((buffer-invisibility-spec nil))
2565 (move-to-column (or goal-column temporary-goal-column))))
2567 ;; If we are moving into some intangible text,
2568 ;; look for following text on the same line which isn't intangible
2570 (setq line-end (save-excursion (end-of-line) (point)))
2571 (setq line-beg (save-excursion (beginning-of-line) (point)))
2572 (let ((after (and (< new (point-max))
2573 (get-char-property new 'intangible)))
2574 (before (and (> new (point-min))
2575 (get-char-property (1- new) 'intangible))))
2576 (when (and before (eq before after)
2578 (goto-char (point-min))
2579 (let ((inhibit-point-motion-hooks nil))
2581 (if (<= new line-end)
2582 (setq new (point)))))
2583 ;; NEW is where we want to move to.
2584 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2585 ;; Move there in just one step, from our starting position,
2586 ;; with intangibility and point-motion hooks enabled this time.
2588 (setq inhibit-point-motion-hooks nil)
2589 (goto-char (constrain-to-field new opoint nil t
2590 'inhibit-line-move-field-capture))
2591 ;; If intangibility processing moved us to a different line,
2592 ;; readjust the horizontal position within the line we ended up at.
2593 (when (or (< (point) line-beg) (> (point) line-end))
2595 (setq inhibit-point-motion-hooks t)
2596 (setq line-end (save-excursion (end-of-line) (point)))
2598 (setq line-beg (point))
2599 (let ((buffer-invisibility-spec nil))
2600 (move-to-column (or goal-column temporary-goal-column)))
2601 (if (<= (point) line-end)
2603 (goto-char (point-min))
2604 (setq inhibit-point-motion-hooks nil)
2605 (goto-char (constrain-to-field new opoint nil t
2606 'inhibit-line-move-field-capture))
2610 ;;; Many people have said they rarely use this feature, and often type
2611 ;;; it by accident. Maybe it shouldn't even be on a key.
2612 (put 'set-goal-column 'disabled t)
2614 (defun set-goal-column (arg)
2615 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2616 Those commands will move to this position in the line moved to
2617 rather than trying to keep the same horizontal position.
2618 With a non-nil argument, clears out the goal column
2619 so that \\[next-line] and \\[previous-line] resume vertical motion.
2620 The goal column is stored in the variable `goal-column'."
2624 (setq goal-column nil)
2625 (message "No goal column"))
2626 (setq goal-column (current-column))
2627 (message (substitute-command-keys
2628 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2633 (defun scroll-other-window-down (lines)
2634 "Scroll the \"other window\" down.
2635 For more details, see the documentation for `scroll-other-window'."
2637 (scroll-other-window
2638 ;; Just invert the argument's meaning.
2639 ;; We can do that without knowing which window it will be.
2640 (if (eq lines '-) nil
2642 (- (prefix-numeric-value lines))))))
2643 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2645 (defun beginning-of-buffer-other-window (arg)
2646 "Move point to the beginning of the buffer in the other window.
2647 Leave mark at previous position.
2648 With arg N, put point N/10 of the way from the true beginning."
2650 (let ((orig-window (selected-window))
2651 (window (other-window-for-scrolling)))
2652 ;; We use unwind-protect rather than save-window-excursion
2653 ;; because the latter would preserve the things we want to change.
2656 (select-window window)
2657 ;; Set point and mark in that window's buffer.
2658 (beginning-of-buffer arg)
2659 ;; Set point accordingly.
2661 (select-window orig-window))))
2663 (defun end-of-buffer-other-window (arg)
2664 "Move point to the end of the buffer in the other window.
2665 Leave mark at previous position.
2666 With arg N, put point N/10 of the way from the true end."
2668 ;; See beginning-of-buffer-other-window for comments.
2669 (let ((orig-window (selected-window))
2670 (window (other-window-for-scrolling)))
2673 (select-window window)
2676 (select-window orig-window))))
2678 (defun transpose-chars (arg)
2679 "Interchange characters around point, moving forward one character.
2680 With prefix arg ARG, effect is to take character before point
2681 and drag it forward past ARG other characters (backward if ARG negative).
2682 If no argument and at end of line, the previous two chars are exchanged."
2684 (and (null arg) (eolp) (forward-char -1))
2685 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2687 (defun transpose-words (arg)
2688 "Interchange words around point, leaving point at end of them.
2689 With prefix arg ARG, effect is to take word before or around point
2690 and drag it forward past ARG other words (backward if ARG negative).
2691 If ARG is zero, the words around or after point and around or after mark
2694 (transpose-subr 'forward-word arg))
2696 (defun transpose-sexps (arg)
2697 "Like \\[transpose-words] but applies to sexps.
2698 Does not work on a sexp that point is in the middle of
2699 if it is a list or string."
2701 (transpose-subr 'forward-sexp arg))
2703 (defun transpose-lines (arg)
2704 "Exchange current line and previous line, leaving point after both.
2705 With argument ARG, takes previous line and moves it past ARG lines.
2706 With argument 0, interchanges line point is in with line mark is in."
2708 (transpose-subr (function
2712 ;; Move forward over ARG lines,
2713 ;; but create newlines if necessary.
2714 (setq arg (forward-line arg))
2715 (if (/= (preceding-char) ?\n)
2716 (setq arg (1+ arg)))
2719 (forward-line arg))))
2722 (defvar transpose-subr-start1)
2723 (defvar transpose-subr-start2)
2724 (defvar transpose-subr-end1)
2725 (defvar transpose-subr-end2)
2727 (defun transpose-subr (mover arg)
2728 (let (transpose-subr-start1
2730 transpose-subr-start2
2731 transpose-subr-end2)
2736 (setq transpose-subr-end2 (point))
2738 (setq transpose-subr-start2 (point))
2741 (setq transpose-subr-end1 (point))
2743 (setq transpose-subr-start1 (point))
2745 (exchange-point-and-mark))
2749 (setq transpose-subr-start1 (point))
2751 (setq transpose-subr-end1 (point))
2753 (setq transpose-subr-end2 (point))
2754 (funcall mover (- arg))
2755 (setq transpose-subr-start2 (point))
2757 (goto-char transpose-subr-end2))
2759 (setq transpose-subr-start2 (point))
2761 (setq transpose-subr-end2 (point))
2762 (funcall mover (1- arg))
2763 (setq transpose-subr-start1 (point))
2764 (funcall mover (- arg))
2765 (setq transpose-subr-end1 (point))
2766 (transpose-subr-1)))))
2768 (defun transpose-subr-1 ()
2769 (if (> (min transpose-subr-end1 transpose-subr-end2)
2770 (max transpose-subr-start1 transpose-subr-start2))
2771 (error "Don't have two things to transpose"))
2772 (let* ((word1 (buffer-substring transpose-subr-start1 transpose-subr-end1))
2773 (len1 (length word1))
2774 (word2 (buffer-substring transpose-subr-start2 transpose-subr-end2))
2775 (len2 (length word2)))
2776 (delete-region transpose-subr-start2 transpose-subr-end2)
2777 (goto-char transpose-subr-start2)
2779 (goto-char (if (< transpose-subr-start1 transpose-subr-start2)
2780 transpose-subr-start1
2781 (+ transpose-subr-start1 (- len1 len2))))
2782 (delete-region (point) (+ (point) len1))
2785 (defun backward-word (arg)
2786 "Move backward until encountering the end of a word.
2787 With argument, do this that many times."
2789 (forward-word (- arg)))
2791 (defun mark-word (arg)
2792 "Set mark arg words away from point."
2800 (defun kill-word (arg)
2801 "Kill characters forward until encountering the end of a word.
2802 With argument, do this that many times."
2804 (kill-region (point) (progn (forward-word arg) (point))))
2806 (defun backward-kill-word (arg)
2807 "Kill characters backward until encountering the end of a word.
2808 With argument, do this that many times."
2810 (kill-word (- arg)))
2812 (defun current-word (&optional strict)
2813 "Return the word point is on (or a nearby word) as a string.
2814 If optional arg STRICT is non-nil, return nil unless point is within
2815 or adjacent to a word."
2817 (let ((oldpoint (point)) (start (point)) (end (point)))
2818 (skip-syntax-backward "w_") (setq start (point))
2819 (goto-char oldpoint)
2820 (skip-syntax-forward "w_") (setq end (point))
2821 (if (and (eq start oldpoint) (eq end oldpoint))
2822 ;; Point is neither within nor adjacent to a word.
2825 ;; Look for preceding word in same line.
2826 (skip-syntax-backward "^w_"
2827 (save-excursion (beginning-of-line)
2830 ;; No preceding word in same line.
2831 ;; Look for following word in same line.
2833 (skip-syntax-forward "^w_"
2834 (save-excursion (end-of-line)
2836 (setq start (point))
2837 (skip-syntax-forward "w_")
2840 (skip-syntax-backward "w_")
2841 (setq start (point)))
2842 (buffer-substring-no-properties start end)))
2843 (buffer-substring-no-properties start end)))))
2845 (defcustom fill-prefix nil
2846 "*String for filling to insert at front of new line, or nil for none.
2847 Setting this variable automatically makes it local to the current buffer."
2848 :type '(choice (const :tag "None" nil)
2851 (make-variable-buffer-local 'fill-prefix)
2853 (defcustom auto-fill-inhibit-regexp nil
2854 "*Regexp to match lines which should not be auto-filled."
2855 :type '(choice (const :tag "None" nil)
2859 (defvar comment-line-break-function 'comment-indent-new-line
2860 "*Mode-specific function which line breaks and continues a comment.
2862 This function is only called during auto-filling of a comment section.
2863 The function should take a single optional argument, which is a flag
2864 indicating whether it should use soft newlines.
2866 Setting this variable automatically makes it local to the current buffer.")
2868 ;; This function is used as the auto-fill-function of a buffer
2869 ;; when Auto-Fill mode is enabled.
2870 ;; It returns t if it really did any work.
2871 ;; (Actually some major modes use a different auto-fill function,
2872 ;; but this one is the default one.)
2873 (defun do-auto-fill ()
2874 (let (fc justify bol give-up
2875 (fill-prefix fill-prefix))
2876 (if (or (not (setq justify (current-justification)))
2877 (null (setq fc (current-fill-column)))
2878 (and (eq justify 'left)
2879 (<= (current-column) fc))
2880 (save-excursion (beginning-of-line)
2882 (and auto-fill-inhibit-regexp
2883 (looking-at auto-fill-inhibit-regexp))))
2884 nil ;; Auto-filling not required
2885 (if (memq justify '(full center right))
2886 (save-excursion (unjustify-current-line)))
2888 ;; Choose a fill-prefix automatically.
2889 (if (and adaptive-fill-mode
2890 (or (null fill-prefix) (string= fill-prefix "")))
2892 (fill-context-prefix
2893 (save-excursion (backward-paragraph 1) (point))
2894 (save-excursion (forward-paragraph 1) (point)))))
2895 (and prefix (not (equal prefix ""))
2896 (setq fill-prefix prefix))))
2898 (while (and (not give-up) (> (current-column) fc))
2899 ;; Determine where to split the line.
2902 (let ((opoint (point))
2907 (setq after-prefix (point))
2909 (looking-at (regexp-quote fill-prefix))
2910 (setq after-prefix (match-end 0)))
2911 (move-to-column (1+ fc))
2912 ;; Move back to the point where we can break the line.
2913 ;; We break the line between word or
2914 ;; after/before the character which has character
2915 ;; category `|'. We search space, \c| followed by
2916 ;; a character, or \c| following a character. If
2917 ;; not found, place the point at beginning of line.
2919 ;; If this is after period and a single space,
2920 ;; move back once more--we don't want to break
2921 ;; the line there and make it look like a
2925 sentence-end-double-space
2926 (save-excursion (forward-char -1)
2927 (and (looking-at "\\. ")
2928 (not (looking-at "\\. ")))))
2931 fill-nobreak-predicate
2932 (funcall fill-nobreak-predicate)))
2934 (re-search-backward "[ \t]\\|\\c|.\\|.\\c|\\|^")
2935 ;; If we find nowhere on the line to break it,
2936 ;; break after one word. Set bounce to t
2937 ;; so we will not keep going in this while loop.
2938 (if (<= (point) after-prefix)
2940 (goto-char after-prefix)
2941 (re-search-forward "[ \t]" opoint t)
2943 (if (looking-at "[ \t]")
2944 ;; Break the line at word boundary.
2945 (skip-chars-backward " \t")
2946 ;; Break the line after/before \c|.
2948 (if enable-multibyte-characters
2949 ;; If we are going to break the line after or
2950 ;; before a non-ascii character, we may have
2951 ;; to run a special function for the charset
2952 ;; of the character to find the correct break
2954 (if (not (and (eq (charset-after (1- (point))) 'ascii)
2955 (eq (charset-after (point)) 'ascii)))
2956 (fill-find-break-point after-prefix)))
2958 ;; Let fill-point be set to the place where we end up.
2959 ;; But move back before any whitespace here.
2960 (skip-chars-backward " \t")
2963 ;; See whether the place we found is any good.
2965 (goto-char fill-point)
2967 ;; There is no use breaking at end of line.
2968 (not (save-excursion (skip-chars-forward " ") (eolp)))
2969 ;; It is futile to split at the end of the prefix
2970 ;; since we would just insert the prefix again.
2971 (not (and after-prefix (<= (point) after-prefix)))
2972 ;; Don't split right after a comment starter
2973 ;; since we would just make another comment starter.
2974 (not (and comment-start-skip
2975 (let ((limit (point)))
2977 (and (re-search-forward comment-start-skip
2979 (eq (point) limit)))))))
2980 ;; Ok, we have a useful place to break the line. Do it.
2981 (let ((prev-column (current-column)))
2982 ;; If point is at the fill-point, do not `save-excursion'.
2983 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2984 ;; point will end up before it rather than after it.
2986 (skip-chars-backward " \t")
2987 (= (point) fill-point))
2988 (funcall comment-line-break-function t)
2990 (goto-char fill-point)
2991 (funcall comment-line-break-function t)))
2992 ;; Now do justification, if required
2993 (if (not (eq justify 'left))
2996 (justify-current-line justify nil t)))
2997 ;; If making the new line didn't reduce the hpos of
2998 ;; the end of the line, then give up now;
2999 ;; trying again will not help.
3000 (if (>= (current-column) prev-column)
3002 ;; No good place to break => stop trying.
3004 ;; Justify last line.
3005 (justify-current-line justify t t)
3008 (defvar normal-auto-fill-function 'do-auto-fill
3009 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3010 Some major modes set this.")
3012 (defun auto-fill-mode (&optional arg)
3013 "Toggle Auto Fill mode.
3014 With arg, turn Auto Fill mode on if and only if arg is positive.
3015 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
3016 automatically breaks the line at a previous space.
3018 The value of `normal-auto-fill-function' specifies the function to use
3019 for `auto-fill-function' when turning Auto Fill mode on."
3021 (prog1 (setq auto-fill-function
3023 (not auto-fill-function)
3024 (> (prefix-numeric-value arg) 0))
3025 normal-auto-fill-function
3027 (force-mode-line-update)))
3029 ;; This holds a document string used to document auto-fill-mode.
3030 (defun auto-fill-function ()
3031 "Automatically break line at a previous space, in insertion of text."
3034 (defun turn-on-auto-fill ()
3035 "Unconditionally turn on Auto Fill mode."
3038 (defun turn-off-auto-fill ()
3039 "Unconditionally turn off Auto Fill mode."
3040 (auto-fill-mode -1))
3042 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
3044 (defun set-fill-column (arg)
3045 "Set `fill-column' to specified argument.
3046 Use \\[universal-argument] followed by a number to specify a column.
3047 Just \\[universal-argument] as argument means to use the current column."
3050 (setq arg (current-column)))
3051 (if (not (integerp arg))
3052 ;; Disallow missing argument; it's probably a typo for C-x C-f.
3053 (error "set-fill-column requires an explicit argument")
3054 (message "Fill column set to %d (was %d)" arg fill-column)
3055 (setq fill-column arg)))
3057 (defun set-selective-display (arg)
3058 "Set `selective-display' to ARG; clear it if no arg.
3059 When the value of `selective-display' is a number > 0,
3060 lines whose indentation is >= that value are not displayed.
3061 The variable `selective-display' has a separate value for each buffer."
3063 (if (eq selective-display t)
3064 (error "selective-display already in use for marked lines"))
3067 (narrow-to-region (point-min) (point))
3068 (goto-char (window-start))
3069 (vertical-motion (window-height)))))
3070 (setq selective-display
3071 (and arg (prefix-numeric-value arg)))
3072 (recenter current-vpos))
3073 (set-window-start (selected-window) (window-start (selected-window)))
3074 (princ "selective-display set to " t)
3075 (prin1 selective-display t)
3078 (defvar overwrite-mode-textual " Ovwrt"
3079 "The string displayed in the mode line when in overwrite mode.")
3080 (defvar overwrite-mode-binary " Bin Ovwrt"
3081 "The string displayed in the mode line when in binary overwrite mode.")
3083 (defun overwrite-mode (arg)
3084 "Toggle overwrite mode.
3085 With arg, turn overwrite mode on iff arg is positive.
3086 In overwrite mode, printing characters typed in replace existing text
3087 on a one-for-one basis, rather than pushing it to the right. At the
3088 end of a line, such characters extend the line. Before a tab,
3089 such characters insert until the tab is filled in.
3090 \\[quoted-insert] still inserts characters in overwrite mode; this
3091 is supposed to make it easier to insert characters when necessary."
3093 (setq overwrite-mode
3094 (if (if (null arg) (not overwrite-mode)
3095 (> (prefix-numeric-value arg) 0))
3096 'overwrite-mode-textual))
3097 (force-mode-line-update))
3099 (defun binary-overwrite-mode (arg)
3100 "Toggle binary overwrite mode.
3101 With arg, turn binary overwrite mode on iff arg is positive.
3102 In binary overwrite mode, printing characters typed in replace
3103 existing text. Newlines are not treated specially, so typing at the
3104 end of a line joins the line to the next, with the typed character
3105 between them. Typing before a tab character simply replaces the tab
3106 with the character typed.
3107 \\[quoted-insert] replaces the text at the cursor, just as ordinary
3108 typing characters do.
3110 Note that binary overwrite mode is not its own minor mode; it is a
3111 specialization of overwrite-mode, entered by setting the
3112 `overwrite-mode' variable to `overwrite-mode-binary'."
3114 (setq overwrite-mode
3116 (not (eq overwrite-mode 'overwrite-mode-binary))
3117 (> (prefix-numeric-value arg) 0))
3118 'overwrite-mode-binary))
3119 (force-mode-line-update))
3121 (defcustom line-number-mode t
3122 "*Non-nil means display line number in mode line."
3124 :group 'editing-basics)
3126 (defun line-number-mode (arg)
3127 "Toggle Line Number mode.
3128 With arg, turn Line Number mode on iff arg is positive.
3129 When Line Number mode is enabled, the line number appears
3132 Line numbers do not appear for very large buffers, see variable
3133 `line-number-display-limit'."
3135 (setq line-number-mode
3136 (if (null arg) (not line-number-mode)
3137 (> (prefix-numeric-value arg) 0)))
3138 (force-mode-line-update))
3140 (defcustom column-number-mode nil
3141 "*Non-nil means display column number in mode line."
3143 :group 'editing-basics)
3145 (defun column-number-mode (arg)
3146 "Toggle Column Number mode.
3147 With arg, turn Column Number mode on iff arg is positive.
3148 When Column Number mode is enabled, the column number appears
3151 (setq column-number-mode
3152 (if (null arg) (not column-number-mode)
3153 (> (prefix-numeric-value arg) 0)))
3154 (force-mode-line-update))
3156 (defgroup paren-blinking nil
3157 "Blinking matching of parens and expressions."
3158 :prefix "blink-matching-"
3159 :group 'paren-matching)
3161 (defcustom blink-matching-paren t
3162 "*Non-nil means show matching open-paren when close-paren is inserted."
3164 :group 'paren-blinking)
3166 (defcustom blink-matching-paren-on-screen t
3167 "*Non-nil means show matching open-paren when it is on screen.
3168 If nil, means don't show it (but the open-paren can still be shown
3169 when it is off screen)."
3171 :group 'paren-blinking)
3173 (defcustom blink-matching-paren-distance (* 25 1024)
3174 "*If non-nil, is maximum distance to search for matching open-paren."
3176 :group 'paren-blinking)
3178 (defcustom blink-matching-delay 1
3179 "*Time in seconds to delay after showing a matching paren."
3181 :group 'paren-blinking)
3183 (defcustom blink-matching-paren-dont-ignore-comments nil
3184 "*Non-nil means `blink-matching-paren' will not ignore comments."
3186 :group 'paren-blinking)
3188 (defun blink-matching-open ()
3189 "Move cursor momentarily to the beginning of the sexp before point."
3191 (and (> (point) (1+ (point-min)))
3192 blink-matching-paren
3193 ;; Verify an even number of quoting characters precede the close.
3194 (= 1 (logand 1 (- (point)
3197 (skip-syntax-backward "/\\")
3199 (let* ((oldpos (point))
3204 (if blink-matching-paren-distance
3205 (narrow-to-region (max (point-min)
3206 (- (point) blink-matching-paren-distance))
3209 (let ((parse-sexp-ignore-comments
3210 (and parse-sexp-ignore-comments
3211 (not blink-matching-paren-dont-ignore-comments))))
3212 (setq blinkpos (scan-sexps oldpos -1)))
3215 (/= (char-syntax (char-after blinkpos))
3218 (or (null (matching-paren (char-after blinkpos)))
3219 (/= (char-after (1- oldpos))
3220 (matching-paren (char-after blinkpos))))))
3221 (if mismatch (setq blinkpos nil))
3223 ;; Don't log messages about paren matching.
3224 (let (message-log-max)
3225 (goto-char blinkpos)
3226 (if (pos-visible-in-window-p)
3227 (and blink-matching-paren-on-screen
3228 (sit-for blink-matching-delay))
3229 (goto-char blinkpos)
3232 ;; Show what precedes the open in its line, if anything.
3234 (skip-chars-backward " \t")
3236 (buffer-substring (progn (beginning-of-line) (point))
3238 ;; Show what follows the open in its line, if anything.
3241 (skip-chars-forward " \t")
3243 (buffer-substring blinkpos
3244 (progn (end-of-line) (point)))
3245 ;; Otherwise show the previous nonblank line,
3248 (skip-chars-backward "\n \t")
3251 (buffer-substring (progn
3252 (skip-chars-backward "\n \t")
3255 (progn (end-of-line)
3256 (skip-chars-backward " \t")
3258 ;; Replace the newline and other whitespace with `...'.
3260 (buffer-substring blinkpos (1+ blinkpos)))
3261 ;; There is nothing to show except the char itself.
3262 (buffer-substring blinkpos (1+ blinkpos))))))))
3264 (message "Mismatched parentheses"))
3265 ((not blink-matching-paren-distance)
3266 (message "Unmatched parenthesis"))))))))
3268 ;Turned off because it makes dbx bomb out.
3269 (setq blink-paren-function 'blink-matching-open)
3271 ;; This executes C-g typed while Emacs is waiting for a command.
3272 ;; Quitting out of a program does not go through here;
3273 ;; that happens in the QUIT macro at the C code level.
3274 (defun keyboard-quit ()
3275 "Signal a `quit' condition.
3276 During execution of Lisp code, this character causes a quit directly.
3277 At top-level, as an editor command, this simply beeps."
3282 (define-key global-map "\C-g" 'keyboard-quit)
3284 (defvar buffer-quit-function nil
3285 "Function to call to \"quit\" the current buffer, or nil if none.
3286 \\[keyboard-escape-quit] calls this function when its more local actions
3287 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3289 (defun keyboard-escape-quit ()
3290 "Exit the current \"mode\" (in a generalized sense of the word).
3291 This command can exit an interactive command such as `query-replace',
3292 can clear out a prefix argument or a region,
3293 can get out of the minibuffer or other recursive edit,
3294 cancel the use of the current buffer (for special-purpose buffers),
3295 or go back to just one window (by deleting all but the selected window)."
3297 (cond ((eq last-command 'mode-exited) nil)
3298 ((> (minibuffer-depth) 0)
3299 (abort-recursive-edit))
3302 ((and transient-mark-mode
3305 ((> (recursion-depth) 0)
3306 (exit-recursive-edit))
3307 (buffer-quit-function
3308 (funcall buffer-quit-function))
3309 ((not (one-window-p t))
3310 (delete-other-windows))
3311 ((string-match "^ \\*" (buffer-name (current-buffer)))
3314 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3316 (defcustom read-mail-command 'rmail
3317 "*Your preference for a mail reading package.
3318 This is used by some keybindings which support reading mail.
3319 See also `mail-user-agent' concerning sending mail."
3320 :type '(choice (function-item rmail)
3321 (function-item gnus)
3322 (function-item mh-rmail)
3323 (function :tag "Other"))
3327 (defcustom mail-user-agent 'sendmail-user-agent
3328 "*Your preference for a mail composition package.
3329 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
3330 outgoing email message. This variable lets you specify which
3331 mail-sending package you prefer.
3333 Valid values include:
3335 `sendmail-user-agent' -- use the default Emacs Mail package.
3336 See Info node `(emacs)Sending Mail'.
3337 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
3338 See Info node `(mh-e)'.
3339 `message-user-agent' -- use the Gnus Message package.
3340 See Info node `(message)'.
3341 `gnus-user-agent' -- like `message-user-agent', but with Gnus
3342 paraphernalia, particularly the Gcc: header for
3345 Additional valid symbols may be available; check with the author of
3346 your package for details. The function should return non-nil if it
3349 See also `read-mail-command' concerning reading mail."
3350 :type '(radio (function-item :tag "Default Emacs mail"
3352 sendmail-user-agent)
3353 (function-item :tag "Emacs interface to MH"
3356 (function-item :tag "Gnus Message package"
3359 (function-item :tag "Gnus Message with full Gnus features"
3362 (function :tag "Other"))
3365 (defun define-mail-user-agent (symbol composefunc sendfunc
3366 &optional abortfunc hookvar)
3367 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3369 SYMBOL can be any Lisp symbol. Its function definition and/or
3370 value as a variable do not matter for this usage; we use only certain
3371 properties on its property list, to encode the rest of the arguments.
3373 COMPOSEFUNC is program callable function that composes an outgoing
3374 mail message buffer. This function should set up the basics of the
3375 buffer without requiring user interaction. It should populate the
3376 standard mail headers, leaving the `to:' and `subject:' headers blank
3379 COMPOSEFUNC should accept several optional arguments--the same
3380 arguments that `compose-mail' takes. See that function's documentation.
3382 SENDFUNC is the command a user would run to send the message.
3384 Optional ABORTFUNC is the command a user would run to abort the
3385 message. For mail packages that don't have a separate abort function,
3386 this can be `kill-buffer' (the equivalent of omitting this argument).
3388 Optional HOOKVAR is a hook variable that gets run before the message
3389 is actually sent. Callers that use the `mail-user-agent' may
3390 install a hook function temporarily on this hook variable.
3391 If HOOKVAR is nil, `mail-send-hook' is used.
3393 The properties used on SYMBOL are `composefunc', `sendfunc',
3394 `abortfunc', and `hookvar'."
3395 (put symbol 'composefunc composefunc)
3396 (put symbol 'sendfunc sendfunc)
3397 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3398 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3400 (define-mail-user-agent 'sendmail-user-agent
3401 'sendmail-user-agent-compose
3402 'mail-send-and-exit)
3404 (defun rfc822-goto-eoh ()
3405 ;; Go to header delimiter line in a mail message, following RFC822 rules
3406 (goto-char (point-min))
3407 (while (looking-at "^[^: \n]+:\\|^[ \t]")
3411 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3412 switch-function yank-action
3415 (let ((special-display-buffer-names nil)
3416 (special-display-regexps nil)
3417 (same-window-buffer-names nil)
3418 (same-window-regexps nil))
3419 (funcall switch-function "*mail*")))
3420 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3421 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3422 (body (cdr (assoc-ignore-case "body" other-headers))))
3423 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3425 (error "Message aborted"))
3428 (while other-headers
3429 (unless (member-ignore-case (car (car other-headers))
3430 '("in-reply-to" "cc" "body"))
3431 (insert (car (car other-headers)) ": "
3432 (cdr (car other-headers)) "\n"))
3433 (setq other-headers (cdr other-headers)))
3439 (define-mail-user-agent 'mh-e-user-agent
3440 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3441 'mh-before-send-letter-hook)
3443 (defun compose-mail (&optional to subject other-headers continue
3444 switch-function yank-action send-actions)
3445 "Start composing a mail message to send.
3446 This uses the user's chosen mail composition package
3447 as selected with the variable `mail-user-agent'.
3448 The optional arguments TO and SUBJECT specify recipients
3449 and the initial Subject field, respectively.
3451 OTHER-HEADERS is an alist specifying additional
3452 header fields. Elements look like (HEADER . VALUE) where both
3453 HEADER and VALUE are strings.
3455 CONTINUE, if non-nil, says to continue editing a message already
3458 SWITCH-FUNCTION, if non-nil, is a function to use to
3459 switch to and display the buffer used for mail composition.
3461 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3462 to insert the raw text of the message being replied to.
3463 It has the form (FUNCTION . ARGS). The user agent will apply
3464 FUNCTION to ARGS, to insert the raw text of the original message.
3465 \(The user agent will also run `mail-citation-hook', *after* the
3466 original text has been inserted in this way.)
3468 SEND-ACTIONS is a list of actions to call when the message is sent.
3469 Each action has the form (FUNCTION . ARGS)."
3471 (list nil nil nil current-prefix-arg))
3472 (let ((function (get mail-user-agent 'composefunc)))
3473 (funcall function to subject other-headers continue
3474 switch-function yank-action send-actions)))
3476 (defun compose-mail-other-window (&optional to subject other-headers continue
3477 yank-action send-actions)
3478 "Like \\[compose-mail], but edit the outgoing message in another window."
3480 (list nil nil nil current-prefix-arg))
3481 (compose-mail to subject other-headers continue
3482 'switch-to-buffer-other-window yank-action send-actions))
3485 (defun compose-mail-other-frame (&optional to subject other-headers continue
3486 yank-action send-actions)
3487 "Like \\[compose-mail], but edit the outgoing message in another frame."
3489 (list nil nil nil current-prefix-arg))
3490 (compose-mail to subject other-headers continue
3491 'switch-to-buffer-other-frame yank-action send-actions))
3493 (defvar set-variable-value-history nil
3494 "History of values entered with `set-variable'.")
3496 (defun set-variable (var val)
3497 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3498 When using this interactively, enter a Lisp object for VALUE.
3499 If you want VALUE to be a string, you must surround it with doublequotes.
3500 VALUE is used literally, not evaluated.
3502 If VARIABLE has a `variable-interactive' property, that is used as if
3503 it were the arg to `interactive' (which see) to interactively read VALUE.
3505 If VARIABLE has been defined with `defcustom', then the type information
3506 in the definition is used to check that VALUE is valid."
3508 (let* ((default-var (variable-at-point))
3509 (var (if (symbolp default-var)
3510 (read-variable (format "Set variable (default %s): " default-var)
3512 (read-variable "Set variable: ")))
3513 (minibuffer-help-form '(describe-variable var))
3514 (prop (get var 'variable-interactive))
3515 (prompt (format "Set %s to value: " var))
3517 ;; Use VAR's `variable-interactive' property
3518 ;; as an interactive spec for prompting.
3519 (call-interactively `(lambda (arg)
3523 (read-string prompt nil
3524 'set-variable-value-history)))))
3527 (let ((type (get var 'custom-type)))
3529 ;; Match with custom type.
3531 (setq type (widget-convert type))
3532 (unless (widget-apply type :match val)
3533 (error "Value `%S' does not match type %S of %S"
3534 val (car type) var))))
3537 ;; Force a thorough redisplay for the case that the variable
3538 ;; has an effect on the display, like `tab-width' has.
3539 (force-mode-line-update))
3541 ;; Define the major mode for lists of completions.
3543 (defvar completion-list-mode-map nil
3544 "Local map for completion list buffers.")
3545 (or completion-list-mode-map
3546 (let ((map (make-sparse-keymap)))
3547 (define-key map [mouse-2] 'mouse-choose-completion)
3548 (define-key map [down-mouse-2] nil)
3549 (define-key map "\C-m" 'choose-completion)
3550 (define-key map "\e\e\e" 'delete-completion-window)
3551 (define-key map [left] 'previous-completion)
3552 (define-key map [right] 'next-completion)
3553 (setq completion-list-mode-map map)))
3555 ;; Completion mode is suitable only for specially formatted data.
3556 (put 'completion-list-mode 'mode-class 'special)
3558 (defvar completion-reference-buffer nil
3559 "Record the buffer that was current when the completion list was requested.
3560 This is a local variable in the completion list buffer.
3561 Initial value is nil to avoid some compiler warnings.")
3563 (defvar completion-no-auto-exit nil
3564 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3565 This also applies to other functions such as `choose-completion'
3566 and `mouse-choose-completion'.")
3568 (defvar completion-base-size nil
3569 "Number of chars at beginning of minibuffer not involved in completion.
3570 This is a local variable in the completion list buffer
3571 but it talks about the buffer in `completion-reference-buffer'.
3572 If this is nil, it means to compare text to determine which part
3573 of the tail end of the buffer's text is involved in completion.")
3575 (defun delete-completion-window ()
3576 "Delete the completion list window.
3577 Go to the window from which completion was requested."
3579 (let ((buf completion-reference-buffer))
3580 (if (one-window-p t)
3581 (if (window-dedicated-p (selected-window))
3582 (delete-frame (selected-frame)))
3583 (delete-window (selected-window))
3584 (if (get-buffer-window buf)
3585 (select-window (get-buffer-window buf))))))
3587 (defun previous-completion (n)
3588 "Move to the previous item in the completion list."
3590 (next-completion (- n)))
3592 (defun next-completion (n)
3593 "Move to the next item in the completion list.
3594 With prefix argument N, move N items (negative N means move backward)."
3596 (let ((beg (point-min)) (end (point-max)))
3597 (while (and (> n 0) (not (eobp)))
3598 ;; If in a completion, move to the end of it.
3599 (when (get-text-property (point) 'mouse-face)
3600 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3601 ;; Move to start of next one.
3602 (unless (get-text-property (point) 'mouse-face)
3603 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3605 (while (and (< n 0) (not (bobp)))
3606 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
3607 ;; If in a completion, move to the start of it.
3608 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
3609 (goto-char (previous-single-property-change
3610 (point) 'mouse-face nil beg)))
3611 ;; Move to end of the previous completion.
3612 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
3613 (goto-char (previous-single-property-change
3614 (point) 'mouse-face nil beg)))
3615 ;; Move to the start of that one.
3616 (goto-char (previous-single-property-change
3617 (point) 'mouse-face nil beg))
3620 (defun choose-completion ()
3621 "Choose the completion that point is in or next to."
3623 (let (beg end completion (buffer completion-reference-buffer)
3624 (base-size completion-base-size))
3625 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3626 (setq end (point) beg (1+ (point))))
3627 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3628 (setq end (1- (point)) beg (point)))
3630 (error "No completion here"))
3631 (setq beg (previous-single-property-change beg 'mouse-face))
3632 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3633 (setq completion (buffer-substring beg end))
3634 (let ((owindow (selected-window)))
3635 (if (and (one-window-p t 'selected-frame)
3636 (window-dedicated-p (selected-window)))
3637 ;; This is a special buffer's frame
3638 (iconify-frame (selected-frame))
3639 (or (window-dedicated-p (selected-window))
3641 (select-window owindow))
3642 (choose-completion-string completion buffer base-size)))
3644 ;; Delete the longest partial match for STRING
3645 ;; that can be found before POINT.
3646 (defun choose-completion-delete-max-match (string)
3647 (let ((opoint (point))
3648 (len (min (length string)
3649 (- (point) (point-min)))))
3650 (goto-char (- (point) (length string)))
3651 (if completion-ignore-case
3652 (setq string (downcase string)))
3653 (while (and (> len 0)
3654 (let ((tail (buffer-substring (point)
3656 (if completion-ignore-case
3657 (setq tail (downcase tail)))
3658 (not (string= tail (substring string 0 len)))))
3663 ;; Switch to BUFFER and insert the completion choice CHOICE.
3664 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3665 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
3667 ;; If BUFFER is the minibuffer, exit the minibuffer
3668 ;; unless it is reading a file name and CHOICE is a directory,
3669 ;; or completion-no-auto-exit is non-nil.
3670 (defun choose-completion-string (choice &optional buffer base-size)
3671 (let ((buffer (or buffer completion-reference-buffer))
3672 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))))
3673 ;; If BUFFER is a minibuffer, barf unless it's the currently
3674 ;; active minibuffer.
3676 (or (not (active-minibuffer-window))
3678 (window-buffer (active-minibuffer-window))))))
3679 (error "Minibuffer is not active for completion")
3680 ;; Insert the completion into the buffer where completion was requested.
3683 (delete-region (+ base-size (if mini-p
3684 (minibuffer-prompt-end)
3687 (choose-completion-delete-max-match choice))
3689 (remove-text-properties (- (point) (length choice)) (point)
3691 ;; Update point in the window that BUFFER is showing in.
3692 (let ((window (get-buffer-window buffer t)))
3693 (set-window-point window (point)))
3694 ;; If completing for the minibuffer, exit it with this choice.
3695 (and (not completion-no-auto-exit)
3696 (equal buffer (window-buffer (minibuffer-window)))
3697 minibuffer-completion-table
3698 ;; If this is reading a file name, and the file name chosen
3699 ;; is a directory, don't exit the minibuffer.
3700 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
3701 (file-directory-p (field-string (point-max))))
3702 (let ((mini (active-minibuffer-window)))
3703 (select-window mini)
3704 (when minibuffer-auto-raise
3705 (raise-frame (window-frame mini))))
3706 (exit-minibuffer))))))
3708 (defun completion-list-mode ()
3709 "Major mode for buffers showing lists of possible completions.
3710 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3711 to select the completion near point.
3712 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3715 (kill-all-local-variables)
3716 (use-local-map completion-list-mode-map)
3717 (setq mode-name "Completion List")
3718 (setq major-mode 'completion-list-mode)
3719 (make-local-variable 'completion-base-size)
3720 (setq completion-base-size nil)
3721 (run-hooks 'completion-list-mode-hook))
3723 (defun completion-list-mode-finish ()
3724 "Finish setup of the completions buffer.
3725 Called from `temp-buffer-show-hook'."
3726 (when (eq major-mode 'completion-list-mode)
3727 (toggle-read-only 1)))
3729 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
3731 (defvar completion-setup-hook nil
3732 "Normal hook run at the end of setting up a completion list buffer.
3733 When this hook is run, the current buffer is the one in which the
3734 command to display the completion list buffer was run.
3735 The completion list buffer is available as the value of `standard-output'.")
3737 ;; This function goes in completion-setup-hook, so that it is called
3738 ;; after the text of the completion list buffer is written.
3740 (defun completion-setup-function ()
3742 (let ((mainbuf (current-buffer)))
3743 (set-buffer standard-output)
3744 (completion-list-mode)
3745 (make-local-variable 'completion-reference-buffer)
3746 (setq completion-reference-buffer mainbuf)
3747 (if (eq minibuffer-completion-table 'read-file-name-internal)
3748 ;; For file name completion,
3749 ;; use the number of chars before the start of the
3750 ;; last file name component.
3751 (setq completion-base-size
3753 (set-buffer mainbuf)
3754 (goto-char (point-max))
3755 (skip-chars-backward (format "^%c" directory-sep-char))
3756 (- (point) (minibuffer-prompt-end))))
3757 ;; Otherwise, in minibuffer, the whole input is being completed.
3759 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3760 (buffer-name mainbuf))
3761 (setq completion-base-size 0))))
3762 (goto-char (point-min))
3763 (if (display-mouse-p)
3764 (insert (substitute-command-keys
3765 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
3766 (insert (substitute-command-keys
3767 "In this buffer, type \\[choose-completion] to \
3768 select the completion near point.\n\n")))))
3770 (add-hook 'completion-setup-hook 'completion-setup-function)
3772 (define-key minibuffer-local-completion-map [prior]
3773 'switch-to-completions)
3774 (define-key minibuffer-local-must-match-map [prior]
3775 'switch-to-completions)
3776 (define-key minibuffer-local-completion-map "\M-v"
3777 'switch-to-completions)
3778 (define-key minibuffer-local-must-match-map "\M-v"
3779 'switch-to-completions)
3781 (defun switch-to-completions ()
3782 "Select the completion list window."
3784 ;; Make sure we have a completions window.
3785 (or (get-buffer-window "*Completions*")
3786 (minibuffer-completion-help))
3787 (let ((window (get-buffer-window "*Completions*")))
3789 (select-window window)
3790 (goto-char (point-min))
3791 (search-forward "\n\n")
3794 ;; Support keyboard commands to turn on various modifiers.
3796 ;; These functions -- which are not commands -- each add one modifier
3797 ;; to the following event.
3799 (defun event-apply-alt-modifier (ignore-prompt)
3800 "Add the Alt modifier to the following event.
3801 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
3802 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3803 (defun event-apply-super-modifier (ignore-prompt)
3804 "Add the Super modifier to the following event.
3805 For example, type \\[event-apply-super-modifier] & to enter Super-&."
3806 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3807 (defun event-apply-hyper-modifier (ignore-prompt)
3808 "Add the Hyper modifier to the following event.
3809 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
3810 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3811 (defun event-apply-shift-modifier (ignore-prompt)
3812 "Add the Shift modifier to the following event.
3813 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
3814 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3815 (defun event-apply-control-modifier (ignore-prompt)
3816 "Add the Ctrl modifier to the following event.
3817 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
3818 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3819 (defun event-apply-meta-modifier (ignore-prompt)
3820 "Add the Meta modifier to the following event.
3821 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
3822 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3824 (defun event-apply-modifier (event symbol lshiftby prefix)
3825 "Apply a modifier flag to event EVENT.
3826 SYMBOL is the name of this modifier, as a symbol.
3827 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3828 PREFIX is the string that represents this modifier in an event type symbol."
3830 (cond ((eq symbol 'control)
3831 (if (and (<= (downcase event) ?z)
3832 (>= (downcase event) ?a))
3833 (- (downcase event) ?a -1)
3834 (if (and (<= (downcase event) ?Z)
3835 (>= (downcase event) ?A))
3836 (- (downcase event) ?A -1)
3837 (logior (lsh 1 lshiftby) event))))
3839 (if (and (<= (downcase event) ?z)
3840 (>= (downcase event) ?a))
3842 (logior (lsh 1 lshiftby) event)))
3844 (logior (lsh 1 lshiftby) event)))
3845 (if (memq symbol (event-modifiers event))
3847 (let ((event-type (if (symbolp event) event (car event))))
3848 (setq event-type (intern (concat prefix (symbol-name event-type))))
3851 (cons event-type (cdr event)))))))
3853 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3854 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3855 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3856 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3857 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3858 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3860 ;;;; Keypad support.
3862 ;;; Make the keypad keys act like ordinary typing keys. If people add
3863 ;;; bindings for the function key symbols, then those bindings will
3864 ;;; override these, so this shouldn't interfere with any existing
3867 ;; Also tell read-char how to handle these keys.
3869 (lambda (keypad-normal)
3870 (let ((keypad (nth 0 keypad-normal))
3871 (normal (nth 1 keypad-normal)))
3872 (put keypad 'ascii-character normal)
3873 (define-key function-key-map (vector keypad) (vector normal))))
3874 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3875 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3888 ;;;; forking a twin copy of a buffer.
3891 (defvar clone-buffer-hook nil
3892 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
3894 (defun clone-process (process &optional newname)
3895 "Create a twin copy of PROCESS.
3896 If NEWNAME is nil, it defaults to PROCESS' name;
3897 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3898 If PROCESS is associated with a buffer, the new process will be associated
3899 with the current buffer instead.
3900 Returns nil if PROCESS has already terminated."
3901 (setq newname (or newname (process-name process)))
3902 (if (string-match "<[0-9]+>\\'" newname)
3903 (setq newname (substring newname 0 (match-beginning 0))))
3904 (when (memq (process-status process) '(run stop open))
3905 (let* ((process-connection-type (process-tty-name process))
3906 (old-kwoq (process-kill-without-query process nil))
3908 (if (memq (process-status process) '(open))
3909 (apply 'open-network-stream newname
3910 (if (process-buffer process) (current-buffer))
3911 (process-contact process))
3912 (apply 'start-process newname
3913 (if (process-buffer process) (current-buffer))
3914 (process-command process)))))
3915 (process-kill-without-query new-process old-kwoq)
3916 (process-kill-without-query process old-kwoq)
3917 (set-process-inherit-coding-system-flag
3918 new-process (process-inherit-coding-system-flag process))
3919 (set-process-filter new-process (process-filter process))
3920 (set-process-sentinel new-process (process-sentinel process))
3923 ;; things to maybe add (currently partly covered by `funcall mode':
3926 (defun clone-buffer (&optional newname display-flag)
3927 "Create a twin copy of the current buffer.
3928 If NEWNAME is nil, it defaults to the current buffer's name;
3929 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3931 If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
3932 This runs the normal hook `clone-buffer-hook' in the new buffer
3933 after it has been set up properly in other respects."
3934 (interactive (list (if current-prefix-arg (read-string "Name: "))
3936 (if buffer-file-name
3937 (error "Cannot clone a file-visiting buffer"))
3938 (if (get major-mode 'no-clone)
3939 (error "Cannot clone a buffer in %s mode" mode-name))
3940 (setq newname (or newname (buffer-name)))
3941 (if (string-match "<[0-9]+>\\'" newname)
3942 (setq newname (substring newname 0 (match-beginning 0))))
3943 (let ((buf (current-buffer))
3947 (mk (if mark-active (mark t)))
3948 (modified (buffer-modified-p))
3950 (lvars (buffer-local-variables))
3951 (process (get-buffer-process (current-buffer)))
3952 (new (generate-new-buffer (or newname (buffer-name)))))
3955 (with-current-buffer new
3956 (insert-buffer-substring buf)))
3957 (with-current-buffer new
3958 (narrow-to-region ptmin ptmax)
3960 (if mk (set-mark mk))
3961 (set-buffer-modified-p modified)
3963 ;; Clone the old buffer's process, if any.
3964 (when process (clone-process process))
3966 ;; Now set up the major mode.
3969 ;; Set up other local variables.
3971 (condition-case () ;in case var is read-only
3974 (set (make-local-variable (car v)) (cdr v)))
3978 ;; Run any hooks (typically set up by the major mode
3979 ;; for cloning to work properly).
3980 (run-hooks 'clone-buffer-hook))
3981 (if display-flag (pop-to-buffer new))
3985 (defun clone-indirect-buffer (newname display-flag &optional norecord)
3986 "Create an indirect buffer that is a twin copy of the current buffer.
3988 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
3989 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
3990 or if not called with a prefix arg, NEWNAME defaults to the current
3991 buffer's name. The name is modified by adding a `<N>' suffix to it
3992 or by incrementing the N in an existing suffix.
3994 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
3995 This is always done when called interactively.
3997 Optional last arg NORECORD non-nil means do not put this buffer at the
3998 front of the list of recently selected ones."
3999 (interactive (list (if current-prefix-arg
4000 (read-string "BName of indirect buffer: "))
4002 (setq newname (or newname (buffer-name)))
4003 (if (string-match "<[0-9]+>\\'" newname)
4004 (setq newname (substring newname 0 (match-beginning 0))))
4005 (let* ((name (generate-new-buffer-name newname))
4006 (buffer (make-indirect-buffer (current-buffer) name t)))
4008 (pop-to-buffer buffer norecord))
4012 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
4013 "Create an indirect buffer that is a twin copy of BUFFER.
4014 Select the new buffer in another window.
4015 Optional second arg NORECORD non-nil means do not put this buffer at
4016 the front of the list of recently selected ones."
4017 (interactive "bClone buffer in other window: ")
4018 (let ((popup-windows t))
4020 (clone-indirect-buffer nil t norecord)))
4022 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
4027 (defconst syntax-code-table
4028 '((?\ 0 "whitespace")
4030 (?. 1 "punctuation")
4033 (?\( 4 "open parenthesis")
4034 (?\) 5 "close parenthesis")
4035 (?\' 6 "expression prefix")
4036 (?\" 7 "string quote")
4037 (?$ 8 "paired delimiter")
4039 (?/ 10 "character quote")
4040 (?< 11 "comment start")
4041 (?> 12 "comment end")
4043 (nil 14 "comment fence")
4044 (nil 15 "string fence"))
4045 "Alist of forms (CHAR CODE DESCRIPTION) mapping characters to syntax info.
4046 CHAR is a character that is allowed as first char in the string
4047 specifying the syntax when calling `modify-syntax-entry'. CODE is the
4048 corresponing syntax code as it is stored in a syntax cell, and
4049 can be used as value of a `syntax-table' property.
4050 DESCRIPTION is the descriptive string for the syntax.")
4053 ;;; Handling of Backspace and Delete keys.
4055 (defcustom normal-erase-is-backspace nil
4056 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
4058 On window systems, the default value of this option is chosen
4059 according to the keyboard used. If the keyboard has both a Backspace
4060 key and a Delete key, and both are mapped to their usual meanings, the
4061 option's default value is set to t, so that Backspace can be used to
4062 delete backward, and Delete can be used to delete forward.
4064 If not running under a window system, customizing this option accomplishes
4065 a similar effect by mapping C-h, which is usually generated by the
4066 Backspace key, to DEL, and by mapping DEL to C-d via
4067 `keyboard-translate'. The former functionality of C-h is available on
4068 the F1 key. You should probably not use this setting if you don't
4069 have both Backspace, Delete and F1 keys.
4071 Setting this variable with setq doesn't take effect. Programmatically,
4072 call `normal-erase-is-backspace-mode' (which see) instead."
4074 :group 'editing-basics
4076 :set (lambda (symbol value)
4077 ;; The fboundp is because of a problem with :set when
4078 ;; dumping Emacs. It doesn't really matter.
4079 (if (fboundp 'normal-erase-is-backspace-mode)
4080 (normal-erase-is-backspace-mode (or value 0))
4081 (set-default symbol value))))
4084 (defun normal-erase-is-backspace-mode (&optional arg)
4085 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
4087 With numeric arg, turn the mode on if and only if ARG is positive.
4089 On window systems, when this mode is on, Delete is mapped to C-d and
4090 Backspace is mapped to DEL; when this mode is off, both Delete and
4091 Backspace are mapped to DEL. (The remapping goes via
4092 `function-key-map', so binding Delete or Backspace in the global or
4093 local keymap will override that.)
4095 In addition, on window systems, the bindings of C-Delete, M-Delete,
4096 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
4097 the global keymap in accordance with the functionality of Delete and
4098 Backspace. For example, if Delete is remapped to C-d, which deletes
4099 forward, C-Delete is bound to `kill-word', but if Delete is remapped
4100 to DEL, which deletes backward, C-Delete is bound to
4101 `backward-kill-word'.
4103 If not running on a window system, a similar effect is accomplished by
4104 remapping C-h (normally produced by the Backspace key) and DEL via
4105 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
4106 to C-d; if it's off, the keys are not remapped.
4108 When not running on a window system, and this mode is turned on, the
4109 former functionality of C-h is available on the F1 key. You should
4110 probably not turn on this mode on a text-only terminal if you don't
4111 have both Backspace, Delete and F1 keys.
4113 See also `normal-erase-is-backspace'."
4115 (setq normal-erase-is-backspace
4117 (> (prefix-numeric-value arg) 0)
4118 (not normal-erase-is-backspace)))
4120 (cond ((or (memq window-system '(x w32 mac pc))
4121 (memq system-type '(ms-dos windows-nt)))
4123 `(([C-delete] [C-backspace])
4124 ([M-delete] [M-backspace])
4125 ([C-M-delete] [C-M-backspace])
4127 [C-delete] [C-backspace])))
4128 (old-state (lookup-key function-key-map [delete])))
4130 (if normal-erase-is-backspace
4132 (define-key function-key-map [delete] [?\C-d])
4133 (define-key function-key-map [kp-delete] [?\C-d])
4134 (define-key function-key-map [backspace] [?\C-?]))
4135 (define-key function-key-map [delete] [?\C-?])
4136 (define-key function-key-map [kp-delete] [?\C-?])
4137 (define-key function-key-map [backspace] [?\C-?]))
4139 ;; Maybe swap bindings of C-delete and C-backspace, etc.
4140 (unless (equal old-state (lookup-key function-key-map [delete]))
4141 (dolist (binding bindings)
4142 (let ((map global-map))
4143 (when (keymapp (car binding))
4144 (setq map (car binding) binding (cdr binding)))
4145 (let* ((key1 (nth 0 binding))
4146 (key2 (nth 1 binding))
4147 (binding1 (lookup-key map key1))
4148 (binding2 (lookup-key map key2)))
4149 (define-key map key1 binding2)
4150 (define-key map key2 binding1)))))))
4152 (if normal-erase-is-backspace
4154 (keyboard-translate ?\C-h ?\C-?)
4155 (keyboard-translate ?\C-? ?\C-d))
4156 (keyboard-translate ?\C-h ?\C-h)
4157 (keyboard-translate ?\C-? ?\C-?))))
4159 (run-hooks 'normal-erase-is-backspace-hook)
4161 (message "Delete key deletes %s"
4162 (if normal-erase-is-backspace "forward" "backward"))))
4167 (defun byte-compiling-files-p ()
4168 "Return t if currently byte-compiling files."
4169 (and (boundp 'byte-compile-current-file)
4170 (stringp byte-compile-current-file)))
4172 ;;; simple.el ends here