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