1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 1997
4 ;; Free Software Foundation, Inc.
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
25 ;; A grab-bag of basic Emacs commands not specifically related to some
26 ;; major mode or to file-handling.
31 "Killing and yanking commands"
34 (defgroup fill-comments nil
35 "Indenting and filling of comments."
39 (defgroup paren-matching nil
40 "Highlight (un)matching of parens and expressions."
44 (defun newline (&optional arg)
45 "Insert a newline, and move to left margin of the new line if it's blank.
46 The newline is marked with the text-property `hard'.
47 With arg, insert that many newlines.
48 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
50 (barf-if-buffer-read-only)
51 ;; Inserting a newline at the end of a line produces better redisplay in
52 ;; try_window_id than inserting at the beginning of a line, and the textual
53 ;; result is the same. So, if we're at beginning of line, pretend to be at
54 ;; the end of the previous line.
55 (let ((flag (and (not (bobp))
57 ;; Make sure no functions want to be told about
58 ;; the range of the changes.
59 (not after-change-function)
60 (not before-change-function)
61 (not after-change-functions)
62 (not before-change-functions)
63 ;; Make sure there are no markers here.
64 (not (buffer-has-markers-at (1- (point))))
65 ;; Make sure no text properties want to know
66 ;; where the change was.
67 (not (get-char-property (1- (point)) 'modification-hooks))
68 (not (get-char-property (1- (point)) 'insert-behind-hooks))
70 (not (get-char-property (point) 'insert-in-front-hooks)))
71 ;; Make sure the newline before point isn't intangible.
72 (not (get-char-property (1- (point)) 'intangible))
73 ;; Make sure the newline before point isn't read-only.
74 (not (get-char-property (1- (point)) 'read-only))
75 ;; Make sure the newline before point isn't invisible.
76 (not (get-char-property (1- (point)) 'invisible))
77 ;; Make sure the newline before point has the same
78 ;; properties as the char before it (if any).
79 (< (or (previous-property-change (point)) -2)
81 (was-page-start (and (bolp)
82 (looking-at page-delimiter)))
84 (if flag (backward-char 1))
85 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
86 ;; Set last-command-char to tell self-insert what to insert.
87 (let ((last-command-char ?\n)
88 ;; Don't auto-fill if we have a numeric argument.
89 ;; Also not if flag is true (it would fill wrong line);
90 ;; there is no need to since we're at BOL.
91 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
93 (self-insert-command (prefix-numeric-value arg))
94 ;; If we get an error in self-insert-command, put point at right place.
95 (if flag (forward-char 1))))
96 ;; If we did *not* get an error, cancel that forward-char.
97 (if flag (backward-char 1))
98 ;; Mark the newline(s) `hard'.
100 (set-hard-newline-properties
101 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
102 ;; If the newline leaves the previous line blank,
103 ;; and we have a left margin, delete that from the blank line.
106 (goto-char beforepos)
108 (and (looking-at "[ \t]$")
109 (> (current-left-margin) 0)
110 (delete-region (point) (progn (end-of-line) (point))))))
111 (if flag (forward-char 1))
112 ;; Indent the line after the newline, except in one case:
113 ;; when we added the newline at the beginning of a line
114 ;; which starts a page.
116 (move-to-left-margin nil t)))
119 (defun set-hard-newline-properties (from to)
120 (let ((sticky (get-text-property from 'rear-nonsticky)))
121 (put-text-property from to 'hard 't)
122 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
123 (if (and (listp sticky) (not (memq 'hard sticky)))
124 (put-text-property from (point) 'rear-nonsticky
125 (cons 'hard sticky)))))
127 (defun open-line (arg)
128 "Insert a newline and leave point before it.
129 If there is a fill prefix and/or a left-margin, insert them on the new line
130 if the line would have been blank.
131 With arg N, insert N newlines."
133 (let* ((do-fill-prefix (and fill-prefix (bolp)))
134 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
140 (if do-left-margin (indent-to (current-left-margin)))
141 (if do-fill-prefix (insert-and-inherit fill-prefix))))
148 "Split current line, moving portion beyond point vertically down."
150 (skip-chars-forward " \t")
151 (let ((col (current-column))
157 (defun quoted-insert (arg)
158 "Read next input character and insert it.
159 This is useful for inserting control characters.
161 If the first character you type after this command is an octal digit,
162 you should type a sequence of octal digits which specify a character code.
163 Any nondigit terminates the sequence. If the terminator is a RET,
164 it is discarded; any other terminator is used itself as input.
165 The variable `read-quoted-char-radix' specifies the radix for this feature;
166 set it to 10 or 16 to use decimal or hex instead of octal.
168 In overwrite mode, this function inserts the character anyway, and
169 does not handle octal digits specially. This means that if you use
170 overwrite as your normal editing mode, you can use this function to
171 insert characters when necessary.
173 In binary overwrite mode, this function does overwrite, and octal
174 digits are interpreted as a character code. This is intended to be
175 useful for editing binary files."
177 (let ((char (if (or (not overwrite-mode)
178 (eq overwrite-mode 'overwrite-mode-binary))
181 ;; Assume character codes 0200 - 0377 stand for
182 ;; European characters in Latin-1, and convert them
183 ;; to Emacs characters.
184 (and enable-multibyte-characters
187 (setq char (+ nonascii-insert-offset char)))
189 (if (eq overwrite-mode 'overwrite-mode-binary)
192 (insert-and-inherit char)
193 (setq arg (1- arg)))))
195 (defun delete-indentation (&optional arg)
196 "Join this line to previous and fix up whitespace at join.
197 If there is a fill prefix, delete it from the beginning of this line.
198 With argument, join this line to following line."
201 (if arg (forward-line 1))
202 (if (eq (preceding-char) ?\n)
204 (delete-region (point) (1- (point)))
205 ;; If the second line started with the fill prefix,
206 ;; delete the prefix.
208 (<= (+ (point) (length fill-prefix)) (point-max))
210 (buffer-substring (point)
211 (+ (point) (length fill-prefix)))))
212 (delete-region (point) (+ (point) (length fill-prefix))))
213 (fixup-whitespace))))
215 (defun fixup-whitespace ()
216 "Fixup white space between objects around point.
217 Leave one space or none, according to the context."
220 (delete-horizontal-space)
221 (if (or (looking-at "^\\|\\s)")
222 (save-excursion (forward-char -1)
223 (looking-at "$\\|\\s(\\|\\s'")))
227 (defun delete-horizontal-space ()
228 "Delete all spaces and tabs around point."
230 (skip-chars-backward " \t")
231 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
233 (defun just-one-space ()
234 "Delete all spaces and tabs around point, leaving one space."
236 (skip-chars-backward " \t")
237 (if (= (following-char) ? )
240 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
242 (defun delete-blank-lines ()
243 "On blank line, delete all surrounding blank lines, leaving just one.
244 On isolated blank line, delete that one.
245 On nonblank line, delete any immediately following blank lines."
247 (let (thisblank singleblank)
250 (setq thisblank (looking-at "[ \t]*$"))
251 ;; Set singleblank if there is just one blank line here.
254 (not (looking-at "[ \t]*\n[ \t]*$"))
256 (progn (forward-line -1)
257 (not (looking-at "[ \t]*$")))))))
258 ;; Delete preceding blank lines, and this one too if it's the only one.
262 (if singleblank (forward-line 1))
263 (delete-region (point)
264 (if (re-search-backward "[^ \t\n]" nil t)
265 (progn (forward-line 1) (point))
267 ;; Delete following blank lines, unless the current line is blank
268 ;; and there are no following blank lines.
269 (if (not (and thisblank singleblank))
273 (delete-region (point)
274 (if (re-search-forward "[^ \t\n]" nil t)
275 (progn (beginning-of-line) (point))
277 ;; Handle the special case where point is followed by newline and eob.
278 ;; Delete the line, leaving point at eob.
279 (if (looking-at "^[ \t]*\n\\'")
280 (delete-region (point) (point-max)))))
282 (defun back-to-indentation ()
283 "Move point to the first non-whitespace character on this line."
285 (beginning-of-line 1)
286 (skip-chars-forward " \t"))
288 (defun newline-and-indent ()
289 "Insert a newline, then indent according to major mode.
290 Indentation is done using the value of `indent-line-function'.
291 In programming language modes, this is the same as TAB.
292 In some text modes, where TAB inserts a tab, this command indents to the
293 column specified by the function `current-left-margin'."
295 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
297 (indent-according-to-mode))
299 (defun reindent-then-newline-and-indent ()
300 "Reindent current line, insert newline, then indent the new line.
301 Indentation of both lines is done according to the current major mode,
302 which means calling the current value of `indent-line-function'.
303 In programming language modes, this is the same as TAB.
304 In some text modes, where TAB inserts a tab, this indents to the
305 column specified by the function `current-left-margin'."
308 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
309 (indent-according-to-mode))
311 (indent-according-to-mode))
313 ;; Internal subroutine of delete-char
314 (defun kill-forward-chars (arg)
315 (if (listp arg) (setq arg (car arg)))
316 (if (eq arg '-) (setq arg -1))
317 (kill-region (point) (forward-point arg)))
319 ;; Internal subroutine of backward-delete-char
320 (defun kill-backward-chars (arg)
321 (if (listp arg) (setq arg (car arg)))
322 (if (eq arg '-) (setq arg -1))
323 (kill-region (point) (forward-point (- arg))))
325 (defun backward-delete-char-untabify (arg &optional killp)
326 "Delete characters backward, changing tabs into spaces.
327 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
328 Interactively, ARG is the prefix arg (default 1)
329 and KILLP is t if a prefix arg was specified."
330 (interactive "*p\nP")
333 (while (and (> count 0) (not (bobp)))
334 (if (= (preceding-char) ?\t)
335 (let ((col (current-column)))
337 (setq col (- col (current-column)))
341 (setq count (1- count)))))
342 (delete-backward-char arg killp))
344 (defun zap-to-char (arg char)
345 "Kill up to and including ARG'th occurrence of CHAR.
346 Goes backward if ARG is negative; error if CHAR not found."
347 (interactive "p\ncZap to char: ")
348 (kill-region (point) (progn
349 (search-forward (char-to-string char) nil nil arg)
350 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
353 (defun beginning-of-buffer (&optional arg)
354 "Move point to the beginning of the buffer; leave mark at previous position.
355 With arg N, put point N/10 of the way from the beginning.
357 If the buffer is narrowed, this command uses the beginning and size
358 of the accessible part of the buffer.
360 Don't use this command in Lisp programs!
361 \(goto-char (point-min)) is faster and avoids clobbering the mark."
364 (let ((size (- (point-max) (point-min))))
368 ;; Avoid overflow for large buffer sizes!
369 (* (prefix-numeric-value arg)
371 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
373 (if arg (forward-line 1)))
375 (defun end-of-buffer (&optional arg)
376 "Move point to the end of the buffer; leave mark at previous position.
377 With arg N, put point N/10 of the way from the end.
379 If the buffer is narrowed, this command uses the beginning and size
380 of the accessible part of the buffer.
382 Don't use this command in Lisp programs!
383 \(goto-char (point-max)) is faster and avoids clobbering the mark."
386 (let ((size (- (point-max) (point-min))))
390 ;; Avoid overflow for large buffer sizes!
391 (* (prefix-numeric-value arg)
393 (/ (* size (prefix-numeric-value arg)) 10)))
395 ;; If we went to a place in the middle of the buffer,
396 ;; adjust it to the beginning of a line.
397 (if arg (forward-line 1)
398 ;; If the end of the buffer is not already on the screen,
399 ;; then scroll specially to put it near, but not at, the bottom.
400 (if (let ((old-point (point)))
402 (goto-char (window-start))
403 (vertical-motion (window-height))
404 (< (point) old-point)))
406 (overlay-recenter (point))
409 (defun mark-whole-buffer ()
410 "Put point at beginning and mark at end of buffer.
411 You probably should not use this function in Lisp programs;
412 it is usually a mistake for a Lisp function to use any subroutine
413 that uses or sets the mark."
416 (push-mark (point-max) nil t)
417 (goto-char (point-min)))
419 (defun count-lines-region (start end)
420 "Print number of lines and characters in the region."
422 (message "Region has %d lines, %d characters"
423 (count-lines start end) (- end start)))
426 "Print the current buffer line number and narrowed line number of point."
428 (let ((opoint (point)) start)
431 (goto-char (point-min))
438 (message "line %d (narrowed line %d)"
439 (1+ (count-lines 1 (point)))
440 (1+ (count-lines start (point))))
441 (message "Line %d" (1+ (count-lines 1 (point)))))))))
444 (defun count-lines (start end)
445 "Return number of lines between START and END.
446 This is usually the number of newlines between them,
447 but can be one more if START is not equal to END
448 and the greater of them is not at the start of a line."
451 (narrow-to-region start end)
452 (goto-char (point-min))
453 (if (eq selective-display t)
456 (while (re-search-forward "[\n\C-m]" nil t 40)
457 (setq done (+ 40 done)))
458 (while (re-search-forward "[\n\C-m]" nil t 1)
459 (setq done (+ 1 done)))
460 (goto-char (point-max))
461 (if (and (/= start end)
465 (- (buffer-size) (forward-line (buffer-size)))))))
467 (defun what-cursor-position (&optional detail)
468 "Print info on cursor position (on screen and within buffer).
469 With prefix argument, print detailed info of a character on cursor position."
471 (let* ((char (following-char))
475 (total (buffer-size))
476 (percent (if (> total 50000)
477 ;; Avoid overflow from multiplying by 100!
478 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
479 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
480 (hscroll (if (= (window-hscroll) 0)
482 (format " Hscroll=%d" (window-hscroll))))
483 (col (current-column)))
485 (if (or (/= beg 1) (/= end (1+ total)))
486 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
487 pos total percent beg end col hscroll)
488 (message "point=%d of %d(%d%%) column %d %s"
489 pos total percent col hscroll))
490 (let ((str (if detail (format " %s" (split-char char)) "")))
491 (if (or (/= beg 1) (/= end (1+ total)))
492 (message "Char: %s (0%o, %d, 0x%x) %s point=%d of %d(%d%%) <%d - %d> column %d %s"
494 (single-key-description char)
495 (char-to-string char))
496 char char char str pos total percent beg end col hscroll)
497 (message "Char: %s (0%o, %d, 0x%x)%s point=%d of %d(%d%%) column %d %s"
499 (single-key-description char)
500 (char-to-string char))
501 char char char str pos total percent col hscroll))))))
503 (defun fundamental-mode ()
504 "Major mode not specialized for anything in particular.
505 Other major modes are defined by comparison with this one."
507 (kill-all-local-variables))
509 (defvar read-expression-map (cons 'keymap minibuffer-local-map)
510 "Minibuffer keymap used for reading Lisp expressions.")
511 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
513 (defvar read-expression-history nil)
515 ;; We define this, rather than making `eval' interactive,
516 ;; for the sake of completion of names like eval-region, eval-current-buffer.
517 (defun eval-expression (eval-expression-arg
518 &optional eval-expression-insert-value)
519 "Evaluate EXPRESSION and print value in minibuffer.
520 Value is also consed on to front of the variable `values'."
522 (list (read-from-minibuffer "Eval: "
523 nil read-expression-map t
524 'read-expression-history)
526 (setq values (cons (eval eval-expression-arg) values))
528 (if eval-expression-insert-value (current-buffer) t)))
530 (defun edit-and-eval-command (prompt command)
531 "Prompting with PROMPT, let user edit COMMAND and eval result.
532 COMMAND is a Lisp expression. Let user edit that expression in
533 the minibuffer, then read and evaluate the result."
534 (let ((command (read-from-minibuffer prompt
535 (prin1-to-string command)
536 read-expression-map t
537 '(command-history . 1))))
538 ;; If command was added to command-history as a string,
539 ;; get rid of that. We want only evaluable expressions there.
540 (if (stringp (car command-history))
541 (setq command-history (cdr command-history)))
543 ;; If command to be redone does not match front of history,
544 ;; add it to the history.
545 (or (equal command (car command-history))
546 (setq command-history (cons command command-history)))
549 (defun repeat-complex-command (arg)
550 "Edit and re-evaluate last complex command, or ARGth from last.
551 A complex command is one which used the minibuffer.
552 The command is placed in the minibuffer as a Lisp form for editing.
553 The result is executed, repeating the command as changed.
554 If the command has been changed or is not the most recent previous command
555 it is added to the front of the command history.
556 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
557 to get different commands to edit and resubmit."
559 (let ((elt (nth (1- arg) command-history))
564 (let ((print-level nil)
565 (minibuffer-history-position arg)
566 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
567 (read-from-minibuffer
568 "Redo: " (prin1-to-string elt) read-expression-map t
569 (cons 'command-history arg))))
571 ;; If command was added to command-history as a string,
572 ;; get rid of that. We want only evaluable expressions there.
573 (if (stringp (car command-history))
574 (setq command-history (cdr command-history)))
576 ;; If command to be redone does not match front of history,
577 ;; add it to the history.
578 (or (equal newcmd (car command-history))
579 (setq command-history (cons newcmd command-history)))
583 (defvar minibuffer-history nil
584 "Default minibuffer history list.
585 This is used for all minibuffer input
586 except when an alternate history list is specified.")
587 (defvar minibuffer-history-sexp-flag nil
588 "Non-nil when doing history operations on `command-history'.
589 More generally, indicates that the history list being acted on
590 contains expressions rather than strings.
591 It is only valid if its value equals the current minibuffer depth,
592 to handle recursive uses of the minibuffer.")
593 (setq minibuffer-history-variable 'minibuffer-history)
594 (setq minibuffer-history-position nil)
595 (defvar minibuffer-history-search-history nil)
598 (lambda (key-and-command)
600 (lambda (keymap-and-completionp)
601 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
602 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
603 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
604 (define-key (symbol-value (car keymap-and-completionp))
605 (car key-and-command)
606 (let ((command (cdr key-and-command)))
608 ;; (and ... nil) => ... turns back on the completion-oriented
609 ;; history commands which rms turned off since they seem to
610 ;; do things he doesn't like.
611 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
612 (progn (error "EMACS BUG!") (cdr command))
615 '((minibuffer-local-map . nil)
616 (minibuffer-local-ns-map . nil)
617 (minibuffer-local-completion-map . t)
618 (minibuffer-local-must-match-map . t)
619 (read-expression-map . nil))))
620 '(("\en" . (next-history-element . next-complete-history-element))
621 ([next] . (next-history-element . next-complete-history-element))
622 ("\ep" . (previous-history-element . previous-complete-history-element))
623 ([prior] . (previous-history-element . previous-complete-history-element))
624 ("\er" . previous-matching-history-element)
625 ("\es" . next-matching-history-element)))
627 (defvar minibuffer-text-before-history nil
628 "Text that was in this minibuffer before any history commands.
629 This is nil if there have not yet been any history commands
630 in this use of the minibuffer.")
632 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
634 (defun minibuffer-history-initialize ()
635 (setq minibuffer-text-before-history nil))
637 (defun previous-matching-history-element (regexp n)
638 "Find the previous history element that matches REGEXP.
639 \(Previous history elements refer to earlier actions.)
640 With prefix argument N, search for Nth previous match.
641 If N is negative, find the next or Nth next match."
643 (let* ((enable-recursive-minibuffers t)
644 (regexp (read-from-minibuffer "Previous element matching (regexp): "
648 'minibuffer-history-search-history)))
649 ;; Use the last regexp specified, by default, if input is empty.
650 (list (if (string= regexp "")
651 (if minibuffer-history-search-history
652 (car minibuffer-history-search-history)
653 (error "No previous history search regexp"))
655 (prefix-numeric-value current-prefix-arg))))
656 (if (and (zerop minibuffer-history-position)
657 (null minibuffer-text-before-history))
658 (setq minibuffer-text-before-history (buffer-string)))
659 (let ((history (symbol-value minibuffer-history-variable))
661 (pos minibuffer-history-position))
664 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
667 "No later matching history item"
668 "No earlier matching history item")))
669 (if (string-match regexp
670 (if (eq minibuffer-history-sexp-flag
672 (let ((print-level nil))
673 (prin1-to-string (nth (1- pos) history)))
674 (nth (1- pos) history)))
675 (setq n (+ n (if (< n 0) 1 -1)))))
676 (setq minibuffer-history-position pos)
678 (let ((elt (nth (1- pos) history)))
679 (insert (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
680 (let ((print-level nil))
681 (prin1-to-string elt))
683 (goto-char (point-min)))
684 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
685 (eq (car (car command-history)) 'next-matching-history-element))
686 (setq command-history (cdr command-history))))
688 (defun next-matching-history-element (regexp n)
689 "Find the next history element that matches REGEXP.
690 \(The next history element refers to a more recent action.)
691 With prefix argument N, search for Nth next match.
692 If N is negative, find the previous or Nth previous match."
694 (let* ((enable-recursive-minibuffers t)
695 (regexp (read-from-minibuffer "Next element matching (regexp): "
699 'minibuffer-history-search-history)))
700 ;; Use the last regexp specified, by default, if input is empty.
701 (list (if (string= regexp "")
702 (setcar minibuffer-history-search-history
703 (nth 1 minibuffer-history-search-history))
705 (prefix-numeric-value current-prefix-arg))))
706 (previous-matching-history-element regexp (- n)))
708 (defun next-history-element (n)
709 "Insert the next element of the minibuffer history into the minibuffer."
712 (let ((narg (- minibuffer-history-position n))
713 (minimum (if minibuffer-default -1 0))
715 (if (and (zerop minibuffer-history-position)
716 (null minibuffer-text-before-history))
717 (setq minibuffer-text-before-history (buffer-string)))
719 (error "End of history; no next item"))
720 (if (> narg (length (symbol-value minibuffer-history-variable)))
721 (error "Beginning of history; no preceding item"))
723 (setq minibuffer-history-position narg)
725 (setq elt minibuffer-default))
727 (setq elt (or minibuffer-text-before-history ""))
728 (setq minibuffer-text-before-history nil))
729 (t (setq elt (nth (1- minibuffer-history-position)
730 (symbol-value minibuffer-history-variable)))))
732 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
733 (let ((print-level nil))
734 (prin1-to-string elt))
736 (goto-char (point-min)))))
738 (defun previous-history-element (n)
739 "Inserts the previous element of the minibuffer history into the minibuffer."
741 (next-history-element (- n)))
743 (defun next-complete-history-element (n)
744 "Get next element of history which is a completion of minibuffer contents."
746 (let ((point-at-start (point)))
747 (next-matching-history-element
748 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
749 ;; next-matching-history-element always puts us at (point-min).
750 ;; Move to the position we were at before changing the buffer contents.
751 ;; This is still sensical, because the text before point has not changed.
752 (goto-char point-at-start)))
754 (defun previous-complete-history-element (n)
756 Get previous element of history which is a completion of minibuffer contents."
758 (next-complete-history-element (- n)))
760 (defun goto-line (arg)
761 "Goto line ARG, counting from line 1 at beginning of buffer."
762 (interactive "NGoto line: ")
763 (setq arg (prefix-numeric-value arg))
767 (if (eq selective-display t)
768 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
769 (forward-line (1- arg)))))
771 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
772 (defalias 'advertised-undo 'undo)
774 (defun undo (&optional arg)
775 "Undo some previous changes.
776 Repeat this command to undo more changes.
777 A numeric argument serves as a repeat count."
779 ;; If we don't get all the way thru, make last-command indicate that
780 ;; for the following command.
781 (setq this-command t)
782 (let ((modified (buffer-modified-p))
783 (recent-save (recent-auto-save-p)))
784 (or (eq (selected-window) (minibuffer-window))
786 (or (eq last-command 'undo)
789 (undo-more (or arg 1))
790 ;; Don't specify a position in the undo record for the undo command.
791 ;; Instead, undoing this should move point to where the change is.
792 (let ((tail buffer-undo-list)
794 (while (and tail (not done) (not (null (car tail))))
795 (if (integerp (car tail))
798 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
799 (setq tail (cdr tail))))
800 (and modified (not (buffer-modified-p))
801 (delete-auto-save-file-if-necessary recent-save)))
802 ;; If we do get all the way thru, make this-command indicate that.
803 (setq this-command 'undo))
805 (defvar pending-undo-list nil
806 "Within a run of consecutive undo commands, list remaining to be undone.")
809 "Set `pending-undo-list' to the front of the undo list.
810 The next call to `undo-more' will undo the most recently made change."
811 (if (eq buffer-undo-list t)
812 (error "No undo information in this buffer"))
813 (setq pending-undo-list buffer-undo-list))
815 (defun undo-more (count)
816 "Undo back N undo-boundaries beyond what was already undone recently.
817 Call `undo-start' to get ready to undo recent changes,
818 then call `undo-more' one or more times to undo them."
819 (or pending-undo-list
820 (error "No further undo information"))
821 (setq pending-undo-list (primitive-undo count pending-undo-list)))
823 (defvar shell-command-history nil
824 "History list for some commands that read shell commands.")
826 (defvar shell-command-switch "-c"
827 "Switch used to have the shell execute its command line argument.")
829 (defun shell-command (command &optional output-buffer)
830 "Execute string COMMAND in inferior shell; display output, if any.
832 If COMMAND ends in ampersand, execute it asynchronously.
833 The output appears in the buffer `*Async Shell Command*'.
834 That buffer is in shell mode.
836 Otherwise, COMMAND is executed synchronously. The output appears in the
837 buffer `*Shell Command Output*'.
838 If the output is one line, it is displayed in the echo area *as well*,
839 but it is nonetheless available in buffer `*Shell Command Output*',
840 even though that buffer is not automatically displayed.
841 If there is no output, or if output is inserted in the current buffer,
842 then `*Shell Command Output*' is deleted.
844 To specify a coding system for converting non-ASCII characters
845 in the shell command output, use \\[universal-coding-system-argument]
848 Noninteractive callers can specify coding systems by binding
849 `coding-system-for-read' and `coding-system-for-write'.
851 The optional second argument OUTPUT-BUFFER, if non-nil,
852 says to put the output in some other buffer.
853 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
854 If OUTPUT-BUFFER is not a buffer and not nil,
855 insert output in current buffer. (This cannot be done asynchronously.)
856 In either case, the output is inserted after point (leaving mark after it)."
857 (interactive (list (read-from-minibuffer "Shell command: "
858 nil nil nil 'shell-command-history)
860 ;; Look for a handler in case default-directory is a remote file name.
862 (find-file-name-handler (directory-file-name default-directory)
865 (funcall handler 'shell-command command output-buffer)
866 (if (and output-buffer
867 (not (or (bufferp output-buffer) (stringp output-buffer))))
868 (progn (barf-if-buffer-read-only)
870 ;; We do not use -f for csh; we will not support broken use of
871 ;; .cshrcs. Even the BSD csh manual says to use
872 ;; "if ($?prompt) exit" before things which are not useful
873 ;; non-interactively. Besides, if someone wants their other
874 ;; aliases for shell commands then they can still have them.
875 (call-process shell-file-name nil t nil
876 shell-command-switch command)
877 ;; This is like exchange-point-and-mark, but doesn't
878 ;; activate the mark. It is cleaner to avoid activation,
879 ;; even though the command loop would deactivate the mark
880 ;; because we inserted text.
881 (goto-char (prog1 (mark t)
882 (set-marker (mark-marker) (point)
884 ;; Preserve the match data in case called from a program.
886 (if (string-match "[ \t]*&[ \t]*$" command)
887 ;; Command ending with ampersand means asynchronous.
888 (let ((buffer (get-buffer-create
889 (or output-buffer "*Async Shell Command*")))
890 (directory default-directory)
892 ;; Remove the ampersand.
893 (setq command (substring command 0 (match-beginning 0)))
894 ;; If will kill a process, query first.
895 (setq proc (get-buffer-process buffer))
897 (if (yes-or-no-p "A command is running. Kill it? ")
899 (error "Shell command in progress")))
902 (setq buffer-read-only nil)
904 (display-buffer buffer)
905 (setq default-directory directory)
906 (setq proc (start-process "Shell" buffer shell-file-name
907 shell-command-switch command))
908 (setq mode-line-process '(":%s"))
909 (require 'shell) (shell-mode)
910 (set-process-sentinel proc 'shell-command-sentinel)
912 (shell-command-on-region (point) (point) command output-buffer)
915 ;; We have a sentinel to prevent insertion of a termination message
916 ;; in the buffer itself.
917 (defun shell-command-sentinel (process signal)
918 (if (memq (process-status process) '(exit signal))
920 (car (cdr (cdr (process-command process))))
921 (substring signal 0 -1))))
923 (defun shell-command-on-region (start end command
924 &optional output-buffer replace
926 "Execute string COMMAND in inferior shell with region as input.
927 Normally display output (if any) in temp buffer `*Shell Command Output*';
928 Prefix arg means replace the region with it.
930 To specify a coding system for converting non-ASCII characters
931 in the input and output to the shell command, use \\[universal-coding-system-argument]
932 before this command. By default, the input (from the current buffer)
933 is encoded in the same coding system that will be used to save the file,
934 `buffer-file-coding-system'. If the output is going to replace the region,
935 then it is decoded from that same coding system.
937 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER, REPLACE,
938 ERROR-BUFFER. If REPLACE is non-nil, that means insert the output
939 in place of text from START to END, putting point and mark around it.
940 Noninteractive callers can specify coding systems by binding
941 `coding-system-for-read' and `coding-system-for-write'.
943 If the output is one line, it is displayed in the echo area,
944 but it is nonetheless available in buffer `*Shell Command Output*'
945 even though that buffer is not automatically displayed.
946 If there is no output, or if output is inserted in the current buffer,
947 then `*Shell Command Output*' is deleted.
949 If the optional fourth argument OUTPUT-BUFFER is non-nil,
950 that says to put the output in some other buffer.
951 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
952 If OUTPUT-BUFFER is not a buffer and not nil,
953 insert output in the current buffer.
954 In either case, the output is inserted after point (leaving mark after it).
956 If optional fifth argument ERROR-BUFFER is non-nil, it is a buffer
957 or buffer name to which to direct the command's standard error output.
958 If it is nil, error output is mingled with regular output."
959 (interactive (let ((string
960 ;; Do this before calling region-beginning
961 ;; and region-end, in case subprocess output
962 ;; relocates them while we are in the minibuffer.
963 (read-from-minibuffer "Shell command on region: "
965 'shell-command-history)))
966 ;; call-interactively recognizes region-beginning and
967 ;; region-end specially, leaving them in the history.
968 (list (region-beginning) (region-end)
971 current-prefix-arg)))
974 (concat (file-name-directory temp-file-name-pattern)
975 (make-temp-name "scor"))
979 (not (or (bufferp output-buffer) (stringp output-buffer))))
980 (equal (buffer-name (current-buffer)) "*Shell Command Output*"))
981 ;; Replace specified region with output from command.
982 (let ((swap (and replace (< start end))))
983 ;; Don't muck with mark unless REPLACE says we should.
985 (and replace (push-mark))
986 (call-process-region start end shell-file-name t
990 nil shell-command-switch command)
991 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
992 (and shell-buffer (not (eq shell-buffer (current-buffer)))
993 (kill-buffer shell-buffer)))
994 ;; Don't muck with mark unless REPLACE says we should.
995 (and replace swap (exchange-point-and-mark)))
996 ;; No prefix argument: put the output in a temp buffer,
997 ;; replacing its entire contents.
998 (let ((buffer (get-buffer-create
999 (or output-buffer "*Shell Command Output*")))
1002 (if (eq buffer (current-buffer))
1003 ;; If the input is the same buffer as the output,
1004 ;; delete everything but the specified region,
1005 ;; then replace that region with the output.
1006 (progn (setq buffer-read-only nil)
1007 (delete-region (max start end) (point-max))
1008 (delete-region (point-min) (min start end))
1009 (call-process-region (point-min) (point-max)
1014 nil shell-command-switch command)
1016 ;; Clear the output buffer, then run the command with output there.
1019 (setq buffer-read-only nil)
1021 (call-process-region start end shell-file-name nil
1023 (list buffer error-file)
1025 nil shell-command-switch command)
1027 ;; Report the amount of output.
1028 (let ((lines (save-excursion
1030 (if (= (buffer-size) 0)
1032 (count-lines (point-min) (point-max))))))
1035 (message "(Shell command completed with no output)"))
1036 (kill-buffer buffer))
1037 ((and success (= lines 1))
1041 (goto-char (point-min))
1042 (buffer-substring (point)
1043 (progn (end-of-line) (point))))))
1047 (goto-char (point-min)))
1048 (display-buffer buffer)))))))
1049 (if (and error-file (file-exists-p error-file))
1051 (set-buffer (get-buffer-create error-buffer))
1052 ;; Do no formatting while reading error file, for fear of looping.
1053 (format-insert-file error-file nil)
1054 (delete-file error-file)))))
1056 (defun shell-command-to-string (command)
1057 "Execute shell command COMMAND and return its output as a string."
1058 (with-output-to-string
1059 (with-current-buffer
1061 (call-process shell-file-name nil t nil shell-command-switch command))))
1063 (defvar universal-argument-map
1064 (let ((map (make-sparse-keymap)))
1065 (define-key map [t] 'universal-argument-other-key)
1066 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1067 (define-key map [switch-frame] nil)
1068 (define-key map [?\C-u] 'universal-argument-more)
1069 (define-key map [?-] 'universal-argument-minus)
1070 (define-key map [?0] 'digit-argument)
1071 (define-key map [?1] 'digit-argument)
1072 (define-key map [?2] 'digit-argument)
1073 (define-key map [?3] 'digit-argument)
1074 (define-key map [?4] 'digit-argument)
1075 (define-key map [?5] 'digit-argument)
1076 (define-key map [?6] 'digit-argument)
1077 (define-key map [?7] 'digit-argument)
1078 (define-key map [?8] 'digit-argument)
1079 (define-key map [?9] 'digit-argument)
1081 "Keymap used while processing \\[universal-argument].")
1083 (defvar universal-argument-num-events nil
1084 "Number of argument-specifying events read by `universal-argument'.
1085 `universal-argument-other-key' uses this to discard those events
1086 from (this-command-keys), and reread only the final command.")
1088 (defun universal-argument ()
1089 "Begin a numeric argument for the following command.
1090 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1091 \\[universal-argument] following the digits or minus sign ends the argument.
1092 \\[universal-argument] without digits or minus sign provides 4 as argument.
1093 Repeating \\[universal-argument] without digits or minus sign
1094 multiplies the argument by 4 each time.
1095 For some commands, just \\[universal-argument] by itself serves as a flag
1096 which is different in effect from any particular numeric argument.
1097 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1099 (setq prefix-arg (list 4))
1100 (setq universal-argument-num-events (length (this-command-keys)))
1101 (setq overriding-terminal-local-map universal-argument-map))
1103 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1104 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1105 (defun universal-argument-more (arg)
1108 (setq prefix-arg (list (* 4 (car arg))))
1110 (setq prefix-arg (list -4))
1111 (setq prefix-arg arg)
1112 (setq overriding-terminal-local-map nil)))
1113 (setq universal-argument-num-events (length (this-command-keys))))
1115 (defun negative-argument (arg)
1116 "Begin a negative numeric argument for the next command.
1117 \\[universal-argument] following digits or minus sign ends the argument."
1119 (cond ((integerp arg)
1120 (setq prefix-arg (- arg)))
1122 (setq prefix-arg nil))
1124 (setq prefix-arg '-)))
1125 (setq universal-argument-num-events (length (this-command-keys)))
1126 (setq overriding-terminal-local-map universal-argument-map))
1128 (defun digit-argument (arg)
1129 "Part of the numeric argument for the next command.
1130 \\[universal-argument] following digits or minus sign ends the argument."
1132 (let ((digit (- (logand last-command-char ?\177) ?0)))
1133 (cond ((integerp arg)
1134 (setq prefix-arg (+ (* arg 10)
1135 (if (< arg 0) (- digit) digit))))
1137 ;; Treat -0 as just -, so that -01 will work.
1138 (setq prefix-arg (if (zerop digit) '- (- digit))))
1140 (setq prefix-arg digit))))
1141 (setq universal-argument-num-events (length (this-command-keys)))
1142 (setq overriding-terminal-local-map universal-argument-map))
1144 ;; For backward compatibility, minus with no modifiers is an ordinary
1145 ;; command if digits have already been entered.
1146 (defun universal-argument-minus (arg)
1149 (universal-argument-other-key arg)
1150 (negative-argument arg)))
1152 ;; Anything else terminates the argument and is left in the queue to be
1153 ;; executed as a command.
1154 (defun universal-argument-other-key (arg)
1156 (setq prefix-arg arg)
1157 (let* ((key (this-command-keys))
1158 (keylist (listify-key-sequence key)))
1159 (setq unread-command-events
1160 (append (nthcdr universal-argument-num-events keylist)
1161 unread-command-events)))
1162 (reset-this-command-lengths)
1163 (setq overriding-terminal-local-map nil))
1165 (defun forward-to-indentation (arg)
1166 "Move forward ARG lines and position at first nonblank character."
1169 (skip-chars-forward " \t"))
1171 (defun backward-to-indentation (arg)
1172 "Move backward ARG lines and position at first nonblank character."
1174 (forward-line (- arg))
1175 (skip-chars-forward " \t"))
1177 (defcustom kill-whole-line nil
1178 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
1182 (defun kill-line (&optional arg)
1183 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1184 With prefix argument, kill that many lines from point.
1185 Negative arguments kill lines backward.
1187 When calling from a program, nil means \"no arg\",
1188 a number counts as a prefix arg.
1190 To kill a whole line, when point is not at the beginning, type \
1191 \\[beginning-of-line] \\[kill-line] \\[kill-line].
1193 If `kill-whole-line' is non-nil, then this command kills the whole line
1194 including its terminating newline, when used at the beginning of a line
1195 with no argument. As a consequence, you can always kill a whole line
1196 by typing \\[beginning-of-line] \\[kill-line]."
1198 (kill-region (point)
1199 ;; It is better to move point to the other end of the kill
1200 ;; before killing. That way, in a read-only buffer, point
1201 ;; moves across the text that is copied to the kill ring.
1202 ;; The choice has no effect on undo now that undo records
1203 ;; the value of point from before the command was run.
1206 (forward-visible-line (prefix-numeric-value arg))
1208 (signal 'end-of-buffer nil))
1209 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
1210 (forward-visible-line 1)
1211 (end-of-visible-line)))
1214 (defun forward-visible-line (arg)
1215 "Move forward by ARG lines, ignoring currently invisible newlines only.
1216 If ARG is negative, move backward -ARG lines.
1217 If ARG is zero, move to the beginning of the current line."
1221 (or (zerop (forward-line 1))
1222 (signal 'end-of-buffer nil))
1223 ;; If the following character is currently invisible,
1224 ;; skip all characters with that same `invisible' property value,
1225 ;; then find the next newline.
1226 (while (and (not (eobp))
1228 (get-char-property (point) 'invisible)))
1229 (if (eq buffer-invisibility-spec t)
1231 (or (memq prop buffer-invisibility-spec)
1232 (assq prop buffer-invisibility-spec)))))
1234 (if (get-text-property (point) 'invisible)
1235 (or (next-single-property-change (point) 'invisible)
1237 (next-overlay-change (point))))
1238 (or (zerop (forward-line 1))
1239 (signal 'end-of-buffer nil)))
1240 (setq arg (1- arg)))
1242 (while (or first (< arg 0))
1245 (or (zerop (forward-line -1))
1246 (signal 'beginning-of-buffer nil)))
1247 (while (and (not (bobp))
1249 (get-char-property (1- (point)) 'invisible)))
1250 (if (eq buffer-invisibility-spec t)
1252 (or (memq prop buffer-invisibility-spec)
1253 (assq prop buffer-invisibility-spec)))))
1255 (if (get-text-property (1- (point)) 'invisible)
1256 (or (previous-single-property-change (point) 'invisible)
1258 (previous-overlay-change (point))))
1259 (or (zerop (forward-line -1))
1260 (signal 'beginning-of-buffer nil)))
1262 (setq arg (1+ arg)))))
1263 ((beginning-of-buffer end-of-buffer)
1266 (defun end-of-visible-line ()
1267 "Move to end of current visible line."
1269 ;; If the following character is currently invisible,
1270 ;; skip all characters with that same `invisible' property value,
1271 ;; then find the next newline.
1272 (while (and (not (eobp))
1274 (get-char-property (point) 'invisible)))
1275 (if (eq buffer-invisibility-spec t)
1277 (or (memq prop buffer-invisibility-spec)
1278 (assq prop buffer-invisibility-spec)))))
1279 (if (get-text-property (point) 'invisible)
1280 (goto-char (next-single-property-change (point) 'invisible))
1281 (goto-char (next-overlay-change (point))))
1284 ;;;; Window system cut and paste hooks.
1286 (defvar interprogram-cut-function nil
1287 "Function to call to make a killed region available to other programs.
1289 Most window systems provide some sort of facility for cutting and
1290 pasting text between the windows of different programs.
1291 This variable holds a function that Emacs calls whenever text
1292 is put in the kill ring, to make the new kill available to other
1295 The function takes one or two arguments.
1296 The first argument, TEXT, is a string containing
1297 the text which should be made available.
1298 The second, PUSH, if non-nil means this is a \"new\" kill;
1299 nil means appending to an \"old\" kill.")
1301 (defvar interprogram-paste-function nil
1302 "Function to call to get text cut from other programs.
1304 Most window systems provide some sort of facility for cutting and
1305 pasting text between the windows of different programs.
1306 This variable holds a function that Emacs calls to obtain
1307 text that other programs have provided for pasting.
1309 The function should be called with no arguments. If the function
1310 returns nil, then no other program has provided such text, and the top
1311 of the Emacs kill ring should be used. If the function returns a
1312 string, that string should be put in the kill ring as the latest kill.
1314 Note that the function should return a string only if a program other
1315 than Emacs has provided a string for pasting; if Emacs provided the
1316 most recent string, the function should return nil. If it is
1317 difficult to tell whether Emacs or some other program provided the
1318 current string, it is probably good enough to return nil if the string
1319 is equal (according to `string=') to the last text Emacs provided.")
1323 ;;;; The kill ring data structure.
1325 (defvar kill-ring nil
1326 "List of killed text sequences.
1327 Since the kill ring is supposed to interact nicely with cut-and-paste
1328 facilities offered by window systems, use of this variable should
1329 interact nicely with `interprogram-cut-function' and
1330 `interprogram-paste-function'. The functions `kill-new',
1331 `kill-append', and `current-kill' are supposed to implement this
1332 interaction; you may want to use them instead of manipulating the kill
1335 (defcustom kill-ring-max 30
1336 "*Maximum length of kill ring before oldest elements are thrown away."
1340 (defvar kill-ring-yank-pointer nil
1341 "The tail of the kill ring whose car is the last thing yanked.")
1343 (defun kill-new (string &optional replace)
1344 "Make STRING the latest kill in the kill ring.
1345 Set the kill-ring-yank pointer to point to it.
1346 If `interprogram-cut-function' is non-nil, apply it to STRING.
1347 Optional second argument REPLACE non-nil means that STRING will replace
1348 the front of the kill ring, rather than being added to the list."
1349 (and (fboundp 'menu-bar-update-yank-menu)
1350 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1352 (setcar kill-ring string)
1353 (setq kill-ring (cons string kill-ring))
1354 (if (> (length kill-ring) kill-ring-max)
1355 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1356 (setq kill-ring-yank-pointer kill-ring)
1357 (if interprogram-cut-function
1358 (funcall interprogram-cut-function string (not replace))))
1360 (defun kill-append (string before-p)
1361 "Append STRING to the end of the latest kill in the kill ring.
1362 If BEFORE-P is non-nil, prepend STRING to the kill.
1363 If `interprogram-cut-function' is set, pass the resulting kill to
1365 (kill-new (if before-p
1366 (concat string (car kill-ring))
1367 (concat (car kill-ring) string)) t))
1369 (defun current-kill (n &optional do-not-move)
1370 "Rotate the yanking point by N places, and then return that kill.
1371 If N is zero, `interprogram-paste-function' is set, and calling it
1372 returns a string, then that string is added to the front of the
1373 kill ring and returned as the latest kill.
1374 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1375 yanking point; just return the Nth kill forward."
1376 (let ((interprogram-paste (and (= n 0)
1377 interprogram-paste-function
1378 (funcall interprogram-paste-function))))
1379 (if interprogram-paste
1381 ;; Disable the interprogram cut function when we add the new
1382 ;; text to the kill ring, so Emacs doesn't try to own the
1383 ;; selection, with identical text.
1384 (let ((interprogram-cut-function nil))
1385 (kill-new interprogram-paste))
1387 (or kill-ring (error "Kill ring is empty"))
1388 (let ((ARGth-kill-element
1389 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1393 (setq kill-ring-yank-pointer ARGth-kill-element))
1394 (car ARGth-kill-element)))))
1398 ;;;; Commands for manipulating the kill ring.
1400 (defcustom kill-read-only-ok nil
1401 "*Non-nil means don't signal an error for killing read-only text."
1405 (put 'text-read-only 'error-conditions
1406 '(text-read-only buffer-read-only error))
1407 (put 'text-read-only 'error-message "Text is read-only")
1409 (defun kill-region (beg end)
1410 "Kill between point and mark.
1411 The text is deleted but saved in the kill ring.
1412 The command \\[yank] can retrieve it from there.
1413 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1414 If the buffer is read-only, Emacs will beep and refrain from deleting
1415 the text, but put the text in the kill ring anyway. This means that
1416 you can use the killing commands to copy text from a read-only buffer.
1418 This is the primitive for programs to kill text (as opposed to deleting it).
1419 Supply two arguments, character numbers indicating the stretch of text
1421 Any command that calls this function is a \"kill command\".
1422 If the previous command was also a kill command,
1423 the text killed this time appends to the text killed last time
1424 to make one entry in the kill ring."
1427 ;; Don't let the undo list be truncated before we can even access it.
1428 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1429 (old-list buffer-undo-list)
1431 ;; If we can't rely on finding the killed text
1432 ;; in the undo list, save it now as a string.
1433 (string (if (or (eq buffer-undo-list t)
1435 (buffer-substring beg end))))
1436 (delete-region beg end)
1437 ;; Search back in buffer-undo-list for this string,
1438 ;; in case a change hook made property changes.
1439 (setq tail buffer-undo-list)
1441 (while (not (stringp (car (car tail))))
1442 (setq tail (cdr tail)))
1443 ;; If we did not already make the string to use,
1444 ;; use the same one that undo made for us.
1445 (setq string (car (car tail))))
1446 ;; Add that string to the kill ring, one way or another.
1447 (if (eq last-command 'kill-region)
1448 (kill-append string (< end beg))
1450 (setq this-command 'kill-region))
1451 ((buffer-read-only text-read-only)
1452 ;; The code above failed because the buffer, or some of the characters
1453 ;; in the region, are read-only.
1454 ;; We should beep, in case the user just isn't aware of this.
1455 ;; However, there's no harm in putting
1456 ;; the region's text in the kill ring, anyway.
1457 (copy-region-as-kill beg end)
1458 ;; This should always barf, and give us the correct error.
1459 (if kill-read-only-ok
1460 (message "Read only text copied to kill ring")
1461 (setq this-command 'kill-region)
1462 ;; Signal an error if the buffer is read-only.
1463 (barf-if-buffer-read-only)
1464 ;; If the buffer isn't read-only, the text is.
1465 (signal 'text-read-only (list (current-buffer)))))))
1467 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1468 ;; to get two copies of the text when the user accidentally types M-w and
1469 ;; then corrects it with the intended C-w.
1470 (defun copy-region-as-kill (beg end)
1471 "Save the region as if killed, but don't kill it.
1472 If `interprogram-cut-function' is non-nil, also save the text for a window
1473 system cut and paste."
1475 (if (eq last-command 'kill-region)
1476 (kill-append (buffer-substring beg end) (< end beg))
1477 (kill-new (buffer-substring beg end)))
1480 (defun kill-ring-save (beg end)
1481 "Save the region as if killed, but don't kill it.
1482 This command is similar to `copy-region-as-kill', except that it gives
1483 visual feedback indicating the extent of the region being copied.
1484 If `interprogram-cut-function' is non-nil, also save the text for a window
1485 system cut and paste."
1487 (copy-region-as-kill beg end)
1489 (let ((other-end (if (= (point) beg) end beg))
1491 ;; Inhibit quitting so we can make a quit here
1492 ;; look like a C-g typed as a command.
1494 (if (pos-visible-in-window-p other-end (selected-window))
1496 ;; Swap point and mark.
1497 (set-marker (mark-marker) (point) (current-buffer))
1498 (goto-char other-end)
1501 (set-marker (mark-marker) other-end (current-buffer))
1503 ;; If user quit, deactivate the mark
1504 ;; as C-g would as a command.
1505 (and quit-flag mark-active
1507 (let* ((killed-text (current-kill 0))
1508 (message-len (min (length killed-text) 40)))
1510 ;; Don't say "killed"; that is misleading.
1511 (message "Saved text until \"%s\""
1512 (substring killed-text (- message-len)))
1513 (message "Saved text from \"%s\""
1514 (substring killed-text 0 message-len))))))))
1516 (defun append-next-kill ()
1517 "Cause following command, if it kills, to append to previous kill."
1521 (setq this-command 'kill-region)
1522 (message "If the next command is a kill, it will append"))
1523 (setq last-command 'kill-region)))
1525 (defun yank-pop (arg)
1526 "Replace just-yanked stretch of killed text with a different stretch.
1527 This command is allowed only immediately after a `yank' or a `yank-pop'.
1528 At such a time, the region contains a stretch of reinserted
1529 previously-killed text. `yank-pop' deletes that text and inserts in its
1530 place a different stretch of killed text.
1532 With no argument, the previous kill is inserted.
1533 With argument N, insert the Nth previous kill.
1534 If N is negative, this is a more recent kill.
1536 The sequence of kills wraps around, so that after the oldest one
1537 comes the newest one."
1539 (if (not (eq last-command 'yank))
1540 (error "Previous command was not a yank"))
1541 (setq this-command 'yank)
1542 (let ((inhibit-read-only t)
1543 (before (< (point) (mark t))))
1544 (delete-region (point) (mark t))
1545 (set-marker (mark-marker) (point) (current-buffer))
1546 (let ((opoint (point)))
1547 (insert (current-kill arg))
1548 (let ((inhibit-read-only t))
1549 (remove-text-properties opoint (point) '(read-only nil))))
1551 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1552 ;; It is cleaner to avoid activation, even though the command
1553 ;; loop would deactivate the mark because we inserted text.
1554 (goto-char (prog1 (mark t)
1555 (set-marker (mark-marker) (point) (current-buffer))))))
1558 (defun yank (&optional arg)
1559 "Reinsert the last stretch of killed text.
1560 More precisely, reinsert the stretch of killed text most recently
1561 killed OR yanked. Put point at end, and set mark at beginning.
1562 With just C-u as argument, same but put point at beginning (and mark at end).
1563 With argument N, reinsert the Nth most recently killed stretch of killed
1565 See also the command \\[yank-pop]."
1567 ;; If we don't get all the way thru, make last-command indicate that
1568 ;; for the following command.
1569 (setq this-command t)
1571 (let ((opoint (point)))
1572 (insert (current-kill (cond
1576 (let ((inhibit-read-only t))
1577 (remove-text-properties opoint (point) '(read-only nil))))
1579 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1580 ;; It is cleaner to avoid activation, even though the command
1581 ;; loop would deactivate the mark because we inserted text.
1582 (goto-char (prog1 (mark t)
1583 (set-marker (mark-marker) (point) (current-buffer)))))
1584 ;; If we do get all the way thru, make this-command indicate that.
1585 (setq this-command 'yank)
1588 (defun rotate-yank-pointer (arg)
1589 "Rotate the yanking point in the kill ring.
1590 With argument, rotate that many kills forward (or backward, if negative)."
1595 (defun insert-buffer (buffer)
1596 "Insert after point the contents of BUFFER.
1597 Puts mark after the inserted text.
1598 BUFFER may be a buffer or a buffer name."
1602 (barf-if-buffer-read-only)
1603 (read-buffer "Insert buffer: "
1604 (if (eq (selected-window) (next-window (selected-window)))
1605 (other-buffer (current-buffer))
1606 (window-buffer (next-window (selected-window))))
1608 (or (bufferp buffer)
1609 (setq buffer (get-buffer buffer)))
1610 (let (start end newmark)
1614 (setq start (point-min) end (point-max)))
1615 (insert-buffer-substring buffer start end)
1616 (setq newmark (point)))
1617 (push-mark newmark))
1620 (defun append-to-buffer (buffer start end)
1621 "Append to specified buffer the text of the region.
1622 It is inserted into that buffer before its point.
1624 When calling from a program, give three arguments:
1625 BUFFER (or buffer name), START and END.
1626 START and END specify the portion of the current buffer to be copied."
1628 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
1629 (region-beginning) (region-end)))
1630 (let ((oldbuf (current-buffer)))
1632 (set-buffer (get-buffer-create buffer))
1633 (insert-buffer-substring oldbuf start end))))
1635 (defun prepend-to-buffer (buffer start end)
1636 "Prepend to specified buffer the text of the region.
1637 It is inserted into that buffer after its point.
1639 When calling from a program, give three arguments:
1640 BUFFER (or buffer name), START and END.
1641 START and END specify the portion of the current buffer to be copied."
1642 (interactive "BPrepend to buffer: \nr")
1643 (let ((oldbuf (current-buffer)))
1645 (set-buffer (get-buffer-create buffer))
1647 (insert-buffer-substring oldbuf start end)))))
1649 (defun copy-to-buffer (buffer start end)
1650 "Copy to specified buffer the text of the region.
1651 It is inserted into that buffer, replacing existing text there.
1653 When calling from a program, give three arguments:
1654 BUFFER (or buffer name), START and END.
1655 START and END specify the portion of the current buffer to be copied."
1656 (interactive "BCopy to buffer: \nr")
1657 (let ((oldbuf (current-buffer)))
1659 (set-buffer (get-buffer-create buffer))
1662 (insert-buffer-substring oldbuf start end)))))
1664 (put 'mark-inactive 'error-conditions '(mark-inactive error))
1665 (put 'mark-inactive 'error-message "The mark is not active now")
1667 (defun mark (&optional force)
1668 "Return this buffer's mark value as integer; error if mark inactive.
1669 If optional argument FORCE is non-nil, access the mark value
1670 even if the mark is not currently active, and return nil
1671 if there is no mark at all.
1673 If you are using this in an editing command, you are most likely making
1674 a mistake; see the documentation of `set-mark'."
1675 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
1676 (marker-position (mark-marker))
1677 (signal 'mark-inactive nil)))
1679 ;; Many places set mark-active directly, and several of them failed to also
1680 ;; run deactivate-mark-hook. This shorthand should simplify.
1681 (defsubst deactivate-mark ()
1682 "Deactivate the mark by setting `mark-active' to nil.
1683 \(That makes a difference only in Transient Mark mode.)
1684 Also runs the hook `deactivate-mark-hook'."
1685 (if transient-mark-mode
1687 (setq mark-active nil)
1688 (run-hooks 'deactivate-mark-hook))))
1690 (defun set-mark (pos)
1691 "Set this buffer's mark to POS. Don't use this function!
1692 That is to say, don't use this function unless you want
1693 the user to see that the mark has moved, and you want the previous
1694 mark position to be lost.
1696 Normally, when a new mark is set, the old one should go on the stack.
1697 This is why most applications should use push-mark, not set-mark.
1699 Novice Emacs Lisp programmers often try to use the mark for the wrong
1700 purposes. The mark saves a location for the user's convenience.
1701 Most editing commands should not alter the mark.
1702 To remember a location for internal use in the Lisp program,
1703 store it in a Lisp variable. Example:
1705 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1709 (setq mark-active t)
1710 (run-hooks 'activate-mark-hook)
1711 (set-marker (mark-marker) pos (current-buffer)))
1712 ;; Normally we never clear mark-active except in Transient Mark mode.
1713 ;; But when we actually clear out the mark value too,
1714 ;; we must clear mark-active in any mode.
1715 (setq mark-active nil)
1716 (run-hooks 'deactivate-mark-hook)
1717 (set-marker (mark-marker) nil)))
1719 (defvar mark-ring nil
1720 "The list of former marks of the current buffer, most recent first.")
1721 (make-variable-buffer-local 'mark-ring)
1722 (put 'mark-ring 'permanent-local t)
1724 (defcustom mark-ring-max 16
1725 "*Maximum size of mark ring. Start discarding off end if gets this big."
1727 :group 'editing-basics)
1729 (defvar global-mark-ring nil
1730 "The list of saved global marks, most recent first.")
1732 (defcustom global-mark-ring-max 16
1733 "*Maximum size of global mark ring. \
1734 Start discarding off end if gets this big."
1736 :group 'editing-basics)
1738 (defun set-mark-command (arg)
1739 "Set mark at where point is, or jump to mark.
1740 With no prefix argument, set mark, push old mark position on local mark
1741 ring, and push mark on global mark ring.
1742 With argument, jump to mark, and pop a new position for mark off the ring
1743 \(does not affect global mark ring\).
1745 Novice Emacs Lisp programmers often try to use the mark for the wrong
1746 purposes. See the documentation of `set-mark' for more information."
1750 (push-mark nil nil t))
1752 (error "No mark set in this buffer")
1753 (goto-char (mark t))
1756 (defun push-mark (&optional location nomsg activate)
1757 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1758 If the last global mark pushed was not in the current buffer,
1759 also push LOCATION on the global mark ring.
1760 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1761 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
1763 Novice Emacs Lisp programmers often try to use the mark for the wrong
1764 purposes. See the documentation of `set-mark' for more information.
1766 In Transient Mark mode, this does not activate the mark."
1769 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1770 (if (> (length mark-ring) mark-ring-max)
1772 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1773 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1774 (set-marker (mark-marker) (or location (point)) (current-buffer))
1775 ;; Now push the mark on the global mark ring.
1776 (if (and global-mark-ring
1777 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
1778 ;; The last global mark pushed was in this same buffer.
1779 ;; Don't push another one.
1781 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1782 (if (> (length global-mark-ring) global-mark-ring-max)
1784 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1786 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
1787 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
1788 (message "Mark set"))
1789 (if (or activate (not transient-mark-mode))
1790 (set-mark (mark t)))
1794 "Pop off mark ring into the buffer's actual mark.
1795 Does not set point. Does nothing if mark ring is empty."
1798 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1799 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1801 (move-marker (car mark-ring) nil)
1802 (if (null (mark t)) (ding))
1803 (setq mark-ring (cdr mark-ring)))))
1805 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
1806 (defun exchange-point-and-mark ()
1807 "Put the mark where point is now, and point where the mark is now.
1808 This command works even when the mark is not active,
1809 and it reactivates the mark."
1811 (let ((omark (mark t)))
1813 (error "No mark set in this buffer"))
1818 (defun transient-mark-mode (arg)
1819 "Toggle Transient Mark mode.
1820 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1822 In Transient Mark mode, when the mark is active, the region is highlighted.
1823 Changing the buffer \"deactivates\" the mark.
1824 So do certain other operations that set the mark
1825 but whose main purpose is something else--for example,
1826 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
1828 (setq transient-mark-mode
1830 (not transient-mark-mode)
1831 (> (prefix-numeric-value arg) 0)))
1833 (if transient-mark-mode
1834 (message "Transient Mark mode enabled")
1835 (message "Transient Mark mode disabled"))))
1837 (defun pop-global-mark ()
1838 "Pop off global mark ring and jump to the top location."
1840 ;; Pop entries which refer to non-existent buffers.
1841 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1842 (setq global-mark-ring (cdr global-mark-ring)))
1843 (or global-mark-ring
1844 (error "No global mark set"))
1845 (let* ((marker (car global-mark-ring))
1846 (buffer (marker-buffer marker))
1847 (position (marker-position marker)))
1848 (setq global-mark-ring (nconc (cdr global-mark-ring)
1849 (list (car global-mark-ring))))
1851 (or (and (>= position (point-min))
1852 (<= position (point-max)))
1854 (goto-char position)
1855 (switch-to-buffer buffer)))
1857 (defcustom next-line-add-newlines t
1858 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
1860 :group 'editing-basics)
1862 (defun next-line (arg)
1863 "Move cursor vertically down ARG lines.
1864 If there is no character in the target line exactly under the current column,
1865 the cursor is positioned after the character in that line which spans this
1866 column, or at the end of the line if it is not long enough.
1867 If there is no line in the buffer after this one, behavior depends on the
1868 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
1869 to create a line, and moves the cursor to that line. Otherwise it moves the
1870 cursor to the end of the buffer.
1872 The command \\[set-goal-column] can be used to create
1873 a semipermanent goal column for this command.
1874 Then instead of trying to move exactly vertically (or as close as possible),
1875 this command moves to the specified goal column (or as close as possible).
1876 The goal column is stored in the variable `goal-column', which is nil
1877 when there is no goal column.
1879 If you are thinking of using this in a Lisp program, consider
1880 using `forward-line' instead. It is usually easier to use
1881 and more reliable (no dependence on goal column, etc.)."
1883 (if (and next-line-add-newlines (= arg 1))
1884 (let ((opoint (point)))
1893 ((beginning-of-buffer end-of-buffer) (ding)))
1897 (defun previous-line (arg)
1898 "Move cursor vertically up ARG lines.
1899 If there is no character in the target line exactly over the current column,
1900 the cursor is positioned after the character in that line which spans this
1901 column, or at the end of the line if it is not long enough.
1903 The command \\[set-goal-column] can be used to create
1904 a semipermanent goal column for this command.
1905 Then instead of trying to move exactly vertically (or as close as possible),
1906 this command moves to the specified goal column (or as close as possible).
1907 The goal column is stored in the variable `goal-column', which is nil
1908 when there is no goal column.
1910 If you are thinking of using this in a Lisp program, consider using
1911 `forward-line' with a negative argument instead. It is usually easier
1912 to use and more reliable (no dependence on goal column, etc.)."
1917 ((beginning-of-buffer end-of-buffer) (ding)))
1918 (line-move (- arg)))
1921 (defcustom track-eol nil
1922 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1923 This means moving to the end of each line moved onto.
1924 The beginning of a blank line does not count as the end of a line."
1926 :group 'editing-basics)
1928 (defcustom goal-column nil
1929 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
1930 :type '(choice integer
1931 (const :tag "None" nil))
1932 :group 'editing-basics)
1933 (make-variable-buffer-local 'goal-column)
1935 (defvar temporary-goal-column 0
1936 "Current goal column for vertical motion.
1937 It is the column where point was
1938 at the start of current run of vertical motion commands.
1939 When the `track-eol' feature is doing its job, the value is 9999.")
1941 (defcustom line-move-ignore-invisible nil
1942 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
1943 Outline mode sets this."
1945 :group 'editing-basics)
1947 ;; This is the guts of next-line and previous-line.
1948 ;; Arg says how many lines to move.
1949 (defun line-move (arg)
1950 ;; Don't run any point-motion hooks, and disregard intangibility,
1951 ;; for intermediate positions.
1952 (let ((inhibit-point-motion-hooks t)
1954 new line-end line-beg)
1957 (if (not (or (eq last-command 'next-line)
1958 (eq last-command 'previous-line)))
1959 (setq temporary-goal-column
1960 (if (and track-eol (eolp)
1961 ;; Don't count beg of empty line as end of line
1962 ;; unless we just did explicit end-of-line.
1963 (or (not (bolp)) (eq last-command 'end-of-line)))
1966 (if (and (not (integerp selective-display))
1967 (not line-move-ignore-invisible))
1968 ;; Use just newline characters.
1970 (progn (if (> arg 1) (forward-line (1- arg)))
1971 ;; This way of moving forward ARG lines
1972 ;; verifies that we have a newline after the last one.
1973 ;; It doesn't get confused by intangible text.
1975 (zerop (forward-line 1)))
1976 (and (zerop (forward-line arg))
1978 (signal (if (< arg 0)
1979 'beginning-of-buffer
1982 ;; Move by arg lines, but ignore invisible ones.
1985 (and (zerop (vertical-motion 1))
1986 (signal 'end-of-buffer nil))
1987 ;; If the following character is currently invisible,
1988 ;; skip all characters with that same `invisible' property value.
1989 (while (and (not (eobp))
1991 (get-char-property (point) 'invisible)))
1992 (if (eq buffer-invisibility-spec t)
1994 (or (memq prop buffer-invisibility-spec)
1995 (assq prop buffer-invisibility-spec)))))
1996 (if (get-text-property (point) 'invisible)
1997 (goto-char (next-single-property-change (point) 'invisible))
1998 (goto-char (next-overlay-change (point)))))
1999 (setq arg (1- arg)))
2002 (and (zerop (vertical-motion -1))
2003 (signal 'beginning-of-buffer nil))
2004 (while (and (not (bobp))
2006 (get-char-property (1- (point)) 'invisible)))
2007 (if (eq buffer-invisibility-spec t)
2009 (or (memq prop buffer-invisibility-spec)
2010 (assq prop buffer-invisibility-spec)))))
2011 (if (get-text-property (1- (point)) 'invisible)
2012 (goto-char (previous-single-property-change (point) 'invisible))
2013 (goto-char (previous-overlay-change (point)))))
2014 (setq arg (1+ arg))))
2015 (let ((buffer-invisibility-spec nil))
2016 (move-to-column (or goal-column temporary-goal-column))))
2018 ;; If we are moving into some intangible text,
2019 ;; look for following text on the same line which isn't intangible
2021 (setq line-end (save-excursion (end-of-line) (point)))
2022 (setq line-beg (save-excursion (beginning-of-line) (point)))
2023 (let ((after (and (< new (point-max))
2024 (get-char-property new 'intangible)))
2025 (before (and (> new (point-min))
2026 (get-char-property (1- new) 'intangible))))
2027 (when (and before (eq before after)
2029 (goto-char (point-min))
2030 (let ((inhibit-point-motion-hooks nil))
2032 (if (<= new line-end)
2033 (setq new (point)))))
2034 ;; NEW is where we want to move to.
2035 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2036 ;; Move there in just one step, from our starting position,
2037 ;; with intangibility and point-motion hooks enabled this time.
2039 (setq inhibit-point-motion-hooks nil)
2041 ;; If intangibility processing moved us to a different line,
2042 ;; readjust the horizontal position within the line we ended up at.
2043 (when (or (< (point) line-beg) (> (point) line-end))
2045 (setq inhibit-point-motion-hooks t)
2046 (setq line-end (save-excursion (end-of-line) (point)))
2048 (setq line-beg (point))
2049 (let ((buffer-invisibility-spec nil))
2050 (move-to-column (or goal-column temporary-goal-column)))
2051 (if (<= (point) line-end)
2053 (goto-char (point-min))
2054 (setq inhibit-point-motion-hooks nil)
2059 ;;; Many people have said they rarely use this feature, and often type
2060 ;;; it by accident. Maybe it shouldn't even be on a key.
2061 (put 'set-goal-column 'disabled t)
2063 (defun set-goal-column (arg)
2064 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2065 Those commands will move to this position in the line moved to
2066 rather than trying to keep the same horizontal position.
2067 With a non-nil argument, clears out the goal column
2068 so that \\[next-line] and \\[previous-line] resume vertical motion.
2069 The goal column is stored in the variable `goal-column'."
2073 (setq goal-column nil)
2074 (message "No goal column"))
2075 (setq goal-column (current-column))
2076 (message (substitute-command-keys
2077 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2081 ;;; Partial support for horizontal autoscrolling. Someday, this feature
2082 ;;; will be built into the C level and all the (hscroll-point-visible) calls
2085 (defcustom hscroll-step 0
2086 "*The number of columns to try scrolling a window by when point moves out.
2087 If that fails to bring point back on frame, point is centered instead.
2088 If this is zero, point is always centered after it moves off frame."
2089 :type '(choice (const :tag "Alway Center" 0)
2090 (integer :format "%v" 1))
2091 :group 'editing-basics)
2093 (defun hscroll-point-visible ()
2094 "Scrolls the selected window horizontally to make point visible."
2096 (set-buffer (window-buffer))
2097 (if (not (or truncate-lines
2098 (> (window-hscroll) 0)
2099 (and truncate-partial-width-windows
2100 (< (window-width) (frame-width)))))
2101 ;; Point is always visible when lines are wrapped.
2103 ;; If point is on the invisible part of the line before window-start,
2104 ;; then hscrolling can't bring it back, so reset window-start first.
2105 (and (< (point) (window-start))
2106 (let ((ws-bol (save-excursion
2107 (goto-char (window-start))
2110 (and (>= (point) ws-bol)
2111 (set-window-start nil ws-bol))))
2112 (let* ((here (hscroll-window-column))
2113 (left (min (window-hscroll) 1))
2114 (right (1- (window-width))))
2115 ;; Allow for the truncation glyph, if we're not exactly at eol.
2116 (if (not (and (= here right)
2117 (= (following-char) ?\n)))
2118 (setq right (1- right)))
2120 ;; If too far away, just recenter. But don't show too much
2121 ;; white space off the end of the line.
2122 ((or (< here (- left hscroll-step))
2123 (> here (+ right hscroll-step)))
2124 (let ((eol (save-excursion (end-of-line) (hscroll-window-column))))
2125 (scroll-left (min (- here (/ (window-width) 2))
2126 (- eol (window-width) -5)))))
2127 ;; Within range. Scroll by one step (or maybe not at all).
2129 (scroll-right hscroll-step))
2131 (scroll-left hscroll-step)))))))
2133 ;; This function returns the window's idea of the display column of point,
2134 ;; assuming that the window is already known to be truncated rather than
2135 ;; wrapped, and that we've already handled the case where point is on the
2136 ;; part of the line before window-start. We ignore window-width; if point
2137 ;; is beyond the right margin, we want to know how far. The return value
2138 ;; includes the effects of window-hscroll, window-start, and the prompt
2139 ;; string in the minibuffer. It may be negative due to hscroll.
2140 (defun hscroll-window-column ()
2141 (let* ((hscroll (window-hscroll))
2142 (startpos (save-excursion
2144 (if (= (point) (save-excursion
2145 (goto-char (window-start))
2148 (goto-char (window-start)))
2150 (hpos (+ (if (and (eq (selected-window) (minibuffer-window))
2151 (= 1 (window-start))
2152 (= startpos (point-min)))
2153 (minibuffer-prompt-width)
2155 (min 0 (- 1 hscroll))))
2157 (car (cdr (compute-motion startpos (cons hpos 0)
2159 1000000 (cons hscroll 0) nil)))))
2162 ;; rms: (1) The definitions of arrow keys should not simply restate
2163 ;; what keys they are. The arrow keys should run the ordinary commands.
2164 ;; (2) The arrow keys are just one of many common ways of moving point
2165 ;; within a line. Real horizontal autoscrolling would be a good feature,
2166 ;; but supporting it only for arrow keys is too incomplete to be desirable.
2168 ;;;;; Make arrow keys do the right thing for improved terminal support
2169 ;;;;; When we implement true horizontal autoscrolling, right-arrow and
2170 ;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
2171 ;;;;; aliases. These functions are bound to the corresponding keyboard
2172 ;;;;; events in loaddefs.el.
2174 ;;(defun right-arrow (arg)
2175 ;; "Move right one character on the screen (with prefix ARG, that many chars).
2176 ;;Scroll right if needed to keep point horizontally onscreen."
2177 ;; (interactive "P")
2178 ;; (forward-char arg)
2179 ;; (hscroll-point-visible))
2181 ;;(defun left-arrow (arg)
2182 ;; "Move left one character on the screen (with prefix ARG, that many chars).
2183 ;;Scroll left if needed to keep point horizontally onscreen."
2184 ;; (interactive "P")
2185 ;; (backward-char arg)
2186 ;; (hscroll-point-visible))
2188 (defun scroll-other-window-down (lines)
2189 "Scroll the \"other window\" down.
2190 For more details, see the documentation for `scroll-other-window'."
2192 (scroll-other-window
2193 ;; Just invert the argument's meaning.
2194 ;; We can do that without knowing which window it will be.
2195 (if (eq lines '-) nil
2197 (- (prefix-numeric-value lines))))))
2198 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2200 (defun beginning-of-buffer-other-window (arg)
2201 "Move point to the beginning of the buffer in the other window.
2202 Leave mark at previous position.
2203 With arg N, put point N/10 of the way from the true beginning."
2205 (let ((orig-window (selected-window))
2206 (window (other-window-for-scrolling)))
2207 ;; We use unwind-protect rather than save-window-excursion
2208 ;; because the latter would preserve the things we want to change.
2211 (select-window window)
2212 ;; Set point and mark in that window's buffer.
2213 (beginning-of-buffer arg)
2214 ;; Set point accordingly.
2216 (select-window orig-window))))
2218 (defun end-of-buffer-other-window (arg)
2219 "Move point to the end of the buffer in the other window.
2220 Leave mark at previous position.
2221 With arg N, put point N/10 of the way from the true end."
2223 ;; See beginning-of-buffer-other-window for comments.
2224 (let ((orig-window (selected-window))
2225 (window (other-window-for-scrolling)))
2228 (select-window window)
2231 (select-window orig-window))))
2233 (defun transpose-chars (arg)
2234 "Interchange characters around point, moving forward one character.
2235 With prefix arg ARG, effect is to take character before point
2236 and drag it forward past ARG other characters (backward if ARG negative).
2237 If no argument and at end of line, the previous two chars are exchanged."
2239 (and (null arg) (eolp) (forward-char -1))
2240 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2242 (defun transpose-words (arg)
2243 "Interchange words around point, leaving point at end of them.
2244 With prefix arg ARG, effect is to take word before or around point
2245 and drag it forward past ARG other words (backward if ARG negative).
2246 If ARG is zero, the words around or after point and around or after mark
2249 (transpose-subr 'forward-word arg))
2251 (defun transpose-sexps (arg)
2252 "Like \\[transpose-words] but applies to sexps.
2253 Does not work on a sexp that point is in the middle of
2254 if it is a list or string."
2256 (transpose-subr 'forward-sexp arg))
2258 (defun transpose-lines (arg)
2259 "Exchange current line and previous line, leaving point after both.
2260 With argument ARG, takes previous line and moves it past ARG lines.
2261 With argument 0, interchanges line point is in with line mark is in."
2263 (transpose-subr (function
2267 ;; Move forward over ARG lines,
2268 ;; but create newlines if necessary.
2269 (setq arg (forward-line arg))
2270 (if (/= (preceding-char) ?\n)
2271 (setq arg (1+ arg)))
2274 (forward-line arg))))
2277 (defun transpose-subr (mover arg)
2278 (let (start1 end1 start2 end2)
2285 (setq start2 (point))
2290 (setq start1 (point))
2292 (exchange-point-and-mark))
2296 (setq start1 (point))
2301 (funcall mover (- arg))
2302 (setq start2 (point))
2306 (setq start2 (point))
2309 (funcall mover (1- arg))
2310 (setq start1 (point))
2311 (funcall mover (- arg))
2313 (transpose-subr-1)))))
2315 (defun transpose-subr-1 ()
2316 (if (> (min end1 end2) (max start1 start2))
2317 (error "Don't have two things to transpose"))
2318 (let* ((word1 (buffer-substring start1 end1))
2319 (len1 (length word1))
2320 (word2 (buffer-substring start2 end2))
2321 (len2 (length word2)))
2322 (delete-region start2 end2)
2325 (goto-char (if (< start1 start2) start1
2326 (+ start1 (- len1 len2))))
2327 (delete-region (point) (+ (point) len1))
2330 (defcustom comment-column 32
2331 "*Column to indent right-margin comments to.
2332 Setting this variable automatically makes it local to the current buffer.
2333 Each mode establishes a different default value for this variable; you
2334 can set the value for a particular mode using that mode's hook."
2336 :group 'fill-comments)
2337 (make-variable-buffer-local 'comment-column)
2339 (defcustom comment-start nil
2340 "*String to insert to start a new comment, or nil if no comment syntax."
2341 :type '(choice (const :tag "None" nil)
2343 :group 'fill-comments)
2345 (defcustom comment-start-skip nil
2346 "*Regexp to match the start of a comment plus everything up to its body.
2347 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
2348 at the place matched by the close of the first pair."
2349 :type '(choice (const :tag "None" nil)
2351 :group 'fill-comments)
2353 (defcustom comment-end ""
2354 "*String to insert to end a new comment.
2355 Should be an empty string if comments are terminated by end-of-line."
2357 :group 'fill-comments)
2359 (defvar comment-indent-hook nil
2360 "Obsolete variable for function to compute desired indentation for a comment.
2361 This function is called with no args with point at the beginning of
2362 the comment's starting delimiter.")
2364 (defvar comment-indent-function
2365 '(lambda () comment-column)
2366 "Function to compute desired indentation for a comment.
2367 This function is called with no args with point at the beginning of
2368 the comment's starting delimiter.")
2370 (defcustom block-comment-start nil
2371 "*String to insert to start a new comment on a line by itself.
2372 If nil, use `comment-start' instead.
2373 Note that the regular expression `comment-start-skip' should skip this string
2374 as well as the `comment-start' string."
2375 :type '(choice (const :tag "Use comment-start" nil)
2377 :group 'fill-comments)
2379 (defcustom block-comment-end nil
2380 "*String to insert to end a new comment on a line by itself.
2381 Should be an empty string if comments are terminated by end-of-line.
2382 If nil, use `comment-end' instead."
2383 :type '(choice (const :tag "Use comment-end" nil)
2385 :group 'fill-comments)
2387 (defun indent-for-comment ()
2388 "Indent this line's comment to comment column, or insert an empty comment."
2390 (let* ((empty (save-excursion (beginning-of-line)
2391 (looking-at "[ \t]*$")))
2392 (starter (or (and empty block-comment-start) comment-start))
2393 (ender (or (and empty block-comment-end) comment-end)))
2396 (error "No comment syntax defined"))
2397 ((null comment-start-skip)
2398 (error "This mode doesn't define `comment-start-skip'"))
2399 (t (let* ((eolpos (save-excursion (end-of-line) (point)))
2402 (if (re-search-forward comment-start-skip eolpos 'move)
2403 (progn (setq cpos (point-marker))
2404 ;; Find the start of the comment delimiter.
2405 ;; If there were paren-pairs in comment-start-skip,
2406 ;; position at the end of the first pair.
2408 (goto-char (match-end 1))
2409 ;; If comment-start-skip matched a string with
2410 ;; internal whitespace (not final whitespace) then
2411 ;; the delimiter start at the end of that
2412 ;; whitespace. Otherwise, it starts at the
2413 ;; beginning of what was matched.
2414 (skip-syntax-backward " " (match-beginning 0))
2415 (skip-syntax-backward "^ " (match-beginning 0)))))
2416 (setq begpos (point))
2417 ;; Compute desired indent.
2418 (if (= (current-column)
2419 (setq indent (if comment-indent-hook
2420 (funcall comment-indent-hook)
2421 (funcall comment-indent-function))))
2423 ;; If that's different from current, change it.
2424 (skip-chars-backward " \t")
2425 (delete-region (point) begpos)
2427 ;; An existing comment?
2429 (progn (goto-char cpos)
2430 (set-marker cpos nil))
2434 (insert ender))))))))
2436 (defun set-comment-column (arg)
2437 "Set the comment column based on point.
2438 With no arg, set the comment column to the current column.
2439 With just minus as arg, kill any comment on this line.
2440 With any other arg, set comment column to indentation of the previous comment
2441 and then align or create a comment on this line at that column."
2449 (re-search-backward comment-start-skip)
2451 (re-search-forward comment-start-skip)
2452 (goto-char (match-beginning 0))
2453 (setq comment-column (current-column))
2454 (message "Comment column set to %d" comment-column))
2455 (indent-for-comment))
2456 (setq comment-column (current-column))
2457 (message "Comment column set to %d" comment-column))))
2459 (defun kill-comment (arg)
2460 "Kill the comment on this line, if any.
2461 With argument, kill comments on that many lines starting with this one."
2462 ;; this function loses in a lot of situations. it incorrectly recognises
2463 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
2464 ;; with multi-line comments, can kill extra whitespace if comment wasn't
2465 ;; through end-of-line, et cetera.
2467 (or comment-start-skip (error "No comment syntax defined"))
2468 (let ((count (prefix-numeric-value arg)) endc)
2474 (and (string< "" comment-end)
2477 (re-search-forward (regexp-quote comment-end) endc 'move)
2478 (skip-chars-forward " \t")
2481 (if (re-search-forward comment-start-skip endc t)
2483 (goto-char (match-beginning 0))
2484 (skip-chars-backward " \t")
2485 (kill-region (point) endc)
2486 ;; to catch comments a line beginnings
2487 (indent-according-to-mode))))
2488 (if arg (forward-line 1))
2489 (setq count (1- count)))))
2491 (defvar comment-padding 1
2492 "Number of spaces `comment-region' puts between comment chars and text.
2494 Extra spacing between the comment characters and the comment text
2495 makes the comment easier to read. Default is 1. Nil means 0 and is
2498 (defun comment-region (beg end &optional arg)
2499 "Comment or uncomment each line in the region.
2500 With just C-u prefix arg, uncomment each line in region.
2501 Numeric prefix arg ARG means use ARG comment characters.
2502 If ARG is negative, delete that many comment characters instead.
2503 Comments are terminated on each line, even for syntax in which newline does
2504 not end the comment. Blank lines do not get comments."
2505 ;; if someone wants it to only put a comment-start at the beginning and
2506 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2507 ;; is easy enough. No option is made here for other than commenting
2509 (interactive "r\nP")
2510 (or comment-start (error "No comment syntax is defined"))
2511 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
2514 (let ((cs comment-start) (ce comment-end)
2516 (if (consp arg) (setq numarg t)
2517 (setq numarg (prefix-numeric-value arg))
2518 ;; For positive arg > 1, replicate the comment delims now,
2519 ;; then insert the replicated strings just once.
2521 (setq cs (concat cs comment-start)
2522 ce (concat ce comment-end))
2523 (setq numarg (1- numarg))))
2524 (when comment-padding
2525 (setq cs (concat cs (make-string comment-padding ? ))))
2526 ;; Loop over all lines from BEG to END.
2527 (narrow-to-region beg end)
2530 (if (or (eq numarg t) (< numarg 0))
2532 ;; Delete comment start from beginning of line.
2534 (while (looking-at (regexp-quote cs))
2535 (delete-char (length cs)))
2536 (let ((count numarg))
2537 (while (and (> 1 (setq count (1+ count)))
2538 (looking-at (regexp-quote cs)))
2539 (delete-char (length cs)))))
2540 ;; Delete comment end from end of line.
2546 ;; This is questionable if comment-end ends in
2547 ;; whitespace. That is pretty brain-damaged,
2549 (while (progn (skip-chars-backward " \t")
2550 (and (>= (- (point) (point-min)) (length ce))
2552 (backward-char (length ce))
2553 (looking-at (regexp-quote ce)))))
2554 (delete-char (- (length ce)))))
2555 (let ((count numarg))
2556 (while (> 1 (setq count (1+ count)))
2558 ;; this is questionable if comment-end ends in whitespace
2559 ;; that is pretty brain-damaged though
2560 (skip-chars-backward " \t")
2562 (backward-char (length ce))
2563 (if (looking-at (regexp-quote ce))
2564 (delete-char (length ce))))))))
2566 ;; Insert at beginning and at end.
2567 (if (looking-at "[ \t]*$") ()
2569 (if (string= "" ce) ()
2572 (search-forward "\n" nil 'move)))))))
2574 (defun backward-word (arg)
2575 "Move backward until encountering the end of a word.
2576 With argument, do this that many times.
2577 In programs, it is faster to call `forward-word' with negative arg."
2579 (forward-word (- arg)))
2581 (defun mark-word (arg)
2582 "Set mark arg words away from point."
2590 (defun kill-word (arg)
2591 "Kill characters forward until encountering the end of a word.
2592 With argument, do this that many times."
2594 (kill-region (point) (progn (forward-word arg) (point))))
2596 (defun backward-kill-word (arg)
2597 "Kill characters backward until encountering the end of a word.
2598 With argument, do this that many times."
2600 (kill-word (- arg)))
2602 (defun current-word (&optional strict)
2603 "Return the word point is on (or a nearby word) as a string.
2604 If optional arg STRICT is non-nil, return nil unless point is within
2605 or adjacent to a word."
2607 (let ((oldpoint (point)) (start (point)) (end (point)))
2608 (skip-syntax-backward "w_") (setq start (point))
2609 (goto-char oldpoint)
2610 (skip-syntax-forward "w_") (setq end (point))
2611 (if (and (eq start oldpoint) (eq end oldpoint))
2612 ;; Point is neither within nor adjacent to a word.
2615 ;; Look for preceding word in same line.
2616 (skip-syntax-backward "^w_"
2617 (save-excursion (beginning-of-line)
2620 ;; No preceding word in same line.
2621 ;; Look for following word in same line.
2623 (skip-syntax-forward "^w_"
2624 (save-excursion (end-of-line)
2626 (setq start (point))
2627 (skip-syntax-forward "w_")
2630 (skip-syntax-backward "w_")
2631 (setq start (point)))
2632 (buffer-substring-no-properties start end)))
2633 (buffer-substring-no-properties start end)))))
2635 (defcustom fill-prefix nil
2636 "*String for filling to insert at front of new line, or nil for none.
2637 Setting this variable automatically makes it local to the current buffer."
2638 :type '(choice (const :tag "None" nil)
2641 (make-variable-buffer-local 'fill-prefix)
2643 (defcustom auto-fill-inhibit-regexp nil
2644 "*Regexp to match lines which should not be auto-filled."
2645 :type '(choice (const :tag "None" nil)
2649 (defvar comment-line-break-function 'indent-new-comment-line
2650 "*Mode-specific function which line breaks and continues a comment.
2652 This function is only called during auto-filling of a comment section.
2653 The function should take a single optional argument, which is a flag
2654 indicating whether it should use soft newlines.
2656 Setting this variable automatically makes it local to the current buffer.")
2658 ;; This function is the auto-fill-function of a buffer
2659 ;; when Auto-Fill mode is enabled.
2660 ;; It returns t if it really did any work.
2661 (defun do-auto-fill ()
2662 (let (fc justify bol give-up
2663 (fill-prefix fill-prefix))
2664 (if (or (not (setq justify (current-justification)))
2665 (null (setq fc (current-fill-column)))
2666 (and (eq justify 'left)
2667 (<= (current-column) fc))
2668 (save-excursion (beginning-of-line)
2670 (and auto-fill-inhibit-regexp
2671 (looking-at auto-fill-inhibit-regexp))))
2672 nil ;; Auto-filling not required
2673 (if (memq justify '(full center right))
2674 (save-excursion (unjustify-current-line)))
2676 ;; Choose a fill-prefix automatically.
2677 (if (and adaptive-fill-mode
2678 (or (null fill-prefix) (string= fill-prefix "")))
2680 (fill-context-prefix
2681 (save-excursion (backward-paragraph 1) (point))
2682 (save-excursion (forward-paragraph 1) (point)))))
2683 (and prefix (not (equal prefix ""))
2684 (setq fill-prefix prefix))))
2686 (while (and (not give-up) (> (current-column) fc))
2687 ;; Determine where to split the line.
2690 (let ((opoint (point))
2695 (setq after-prefix (point))
2697 (looking-at (regexp-quote fill-prefix))
2698 (setq after-prefix (match-end 0)))
2699 (move-to-column (1+ fc))
2700 ;; Move back to the point where we can break the
2701 ;; line at. We break the line between word or
2702 ;; after/before the character which has character
2703 ;; category `|'. We search space, \c| followed by
2704 ;; a character, or \c| follwoing a character. If
2705 ;; not found, place the point at beginning of line.
2707 ;; If this is after period and a single space,
2708 ;; move back once more--we don't want to break
2709 ;; the line there and make it look like a
2713 sentence-end-double-space
2714 (save-excursion (forward-char -1)
2715 (and (looking-at "\\. ")
2716 (not (looking-at "\\. "))))))
2718 (re-search-backward "[ \t]\\|\\c|.\\|.\\c|\\|^")
2719 ;; If we find nowhere on the line to break it,
2720 ;; break after one word. Set bounce to t
2721 ;; so we will not keep going in this while loop.
2722 (if (<= (point) after-prefix)
2724 (goto-char after-prefix)
2725 (re-search-forward "[ \t]" opoint t)
2727 (if (looking-at "[ \t]")
2728 ;; Break the line at word boundary.
2729 (skip-chars-backward " \t")
2730 ;; Break the line after/before \c|.
2732 (if (and enable-kinsoku enable-multibyte-characters)
2733 (kinsoku (save-excursion
2734 (forward-line 0) (point))))
2735 ;; Let fill-point be set to the place where we end up.
2738 ;; See whether the place we found is any good.
2740 (goto-char fill-point)
2742 ;; There is no use breaking at end of line.
2743 (not (save-excursion (skip-chars-forward " ") (eolp)))
2744 ;; It is futile to split at the end of the prefix
2745 ;; since we would just insert the prefix again.
2746 (not (and after-prefix (<= (point) after-prefix)))
2747 ;; Don't split right after a comment starter
2748 ;; since we would just make another comment starter.
2749 (not (and comment-start-skip
2750 (let ((limit (point)))
2752 (and (re-search-forward comment-start-skip
2754 (eq (point) limit)))))))
2755 ;; Ok, we have a useful place to break the line. Do it.
2756 (let ((prev-column (current-column)))
2757 ;; If point is at the fill-point, do not `save-excursion'.
2758 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2759 ;; point will end up before it rather than after it.
2761 (skip-chars-backward " \t")
2762 (= (point) fill-point))
2763 (funcall comment-line-break-function t)
2765 (goto-char fill-point)
2766 (funcall comment-line-break-function t)))
2767 ;; Now do justification, if required
2768 (if (not (eq justify 'left))
2771 (justify-current-line justify nil t)))
2772 ;; If making the new line didn't reduce the hpos of
2773 ;; the end of the line, then give up now;
2774 ;; trying again will not help.
2775 (if (>= (current-column) prev-column)
2777 ;; No good place to break => stop trying.
2779 ;; Justify last line.
2780 (justify-current-line justify t t)
2783 (defvar normal-auto-fill-function 'do-auto-fill
2784 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
2785 Some major modes set this.")
2787 (defun auto-fill-mode (&optional arg)
2788 "Toggle Auto Fill mode.
2789 With arg, turn Auto Fill mode on if and only if arg is positive.
2790 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
2791 automatically breaks the line at a previous space.
2793 The value of `normal-auto-fill-function' specifies the function to use
2794 for `auto-fill-function' when turning Auto Fill mode on."
2796 (prog1 (setq auto-fill-function
2798 (not auto-fill-function)
2799 (> (prefix-numeric-value arg) 0))
2800 normal-auto-fill-function
2802 (force-mode-line-update)))
2804 ;; This holds a document string used to document auto-fill-mode.
2805 (defun auto-fill-function ()
2806 "Automatically break line at a previous space, in insertion of text."
2809 (defun turn-on-auto-fill ()
2810 "Unconditionally turn on Auto Fill mode."
2813 (defun set-fill-column (arg)
2814 "Set `fill-column' to specified argument.
2815 Just \\[universal-argument] as argument means to use the current column."
2818 (setq arg (current-column)))
2819 (if (not (integerp arg))
2820 ;; Disallow missing argument; it's probably a typo for C-x C-f.
2821 (error "set-fill-column requires an explicit argument")
2822 (message "Fill column set to %d (was %d)" arg fill-column)
2823 (setq fill-column arg)))
2825 (defcustom comment-multi-line nil
2826 "*Non-nil means \\[indent-new-comment-line] should continue same comment
2827 on new line, with no new terminator or starter.
2828 This is obsolete because you might as well use \\[newline-and-indent]."
2830 :group 'fill-comments)
2832 (defun indent-new-comment-line (&optional soft)
2833 "Break line at point and indent, continuing comment if within one.
2834 This indents the body of the continued comment
2835 under the previous comment line.
2837 This command is intended for styles where you write a comment per line,
2838 starting a new comment (and terminating it if necessary) on each line.
2839 If you want to continue one comment across several lines, use \\[newline-and-indent].
2841 If a fill column is specified, it overrides the use of the comment column
2842 or comment indentation.
2844 The inserted newline is marked hard if `use-hard-newlines' is true,
2845 unless optional argument SOFT is non-nil."
2847 (let (comcol comstart)
2848 (skip-chars-backward " \t")
2849 (delete-region (point)
2850 (progn (skip-chars-forward " \t")
2852 (if soft (insert-and-inherit ?\n) (newline 1))
2855 (indent-to-left-margin)
2856 (insert-and-inherit fill-prefix))
2857 (if (not comment-multi-line)
2859 (if (and comment-start-skip
2860 (let ((opoint (point)))
2862 (re-search-forward comment-start-skip opoint t)))
2863 ;; The old line is a comment.
2864 ;; Set WIN to the pos of the comment-start.
2865 ;; But if the comment is empty, look at preceding lines
2866 ;; to find one that has a nonempty comment.
2868 ;; If comment-start-skip contains a \(...\) pair,
2869 ;; the real comment delimiter starts at the end of that pair.
2870 (let ((win (or (match-end 1) (match-beginning 0))))
2871 (while (and (eolp) (not (bobp))
2874 (setq opoint (point))
2876 (re-search-forward comment-start-skip opoint t)))
2877 (setq win (or (match-end 1) (match-beginning 0))))
2878 ;; Indent this line like what we found.
2880 (setq comcol (current-column))
2882 (buffer-substring (point) (match-end 0)))))))
2884 (let ((comment-column comcol)
2885 (comment-start comstart)
2886 (comment-end comment-end))
2887 (and comment-end (not (equal comment-end ""))
2888 ; (if (not comment-multi-line)
2891 (insert comment-end)
2893 ; (setq comment-column (+ comment-column (length comment-start))
2898 (setq comment-end ""))
2899 (insert-and-inherit ?\n)
2901 (indent-for-comment)
2903 ;; Make sure we delete the newline inserted above.
2906 (indent-according-to-mode)))))
2908 (defun set-selective-display (arg)
2909 "Set `selective-display' to ARG; clear it if no arg.
2910 When the value of `selective-display' is a number > 0,
2911 lines whose indentation is >= that value are not displayed.
2912 The variable `selective-display' has a separate value for each buffer."
2914 (if (eq selective-display t)
2915 (error "selective-display already in use for marked lines"))
2918 (narrow-to-region (point-min) (point))
2919 (goto-char (window-start))
2920 (vertical-motion (window-height)))))
2921 (setq selective-display
2922 (and arg (prefix-numeric-value arg)))
2923 (recenter current-vpos))
2924 (set-window-start (selected-window) (window-start (selected-window)))
2925 (princ "selective-display set to " t)
2926 (prin1 selective-display t)
2929 (defvar overwrite-mode-textual " Ovwrt"
2930 "The string displayed in the mode line when in overwrite mode.")
2931 (defvar overwrite-mode-binary " Bin Ovwrt"
2932 "The string displayed in the mode line when in binary overwrite mode.")
2934 (defun overwrite-mode (arg)
2935 "Toggle overwrite mode.
2936 With arg, turn overwrite mode on iff arg is positive.
2937 In overwrite mode, printing characters typed in replace existing text
2938 on a one-for-one basis, rather than pushing it to the right. At the
2939 end of a line, such characters extend the line. Before a tab,
2940 such characters insert until the tab is filled in.
2941 \\[quoted-insert] still inserts characters in overwrite mode; this
2942 is supposed to make it easier to insert characters when necessary."
2944 (setq overwrite-mode
2945 (if (if (null arg) (not overwrite-mode)
2946 (> (prefix-numeric-value arg) 0))
2947 'overwrite-mode-textual))
2948 (force-mode-line-update))
2950 (defun binary-overwrite-mode (arg)
2951 "Toggle binary overwrite mode.
2952 With arg, turn binary overwrite mode on iff arg is positive.
2953 In binary overwrite mode, printing characters typed in replace
2954 existing text. Newlines are not treated specially, so typing at the
2955 end of a line joins the line to the next, with the typed character
2956 between them. Typing before a tab character simply replaces the tab
2957 with the character typed.
2958 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2959 typing characters do.
2961 Note that binary overwrite mode is not its own minor mode; it is a
2962 specialization of overwrite-mode, entered by setting the
2963 `overwrite-mode' variable to `overwrite-mode-binary'."
2965 (setq overwrite-mode
2967 (not (eq overwrite-mode 'overwrite-mode-binary))
2968 (> (prefix-numeric-value arg) 0))
2969 'overwrite-mode-binary))
2970 (force-mode-line-update))
2972 (defcustom line-number-mode t
2973 "*Non-nil means display line number in mode line."
2975 :group 'editing-basics)
2977 (defun line-number-mode (arg)
2978 "Toggle Line Number mode.
2979 With arg, turn Line Number mode on iff arg is positive.
2980 When Line Number mode is enabled, the line number appears
2983 (setq line-number-mode
2984 (if (null arg) (not line-number-mode)
2985 (> (prefix-numeric-value arg) 0)))
2986 (force-mode-line-update))
2988 (defcustom column-number-mode nil
2989 "*Non-nil means display column number in mode line."
2991 :group 'editing-basics)
2993 (defun column-number-mode (arg)
2994 "Toggle Column Number mode.
2995 With arg, turn Column Number mode on iff arg is positive.
2996 When Column Number mode is enabled, the column number appears
2999 (setq column-number-mode
3000 (if (null arg) (not column-number-mode)
3001 (> (prefix-numeric-value arg) 0)))
3002 (force-mode-line-update))
3004 (defgroup paren-blinking nil
3005 "Blinking matching of parens and expressions."
3006 :prefix "blink-matching-"
3007 :group 'paren-matching)
3009 (defcustom blink-matching-paren t
3010 "*Non-nil means show matching open-paren when close-paren is inserted."
3012 :group 'paren-blinking)
3014 (defcustom blink-matching-paren-on-screen t
3015 "*Non-nil means show matching open-paren when it is on screen.
3016 If nil, means don't show it (but the open-paren can still be shown
3017 when it is off screen)."
3019 :group 'paren-blinking)
3021 (defcustom blink-matching-paren-distance (* 25 1024)
3022 "*If non-nil, is maximum distance to search for matching open-paren."
3024 :group 'paren-blinking)
3026 (defcustom blink-matching-delay 1
3027 "*Time in seconds to delay after showing a matching paren."
3029 :group 'paren-blinking)
3031 (defcustom blink-matching-paren-dont-ignore-comments nil
3032 "*Non-nil means `blink-matching-paren' will not ignore comments."
3034 :group 'paren-blinking)
3036 (defun blink-matching-open ()
3037 "Move cursor momentarily to the beginning of the sexp before point."
3039 (and (> (point) (1+ (point-min)))
3040 blink-matching-paren
3041 ;; Verify an even number of quoting characters precede the close.
3042 (= 1 (logand 1 (- (point)
3045 (skip-syntax-backward "/\\")
3047 (let* ((oldpos (point))
3052 (if blink-matching-paren-distance
3053 (narrow-to-region (max (point-min)
3054 (- (point) blink-matching-paren-distance))
3057 (let ((parse-sexp-ignore-comments
3058 (and parse-sexp-ignore-comments
3059 (not blink-matching-paren-dont-ignore-comments))))
3060 (setq blinkpos (scan-sexps oldpos -1)))
3063 (/= (char-syntax (char-after blinkpos))
3066 (or (null (matching-paren (char-after blinkpos)))
3067 (/= (char-after (1- oldpos))
3068 (matching-paren (char-after blinkpos))))))
3069 (if mismatch (setq blinkpos nil))
3072 (goto-char blinkpos)
3073 (if (pos-visible-in-window-p)
3074 (and blink-matching-paren-on-screen
3075 (sit-for blink-matching-delay))
3076 (goto-char blinkpos)
3079 ;; Show what precedes the open in its line, if anything.
3081 (skip-chars-backward " \t")
3083 (buffer-substring (progn (beginning-of-line) (point))
3085 ;; Show what follows the open in its line, if anything.
3088 (skip-chars-forward " \t")
3090 (buffer-substring blinkpos
3091 (progn (end-of-line) (point)))
3092 ;; Otherwise show the previous nonblank line,
3095 (skip-chars-backward "\n \t")
3098 (buffer-substring (progn
3099 (skip-chars-backward "\n \t")
3102 (progn (end-of-line)
3103 (skip-chars-backward " \t")
3105 ;; Replace the newline and other whitespace with `...'.
3107 (buffer-substring blinkpos (1+ blinkpos)))
3108 ;; There is nothing to show except the char itself.
3109 (buffer-substring blinkpos (1+ blinkpos))))))))
3111 (message "Mismatched parentheses"))
3112 ((not blink-matching-paren-distance)
3113 (message "Unmatched parenthesis"))))))))
3115 ;Turned off because it makes dbx bomb out.
3116 (setq blink-paren-function 'blink-matching-open)
3118 ;; This executes C-g typed while Emacs is waiting for a command.
3119 ;; Quitting out of a program does not go through here;
3120 ;; that happens in the QUIT macro at the C code level.
3121 (defun keyboard-quit ()
3122 "Signal a quit condition.
3123 During execution of Lisp code, this character causes a quit directly.
3124 At top-level, as an editor command, this simply beeps."
3129 (define-key global-map "\C-g" 'keyboard-quit)
3131 (defvar buffer-quit-function nil
3132 "Function to call to \"quit\" the current buffer, or nil if none.
3133 \\[keyboard-escape-quit] calls this function when its more local actions
3134 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3136 (defun keyboard-escape-quit ()
3137 "Exit the current \"mode\" (in a generalized sense of the word).
3138 This command can exit an interactive command such as `query-replace',
3139 can clear out a prefix argument or a region,
3140 can get out of the minibuffer or other recursive edit,
3141 cancel the use of the current buffer (for special-purpose buffers),
3142 or go back to just one window (by deleting all but the selected window)."
3144 (cond ((eq last-command 'mode-exited) nil)
3145 ((> (minibuffer-depth) 0)
3146 (abort-recursive-edit))
3149 ((and transient-mark-mode
3152 ((> (recursion-depth) 0)
3153 (exit-recursive-edit))
3154 (buffer-quit-function
3155 (funcall buffer-quit-function))
3156 ((not (one-window-p t))
3157 (delete-other-windows))
3158 ((string-match "^ \\*" (buffer-name (current-buffer)))
3161 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3163 (defcustom mail-user-agent 'sendmail-user-agent
3164 "*Your preference for a mail composition package.
3165 Various Emacs Lisp packages (e.g. reporter) require you to compose an
3166 outgoing email message. This variable lets you specify which
3167 mail-sending package you prefer.
3169 Valid values include:
3171 sendmail-user-agent -- use the default Emacs Mail package
3172 mh-e-user-agent -- use the Emacs interface to the MH mail system
3173 message-user-agent -- use the GNUS mail sending package
3175 Additional valid symbols may be available; check with the author of
3176 your package for details."
3177 :type '(radio (function-item :tag "Default Emacs mail"
3179 sendmail-user-agent)
3180 (function-item :tag "Emacs interface to MH"
3183 (function-item :tag "Gnus mail sending package"
3186 (function :tag "Other"))
3189 (defun define-mail-user-agent (symbol composefunc sendfunc
3190 &optional abortfunc hookvar)
3191 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3193 SYMBOL can be any Lisp symbol. Its function definition and/or
3194 value as a variable do not matter for this usage; we use only certain
3195 properties on its property list, to encode the rest of the arguments.
3197 COMPOSEFUNC is program callable function that composes an outgoing
3198 mail message buffer. This function should set up the basics of the
3199 buffer without requiring user interaction. It should populate the
3200 standard mail headers, leaving the `to:' and `subject:' headers blank
3203 COMPOSEFUNC should accept several optional arguments--the same
3204 arguments that `compose-mail' takes. See that function's documentation.
3206 SENDFUNC is the command a user would run to send the message.
3208 Optional ABORTFUNC is the command a user would run to abort the
3209 message. For mail packages that don't have a separate abort function,
3210 this can be `kill-buffer' (the equivalent of omitting this argument).
3212 Optional HOOKVAR is a hook variable that gets run before the message
3213 is actually sent. Callers that use the `mail-user-agent' may
3214 install a hook function temporarily on this hook variable.
3215 If HOOKVAR is nil, `mail-send-hook' is used.
3217 The properties used on SYMBOL are `composefunc', `sendfunc',
3218 `abortfunc', and `hookvar'."
3219 (put symbol 'composefunc composefunc)
3220 (put symbol 'sendfunc sendfunc)
3221 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3222 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3224 (defun assoc-ignore-case (key alist)
3225 "Like `assoc', but assumes KEY is a string and ignores case when comparing."
3226 (setq key (downcase key))
3228 (while (and alist (not element))
3229 (if (equal key (downcase (car (car alist))))
3230 (setq element (car alist)))
3231 (setq alist (cdr alist)))
3234 (define-mail-user-agent 'sendmail-user-agent
3235 'sendmail-user-agent-compose
3236 'mail-send-and-exit)
3238 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3239 switch-function yank-action
3242 (let ((special-display-buffer-names nil)
3243 (special-display-regexps nil)
3244 (same-window-buffer-names nil)
3245 (same-window-regexps nil))
3246 (funcall switch-function "*mail*")))
3247 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3248 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers))))
3249 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3251 (error "Message aborted"))
3253 (goto-char (point-min))
3254 (search-forward mail-header-separator)
3256 (while other-headers
3257 (if (not (member (car (car other-headers)) '("in-reply-to" "cc")))
3258 (insert (car (car other-headers)) ": "
3259 (cdr (car other-headers)) "\n"))
3260 (setq other-headers (cdr other-headers)))
3263 (define-mail-user-agent 'mh-e-user-agent
3264 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3265 'mh-before-send-letter-hook)
3267 (defun compose-mail (&optional to subject other-headers continue
3268 switch-function yank-action send-actions)
3269 "Start composing a mail message to send.
3270 This uses the user's chosen mail composition package
3271 as selected with the variable `mail-user-agent'.
3272 The optional arguments TO and SUBJECT specify recipients
3273 and the initial Subject field, respectively.
3275 OTHER-HEADERS is an alist specifying additional
3276 header fields. Elements look like (HEADER . VALUE) where both
3277 HEADER and VALUE are strings.
3279 CONTINUE, if non-nil, says to continue editing a message already
3282 SWITCH-FUNCTION, if non-nil, is a function to use to
3283 switch to and display the buffer used for mail composition.
3285 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3286 to insert the raw text of the message being replied to.
3287 It has the form (FUNCTION . ARGS). The user agent will apply
3288 FUNCTION to ARGS, to insert the raw text of the original message.
3289 \(The user agent will also run `mail-citation-hook', *after* the
3290 original text has been inserted in this way.)
3292 SEND-ACTIONS is a list of actions to call when the message is sent.
3293 Each action has the form (FUNCTION . ARGS)."
3295 (list nil nil nil current-prefix-arg))
3296 (let ((function (get mail-user-agent 'composefunc)))
3297 (funcall function to subject other-headers continue
3298 switch-function yank-action send-actions)))
3300 (defun compose-mail-other-window (&optional to subject other-headers continue
3301 yank-action send-actions)
3302 "Like \\[compose-mail], but edit the outgoing message in another window."
3304 (list nil nil nil current-prefix-arg))
3305 (compose-mail to subject other-headers continue
3306 'switch-to-buffer-other-window yank-action send-actions))
3309 (defun compose-mail-other-frame (&optional to subject other-headers continue
3310 yank-action send-actions)
3311 "Like \\[compose-mail], but edit the outgoing message in another frame."
3313 (list nil nil nil current-prefix-arg))
3314 (compose-mail to subject other-headers continue
3315 'switch-to-buffer-other-frame yank-action send-actions))
3317 (defvar set-variable-value-history nil
3318 "History of values entered with `set-variable'.")
3320 (defun set-variable (var val)
3321 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3322 When using this interactively, enter a Lisp object for VALUE.
3323 If you want VALUE to be a string, you must surround it with doublequotes.
3324 VALUE is used literally, not evaluated.
3326 If VARIABLE has a `variable-interactive' property, that is used as if
3327 it were the arg to `interactive' (which see) to interactively read VALUE.
3329 If VARIABLE has been defined with `defcustom', then the type information
3330 in the definition is used to check that VALUE is valid."
3331 (interactive (let* ((var (read-variable "Set variable: "))
3332 (minibuffer-help-form '(describe-variable var))
3333 (prop (get var 'variable-interactive))
3334 (prompt (format "Set %s to value: " var))
3336 ;; Use VAR's `variable-interactive' property
3337 ;; as an interactive spec for prompting.
3338 (call-interactively `(lambda (arg)
3342 (read-string prompt nil
3343 'set-variable-value-history)))))
3346 (let ((type (get var 'custom-type)))
3348 ;; Match with custom type.
3350 (setq type (widget-convert type))
3351 (unless (widget-apply type :match val)
3352 (error "Value `%S' does not match type %S of %S"
3353 val (car type) var))))
3356 ;; Define the major mode for lists of completions.
3358 (defvar completion-list-mode-map nil
3359 "Local map for completion list buffers.")
3360 (or completion-list-mode-map
3361 (let ((map (make-sparse-keymap)))
3362 (define-key map [mouse-2] 'mouse-choose-completion)
3363 (define-key map [down-mouse-2] nil)
3364 (define-key map "\C-m" 'choose-completion)
3365 (define-key map "\e\e\e" 'delete-completion-window)
3366 (define-key map [left] 'previous-completion)
3367 (define-key map [right] 'next-completion)
3368 (setq completion-list-mode-map map)))
3370 ;; Completion mode is suitable only for specially formatted data.
3371 (put 'completion-list-mode 'mode-class 'special)
3373 (defvar completion-reference-buffer nil
3374 "Record the buffer that was current when the completion list was requested.
3375 This is a local variable in the completion list buffer.
3376 Initial value is nil to avoid some compiler warnings.")
3378 (defvar completion-no-auto-exit nil
3379 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3380 This also applies to other functions such as `choose-completion'
3381 and `mouse-choose-completion'.")
3383 (defvar completion-base-size nil
3384 "Number of chars at beginning of minibuffer not involved in completion.
3385 This is a local variable in the completion list buffer
3386 but it talks about the buffer in `completion-reference-buffer'.
3387 If this is nil, it means to compare text to determine which part
3388 of the tail end of the buffer's text is involved in completion.")
3390 (defun delete-completion-window ()
3391 "Delete the completion list window.
3392 Go to the window from which completion was requested."
3394 (let ((buf completion-reference-buffer))
3395 (if (one-window-p t)
3396 (if (window-dedicated-p (selected-window))
3397 (delete-frame (selected-frame)))
3398 (delete-window (selected-window))
3399 (if (get-buffer-window buf)
3400 (select-window (get-buffer-window buf))))))
3402 (defun previous-completion (n)
3403 "Move to the previous item in the completion list."
3405 (next-completion (- n)))
3407 (defun next-completion (n)
3408 "Move to the next item in the completion list.
3409 With prefix argument N, move N items (negative N means move backward)."
3411 (while (and (> n 0) (not (eobp)))
3412 (let ((prop (get-text-property (point) 'mouse-face))
3414 ;; If in a completion, move to the end of it.
3416 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3417 ;; Move to start of next one.
3418 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3420 (while (and (< n 0) (not (bobp)))
3421 (let ((prop (get-text-property (1- (point)) 'mouse-face))
3423 ;; If in a completion, move to the start of it.
3425 (goto-char (previous-single-property-change
3426 (point) 'mouse-face nil end)))
3427 ;; Move to end of the previous completion.
3428 (goto-char (previous-single-property-change (point) 'mouse-face nil end))
3429 ;; Move to the start of that one.
3430 (goto-char (previous-single-property-change (point) 'mouse-face nil end)))
3433 (defun choose-completion ()
3434 "Choose the completion that point is in or next to."
3436 (let (beg end completion (buffer completion-reference-buffer)
3437 (base-size completion-base-size))
3438 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3439 (setq end (point) beg (1+ (point))))
3440 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3441 (setq end (1- (point)) beg (point)))
3443 (error "No completion here"))
3444 (setq beg (previous-single-property-change beg 'mouse-face))
3445 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3446 (setq completion (buffer-substring beg end))
3447 (let ((owindow (selected-window)))
3448 (if (and (one-window-p t 'selected-frame)
3449 (window-dedicated-p (selected-window)))
3450 ;; This is a special buffer's frame
3451 (iconify-frame (selected-frame))
3452 (or (window-dedicated-p (selected-window))
3454 (select-window owindow))
3455 (choose-completion-string completion buffer base-size)))
3457 ;; Delete the longest partial match for STRING
3458 ;; that can be found before POINT.
3459 (defun choose-completion-delete-max-match (string)
3460 (let ((opoint (point))
3461 (len (min (length string)
3462 (- (point) (point-min)))))
3463 (goto-char (- (point) (length string)))
3464 (if completion-ignore-case
3465 (setq string (downcase string)))
3466 (while (and (> len 0)
3467 (let ((tail (buffer-substring (point)
3469 (if completion-ignore-case
3470 (setq tail (downcase tail)))
3471 (not (string= tail (substring string 0 len)))))
3476 ;; Switch to BUFFER and insert the completion choice CHOICE.
3477 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3478 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
3480 ;; If BUFFER is the minibuffer, exit the minibuffer
3481 ;; unless it is reading a file name and CHOICE is a directory,
3482 ;; or completion-no-auto-exit is non-nil.
3483 (defun choose-completion-string (choice &optional buffer base-size)
3484 (let ((buffer (or buffer completion-reference-buffer)))
3485 ;; If BUFFER is a minibuffer, barf unless it's the currently
3486 ;; active minibuffer.
3487 (if (and (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))
3488 (or (not (active-minibuffer-window))
3490 (window-buffer (active-minibuffer-window))))))
3491 (error "Minibuffer is not active for completion")
3492 ;; Insert the completion into the buffer where completion was requested.
3495 (delete-region (+ base-size (point-min)) (point))
3496 (choose-completion-delete-max-match choice))
3498 (remove-text-properties (- (point) (length choice)) (point)
3500 ;; Update point in the window that BUFFER is showing in.
3501 (let ((window (get-buffer-window buffer t)))
3502 (set-window-point window (point)))
3503 ;; If completing for the minibuffer, exit it with this choice.
3504 (and (not completion-no-auto-exit)
3505 (equal buffer (window-buffer (minibuffer-window)))
3506 minibuffer-completion-table
3507 ;; If this is reading a file name, and the file name chosen
3508 ;; is a directory, don't exit the minibuffer.
3509 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
3510 (file-directory-p (buffer-string)))
3511 (select-window (active-minibuffer-window))
3512 (exit-minibuffer))))))
3514 (defun completion-list-mode ()
3515 "Major mode for buffers showing lists of possible completions.
3516 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3517 to select the completion near point.
3518 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3521 (kill-all-local-variables)
3522 (use-local-map completion-list-mode-map)
3523 (setq mode-name "Completion List")
3524 (setq major-mode 'completion-list-mode)
3525 (make-local-variable 'completion-base-size)
3526 (setq completion-base-size nil)
3527 (run-hooks 'completion-list-mode-hook))
3529 (defvar completion-fixup-function nil
3530 "A function to customize how completions are identified in completion lists.
3531 `completion-setup-function' calls this function with no arguments
3532 each time it has found what it thinks is one completion.
3533 Point is at the end of the completion in the completion list buffer.
3534 If this function moves point, it can alter the end of that completion.")
3536 (defvar completion-setup-hook nil
3537 "Normal hook run at the end of setting up a completion list buffer.
3538 When this hook is run, the current buffer is the one in which the
3539 command to display the completion list buffer was run.
3540 The completion list buffer is available as the value of `standard-output'.")
3542 ;; This function goes in completion-setup-hook, so that it is called
3543 ;; after the text of the completion list buffer is written.
3545 (defun completion-setup-function ()
3547 (let ((mainbuf (current-buffer)))
3548 (set-buffer standard-output)
3549 (completion-list-mode)
3550 (make-local-variable 'completion-reference-buffer)
3551 (setq completion-reference-buffer mainbuf)
3552 (if (eq minibuffer-completion-table 'read-file-name-internal)
3553 ;; For file name completion,
3554 ;; use the number of chars before the start of the
3555 ;; last file name component.
3556 (setq completion-base-size
3558 (set-buffer mainbuf)
3559 (goto-char (point-max))
3560 (skip-chars-backward (format "^%c" directory-sep-char))
3561 (- (point) (point-min))))
3562 ;; Otherwise, in minibuffer, the whole input is being completed.
3564 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3565 (buffer-name mainbuf))
3566 (setq completion-base-size 0))))
3567 (goto-char (point-min))
3569 (insert (substitute-command-keys
3570 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
3571 (insert (substitute-command-keys
3572 "In this buffer, type \\[choose-completion] to \
3573 select the completion near point.\n\n"))
3575 (while (re-search-forward "[^ \t\n]+\\( [^ \t\n]+\\)*" nil t)
3576 (let ((beg (match-beginning 0))
3578 (if completion-fixup-function
3579 (funcall completion-fixup-function))
3580 (put-text-property beg (point) 'mouse-face 'highlight)
3581 (goto-char end))))))
3583 (add-hook 'completion-setup-hook 'completion-setup-function)
3585 (define-key minibuffer-local-completion-map [prior]
3586 'switch-to-completions)
3587 (define-key minibuffer-local-must-match-map [prior]
3588 'switch-to-completions)
3589 (define-key minibuffer-local-completion-map "\M-v"
3590 'switch-to-completions)
3591 (define-key minibuffer-local-must-match-map "\M-v"
3592 'switch-to-completions)
3594 (defun switch-to-completions ()
3595 "Select the completion list window."
3597 ;; Make sure we have a completions window.
3598 (or (get-buffer-window "*Completions*")
3599 (minibuffer-completion-help))
3600 (select-window (get-buffer-window "*Completions*"))
3601 (goto-char (point-min))
3602 (search-forward "\n\n")
3605 ;; Support keyboard commands to turn on various modifiers.
3607 ;; These functions -- which are not commands -- each add one modifier
3608 ;; to the following event.
3610 (defun event-apply-alt-modifier (ignore-prompt)
3611 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3612 (defun event-apply-super-modifier (ignore-prompt)
3613 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3614 (defun event-apply-hyper-modifier (ignore-prompt)
3615 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3616 (defun event-apply-shift-modifier (ignore-prompt)
3617 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3618 (defun event-apply-control-modifier (ignore-prompt)
3619 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3620 (defun event-apply-meta-modifier (ignore-prompt)
3621 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3623 (defun event-apply-modifier (event symbol lshiftby prefix)
3624 "Apply a modifier flag to event EVENT.
3625 SYMBOL is the name of this modifier, as a symbol.
3626 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3627 PREFIX is the string that represents this modifier in an event type symbol."
3629 (cond ((eq symbol 'control)
3630 (if (and (<= (downcase event) ?z)
3631 (>= (downcase event) ?a))
3632 (- (downcase event) ?a -1)
3633 (if (and (<= (downcase event) ?Z)
3634 (>= (downcase event) ?A))
3635 (- (downcase event) ?A -1)
3636 (logior (lsh 1 lshiftby) event))))
3638 (if (and (<= (downcase event) ?z)
3639 (>= (downcase event) ?a))
3641 (logior (lsh 1 lshiftby) event)))
3643 (logior (lsh 1 lshiftby) event)))
3644 (if (memq symbol (event-modifiers event))
3646 (let ((event-type (if (symbolp event) event (car event))))
3647 (setq event-type (intern (concat prefix (symbol-name event-type))))
3650 (cons event-type (cdr event)))))))
3652 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3653 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3654 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3655 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3656 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3657 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3659 ;;;; Keypad support.
3661 ;;; Make the keypad keys act like ordinary typing keys. If people add
3662 ;;; bindings for the function key symbols, then those bindings will
3663 ;;; override these, so this shouldn't interfere with any existing
3666 ;; Also tell read-char how to handle these keys.
3668 (lambda (keypad-normal)
3669 (let ((keypad (nth 0 keypad-normal))
3670 (normal (nth 1 keypad-normal)))
3671 (put keypad 'ascii-character normal)
3672 (define-key function-key-map (vector keypad) (vector normal))))
3673 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3674 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3686 ;;; simple.el ends here