1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to
19 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 ;; A grab-bag of basic Emacs commands not specifically related to some
24 ;; major mode or to file-handling.
28 (defun newline (&optional arg
)
29 "Insert a newline, and move to left margin of the new line if it's blank.
30 The newline is marked with the text-property `hard'.
31 With arg, insert that many newlines.
32 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
34 ;; Inserting a newline at the end of a line produces better redisplay in
35 ;; try_window_id than inserting at the beginning of a line, and the textual
36 ;; result is the same. So, if we're at beginning of line, pretend to be at
37 ;; the end of the previous line.
38 (let ((flag (and (not (bobp))
40 (< (or (previous-property-change (point)) -
2)
42 (was-page-start (and (bolp)
43 (looking-at page-delimiter
)))
45 (if flag
(backward-char 1))
46 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
47 ;; Set last-command-char to tell self-insert what to insert.
48 (let ((last-command-char ?
\n)
49 ;; Don't auto-fill if we have a numeric argument.
50 ;; Also not if flag is true (it would fill wrong line);
51 ;; there is no need to since we're at BOL.
52 (auto-fill-function (if (or arg flag
) nil auto-fill-function
)))
54 (self-insert-command (prefix-numeric-value arg
))
55 ;; If we get an error in self-insert-command, put point at right place.
56 (if flag
(forward-char 1))))
57 ;; If we did *not* get an error, cancel that forward-char.
58 (if flag
(backward-char 1))
59 ;; Mark the newline(s) `hard'.
61 (let* ((from (- (point) (if arg
(prefix-numeric-value arg
) 1)))
62 (sticky (get-text-property from
'rear-nonsticky
)))
63 (put-text-property from
(point) 'hard
't
)
64 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
65 (if (and (listp sticky
) (not (memq 'hard sticky
)))
66 (put-text-property from
(point) 'rear-nonsticky
67 (cons 'hard sticky
)))))
68 ;; If the newline leaves the previous line blank,
69 ;; and we have a left margin, delete that from the blank line.
74 (and (looking-at "[ \t]$")
75 (> (current-left-margin) 0)
76 (delete-region (point) (progn (end-of-line) (point))))))
77 (if flag
(forward-char 1))
78 ;; Indent the line after the newline, except in one case:
79 ;; when we added the newline at the beginning of a line
80 ;; which starts a page.
82 (move-to-left-margin nil t
)))
85 (defun open-line (arg)
86 "Insert a newline and leave point before it.
87 If there is a fill prefix and/or a left-margin, insert them on the new line
88 if the line would have been blank.
89 With arg N, insert N newlines."
91 (let* ((do-fill-prefix (and fill-prefix
(bolp)))
92 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
98 (if do-left-margin
(indent-to (current-left-margin)))
99 (if do-fill-prefix
(insert-and-inherit fill-prefix
))))
106 "Split current line, moving portion beyond point vertically down."
108 (skip-chars-forward " \t")
109 (let ((col (current-column))
115 (defun quoted-insert (arg)
116 "Read next input character and insert it.
117 This is useful for inserting control characters.
118 You may also type up to 3 octal digits, to insert a character with that code.
120 In overwrite mode, this function inserts the character anyway, and
121 does not handle octal digits specially. This means that if you use
122 overwrite as your normal editing mode, you can use this function to
123 insert characters when necessary.
125 In binary overwrite mode, this function does overwrite, and octal
126 digits are interpreted as a character code. This is supposed to make
127 this function useful in editing binary files."
129 (let ((char (if (or (not overwrite-mode
)
130 (eq overwrite-mode
'overwrite-mode-binary
))
134 (if (eq overwrite-mode
'overwrite-mode-binary
)
137 (insert-and-inherit char
)
138 (setq arg
(1- arg
)))))
140 (defun delete-indentation (&optional arg
)
141 "Join this line to previous and fix up whitespace at join.
142 If there is a fill prefix, delete it from the beginning of this line.
143 With argument, join this line to following line."
146 (if arg
(forward-line 1))
147 (if (eq (preceding-char) ?
\n)
149 (delete-region (point) (1- (point)))
150 ;; If the second line started with the fill prefix,
151 ;; delete the prefix.
153 (<= (+ (point) (length fill-prefix
)) (point-max))
155 (buffer-substring (point)
156 (+ (point) (length fill-prefix
)))))
157 (delete-region (point) (+ (point) (length fill-prefix
))))
158 (fixup-whitespace))))
160 (defun fixup-whitespace ()
161 "Fixup white space between objects around point.
162 Leave one space or none, according to the context."
165 (delete-horizontal-space)
166 (if (or (looking-at "^\\|\\s)")
167 (save-excursion (forward-char -
1)
168 (looking-at "$\\|\\s(\\|\\s'")))
172 (defun delete-horizontal-space ()
173 "Delete all spaces and tabs around point."
175 (skip-chars-backward " \t")
176 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
178 (defun just-one-space ()
179 "Delete all spaces and tabs around point, leaving one space."
181 (skip-chars-backward " \t")
182 (if (= (following-char) ?
)
185 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
187 (defun delete-blank-lines ()
188 "On blank line, delete all surrounding blank lines, leaving just one.
189 On isolated blank line, delete that one.
190 On nonblank line, delete any immediately following blank lines."
192 (let (thisblank singleblank
)
195 (setq thisblank
(looking-at "[ \t]*$"))
196 ;; Set singleblank if there is just one blank line here.
199 (not (looking-at "[ \t]*\n[ \t]*$"))
201 (progn (forward-line -
1)
202 (not (looking-at "[ \t]*$")))))))
203 ;; Delete preceding blank lines, and this one too if it's the only one.
207 (if singleblank
(forward-line 1))
208 (delete-region (point)
209 (if (re-search-backward "[^ \t\n]" nil t
)
210 (progn (forward-line 1) (point))
212 ;; Delete following blank lines, unless the current line is blank
213 ;; and there are no following blank lines.
214 (if (not (and thisblank singleblank
))
218 (delete-region (point)
219 (if (re-search-forward "[^ \t\n]" nil t
)
220 (progn (beginning-of-line) (point))
222 ;; Handle the special case where point is followed by newline and eob.
223 ;; Delete the line, leaving point at eob.
224 (if (looking-at "^[ \t]*\n\\'")
225 (delete-region (point) (point-max)))))
227 (defun back-to-indentation ()
228 "Move point to the first non-whitespace character on this line."
230 (beginning-of-line 1)
231 (skip-chars-forward " \t"))
233 (defun newline-and-indent ()
234 "Insert a newline, then indent according to major mode.
235 Indentation is done using the value of `indent-line-function'.
236 In programming language modes, this is the same as TAB.
237 In some text modes, where TAB inserts a tab, this command indents to the
238 column specified by the function `current-left-margin'."
240 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
242 (indent-according-to-mode))
244 (defun reindent-then-newline-and-indent ()
245 "Reindent current line, insert newline, then indent the new line.
246 Indentation of both lines is done according to the current major mode,
247 which means calling the current value of `indent-line-function'.
248 In programming language modes, this is the same as TAB.
249 In some text modes, where TAB inserts a tab, this indents to the
250 column specified by the function `current-left-margin'."
253 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
254 (indent-according-to-mode))
256 (indent-according-to-mode))
258 ;; Internal subroutine of delete-char
259 (defun kill-forward-chars (arg)
260 (if (listp arg
) (setq arg
(car arg
)))
261 (if (eq arg
'-
) (setq arg -
1))
262 (kill-region (point) (+ (point) arg
)))
264 ;; Internal subroutine of backward-delete-char
265 (defun kill-backward-chars (arg)
266 (if (listp arg
) (setq arg
(car arg
)))
267 (if (eq arg
'-
) (setq arg -
1))
268 (kill-region (point) (- (point) arg
)))
270 (defun backward-delete-char-untabify (arg &optional killp
)
271 "Delete characters backward, changing tabs into spaces.
272 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
273 Interactively, ARG is the prefix arg (default 1)
274 and KILLP is t if a prefix arg was specified."
275 (interactive "*p\nP")
278 (while (and (> count
0) (not (bobp)))
279 (if (= (preceding-char) ?
\t)
280 (let ((col (current-column)))
282 (setq col
(- col
(current-column)))
286 (setq count
(1- count
)))))
287 (delete-backward-char arg killp
)
288 ;; In overwrite mode, back over columns while clearing them out,
289 ;; unless at end of line.
290 (and overwrite-mode
(not (eolp))
291 (save-excursion (insert-char ?\ arg
))))
293 (defun zap-to-char (arg char
)
294 "Kill up to and including ARG'th occurrence of CHAR.
295 Goes backward if ARG is negative; error if CHAR not found."
296 (interactive "p\ncZap to char: ")
297 (kill-region (point) (progn
298 (search-forward (char-to-string char
) nil nil arg
)
299 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
302 (defun beginning-of-buffer (&optional arg
)
303 "Move point to the beginning of the buffer; leave mark at previous position.
304 With arg N, put point N/10 of the way from the beginning.
306 If the buffer is narrowed, this command uses the beginning and size
307 of the accessible part of the buffer.
309 Don't use this command in Lisp programs!
310 \(goto-char (point-min)) is faster and avoids clobbering the mark."
313 (let ((size (- (point-max) (point-min))))
317 ;; Avoid overflow for large buffer sizes!
318 (* (prefix-numeric-value arg
)
320 (/ (+ 10 (* size
(prefix-numeric-value arg
))) 10)))
322 (if arg
(forward-line 1)))
324 (defun end-of-buffer (&optional arg
)
325 "Move point to the end of the buffer; leave mark at previous position.
326 With arg N, put point N/10 of the way from the end.
328 If the buffer is narrowed, this command uses the beginning and size
329 of the accessible part of the buffer.
331 Don't use this command in Lisp programs!
332 \(goto-char (point-max)) is faster and avoids clobbering the mark."
335 (let ((size (- (point-max) (point-min))))
339 ;; Avoid overflow for large buffer sizes!
340 (* (prefix-numeric-value arg
)
342 (/ (* size
(prefix-numeric-value arg
)) 10)))
344 ;; If we went to a place in the middle of the buffer,
345 ;; adjust it to the beginning of a line.
346 (if arg
(forward-line 1)
347 ;; If the end of the buffer is not already on the screen,
348 ;; then scroll specially to put it near, but not at, the bottom.
349 (if (let ((old-point (point)))
351 (goto-char (window-start))
352 (vertical-motion (window-height))
353 (< (point) old-point
)))
355 (overlay-recenter (point))
358 (defun mark-whole-buffer ()
359 "Put point at beginning and mark at end of buffer.
360 You probably should not use this function in Lisp programs;
361 it is usually a mistake for a Lisp function to use any subroutine
362 that uses or sets the mark."
365 (push-mark (point-max) nil t
)
366 (goto-char (point-min)))
368 (defun count-lines-region (start end
)
369 "Print number of lines and characters in the region."
371 (message "Region has %d lines, %d characters"
372 (count-lines start end
) (- end start
)))
375 "Print the current line number (in the buffer) of point."
382 (1+ (count-lines 1 (point)))))))
384 (defun count-lines (start end
)
385 "Return number of lines between START and END.
386 This is usually the number of newlines between them,
387 but can be one more if START is not equal to END
388 and the greater of them is not at the start of a line."
391 (narrow-to-region start end
)
392 (goto-char (point-min))
393 (if (eq selective-display t
)
396 (while (re-search-forward "[\n\C-m]" nil t
40)
397 (setq done
(+ 40 done
)))
398 (while (re-search-forward "[\n\C-m]" nil t
1)
399 (setq done
(+ 1 done
)))
400 (goto-char (point-max))
401 (if (and (/= start end
)
405 (- (buffer-size) (forward-line (buffer-size)))))))
407 (defun what-cursor-position ()
408 "Print info on cursor position (on screen and within buffer)."
410 (let* ((char (following-char))
414 (total (buffer-size))
415 (percent (if (> total
50000)
416 ;; Avoid overflow from multiplying by 100!
417 (/ (+ (/ total
200) (1- pos
)) (max (/ total
100) 1))
418 (/ (+ (/ total
2) (* 100 (1- pos
))) (max total
1))))
419 (hscroll (if (= (window-hscroll) 0)
421 (format " Hscroll=%d" (window-hscroll))))
422 (col (current-column)))
424 (if (or (/= beg
1) (/= end
(1+ total
)))
425 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
426 pos total percent beg end col hscroll
)
427 (message "point=%d of %d(%d%%) column %d %s"
428 pos total percent col hscroll
))
429 (if (or (/= beg
1) (/= end
(1+ total
)))
430 (message "Char: %s (0%o, %d, 0x%x) point=%d of %d(%d%%) <%d - %d> column %d %s"
431 (single-key-description char
) char char char pos total percent beg end col hscroll
)
432 (message "Char: %s (0%o, %d, 0x%x) point=%d of %d(%d%%) column %d %s"
433 (single-key-description char
) char char char pos total percent col hscroll
)))))
435 (defun fundamental-mode ()
436 "Major mode not specialized for anything in particular.
437 Other major modes are defined by comparison with this one."
439 (kill-all-local-variables))
441 (defvar read-expression-map
(cons 'keymap minibuffer-local-map
)
442 "Minibuffer keymap used for reading Lisp expressions.")
443 (define-key read-expression-map
"\M-\t" 'lisp-complete-symbol
)
445 (put 'eval-expression
'disabled t
)
447 (defvar read-expression-history nil
)
449 ;; We define this, rather than making `eval' interactive,
450 ;; for the sake of completion of names like eval-region, eval-current-buffer.
451 (defun eval-expression (expression)
452 "Evaluate EXPRESSION and print value in minibuffer.
453 Value is also consed on to front of the variable `values'."
455 (list (read-from-minibuffer "Eval: "
456 nil read-expression-map t
457 'read-expression-history
)))
458 (setq values
(cons (eval expression
) values
))
459 (prin1 (car values
) t
))
461 (defun edit-and-eval-command (prompt command
)
462 "Prompting with PROMPT, let user edit COMMAND and eval result.
463 COMMAND is a Lisp expression. Let user edit that expression in
464 the minibuffer, then read and evaluate the result."
465 (let ((command (read-from-minibuffer prompt
466 (prin1-to-string command
)
467 read-expression-map t
468 '(command-history .
1))))
469 ;; If command was added to command-history as a string,
470 ;; get rid of that. We want only evallable expressions there.
471 (if (stringp (car command-history
))
472 (setq command-history
(cdr command-history
)))
474 ;; If command to be redone does not match front of history,
475 ;; add it to the history.
476 (or (equal command
(car command-history
))
477 (setq command-history
(cons command command-history
)))
480 (defun repeat-complex-command (arg)
481 "Edit and re-evaluate last complex command, or ARGth from last.
482 A complex command is one which used the minibuffer.
483 The command is placed in the minibuffer as a Lisp form for editing.
484 The result is executed, repeating the command as changed.
485 If the command has been changed or is not the most recent previous command
486 it is added to the front of the command history.
487 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
488 to get different commands to edit and resubmit."
490 (let ((elt (nth (1- arg
) command-history
))
491 (minibuffer-history-position arg
)
492 (minibuffer-history-sexp-flag t
)
497 (let ((print-level nil
))
498 (read-from-minibuffer
499 "Redo: " (prin1-to-string elt
) read-expression-map t
500 (cons 'command-history arg
))))
502 ;; If command was added to command-history as a string,
503 ;; get rid of that. We want only evallable expressions there.
504 (if (stringp (car command-history
))
505 (setq command-history
(cdr command-history
)))
507 ;; If command to be redone does not match front of history,
508 ;; add it to the history.
509 (or (equal newcmd
(car command-history
))
510 (setq command-history
(cons newcmd command-history
)))
514 (defvar minibuffer-history nil
515 "Default minibuffer history list.
516 This is used for all minibuffer input
517 except when an alternate history list is specified.")
518 (defvar minibuffer-history-sexp-flag nil
519 "Non-nil when doing history operations on `command-history'.
520 More generally, indicates that the history list being acted on
521 contains expressions rather than strings.")
522 (setq minibuffer-history-variable
'minibuffer-history
)
523 (setq minibuffer-history-position nil
)
524 (defvar minibuffer-history-search-history nil
)
527 (lambda (key-and-command)
529 (lambda (keymap-and-completionp)
530 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
531 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
532 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
533 (define-key (symbol-value (car keymap-and-completionp
))
534 (car key-and-command
)
535 (let ((command (cdr key-and-command
)))
537 ;; (and ... nil) => ... turns back on the completion-oriented
538 ;; history commands which rms turned off since they seem to
539 ;; do things he doesn't like.
540 (if (and (cdr keymap-and-completionp
) nil
) ;XXX turned off
541 (progn (error "EMACS BUG!") (cdr command
))
544 '((minibuffer-local-map . nil
)
545 (minibuffer-local-ns-map . nil
)
546 (minibuffer-local-completion-map . t
)
547 (minibuffer-local-must-match-map . t
)
548 (read-expression-map . nil
))))
549 '(("\en" .
(next-history-element . next-complete-history-element
))
550 ([next] . (next-history-element . next-complete-history-element))
551 ("\ep" . (previous-history-element . previous-complete-history-element))
552 ([prior] . (previous-history-element . previous-complete-history-element))
553 ("\er" . previous-matching-history-element)
554 ("\es" . next-matching-history-element)))
556 (defun previous-matching-history-element (regexp n)
557 "Find the previous history element that matches REGEXP.
558 \(Previous history elements refer to earlier actions.)
559 With prefix argument N, search for Nth previous match.
560 If N is negative, find the next or Nth next match."
562 (let* ((enable-recursive-minibuffers t)
563 (minibuffer-history-sexp-flag nil)
564 (regexp (read-from-minibuffer "Previous element matching (regexp): "
568 'minibuffer-history-search-history)))
569 ;; Use the last regexp specified, by default, if input is empty.
570 (list (if (string= regexp "")
571 (if minibuffer-history-search-history
572 (car minibuffer-history-search-history)
573 (error "No previous history search regexp"))
575 (prefix-numeric-value current-prefix-arg))))
576 (let ((history (symbol-value minibuffer-history-variable))
578 (pos minibuffer-history-position))
581 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
584 "No later matching history item"
585 "No earlier matching history item")))
586 (if (string-match regexp
587 (if minibuffer-history-sexp-flag
588 (let ((print-level nil))
589 (prin1-to-string (nth (1- pos) history)))
590 (nth (1- pos) history)))
591 (setq n (+ n (if (< n 0) 1 -1)))))
592 (setq minibuffer-history-position pos)
594 (let ((elt (nth (1- pos) history)))
595 (insert (if minibuffer-history-sexp-flag
596 (let ((print-level nil))
597 (prin1-to-string elt))
599 (goto-char (point-min)))
600 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
601 (eq (car (car command-history)) 'next-matching-history-element))
602 (setq command-history (cdr command-history))))
604 (defun next-matching-history-element (regexp n)
605 "Find the next history element that matches REGEXP.
606 \(The next history element refers to a more recent action.)
607 With prefix argument N, search for Nth next match.
608 If N is negative, find the previous or Nth previous match."
610 (let* ((enable-recursive-minibuffers t)
611 (minibuffer-history-sexp-flag nil)
612 (regexp (read-from-minibuffer "Next element matching (regexp): "
616 'minibuffer-history-search-history)))
617 ;; Use the last regexp specified, by default, if input is empty.
618 (list (if (string= regexp "")
619 (setcar minibuffer-history-search-history
620 (nth 1 minibuffer-history-search-history))
622 (prefix-numeric-value current-prefix-arg))))
623 (previous-matching-history-element regexp (- n)))
625 (defun next-history-element (n)
626 "Insert the next element of the minibuffer history into the minibuffer."
629 (let ((narg (min (max 1 (- minibuffer-history-position n))
630 (length (symbol-value minibuffer-history-variable)))))
632 (= minibuffer-history-position narg))
633 (error (if (if (zerop narg)
635 (= minibuffer-history-position 1))
636 "End of history; no next item"
637 "Beginning of history; no preceding item"))
639 (setq minibuffer-history-position narg)
640 (let ((elt (nth (1- minibuffer-history-position)
641 (symbol-value minibuffer-history-variable))))
643 (if minibuffer-history-sexp-flag
644 (let ((print-level nil))
645 (prin1-to-string elt))
647 (goto-char (point-min))))))
649 (defun previous-history-element (n)
650 "Inserts the previous element of the minibuffer history into the minibuffer."
652 (next-history-element (- n)))
654 (defun next-complete-history-element (n)
655 "Get next element of history which is a completion of minibuffer contents."
657 (let ((point-at-start (point)))
658 (next-matching-history-element
659 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
660 ;; next-matching-history-element always puts us at (point-min).
661 ;; Move to the position we were at before changing the buffer contents.
662 ;; This is still sensical, because the text before point has not changed.
663 (goto-char point-at-start)))
665 (defun previous-complete-history-element (n)
667 Get previous element of history which is a completion of minibuffer contents."
669 (next-complete-history-element (- n)))
671 (defun goto-line (arg)
672 "Goto line ARG, counting from line 1 at beginning of buffer."
673 (interactive "NGoto line: ")
674 (setq arg (prefix-numeric-value arg))
678 (if (eq selective-display t)
679 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
680 (forward-line (1- arg)))))
682 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
683 (define-function 'advertised-undo 'undo)
685 (defun undo (&optional arg)
686 "Undo some previous changes.
687 Repeat this command to undo more changes.
688 A numeric argument serves as a repeat count."
690 ;; If we don't get all the way thru, make last-command indicate that
691 ;; for the following command.
692 (setq this-command t)
693 (let ((modified (buffer-modified-p))
694 (recent-save (recent-auto-save-p)))
695 (or (eq (selected-window) (minibuffer-window))
697 (or (eq last-command 'undo)
700 (undo-more (or arg 1))
701 ;; Don't specify a position in the undo record for the undo command.
702 ;; Instead, undoing this should move point to where the change is.
703 (let ((tail buffer-undo-list)
705 (while (and tail (not done) (not (null (car tail))))
706 (if (integerp (car tail))
709 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
710 (setq tail (cdr tail))))
711 (and modified (not (buffer-modified-p))
712 (delete-auto-save-file-if-necessary recent-save)))
713 ;; If we do get all the way thru, make this-command indicate that.
714 (setq this-command 'undo))
716 (defvar pending-undo-list nil
717 "Within a run of consecutive undo commands, list remaining to be undone.")
720 "Set `pending-undo-list' to the front of the undo list.
721 The next call to `undo-more' will undo the most recently made change."
722 (if (eq buffer-undo-list t)
723 (error "No undo information in this buffer"))
724 (setq pending-undo-list buffer-undo-list))
726 (defun undo-more (count)
727 "Undo back N undo-boundaries beyond what was already undone recently.
728 Call `undo-start' to get ready to undo recent changes,
729 then call `undo-more' one or more times to undo them."
730 (or pending-undo-list
731 (error "No further undo information"))
732 (setq pending-undo-list (primitive-undo count pending-undo-list)))
734 (defvar shell-command-history nil
735 "History list for some commands that read shell commands.")
737 (defvar shell-command-switch "-c"
738 "Switch used to have the shell execute its command line argument.")
740 (defun shell-command (command &optional output-buffer)
741 "Execute string COMMAND in inferior shell; display output, if any.
743 If COMMAND ends in ampersand, execute it asynchronously.
744 The output appears in the buffer `*Async Shell Command*'.
745 That buffer is in shell mode.
747 Otherwise, COMMAND is executed synchronously. The output appears in the
748 buffer `*Shell Command Output*'.
749 If the output is one line, it is displayed in the echo area *as well*,
750 but it is nonetheless available in buffer `*Shell Command Output*',
751 even though that buffer is not automatically displayed.
752 If there is no output, or if output is inserted in the current buffer,
753 then `*Shell Command Output*' is deleted.
755 The optional second argument OUTPUT-BUFFER, if non-nil,
756 says to put the output in some other buffer.
757 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
758 If OUTPUT-BUFFER is not a buffer and not nil,
759 insert output in current buffer. (This cannot be done asynchronously.)
760 In either case, the output is inserted after point (leaving mark after it)."
761 (interactive (list (read-from-minibuffer "Shell command: "
762 nil nil nil 'shell-command-history)
764 (if (and output-buffer
765 (not (or (bufferp output-buffer) (stringp output-buffer))))
766 (progn (barf-if-buffer-read-only)
768 ;; We do not use -f for csh; we will not support broken use of
769 ;; .cshrcs. Even the BSD csh manual says to use
770 ;; "if ($?prompt) exit" before things which are not useful
771 ;; non-interactively. Besides, if someone wants their other
772 ;; aliases for shell commands then they can still have them.
773 (call-process shell-file-name nil t nil
774 shell-command-switch command)
775 ;; This is like exchange-point-and-mark, but doesn't
776 ;; activate the mark. It is cleaner to avoid activation,
777 ;; even though the command loop would deactivate the mark
778 ;; because we inserted text.
779 (goto-char (prog1 (mark t)
780 (set-marker (mark-marker) (point)
782 ;; Preserve the match data in case called from a program.
784 (if (string-match "[ \t]*&[ \t]*$" command)
785 ;; Command ending with ampersand means asynchronous.
786 (let ((buffer (get-buffer-create
787 (or output-buffer "*Asynch Shell Command*")))
788 (directory default-directory)
790 ;; Remove the ampersand.
791 (setq command (substring command 0 (match-beginning 0)))
792 ;; If will kill a process, query first.
793 (setq proc (get-buffer-process buffer))
795 (if (yes-or-no-p "A command is running. Kill it? ")
797 (error "Shell command in progress")))
800 (setq buffer-read-only nil)
802 (display-buffer buffer)
803 (setq default-directory directory)
804 (setq proc (start-process "Shell" buffer shell-file-name
805 shell-command-switch command))
806 (setq mode-line-process '(":%s"))
807 (require 'shell) (shell-mode)
808 (set-process-sentinel proc 'shell-command-sentinel)
810 (shell-command-on-region (point) (point) command nil)
813 ;; We have a sentinel to prevent insertion of a termination message
814 ;; in the buffer itself.
815 (defun shell-command-sentinel (process signal)
816 (if (memq (process-status process) '(exit signal))
818 (car (cdr (cdr (process-command process))))
819 (substring signal 0 -1))))
821 (defun shell-command-on-region (start end command
822 &optional output-buffer replace)
823 "Execute string COMMAND in inferior shell with region as input.
824 Normally display output (if any) in temp buffer `*Shell Command Output*';
825 Prefix arg means replace the region with it.
827 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER, REPLACE.
828 If REPLACE is non-nil, that means insert the output
829 in place of text from START to END, putting point and mark around it.
831 If the output is one line, it is displayed in the echo area,
832 but it is nonetheless available in buffer `*Shell Command Output*'
833 even though that buffer is not automatically displayed.
834 If there is no output, or if output is inserted in the current buffer,
835 then `*Shell Command Output*' is deleted.
837 If the optional fourth argument OUTPUT-BUFFER is non-nil,
838 that says to put the output in some other buffer.
839 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
840 If OUTPUT-BUFFER is not a buffer and not nil,
841 insert output in the current buffer.
842 In either case, the output is inserted after point (leaving mark after it)."
843 (interactive (let ((string
844 ;; Do this before calling region-beginning
845 ;; and region-end, in case subprocess output
846 ;; relocates them while we are in the minibuffer.
847 (read-from-minibuffer "Shell command on region: "
849 'shell-command-history)))
853 current-prefix-arg)))
856 (not (or (bufferp output-buffer) (stringp output-buffer)))))
857 ;; Replace specified region with output from command.
858 (let ((swap (and replace (< start end))))
859 ;; Don't muck with mark unless REPLACE says we should.
861 (and replace (push-mark))
862 (call-process-region start end shell-file-name t t nil
863 shell-command-switch command)
864 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
865 (and shell-buffer (not (eq shell-buffer (current-buffer)))
866 (kill-buffer shell-buffer)))
867 ;; Don't muck with mark unless REPLACE says we should.
868 (and replace swap (exchange-point-and-mark)))
869 ;; No prefix argument: put the output in a temp buffer,
870 ;; replacing its entire contents.
871 (let ((buffer (get-buffer-create
872 (or output-buffer "*Shell Command Output*")))
875 (if (eq buffer (current-buffer))
876 ;; If the input is the same buffer as the output,
877 ;; delete everything but the specified region,
878 ;; then replace that region with the output.
879 (progn (setq buffer-read-only nil)
880 (delete-region (max start end) (point-max))
881 (delete-region (point-min) (max start end))
882 (call-process-region (point-min) (point-max)
883 shell-file-name t t nil
884 shell-command-switch command)
886 ;; Clear the output buffer, then run the command with output there.
889 (setq buffer-read-only nil)
891 (call-process-region start end shell-file-name
893 shell-command-switch command)
895 ;; Report the amount of output.
896 (let ((lines (save-excursion
898 (if (= (buffer-size) 0)
900 (count-lines (point-min) (point-max))))))
903 (message "(Shell command completed with no output)"))
904 (kill-buffer buffer))
905 ((and success (= lines 1))
909 (goto-char (point-min))
910 (buffer-substring (point)
911 (progn (end-of-line) (point))))))
913 (set-window-start (display-buffer buffer) 1))))))))
915 (defconst universal-argument-map
916 (let ((map (make-sparse-keymap)))
917 (define-key map [t] 'universal-argument-other-key)
918 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
919 (define-key map [switch-frame] nil)
920 (define-key map [?\C-u] 'universal-argument-more)
921 (define-key map [?-] 'universal-argument-minus)
922 (define-key map [?0] 'digit-argument)
923 (define-key map [?1] 'digit-argument)
924 (define-key map [?2] 'digit-argument)
925 (define-key map [?3] 'digit-argument)
926 (define-key map [?4] 'digit-argument)
927 (define-key map [?5] 'digit-argument)
928 (define-key map [?6] 'digit-argument)
929 (define-key map [?7] 'digit-argument)
930 (define-key map [?8] 'digit-argument)
931 (define-key map [?9] 'digit-argument)
933 "Keymap used while processing \\[universal-argument].")
935 (defvar universal-argument-num-events nil
936 "Number of argument-specifying events read by `universal-argument'.
937 `universal-argument-other-key' uses this to discard those events
938 from (this-command-keys), and reread only the final command.")
940 (defun universal-argument ()
941 "Begin a numeric argument for the following command.
942 Digits or minus sign following \\[universal-argument] make up the numeric argument.
943 \\[universal-argument] following the digits or minus sign ends the argument.
944 \\[universal-argument] without digits or minus sign provides 4 as argument.
945 Repeating \\[universal-argument] without digits or minus sign
946 multiplies the argument by 4 each time."
948 (setq prefix-arg (list 4))
949 (setq universal-argument-num-events (length (this-command-keys)))
950 (setq overriding-terminal-local-map universal-argument-map))
952 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
953 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
954 (defun universal-argument-more (arg)
957 (setq prefix-arg (list (* 4 (car arg))))
958 (setq prefix-arg arg)
959 (setq overriding-terminal-local-map nil))
960 (setq universal-argument-num-events (length (this-command-keys))))
962 (defun negative-argument (arg)
963 "Begin a negative numeric argument for the next command.
964 \\[universal-argument] following digits or minus sign ends the argument."
966 (cond ((integerp arg)
967 (setq prefix-arg (- arg)))
969 (setq prefix-arg nil))
971 (setq prefix-arg '-)))
972 (setq universal-argument-num-events (length (this-command-keys)))
973 (setq overriding-terminal-local-map universal-argument-map))
975 (defun digit-argument (arg)
976 "Part of the numeric argument for the next command.
977 \\[universal-argument] following digits or minus sign ends the argument."
979 (let ((digit (- (logand last-command-char ?\177) ?0)))
980 (cond ((integerp arg)
981 (setq prefix-arg (+ (* arg 10)
982 (if (< arg 0) (- digit) digit))))
984 ;; Treat -0 as just -, so that -01 will work.
985 (setq prefix-arg (if (zerop digit) '- (- digit))))
987 (setq prefix-arg digit))))
988 (setq universal-argument-num-events (length (this-command-keys)))
989 (setq overriding-terminal-local-map universal-argument-map))
991 ;; For backward compatibility, minus with no modifiers is an ordinary
992 ;; command if digits have already been entered.
993 (defun universal-argument-minus (arg)
996 (universal-argument-other-key arg)
997 (negative-argument arg)))
999 ;; Anything else terminates the argument and is left in the queue to be
1000 ;; executed as a command.
1001 (defun universal-argument-other-key (arg)
1003 (setq prefix-arg arg)
1004 (let* ((key (this-command-keys))
1005 (keylist (listify-key-sequence key)))
1006 (setq unread-command-events
1007 (nthcdr universal-argument-num-events keylist)))
1008 (reset-this-command-lengths)
1009 (setq overriding-terminal-local-map nil))
1011 (defun forward-to-indentation (arg)
1012 "Move forward ARG lines and position at first nonblank character."
1015 (skip-chars-forward " \t"))
1017 (defun backward-to-indentation (arg)
1018 "Move backward ARG lines and position at first nonblank character."
1020 (forward-line (- arg))
1021 (skip-chars-forward " \t"))
1023 (defvar kill-whole-line nil
1024 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
1026 (defun kill-line (&optional arg)
1027 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1028 With prefix argument, kill that many lines from point.
1029 Negative arguments kill lines backward.
1031 When calling from a program, nil means \"no arg\",
1032 a number counts as a prefix arg.
1034 If `kill-whole-line' is non-nil, then kill the whole line
1035 when given no argument at the beginning of a line."
1037 (kill-region (point)
1038 ;; It is better to move point to the other end of the kill
1039 ;; before killing. That way, in a read-only buffer, point
1040 ;; moves across the text that is copied to the kill ring.
1041 ;; The choice has no effect on undo now that undo records
1042 ;; the value of point from before the command was run.
1045 (forward-line (prefix-numeric-value arg))
1047 (signal 'end-of-buffer nil))
1048 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
1053 ;;;; Window system cut and paste hooks.
1055 (defvar interprogram-cut-function nil
1056 "Function to call to make a killed region available to other programs.
1058 Most window systems provide some sort of facility for cutting and
1059 pasting text between the windows of different programs.
1060 This variable holds a function that Emacs calls whenever text
1061 is put in the kill ring, to make the new kill available to other
1064 The function takes one or two arguments.
1065 The first argument, TEXT, is a string containing
1066 the text which should be made available.
1067 The second, PUSH, if non-nil means this is a \"new\" kill;
1068 nil means appending to an \"old\" kill.")
1070 (defvar interprogram-paste-function nil
1071 "Function to call to get text cut from other programs.
1073 Most window systems provide some sort of facility for cutting and
1074 pasting text between the windows of different programs.
1075 This variable holds a function that Emacs calls to obtain
1076 text that other programs have provided for pasting.
1078 The function should be called with no arguments. If the function
1079 returns nil, then no other program has provided such text, and the top
1080 of the Emacs kill ring should be used. If the function returns a
1081 string, that string should be put in the kill ring as the latest kill.
1083 Note that the function should return a string only if a program other
1084 than Emacs has provided a string for pasting; if Emacs provided the
1085 most recent string, the function should return nil. If it is
1086 difficult to tell whether Emacs or some other program provided the
1087 current string, it is probably good enough to return nil if the string
1088 is equal (according to `string=') to the last text Emacs provided.")
1092 ;;;; The kill ring data structure.
1094 (defvar kill-ring nil
1095 "List of killed text sequences.
1096 Since the kill ring is supposed to interact nicely with cut-and-paste
1097 facilities offered by window systems, use of this variable should
1098 interact nicely with `interprogram-cut-function' and
1099 `interprogram-paste-function'. The functions `kill-new',
1100 `kill-append', and `current-kill' are supposed to implement this
1101 interaction; you may want to use them instead of manipulating the kill
1104 (defconst kill-ring-max 30
1105 "*Maximum length of kill ring before oldest elements are thrown away.")
1107 (defvar kill-ring-yank-pointer nil
1108 "The tail of the kill ring whose car is the last thing yanked.")
1110 (defun kill-new (string &optional replace)
1111 "Make STRING the latest kill in the kill ring.
1112 Set the kill-ring-yank pointer to point to it.
1113 If `interprogram-cut-function' is non-nil, apply it to STRING.
1114 Optional second argument REPLACE non-nil means that STRING will replace
1115 the front of the kill ring, rather than being added to the list."
1116 (and (fboundp 'menu-bar-update-yank-menu)
1117 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1119 (setcar kill-ring string)
1120 (setq kill-ring (cons string kill-ring))
1121 (if (> (length kill-ring) kill-ring-max)
1122 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1123 (setq kill-ring-yank-pointer kill-ring)
1124 (if interprogram-cut-function
1125 (funcall interprogram-cut-function string t)))
1127 (defun kill-append (string before-p)
1128 "Append STRING to the end of the latest kill in the kill ring.
1129 If BEFORE-P is non-nil, prepend STRING to the kill.
1130 If `interprogram-cut-function' is set, pass the resulting kill to
1132 (kill-new (if before-p
1133 (concat string (car kill-ring))
1134 (concat (car kill-ring) string)) t))
1136 (defun current-kill (n &optional do-not-move)
1137 "Rotate the yanking point by N places, and then return that kill.
1138 If N is zero, `interprogram-paste-function' is set, and calling it
1139 returns a string, then that string is added to the front of the
1140 kill ring and returned as the latest kill.
1141 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1142 yanking point; just return the Nth kill forward."
1143 (let ((interprogram-paste (and (= n 0)
1144 interprogram-paste-function
1145 (funcall interprogram-paste-function))))
1146 (if interprogram-paste
1148 ;; Disable the interprogram cut function when we add the new
1149 ;; text to the kill ring, so Emacs doesn't try to own the
1150 ;; selection, with identical text.
1151 (let ((interprogram-cut-function nil))
1152 (kill-new interprogram-paste))
1154 (or kill-ring (error "Kill ring is empty"))
1155 (let ((ARGth-kill-element
1156 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1160 (setq kill-ring-yank-pointer ARGth-kill-element))
1161 (car ARGth-kill-element)))))
1165 ;;;; Commands for manipulating the kill ring.
1167 (defvar kill-read-only-ok nil
1168 "*Non-nil means don't signal an error for killing read-only text.")
1170 (defun kill-region (beg end)
1171 "Kill between point and mark.
1172 The text is deleted but saved in the kill ring.
1173 The command \\[yank] can retrieve it from there.
1174 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1175 If the buffer is read-only, Emacs will beep and refrain from deleting
1176 the text, but put the text in the kill ring anyway. This means that
1177 you can use the killing commands to copy text from a read-only buffer.
1179 This is the primitive for programs to kill text (as opposed to deleting it).
1180 Supply two arguments, character numbers indicating the stretch of text
1182 Any command that calls this function is a \"kill command\".
1183 If the previous command was also a kill command,
1184 the text killed this time appends to the text killed last time
1185 to make one entry in the kill ring."
1189 ;; If the buffer is read-only, we should beep, in case the person
1190 ;; just isn't aware of this. However, there's no harm in putting
1191 ;; the region's text in the kill ring, anyway.
1192 ((or (and buffer-read-only (not inhibit-read-only))
1193 (text-property-not-all beg end 'read-only nil))
1194 (copy-region-as-kill beg end)
1195 ;; This should always barf, and give us the correct error.
1196 (if kill-read-only-ok
1197 (message "Read only text copied to kill ring")
1198 (setq this-command 'kill-region)
1199 (barf-if-buffer-read-only)))
1201 ;; In certain cases, we can arrange for the undo list and the kill
1202 ;; ring to share the same string object. This code does that.
1203 ((not (or (eq buffer-undo-list t)
1204 (eq last-command 'kill-region)
1205 ;; Use = since positions may be numbers or markers.
1207 ;; Don't let the undo list be truncated before we can even access it.
1208 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1209 (old-list buffer-undo-list)
1211 (delete-region beg end)
1212 ;; Search back in buffer-undo-list for this string,
1213 ;; in case a change hook made property changes.
1214 (setq tail buffer-undo-list)
1215 (while (not (stringp (car (car tail))))
1216 (setq tail (cdr tail)))
1217 ;; Take the same string recorded for undo
1218 ;; and put it in the kill-ring.
1219 (kill-new (car (car tail)))))
1222 (copy-region-as-kill beg end)
1223 (delete-region beg end)))
1224 (setq this-command 'kill-region))
1226 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1227 ;; to get two copies of the text when the user accidentally types M-w and
1228 ;; then corrects it with the intended C-w.
1229 (defun copy-region-as-kill (beg end)
1230 "Save the region as if killed, but don't kill it.
1231 If `interprogram-cut-function' is non-nil, also save the text for a window
1232 system cut and paste."
1234 (if (eq last-command 'kill-region)
1235 (kill-append (buffer-substring beg end) (< end beg))
1236 (kill-new (buffer-substring beg end)))
1239 (defun kill-ring-save (beg end)
1240 "Save the region as if killed, but don't kill it.
1241 This command is similar to `copy-region-as-kill', except that it gives
1242 visual feedback indicating the extent of the region being copied.
1243 If `interprogram-cut-function' is non-nil, also save the text for a window
1244 system cut and paste."
1246 (copy-region-as-kill beg end)
1248 (let ((other-end (if (= (point) beg) end beg))
1250 ;; Inhibit quitting so we can make a quit here
1251 ;; look like a C-g typed as a command.
1253 (if (pos-visible-in-window-p other-end (selected-window))
1255 ;; Swap point and mark.
1256 (set-marker (mark-marker) (point) (current-buffer))
1257 (goto-char other-end)
1260 (set-marker (mark-marker) other-end (current-buffer))
1262 ;; If user quit, deactivate the mark
1263 ;; as C-g would as a command.
1264 (and quit-flag mark-active
1266 (let* ((killed-text (current-kill 0))
1267 (message-len (min (length killed-text) 40)))
1269 ;; Don't say "killed"; that is misleading.
1270 (message "Saved text until \"%s\""
1271 (substring killed-text (- message-len)))
1272 (message "Saved text from \"%s\""
1273 (substring killed-text 0 message-len))))))))
1275 (defun append-next-kill ()
1276 "Cause following command, if it kills, to append to previous kill."
1280 (setq this-command 'kill-region)
1281 (message "If the next command is a kill, it will append"))
1282 (setq last-command 'kill-region)))
1284 (defun yank-pop (arg)
1285 "Replace just-yanked stretch of killed text with a different stretch.
1286 This command is allowed only immediately after a `yank' or a `yank-pop'.
1287 At such a time, the region contains a stretch of reinserted
1288 previously-killed text. `yank-pop' deletes that text and inserts in its
1289 place a different stretch of killed text.
1291 With no argument, the previous kill is inserted.
1292 With argument N, insert the Nth previous kill.
1293 If N is negative, this is a more recent kill.
1295 The sequence of kills wraps around, so that after the oldest one
1296 comes the newest one."
1298 (if (not (eq last-command 'yank))
1299 (error "Previous command was not a yank"))
1300 (setq this-command 'yank)
1301 (let ((before (< (point) (mark t))))
1302 (delete-region (point) (mark t))
1303 (set-marker (mark-marker) (point) (current-buffer))
1304 (insert (current-kill arg))
1306 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1307 ;; It is cleaner to avoid activation, even though the command
1308 ;; loop would deactivate the mark because we inserted text.
1309 (goto-char (prog1 (mark t)
1310 (set-marker (mark-marker) (point) (current-buffer))))))
1313 (defun yank (&optional arg)
1314 "Reinsert the last stretch of killed text.
1315 More precisely, reinsert the stretch of killed text most recently
1316 killed OR yanked. Put point at end, and set mark at beginning.
1317 With just C-u as argument, same but put point at beginning (and mark at end).
1318 With argument N, reinsert the Nth most recently killed stretch of killed
1320 See also the command \\[yank-pop]."
1322 ;; If we don't get all the way thru, make last-command indicate that
1323 ;; for the following command.
1324 (setq this-command t)
1326 (insert (current-kill (cond
1331 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1332 ;; It is cleaner to avoid activation, even though the command
1333 ;; loop would deactivate the mark because we inserted text.
1334 (goto-char (prog1 (mark t)
1335 (set-marker (mark-marker) (point) (current-buffer)))))
1336 ;; If we do get all the way thru, make this-command indicate that.
1337 (setq this-command 'yank)
1340 (defun rotate-yank-pointer (arg)
1341 "Rotate the yanking point in the kill ring.
1342 With argument, rotate that many kills forward (or backward, if negative)."
1347 (defun insert-buffer (buffer)
1348 "Insert after point the contents of BUFFER.
1349 Puts mark after the inserted text.
1350 BUFFER may be a buffer or a buffer name."
1351 (interactive (list (progn (barf-if-buffer-read-only)
1352 (read-buffer "Insert buffer: "
1353 (other-buffer (current-buffer) t)
1355 (or (bufferp buffer)
1356 (setq buffer (get-buffer buffer)))
1357 (let (start end newmark)
1361 (setq start (point-min) end (point-max)))
1362 (insert-buffer-substring buffer start end)
1363 (setq newmark (point)))
1364 (push-mark newmark))
1367 (defun append-to-buffer (buffer start end)
1368 "Append to specified buffer the text of the region.
1369 It is inserted into that buffer before its point.
1371 When calling from a program, give three arguments:
1372 BUFFER (or buffer name), START and END.
1373 START and END specify the portion of the current buffer to be copied."
1375 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
1376 (region-beginning) (region-end)))
1377 (let ((oldbuf (current-buffer)))
1379 (set-buffer (get-buffer-create buffer))
1380 (insert-buffer-substring oldbuf start end))))
1382 (defun prepend-to-buffer (buffer start end)
1383 "Prepend to specified buffer the text of the region.
1384 It is inserted into that buffer after its point.
1386 When calling from a program, give three arguments:
1387 BUFFER (or buffer name), START and END.
1388 START and END specify the portion of the current buffer to be copied."
1389 (interactive "BPrepend to buffer: \nr")
1390 (let ((oldbuf (current-buffer)))
1392 (set-buffer (get-buffer-create buffer))
1394 (insert-buffer-substring oldbuf start end)))))
1396 (defun copy-to-buffer (buffer start end)
1397 "Copy to specified buffer the text of the region.
1398 It is inserted into that buffer, replacing existing text there.
1400 When calling from a program, give three arguments:
1401 BUFFER (or buffer name), START and END.
1402 START and END specify the portion of the current buffer to be copied."
1403 (interactive "BCopy to buffer: \nr")
1404 (let ((oldbuf (current-buffer)))
1406 (set-buffer (get-buffer-create buffer))
1409 (insert-buffer-substring oldbuf start end)))))
1411 (put 'mark-inactive 'error-conditions '(mark-inactive error))
1412 (put 'mark-inactive 'error-message "The mark is not active now")
1414 (defun mark (&optional force)
1415 "Return this buffer's mark value as integer; error if mark inactive.
1416 If optional argument FORCE is non-nil, access the mark value
1417 even if the mark is not currently active, and return nil
1418 if there is no mark at all.
1420 If you are using this in an editing command, you are most likely making
1421 a mistake; see the documentation of `set-mark'."
1422 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
1423 (marker-position (mark-marker))
1424 (signal 'mark-inactive nil)))
1426 ;; Many places set mark-active directly, and several of them failed to also
1427 ;; run deactivate-mark-hook. This shorthand should simplify.
1428 (defsubst deactivate-mark ()
1429 "Deactivate the mark by setting `mark-active' to nil.
1430 \(That makes a difference only in Transient Mark mode.)
1431 Also runs the hook `deactivate-mark-hook'."
1432 (if transient-mark-mode
1434 (setq mark-active nil)
1435 (run-hooks 'deactivate-mark-hook))))
1437 (defun set-mark (pos)
1438 "Set this buffer's mark to POS. Don't use this function!
1439 That is to say, don't use this function unless you want
1440 the user to see that the mark has moved, and you want the previous
1441 mark position to be lost.
1443 Normally, when a new mark is set, the old one should go on the stack.
1444 This is why most applications should use push-mark, not set-mark.
1446 Novice Emacs Lisp programmers often try to use the mark for the wrong
1447 purposes. The mark saves a location for the user's convenience.
1448 Most editing commands should not alter the mark.
1449 To remember a location for internal use in the Lisp program,
1450 store it in a Lisp variable. Example:
1452 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1456 (setq mark-active t)
1457 (run-hooks 'activate-mark-hook)
1458 (set-marker (mark-marker) pos (current-buffer)))
1459 ;; Normally we never clear mark-active except in Transient Mark mode.
1460 ;; But when we actually clear out the mark value too,
1461 ;; we must clear mark-active in any mode.
1462 (setq mark-active nil)
1463 (run-hooks 'deactivate-mark-hook)
1464 (set-marker (mark-marker) nil)))
1466 (defvar mark-ring nil
1467 "The list of former marks of the current buffer, most recent first.")
1468 (make-variable-buffer-local 'mark-ring)
1469 (put 'mark-ring 'permanent-local t)
1471 (defconst mark-ring-max 16
1472 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1474 (defvar global-mark-ring nil
1475 "The list of saved global marks, most recent first.")
1477 (defconst global-mark-ring-max 16
1478 "*Maximum size of global mark ring. \
1479 Start discarding off end if gets this big.")
1481 (defun set-mark-command (arg)
1482 "Set mark at where point is, or jump to mark.
1483 With no prefix argument, set mark, push old mark position on local mark
1484 ring, and push mark on global mark ring.
1485 With argument, jump to mark, and pop a new position for mark off the ring
1486 \(does not affect global mark ring\).
1488 Novice Emacs Lisp programmers often try to use the mark for the wrong
1489 purposes. See the documentation of `set-mark' for more information."
1493 (push-mark nil nil t))
1495 (error "No mark set in this buffer")
1496 (goto-char (mark t))
1499 (defun push-mark (&optional location nomsg activate)
1500 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1501 If the last global mark pushed was not in the current buffer,
1502 also push LOCATION on the global mark ring.
1503 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1504 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
1506 Novice Emacs Lisp programmers often try to use the mark for the wrong
1507 purposes. See the documentation of `set-mark' for more information.
1509 In Transient Mark mode, this does not activate the mark."
1512 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1513 (if (> (length mark-ring) mark-ring-max)
1515 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1516 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1517 (set-marker (mark-marker) (or location (point)) (current-buffer))
1518 ;; Now push the mark on the global mark ring.
1519 (if (and global-mark-ring
1520 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
1521 ;; The last global mark pushed was in this same buffer.
1522 ;; Don't push another one.
1524 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1525 (if (> (length global-mark-ring) global-mark-ring-max)
1527 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1529 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
1530 (or nomsg executing-macro (> (minibuffer-depth) 0)
1531 (message "Mark set"))
1532 (if (or activate (not transient-mark-mode))
1533 (set-mark (mark t)))
1537 "Pop off mark ring into the buffer's actual mark.
1538 Does not set point. Does nothing if mark ring is empty."
1541 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1542 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1544 (move-marker (car mark-ring) nil)
1545 (if (null (mark t)) (ding))
1546 (setq mark-ring (cdr mark-ring)))))
1548 (define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
1549 (defun exchange-point-and-mark ()
1550 "Put the mark where point is now, and point where the mark is now.
1551 This command works even when the mark is not active,
1552 and it reactivates the mark."
1554 (let ((omark (mark t)))
1556 (error "No mark set in this buffer"))
1561 (defun transient-mark-mode (arg)
1562 "Toggle Transient Mark mode.
1563 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1565 In Transient Mark mode, when the mark is active, the region is highlighted.
1566 Changing the buffer \"deactivates\" the mark.
1567 So do certain other operations that set the mark
1568 but whose main purpose is something else--for example,
1569 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
1571 (setq transient-mark-mode
1573 (not transient-mark-mode)
1574 (> (prefix-numeric-value arg) 0))))
1576 (defun pop-global-mark ()
1577 "Pop off global mark ring and jump to the top location."
1579 ;; Pop entries which refer to non-existent buffers.
1580 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1581 (setq global-mark-ring (cdr global-mark-ring)))
1582 (or global-mark-ring
1583 (error "No global mark set"))
1584 (let* ((marker (car global-mark-ring))
1585 (buffer (marker-buffer marker))
1586 (position (marker-position marker)))
1587 (setq global-mark-ring (nconc (cdr global-mark-ring)
1588 (list (car global-mark-ring))))
1590 (or (and (>= position (point-min))
1591 (<= position (point-max)))
1593 (goto-char position)
1594 (switch-to-buffer buffer)))
1596 (defvar next-line-add-newlines t
1597 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
1599 (defun next-line (arg)
1600 "Move cursor vertically down ARG lines.
1601 If there is no character in the target line exactly under the current column,
1602 the cursor is positioned after the character in that line which spans this
1603 column, or at the end of the line if it is not long enough.
1604 If there is no line in the buffer after this one, behavior depends on the
1605 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
1606 to create a line, and moves the cursor to that line. Otherwise it moves the
1607 cursor to the end of the buffer.
1609 The command \\[set-goal-column] can be used to create
1610 a semipermanent goal column to which this command always moves.
1611 Then it does not try to move vertically. This goal column is stored
1612 in `goal-column', which is nil when there is none.
1614 If you are thinking of using this in a Lisp program, consider
1615 using `forward-line' instead. It is usually easier to use
1616 and more reliable (no dependence on goal column, etc.)."
1618 (if (and next-line-add-newlines (= arg 1))
1619 (let ((opoint (point)))
1628 ((beginning-of-buffer end-of-buffer) (ding)))
1632 (defun previous-line (arg)
1633 "Move cursor vertically up ARG lines.
1634 If there is no character in the target line exactly over the current column,
1635 the cursor is positioned after the character in that line which spans this
1636 column, or at the end of the line if it is not long enough.
1638 The command \\[set-goal-column] can be used to create
1639 a semipermanent goal column to which this command always moves.
1640 Then it does not try to move vertically.
1642 If you are thinking of using this in a Lisp program, consider using
1643 `forward-line' with a negative argument instead. It is usually easier
1644 to use and more reliable (no dependence on goal column, etc.)."
1649 ((beginning-of-buffer end-of-buffer) (ding)))
1650 (line-move (- arg)))
1653 (defconst track-eol nil
1654 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1655 This means moving to the end of each line moved onto.
1656 The beginning of a blank line does not count as the end of a line.")
1658 (defvar goal-column nil
1659 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1660 (make-variable-buffer-local 'goal-column)
1662 (defvar temporary-goal-column 0
1663 "Current goal column for vertical motion.
1664 It is the column where point was
1665 at the start of current run of vertical motion commands.
1666 When the `track-eol' feature is doing its job, the value is 9999.")
1668 (defvar line-move-ignore-invisible nil
1669 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
1670 Outline mode sets this.")
1672 ;; This is the guts of next-line and previous-line.
1673 ;; Arg says how many lines to move.
1674 (defun line-move (arg)
1675 ;; Don't run any point-motion hooks, and disregard intangibility,
1676 ;; for intermediate positions.
1677 (let ((inhibit-point-motion-hooks t)
1682 (if (not (or (eq last-command 'next-line)
1683 (eq last-command 'previous-line)))
1684 (setq temporary-goal-column
1685 (if (and track-eol (eolp)
1686 ;; Don't count beg of empty line as end of line
1687 ;; unless we just did explicit end-of-line.
1688 (or (not (bolp)) (eq last-command 'end-of-line)))
1691 (if (and (not (integerp selective-display))
1692 (not line-move-ignore-invisible))
1693 ;; Use just newline characters.
1695 (progn (if (> arg 1) (forward-line (1- arg)))
1696 ;; This way of moving forward ARG lines
1697 ;; verifies that we have a newline after the last one.
1698 ;; It doesn't get confused by intangible text.
1700 (zerop (forward-line 1)))
1701 (and (zerop (forward-line arg))
1703 (signal (if (< arg 0)
1704 'beginning-of-buffer
1707 ;; Move by arg lines, but ignore invisible ones.
1710 (and (zerop (vertical-motion 1))
1711 (signal 'end-of-buffer nil))
1712 ;; If the following character is currently invisible,
1713 ;; skip all characters with that same `invisible' property value.
1714 (while (and (not (eobp))
1716 (get-char-property (point) 'invisible)))
1717 (if (eq buffer-invisibility-spec t)
1719 (or (memq prop buffer-invisibility-spec)
1720 (assq prop buffer-invisibility-spec)))))
1721 (if (get-text-property (point) 'invisible)
1722 (goto-char (next-single-property-change (point) 'invisible))
1723 (goto-char (next-overlay-change (point)))))
1724 (setq arg (1- arg)))
1727 (and (zerop (vertical-motion -1))
1728 (signal 'beginning-of-buffer nil))
1729 (while (and (not (bobp))
1731 (get-char-property (1- (point)) 'invisible)))
1732 (if (eq buffer-invisibility-spec t)
1734 (or (memq prop buffer-invisibility-spec)
1735 (assq prop buffer-invisibility-spec)))))
1736 (if (get-text-property (1- (point)) 'invisible)
1737 (goto-char (previous-single-property-change (point) 'invisible))
1738 (goto-char (previous-overlay-change (point)))))
1739 (setq arg (1+ arg))))
1740 (move-to-column (or goal-column temporary-goal-column)))
1741 ;; Remember where we moved to, go back home,
1742 ;; then do the motion over again
1743 ;; in just one step, with intangibility and point-motion hooks
1744 ;; enabled this time.
1747 (setq inhibit-point-motion-hooks nil)
1751 ;;; Many people have said they rarely use this feature, and often type
1752 ;;; it by accident. Maybe it shouldn't even be on a key.
1753 (put 'set-goal-column 'disabled t)
1755 (defun set-goal-column (arg)
1756 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1757 Those commands will move to this position in the line moved to
1758 rather than trying to keep the same horizontal position.
1759 With a non-nil argument, clears out the goal column
1760 so that \\[next-line] and \\[previous-line] resume vertical motion.
1761 The goal column is stored in the variable `goal-column'."
1765 (setq goal-column nil)
1766 (message "No goal column"))
1767 (setq goal-column (current-column))
1768 (message (substitute-command-keys
1769 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1773 ;;; Partial support for horizontal autoscrolling. Someday, this feature
1774 ;;; will be built into the C level and all the (hscroll-point-visible) calls
1777 (defvar hscroll-step 0
1778 "*The number of columns to try scrolling a window by when point moves out.
1779 If that fails to bring point back on frame, point is centered instead.
1780 If this is zero, point is always centered after it moves off frame.")
1782 (defun hscroll-point-visible ()
1783 "Scrolls the selected window horizontally to make point visible."
1785 (set-buffer (window-buffer))
1786 (if (not (or truncate-lines
1787 (> (window-hscroll) 0)
1788 (and truncate-partial-width-windows
1789 (< (window-width) (frame-width)))))
1790 ;; Point is always visible when lines are wrapped.
1792 ;; If point is on the invisible part of the line before window-start,
1793 ;; then hscrolling can't bring it back, so reset window-start first.
1794 (and (< (point) (window-start))
1795 (let ((ws-bol (save-excursion
1796 (goto-char (window-start))
1799 (and (>= (point) ws-bol)
1800 (set-window-start nil ws-bol))))
1801 (let* ((here (hscroll-window-column))
1802 (left (min (window-hscroll) 1))
1803 (right (1- (window-width))))
1804 ;; Allow for the truncation glyph, if we're not exactly at eol.
1805 (if (not (and (= here right)
1806 (= (following-char) ?\n)))
1807 (setq right (1- right)))
1809 ;; If too far away, just recenter. But don't show too much
1810 ;; white space off the end of the line.
1811 ((or (< here (- left hscroll-step))
1812 (> here (+ right hscroll-step)))
1813 (let ((eol (save-excursion (end-of-line) (hscroll-window-column))))
1814 (scroll-left (min (- here (/ (window-width) 2))
1815 (- eol (window-width) -5)))))
1816 ;; Within range. Scroll by one step (or maybe not at all).
1818 (scroll-right hscroll-step))
1820 (scroll-left hscroll-step)))))))
1822 ;; This function returns the window's idea of the display column of point,
1823 ;; assuming that the window is already known to be truncated rather than
1824 ;; wrapped, and that we've already handled the case where point is on the
1825 ;; part of the line before window-start. We ignore window-width; if point
1826 ;; is beyond the right margin, we want to know how far. The return value
1827 ;; includes the effects of window-hscroll, window-start, and the prompt
1828 ;; string in the minibuffer. It may be negative due to hscroll.
1829 (defun hscroll-window-column ()
1830 (let* ((hscroll (window-hscroll))
1831 (startpos (save-excursion
1833 (if (= (point) (save-excursion
1834 (goto-char (window-start))
1837 (goto-char (window-start)))
1839 (hpos (+ (if (and (eq (selected-window) (minibuffer-window))
1840 (= 1 (window-start))
1841 (= startpos (point-min)))
1842 (minibuffer-prompt-width)
1844 (min 0 (- 1 hscroll))))
1846 (car (cdr (compute-motion startpos (cons hpos 0)
1848 1000000 (cons hscroll 0) nil)))))
1851 ;; rms: (1) The definitions of arrow keys should not simply restate
1852 ;; what keys they are. The arrow keys should run the ordinary commands.
1853 ;; (2) The arrow keys are just one of many common ways of moving point
1854 ;; within a line. Real horizontal autoscrolling would be a good feature,
1855 ;; but supporting it only for arrow keys is too incomplete to be desirable.
1857 ;;;;; Make arrow keys do the right thing for improved terminal support
1858 ;;;;; When we implement true horizontal autoscrolling, right-arrow and
1859 ;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1860 ;;;;; aliases. These functions are bound to the corresponding keyboard
1861 ;;;;; events in loaddefs.el.
1863 ;;(defun right-arrow (arg)
1864 ;; "Move right one character on the screen (with prefix ARG, that many chars).
1865 ;;Scroll right if needed to keep point horizontally onscreen."
1866 ;; (interactive "P")
1867 ;; (forward-char arg)
1868 ;; (hscroll-point-visible))
1870 ;;(defun left-arrow (arg)
1871 ;; "Move left one character on the screen (with prefix ARG, that many chars).
1872 ;;Scroll left if needed to keep point horizontally onscreen."
1873 ;; (interactive "P")
1874 ;; (backward-char arg)
1875 ;; (hscroll-point-visible))
1877 (defun scroll-other-window-down (lines)
1878 "Scroll the \"other window\" down.
1879 For more details, see the documentation for `scroll-other-window'."
1881 (scroll-other-window
1882 ;; Just invert the argument's meaning.
1883 ;; We can do that without knowing which window it will be.
1884 (if (eq lines '-) nil
1886 (- (prefix-numeric-value lines))))))
1887 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
1889 (defun beginning-of-buffer-other-window (arg)
1890 "Move point to the beginning of the buffer in the other window.
1891 Leave mark at previous position.
1892 With arg N, put point N/10 of the way from the true beginning."
1894 (let ((orig-window (selected-window))
1895 (window (other-window-for-scrolling)))
1896 ;; We use unwind-protect rather than save-window-excursion
1897 ;; because the latter would preserve the things we want to change.
1900 (select-window window)
1901 ;; Set point and mark in that window's buffer.
1902 (beginning-of-buffer arg)
1903 ;; Set point accordingly.
1905 (select-window orig-window))))
1907 (defun end-of-buffer-other-window (arg)
1908 "Move point to the end of the buffer in the other window.
1909 Leave mark at previous position.
1910 With arg N, put point N/10 of the way from the true end."
1912 ;; See beginning-of-buffer-other-window for comments.
1913 (let ((orig-window (selected-window))
1914 (window (other-window-for-scrolling)))
1917 (select-window window)
1920 (select-window orig-window))))
1922 (defun transpose-chars (arg)
1923 "Interchange characters around point, moving forward one character.
1924 With prefix arg ARG, effect is to take character before point
1925 and drag it forward past ARG other characters (backward if ARG negative).
1926 If no argument and at end of line, the previous two chars are exchanged."
1928 (and (null arg) (eolp) (forward-char -1))
1929 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1931 (defun transpose-words (arg)
1932 "Interchange words around point, leaving point at end of them.
1933 With prefix arg ARG, effect is to take word before or around point
1934 and drag it forward past ARG other words (backward if ARG negative).
1935 If ARG is zero, the words around or after point and around or after mark
1938 (transpose-subr 'forward-word arg))
1940 (defun transpose-sexps (arg)
1941 "Like \\[transpose-words] but applies to sexps.
1942 Does not work on a sexp that point is in the middle of
1943 if it is a list or string."
1945 (transpose-subr 'forward-sexp arg))
1947 (defun transpose-lines (arg)
1948 "Exchange current line and previous line, leaving point after both.
1949 With argument ARG, takes previous line and moves it past ARG lines.
1950 With argument 0, interchanges line point is in with line mark is in."
1952 (transpose-subr (function
1956 ;; Move forward over a line,
1957 ;; but create a newline if none exists yet.
1962 (forward-line arg))))
1965 (defun transpose-subr (mover arg)
1966 (let (start1 end1 start2 end2)
1973 (setq start2 (point))
1978 (setq start1 (point))
1980 (exchange-point-and-mark)))
1983 (setq start1 (point))
1989 (setq start2 (point))
1992 (setq arg (1- arg)))
1995 (setq start2 (point))
1997 (setq start1 (point))
2003 (setq arg (1+ arg)))))
2005 (defun transpose-subr-1 ()
2006 (if (> (min end1 end2) (max start1 start2))
2007 (error "Don't have two things to transpose"))
2008 (let ((word1 (buffer-substring start1 end1))
2009 (word2 (buffer-substring start2 end2)))
2010 (delete-region start2 end2)
2013 (goto-char (if (< start1 start2) start1
2014 (+ start1 (- (length word1) (length word2)))))
2015 (delete-char (length word1))
2018 (defconst comment-column 32
2019 "*Column to indent right-margin comments to.
2020 Setting this variable automatically makes it local to the current buffer.
2021 Each mode establishes a different default value for this variable; you
2022 can set the value for a particular mode using that mode's hook.")
2023 (make-variable-buffer-local 'comment-column)
2025 (defconst comment-start nil
2026 "*String to insert to start a new comment, or nil if no comment syntax.")
2028 (defconst comment-start-skip nil
2029 "*Regexp to match the start of a comment plus everything up to its body.
2030 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
2031 at the place matched by the close of the first pair.")
2033 (defconst comment-end ""
2034 "*String to insert to end a new comment.
2035 Should be an empty string if comments are terminated by end-of-line.")
2037 (defconst comment-indent-hook nil
2038 "Obsolete variable for function to compute desired indentation for a comment.
2039 This function is called with no args with point at the beginning of
2040 the comment's starting delimiter.")
2042 (defconst comment-indent-function
2043 '(lambda () comment-column)
2044 "Function to compute desired indentation for a comment.
2045 This function is called with no args with point at the beginning of
2046 the comment's starting delimiter.")
2048 (defconst block-comment-start nil
2049 "*String to insert to start a new comment on a line by itself.
2050 If nil, use `comment-start' instead.
2051 Note that the regular expression `comment-start-skip' should skip this string
2052 as well as the `comment-start' string.")
2054 (defconst block-comment-end nil
2055 "*String to insert to end a new comment on a line by itself.
2056 Should be an empty string if comments are terminated by end-of-line.
2057 If nil, use `comment-end' instead.")
2059 (defun indent-for-comment ()
2060 "Indent this line's comment to comment column, or insert an empty comment."
2062 (let* ((empty (save-excursion (beginning-of-line)
2063 (looking-at "[ \t]*$")))
2064 (starter (or (and empty block-comment-start) comment-start))
2065 (ender (or (and empty block-comment-end) comment-end)))
2067 (error "No comment syntax defined")
2068 (let* ((eolpos (save-excursion (end-of-line) (point)))
2071 (if (re-search-forward comment-start-skip eolpos 'move)
2072 (progn (setq cpos (point-marker))
2073 ;; Find the start of the comment delimiter.
2074 ;; If there were paren-pairs in comment-start-skip,
2075 ;; position at the end of the first pair.
2077 (goto-char (match-end 1))
2078 ;; If comment-start-skip matched a string with
2079 ;; internal whitespace (not final whitespace) then
2080 ;; the delimiter start at the end of that
2081 ;; whitespace. Otherwise, it starts at the
2082 ;; beginning of what was matched.
2083 (skip-syntax-backward " " (match-beginning 0))
2084 (skip-syntax-backward "^ " (match-beginning 0)))))
2085 (setq begpos (point))
2086 ;; Compute desired indent.
2087 (if (= (current-column)
2088 (setq indent (if comment-indent-hook
2089 (funcall comment-indent-hook)
2090 (funcall comment-indent-function))))
2092 ;; If that's different from current, change it.
2093 (skip-chars-backward " \t")
2094 (delete-region (point) begpos)
2096 ;; An existing comment?
2098 (progn (goto-char cpos)
2099 (set-marker cpos nil))
2103 (insert ender)))))))
2105 (defun set-comment-column (arg)
2106 "Set the comment column based on point.
2107 With no arg, set the comment column to the current column.
2108 With just minus as arg, kill any comment on this line.
2109 With any other arg, set comment column to indentation of the previous comment
2110 and then align or create a comment on this line at that column."
2118 (re-search-backward comment-start-skip)
2120 (re-search-forward comment-start-skip)
2121 (goto-char (match-beginning 0))
2122 (setq comment-column (current-column))
2123 (message "Comment column set to %d" comment-column))
2124 (indent-for-comment))
2125 (setq comment-column (current-column))
2126 (message "Comment column set to %d" comment-column))))
2128 (defun kill-comment (arg)
2129 "Kill the comment on this line, if any.
2130 With argument, kill comments on that many lines starting with this one."
2131 ;; this function loses in a lot of situations. it incorrectly recognises
2132 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
2133 ;; with multi-line comments, can kill extra whitespace if comment wasn't
2134 ;; through end-of-line, et cetera.
2136 (or comment-start-skip (error "No comment syntax defined"))
2137 (let ((count (prefix-numeric-value arg)) endc)
2143 (and (string< "" comment-end)
2146 (re-search-forward (regexp-quote comment-end) endc 'move)
2147 (skip-chars-forward " \t")
2150 (if (re-search-forward comment-start-skip endc t)
2152 (goto-char (match-beginning 0))
2153 (skip-chars-backward " \t")
2154 (kill-region (point) endc)
2155 ;; to catch comments a line beginnings
2156 (indent-according-to-mode))))
2157 (if arg (forward-line 1))
2158 (setq count (1- count)))))
2160 (defun comment-region (beg end &optional arg)
2161 "Comment or uncomment each line in the region.
2162 With just C-u prefix arg, uncomment each line in region.
2163 Numeric prefix arg ARG means use ARG comment characters.
2164 If ARG is negative, delete that many comment characters instead.
2165 Comments are terminated on each line, even for syntax in which newline does
2166 not end the comment. Blank lines do not get comments."
2167 ;; if someone wants it to only put a comment-start at the beginning and
2168 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2169 ;; is easy enough. No option is made here for other than commenting
2171 (interactive "r\nP")
2172 (or comment-start (error "No comment syntax is defined"))
2173 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
2176 (let ((cs comment-start) (ce comment-end)
2178 (if (consp arg) (setq numarg t)
2179 (setq numarg (prefix-numeric-value arg))
2180 ;; For positive arg > 1, replicate the comment delims now,
2181 ;; then insert the replicated strings just once.
2183 (setq cs (concat cs comment-start)
2184 ce (concat ce comment-end))
2185 (setq numarg (1- numarg))))
2186 ;; Loop over all lines from BEG to END.
2187 (narrow-to-region beg end)
2190 (if (or (eq numarg t) (< numarg 0))
2192 ;; Delete comment start from beginning of line.
2194 (while (looking-at (regexp-quote cs))
2195 (delete-char (length cs)))
2196 (let ((count numarg))
2197 (while (and (> 1 (setq count (1+ count)))
2198 (looking-at (regexp-quote cs)))
2199 (delete-char (length cs)))))
2200 ;; Delete comment end from end of line.
2206 ;; This is questionable if comment-end ends in
2207 ;; whitespace. That is pretty brain-damaged,
2209 (skip-chars-backward " \t")
2210 (if (and (>= (- (point) (point-min)) (length ce))
2212 (backward-char (length ce))
2213 (looking-at (regexp-quote ce))))
2214 (delete-char (- (length ce)))))
2215 (let ((count numarg))
2216 (while (> 1 (setq count (1+ count)))
2218 ;; this is questionable if comment-end ends in whitespace
2219 ;; that is pretty brain-damaged though
2220 (skip-chars-backward " \t")
2222 (backward-char (length ce))
2223 (if (looking-at (regexp-quote ce))
2224 (delete-char (length ce))))))))
2226 ;; Insert at beginning and at end.
2227 (if (looking-at "[ \t]*$") ()
2229 (if (string= "" ce) ()
2232 (search-forward "\n" nil 'move)))))))
2234 (defun backward-word (arg)
2235 "Move backward until encountering the end of a word.
2236 With argument, do this that many times.
2237 In programs, it is faster to call `forward-word' with negative arg."
2239 (forward-word (- arg)))
2241 (defun mark-word (arg)
2242 "Set mark arg words away from point."
2250 (defun kill-word (arg)
2251 "Kill characters forward until encountering the end of a word.
2252 With argument, do this that many times."
2254 (kill-region (point) (progn (forward-word arg) (point))))
2256 (defun backward-kill-word (arg)
2257 "Kill characters backward until encountering the end of a word.
2258 With argument, do this that many times."
2260 (kill-word (- arg)))
2262 (defun current-word (&optional strict)
2263 "Return the word point is on (or a nearby word) as a string.
2264 If optional arg STRICT is non-nil, return nil unless point is within
2265 or adjacent to a word."
2267 (let ((oldpoint (point)) (start (point)) (end (point)))
2268 (skip-syntax-backward "w_") (setq start (point))
2269 (goto-char oldpoint)
2270 (skip-syntax-forward "w_") (setq end (point))
2271 (if (and (eq start oldpoint) (eq end oldpoint))
2272 ;; Point is neither within nor adjacent to a word.
2275 ;; Look for preceding word in same line.
2276 (skip-syntax-backward "^w_"
2277 (save-excursion (beginning-of-line)
2280 ;; No preceding word in same line.
2281 ;; Look for following word in same line.
2283 (skip-syntax-forward "^w_"
2284 (save-excursion (end-of-line)
2286 (setq start (point))
2287 (skip-syntax-forward "w_")
2290 (skip-syntax-backward "w_")
2291 (setq start (point)))
2292 (buffer-substring start end)))
2293 (buffer-substring start end)))))
2295 (defconst fill-prefix nil
2296 "*String for filling to insert at front of new line, or nil for none.
2297 Setting this variable automatically makes it local to the current buffer.")
2298 (make-variable-buffer-local 'fill-prefix)
2300 (defconst auto-fill-inhibit-regexp nil
2301 "*Regexp to match lines which should not be auto-filled.")
2303 (defun do-auto-fill ()
2304 (let (fc justify bol give-up
2305 (fill-prefix fill-prefix))
2306 (if (or (not (setq justify (current-justification)))
2307 (null (setq fc (current-fill-column)))
2308 (and (eq justify 'left)
2309 (<= (current-column) fc))
2310 (save-excursion (beginning-of-line)
2312 (and auto-fill-inhibit-regexp
2313 (looking-at auto-fill-inhibit-regexp))))
2314 nil ;; Auto-filling not required
2315 (if (memq justify '(full center right))
2316 (save-excursion (unjustify-current-line)))
2318 ;; Choose a fill-prefix automatically.
2319 (if (and adaptive-fill-mode
2320 (or (null fill-prefix) (string= fill-prefix "")))
2321 (let (start end temp)
2326 (setq start (point))
2327 (move-to-left-margin)
2328 ;; Don't do it if this line is a paragraph-starter line
2329 ;; because then the next line will probably also become one.
2330 ;; In text mode, when the user indents the first line of a
2331 ;; paragraph, we don't want all the lines to be indented.
2332 (if (not (looking-at paragraph-start))
2333 (cond ((re-search-forward adaptive-fill-regexp end t)
2335 (buffer-substring-no-properties start (point))))
2336 ((setq temp (funcall adaptive-fill-function))
2337 (setq fill-prefix temp)))))))
2339 (while (and (not give-up) (> (current-column) fc))
2340 ;; Determine where to split the line.
2342 (let ((opoint (point))
2346 (move-to-column (1+ fc))
2347 ;; Move back to a word boundary.
2349 ;; If this is after period and a single space,
2350 ;; move back once more--we don't want to break
2351 ;; the line there and make it look like a
2355 sentence-end-double-space
2356 (save-excursion (forward-char -1)
2357 (and (looking-at "\\. ")
2358 (not (looking-at "\\. "))))))
2360 (skip-chars-backward "^ \t\n")
2361 ;; If we find nowhere on the line to break it,
2362 ;; break after one word. Set bounce to t
2363 ;; so we will not keep going in this while loop.
2366 (re-search-forward "[ \t]" opoint t)
2368 (skip-chars-backward " \t"))
2369 ;; Let fill-point be set to the place where we end up.
2371 ;; If that place is not the beginning of the line,
2372 ;; break the line there.
2374 (goto-char fill-point)
2376 (let ((prev-column (current-column)))
2377 ;; If point is at the fill-point, do not `save-excursion'.
2378 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2379 ;; point will end up before it rather than after it.
2381 (skip-chars-backward " \t")
2382 (= (point) fill-point))
2383 (indent-new-comment-line t)
2385 (goto-char fill-point)
2386 (indent-new-comment-line t)))
2387 ;; Now do justification, if required
2388 (if (not (eq justify 'left))
2391 (justify-current-line justify nil t)))
2392 ;; If making the new line didn't reduce the hpos of
2393 ;; the end of the line, then give up now;
2394 ;; trying again will not help.
2395 (if (>= (current-column) prev-column)
2397 ;; No place to break => stop trying.
2399 ;; justify last line
2400 (justify-current-line justify t t))))
2402 (defun auto-fill-mode (&optional arg)
2403 "Toggle auto-fill mode.
2404 With arg, turn Auto-Fill mode on if and only if arg is positive.
2405 In Auto-Fill mode, inserting a space at a column beyond `current-fill-column'
2406 automatically breaks the line at a previous space."
2408 (prog1 (setq auto-fill-function
2410 (not auto-fill-function)
2411 (> (prefix-numeric-value arg) 0))
2414 (force-mode-line-update)))
2416 ;; This holds a document string used to document auto-fill-mode.
2417 (defun auto-fill-function ()
2418 "Automatically break line at a previous space, in insertion of text."
2421 (defun turn-on-auto-fill ()
2422 "Unconditionally turn on Auto Fill mode."
2425 (defun set-fill-column (arg)
2426 "Set `fill-column' to current column, or to argument if given.
2427 The variable `fill-column' has a separate value for each buffer."
2429 (setq fill-column (if (integerp arg) arg (current-column)))
2430 (message "fill-column set to %d" fill-column))
2432 (defconst comment-multi-line nil
2433 "*Non-nil means \\[indent-new-comment-line] should continue same comment
2434 on new line, with no new terminator or starter.
2435 This is obsolete because you might as well use \\[newline-and-indent].")
2437 (defun indent-new-comment-line (&optional soft)
2438 "Break line at point and indent, continuing comment if within one.
2439 This indents the body of the continued comment
2440 under the previous comment line.
2442 This command is intended for styles where you write a comment per line,
2443 starting a new comment (and terminating it if necessary) on each line.
2444 If you want to continue one comment across several lines, use \\[newline-and-indent].
2446 If a fill column is specified, it overrides the use of the comment column
2447 or comment indentation.
2449 The inserted newline is marked hard if `use-hard-newlines' is true,
2450 unless optional argument SOFT is non-nil."
2452 (let (comcol comstart)
2453 (skip-chars-backward " \t")
2454 (delete-region (point)
2455 (progn (skip-chars-forward " \t")
2457 (if soft (insert-and-inherit ?\n) (newline 1))
2460 (indent-to-left-margin)
2461 (insert-and-inherit fill-prefix))
2462 (if (not comment-multi-line)
2464 (if (and comment-start-skip
2465 (let ((opoint (point)))
2467 (re-search-forward comment-start-skip opoint t)))
2468 ;; The old line is a comment.
2469 ;; Set WIN to the pos of the comment-start.
2470 ;; But if the comment is empty, look at preceding lines
2471 ;; to find one that has a nonempty comment.
2473 ;; If comment-start-skip contains a \(...\) pair,
2474 ;; the real comment delimiter starts at the end of that pair.
2475 (let ((win (or (match-end 1) (match-beginning 0))))
2476 (while (and (eolp) (not (bobp))
2479 (setq opoint (point))
2481 (re-search-forward comment-start-skip opoint t)))
2482 (setq win (or (match-end 1) (match-beginning 0))))
2483 ;; Indent this line like what we found.
2485 (setq comcol (current-column))
2487 (buffer-substring (point) (match-end 0)))))))
2489 (let ((comment-column comcol)
2490 (comment-start comstart)
2491 (comment-end comment-end))
2492 (and comment-end (not (equal comment-end ""))
2493 ; (if (not comment-multi-line)
2496 (insert comment-end)
2498 ; (setq comment-column (+ comment-column (length comment-start))
2503 (setq comment-end ""))
2504 (insert-and-inherit ?\n)
2506 (indent-for-comment)
2508 ;; Make sure we delete the newline inserted above.
2511 (indent-according-to-mode)))))
2513 (defun set-selective-display (arg)
2514 "Set `selective-display' to ARG; clear it if no arg.
2515 When the value of `selective-display' is a number > 0,
2516 lines whose indentation is >= that value are not displayed.
2517 The variable `selective-display' has a separate value for each buffer."
2519 (if (eq selective-display t)
2520 (error "selective-display already in use for marked lines"))
2523 (narrow-to-region (point-min) (point))
2524 (goto-char (window-start))
2525 (vertical-motion (window-height)))))
2526 (setq selective-display
2527 (and arg (prefix-numeric-value arg)))
2528 (recenter current-vpos))
2529 (set-window-start (selected-window) (window-start (selected-window)))
2530 (princ "selective-display set to " t)
2531 (prin1 selective-display t)
2534 (defconst overwrite-mode-textual " Ovwrt"
2535 "The string displayed in the mode line when in overwrite mode.")
2536 (defconst overwrite-mode-binary " Bin Ovwrt"
2537 "The string displayed in the mode line when in binary overwrite mode.")
2539 (defun overwrite-mode (arg)
2540 "Toggle overwrite mode.
2541 With arg, turn overwrite mode on iff arg is positive.
2542 In overwrite mode, printing characters typed in replace existing text
2543 on a one-for-one basis, rather than pushing it to the right. At the
2544 end of a line, such characters extend the line. Before a tab,
2545 such characters insert until the tab is filled in.
2546 \\[quoted-insert] still inserts characters in overwrite mode; this
2547 is supposed to make it easier to insert characters when necessary."
2549 (setq overwrite-mode
2550 (if (if (null arg) (not overwrite-mode)
2551 (> (prefix-numeric-value arg) 0))
2552 'overwrite-mode-textual))
2553 (force-mode-line-update))
2555 (defun binary-overwrite-mode (arg)
2556 "Toggle binary overwrite mode.
2557 With arg, turn binary overwrite mode on iff arg is positive.
2558 In binary overwrite mode, printing characters typed in replace
2559 existing text. Newlines are not treated specially, so typing at the
2560 end of a line joins the line to the next, with the typed character
2561 between them. Typing before a tab character simply replaces the tab
2562 with the character typed.
2563 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2564 typing characters do.
2566 Note that binary overwrite mode is not its own minor mode; it is a
2567 specialization of overwrite-mode, entered by setting the
2568 `overwrite-mode' variable to `overwrite-mode-binary'."
2570 (setq overwrite-mode
2572 (not (eq overwrite-mode 'overwrite-mode-binary))
2573 (> (prefix-numeric-value arg) 0))
2574 'overwrite-mode-binary))
2575 (force-mode-line-update))
2577 (defvar line-number-mode t
2578 "*Non-nil means display line number in mode line.")
2580 (defun line-number-mode (arg)
2581 "Toggle Line Number mode.
2582 With arg, turn Line Number mode on iff arg is positive.
2583 When Line Number mode is enabled, the line number appears
2586 (setq line-number-mode
2587 (if (null arg) (not line-number-mode)
2588 (> (prefix-numeric-value arg) 0)))
2589 (force-mode-line-update))
2591 (defvar column-number-mode t
2592 "*Non-nil means display column number in mode line.")
2594 (defun column-number-mode (arg)
2595 "Toggle Column Number mode.
2596 With arg, turn Column Number mode on iff arg is positive.
2597 When Column Number mode is enabled, the column number appears
2600 (setq column-number-mode
2601 (if (null arg) (not column-number-mode)
2602 (> (prefix-numeric-value arg) 0)))
2603 (force-mode-line-update))
2605 (defvar blink-matching-paren t
2606 "*Non-nil means show matching open-paren when close-paren is inserted.")
2608 (defconst blink-matching-paren-distance 12000
2609 "*If non-nil, is maximum distance to search for matching open-paren.")
2611 (defconst blink-matching-delay 1
2612 "*The number of seconds that `blink-matching-open' will delay at a match.")
2614 (defconst blink-matching-paren-dont-ignore-comments nil
2615 "*Non-nil means `blink-matching-paren' should not ignore comments.")
2617 (defun blink-matching-open ()
2618 "Move cursor momentarily to the beginning of the sexp before point."
2620 (and (> (point) (1+ (point-min)))
2621 blink-matching-paren
2622 ;; Verify an even number of quoting characters precede the close.
2623 (= 1 (logand 1 (- (point)
2626 (skip-syntax-backward "/\\")
2628 (let* ((oldpos (point))
2633 (if blink-matching-paren-distance
2634 (narrow-to-region (max (point-min)
2635 (- (point) blink-matching-paren-distance))
2638 (let ((parse-sexp-ignore-comments
2639 (and parse-sexp-ignore-comments
2640 (not blink-matching-paren-dont-ignore-comments))))
2641 (setq blinkpos (scan-sexps oldpos -1)))
2644 (/= (char-syntax (char-after blinkpos))
2647 (or (null (matching-paren (char-after blinkpos)))
2648 (/= (char-after (1- oldpos))
2649 (matching-paren (char-after blinkpos))))))
2650 (if mismatch (setq blinkpos nil))
2653 (goto-char blinkpos)
2654 (if (pos-visible-in-window-p)
2655 (sit-for blink-matching-delay)
2656 (goto-char blinkpos)
2659 ;; Show what precedes the open in its line, if anything.
2661 (skip-chars-backward " \t")
2663 (buffer-substring (progn (beginning-of-line) (point))
2665 ;; Show what follows the open in its line, if anything.
2668 (skip-chars-forward " \t")
2670 (buffer-substring blinkpos
2671 (progn (end-of-line) (point)))
2672 ;; Otherwise show the previous nonblank line,
2675 (skip-chars-backward "\n \t")
2678 (buffer-substring (progn
2679 (skip-chars-backward "\n \t")
2682 (progn (end-of-line)
2683 (skip-chars-backward " \t")
2685 ;; Replace the newline and other whitespace with `...'.
2687 (buffer-substring blinkpos (1+ blinkpos)))
2688 ;; There is nothing to show except the char itself.
2689 (buffer-substring blinkpos (1+ blinkpos))))))))
2691 (message "Mismatched parentheses"))
2692 ((not blink-matching-paren-distance)
2693 (message "Unmatched parenthesis"))))))))
2695 ;Turned off because it makes dbx bomb out.
2696 (setq blink-paren-function 'blink-matching-open)
2698 ;; This executes C-g typed while Emacs is waiting for a command.
2699 ;; Quitting out of a program does not go through here;
2700 ;; that happens in the QUIT macro at the C code level.
2701 (defun keyboard-quit ()
2702 "Signal a quit condition.
2703 During execution of Lisp code, this character causes a quit directly.
2704 At top-level, as an editor command, this simply beeps."
2709 (define-key global-map "\C-g" 'keyboard-quit)
2711 (defvar buffer-quit-function nil
2712 "Function to call to \"quit\" the current buffer, or nil if none.
2713 \\[keyboard-escape-quit] calls this function when its more local actions
2714 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
2716 (defun keyboard-escape-quit ()
2717 "Exit the current \"mode\" (in a generalized sense of the word).
2718 This command can exit an interactive command such as `query-replace',
2719 can clear out a prefix argument or a region,
2720 can get out of the minibuffer or other recursive edit,
2721 cancel the use of the current buffer (for special-purpose buffers),
2722 or go back to just one window (by deleting all but the selected window)."
2724 (cond ((eq last-command 'mode-exited) nil)
2725 ((> (minibuffer-depth) 0)
2726 (abort-recursive-edit))
2729 ((and transient-mark-mode
2732 (buffer-quit-function
2733 (funcall buffer-quit-function))
2734 ((not (one-window-p t))
2735 (delete-other-windows))))
2737 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
2739 (defun set-variable (var val)
2740 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2741 When using this interactively, supply a Lisp expression for VALUE.
2742 If you want VALUE to be a string, you must surround it with doublequotes.
2744 If VARIABLE has a `variable-interactive' property, that is used as if
2745 it were the arg to `interactive' (which see) to interactively read the value."
2747 (let* ((var (read-variable "Set variable: "))
2748 (minibuffer-help-form
2753 (with-output-to-temp-buffer "*Help*"
2755 (princ "\nDocumentation:\n")
2756 (princ (substring (documentation-property var 'variable-documentation)
2759 (let ((print-length 20))
2760 (princ "\n\nCurrent value: ")
2761 (prin1 (symbol-value var))))
2763 (set-buffer standard-output)
2767 (let ((prop (get var 'variable-interactive)))
2769 ;; Use VAR's `variable-interactive' property
2770 ;; as an interactive spec for prompting.
2771 (call-interactively (list 'lambda '(arg)
2772 (list 'interactive prop)
2774 (eval-minibuffer (format "Set %s to value: " var)))))))
2777 ;; Define the major mode for lists of completions.
2779 (defvar completion-list-mode-map nil
2780 "Local map for completion list buffers.")
2781 (or completion-list-mode-map
2782 (let ((map (make-sparse-keymap)))
2783 (define-key map [mouse-2] 'mouse-choose-completion)
2784 (define-key map [down-mouse-2] nil)
2785 (define-key map "\C-m" 'choose-completion)
2786 (define-key map "\e\e\e" 'delete-completion-window)
2787 (define-key map [left] 'previous-completion)
2788 (define-key map [right] 'next-completion)
2789 (setq completion-list-mode-map map)))
2791 ;; Completion mode is suitable only for specially formatted data.
2792 (put 'completion-list-mode 'mode-class 'special)
2794 (defvar completion-reference-buffer nil
2795 "Record the buffer that was current when the completion list was requested.
2796 This is a local variable in the completion list buffer.
2797 Initial value is nil to avoid some compiler warnings.")
2799 (defvar completion-base-size nil
2800 "Number of chars at beginning of minibuffer not involved in completion.
2801 This is a local variable in the completion list buffer
2802 but it talks about the buffer in `completion-reference-buffer'.
2803 If this is nil, it means to compare text to determine which part
2804 of the tail end of the buffer's text is involved in completion.")
2806 (defun delete-completion-window ()
2807 "Delete the completion list window.
2808 Go to the window from which completion was requested."
2810 (let ((buf completion-reference-buffer))
2811 (delete-window (selected-window))
2812 (if (get-buffer-window buf)
2813 (select-window (get-buffer-window buf)))))
2815 (defun previous-completion (n)
2816 "Move to the previous item in the completion list."
2818 (next-completion (- n)))
2820 (defun next-completion (n)
2821 "Move to the next item in the completion list.
2822 WIth prefix argument N, move N items (negative N means move backward)."
2824 (while (and (> n 0) (not (eobp)))
2825 (let ((prop (get-text-property (point) 'mouse-face)))
2826 ;; If in a completion, move to the end of it.
2828 (goto-char (next-single-property-change (point) 'mouse-face)))
2829 ;; Move to start of next one.
2830 (goto-char (next-single-property-change (point) 'mouse-face)))
2832 (while (and (< n 0) (not (bobp)))
2833 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
2834 ;; If in a completion, move to the start of it.
2836 (goto-char (previous-single-property-change (point) 'mouse-face)))
2837 ;; Move to end of the previous completion.
2838 (goto-char (previous-single-property-change (point) 'mouse-face))
2839 ;; Move to the start of that one.
2840 (goto-char (previous-single-property-change (point) 'mouse-face)))
2843 (defun choose-completion ()
2844 "Choose the completion that point is in or next to."
2846 (let (beg end completion (buffer completion-reference-buffer)
2847 (base-size completion-base-size))
2848 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
2849 (setq end (point) beg (1+ (point))))
2850 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
2851 (setq end (1- (point)) beg (point)))
2853 (error "No completion here"))
2854 (setq beg (previous-single-property-change beg 'mouse-face))
2855 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
2856 (setq completion (buffer-substring beg end))
2857 (let ((owindow (selected-window)))
2858 (if (and (one-window-p t 'selected-frame)
2859 (window-dedicated-p (selected-window)))
2860 ;; This is a special buffer's frame
2861 (iconify-frame (selected-frame))
2862 (or (window-dedicated-p (selected-window))
2864 (select-window owindow))
2865 (choose-completion-string completion buffer base-size)))
2867 ;; Delete the longest partial match for STRING
2868 ;; that can be found before POINT.
2869 (defun choose-completion-delete-max-match (string)
2870 (let ((opoint (point))
2871 (len (min (length string)
2872 (- (point) (point-min)))))
2873 (goto-char (- (point) (length string)))
2874 (if completion-ignore-case
2875 (setq string (downcase string)))
2876 (while (and (> len 0)
2877 (let ((tail (buffer-substring (point)
2879 (if completion-ignore-case
2880 (setq tail (downcase tail)))
2881 (not (string= tail (substring string 0 len)))))
2886 ;; Switch to BUFFER and insert the completion choice CHOICE.
2887 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
2888 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
2889 (defun choose-completion-string (choice &optional buffer base-size)
2890 (let ((buffer (or buffer completion-reference-buffer)))
2891 ;; If BUFFER is a minibuffer, barf unless it's the currently
2892 ;; active minibuffer.
2893 (if (and (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))
2894 (or (not (active-minibuffer-window))
2896 (window-buffer (active-minibuffer-window))))))
2897 (error "Minibuffer is not active for completion")
2898 ;; Insert the completion into the buffer where completion was requested.
2901 (delete-region (+ base-size (point-min)) (point))
2902 (choose-completion-delete-max-match choice))
2904 (remove-text-properties (- (point) (length choice)) (point)
2906 ;; Update point in the window that BUFFER is showing in.
2907 (let ((window (get-buffer-window buffer t)))
2908 (set-window-point window (point)))
2909 ;; If completing for the minibuffer, exit it with this choice.
2910 (and (equal buffer (window-buffer (minibuffer-window)))
2911 minibuffer-completion-table
2912 (exit-minibuffer)))))
2914 (defun completion-list-mode ()
2915 "Major mode for buffers showing lists of possible completions.
2916 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
2917 to select the completion near point.
2918 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
2921 (kill-all-local-variables)
2922 (use-local-map completion-list-mode-map)
2923 (setq mode-name "Completion List")
2924 (setq major-mode 'completion-list-mode)
2925 (make-local-variable 'completion-base-size)
2926 (setq completion-base-size nil)
2927 (run-hooks 'completion-list-mode-hook))
2929 (defvar completion-fixup-function nil
2930 "A function to customize how completions are identified in completion lists.
2931 `completion-setup-function' calls this function with no arguments
2932 each time it has found what it thinks is one completion.
2933 Point is at the end of the completion in the completion list buffer.
2934 If this function moves point, it can alter the end of that completion.")
2936 ;; This function goes in completion-setup-hook, so that it is called
2937 ;; after the text of the completion list buffer is written.
2939 (defun completion-setup-function ()
2941 (let ((mainbuf (current-buffer)))
2942 (set-buffer standard-output)
2943 (completion-list-mode)
2944 (make-local-variable 'completion-reference-buffer)
2945 (setq completion-reference-buffer mainbuf)
2946 ;;; The value 0 is right in most cases, but not for file name completion.
2947 ;;; so this has to be turned off.
2948 ;;; (setq completion-base-size 0)
2949 (goto-char (point-min))
2951 (insert (substitute-command-keys
2952 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
2953 (insert (substitute-command-keys
2954 "In this buffer, type \\[choose-completion] to \
2955 select the completion near point.\n\n"))
2957 (while (re-search-forward "[^ \t\n]+\\( [^ \t\n]+\\)*" nil t)
2958 (let ((beg (match-beginning 0))
2960 (if completion-fixup-function
2961 (funcall completion-fixup-function))
2962 (put-text-property beg (point) 'mouse-face 'highlight)
2963 (goto-char end))))))
2965 (add-hook 'completion-setup-hook 'completion-setup-function)
2967 (define-key minibuffer-local-completion-map [prior]
2968 'switch-to-completions)
2969 (define-key minibuffer-local-must-match-map [prior]
2970 'switch-to-completions)
2971 (define-key minibuffer-local-completion-map "\M-v"
2972 'switch-to-completions)
2973 (define-key minibuffer-local-must-match-map "\M-v"
2974 'switch-to-completions)
2976 (defun switch-to-completions ()
2977 "Select the completion list window."
2979 ;; Make sure we have a completions window.
2980 (or (get-buffer-window "*Completions*")
2981 (minibuffer-completion-help))
2982 (select-window (get-buffer-window "*Completions*"))
2983 (goto-char (point-min))
2984 (search-forward "\n\n")
2987 ;; Support keyboard commands to turn on various modifiers.
2989 ;; These functions -- which are not commands -- each add one modifier
2990 ;; to the following event.
2992 (defun event-apply-alt-modifier (ignore-prompt)
2993 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
2994 (defun event-apply-super-modifier (ignore-prompt)
2995 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
2996 (defun event-apply-hyper-modifier (ignore-prompt)
2997 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
2998 (defun event-apply-shift-modifier (ignore-prompt)
2999 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3000 (defun event-apply-control-modifier (ignore-prompt)
3001 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3002 (defun event-apply-meta-modifier (ignore-prompt)
3003 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3005 (defun event-apply-modifier (event symbol lshiftby prefix)
3006 "Apply a modifier flag to event EVENT.
3007 SYMBOL is the name of this modifier, as a symbol.
3008 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3009 PREFIX is the string that represents this modifier in an event type symbol."
3011 (cond ((eq symbol 'control)
3012 (if (and (<= (downcase event) ?z)
3013 (>= (downcase event) ?a))
3014 (- (downcase event) ?a -1)
3015 (if (and (<= (downcase event) ?Z)
3016 (>= (downcase event) ?A))
3017 (- (downcase event) ?A -1)
3018 (logior (lsh 1 lshiftby) event))))
3020 (if (and (<= (downcase event) ?z)
3021 (>= (downcase event) ?a))
3023 (logior (lsh 1 lshiftby) event)))
3025 (logior (lsh 1 lshiftby) event)))
3026 (if (memq symbol (event-modifiers event))
3028 (let ((event-type (if (symbolp event) event (car event))))
3029 (setq event-type (intern (concat prefix (symbol-name event-type))))
3032 (cons event-type (cdr event)))))))
3034 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3035 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3036 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3037 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3038 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3039 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3041 ;;;; Keypad support.
3043 ;;; Make the keypad keys act like ordinary typing keys. If people add
3044 ;;; bindings for the function key symbols, then those bindings will
3045 ;;; override these, so this shouldn't interfere with any existing
3048 ;; Also tell read-char how to handle these keys.
3050 (lambda (keypad-normal)
3051 (let ((keypad (nth 0 keypad-normal))
3052 (normal (nth 1 keypad-normal)))
3053 (put keypad 'ascii-character normal)
3054 (define-key function-key-map (vector keypad) (vector normal))))
3055 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3056 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3068 ;;; simple.el ends here