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."
343 (let ((orig-pos (point)))
348 (skip-chars-forward " \t")
349 (constrain-to-field nil orig-pos t
)))
351 (skip-chars-backward " \t")
352 (constrain-to-field nil orig-pos
)))))
354 (defun just-one-space ()
355 "Delete all spaces and tabs around point, leaving one space."
357 (let ((orig-pos (point)))
358 (skip-chars-backward " \t")
359 (constrain-to-field nil orig-pos
)
360 (if (= (following-char) ?
)
366 (skip-chars-forward " \t")
367 (constrain-to-field nil orig-pos t
)))))
369 (defun beginning-of-buffer (&optional arg
)
370 "Move point to the beginning of the buffer; leave mark at previous position.
371 With arg N, put point N/10 of the way from the beginning.
373 If the buffer is narrowed, this command uses the beginning and size
374 of the accessible part of the buffer.
376 Don't use this command in Lisp programs!
377 \(goto-char (point-min)) is faster and avoids clobbering the mark."
380 (let ((size (- (point-max) (point-min))))
384 ;; Avoid overflow for large buffer sizes!
385 (* (prefix-numeric-value arg
)
387 (/ (+ 10 (* size
(prefix-numeric-value arg
))) 10)))
389 (if arg
(forward-line 1)))
391 (defun end-of-buffer (&optional arg
)
392 "Move point to the end of the buffer; leave mark at previous position.
393 With arg N, put point N/10 of the way from the end.
395 If the buffer is narrowed, this command uses the beginning and size
396 of the accessible part of the buffer.
398 Don't use this command in Lisp programs!
399 \(goto-char (point-max)) is faster and avoids clobbering the mark."
402 (let ((size (- (point-max) (point-min))))
406 ;; Avoid overflow for large buffer sizes!
407 (* (prefix-numeric-value arg
)
409 (/ (* size
(prefix-numeric-value arg
)) 10)))
411 ;; If we went to a place in the middle of the buffer,
412 ;; adjust it to the beginning of a line.
413 (cond (arg (forward-line 1))
414 ((< (point) (window-end nil t
))
415 ;; If the end of the buffer is not already on the screen,
416 ;; then scroll specially to put it near, but not at, the bottom.
417 (overlay-recenter (point))
420 (defun mark-whole-buffer ()
421 "Put point at beginning and mark at end of buffer.
422 You probably should not use this function in Lisp programs;
423 it is usually a mistake for a Lisp function to use any subroutine
424 that uses or sets the mark."
427 (push-mark (point-max) nil t
)
428 (goto-char (point-min)))
431 ;; Counting lines, one way or another.
433 (defun goto-line (arg)
434 "Goto line ARG, counting from line 1 at beginning of buffer."
435 (interactive "NGoto line: ")
436 (setq arg
(prefix-numeric-value arg
))
440 (if (eq selective-display t
)
441 (re-search-forward "[\n\C-m]" nil
'end
(1- arg
))
442 (forward-line (1- arg
)))))
444 (defun count-lines-region (start end
)
445 "Print number of lines and characters in the region."
447 (message "Region has %d lines, %d characters"
448 (count-lines start end
) (- end start
)))
451 "Print the current buffer line number and narrowed line number of point."
453 (let ((opoint (point)) start
)
456 (goto-char (point-min))
463 (message "line %d (narrowed line %d)"
464 (1+ (count-lines 1 (point)))
465 (1+ (count-lines start
(point))))
466 (message "Line %d" (1+ (count-lines 1 (point)))))))))
468 (defun count-lines (start end
)
469 "Return number of lines between START and END.
470 This is usually the number of newlines between them,
471 but can be one more if START is not equal to END
472 and the greater of them is not at the start of a line."
475 (narrow-to-region start end
)
476 (goto-char (point-min))
477 (if (eq selective-display t
)
480 (while (re-search-forward "[\n\C-m]" nil t
40)
481 (setq done
(+ 40 done
)))
482 (while (re-search-forward "[\n\C-m]" nil t
1)
483 (setq done
(+ 1 done
)))
484 (goto-char (point-max))
485 (if (and (/= start end
)
489 (- (buffer-size) (forward-line (buffer-size)))))))
491 (defun what-cursor-position (&optional detail
)
492 "Print info on cursor position (on screen and within buffer).
493 Also describe the character after point, and give its character code
494 in octal, decimal and hex.
496 For a non-ASCII multibyte character, also give its encoding in the
497 buffer's selected coding system if the coding system encodes the
498 character safely. If the character is encoded into one byte, that
499 code is shown in hex. If the character is encoded into more than one
500 byte, just \"...\" is shown.
502 In addition, with prefix argument, show details about that character
503 in *Help* buffer. See also the command `describe-char-after'."
505 (let* ((char (following-char))
509 (total (buffer-size))
510 (percent (if (> total
50000)
511 ;; Avoid overflow from multiplying by 100!
512 (/ (+ (/ total
200) (1- pos
)) (max (/ total
100) 1))
513 (/ (+ (/ total
2) (* 100 (1- pos
))) (max total
1))))
514 (hscroll (if (= (window-hscroll) 0)
516 (format " Hscroll=%d" (window-hscroll))))
517 (col (current-column)))
519 (if (or (/= beg
1) (/= end
(1+ total
)))
520 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
521 pos total percent beg end col hscroll
)
522 (message "point=%d of %d (%d%%) column %d %s"
523 pos total percent col hscroll
))
524 (let ((coding buffer-file-coding-system
)
525 encoded encoding-msg
)
527 (eq (coding-system-type coding
) t
))
528 (setq coding default-buffer-file-coding-system
))
529 (if (not (char-valid-p char
))
531 (format "(0%o, %d, 0x%x, invalid)" char char char
))
532 (setq encoded
(and (>= char
128) (encode-coding-char char coding
)))
535 (format "(0%o, %d, 0x%x, file %s)"
537 (if (> (length encoded
) 1)
539 (encoded-string-description encoded coding
)))
540 (format "(0%o, %d, 0x%x)" char char char
))))
542 ;; We show the detailed information about CHAR.
543 (describe-char-after (point)))
544 (if (or (/= beg
1) (/= end
(1+ total
)))
545 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
547 (single-key-description char
)
548 (buffer-substring-no-properties (point) (1+ (point))))
549 encoding-msg pos total percent beg end col hscroll
)
550 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
552 (single-key-description char
)
553 (buffer-substring-no-properties (point) (1+ (point))))
554 encoding-msg pos total percent col hscroll
))))))
556 (defvar read-expression-map
557 (let ((m (make-sparse-keymap)))
558 (define-key m
"\M-\t" 'lisp-complete-symbol
)
559 (set-keymap-parent m minibuffer-local-map
)
561 "Minibuffer keymap used for reading Lisp expressions.")
563 (defvar read-expression-history nil
)
565 (defcustom eval-expression-print-level
4
566 "*Value to use for `print-level' when printing value in `eval-expression'."
571 (defcustom eval-expression-print-length
12
572 "*Value to use for `print-length' when printing value in `eval-expression'."
574 :type
'(choice (const nil
) integer
)
577 (defcustom eval-expression-debug-on-error t
578 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
579 If nil, don't change the value of `debug-on-error'."
584 ;; We define this, rather than making `eval' interactive,
585 ;; for the sake of completion of names like eval-region, eval-current-buffer.
586 (defun eval-expression (eval-expression-arg
587 &optional eval-expression-insert-value
)
588 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
589 Value is also consed on to front of the variable `values'.
590 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
591 insert the result into the current buffer instead of printing it in
594 (list (read-from-minibuffer "Eval: "
595 nil read-expression-map t
596 'read-expression-history
)
599 (if (null eval-expression-debug-on-error
)
600 (setq values
(cons (eval eval-expression-arg
) values
))
601 (let ((old-value (make-symbol "t")) new-value
)
602 ;; Bind debug-on-error to something unique so that we can
603 ;; detect when evaled code changes it.
604 (let ((debug-on-error old-value
))
605 (setq values
(cons (eval eval-expression-arg
) values
))
606 (setq new-value debug-on-error
))
607 ;; If evaled code has changed the value of debug-on-error,
608 ;; propagate that change to the global binding.
609 (unless (eq old-value new-value
)
610 (setq debug-on-error new-value
))))
612 (let ((print-length eval-expression-print-length
)
613 (print-level eval-expression-print-level
))
615 (if eval-expression-insert-value
(current-buffer) t
))))
617 (defun edit-and-eval-command (prompt command
)
618 "Prompting with PROMPT, let user edit COMMAND and eval result.
619 COMMAND is a Lisp expression. Let user edit that expression in
620 the minibuffer, then read and evaluate the result."
621 (let ((command (read-from-minibuffer prompt
622 (prin1-to-string command
)
623 read-expression-map t
624 '(command-history .
1))))
625 ;; If command was added to command-history as a string,
626 ;; get rid of that. We want only evaluable expressions there.
627 (if (stringp (car command-history
))
628 (setq command-history
(cdr command-history
)))
630 ;; If command to be redone does not match front of history,
631 ;; add it to the history.
632 (or (equal command
(car command-history
))
633 (setq command-history
(cons command command-history
)))
636 (defun repeat-complex-command (arg)
637 "Edit and re-evaluate last complex command, or ARGth from last.
638 A complex command is one which used the minibuffer.
639 The command is placed in the minibuffer as a Lisp form for editing.
640 The result is executed, repeating the command as changed.
641 If the command has been changed or is not the most recent previous command
642 it is added to the front of the command history.
643 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
644 to get different commands to edit and resubmit."
646 (let ((elt (nth (1- arg
) command-history
))
651 (let ((print-level nil
)
652 (minibuffer-history-position arg
)
653 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
654 (read-from-minibuffer
655 "Redo: " (prin1-to-string elt
) read-expression-map t
656 (cons 'command-history arg
))))
658 ;; If command was added to command-history as a string,
659 ;; get rid of that. We want only evaluable expressions there.
660 (if (stringp (car command-history
))
661 (setq command-history
(cdr command-history
)))
663 ;; If command to be redone does not match front of history,
664 ;; add it to the history.
665 (or (equal newcmd
(car command-history
))
666 (setq command-history
(cons newcmd command-history
)))
670 (defvar minibuffer-history nil
671 "Default minibuffer history list.
672 This is used for all minibuffer input
673 except when an alternate history list is specified.")
674 (defvar minibuffer-history-sexp-flag nil
675 "Non-nil when doing history operations on `command-history'.
676 More generally, indicates that the history list being acted on
677 contains expressions rather than strings.
678 It is only valid if its value equals the current minibuffer depth,
679 to handle recursive uses of the minibuffer.")
680 (setq minibuffer-history-variable
'minibuffer-history
)
681 (setq minibuffer-history-position nil
)
682 (defvar minibuffer-history-search-history nil
)
685 (lambda (key-and-command)
687 (lambda (keymap-and-completionp)
688 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
689 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
690 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
691 (define-key (symbol-value (car keymap-and-completionp
))
692 (car key-and-command
)
693 (let ((command (cdr key-and-command
)))
695 ;; (and ... nil) => ... turns back on the completion-oriented
696 ;; history commands which rms turned off since they seem to
697 ;; do things he doesn't like.
698 (if (and (cdr keymap-and-completionp
) nil
) ;XXX turned off
699 (progn (error "EMACS BUG!") (cdr command
))
702 '((minibuffer-local-map . nil
)
703 (minibuffer-local-ns-map . nil
)
704 (minibuffer-local-completion-map . t
)
705 (minibuffer-local-must-match-map . t
)
706 (read-expression-map . nil
))))
707 '(("\en" .
(next-history-element . next-complete-history-element
))
708 ([next] . (next-history-element . next-complete-history-element))
709 ("\ep" . (previous-history-element . previous-complete-history-element))
710 ([prior] . (previous-history-element . previous-complete-history-element))
711 ("\er" . previous-matching-history-element)
712 ("\es" . next-matching-history-element)))
714 (defvar minibuffer-text-before-history nil
715 "Text that was in this minibuffer before any history commands.
716 This is nil if there have not yet been any history commands
717 in this use of the minibuffer.")
719 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
721 (defun minibuffer-history-initialize ()
722 (setq minibuffer-text-before-history nil))
724 (defun minibuffer-avoid-prompt (new old)
725 "A point-motion hook for the minibuffer, that moves point out of the prompt."
726 (constrain-to-field nil (point-max)))
728 (defcustom minibuffer-history-case-insensitive-variables nil
729 "*Minibuffer history variables for which matching should ignore case.
730 If a history variable is a member of this list, then the
731 \\[previous-matching-history-element] and \\[next-matching-history-element]\
732 commands ignore case when searching it, regardless of `case-fold-search'."
733 :type '(repeat variable)
736 (defun previous-matching-history-element (regexp n)
737 "Find the previous history element that matches REGEXP.
738 \(Previous history elements refer to earlier actions.)
739 With prefix argument N, search for Nth previous match.
740 If N is negative, find the next or Nth next match.
741 Normally, history elements are matched case-insensitively if
742 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
743 makes the search case-sensitive.
744 See also `minibuffer-history-case-insensitive-variables'."
746 (let* ((enable-recursive-minibuffers t)
747 (regexp (read-from-minibuffer "Previous element matching (regexp): "
751 'minibuffer-history-search-history)))
752 ;; Use the last regexp specified, by default, if input is empty.
753 (list (if (string= regexp "")
754 (if minibuffer-history-search-history
755 (car minibuffer-history-search-history)
756 (error "No previous history search regexp"))
758 (prefix-numeric-value current-prefix-arg))))
760 (if (and (zerop minibuffer-history-position)
761 (null minibuffer-text-before-history))
762 (setq minibuffer-text-before-history (field-string (point-max))))
763 (let ((history (symbol-value minibuffer-history-variable))
765 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
766 ;; On some systems, ignore case for file names.
767 (if (memq minibuffer-history-variable
768 minibuffer-history-case-insensitive-variables)
770 ;; Respect the user's setting for case-fold-search:
776 (pos minibuffer-history-position))
779 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
780 (when (= pos prevpos)
782 "No later matching history item"
783 "No earlier matching history item")))
785 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
786 (let ((print-level nil))
787 (prin1-to-string (nth (1- pos) history)))
788 (nth (1- pos) history)))
791 (and (string-match regexp match-string)
793 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
794 (match-beginning 1))))
796 (setq n (+ n (if (< n 0) 1 -1)))))
797 (setq minibuffer-history-position pos)
798 (goto-char (point-max))
800 (insert match-string)
801 (goto-char (+ (field-beginning) match-offset))))
802 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
803 (eq (car (car command-history)) 'next-matching-history-element))
804 (setq command-history (cdr command-history))))
806 (defun next-matching-history-element (regexp n)
807 "Find the next history element that matches REGEXP.
808 \(The next history element refers to a more recent action.)
809 With prefix argument N, search for Nth next match.
810 If N is negative, find the previous or Nth previous match.
811 Normally, history elements are matched case-insensitively if
812 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
813 makes the search case-sensitive."
815 (let* ((enable-recursive-minibuffers t)
816 (regexp (read-from-minibuffer "Next element matching (regexp): "
820 'minibuffer-history-search-history)))
821 ;; Use the last regexp specified, by default, if input is empty.
822 (list (if (string= regexp "")
823 (setcar minibuffer-history-search-history
824 (nth 1 minibuffer-history-search-history))
826 (prefix-numeric-value current-prefix-arg))))
827 (previous-matching-history-element regexp (- n)))
829 (defvar minibuffer-temporary-goal-position nil)
831 (defun next-history-element (n)
832 "Insert the next element of the minibuffer history into the minibuffer."
835 (let ((narg (- minibuffer-history-position n))
836 (minimum (if minibuffer-default -1 0))
837 elt minibuffer-returned-to-present)
838 (if (and (zerop minibuffer-history-position)
839 (null minibuffer-text-before-history))
840 (setq minibuffer-text-before-history (field-string (point-max))))
842 (if minibuffer-default
843 (error "End of history; no next item")
844 (error "End of history; no default available")))
845 (if (> narg (length (symbol-value minibuffer-history-variable)))
846 (error "Beginning of history; no preceding item"))
847 (unless (or (eq last-command 'next-history-element)
848 (eq last-command 'previous-history-element))
849 (let ((prompt-end (field-beginning (point-max))))
850 (set (make-local-variable 'minibuffer-temporary-goal-position)
851 (cond ((<= (point) prompt-end) prompt-end)
854 (goto-char (point-max))
856 (setq minibuffer-history-position narg)
858 (setq elt minibuffer-default))
860 (setq elt (or minibuffer-text-before-history ""))
861 (setq minibuffer-returned-to-present t)
862 (setq minibuffer-text-before-history nil))
863 (t (setq elt (nth (1- minibuffer-history-position)
864 (symbol-value minibuffer-history-variable)))))
866 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
867 (not minibuffer-returned-to-present))
868 (let ((print-level nil))
869 (prin1-to-string elt))
871 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
873 (defun previous-history-element (n)
874 "Inserts the previous element of the minibuffer history into the minibuffer."
876 (next-history-element (- n)))
878 (defun next-complete-history-element (n)
879 "Get next history element which completes the minibuffer before the point.
880 The contents of the minibuffer after the point are deleted, and replaced
881 by the new completion."
883 (let ((point-at-start (point)))
884 (next-matching-history-element
886 "^" (regexp-quote (buffer-substring (field-beginning) (point))))
888 ;; next-matching-history-element always puts us at (point-min).
889 ;; Move to the position we were at before changing the buffer contents.
890 ;; This is still sensical, because the text before point has not changed.
891 (goto-char point-at-start)))
893 (defun previous-complete-history-element (n)
895 Get previous history element which completes the minibuffer before the point.
896 The contents of the minibuffer after the point are deleted, and replaced
897 by the new completion."
899 (next-complete-history-element (- n)))
901 ;; These two functions are for compatibility with the old subrs of the
904 (defun minibuffer-prompt-width ()
905 "Return the display width of the minibuffer prompt.
906 Return 0 if current buffer is not a mini-buffer."
907 ;; Return the width of everything before the field at the end of
908 ;; the buffer; this should be 0 for normal buffers.
909 (1- (field-beginning (point-max))))
911 (defun minibuffer-prompt-end ()
912 "Return the buffer position of the end of the minibuffer prompt.
913 Return (point-min) if current buffer is not a mini-buffer."
914 (field-beginning (point-max)))
916 (defun minibuffer-contents ()
917 "Return the user input in a minbuffer as a string.
918 The current buffer must be a minibuffer."
919 (field-string (point-max)))
921 (defun minibuffer-contents-no-properties ()
922 "Return the user input in a minbuffer as a string, without text-properties.
923 The current buffer must be a minibuffer."
924 (field-string-no-properties (point-max)))
926 (defun delete-minibuffer-contents ()
927 "Delete all user input in a minibuffer.
928 The current buffer must be a minibuffer."
929 (delete-field (point-max)))
931 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
932 (defalias 'advertised-undo 'undo)
934 (defun undo (&optional arg)
935 "Undo some previous changes.
936 Repeat this command to undo more changes.
937 A numeric argument serves as a repeat count.
939 In Transient Mark mode when the mark is active, only undo changes within
940 the current region. Similarly, when not in Transient Mark mode, just C-u
941 as an argument limits undo to changes within the current region."
943 ;; If we don't get all the way thru, make last-command indicate that
944 ;; for the following command.
945 (setq this-command t)
946 (let ((modified (buffer-modified-p))
947 (recent-save (recent-auto-save-p)))
948 (or (eq (selected-window) (minibuffer-window))
950 (unless (eq last-command 'undo)
951 (if (if transient-mark-mode mark-active (and arg (not (numberp arg))))
952 (undo-start (region-beginning) (region-end))
954 ;; get rid of initial undo boundary
957 (if (or transient-mark-mode (numberp arg))
958 (prefix-numeric-value arg)
960 ;; Don't specify a position in the undo record for the undo command.
961 ;; Instead, undoing this should move point to where the change is.
962 (let ((tail buffer-undo-list)
964 (while (and tail (not done) (not (null (car tail))))
965 (if (integerp (car tail))
968 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
969 (setq tail (cdr tail))))
970 (and modified (not (buffer-modified-p))
971 (delete-auto-save-file-if-necessary recent-save)))
972 ;; If we do get all the way thru, make this-command indicate that.
973 (setq this-command 'undo))
975 (defvar pending-undo-list nil
976 "Within a run of consecutive undo commands, list remaining to be undone.")
978 (defvar undo-in-progress nil
979 "Non-nil while performing an undo.
980 Some change-hooks test this variable to do something different.")
982 (defun undo-more (count)
983 "Undo back N undo-boundaries beyond what was already undone recently.
984 Call `undo-start' to get ready to undo recent changes,
985 then call `undo-more' one or more times to undo them."
986 (or pending-undo-list
987 (error "No further undo information"))
988 (let ((undo-in-progress t))
989 (setq pending-undo-list (primitive-undo count pending-undo-list))))
991 ;; Deep copy of a list
992 (defun undo-copy-list (list)
993 "Make a copy of undo list LIST."
994 (mapcar 'undo-copy-list-1 list))
996 (defun undo-copy-list-1 (elt)
998 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1001 (defun undo-start (&optional beg end)
1002 "Set `pending-undo-list' to the front of the undo list.
1003 The next call to `undo-more' will undo the most recently made change.
1004 If BEG and END are specified, then only undo elements
1005 that apply to text between BEG and END are used; other undo elements
1006 are ignored. If BEG and END are nil, all undo elements are used."
1007 (if (eq buffer-undo-list t)
1008 (error "No undo information in this buffer"))
1009 (setq pending-undo-list
1010 (if (and beg end (not (= beg end)))
1011 (undo-make-selective-list (min beg end) (max beg end))
1014 (defvar undo-adjusted-markers)
1016 (defun undo-make-selective-list (start end)
1017 "Return a list of undo elements for the region START to END.
1018 The elements come from `buffer-undo-list', but we keep only
1019 the elements inside this region, and discard those outside this region.
1020 If we find an element that crosses an edge of this region,
1021 we stop and ignore all further elements."
1022 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1023 (undo-list (list nil))
1024 undo-adjusted-markers
1026 undo-elt undo-elt temp-undo-list delta)
1027 (while undo-list-copy
1028 (setq undo-elt (car undo-list-copy))
1030 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1031 ;; This is a "was unmodified" element.
1032 ;; Keep it if we have kept everything thus far.
1033 (not some-rejected))
1035 (undo-elt-in-region undo-elt start end)))))
1038 (setq end (+ end (cdr (undo-delta undo-elt))))
1039 ;; Don't put two nils together in the list
1040 (if (not (and (eq (car undo-list) nil)
1042 (setq undo-list (cons undo-elt undo-list))))
1043 (if (undo-elt-crosses-region undo-elt start end)
1044 (setq undo-list-copy nil)
1045 (setq some-rejected t)
1046 (setq temp-undo-list (cdr undo-list-copy))
1047 (setq delta (undo-delta undo-elt))
1049 (when (/= (cdr delta) 0)
1050 (let ((position (car delta))
1051 (offset (cdr delta)))
1053 ;; Loop down the earlier events adjusting their buffer positions
1054 ;; to reflect the fact that a change to the buffer isn't being
1055 ;; undone. We only need to process those element types which
1056 ;; undo-elt-in-region will return as being in the region since
1057 ;; only those types can ever get into the output
1059 (while temp-undo-list
1060 (setq undo-elt (car temp-undo-list))
1061 (cond ((integerp undo-elt)
1062 (if (>= undo-elt position)
1063 (setcar temp-undo-list (- undo-elt offset))))
1064 ((atom undo-elt) nil)
1065 ((stringp (car undo-elt))
1066 ;; (TEXT . POSITION)
1067 (let ((text-pos (abs (cdr undo-elt)))
1068 (point-at-end (< (cdr undo-elt) 0 )))
1069 (if (>= text-pos position)
1070 (setcdr undo-elt (* (if point-at-end -1 1)
1071 (- text-pos offset))))))
1072 ((integerp (car undo-elt))
1074 (when (>= (car undo-elt) position)
1075 (setcar undo-elt (- (car undo-elt) offset))
1076 (setcdr undo-elt (- (cdr undo-elt) offset))))
1077 ((null (car undo-elt))
1078 ;; (nil PROPERTY VALUE BEG . END)
1079 (let ((tail (nthcdr 3 undo-elt)))
1080 (when (>= (car tail) position)
1081 (setcar tail (- (car tail) offset))
1082 (setcdr tail (- (cdr tail) offset))))))
1083 (setq temp-undo-list (cdr temp-undo-list))))))))
1084 (setq undo-list-copy (cdr undo-list-copy)))
1085 (nreverse undo-list)))
1087 (defun undo-elt-in-region (undo-elt start end)
1088 "Determine whether UNDO-ELT falls inside the region START ... END.
1089 If it crosses the edge, we return nil."
1090 (cond ((integerp undo-elt)
1091 (and (>= undo-elt start)
1097 ((stringp (car undo-elt))
1098 ;; (TEXT . POSITION)
1099 (and (>= (abs (cdr undo-elt)) start)
1100 (< (abs (cdr undo-elt)) end)))
1101 ((and (consp undo-elt) (markerp (car undo-elt)))
1102 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1103 ;; See if MARKER is inside the region.
1104 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1106 (setq alist-elt (cons (car undo-elt)
1107 (marker-position (car undo-elt))))
1108 (setq undo-adjusted-markers
1109 (cons alist-elt undo-adjusted-markers)))
1110 (and (cdr alist-elt)
1111 (>= (cdr alist-elt) start)
1112 (< (cdr alist-elt) end))))
1113 ((null (car undo-elt))
1114 ;; (nil PROPERTY VALUE BEG . END)
1115 (let ((tail (nthcdr 3 undo-elt)))
1116 (and (>= (car tail) start)
1117 (< (cdr tail) end))))
1118 ((integerp (car undo-elt))
1120 (and (>= (car undo-elt) start)
1121 (< (cdr undo-elt) end)))))
1123 (defun undo-elt-crosses-region (undo-elt start end)
1124 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1125 This assumes we have already decided that UNDO-ELT
1126 is not *inside* the region START...END."
1127 (cond ((atom undo-elt) nil)
1128 ((null (car undo-elt))
1129 ;; (nil PROPERTY VALUE BEG . END)
1130 (let ((tail (nthcdr 3 undo-elt)))
1131 (not (or (< (car tail) end)
1132 (> (cdr tail) start)))))
1133 ((integerp (car undo-elt))
1135 (not (or (< (car undo-elt) end)
1136 (> (cdr undo-elt) start))))))
1138 ;; Return the first affected buffer position and the delta for an undo element
1139 ;; delta is defined as the change in subsequent buffer positions if we *did*
1141 (defun undo-delta (undo-elt)
1142 (if (consp undo-elt)
1143 (cond ((stringp (car undo-elt))
1144 ;; (TEXT . POSITION)
1145 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1146 ((integerp (car undo-elt))
1148 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1153 (defvar shell-command-history nil
1154 "History list for some commands that read shell commands.")
1156 (defvar shell-command-switch "-c"
1157 "Switch used to have the shell execute its command line argument.")
1159 (defvar shell-command-default-error-buffer nil
1160 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1161 This buffer is used when `shell-command' or 'shell-command-on-region'
1162 is run interactively. A value of nil means that output to stderr and
1163 stdout will be intermixed in the output stream.")
1165 (defun shell-command (command &optional output-buffer error-buffer)
1166 "Execute string COMMAND in inferior shell; display output, if any.
1167 With prefix argument, insert the COMMAND's output at point.
1169 If COMMAND ends in ampersand, execute it asynchronously.
1170 The output appears in the buffer `*Async Shell Command*'.
1171 That buffer is in shell mode.
1173 Otherwise, COMMAND is executed synchronously. The output appears in
1174 the buffer `*Shell Command Output*'. If the output is short enough to
1175 display in the echo area (which is determined by the variables
1176 `resize-mini-windows' and `max-mini-window-height'), it is shown
1177 there, but it is nonetheless available in buffer `*Shell Command
1178 Output*' even though that buffer is not automatically displayed. If
1179 there is no output, or if output is inserted in the current buffer,
1180 then `*Shell Command Output*' is deleted.
1182 To specify a coding system for converting non-ASCII characters
1183 in the shell command output, use \\[universal-coding-system-argument]
1184 before this command.
1186 Noninteractive callers can specify coding systems by binding
1187 `coding-system-for-read' and `coding-system-for-write'.
1189 The optional second argument OUTPUT-BUFFER, if non-nil,
1190 says to put the output in some other buffer.
1191 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1192 If OUTPUT-BUFFER is not a buffer and not nil,
1193 insert output in current buffer. (This cannot be done asynchronously.)
1194 In either case, the output is inserted after point (leaving mark after it).
1196 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1197 or buffer name to which to direct the command's standard error output.
1198 If it is nil, error output is mingled with regular output.
1199 In an interactive call, the variable `shell-command-default-error-buffer'
1200 specifies the value of ERROR-BUFFER."
1202 (interactive (list (read-from-minibuffer "Shell command: "
1203 nil nil nil 'shell-command-history)
1205 shell-command-default-error-buffer))
1206 ;; Look for a handler in case default-directory is a remote file name.
1208 (find-file-name-handler (directory-file-name default-directory)
1211 (funcall handler 'shell-command command output-buffer error-buffer)
1212 (if (and output-buffer
1213 (not (or (bufferp output-buffer) (stringp output-buffer))))
1217 (expand-file-name "scor"
1218 (or small-temporary-file-directory
1219 temporary-file-directory)))
1221 (barf-if-buffer-read-only)
1223 ;; We do not use -f for csh; we will not support broken use of
1224 ;; .cshrcs. Even the BSD csh manual says to use
1225 ;; "if ($?prompt) exit" before things which are not useful
1226 ;; non-interactively. Besides, if someone wants their other
1227 ;; aliases for shell commands then they can still have them.
1228 (call-process shell-file-name nil
1232 nil shell-command-switch command)
1233 (when (and error-file (file-exists-p error-file))
1234 (if (< 0 (nth 7 (file-attributes error-file)))
1235 (with-current-buffer (get-buffer-create error-buffer)
1236 (let ((pos-from-end (- (point-max) (point))))
1239 ;; Do no formatting while reading error file,
1240 ;; because that can run a shell command, and we
1241 ;; don't want that to cause an infinite recursion.
1242 (format-insert-file error-file nil)
1243 ;; Put point after the inserted errors.
1244 (goto-char (- (point-max) pos-from-end)))
1245 (display-buffer (current-buffer))))
1246 (delete-file error-file))
1247 ;; This is like exchange-point-and-mark, but doesn't
1248 ;; activate the mark. It is cleaner to avoid activation,
1249 ;; even though the command loop would deactivate the mark
1250 ;; because we inserted text.
1251 (goto-char (prog1 (mark t)
1252 (set-marker (mark-marker) (point)
1253 (current-buffer)))))
1254 ;; Preserve the match data in case called from a program.
1256 (if (string-match "[ \t]*&[ \t]*$" command)
1257 ;; Command ending with ampersand means asynchronous.
1258 (let ((buffer (get-buffer-create
1259 (or output-buffer "*Async Shell Command*")))
1260 (directory default-directory)
1262 ;; Remove the ampersand.
1263 (setq command (substring command 0 (match-beginning 0)))
1264 ;; If will kill a process, query first.
1265 (setq proc (get-buffer-process buffer))
1267 (if (yes-or-no-p "A command is running. Kill it? ")
1269 (error "Shell command in progress")))
1272 (setq buffer-read-only nil)
1274 (display-buffer buffer)
1275 (setq default-directory directory)
1276 (setq proc (start-process "Shell" buffer shell-file-name
1277 shell-command-switch command))
1278 (setq mode-line-process '(":%s"))
1279 (require 'shell) (shell-mode)
1280 (set-process-sentinel proc 'shell-command-sentinel)
1282 (shell-command-on-region (point) (point) command
1283 output-buffer nil error-buffer)))))))
1285 (defun display-message-or-buffer (message
1286 &optional buffer-name not-this-window frame)
1287 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1288 MESSAGE may be either a string or a buffer.
1290 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1291 the maximum height of the echo area, as defined by `max-mini-window-height'
1292 if `resize-mini-windows' is non-nil.
1294 Returns either the string shown in the echo area, or when a pop-up
1295 buffer is used, the window used to display it.
1297 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1298 name of the buffer used to display it in the case where a pop-up buffer
1299 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1300 string and it is displayed in the echo area, it is not specified whether
1301 the contents are inserted into the buffer anyway.
1303 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1304 and only used if a buffer is displayed."
1305 (cond ((and (stringp message) (not (string-match "\n" message)))
1306 ;; Trivial case where we can use the echo area
1307 (message "%s" message))
1308 ((and (stringp message)
1309 (= (string-match "\n" message) (1- (length message))))
1310 ;; Trivial case where we can just remove single trailing newline
1311 (message "%s" (substring message 0 (1- (length message)))))
1314 (with-current-buffer
1315 (if (bufferp message)
1317 (get-buffer-create (or buffer-name "*Message*")))
1319 (unless (bufferp message)
1324 (if (= (buffer-size) 0)
1326 (count-lines (point-min) (point-max)))))
1327 (cond ((or (<= lines 1)
1329 (if resize-mini-windows
1330 (cond ((floatp max-mini-window-height)
1332 max-mini-window-height))
1333 ((integerp max-mini-window-height)
1334 max-mini-window-height)
1339 (goto-char (point-max))
1342 (message "%s" (buffer-substring (point-min) (point))))
1345 (goto-char (point-min))
1346 (display-buffer message not-this-window frame))))))))
1349 ;; We have a sentinel to prevent insertion of a termination message
1350 ;; in the buffer itself.
1351 (defun shell-command-sentinel (process signal)
1352 (if (memq (process-status process) '(exit signal))
1354 (car (cdr (cdr (process-command process))))
1355 (substring signal 0 -1))))
1357 (defun shell-command-on-region (start end command
1358 &optional output-buffer replace
1360 "Execute string COMMAND in inferior shell with region as input.
1361 Normally display output (if any) in temp buffer `*Shell Command Output*';
1362 Prefix arg means replace the region with it. Return the exit code of
1365 To specify a coding system for converting non-ASCII characters
1366 in the input and output to the shell command, use \\[universal-coding-system-argument]
1367 before this command. By default, the input (from the current buffer)
1368 is encoded in the same coding system that will be used to save the file,
1369 `buffer-file-coding-system'. If the output is going to replace the region,
1370 then it is decoded from that same coding system.
1372 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1373 REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1374 systems by binding `coding-system-for-read' and
1375 `coding-system-for-write'.
1377 If the output is short enough to display in the echo area (which is
1378 determined by the variable `max-mini-window-height' if
1379 `resize-mini-windows' is non-nil), it is shown there, but it is
1380 nonetheless available in buffer `*Shell Command Output*' even though
1381 that buffer is not automatically displayed. If there is no output, or
1382 if output is inserted in the current buffer, then `*Shell Command
1383 Output*' is deleted.
1385 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1386 that says to put the output in some other buffer.
1387 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1388 If OUTPUT-BUFFER is not a buffer and not nil,
1389 insert output in the current buffer.
1390 In either case, the output is inserted after point (leaving mark after it).
1392 If REPLACE, the optional fifth argument, is non-nil, that means insert
1393 the output in place of text from START to END, putting point and mark
1396 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1397 or buffer name to which to direct the command's standard error output.
1398 If it is nil, error output is mingled with regular output.
1399 In an interactive call, the variable `shell-command-default-error-buffer'
1400 specifies the value of ERROR-BUFFER."
1401 (interactive (let ((string
1402 ;; Do this before calling region-beginning
1403 ;; and region-end, in case subprocess output
1404 ;; relocates them while we are in the minibuffer.
1405 (read-from-minibuffer "Shell command on region: "
1407 'shell-command-history)))
1408 ;; call-interactively recognizes region-beginning and
1409 ;; region-end specially, leaving them in the history.
1410 (list (region-beginning) (region-end)
1414 shell-command-default-error-buffer)))
1418 (expand-file-name "scor"
1419 (or small-temporary-file-directory
1420 temporary-file-directory)))
1425 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1426 ;; Replace specified region with output from command.
1427 (let ((swap (and replace (< start end))))
1428 ;; Don't muck with mark unless REPLACE says we should.
1430 (and replace (push-mark))
1432 (call-process-region start end shell-file-name t
1436 nil shell-command-switch command))
1437 ;;; It is rude to delete a buffer which the command is not using.
1438 ;;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1439 ;;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
1440 ;;; (kill-buffer shell-buffer)))
1441 ;; Don't muck with mark unless REPLACE says we should.
1442 (and replace swap (exchange-point-and-mark)))
1443 ;; No prefix argument: put the output in a temp buffer,
1444 ;; replacing its entire contents.
1445 (let ((buffer (get-buffer-create
1446 (or output-buffer "*Shell Command Output*")))
1449 (if (eq buffer (current-buffer))
1450 ;; If the input is the same buffer as the output,
1451 ;; delete everything but the specified region,
1452 ;; then replace that region with the output.
1453 (progn (setq buffer-read-only nil)
1454 (delete-region (max start end) (point-max))
1455 (delete-region (point-min) (min start end))
1457 (call-process-region (point-min) (point-max)
1462 nil shell-command-switch
1464 ;; Clear the output buffer, then run the command with
1466 (let ((directory default-directory))
1469 (setq buffer-read-only nil)
1470 (if (not output-buffer)
1471 (setq default-directory directory))
1474 (call-process-region start end shell-file-name nil
1476 (list buffer error-file)
1478 nil shell-command-switch command)))
1479 (setq success (and exit-status (equal 0 exit-status)))
1480 ;; Report the amount of output.
1481 (if (with-current-buffer buffer (> (point-max) (point-min)))
1482 ;; There's some output, display it
1483 (display-message-or-buffer buffer)
1484 ;; No output; error?
1485 (message (if (and error-file
1486 (< 0 (nth 7 (file-attributes error-file))))
1487 "(Shell command %sed with some error output)"
1488 "(Shell command %sed with no output)")
1489 (if (equal 0 exit-status) "succeed" "fail"))))))
1491 (when (and error-file (file-exists-p error-file))
1492 (if (< 0 (nth 7 (file-attributes error-file)))
1493 (with-current-buffer (get-buffer-create error-buffer)
1494 (let ((pos-from-end (- (point-max) (point))))
1497 ;; Do no formatting while reading error file,
1498 ;; because that can run a shell command, and we
1499 ;; don't want that to cause an infinite recursion.
1500 (format-insert-file error-file nil)
1501 ;; Put point after the inserted errors.
1502 (goto-char (- (point-max) pos-from-end)))
1503 (display-buffer (current-buffer))))
1504 (delete-file error-file))
1507 (defun shell-command-to-string (command)
1508 "Execute shell command COMMAND and return its output as a string."
1509 (with-output-to-string
1510 (with-current-buffer
1512 (call-process shell-file-name nil t nil shell-command-switch command))))
1514 (defvar universal-argument-map
1515 (let ((map (make-sparse-keymap)))
1516 (define-key map [t] 'universal-argument-other-key)
1517 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1518 (define-key map [switch-frame] nil)
1519 (define-key map [?\C-u] 'universal-argument-more)
1520 (define-key map [?-] 'universal-argument-minus)
1521 (define-key map [?0] 'digit-argument)
1522 (define-key map [?1] 'digit-argument)
1523 (define-key map [?2] 'digit-argument)
1524 (define-key map [?3] 'digit-argument)
1525 (define-key map [?4] 'digit-argument)
1526 (define-key map [?5] 'digit-argument)
1527 (define-key map [?6] 'digit-argument)
1528 (define-key map [?7] 'digit-argument)
1529 (define-key map [?8] 'digit-argument)
1530 (define-key map [?9] 'digit-argument)
1531 (define-key map [kp-0] 'digit-argument)
1532 (define-key map [kp-1] 'digit-argument)
1533 (define-key map [kp-2] 'digit-argument)
1534 (define-key map [kp-3] 'digit-argument)
1535 (define-key map [kp-4] 'digit-argument)
1536 (define-key map [kp-5] 'digit-argument)
1537 (define-key map [kp-6] 'digit-argument)
1538 (define-key map [kp-7] 'digit-argument)
1539 (define-key map [kp-8] 'digit-argument)
1540 (define-key map [kp-9] 'digit-argument)
1541 (define-key map [kp-subtract] 'universal-argument-minus)
1543 "Keymap used while processing \\[universal-argument].")
1545 (defvar universal-argument-num-events nil
1546 "Number of argument-specifying events read by `universal-argument'.
1547 `universal-argument-other-key' uses this to discard those events
1548 from (this-command-keys), and reread only the final command.")
1550 (defun universal-argument ()
1551 "Begin a numeric argument for the following command.
1552 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1553 \\[universal-argument] following the digits or minus sign ends the argument.
1554 \\[universal-argument] without digits or minus sign provides 4 as argument.
1555 Repeating \\[universal-argument] without digits or minus sign
1556 multiplies the argument by 4 each time.
1557 For some commands, just \\[universal-argument] by itself serves as a flag
1558 which is different in effect from any particular numeric argument.
1559 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1561 (setq prefix-arg (list 4))
1562 (setq universal-argument-num-events (length (this-command-keys)))
1563 (setq overriding-terminal-local-map universal-argument-map))
1565 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1566 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1567 (defun universal-argument-more (arg)
1570 (setq prefix-arg (list (* 4 (car arg))))
1572 (setq prefix-arg (list -4))
1573 (setq prefix-arg arg)
1574 (setq overriding-terminal-local-map nil)))
1575 (setq universal-argument-num-events (length (this-command-keys))))
1577 (defun negative-argument (arg)
1578 "Begin a negative numeric argument for the next command.
1579 \\[universal-argument] following digits or minus sign ends the argument."
1581 (cond ((integerp arg)
1582 (setq prefix-arg (- arg)))
1584 (setq prefix-arg nil))
1586 (setq prefix-arg '-)))
1587 (setq universal-argument-num-events (length (this-command-keys)))
1588 (setq overriding-terminal-local-map universal-argument-map))
1590 (defun digit-argument (arg)
1591 "Part of the numeric argument for the next command.
1592 \\[universal-argument] following digits or minus sign ends the argument."
1594 (let* ((char (if (integerp last-command-char)
1596 (get last-command-char 'ascii-character)))
1597 (digit (- (logand char ?\177) ?0)))
1598 (cond ((integerp arg)
1599 (setq prefix-arg (+ (* arg 10)
1600 (if (< arg 0) (- digit) digit))))
1602 ;; Treat -0 as just -, so that -01 will work.
1603 (setq prefix-arg (if (zerop digit) '- (- digit))))
1605 (setq prefix-arg digit))))
1606 (setq universal-argument-num-events (length (this-command-keys)))
1607 (setq overriding-terminal-local-map universal-argument-map))
1609 ;; For backward compatibility, minus with no modifiers is an ordinary
1610 ;; command if digits have already been entered.
1611 (defun universal-argument-minus (arg)
1614 (universal-argument-other-key arg)
1615 (negative-argument arg)))
1617 ;; Anything else terminates the argument and is left in the queue to be
1618 ;; executed as a command.
1619 (defun universal-argument-other-key (arg)
1621 (setq prefix-arg arg)
1622 (let* ((key (this-command-keys))
1623 (keylist (listify-key-sequence key)))
1624 (setq unread-command-events
1625 (append (nthcdr universal-argument-num-events keylist)
1626 unread-command-events)))
1627 (reset-this-command-lengths)
1628 (setq overriding-terminal-local-map nil))
1630 ;;;; Window system cut and paste hooks.
1632 (defvar interprogram-cut-function nil
1633 "Function to call to make a killed region available to other programs.
1635 Most window systems provide some sort of facility for cutting and
1636 pasting text between the windows of different programs.
1637 This variable holds a function that Emacs calls whenever text
1638 is put in the kill ring, to make the new kill available to other
1641 The function takes one or two arguments.
1642 The first argument, TEXT, is a string containing
1643 the text which should be made available.
1644 The second, PUSH, if non-nil means this is a \"new\" kill;
1645 nil means appending to an \"old\" kill.")
1647 (defvar interprogram-paste-function nil
1648 "Function to call to get text cut from other programs.
1650 Most window systems provide some sort of facility for cutting and
1651 pasting text between the windows of different programs.
1652 This variable holds a function that Emacs calls to obtain
1653 text that other programs have provided for pasting.
1655 The function should be called with no arguments. If the function
1656 returns nil, then no other program has provided such text, and the top
1657 of the Emacs kill ring should be used. If the function returns a
1658 string, that string should be put in the kill ring as the latest kill.
1660 Note that the function should return a string only if a program other
1661 than Emacs has provided a string for pasting; if Emacs provided the
1662 most recent string, the function should return nil. If it is
1663 difficult to tell whether Emacs or some other program provided the
1664 current string, it is probably good enough to return nil if the string
1665 is equal (according to `string=') to the last text Emacs provided.")
1669 ;;;; The kill ring data structure.
1671 (defvar kill-ring nil
1672 "List of killed text sequences.
1673 Since the kill ring is supposed to interact nicely with cut-and-paste
1674 facilities offered by window systems, use of this variable should
1675 interact nicely with `interprogram-cut-function' and
1676 `interprogram-paste-function'. The functions `kill-new',
1677 `kill-append', and `current-kill' are supposed to implement this
1678 interaction; you may want to use them instead of manipulating the kill
1681 (defcustom kill-ring-max 60
1682 "*Maximum length of kill ring before oldest elements are thrown away."
1686 (defvar kill-ring-yank-pointer nil
1687 "The tail of the kill ring whose car is the last thing yanked.")
1689 (defun kill-new (string &optional replace)
1690 "Make STRING the latest kill in the kill ring.
1691 Set the kill-ring-yank pointer to point to it.
1692 If `interprogram-cut-function' is non-nil, apply it to STRING.
1693 Optional second argument REPLACE non-nil means that STRING will replace
1694 the front of the kill ring, rather than being added to the list."
1695 (and (fboundp 'menu-bar-update-yank-menu)
1696 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1697 (if (and replace kill-ring)
1698 (setcar kill-ring string)
1699 (setq kill-ring (cons string kill-ring))
1700 (if (> (length kill-ring) kill-ring-max)
1701 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1702 (setq kill-ring-yank-pointer kill-ring)
1703 (if interprogram-cut-function
1704 (funcall interprogram-cut-function string (not replace))))
1706 (defun kill-append (string before-p)
1707 "Append STRING to the end of the latest kill in the kill ring.
1708 If BEFORE-P is non-nil, prepend STRING to the kill.
1709 If `interprogram-cut-function' is set, pass the resulting kill to
1711 (kill-new (if before-p
1712 (concat string (car kill-ring))
1713 (concat (car kill-ring) string)) t))
1715 (defun current-kill (n &optional do-not-move)
1716 "Rotate the yanking point by N places, and then return that kill.
1717 If N is zero, `interprogram-paste-function' is set, and calling it
1718 returns a string, then that string is added to the front of the
1719 kill ring and returned as the latest kill.
1720 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1721 yanking point; just return the Nth kill forward."
1722 (let ((interprogram-paste (and (= n 0)
1723 interprogram-paste-function
1724 (funcall interprogram-paste-function))))
1725 (if interprogram-paste
1727 ;; Disable the interprogram cut function when we add the new
1728 ;; text to the kill ring, so Emacs doesn't try to own the
1729 ;; selection, with identical text.
1730 (let ((interprogram-cut-function nil))
1731 (kill-new interprogram-paste))
1733 (or kill-ring (error "Kill ring is empty"))
1734 (let ((ARGth-kill-element
1735 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1739 (setq kill-ring-yank-pointer ARGth-kill-element))
1740 (car ARGth-kill-element)))))
1744 ;;;; Commands for manipulating the kill ring.
1746 (defcustom kill-read-only-ok nil
1747 "*Non-nil means don't signal an error for killing read-only text."
1751 (put 'text-read-only 'error-conditions
1752 '(text-read-only buffer-read-only error))
1753 (put 'text-read-only 'error-message "Text is read-only")
1755 (defun kill-region (beg end)
1756 "Kill between point and mark.
1757 The text is deleted but saved in the kill ring.
1758 The command \\[yank] can retrieve it from there.
1759 \(If you want to kill and then yank immediately, use \\[kill-ring-save].)
1761 If you want to append the killed region to the last killed text,
1762 use \\[append-next-kill] before \\[kill-region].
1764 If the buffer is read-only, Emacs will beep and refrain from deleting
1765 the text, but put the text in the kill ring anyway. This means that
1766 you can use the killing commands to copy text from a read-only buffer.
1768 This is the primitive for programs to kill text (as opposed to deleting it).
1769 Supply two arguments, character numbers indicating the stretch of text
1771 Any command that calls this function is a \"kill command\".
1772 If the previous command was also a kill command,
1773 the text killed this time appends to the text killed last time
1774 to make one entry in the kill ring."
1777 (let ((string (delete-and-extract-region beg end)))
1778 (when string ;STRING is nil if BEG = END
1779 ;; Add that string to the kill ring, one way or another.
1780 (if (eq last-command 'kill-region)
1781 (kill-append string (< end beg))
1783 (setq this-command 'kill-region))
1784 ((buffer-read-only text-read-only)
1785 ;; The code above failed because the buffer, or some of the characters
1786 ;; in the region, are read-only.
1787 ;; We should beep, in case the user just isn't aware of this.
1788 ;; However, there's no harm in putting
1789 ;; the region's text in the kill ring, anyway.
1790 (copy-region-as-kill beg end)
1791 ;; Set this-command now, so it will be set even if we get an error.
1792 (setq this-command 'kill-region)
1793 ;; This should barf, if appropriate, and give us the correct error.
1794 (if kill-read-only-ok
1795 (message "Read only text copied to kill ring")
1796 ;; Signal an error if the buffer is read-only.
1797 (barf-if-buffer-read-only)
1798 ;; If the buffer isn't read-only, the text is.
1799 (signal 'text-read-only (list (current-buffer)))))))
1801 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1802 ;; to get two copies of the text when the user accidentally types M-w and
1803 ;; then corrects it with the intended C-w.
1804 (defun copy-region-as-kill (beg end)
1805 "Save the region as if killed, but don't kill it.
1806 In Transient Mark mode, deactivate the mark.
1807 If `interprogram-cut-function' is non-nil, also save the text for a window
1808 system cut and paste."
1810 (if (eq last-command 'kill-region)
1811 (kill-append (buffer-substring beg end) (< end beg))
1812 (kill-new (buffer-substring beg end)))
1813 (if transient-mark-mode
1814 (setq deactivate-mark t))
1817 (defun kill-ring-save (beg end)
1818 "Save the region as if killed, but don't kill it.
1819 In Transient Mark mode, deactivate the mark.
1820 If `interprogram-cut-function' is non-nil, also save the text for a window
1821 system cut and paste.
1823 If you want to append the killed line to the last killed text,
1824 use \\[append-next-kill] before \\[kill-ring-save].
1826 This command is similar to `copy-region-as-kill', except that it gives
1827 visual feedback indicating the extent of the region being copied."
1829 (copy-region-as-kill beg end)
1831 (let ((other-end (if (= (point) beg) end beg))
1833 ;; Inhibit quitting so we can make a quit here
1834 ;; look like a C-g typed as a command.
1836 (if (pos-visible-in-window-p other-end (selected-window))
1838 ;; Swap point and mark.
1839 (set-marker (mark-marker) (point) (current-buffer))
1840 (goto-char other-end)
1843 (set-marker (mark-marker) other-end (current-buffer))
1845 ;; If user quit, deactivate the mark
1846 ;; as C-g would as a command.
1847 (and quit-flag mark-active
1849 (let* ((killed-text (current-kill 0))
1850 (message-len (min (length killed-text) 40)))
1852 ;; Don't say "killed"; that is misleading.
1853 (message "Saved text until \"%s\""
1854 (substring killed-text (- message-len)))
1855 (message "Saved text from \"%s\""
1856 (substring killed-text 0 message-len))))))))
1858 (defun append-next-kill (&optional interactive)
1859 "Cause following command, if it kills, to append to previous kill.
1860 The argument is used for internal purposes; do not supply one."
1862 ;; We don't use (interactive-p), since that breaks kbd macros.
1865 (setq this-command 'kill-region)
1866 (message "If the next command is a kill, it will append"))
1867 (setq last-command 'kill-region)))
1871 (defun yank-pop (arg)
1872 "Replace just-yanked stretch of killed text with a different stretch.
1873 This command is allowed only immediately after a `yank' or a `yank-pop'.
1874 At such a time, the region contains a stretch of reinserted
1875 previously-killed text. `yank-pop' deletes that text and inserts in its
1876 place a different stretch of killed text.
1878 With no argument, the previous kill is inserted.
1879 With argument N, insert the Nth previous kill.
1880 If N is negative, this is a more recent kill.
1882 The sequence of kills wraps around, so that after the oldest one
1883 comes the newest one."
1885 (if (not (eq last-command 'yank))
1886 (error "Previous command was not a yank"))
1887 (setq this-command 'yank)
1888 (let ((inhibit-read-only t)
1889 (before (< (point) (mark t))))
1890 (delete-region (point) (mark t))
1891 (set-marker (mark-marker) (point) (current-buffer))
1892 (let ((opoint (point)))
1893 (insert (current-kill arg))
1894 (let ((inhibit-read-only t))
1895 (remove-text-properties opoint (point) '(read-only nil))))
1897 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1898 ;; It is cleaner to avoid activation, even though the command
1899 ;; loop would deactivate the mark because we inserted text.
1900 (goto-char (prog1 (mark t)
1901 (set-marker (mark-marker) (point) (current-buffer))))))
1904 (defun yank (&optional arg)
1905 "Reinsert the last stretch of killed text.
1906 More precisely, reinsert the stretch of killed text most recently
1907 killed OR yanked. Put point at end, and set mark at beginning.
1908 With just C-u as argument, same but put point at beginning (and mark at end).
1909 With argument N, reinsert the Nth most recently killed stretch of killed
1911 See also the command \\[yank-pop]."
1913 ;; If we don't get all the way thru, make last-command indicate that
1914 ;; for the following command.
1915 (setq this-command t)
1917 (let ((opoint (point)))
1918 (insert (current-kill (cond
1922 (let ((inhibit-read-only t))
1923 (remove-text-properties opoint (point) '(read-only nil))))
1925 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1926 ;; It is cleaner to avoid activation, even though the command
1927 ;; loop would deactivate the mark because we inserted text.
1928 (goto-char (prog1 (mark t)
1929 (set-marker (mark-marker) (point) (current-buffer)))))
1930 ;; If we do get all the way thru, make this-command indicate that.
1931 (setq this-command 'yank)
1934 (defun rotate-yank-pointer (arg)
1935 "Rotate the yanking point in the kill ring.
1936 With argument, rotate that many kills forward (or backward, if negative)."
1940 ;; Some kill commands.
1942 ;; Internal subroutine of delete-char
1943 (defun kill-forward-chars (arg)
1944 (if (listp arg) (setq arg (car arg)))
1945 (if (eq arg '-) (setq arg -1))
1946 (kill-region (point) (forward-point arg)))
1948 ;; Internal subroutine of backward-delete-char
1949 (defun kill-backward-chars (arg)
1950 (if (listp arg) (setq arg (car arg)))
1951 (if (eq arg '-) (setq arg -1))
1952 (kill-region (point) (forward-point (- arg))))
1954 (defcustom backward-delete-char-untabify-method 'untabify
1955 "*The method for untabifying when deleting backward.
1956 Can be `untabify' -- turn a tab to many spaces, then delete one space;
1957 `hungry' -- delete all whitespace, both tabs and spaces;
1958 `all' -- delete all whitespace, including tabs, spaces and newlines;
1959 nil -- just delete one character."
1960 :type '(choice (const untabify) (const hungry) (const all) (const nil))
1964 (defun backward-delete-char-untabify (arg &optional killp)
1965 "Delete characters backward, changing tabs into spaces.
1966 The exact behavior depends on `backward-delete-char-untabify-method'.
1967 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
1968 Interactively, ARG is the prefix arg (default 1)
1969 and KILLP is t if a prefix arg was specified."
1970 (interactive "*p\nP")
1971 (when (eq backward-delete-char-untabify-method 'untabify)
1974 (while (and (> count 0) (not (bobp)))
1975 (if (= (preceding-char) ?\t)
1976 (let ((col (current-column)))
1978 (setq col (- col (current-column)))
1979 (insert-char ?\ col)
1982 (setq count (1- count))))))
1983 (delete-backward-char
1984 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1985 ((eq backward-delete-char-untabify-method 'all)
1988 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
1990 (+ arg (if (zerop wh) 0 (1- wh))))
1994 (defun zap-to-char (arg char)
1995 "Kill up to and including ARG'th occurrence of CHAR.
1996 Case is ignored if `case-fold-search' is non-nil in the current buffer.
1997 Goes backward if ARG is negative; error if CHAR not found."
1998 (interactive "p\ncZap to char: ")
1999 (kill-region (point) (progn
2000 (search-forward (char-to-string char) nil nil arg)
2001 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2004 ;; kill-line and its subroutines.
2006 (defcustom kill-whole-line nil
2007 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2011 (defun kill-line (&optional arg)
2012 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2013 With prefix argument, kill that many lines from point.
2014 Negative arguments kill lines backward.
2015 With zero argument, kills the text before point on the current line.
2017 When calling from a program, nil means \"no arg\",
2018 a number counts as a prefix arg.
2020 To kill a whole line, when point is not at the beginning, type \
2021 \\[beginning-of-line] \\[kill-line] \\[kill-line].
2023 If `kill-whole-line' is non-nil, then this command kills the whole line
2024 including its terminating newline, when used at the beginning of a line
2025 with no argument. As a consequence, you can always kill a whole line
2026 by typing \\[beginning-of-line] \\[kill-line].
2028 If you want to append the killed line to the last killed text,
2029 use \\[append-next-kill] before \\[kill-line].
2031 If the buffer is read-only, Emacs will beep and refrain from deleting
2032 the line, but put the line in the kill ring anyway. This means that
2033 you can use this command to copy text from a read-only buffer."
2035 (kill-region (point)
2036 ;; It is better to move point to the other end of the kill
2037 ;; before killing. That way, in a read-only buffer, point
2038 ;; moves across the text that is copied to the kill ring.
2039 ;; The choice has no effect on undo now that undo records
2040 ;; the value of point from before the command was run.
2043 (forward-visible-line (prefix-numeric-value arg))
2045 (signal 'end-of-buffer nil))
2046 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
2047 (forward-visible-line 1)
2048 (end-of-visible-line)))
2051 (defun forward-visible-line (arg)
2052 "Move forward by ARG lines, ignoring currently invisible newlines only.
2053 If ARG is negative, move backward -ARG lines.
2054 If ARG is zero, move to the beginning of the current line."
2058 (or (zerop (forward-line 1))
2059 (signal 'end-of-buffer nil))
2060 ;; If the following character is currently invisible,
2061 ;; skip all characters with that same `invisible' property value,
2062 ;; then find the next newline.
2063 (while (and (not (eobp))
2065 (get-char-property (point) 'invisible)))
2066 (if (eq buffer-invisibility-spec t)
2068 (or (memq prop buffer-invisibility-spec)
2069 (assq prop buffer-invisibility-spec)))))
2071 (if (get-text-property (point) 'invisible)
2072 (or (next-single-property-change (point) 'invisible)
2074 (next-overlay-change (point))))
2075 (or (zerop (forward-line 1))
2076 (signal 'end-of-buffer nil)))
2077 (setq arg (1- arg)))
2079 (while (or first (< arg 0))
2082 (or (zerop (forward-line -1))
2083 (signal 'beginning-of-buffer nil)))
2084 (while (and (not (bobp))
2086 (get-char-property (1- (point)) 'invisible)))
2087 (if (eq buffer-invisibility-spec t)
2089 (or (memq prop buffer-invisibility-spec)
2090 (assq prop buffer-invisibility-spec)))))
2092 (if (get-text-property (1- (point)) 'invisible)
2093 (or (previous-single-property-change (point) 'invisible)
2095 (previous-overlay-change (point))))
2096 (or (zerop (forward-line -1))
2097 (signal 'beginning-of-buffer nil)))
2099 (setq arg (1+ arg)))))
2100 ((beginning-of-buffer end-of-buffer)
2103 (defun end-of-visible-line ()
2104 "Move to end of current visible line."
2106 ;; If the following character is currently invisible,
2107 ;; skip all characters with that same `invisible' property value,
2108 ;; then find the next newline.
2109 (while (and (not (eobp))
2111 (get-char-property (point) 'invisible)))
2112 (if (eq buffer-invisibility-spec t)
2114 (or (memq prop buffer-invisibility-spec)
2115 (assq prop buffer-invisibility-spec)))))
2116 (if (get-text-property (point) 'invisible)
2117 (goto-char (next-single-property-change (point) 'invisible))
2118 (goto-char (next-overlay-change (point))))
2121 (defun insert-buffer (buffer)
2122 "Insert after point the contents of BUFFER.
2123 Puts mark after the inserted text.
2124 BUFFER may be a buffer or a buffer name.
2126 This function is meant for the user to run interactively.
2127 Don't call it from programs!"
2131 (barf-if-buffer-read-only)
2132 (read-buffer "Insert buffer: "
2133 (if (eq (selected-window) (next-window (selected-window)))
2134 (other-buffer (current-buffer))
2135 (window-buffer (next-window (selected-window))))
2137 (or (bufferp buffer)
2138 (setq buffer (get-buffer buffer)))
2139 (let (start end newmark)
2143 (setq start (point-min) end (point-max)))
2144 (insert-buffer-substring buffer start end)
2145 (setq newmark (point)))
2146 (push-mark newmark))
2149 (defun append-to-buffer (buffer start end)
2150 "Append to specified buffer the text of the region.
2151 It is inserted into that buffer before its point.
2153 When calling from a program, give three arguments:
2154 BUFFER (or buffer name), START and END.
2155 START and END specify the portion of the current buffer to be copied."
2157 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2158 (region-beginning) (region-end)))
2159 (let ((oldbuf (current-buffer)))
2161 (let* ((append-to (get-buffer-create buffer))
2162 (windows (get-buffer-window-list append-to t t))
2164 (set-buffer append-to)
2165 (setq point (point))
2166 (barf-if-buffer-read-only)
2167 (insert-buffer-substring oldbuf start end)
2168 (dolist (window windows)
2169 (when (= (window-point window) point)
2170 (set-window-point window (point))))))))
2172 (defun prepend-to-buffer (buffer start end)
2173 "Prepend to specified buffer the text of the region.
2174 It is inserted into that buffer after its point.
2176 When calling from a program, give three arguments:
2177 BUFFER (or buffer name), START and END.
2178 START and END specify the portion of the current buffer to be copied."
2179 (interactive "BPrepend to buffer: \nr")
2180 (let ((oldbuf (current-buffer)))
2182 (set-buffer (get-buffer-create buffer))
2183 (barf-if-buffer-read-only)
2185 (insert-buffer-substring oldbuf start end)))))
2187 (defun copy-to-buffer (buffer start end)
2188 "Copy to specified buffer the text of the region.
2189 It is inserted into that buffer, replacing existing text there.
2191 When calling from a program, give three arguments:
2192 BUFFER (or buffer name), START and END.
2193 START and END specify the portion of the current buffer to be copied."
2194 (interactive "BCopy to buffer: \nr")
2195 (let ((oldbuf (current-buffer)))
2197 (set-buffer (get-buffer-create buffer))
2198 (barf-if-buffer-read-only)
2201 (insert-buffer-substring oldbuf start end)))))
2203 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2204 (put 'mark-inactive 'error-message "The mark is not active now")
2206 (defun mark (&optional force)
2207 "Return this buffer's mark value as integer; error if mark inactive.
2208 If optional argument FORCE is non-nil, access the mark value
2209 even if the mark is not currently active, and return nil
2210 if there is no mark at all.
2212 If you are using this in an editing command, you are most likely making
2213 a mistake; see the documentation of `set-mark'."
2214 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2215 (marker-position (mark-marker))
2216 (signal 'mark-inactive nil)))
2218 ;; Many places set mark-active directly, and several of them failed to also
2219 ;; run deactivate-mark-hook. This shorthand should simplify.
2220 (defsubst deactivate-mark ()
2221 "Deactivate the mark by setting `mark-active' to nil.
2222 \(That makes a difference only in Transient Mark mode.)
2223 Also runs the hook `deactivate-mark-hook'."
2224 (if transient-mark-mode
2226 (setq mark-active nil)
2227 (run-hooks 'deactivate-mark-hook))))
2229 (defun set-mark (pos)
2230 "Set this buffer's mark to POS. Don't use this function!
2231 That is to say, don't use this function unless you want
2232 the user to see that the mark has moved, and you want the previous
2233 mark position to be lost.
2235 Normally, when a new mark is set, the old one should go on the stack.
2236 This is why most applications should use push-mark, not set-mark.
2238 Novice Emacs Lisp programmers often try to use the mark for the wrong
2239 purposes. The mark saves a location for the user's convenience.
2240 Most editing commands should not alter the mark.
2241 To remember a location for internal use in the Lisp program,
2242 store it in a Lisp variable. Example:
2244 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2248 (setq mark-active t)
2249 (run-hooks 'activate-mark-hook)
2250 (set-marker (mark-marker) pos (current-buffer)))
2251 ;; Normally we never clear mark-active except in Transient Mark mode.
2252 ;; But when we actually clear out the mark value too,
2253 ;; we must clear mark-active in any mode.
2254 (setq mark-active nil)
2255 (run-hooks 'deactivate-mark-hook)
2256 (set-marker (mark-marker) nil)))
2258 (defvar mark-ring nil
2259 "The list of former marks of the current buffer, most recent first.")
2260 (make-variable-buffer-local 'mark-ring)
2261 (put 'mark-ring 'permanent-local t)
2263 (defcustom mark-ring-max 16
2264 "*Maximum size of mark ring. Start discarding off end if gets this big."
2266 :group 'editing-basics)
2268 (defvar global-mark-ring nil
2269 "The list of saved global marks, most recent first.")
2271 (defcustom global-mark-ring-max 16
2272 "*Maximum size of global mark ring. \
2273 Start discarding off end if gets this big."
2275 :group 'editing-basics)
2277 (defun set-mark-command (arg)
2278 "Set mark at where point is, or jump to mark.
2279 With no prefix argument, set mark, push old mark position on local mark
2280 ring, and push mark on global mark ring.
2281 With argument, jump to mark, and pop a new position for mark off the ring
2282 \(does not affect global mark ring\).
2284 Novice Emacs Lisp programmers often try to use the mark for the wrong
2285 purposes. See the documentation of `set-mark' for more information."
2289 (push-mark nil nil t))
2291 (error "No mark set in this buffer")
2292 (goto-char (mark t))
2295 (defun push-mark (&optional location nomsg activate)
2296 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
2297 If the last global mark pushed was not in the current buffer,
2298 also push LOCATION on the global mark ring.
2299 Display `Mark set' unless the optional second arg NOMSG is non-nil.
2300 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2302 Novice Emacs Lisp programmers often try to use the mark for the wrong
2303 purposes. See the documentation of `set-mark' for more information.
2305 In Transient Mark mode, this does not activate the mark."
2308 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2309 (if (> (length mark-ring) mark-ring-max)
2311 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2312 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
2313 (set-marker (mark-marker) (or location (point)) (current-buffer))
2314 ;; Now push the mark on the global mark ring.
2315 (if (and global-mark-ring
2316 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
2317 ;; The last global mark pushed was in this same buffer.
2318 ;; Don't push another one.
2320 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
2321 (if (> (length global-mark-ring) global-mark-ring-max)
2323 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2325 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2326 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2327 (message "Mark set"))
2328 (if (or activate (not transient-mark-mode))
2329 (set-mark (mark t)))
2333 "Pop off mark ring into the buffer's actual mark.
2334 Does not set point. Does nothing if mark ring is empty."
2337 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
2338 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
2340 (move-marker (car mark-ring) nil)
2341 (if (null (mark t)) (ding))
2342 (setq mark-ring (cdr mark-ring)))))
2344 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2345 (defun exchange-point-and-mark ()
2346 "Put the mark where point is now, and point where the mark is now.
2347 This command works even when the mark is not active,
2348 and it reactivates the mark."
2350 (let ((omark (mark t)))
2352 (error "No mark set in this buffer"))
2357 (defun transient-mark-mode (arg)
2358 "Toggle Transient Mark mode.
2359 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
2361 In Transient Mark mode, when the mark is active, the region is highlighted.
2362 Changing the buffer \"deactivates\" the mark.
2363 So do certain other operations that set the mark
2364 but whose main purpose is something else--for example,
2365 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
2367 You can also deactivate the mark by typing \\[keyboard-quit] or
2368 \\[keyboard-escape-quit].
2370 Many commands change their behavior when Transient Mark mode is in effect
2371 and the mark is active, by acting on the region instead of their usual
2372 default part of the buffer's text. Examples of such commands include
2373 \\[comment-dwim], \\[flush-lines], \\[ispell], \\[keep-lines],
2374 \\[query-replace], \\[query-replace-regexp], and \\[undo]. Invoke
2375 \\[apropos-documentation] and type \"transient\" or \"mark.*active\" at
2376 the prompt, to see the documentation of commands which are sensitive to
2377 the Transient Mark mode."
2379 (setq transient-mark-mode
2381 (not transient-mark-mode)
2382 (> (prefix-numeric-value arg) 0)))
2384 (if transient-mark-mode
2385 (message "Transient Mark mode enabled")
2386 (message "Transient Mark mode disabled"))))
2388 (defun pop-global-mark ()
2389 "Pop off global mark ring and jump to the top location."
2391 ;; Pop entries which refer to non-existent buffers.
2392 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2393 (setq global-mark-ring (cdr global-mark-ring)))
2394 (or global-mark-ring
2395 (error "No global mark set"))
2396 (let* ((marker (car global-mark-ring))
2397 (buffer (marker-buffer marker))
2398 (position (marker-position marker)))
2399 (setq global-mark-ring (nconc (cdr global-mark-ring)
2400 (list (car global-mark-ring))))
2402 (or (and (>= position (point-min))
2403 (<= position (point-max)))
2405 (goto-char position)
2406 (switch-to-buffer buffer)))
2408 (defcustom next-line-add-newlines nil
2409 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2412 :group 'editing-basics)
2414 (defun next-line (arg)
2415 "Move cursor vertically down ARG lines.
2416 If there is no character in the target line exactly under the current column,
2417 the cursor is positioned after the character in that line which spans this
2418 column, or at the end of the line if it is not long enough.
2419 If there is no line in the buffer after this one, behavior depends on the
2420 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2421 to create a line, and moves the cursor to that line. Otherwise it moves the
2422 cursor to the end of the buffer.
2424 The command \\[set-goal-column] can be used to create
2425 a semipermanent goal column for this command.
2426 Then instead of trying to move exactly vertically (or as close as possible),
2427 this command moves to the specified goal column (or as close as possible).
2428 The goal column is stored in the variable `goal-column', which is nil
2429 when there is no goal column.
2431 If you are thinking of using this in a Lisp program, consider
2432 using `forward-line' instead. It is usually easier to use
2433 and more reliable (no dependence on goal column, etc.)."
2435 (if (and next-line-add-newlines (= arg 1))
2436 (if (save-excursion (end-of-line) (eobp))
2437 ;; When adding a newline, don't expand an abbrev.
2438 (let ((abbrev-mode nil))
2445 ((beginning-of-buffer end-of-buffer) (ding)))
2449 (defun previous-line (arg)
2450 "Move cursor vertically up ARG lines.
2451 If there is no character in the target line exactly over the current column,
2452 the cursor is positioned after the character in that line which spans this
2453 column, or at the end of the line if it is not long enough.
2455 The command \\[set-goal-column] can be used to create
2456 a semipermanent goal column for this command.
2457 Then instead of trying to move exactly vertically (or as close as possible),
2458 this command moves to the specified goal column (or as close as possible).
2459 The goal column is stored in the variable `goal-column', which is nil
2460 when there is no goal column.
2462 If you are thinking of using this in a Lisp program, consider using
2463 `forward-line' with a negative argument instead. It is usually easier
2464 to use and more reliable (no dependence on goal column, etc.)."
2469 ((beginning-of-buffer end-of-buffer) (ding)))
2470 (line-move (- arg)))
2473 (defcustom track-eol nil
2474 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2475 This means moving to the end of each line moved onto.
2476 The beginning of a blank line does not count as the end of a line."
2478 :group 'editing-basics)
2480 (defcustom goal-column nil
2481 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2482 :type '(choice integer
2483 (const :tag "None" nil))
2484 :group 'editing-basics)
2485 (make-variable-buffer-local 'goal-column)
2487 (defvar temporary-goal-column 0
2488 "Current goal column for vertical motion.
2489 It is the column where point was
2490 at the start of current run of vertical motion commands.
2491 When the `track-eol' feature is doing its job, the value is 9999.")
2493 (defcustom line-move-ignore-invisible nil
2494 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2495 Outline mode sets this."
2497 :group 'editing-basics)
2499 ;; This is the guts of next-line and previous-line.
2500 ;; Arg says how many lines to move.
2501 (defun line-move (arg)
2502 ;; Don't run any point-motion hooks, and disregard intangibility,
2503 ;; for intermediate positions.
2504 (let ((inhibit-point-motion-hooks t)
2506 new line-end line-beg)
2509 (if (not (or (eq last-command 'next-line)
2510 (eq last-command 'previous-line)))
2511 (setq temporary-goal-column
2512 (if (and track-eol (eolp)
2513 ;; Don't count beg of empty line as end of line
2514 ;; unless we just did explicit end-of-line.
2515 (or (not (bolp)) (eq last-command 'end-of-line)))
2518 (if (and (not (integerp selective-display))
2519 (not line-move-ignore-invisible))
2520 ;; Use just newline characters.
2522 (progn (if (> arg 1) (forward-line (1- arg)))
2523 ;; This way of moving forward ARG lines
2524 ;; verifies that we have a newline after the last one.
2525 ;; It doesn't get confused by intangible text.
2527 (zerop (forward-line 1)))
2528 (and (zerop (forward-line arg))
2530 (signal (if (< arg 0)
2531 'beginning-of-buffer
2534 ;; Move by arg lines, but ignore invisible ones.
2537 (and (zerop (vertical-motion 1))
2538 (signal 'end-of-buffer nil))
2539 ;; If the following character is currently invisible,
2540 ;; skip all characters with that same `invisible' property value.
2541 (while (and (not (eobp))
2543 (get-char-property (point) 'invisible)))
2544 (if (eq buffer-invisibility-spec t)
2546 (or (memq prop buffer-invisibility-spec)
2547 (assq prop buffer-invisibility-spec)))))
2548 (if (get-text-property (point) 'invisible)
2549 (goto-char (next-single-property-change (point) 'invisible))
2550 (goto-char (next-overlay-change (point)))))
2551 (setq arg (1- arg)))
2554 (and (zerop (vertical-motion -1))
2555 (signal 'beginning-of-buffer nil))
2556 (while (and (not (bobp))
2558 (get-char-property (1- (point)) 'invisible)))
2559 (if (eq buffer-invisibility-spec t)
2561 (or (memq prop buffer-invisibility-spec)
2562 (assq prop buffer-invisibility-spec)))))
2563 (if (get-text-property (1- (point)) 'invisible)
2564 (goto-char (previous-single-property-change (point) 'invisible))
2565 (goto-char (previous-overlay-change (point)))))
2566 (setq arg (1+ arg))))
2567 (let ((buffer-invisibility-spec nil))
2568 (move-to-column (or goal-column temporary-goal-column))))
2570 ;; If we are moving into some intangible text,
2571 ;; look for following text on the same line which isn't intangible
2573 (setq line-end (save-excursion (end-of-line) (point)))
2574 (setq line-beg (save-excursion (beginning-of-line) (point)))
2575 (let ((after (and (< new (point-max))
2576 (get-char-property new 'intangible)))
2577 (before (and (> new (point-min))
2578 (get-char-property (1- new) 'intangible))))
2579 (when (and before (eq before after)
2581 (goto-char (point-min))
2582 (let ((inhibit-point-motion-hooks nil))
2584 (if (<= new line-end)
2585 (setq new (point)))))
2586 ;; NEW is where we want to move to.
2587 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2588 ;; Move there in just one step, from our starting position,
2589 ;; with intangibility and point-motion hooks enabled this time.
2591 (setq inhibit-point-motion-hooks nil)
2592 (goto-char (constrain-to-field new opoint nil t
2593 'inhibit-line-move-field-capture))
2594 ;; If intangibility processing moved us to a different line,
2595 ;; readjust the horizontal position within the line we ended up at.
2596 (when (or (< (point) line-beg) (> (point) line-end))
2598 (setq inhibit-point-motion-hooks t)
2599 (setq line-end (save-excursion (end-of-line) (point)))
2601 (setq line-beg (point))
2602 (let ((buffer-invisibility-spec nil))
2603 (move-to-column (or goal-column temporary-goal-column)))
2604 (if (<= (point) line-end)
2606 (goto-char (point-min))
2607 (setq inhibit-point-motion-hooks nil)
2608 (goto-char (constrain-to-field new opoint nil t
2609 'inhibit-line-move-field-capture))
2613 ;;; Many people have said they rarely use this feature, and often type
2614 ;;; it by accident. Maybe it shouldn't even be on a key.
2615 (put 'set-goal-column 'disabled t)
2617 (defun set-goal-column (arg)
2618 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2619 Those commands will move to this position in the line moved to
2620 rather than trying to keep the same horizontal position.
2621 With a non-nil argument, clears out the goal column
2622 so that \\[next-line] and \\[previous-line] resume vertical motion.
2623 The goal column is stored in the variable `goal-column'."
2627 (setq goal-column nil)
2628 (message "No goal column"))
2629 (setq goal-column (current-column))
2630 (message (substitute-command-keys
2631 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2636 (defun scroll-other-window-down (lines)
2637 "Scroll the \"other window\" down.
2638 For more details, see the documentation for `scroll-other-window'."
2640 (scroll-other-window
2641 ;; Just invert the argument's meaning.
2642 ;; We can do that without knowing which window it will be.
2643 (if (eq lines '-) nil
2645 (- (prefix-numeric-value lines))))))
2646 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2648 (defun beginning-of-buffer-other-window (arg)
2649 "Move point to the beginning of the buffer in the other window.
2650 Leave mark at previous position.
2651 With arg N, put point N/10 of the way from the true beginning."
2653 (let ((orig-window (selected-window))
2654 (window (other-window-for-scrolling)))
2655 ;; We use unwind-protect rather than save-window-excursion
2656 ;; because the latter would preserve the things we want to change.
2659 (select-window window)
2660 ;; Set point and mark in that window's buffer.
2661 (beginning-of-buffer arg)
2662 ;; Set point accordingly.
2664 (select-window orig-window))))
2666 (defun end-of-buffer-other-window (arg)
2667 "Move point to the end of the buffer in the other window.
2668 Leave mark at previous position.
2669 With arg N, put point N/10 of the way from the true end."
2671 ;; See beginning-of-buffer-other-window for comments.
2672 (let ((orig-window (selected-window))
2673 (window (other-window-for-scrolling)))
2676 (select-window window)
2679 (select-window orig-window))))
2681 (defun transpose-chars (arg)
2682 "Interchange characters around point, moving forward one character.
2683 With prefix arg ARG, effect is to take character before point
2684 and drag it forward past ARG other characters (backward if ARG negative).
2685 If no argument and at end of line, the previous two chars are exchanged."
2687 (and (null arg) (eolp) (forward-char -1))
2688 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2690 (defun transpose-words (arg)
2691 "Interchange words around point, leaving point at end of them.
2692 With prefix arg ARG, effect is to take word before or around point
2693 and drag it forward past ARG other words (backward if ARG negative).
2694 If ARG is zero, the words around or after point and around or after mark
2697 (transpose-subr 'forward-word arg))
2699 (defun transpose-sexps (arg)
2700 "Like \\[transpose-words] but applies to sexps.
2701 Does not work on a sexp that point is in the middle of
2702 if it is a list or string."
2704 (transpose-subr 'forward-sexp arg))
2706 (defun transpose-lines (arg)
2707 "Exchange current line and previous line, leaving point after both.
2708 With argument ARG, takes previous line and moves it past ARG lines.
2709 With argument 0, interchanges line point is in with line mark is in."
2711 (transpose-subr (function
2715 ;; Move forward over ARG lines,
2716 ;; but create newlines if necessary.
2717 (setq arg (forward-line arg))
2718 (if (/= (preceding-char) ?\n)
2719 (setq arg (1+ arg)))
2722 (forward-line arg))))
2725 (defvar transpose-subr-start1)
2726 (defvar transpose-subr-start2)
2727 (defvar transpose-subr-end1)
2728 (defvar transpose-subr-end2)
2730 (defun transpose-subr (mover arg)
2731 (let (transpose-subr-start1
2733 transpose-subr-start2
2734 transpose-subr-end2)
2739 (setq transpose-subr-end2 (point))
2741 (setq transpose-subr-start2 (point))
2744 (setq transpose-subr-end1 (point))
2746 (setq transpose-subr-start1 (point))
2748 (exchange-point-and-mark))
2752 (setq transpose-subr-start1 (point))
2754 (setq transpose-subr-end1 (point))
2756 (setq transpose-subr-end2 (point))
2757 (funcall mover (- arg))
2758 (setq transpose-subr-start2 (point))
2760 (goto-char transpose-subr-end2))
2762 (setq transpose-subr-start2 (point))
2764 (setq transpose-subr-end2 (point))
2765 (funcall mover (1- arg))
2766 (setq transpose-subr-start1 (point))
2767 (funcall mover (- arg))
2768 (setq transpose-subr-end1 (point))
2769 (transpose-subr-1)))))
2771 (defun transpose-subr-1 ()
2772 (if (> (min transpose-subr-end1 transpose-subr-end2)
2773 (max transpose-subr-start1 transpose-subr-start2))
2774 (error "Don't have two things to transpose"))
2775 (let* ((word1 (buffer-substring transpose-subr-start1 transpose-subr-end1))
2776 (len1 (length word1))
2777 (word2 (buffer-substring transpose-subr-start2 transpose-subr-end2))
2778 (len2 (length word2)))
2779 (delete-region transpose-subr-start2 transpose-subr-end2)
2780 (goto-char transpose-subr-start2)
2782 (goto-char (if (< transpose-subr-start1 transpose-subr-start2)
2783 transpose-subr-start1
2784 (+ transpose-subr-start1 (- len1 len2))))
2785 (delete-region (point) (+ (point) len1))
2788 (defun backward-word (arg)
2789 "Move backward until encountering the end of a word.
2790 With argument, do this that many times."
2792 (forward-word (- arg)))
2794 (defun mark-word (arg)
2795 "Set mark arg words away from point."
2803 (defun kill-word (arg)
2804 "Kill characters forward until encountering the end of a word.
2805 With argument, do this that many times."
2807 (kill-region (point) (progn (forward-word arg) (point))))
2809 (defun backward-kill-word (arg)
2810 "Kill characters backward until encountering the end of a word.
2811 With argument, do this that many times."
2813 (kill-word (- arg)))
2815 (defun current-word (&optional strict)
2816 "Return the word point is on (or a nearby word) as a string.
2817 If optional arg STRICT is non-nil, return nil unless point is within
2818 or adjacent to a word."
2820 (let ((oldpoint (point)) (start (point)) (end (point)))
2821 (skip-syntax-backward "w_") (setq start (point))
2822 (goto-char oldpoint)
2823 (skip-syntax-forward "w_") (setq end (point))
2824 (if (and (eq start oldpoint) (eq end oldpoint))
2825 ;; Point is neither within nor adjacent to a word.
2828 ;; Look for preceding word in same line.
2829 (skip-syntax-backward "^w_"
2830 (save-excursion (beginning-of-line)
2833 ;; No preceding word in same line.
2834 ;; Look for following word in same line.
2836 (skip-syntax-forward "^w_"
2837 (save-excursion (end-of-line)
2839 (setq start (point))
2840 (skip-syntax-forward "w_")
2843 (skip-syntax-backward "w_")
2844 (setq start (point)))
2845 (buffer-substring-no-properties start end)))
2846 (buffer-substring-no-properties start end)))))
2848 (defcustom fill-prefix nil
2849 "*String for filling to insert at front of new line, or nil for none.
2850 Setting this variable automatically makes it local to the current buffer."
2851 :type '(choice (const :tag "None" nil)
2854 (make-variable-buffer-local 'fill-prefix)
2856 (defcustom auto-fill-inhibit-regexp nil
2857 "*Regexp to match lines which should not be auto-filled."
2858 :type '(choice (const :tag "None" nil)
2862 (defvar comment-line-break-function 'comment-indent-new-line
2863 "*Mode-specific function which line breaks and continues a comment.
2865 This function is only called during auto-filling of a comment section.
2866 The function should take a single optional argument, which is a flag
2867 indicating whether it should use soft newlines.
2869 Setting this variable automatically makes it local to the current buffer.")
2871 ;; This function is used as the auto-fill-function of a buffer
2872 ;; when Auto-Fill mode is enabled.
2873 ;; It returns t if it really did any work.
2874 ;; (Actually some major modes use a different auto-fill function,
2875 ;; but this one is the default one.)
2876 (defun do-auto-fill ()
2877 (let (fc justify bol give-up
2878 (fill-prefix fill-prefix))
2879 (if (or (not (setq justify (current-justification)))
2880 (null (setq fc (current-fill-column)))
2881 (and (eq justify 'left)
2882 (<= (current-column) fc))
2883 (save-excursion (beginning-of-line)
2885 (and auto-fill-inhibit-regexp
2886 (looking-at auto-fill-inhibit-regexp))))
2887 nil ;; Auto-filling not required
2888 (if (memq justify '(full center right))
2889 (save-excursion (unjustify-current-line)))
2891 ;; Choose a fill-prefix automatically.
2892 (if (and adaptive-fill-mode
2893 (or (null fill-prefix) (string= fill-prefix "")))
2895 (fill-context-prefix
2896 (save-excursion (backward-paragraph 1) (point))
2897 (save-excursion (forward-paragraph 1) (point)))))
2898 (and prefix (not (equal prefix ""))
2899 (setq fill-prefix prefix))))
2901 (while (and (not give-up) (> (current-column) fc))
2902 ;; Determine where to split the line.
2905 (let ((opoint (point))
2910 (setq after-prefix (point))
2912 (looking-at (regexp-quote fill-prefix))
2913 (setq after-prefix (match-end 0)))
2914 (move-to-column (1+ fc))
2915 ;; Move back to the point where we can break the line.
2916 ;; We break the line between word or
2917 ;; after/before the character which has character
2918 ;; category `|'. We search space, \c| followed by
2919 ;; a character, or \c| following a character. If
2920 ;; not found, place the point at beginning of line.
2922 ;; If this is after period and a single space,
2923 ;; move back once more--we don't want to break
2924 ;; the line there and make it look like a
2928 sentence-end-double-space
2929 (save-excursion (forward-char -1)
2930 (and (looking-at "\\. ")
2931 (not (looking-at "\\. ")))))
2934 fill-nobreak-predicate
2935 (funcall fill-nobreak-predicate)))
2937 (re-search-backward "[ \t]\\|\\c|.\\|.\\c|\\|^")
2938 ;; If we find nowhere on the line to break it,
2939 ;; break after one word. Set bounce to t
2940 ;; so we will not keep going in this while loop.
2941 (if (<= (point) after-prefix)
2943 (goto-char after-prefix)
2944 (re-search-forward "[ \t]" opoint t)
2946 (if (looking-at "[ \t]")
2947 ;; Break the line at word boundary.
2948 (skip-chars-backward " \t")
2949 ;; Break the line after/before \c|.
2951 (if enable-multibyte-characters
2952 ;; If we are going to break the line after or
2953 ;; before a non-ascii character, we may have
2954 ;; to run a special function for the charset
2955 ;; of the character to find the correct break
2957 (if (not (and (eq (charset-after (1- (point))) 'ascii)
2958 (eq (charset-after (point)) 'ascii)))
2959 (fill-find-break-point after-prefix)))
2961 ;; Let fill-point be set to the place where we end up.
2962 ;; But move back before any whitespace here.
2963 (skip-chars-backward " \t")
2966 ;; See whether the place we found is any good.
2968 (goto-char fill-point)
2970 ;; There is no use breaking at end of line.
2971 (not (save-excursion (skip-chars-forward " ") (eolp)))
2972 ;; It is futile to split at the end of the prefix
2973 ;; since we would just insert the prefix again.
2974 (not (and after-prefix (<= (point) after-prefix)))
2975 ;; Don't split right after a comment starter
2976 ;; since we would just make another comment starter.
2977 (not (and comment-start-skip
2978 (let ((limit (point)))
2980 (and (re-search-forward comment-start-skip
2982 (eq (point) limit)))))))
2983 ;; Ok, we have a useful place to break the line. Do it.
2984 (let ((prev-column (current-column)))
2985 ;; If point is at the fill-point, do not `save-excursion'.
2986 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2987 ;; point will end up before it rather than after it.
2989 (skip-chars-backward " \t")
2990 (= (point) fill-point))
2991 (funcall comment-line-break-function t)
2993 (goto-char fill-point)
2994 (funcall comment-line-break-function t)))
2995 ;; Now do justification, if required
2996 (if (not (eq justify 'left))
2999 (justify-current-line justify nil t)))
3000 ;; If making the new line didn't reduce the hpos of
3001 ;; the end of the line, then give up now;
3002 ;; trying again will not help.
3003 (if (>= (current-column) prev-column)
3005 ;; No good place to break => stop trying.
3007 ;; Justify last line.
3008 (justify-current-line justify t t)
3011 (defvar normal-auto-fill-function 'do-auto-fill
3012 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3013 Some major modes set this.")
3015 (defun auto-fill-mode (&optional arg)
3016 "Toggle Auto Fill mode.
3017 With arg, turn Auto Fill mode on if and only if arg is positive.
3018 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
3019 automatically breaks the line at a previous space.
3021 The value of `normal-auto-fill-function' specifies the function to use
3022 for `auto-fill-function' when turning Auto Fill mode on."
3024 (prog1 (setq auto-fill-function
3026 (not auto-fill-function)
3027 (> (prefix-numeric-value arg) 0))
3028 normal-auto-fill-function
3030 (force-mode-line-update)))
3032 ;; This holds a document string used to document auto-fill-mode.
3033 (defun auto-fill-function ()
3034 "Automatically break line at a previous space, in insertion of text."
3037 (defun turn-on-auto-fill ()
3038 "Unconditionally turn on Auto Fill mode."
3041 (defun turn-off-auto-fill ()
3042 "Unconditionally turn off Auto Fill mode."
3043 (auto-fill-mode -1))
3045 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
3047 (defun set-fill-column (arg)
3048 "Set `fill-column' to specified argument.
3049 Use \\[universal-argument] followed by a number to specify a column.
3050 Just \\[universal-argument] as argument means to use the current column."
3053 (setq arg (current-column)))
3054 (if (not (integerp arg))
3055 ;; Disallow missing argument; it's probably a typo for C-x C-f.
3056 (error "set-fill-column requires an explicit argument")
3057 (message "Fill column set to %d (was %d)" arg fill-column)
3058 (setq fill-column arg)))
3060 (defun set-selective-display (arg)
3061 "Set `selective-display' to ARG; clear it if no arg.
3062 When the value of `selective-display' is a number > 0,
3063 lines whose indentation is >= that value are not displayed.
3064 The variable `selective-display' has a separate value for each buffer."
3066 (if (eq selective-display t)
3067 (error "selective-display already in use for marked lines"))
3070 (narrow-to-region (point-min) (point))
3071 (goto-char (window-start))
3072 (vertical-motion (window-height)))))
3073 (setq selective-display
3074 (and arg (prefix-numeric-value arg)))
3075 (recenter current-vpos))
3076 (set-window-start (selected-window) (window-start (selected-window)))
3077 (princ "selective-display set to " t)
3078 (prin1 selective-display t)
3081 (defvar overwrite-mode-textual " Ovwrt"
3082 "The string displayed in the mode line when in overwrite mode.")
3083 (defvar overwrite-mode-binary " Bin Ovwrt"
3084 "The string displayed in the mode line when in binary overwrite mode.")
3086 (defun overwrite-mode (arg)
3087 "Toggle overwrite mode.
3088 With arg, turn overwrite mode on iff arg is positive.
3089 In overwrite mode, printing characters typed in replace existing text
3090 on a one-for-one basis, rather than pushing it to the right. At the
3091 end of a line, such characters extend the line. Before a tab,
3092 such characters insert until the tab is filled in.
3093 \\[quoted-insert] still inserts characters in overwrite mode; this
3094 is supposed to make it easier to insert characters when necessary."
3096 (setq overwrite-mode
3097 (if (if (null arg) (not overwrite-mode)
3098 (> (prefix-numeric-value arg) 0))
3099 'overwrite-mode-textual))
3100 (force-mode-line-update))
3102 (defun binary-overwrite-mode (arg)
3103 "Toggle binary overwrite mode.
3104 With arg, turn binary overwrite mode on iff arg is positive.
3105 In binary overwrite mode, printing characters typed in replace
3106 existing text. Newlines are not treated specially, so typing at the
3107 end of a line joins the line to the next, with the typed character
3108 between them. Typing before a tab character simply replaces the tab
3109 with the character typed.
3110 \\[quoted-insert] replaces the text at the cursor, just as ordinary
3111 typing characters do.
3113 Note that binary overwrite mode is not its own minor mode; it is a
3114 specialization of overwrite-mode, entered by setting the
3115 `overwrite-mode' variable to `overwrite-mode-binary'."
3117 (setq overwrite-mode
3119 (not (eq overwrite-mode 'overwrite-mode-binary))
3120 (> (prefix-numeric-value arg) 0))
3121 'overwrite-mode-binary))
3122 (force-mode-line-update))
3124 (defcustom line-number-mode t
3125 "*Non-nil means display line number in mode line."
3127 :group 'editing-basics)
3129 (defun line-number-mode (arg)
3130 "Toggle Line Number mode.
3131 With arg, turn Line Number mode on iff arg is positive.
3132 When Line Number mode is enabled, the line number appears
3135 Line numbers do not appear for very large buffers, see variable
3136 `line-number-display-limit'."
3138 (setq line-number-mode
3139 (if (null arg) (not line-number-mode)
3140 (> (prefix-numeric-value arg) 0)))
3141 (force-mode-line-update))
3143 (defcustom column-number-mode nil
3144 "*Non-nil means display column number in mode line."
3146 :group 'editing-basics)
3148 (defun column-number-mode (arg)
3149 "Toggle Column Number mode.
3150 With arg, turn Column Number mode on iff arg is positive.
3151 When Column Number mode is enabled, the column number appears
3154 (setq column-number-mode
3155 (if (null arg) (not column-number-mode)
3156 (> (prefix-numeric-value arg) 0)))
3157 (force-mode-line-update))
3159 (defgroup paren-blinking nil
3160 "Blinking matching of parens and expressions."
3161 :prefix "blink-matching-"
3162 :group 'paren-matching)
3164 (defcustom blink-matching-paren t
3165 "*Non-nil means show matching open-paren when close-paren is inserted."
3167 :group 'paren-blinking)
3169 (defcustom blink-matching-paren-on-screen t
3170 "*Non-nil means show matching open-paren when it is on screen.
3171 If nil, means don't show it (but the open-paren can still be shown
3172 when it is off screen)."
3174 :group 'paren-blinking)
3176 (defcustom blink-matching-paren-distance (* 25 1024)
3177 "*If non-nil, is maximum distance to search for matching open-paren."
3179 :group 'paren-blinking)
3181 (defcustom blink-matching-delay 1
3182 "*Time in seconds to delay after showing a matching paren."
3184 :group 'paren-blinking)
3186 (defcustom blink-matching-paren-dont-ignore-comments nil
3187 "*Non-nil means `blink-matching-paren' will not ignore comments."
3189 :group 'paren-blinking)
3191 (defun blink-matching-open ()
3192 "Move cursor momentarily to the beginning of the sexp before point."
3194 (and (> (point) (1+ (point-min)))
3195 blink-matching-paren
3196 ;; Verify an even number of quoting characters precede the close.
3197 (= 1 (logand 1 (- (point)
3200 (skip-syntax-backward "/\\")
3202 (let* ((oldpos (point))
3207 (if blink-matching-paren-distance
3208 (narrow-to-region (max (point-min)
3209 (- (point) blink-matching-paren-distance))
3212 (let ((parse-sexp-ignore-comments
3213 (and parse-sexp-ignore-comments
3214 (not blink-matching-paren-dont-ignore-comments))))
3215 (setq blinkpos (scan-sexps oldpos -1)))
3218 (/= (char-syntax (char-after blinkpos))
3221 (or (null (matching-paren (char-after blinkpos)))
3222 (/= (char-after (1- oldpos))
3223 (matching-paren (char-after blinkpos))))))
3224 (if mismatch (setq blinkpos nil))
3226 ;; Don't log messages about paren matching.
3227 (let (message-log-max)
3228 (goto-char blinkpos)
3229 (if (pos-visible-in-window-p)
3230 (and blink-matching-paren-on-screen
3231 (sit-for blink-matching-delay))
3232 (goto-char blinkpos)
3235 ;; Show what precedes the open in its line, if anything.
3237 (skip-chars-backward " \t")
3239 (buffer-substring (progn (beginning-of-line) (point))
3241 ;; Show what follows the open in its line, if anything.
3244 (skip-chars-forward " \t")
3246 (buffer-substring blinkpos
3247 (progn (end-of-line) (point)))
3248 ;; Otherwise show the previous nonblank line,
3251 (skip-chars-backward "\n \t")
3254 (buffer-substring (progn
3255 (skip-chars-backward "\n \t")
3258 (progn (end-of-line)
3259 (skip-chars-backward " \t")
3261 ;; Replace the newline and other whitespace with `...'.
3263 (buffer-substring blinkpos (1+ blinkpos)))
3264 ;; There is nothing to show except the char itself.
3265 (buffer-substring blinkpos (1+ blinkpos))))))))
3267 (message "Mismatched parentheses"))
3268 ((not blink-matching-paren-distance)
3269 (message "Unmatched parenthesis"))))))))
3271 ;Turned off because it makes dbx bomb out.
3272 (setq blink-paren-function 'blink-matching-open)
3274 ;; This executes C-g typed while Emacs is waiting for a command.
3275 ;; Quitting out of a program does not go through here;
3276 ;; that happens in the QUIT macro at the C code level.
3277 (defun keyboard-quit ()
3278 "Signal a `quit' condition.
3279 During execution of Lisp code, this character causes a quit directly.
3280 At top-level, as an editor command, this simply beeps."
3285 (define-key global-map "\C-g" 'keyboard-quit)
3287 (defvar buffer-quit-function nil
3288 "Function to call to \"quit\" the current buffer, or nil if none.
3289 \\[keyboard-escape-quit] calls this function when its more local actions
3290 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3292 (defun keyboard-escape-quit ()
3293 "Exit the current \"mode\" (in a generalized sense of the word).
3294 This command can exit an interactive command such as `query-replace',
3295 can clear out a prefix argument or a region,
3296 can get out of the minibuffer or other recursive edit,
3297 cancel the use of the current buffer (for special-purpose buffers),
3298 or go back to just one window (by deleting all but the selected window)."
3300 (cond ((eq last-command 'mode-exited) nil)
3301 ((> (minibuffer-depth) 0)
3302 (abort-recursive-edit))
3305 ((and transient-mark-mode
3308 ((> (recursion-depth) 0)
3309 (exit-recursive-edit))
3310 (buffer-quit-function
3311 (funcall buffer-quit-function))
3312 ((not (one-window-p t))
3313 (delete-other-windows))
3314 ((string-match "^ \\*" (buffer-name (current-buffer)))
3317 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3319 (defcustom read-mail-command 'rmail
3320 "*Your preference for a mail reading package.
3321 This is used by some keybindings which support reading mail.
3322 See also `mail-user-agent' concerning sending mail."
3323 :type '(choice (function-item rmail)
3324 (function-item gnus)
3325 (function-item mh-rmail)
3326 (function :tag "Other"))
3330 (defcustom mail-user-agent 'sendmail-user-agent
3331 "*Your preference for a mail composition package.
3332 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
3333 outgoing email message. This variable lets you specify which
3334 mail-sending package you prefer.
3336 Valid values include:
3338 `sendmail-user-agent' -- use the default Emacs Mail package.
3339 See Info node `(emacs)Sending Mail'.
3340 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
3341 See Info node `(mh-e)'.
3342 `message-user-agent' -- use the Gnus Message package.
3343 See Info node `(message)'.
3344 `gnus-user-agent' -- like `message-user-agent', but with Gnus
3345 paraphernalia, particularly the Gcc: header for
3348 Additional valid symbols may be available; check with the author of
3349 your package for details. The function should return non-nil if it
3352 See also `read-mail-command' concerning reading mail."
3353 :type '(radio (function-item :tag "Default Emacs mail"
3355 sendmail-user-agent)
3356 (function-item :tag "Emacs interface to MH"
3359 (function-item :tag "Gnus Message package"
3362 (function-item :tag "Gnus Message with full Gnus features"
3365 (function :tag "Other"))
3368 (defun define-mail-user-agent (symbol composefunc sendfunc
3369 &optional abortfunc hookvar)
3370 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3372 SYMBOL can be any Lisp symbol. Its function definition and/or
3373 value as a variable do not matter for this usage; we use only certain
3374 properties on its property list, to encode the rest of the arguments.
3376 COMPOSEFUNC is program callable function that composes an outgoing
3377 mail message buffer. This function should set up the basics of the
3378 buffer without requiring user interaction. It should populate the
3379 standard mail headers, leaving the `to:' and `subject:' headers blank
3382 COMPOSEFUNC should accept several optional arguments--the same
3383 arguments that `compose-mail' takes. See that function's documentation.
3385 SENDFUNC is the command a user would run to send the message.
3387 Optional ABORTFUNC is the command a user would run to abort the
3388 message. For mail packages that don't have a separate abort function,
3389 this can be `kill-buffer' (the equivalent of omitting this argument).
3391 Optional HOOKVAR is a hook variable that gets run before the message
3392 is actually sent. Callers that use the `mail-user-agent' may
3393 install a hook function temporarily on this hook variable.
3394 If HOOKVAR is nil, `mail-send-hook' is used.
3396 The properties used on SYMBOL are `composefunc', `sendfunc',
3397 `abortfunc', and `hookvar'."
3398 (put symbol 'composefunc composefunc)
3399 (put symbol 'sendfunc sendfunc)
3400 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3401 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3403 (define-mail-user-agent 'sendmail-user-agent
3404 'sendmail-user-agent-compose
3405 'mail-send-and-exit)
3407 (defun rfc822-goto-eoh ()
3408 ;; Go to header delimiter line in a mail message, following RFC822 rules
3409 (goto-char (point-min))
3410 (while (looking-at "^[^: \n]+:\\|^[ \t]")
3414 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3415 switch-function yank-action
3418 (let ((special-display-buffer-names nil)
3419 (special-display-regexps nil)
3420 (same-window-buffer-names nil)
3421 (same-window-regexps nil))
3422 (funcall switch-function "*mail*")))
3423 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3424 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3425 (body (cdr (assoc-ignore-case "body" other-headers))))
3426 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3428 (error "Message aborted"))
3431 (while other-headers
3432 (unless (member-ignore-case (car (car other-headers))
3433 '("in-reply-to" "cc" "body"))
3434 (insert (car (car other-headers)) ": "
3435 (cdr (car other-headers)) "\n"))
3436 (setq other-headers (cdr other-headers)))
3442 (define-mail-user-agent 'mh-e-user-agent
3443 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3444 'mh-before-send-letter-hook)
3446 (defun compose-mail (&optional to subject other-headers continue
3447 switch-function yank-action send-actions)
3448 "Start composing a mail message to send.
3449 This uses the user's chosen mail composition package
3450 as selected with the variable `mail-user-agent'.
3451 The optional arguments TO and SUBJECT specify recipients
3452 and the initial Subject field, respectively.
3454 OTHER-HEADERS is an alist specifying additional
3455 header fields. Elements look like (HEADER . VALUE) where both
3456 HEADER and VALUE are strings.
3458 CONTINUE, if non-nil, says to continue editing a message already
3461 SWITCH-FUNCTION, if non-nil, is a function to use to
3462 switch to and display the buffer used for mail composition.
3464 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3465 to insert the raw text of the message being replied to.
3466 It has the form (FUNCTION . ARGS). The user agent will apply
3467 FUNCTION to ARGS, to insert the raw text of the original message.
3468 \(The user agent will also run `mail-citation-hook', *after* the
3469 original text has been inserted in this way.)
3471 SEND-ACTIONS is a list of actions to call when the message is sent.
3472 Each action has the form (FUNCTION . ARGS)."
3474 (list nil nil nil current-prefix-arg))
3475 (let ((function (get mail-user-agent 'composefunc)))
3476 (funcall function to subject other-headers continue
3477 switch-function yank-action send-actions)))
3479 (defun compose-mail-other-window (&optional to subject other-headers continue
3480 yank-action send-actions)
3481 "Like \\[compose-mail], but edit the outgoing message in another window."
3483 (list nil nil nil current-prefix-arg))
3484 (compose-mail to subject other-headers continue
3485 'switch-to-buffer-other-window yank-action send-actions))
3488 (defun compose-mail-other-frame (&optional to subject other-headers continue
3489 yank-action send-actions)
3490 "Like \\[compose-mail], but edit the outgoing message in another frame."
3492 (list nil nil nil current-prefix-arg))
3493 (compose-mail to subject other-headers continue
3494 'switch-to-buffer-other-frame yank-action send-actions))
3496 (defvar set-variable-value-history nil
3497 "History of values entered with `set-variable'.")
3499 (defun set-variable (var val)
3500 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3501 When using this interactively, enter a Lisp object for VALUE.
3502 If you want VALUE to be a string, you must surround it with doublequotes.
3503 VALUE is used literally, not evaluated.
3505 If VARIABLE has a `variable-interactive' property, that is used as if
3506 it were the arg to `interactive' (which see) to interactively read VALUE.
3508 If VARIABLE has been defined with `defcustom', then the type information
3509 in the definition is used to check that VALUE is valid."
3511 (let* ((default-var (variable-at-point))
3512 (var (if (symbolp default-var)
3513 (read-variable (format "Set variable (default %s): " default-var)
3515 (read-variable "Set variable: ")))
3516 (minibuffer-help-form '(describe-variable var))
3517 (prop (get var 'variable-interactive))
3518 (prompt (format "Set %s to value: " var))
3520 ;; Use VAR's `variable-interactive' property
3521 ;; as an interactive spec for prompting.
3522 (call-interactively `(lambda (arg)
3526 (read-string prompt nil
3527 'set-variable-value-history)))))
3530 (let ((type (get var 'custom-type)))
3532 ;; Match with custom type.
3534 (setq type (widget-convert type))
3535 (unless (widget-apply type :match val)
3536 (error "Value `%S' does not match type %S of %S"
3537 val (car type) var))))
3540 ;; Force a thorough redisplay for the case that the variable
3541 ;; has an effect on the display, like `tab-width' has.
3542 (force-mode-line-update))
3544 ;; Define the major mode for lists of completions.
3546 (defvar completion-list-mode-map nil
3547 "Local map for completion list buffers.")
3548 (or completion-list-mode-map
3549 (let ((map (make-sparse-keymap)))
3550 (define-key map [mouse-2] 'mouse-choose-completion)
3551 (define-key map [down-mouse-2] nil)
3552 (define-key map "\C-m" 'choose-completion)
3553 (define-key map "\e\e\e" 'delete-completion-window)
3554 (define-key map [left] 'previous-completion)
3555 (define-key map [right] 'next-completion)
3556 (setq completion-list-mode-map map)))
3558 ;; Completion mode is suitable only for specially formatted data.
3559 (put 'completion-list-mode 'mode-class 'special)
3561 (defvar completion-reference-buffer nil
3562 "Record the buffer that was current when the completion list was requested.
3563 This is a local variable in the completion list buffer.
3564 Initial value is nil to avoid some compiler warnings.")
3566 (defvar completion-no-auto-exit nil
3567 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3568 This also applies to other functions such as `choose-completion'
3569 and `mouse-choose-completion'.")
3571 (defvar completion-base-size nil
3572 "Number of chars at beginning of minibuffer not involved in completion.
3573 This is a local variable in the completion list buffer
3574 but it talks about the buffer in `completion-reference-buffer'.
3575 If this is nil, it means to compare text to determine which part
3576 of the tail end of the buffer's text is involved in completion.")
3578 (defun delete-completion-window ()
3579 "Delete the completion list window.
3580 Go to the window from which completion was requested."
3582 (let ((buf completion-reference-buffer))
3583 (if (one-window-p t)
3584 (if (window-dedicated-p (selected-window))
3585 (delete-frame (selected-frame)))
3586 (delete-window (selected-window))
3587 (if (get-buffer-window buf)
3588 (select-window (get-buffer-window buf))))))
3590 (defun previous-completion (n)
3591 "Move to the previous item in the completion list."
3593 (next-completion (- n)))
3595 (defun next-completion (n)
3596 "Move to the next item in the completion list.
3597 With prefix argument N, move N items (negative N means move backward)."
3599 (let ((beg (point-min)) (end (point-max)))
3600 (while (and (> n 0) (not (eobp)))
3601 ;; If in a completion, move to the end of it.
3602 (when (get-text-property (point) 'mouse-face)
3603 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3604 ;; Move to start of next one.
3605 (unless (get-text-property (point) 'mouse-face)
3606 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3608 (while (and (< n 0) (not (bobp)))
3609 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
3610 ;; If in a completion, move to the start of it.
3611 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
3612 (goto-char (previous-single-property-change
3613 (point) 'mouse-face nil beg)))
3614 ;; Move to end of the previous completion.
3615 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
3616 (goto-char (previous-single-property-change
3617 (point) 'mouse-face nil beg)))
3618 ;; Move to the start of that one.
3619 (goto-char (previous-single-property-change
3620 (point) 'mouse-face nil beg))
3623 (defun choose-completion ()
3624 "Choose the completion that point is in or next to."
3626 (let (beg end completion (buffer completion-reference-buffer)
3627 (base-size completion-base-size))
3628 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3629 (setq end (point) beg (1+ (point))))
3630 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3631 (setq end (1- (point)) beg (point)))
3633 (error "No completion here"))
3634 (setq beg (previous-single-property-change beg 'mouse-face))
3635 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3636 (setq completion (buffer-substring beg end))
3637 (let ((owindow (selected-window)))
3638 (if (and (one-window-p t 'selected-frame)
3639 (window-dedicated-p (selected-window)))
3640 ;; This is a special buffer's frame
3641 (iconify-frame (selected-frame))
3642 (or (window-dedicated-p (selected-window))
3644 (select-window owindow))
3645 (choose-completion-string completion buffer base-size)))
3647 ;; Delete the longest partial match for STRING
3648 ;; that can be found before POINT.
3649 (defun choose-completion-delete-max-match (string)
3650 (let ((opoint (point))
3651 (len (min (length string)
3652 (- (point) (point-min)))))
3653 (goto-char (- (point) (length string)))
3654 (if completion-ignore-case
3655 (setq string (downcase string)))
3656 (while (and (> len 0)
3657 (let ((tail (buffer-substring (point)
3659 (if completion-ignore-case
3660 (setq tail (downcase tail)))
3661 (not (string= tail (substring string 0 len)))))
3666 ;; Switch to BUFFER and insert the completion choice CHOICE.
3667 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3668 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
3670 ;; If BUFFER is the minibuffer, exit the minibuffer
3671 ;; unless it is reading a file name and CHOICE is a directory,
3672 ;; or completion-no-auto-exit is non-nil.
3673 (defun choose-completion-string (choice &optional buffer base-size)
3674 (let ((buffer (or buffer completion-reference-buffer))
3675 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))))
3676 ;; If BUFFER is a minibuffer, barf unless it's the currently
3677 ;; active minibuffer.
3679 (or (not (active-minibuffer-window))
3681 (window-buffer (active-minibuffer-window))))))
3682 (error "Minibuffer is not active for completion")
3683 ;; Insert the completion into the buffer where completion was requested.
3686 (delete-region (+ base-size (if mini-p
3687 (minibuffer-prompt-end)
3690 (choose-completion-delete-max-match choice))
3692 (remove-text-properties (- (point) (length choice)) (point)
3694 ;; Update point in the window that BUFFER is showing in.
3695 (let ((window (get-buffer-window buffer t)))
3696 (set-window-point window (point)))
3697 ;; If completing for the minibuffer, exit it with this choice.
3698 (and (not completion-no-auto-exit)
3699 (equal buffer (window-buffer (minibuffer-window)))
3700 minibuffer-completion-table
3701 ;; If this is reading a file name, and the file name chosen
3702 ;; is a directory, don't exit the minibuffer.
3703 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
3704 (file-directory-p (field-string (point-max))))
3705 (let ((mini (active-minibuffer-window)))
3706 (select-window mini)
3707 (when minibuffer-auto-raise
3708 (raise-frame (window-frame mini))))
3709 (exit-minibuffer))))))
3711 (defun completion-list-mode ()
3712 "Major mode for buffers showing lists of possible completions.
3713 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3714 to select the completion near point.
3715 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3718 (kill-all-local-variables)
3719 (use-local-map completion-list-mode-map)
3720 (setq mode-name "Completion List")
3721 (setq major-mode 'completion-list-mode)
3722 (make-local-variable 'completion-base-size)
3723 (setq completion-base-size nil)
3724 (run-hooks 'completion-list-mode-hook))
3726 (defun completion-list-mode-finish ()
3727 "Finish setup of the completions buffer.
3728 Called from `temp-buffer-show-hook'."
3729 (when (eq major-mode 'completion-list-mode)
3730 (toggle-read-only 1)))
3732 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
3734 (defvar completion-setup-hook nil
3735 "Normal hook run at the end of setting up a completion list buffer.
3736 When this hook is run, the current buffer is the one in which the
3737 command to display the completion list buffer was run.
3738 The completion list buffer is available as the value of `standard-output'.")
3740 ;; This function goes in completion-setup-hook, so that it is called
3741 ;; after the text of the completion list buffer is written.
3743 (defun completion-setup-function ()
3745 (let ((mainbuf (current-buffer)))
3746 (set-buffer standard-output)
3747 (completion-list-mode)
3748 (make-local-variable 'completion-reference-buffer)
3749 (setq completion-reference-buffer mainbuf)
3750 (if (eq minibuffer-completion-table 'read-file-name-internal)
3751 ;; For file name completion,
3752 ;; use the number of chars before the start of the
3753 ;; last file name component.
3754 (setq completion-base-size
3756 (set-buffer mainbuf)
3757 (goto-char (point-max))
3758 (skip-chars-backward (format "^%c" directory-sep-char))
3759 (- (point) (minibuffer-prompt-end))))
3760 ;; Otherwise, in minibuffer, the whole input is being completed.
3762 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3763 (buffer-name mainbuf))
3764 (setq completion-base-size 0))))
3765 (goto-char (point-min))
3766 (if (display-mouse-p)
3767 (insert (substitute-command-keys
3768 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
3769 (insert (substitute-command-keys
3770 "In this buffer, type \\[choose-completion] to \
3771 select the completion near point.\n\n")))))
3773 (add-hook 'completion-setup-hook 'completion-setup-function)
3775 (define-key minibuffer-local-completion-map [prior]
3776 'switch-to-completions)
3777 (define-key minibuffer-local-must-match-map [prior]
3778 'switch-to-completions)
3779 (define-key minibuffer-local-completion-map "\M-v"
3780 'switch-to-completions)
3781 (define-key minibuffer-local-must-match-map "\M-v"
3782 'switch-to-completions)
3784 (defun switch-to-completions ()
3785 "Select the completion list window."
3787 ;; Make sure we have a completions window.
3788 (or (get-buffer-window "*Completions*")
3789 (minibuffer-completion-help))
3790 (let ((window (get-buffer-window "*Completions*")))
3792 (select-window window)
3793 (goto-char (point-min))
3794 (search-forward "\n\n")
3797 ;; Support keyboard commands to turn on various modifiers.
3799 ;; These functions -- which are not commands -- each add one modifier
3800 ;; to the following event.
3802 (defun event-apply-alt-modifier (ignore-prompt)
3803 "Add the Alt modifier to the following event.
3804 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
3805 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3806 (defun event-apply-super-modifier (ignore-prompt)
3807 "Add the Super modifier to the following event.
3808 For example, type \\[event-apply-super-modifier] & to enter Super-&."
3809 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3810 (defun event-apply-hyper-modifier (ignore-prompt)
3811 "Add the Hyper modifier to the following event.
3812 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
3813 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3814 (defun event-apply-shift-modifier (ignore-prompt)
3815 "Add the Shift modifier to the following event.
3816 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
3817 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3818 (defun event-apply-control-modifier (ignore-prompt)
3819 "Add the Ctrl modifier to the following event.
3820 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
3821 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3822 (defun event-apply-meta-modifier (ignore-prompt)
3823 "Add the Meta modifier to the following event.
3824 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
3825 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3827 (defun event-apply-modifier (event symbol lshiftby prefix)
3828 "Apply a modifier flag to event EVENT.
3829 SYMBOL is the name of this modifier, as a symbol.
3830 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3831 PREFIX is the string that represents this modifier in an event type symbol."
3833 (cond ((eq symbol 'control)
3834 (if (and (<= (downcase event) ?z)
3835 (>= (downcase event) ?a))
3836 (- (downcase event) ?a -1)
3837 (if (and (<= (downcase event) ?Z)
3838 (>= (downcase event) ?A))
3839 (- (downcase event) ?A -1)
3840 (logior (lsh 1 lshiftby) event))))
3842 (if (and (<= (downcase event) ?z)
3843 (>= (downcase event) ?a))
3845 (logior (lsh 1 lshiftby) event)))
3847 (logior (lsh 1 lshiftby) event)))
3848 (if (memq symbol (event-modifiers event))
3850 (let ((event-type (if (symbolp event) event (car event))))
3851 (setq event-type (intern (concat prefix (symbol-name event-type))))
3854 (cons event-type (cdr event)))))))
3856 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3857 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3858 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3859 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3860 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3861 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3863 ;;;; Keypad support.
3865 ;;; Make the keypad keys act like ordinary typing keys. If people add
3866 ;;; bindings for the function key symbols, then those bindings will
3867 ;;; override these, so this shouldn't interfere with any existing
3870 ;; Also tell read-char how to handle these keys.
3872 (lambda (keypad-normal)
3873 (let ((keypad (nth 0 keypad-normal))
3874 (normal (nth 1 keypad-normal)))
3875 (put keypad 'ascii-character normal)
3876 (define-key function-key-map (vector keypad) (vector normal))))
3877 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3878 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3891 ;;;; forking a twin copy of a buffer.
3894 (defvar clone-buffer-hook nil
3895 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
3897 (defun clone-process (process &optional newname)
3898 "Create a twin copy of PROCESS.
3899 If NEWNAME is nil, it defaults to PROCESS' name;
3900 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3901 If PROCESS is associated with a buffer, the new process will be associated
3902 with the current buffer instead.
3903 Returns nil if PROCESS has already terminated."
3904 (setq newname (or newname (process-name process)))
3905 (if (string-match "<[0-9]+>\\'" newname)
3906 (setq newname (substring newname 0 (match-beginning 0))))
3907 (when (memq (process-status process) '(run stop open))
3908 (let* ((process-connection-type (process-tty-name process))
3909 (old-kwoq (process-kill-without-query process nil))
3911 (if (memq (process-status process) '(open))
3912 (apply 'open-network-stream newname
3913 (if (process-buffer process) (current-buffer))
3914 (process-contact process))
3915 (apply 'start-process newname
3916 (if (process-buffer process) (current-buffer))
3917 (process-command process)))))
3918 (process-kill-without-query new-process old-kwoq)
3919 (process-kill-without-query process old-kwoq)
3920 (set-process-inherit-coding-system-flag
3921 new-process (process-inherit-coding-system-flag process))
3922 (set-process-filter new-process (process-filter process))
3923 (set-process-sentinel new-process (process-sentinel process))
3926 ;; things to maybe add (currently partly covered by `funcall mode':
3929 (defun clone-buffer (&optional newname display-flag)
3930 "Create a twin copy of the current buffer.
3931 If NEWNAME is nil, it defaults to the current buffer's name;
3932 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3934 If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
3935 This runs the normal hook `clone-buffer-hook' in the new buffer
3936 after it has been set up properly in other respects."
3937 (interactive (list (if current-prefix-arg (read-string "Name: "))
3939 (if buffer-file-name
3940 (error "Cannot clone a file-visiting buffer"))
3941 (if (get major-mode 'no-clone)
3942 (error "Cannot clone a buffer in %s mode" mode-name))
3943 (setq newname (or newname (buffer-name)))
3944 (if (string-match "<[0-9]+>\\'" newname)
3945 (setq newname (substring newname 0 (match-beginning 0))))
3946 (let ((buf (current-buffer))
3950 (mk (if mark-active (mark t)))
3951 (modified (buffer-modified-p))
3953 (lvars (buffer-local-variables))
3954 (process (get-buffer-process (current-buffer)))
3955 (new (generate-new-buffer (or newname (buffer-name)))))
3958 (with-current-buffer new
3959 (insert-buffer-substring buf)))
3960 (with-current-buffer new
3961 (narrow-to-region ptmin ptmax)
3963 (if mk (set-mark mk))
3964 (set-buffer-modified-p modified)
3966 ;; Clone the old buffer's process, if any.
3967 (when process (clone-process process))
3969 ;; Now set up the major mode.
3972 ;; Set up other local variables.
3974 (condition-case () ;in case var is read-only
3977 (set (make-local-variable (car v)) (cdr v)))
3981 ;; Run any hooks (typically set up by the major mode
3982 ;; for cloning to work properly).
3983 (run-hooks 'clone-buffer-hook))
3984 (if display-flag (pop-to-buffer new))
3988 (defun clone-indirect-buffer (newname display-flag &optional norecord)
3989 "Create an indirect buffer that is a twin copy of the current buffer.
3991 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
3992 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
3993 or if not called with a prefix arg, NEWNAME defaults to the current
3994 buffer's name. The name is modified by adding a `<N>' suffix to it
3995 or by incrementing the N in an existing suffix.
3997 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
3998 This is always done when called interactively.
4000 Optional last arg NORECORD non-nil means do not put this buffer at the
4001 front of the list of recently selected ones."
4002 (interactive (list (if current-prefix-arg
4003 (read-string "BName of indirect buffer: "))
4005 (setq newname (or newname (buffer-name)))
4006 (if (string-match "<[0-9]+>\\'" newname)
4007 (setq newname (substring newname 0 (match-beginning 0))))
4008 (let* ((name (generate-new-buffer-name newname))
4009 (buffer (make-indirect-buffer (current-buffer) name t)))
4011 (pop-to-buffer buffer norecord))
4015 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
4016 "Create an indirect buffer that is a twin copy of BUFFER.
4017 Select the new buffer in another window.
4018 Optional second arg NORECORD non-nil means do not put this buffer at
4019 the front of the list of recently selected ones."
4020 (interactive "bClone buffer in other window: ")
4021 (let ((popup-windows t))
4023 (clone-indirect-buffer nil t norecord)))
4025 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
4030 (defconst syntax-code-table
4031 '((?\ 0 "whitespace")
4033 (?. 1 "punctuation")
4036 (?\( 4 "open parenthesis")
4037 (?\) 5 "close parenthesis")
4038 (?\' 6 "expression prefix")
4039 (?\" 7 "string quote")
4040 (?$ 8 "paired delimiter")
4042 (?/ 10 "character quote")
4043 (?< 11 "comment start")
4044 (?> 12 "comment end")
4046 (nil 14 "comment fence")
4047 (nil 15 "string fence"))
4048 "Alist of forms (CHAR CODE DESCRIPTION) mapping characters to syntax info.
4049 CHAR is a character that is allowed as first char in the string
4050 specifying the syntax when calling `modify-syntax-entry'. CODE is the
4051 corresponing syntax code as it is stored in a syntax cell, and
4052 can be used as value of a `syntax-table' property.
4053 DESCRIPTION is the descriptive string for the syntax.")
4056 ;;; Handling of Backspace and Delete keys.
4058 (defcustom normal-erase-is-backspace nil
4059 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
4061 On window systems, the default value of this option is chosen
4062 according to the keyboard used. If the keyboard has both a Backspace
4063 key and a Delete key, and both are mapped to their usual meanings, the
4064 option's default value is set to t, so that Backspace can be used to
4065 delete backward, and Delete can be used to delete forward.
4067 If not running under a window system, customizing this option accomplishes
4068 a similar effect by mapping C-h, which is usually generated by the
4069 Backspace key, to DEL, and by mapping DEL to C-d via
4070 `keyboard-translate'. The former functionality of C-h is available on
4071 the F1 key. You should probably not use this setting if you don't
4072 have both Backspace, Delete and F1 keys.
4074 Setting this variable with setq doesn't take effect. Programmatically,
4075 call `normal-erase-is-backspace-mode' (which see) instead."
4077 :group 'editing-basics
4079 :set (lambda (symbol value)
4080 ;; The fboundp is because of a problem with :set when
4081 ;; dumping Emacs. It doesn't really matter.
4082 (if (fboundp 'normal-erase-is-backspace-mode)
4083 (normal-erase-is-backspace-mode (or value 0))
4084 (set-default symbol value))))
4087 (defun normal-erase-is-backspace-mode (&optional arg)
4088 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
4090 With numeric arg, turn the mode on if and only if ARG is positive.
4092 On window systems, when this mode is on, Delete is mapped to C-d and
4093 Backspace is mapped to DEL; when this mode is off, both Delete and
4094 Backspace are mapped to DEL. (The remapping goes via
4095 `function-key-map', so binding Delete or Backspace in the global or
4096 local keymap will override that.)
4098 In addition, on window systems, the bindings of C-Delete, M-Delete,
4099 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
4100 the global keymap in accordance with the functionality of Delete and
4101 Backspace. For example, if Delete is remapped to C-d, which deletes
4102 forward, C-Delete is bound to `kill-word', but if Delete is remapped
4103 to DEL, which deletes backward, C-Delete is bound to
4104 `backward-kill-word'.
4106 If not running on a window system, a similar effect is accomplished by
4107 remapping C-h (normally produced by the Backspace key) and DEL via
4108 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
4109 to C-d; if it's off, the keys are not remapped.
4111 When not running on a window system, and this mode is turned on, the
4112 former functionality of C-h is available on the F1 key. You should
4113 probably not turn on this mode on a text-only terminal if you don't
4114 have both Backspace, Delete and F1 keys.
4116 See also `normal-erase-is-backspace'."
4118 (setq normal-erase-is-backspace
4120 (> (prefix-numeric-value arg) 0)
4121 (not normal-erase-is-backspace)))
4123 (cond ((or (memq window-system '(x w32 mac pc))
4124 (memq system-type '(ms-dos windows-nt)))
4126 `(([C-delete] [C-backspace])
4127 ([M-delete] [M-backspace])
4128 ([C-M-delete] [C-M-backspace])
4130 [C-delete] [C-backspace])))
4131 (old-state (lookup-key function-key-map [delete])))
4133 (if normal-erase-is-backspace
4135 (define-key function-key-map [delete] [?\C-d])
4136 (define-key function-key-map [kp-delete] [?\C-d])
4137 (define-key function-key-map [backspace] [?\C-?]))
4138 (define-key function-key-map [delete] [?\C-?])
4139 (define-key function-key-map [kp-delete] [?\C-?])
4140 (define-key function-key-map [backspace] [?\C-?]))
4142 ;; Maybe swap bindings of C-delete and C-backspace, etc.
4143 (unless (equal old-state (lookup-key function-key-map [delete]))
4144 (dolist (binding bindings)
4145 (let ((map global-map))
4146 (when (keymapp (car binding))
4147 (setq map (car binding) binding (cdr binding)))
4148 (let* ((key1 (nth 0 binding))
4149 (key2 (nth 1 binding))
4150 (binding1 (lookup-key map key1))
4151 (binding2 (lookup-key map key2)))
4152 (define-key map key1 binding2)
4153 (define-key map key2 binding1)))))))
4155 (if normal-erase-is-backspace
4157 (keyboard-translate ?\C-h ?\C-?)
4158 (keyboard-translate ?\C-? ?\C-d))
4159 (keyboard-translate ?\C-h ?\C-h)
4160 (keyboard-translate ?\C-? ?\C-?))))
4162 (run-hooks 'normal-erase-is-backspace-hook)
4164 (message "Delete key deletes %s"
4165 (if normal-erase-is-backspace "forward" "backward"))))
4170 (defun byte-compiling-files-p ()
4171 "Return t if currently byte-compiling files."
4172 (and (boundp 'byte-compile-current-file)
4173 (stringp byte-compile-current-file)))
4175 ;;; simple.el ends here