1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994 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 open-line (arg)
29 "Insert a newline and leave point before it.
30 If there is a fill prefix, insert the fill prefix on the new line
31 if the line would have been empty.
32 With arg N, insert N newlines."
34 (let* ((do-fill-prefix (and fill-prefix (bolp)))
35 (flag (and (null do-fill-prefix) (bolp) (not (bobp)))))
36 ;; If this is a simple case, and we are at the beginning of a line,
37 ;; actually insert the newline *before* the preceding newline
38 ;; instead of after. That makes better display behavior.
41 ;; If undo is enabled, don't let this hack be visible:
42 ;; record the real value of point as the place to move back to
43 ;; if we undo this insert.
44 (if (not (eq buffer-undo-list t))
45 (setq buffer-undo-list (cons (point) buffer-undo-list)))
49 (if do-fill-prefix (insert fill-prefix))
53 (if flag (forward-char 1))))
56 "Split current line, moving portion beyond point vertically down."
58 (skip-chars-forward " \t")
59 (let ((col (current-column))
65 (defun quoted-insert (arg)
66 "Read next input character and insert it.
67 This is useful for inserting control characters.
68 You may also type up to 3 octal digits, to insert a character with that code.
70 In overwrite mode, this function inserts the character anyway, and
71 does not handle octal digits specially. This means that if you use
72 overwrite as your normal editing mode, you can use this function to
73 insert characters when necessary.
75 In binary overwrite mode, this function does overwrite, and octal
76 digits are interpreted as a character code. This is supposed to make
77 this function useful in editing binary files."
79 (let ((char (if (or (not overwrite-mode)
80 (eq overwrite-mode 'overwrite-mode-binary))
83 (if (eq overwrite-mode 'overwrite-mode-binary)
85 (insert-char char arg)))
87 (defun delete-indentation (&optional arg)
88 "Join this line to previous and fix up whitespace at join.
89 If there is a fill prefix, delete it from the beginning of this line.
90 With argument, join this line to following line."
93 (if arg (forward-line 1))
94 (if (eq (preceding-char) ?\n)
96 (delete-region (point) (1- (point)))
97 ;; If the second line started with the fill prefix,
100 (<= (+ (point) (length fill-prefix)) (point-max))
102 (buffer-substring (point)
103 (+ (point) (length fill-prefix)))))
104 (delete-region (point) (+ (point) (length fill-prefix))))
105 (fixup-whitespace))))
107 (defun fixup-whitespace ()
108 "Fixup white space between objects around point.
109 Leave one space or none, according to the context."
112 (delete-horizontal-space)
113 (if (or (looking-at "^\\|\\s)")
114 (save-excursion (forward-char -1)
115 (looking-at "$\\|\\s(\\|\\s'")))
119 (defun delete-horizontal-space ()
120 "Delete all spaces and tabs around point."
122 (skip-chars-backward " \t")
123 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
125 (defun just-one-space ()
126 "Delete all spaces and tabs around point, leaving one space."
128 (skip-chars-backward " \t")
129 (if (= (following-char) ? )
132 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
134 (defun delete-blank-lines ()
135 "On blank line, delete all surrounding blank lines, leaving just one.
136 On isolated blank line, delete that one.
137 On nonblank line, delete any immediately following blank lines."
139 (let (thisblank singleblank)
142 (setq thisblank (looking-at "[ \t]*$"))
143 ;; Set singleblank if there is just one blank line here.
146 (not (looking-at "[ \t]*\n[ \t]*$"))
148 (progn (forward-line -1)
149 (not (looking-at "[ \t]*$")))))))
150 ;; Delete preceding blank lines, and this one too if it's the only one.
154 (if singleblank (forward-line 1))
155 (delete-region (point)
156 (if (re-search-backward "[^ \t\n]" nil t)
157 (progn (forward-line 1) (point))
159 ;; Delete following blank lines, unless the current line is blank
160 ;; and there are no following blank lines.
161 (if (not (and thisblank singleblank))
165 (delete-region (point)
166 (if (re-search-forward "[^ \t\n]" nil t)
167 (progn (beginning-of-line) (point))
169 ;; Handle the special case where point is followed by newline and eob.
170 ;; Delete the line, leaving point at eob.
171 (if (looking-at "^[ \t]*\n\\'")
172 (delete-region (point) (point-max)))))
174 (defun back-to-indentation ()
175 "Move point to the first non-whitespace character on this line."
177 (beginning-of-line 1)
178 (skip-chars-forward " \t"))
180 (defun newline-and-indent ()
181 "Insert a newline, then indent according to major mode.
182 Indentation is done using the value of `indent-line-function'.
183 In programming language modes, this is the same as TAB.
184 In some text modes, where TAB inserts a tab, this command indents to the
185 column specified by the variable `left-margin'."
187 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
189 (indent-according-to-mode))
191 (defun reindent-then-newline-and-indent ()
192 "Reindent current line, insert newline, then indent the new line.
193 Indentation of both lines is done according to the current major mode,
194 which means calling the current value of `indent-line-function'.
195 In programming language modes, this is the same as TAB.
196 In some text modes, where TAB inserts a tab, this indents to the
197 column specified by the variable `left-margin'."
200 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
201 (indent-according-to-mode))
203 (indent-according-to-mode))
205 ;; Internal subroutine of delete-char
206 (defun kill-forward-chars (arg)
207 (if (listp arg) (setq arg (car arg)))
208 (if (eq arg '-) (setq arg -1))
209 (kill-region (point) (+ (point) arg)))
211 ;; Internal subroutine of backward-delete-char
212 (defun kill-backward-chars (arg)
213 (if (listp arg) (setq arg (car arg)))
214 (if (eq arg '-) (setq arg -1))
215 (kill-region (point) (- (point) arg)))
217 (defun backward-delete-char-untabify (arg &optional killp)
218 "Delete characters backward, changing tabs into spaces.
219 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
220 Interactively, ARG is the prefix arg (default 1)
221 and KILLP is t if prefix arg is was specified."
222 (interactive "*p\nP")
225 (while (and (> count 0) (not (bobp)))
226 (if (= (preceding-char) ?\t)
227 (let ((col (current-column)))
229 (setq col (- col (current-column)))
233 (setq count (1- count)))))
234 (delete-backward-char arg killp)
235 ;; In overwrite mode, back over columns while clearing them out,
236 ;; unless at end of line.
237 (and overwrite-mode (not (eolp))
238 (save-excursion (insert-char ?\ arg))))
240 (defun zap-to-char (arg char)
241 "Kill up to and including ARG'th occurrence of CHAR.
242 Goes backward if ARG is negative; error if CHAR not found."
243 (interactive "p\ncZap to char: ")
244 (kill-region (point) (progn
245 (search-forward (char-to-string char) nil nil arg)
246 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
249 (defun beginning-of-buffer (&optional arg)
250 "Move point to the beginning of the buffer; leave mark at previous position.
251 With arg N, put point N/10 of the way from the true beginning.
253 Don't use this command in Lisp programs!
254 \(goto-char (point-min)) is faster and avoids clobbering the mark."
258 (if (> (buffer-size) 10000)
259 ;; Avoid overflow for large buffer sizes!
260 (* (prefix-numeric-value arg)
261 (/ (buffer-size) 10))
262 (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
264 (if arg (forward-line 1)))
266 (defun end-of-buffer (&optional arg)
267 "Move point to the end of the buffer; leave mark at previous position.
268 With arg N, put point N/10 of the way from the true end.
270 Don't use this command in Lisp programs!
271 \(goto-char (point-max)) is faster and avoids clobbering the mark."
275 (- (1+ (buffer-size))
276 (if (> (buffer-size) 10000)
277 ;; Avoid overflow for large buffer sizes!
278 (* (prefix-numeric-value arg)
279 (/ (buffer-size) 10))
280 (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
282 ;; If we went to a place in the middle of the buffer,
283 ;; adjust it to the beginning of a line.
284 (if arg (forward-line 1)
285 ;; If the end of the buffer is not already on the screen,
286 ;; then scroll specially to put it near, but not at, the bottom.
287 (if (let ((old-point (point)))
289 (goto-char (window-start))
290 (vertical-motion (window-height))
291 (< (point) old-point)))
293 (overlay-recenter (point))
296 (defun mark-whole-buffer ()
297 "Put point at beginning and mark at end of buffer.
298 You probably should not use this function in Lisp programs;
299 it is usually a mistake for a Lisp function to use any subroutine
300 that uses or sets the mark."
303 (push-mark (point-max) nil t)
304 (goto-char (point-min)))
306 (defun count-lines-region (start end)
307 "Print number of lines and characters in the region."
309 (message "Region has %d lines, %d characters"
310 (count-lines start end) (- end start)))
313 "Print the current line number (in the buffer) of point."
320 (1+ (count-lines 1 (point)))))))
322 (defun count-lines (start end)
323 "Return number of lines between START and END.
324 This is usually the number of newlines between them,
325 but can be one more if START is not equal to END
326 and the greater of them is not at the start of a line."
330 (narrow-to-region start end)
331 (goto-char (point-min))
332 (if (eq selective-display t)
334 (while (re-search-forward "[\n\C-m]" nil t 40)
335 (setq done (+ 40 done)))
336 (while (re-search-forward "[\n\C-m]" nil t 1)
337 (setq done (+ 1 done)))
338 (goto-char (point-max))
339 (if (and (/= start end)
343 (- (buffer-size) (forward-line (buffer-size))))))))
345 (defun what-cursor-position ()
346 "Print info on cursor position (on screen and within buffer)."
348 (let* ((char (following-char))
352 (total (buffer-size))
353 (percent (if (> total 50000)
354 ;; Avoid overflow from multiplying by 100!
355 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
356 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
357 (hscroll (if (= (window-hscroll) 0)
359 (format " Hscroll=%d" (window-hscroll))))
360 (col (current-column)))
362 (if (or (/= beg 1) (/= end (1+ total)))
363 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
364 pos total percent beg end col hscroll)
365 (message "point=%d of %d(%d%%) column %d %s"
366 pos total percent col hscroll))
367 (if (or (/= beg 1) (/= end (1+ total)))
368 (message "Char: %s (0%o) point=%d of %d(%d%%) <%d - %d> column %d %s"
369 (single-key-description char) char pos total percent beg end col hscroll)
370 (message "Char: %s (0%o) point=%d of %d(%d%%) column %d %s"
371 (single-key-description char) char pos total percent col hscroll)))))
373 (defun fundamental-mode ()
374 "Major mode not specialized for anything in particular.
375 Other major modes are defined by comparison with this one."
377 (kill-all-local-variables))
379 (defvar read-expression-map (cons 'keymap minibuffer-local-map)
380 "Minibuffer keymap used for reading Lisp expressions.")
381 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
383 (put 'eval-expression 'disabled t)
385 (defvar read-expression-history nil)
387 ;; We define this, rather than making `eval' interactive,
388 ;; for the sake of completion of names like eval-region, eval-current-buffer.
389 (defun eval-expression (expression)
390 "Evaluate EXPRESSION and print value in minibuffer.
391 Value is also consed on to front of the variable `values'."
393 (list (read-from-minibuffer "Eval: "
394 nil read-expression-map t
395 'read-expression-history)))
396 (setq values (cons (eval expression) values))
397 (prin1 (car values) t))
399 (defun edit-and-eval-command (prompt command)
400 "Prompting with PROMPT, let user edit COMMAND and eval result.
401 COMMAND is a Lisp expression. Let user edit that expression in
402 the minibuffer, then read and evaluate the result."
403 (let ((command (read-from-minibuffer prompt
404 (prin1-to-string command)
405 read-expression-map t
406 '(command-history . 1))))
409 (defun repeat-complex-command (arg)
410 "Edit and re-evaluate last complex command, or ARGth from last.
411 A complex command is one which used the minibuffer.
412 The command is placed in the minibuffer as a Lisp form for editing.
413 The result is executed, repeating the command as changed.
414 If the command has been changed or is not the most recent previous command
415 it is added to the front of the command history.
416 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
417 to get different commands to edit and resubmit."
419 (let ((elt (nth (1- arg) command-history))
420 (minibuffer-history-position arg)
421 (minibuffer-history-sexp-flag t)
426 (read-from-minibuffer
427 "Redo: " (prin1-to-string elt) read-expression-map t
428 (cons 'command-history arg)))
430 ;; If command was added to command-history as a string,
431 ;; get rid of that. We want only evallable expressions there.
432 (if (stringp (car command-history))
433 (setq command-history (cdr command-history)))
435 ;; If command to be redone does not match front of history,
436 ;; add it to the history.
437 (or (equal newcmd (car command-history))
438 (setq command-history (cons newcmd command-history)))
442 (defvar minibuffer-history nil
443 "Default minibuffer history list.
444 This is used for all minibuffer input
445 except when an alternate history list is specified.")
446 (defvar minibuffer-history-sexp-flag nil
447 "Non-nil when doing history operations on `command-history'.
448 More generally, indicates that the history list being acted on
449 contains expressions rather than strings.")
450 (setq minibuffer-history-variable 'minibuffer-history)
451 (setq minibuffer-history-position nil)
452 (defvar minibuffer-history-search-history nil)
455 (lambda (key-and-command)
457 (lambda (keymap-and-completionp)
458 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
459 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
460 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
461 (define-key (symbol-value (car keymap-and-completionp))
462 (car key-and-command)
463 (let ((command (cdr key-and-command)))
465 ;; (and ... nil) => ... turns back on the completion-oriented
466 ;; history commands which rms turned off since they seem to
467 ;; do things he doesn't like.
468 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
469 (progn (error "EMACS BUG!") (cdr command))
472 '((minibuffer-local-map . nil)
473 (minibuffer-local-ns-map . nil)
474 (minibuffer-local-completion-map . t)
475 (minibuffer-local-must-match-map . t)
476 (read-expression-map . nil))))
477 '(("\en" . (next-history-element . next-complete-history-element))
478 ([next] . (next-history-element . next-complete-history-element))
479 ("\ep" . (previous-history-element . previous-complete-history-element))
480 ([prior] . (previous-history-element . previous-complete-history-element))
481 ("\er" . previous-matching-history-element)
482 ("\es" . next-matching-history-element)))
484 (defun previous-matching-history-element (regexp n)
485 "Find the previous history element that matches REGEXP.
486 \(Previous history elements refer to earlier actions.)
487 With prefix argument N, search for Nth previous match.
488 If N is negative, find the next or Nth next match."
490 (let* ((enable-recursive-minibuffers t)
491 (minibuffer-history-sexp-flag nil)
492 (regexp (read-from-minibuffer "Previous element matching (regexp): "
496 'minibuffer-history-search-history)))
497 ;; Use the last regexp specified, by default, if input is empty.
498 (list (if (string= regexp "")
499 (setcar minibuffer-history-search-history
500 (nth 1 minibuffer-history-search-history))
502 (prefix-numeric-value current-prefix-arg))))
503 (let ((history (symbol-value minibuffer-history-variable))
505 (pos minibuffer-history-position))
508 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
511 "No later matching history item"
512 "No earlier matching history item")))
513 (if (string-match regexp
514 (if minibuffer-history-sexp-flag
515 (prin1-to-string (nth (1- pos) history))
516 (nth (1- pos) history)))
517 (setq n (+ n (if (< n 0) 1 -1)))))
518 (setq minibuffer-history-position pos)
520 (let ((elt (nth (1- pos) history)))
521 (insert (if minibuffer-history-sexp-flag
522 (prin1-to-string elt)
524 (goto-char (point-min)))
525 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
526 (eq (car (car command-history)) 'next-matching-history-element))
527 (setq command-history (cdr command-history))))
529 (defun next-matching-history-element (regexp n)
530 "Find the next history element that matches REGEXP.
531 \(The next history element refers to a more recent action.)
532 With prefix argument N, search for Nth next match.
533 If N is negative, find the previous or Nth previous match."
535 (let* ((enable-recursive-minibuffers t)
536 (minibuffer-history-sexp-flag nil)
537 (regexp (read-from-minibuffer "Next element matching (regexp): "
541 'minibuffer-history-search-history)))
542 ;; Use the last regexp specified, by default, if input is empty.
543 (list (if (string= regexp "")
544 (setcar minibuffer-history-search-history
545 (nth 1 minibuffer-history-search-history))
547 (prefix-numeric-value current-prefix-arg))))
548 (previous-matching-history-element regexp (- n)))
550 (defun next-history-element (n)
551 "Insert the next element of the minibuffer history into the minibuffer."
553 (let ((narg (min (max 1 (- minibuffer-history-position n))
554 (length (symbol-value minibuffer-history-variable)))))
555 (if (= minibuffer-history-position narg)
556 (error (if (= minibuffer-history-position 1)
557 "End of history; no next item"
558 "Beginning of history; no preceding item"))
560 (setq minibuffer-history-position narg)
561 (let ((elt (nth (1- minibuffer-history-position)
562 (symbol-value minibuffer-history-variable))))
564 (if minibuffer-history-sexp-flag
565 (prin1-to-string elt)
567 (goto-char (point-min)))))
569 (defun previous-history-element (n)
570 "Inserts the previous element of the minibuffer history into the minibuffer."
572 (next-history-element (- n)))
574 (defun next-complete-history-element (n)
575 "Get next element of history which is a completion of minibuffer contents."
577 (let ((point-at-start (point)))
578 (next-matching-history-element
579 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
580 ;; next-matching-history-element always puts us at (point-min).
581 ;; Move to the position we were at before changing the buffer contents.
582 ;; This is still sensical, because the text before point has not changed.
583 (goto-char point-at-start)))
585 (defun previous-complete-history-element (n)
587 Get previous element of history which is a completion of minibuffer contents."
589 (next-complete-history-element (- n)))
591 (defun goto-line (arg)
592 "Goto line ARG, counting from line 1 at beginning of buffer."
593 (interactive "NGoto line: ")
597 (if (eq selective-display t)
598 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
599 (forward-line (1- arg)))))
601 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
602 (define-function 'advertised-undo 'undo)
604 (defun undo (&optional arg)
605 "Undo some previous changes.
606 Repeat this command to undo more changes.
607 A numeric argument serves as a repeat count."
609 ;; If we don't get all the way thru, make last-command indicate that
610 ;; for the following command.
611 (setq this-command t)
612 (let ((modified (buffer-modified-p))
613 (recent-save (recent-auto-save-p)))
614 (or (eq (selected-window) (minibuffer-window))
616 (or (eq last-command 'undo)
619 (undo-more (or arg 1))
620 ;; Don't specify a position in the undo record for the undo command.
621 ;; Instead, undoing this should move point to where the change is.
622 (let ((tail buffer-undo-list)
624 (while (and tail (not done) (not (null (car tail))))
625 (if (integerp (car tail))
628 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
629 (setq tail (cdr tail))))
630 (and modified (not (buffer-modified-p))
631 (delete-auto-save-file-if-necessary recent-save)))
632 ;; If we do get all the way thru, make this-command indicate that.
633 (setq this-command 'undo))
635 (defvar pending-undo-list nil
636 "Within a run of consecutive undo commands, list remaining to be undone.")
639 "Set `pending-undo-list' to the front of the undo list.
640 The next call to `undo-more' will undo the most recently made change."
641 (if (eq buffer-undo-list t)
642 (error "No undo information in this buffer"))
643 (setq pending-undo-list buffer-undo-list))
645 (defun undo-more (count)
646 "Undo back N undo-boundaries beyond what was already undone recently.
647 Call `undo-start' to get ready to undo recent changes,
648 then call `undo-more' one or more times to undo them."
649 (or pending-undo-list
650 (error "No further undo information"))
651 (setq pending-undo-list (primitive-undo count pending-undo-list)))
653 (defvar shell-command-history nil
654 "History list for some commands that read shell commands.")
656 (defun shell-command (command &optional flag)
657 "Execute string COMMAND in inferior shell; display output, if any.
658 If COMMAND ends in ampersand, execute it asynchronously.
660 Optional second arg non-nil (prefix arg, if interactive)
661 means insert output in current buffer after point (leave mark after it).
662 This cannot be done asynchronously."
663 (interactive (list (read-from-minibuffer "Shell command: "
664 nil nil nil 'shell-command-history)
667 (progn (barf-if-buffer-read-only)
669 ;; We do not use -f for csh; we will not support broken use of
670 ;; .cshrcs. Even the BSD csh manual says to use
671 ;; "if ($?prompt) exit" before things which are not useful
672 ;; non-interactively. Besides, if someone wants their other
673 ;; aliases for shell commands then they can still have them.
674 (call-process shell-file-name nil t nil
676 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
677 ;; It is cleaner to avoid activation, even though the command
678 ;; loop would deactivate the mark because we inserted text.
679 (goto-char (prog1 (mark t)
680 (set-marker (mark-marker) (point)
682 ;; Preserve the match data in case called from a program.
683 (let ((data (match-data)))
685 (if (string-match "[ \t]*&[ \t]*$" command)
686 ;; Command ending with ampersand means asynchronous.
687 (let ((buffer (get-buffer-create "*Shell-Command*"))
688 (directory default-directory)
690 ;; Remove the ampersand.
691 (setq command (substring command 0 (match-beginning 0)))
692 ;; If will kill a process, query first.
693 (setq proc (get-buffer-process buffer))
695 (if (yes-or-no-p "A command is running. Kill it? ")
697 (error "Shell command in progress")))
701 (display-buffer buffer)
702 (setq default-directory directory)
703 (setq proc (start-process "Shell" buffer
704 shell-file-name "-c" command))
705 (setq mode-line-process '(":%s"))
706 (set-process-sentinel proc 'shell-command-sentinel)
707 (set-process-filter proc 'shell-command-filter)
709 (shell-command-on-region (point) (point) command nil))
710 (store-match-data data)))))
712 ;; We have a sentinel to prevent insertion of a termination message
713 ;; in the buffer itself.
714 (defun shell-command-sentinel (process signal)
715 (if (and (memq (process-status process) '(exit signal))
716 (buffer-name (process-buffer process)))
719 (car (cdr (cdr (process-command process))))
720 (substring signal 0 -1))
722 (set-buffer (process-buffer process))
723 (setq mode-line-process nil))
724 (delete-process process))))
726 (defun shell-command-filter (proc string)
727 ;; Do save-excursion by hand so that we can leave point numerically unchanged
728 ;; despite an insertion immediately after it.
729 (let* ((obuf (current-buffer))
730 (buffer (process-buffer proc))
732 (window (get-buffer-window buffer))
733 (pos (window-start window)))
737 (or (= (point) (point-max))
738 (setq opoint (point)))
739 (goto-char (point-max))
740 (insert-before-markers string))
741 ;; insert-before-markers moved this marker: set it back.
742 (set-window-start window pos)
743 ;; Finish our save-excursion.
748 (defun shell-command-on-region (start end command &optional flag interactive)
749 "Execute string COMMAND in inferior shell with region as input.
750 Normally display output (if any) in temp buffer `*Shell Command Output*';
751 Prefix arg means replace the region with it.
752 Noninteractive args are START, END, COMMAND, FLAG.
753 Noninteractively FLAG means insert output in place of text from START to END,
754 and put point at the end, but don't alter the mark.
756 If the output is one line, it is displayed in the echo area,
757 but it is nonetheless available in buffer `*Shell Command Output*'
758 even though that buffer is not automatically displayed. If there is no output
759 or output is inserted in the current buffer then `*Shell Command Output*' is
761 (interactive (list (region-beginning) (region-end)
762 (read-from-minibuffer "Shell command on region: "
763 nil nil nil 'shell-command-history)
765 (prefix-numeric-value current-prefix-arg)))
767 ;; Replace specified region with output from command.
768 (let ((swap (and interactive (< (point) (mark)))))
769 ;; Don't muck with mark
770 ;; unless called interactively.
771 (and interactive (push-mark))
772 (call-process-region start end shell-file-name t t nil
774 (if (get-buffer "*Shell Command Output*")
775 (kill-buffer "*Shell Command Output*"))
776 (and interactive swap (exchange-point-and-mark)))
777 ;; No prefix argument: put the output in a temp buffer,
778 ;; replacing its entire contents.
779 (let ((buffer (get-buffer-create "*Shell Command Output*"))
782 (if (eq buffer (current-buffer))
783 ;; If the input is the same buffer as the output,
784 ;; delete everything but the specified region,
785 ;; then replace that region with the output.
786 (progn (delete-region end (point-max))
787 (delete-region (point-min) start)
788 (call-process-region (point-min) (point-max)
789 shell-file-name t t nil
792 ;; Clear the output buffer, then run the command with output there.
796 (call-process-region start end shell-file-name
800 ;; Report the amount of output.
801 (let ((lines (save-excursion
803 (if (= (buffer-size) 0)
805 (count-lines (point-min) (point-max))))))
808 (message "(Shell command completed with no output)"))
809 (kill-buffer buffer))
810 ((and success (= lines 1))
814 (goto-char (point-min))
815 (buffer-substring (point)
816 (progn (end-of-line) (point))))))
818 (set-window-start (display-buffer buffer) 1))))))))
820 (defun universal-argument ()
821 "Begin a numeric argument for the following command.
822 Digits or minus sign following \\[universal-argument] make up the numeric argument.
823 \\[universal-argument] following the digits or minus sign ends the argument.
824 \\[universal-argument] without digits or minus sign provides 4 as argument.
825 Repeating \\[universal-argument] without digits or minus sign
826 multiplies the argument by 4 each time."
830 ;; (describe-arg (list factor) 1)
831 (setq key (read-key-sequence nil t))
832 (while (equal (key-binding key) 'universal-argument)
833 (setq factor (* 4 factor))
834 ;; (describe-arg (list factor) 1)
835 (setq key (read-key-sequence nil t)))
836 (prefix-arg-internal key factor nil)))
838 (defun prefix-arg-internal (key factor value)
840 (if (and (numberp value) (< value 0))
841 (setq sign -1 value (- value)))
843 (setq sign -1 value nil))
844 ;; (describe-arg value sign)
845 (while (equal key "-")
846 (setq sign (- sign) factor nil)
847 ;; (describe-arg value sign)
848 (setq key (read-key-sequence nil t)))
849 (while (and (stringp key)
851 (not (string< key "0"))
852 (not (string< "9" key)))
853 (setq value (+ (* (if (numberp value) value 0) 10)
856 ;; (describe-arg value sign)
857 (setq key (read-key-sequence nil t)))
859 (cond (factor (list factor))
860 ((numberp value) (* value sign))
862 ;; Calling universal-argument after digits
863 ;; terminates the argument but is ignored.
864 (if (eq (key-binding key) 'universal-argument)
866 (describe-arg value sign)
867 (setq key (read-key-sequence nil t))))
868 (setq unread-command-events (listify-key-sequence key))))
870 (defun describe-arg (value sign)
871 (cond ((numberp value)
872 (message "Arg: %d" (* value sign)))
874 (message "Arg: [%d]" (car value)))
876 (message "Arg: -"))))
878 (defun digit-argument (arg)
879 "Part of the numeric argument for the next command.
880 \\[universal-argument] following digits or minus sign ends the argument."
882 (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
885 (defun negative-argument (arg)
886 "Begin a negative numeric argument for the next command.
887 \\[universal-argument] following digits or minus sign ends the argument."
889 (prefix-arg-internal "-" nil arg))
891 (defun forward-to-indentation (arg)
892 "Move forward ARG lines and position at first nonblank character."
895 (skip-chars-forward " \t"))
897 (defun backward-to-indentation (arg)
898 "Move backward ARG lines and position at first nonblank character."
900 (forward-line (- arg))
901 (skip-chars-forward " \t"))
903 (defvar kill-whole-line nil
904 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
906 (defun kill-line (&optional arg)
907 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
908 With prefix argument, kill that many lines from point.
909 Negative arguments kill lines backward.
911 When calling from a program, nil means \"no arg\",
912 a number counts as a prefix arg.
914 If `kill-whole-line' is non-nil, then kill the whole line
915 when given no argument at the beginning of a line."
918 ;; It is better to move point to the other end of the kill
919 ;; before killing. That way, in a read-only buffer, point
920 ;; moves across the text that is copied to the kill ring.
921 ;; The choice has no effect on undo now that undo records
922 ;; the value of point from before the command was run.
925 (forward-line (prefix-numeric-value arg))
927 (signal 'end-of-buffer nil))
928 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
933 ;;;; Window system cut and paste hooks.
935 (defvar interprogram-cut-function nil
936 "Function to call to make a killed region available to other programs.
938 Most window systems provide some sort of facility for cutting and
939 pasting text between the windows of different programs.
940 This variable holds a function that Emacs calls whenever text
941 is put in the kill ring, to make the new kill available to other
944 The function takes one or two arguments.
945 The first argument, TEXT, is a string containing
946 the text which should be made available.
947 The second, PUSH, if non-nil means this is a \"new\" kill;
948 nil means appending to an \"old\" kill.")
950 (defvar interprogram-paste-function nil
951 "Function to call to get text cut from other programs.
953 Most window systems provide some sort of facility for cutting and
954 pasting text between the windows of different programs.
955 This variable holds a function that Emacs calls to obtain
956 text that other programs have provided for pasting.
958 The function should be called with no arguments. If the function
959 returns nil, then no other program has provided such text, and the top
960 of the Emacs kill ring should be used. If the function returns a
961 string, that string should be put in the kill ring as the latest kill.
963 Note that the function should return a string only if a program other
964 than Emacs has provided a string for pasting; if Emacs provided the
965 most recent string, the function should return nil. If it is
966 difficult to tell whether Emacs or some other program provided the
967 current string, it is probably good enough to return nil if the string
968 is equal (according to `string=') to the last text Emacs provided.")
972 ;;;; The kill ring data structure.
974 (defvar kill-ring nil
975 "List of killed text sequences.
976 Since the kill ring is supposed to interact nicely with cut-and-paste
977 facilities offered by window systems, use of this variable should
978 interact nicely with `interprogram-cut-function' and
979 `interprogram-paste-function'. The functions `kill-new',
980 `kill-append', and `current-kill' are supposed to implement this
981 interaction; you may want to use them instead of manipulating the kill
984 (defconst kill-ring-max 30
985 "*Maximum length of kill ring before oldest elements are thrown away.")
987 (defvar kill-ring-yank-pointer nil
988 "The tail of the kill ring whose car is the last thing yanked.")
990 (defun kill-new (string)
991 "Make STRING the latest kill in the kill ring.
992 Set the kill-ring-yank pointer to point to it.
993 If `interprogram-cut-function' is non-nil, apply it to STRING."
994 (setq kill-ring (cons string kill-ring))
995 (if (> (length kill-ring) kill-ring-max)
996 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))
997 (setq kill-ring-yank-pointer kill-ring)
998 (if interprogram-cut-function
999 (funcall interprogram-cut-function string t)))
1001 (defun kill-append (string before-p)
1002 "Append STRING to the end of the latest kill in the kill ring.
1003 If BEFORE-P is non-nil, prepend STRING to the kill.
1004 If `interprogram-cut-function' is set, pass the resulting kill to
1008 (concat string (car kill-ring))
1009 (concat (car kill-ring) string)))
1010 (if interprogram-cut-function
1011 (funcall interprogram-cut-function (car kill-ring))))
1013 (defun current-kill (n &optional do-not-move)
1014 "Rotate the yanking point by N places, and then return that kill.
1015 If N is zero, `interprogram-paste-function' is set, and calling it
1016 returns a string, then that string is added to the front of the
1017 kill ring and returned as the latest kill.
1018 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1019 yanking point; just return the Nth kill forward."
1020 (let ((interprogram-paste (and (= n 0)
1021 interprogram-paste-function
1022 (funcall interprogram-paste-function))))
1023 (if interprogram-paste
1025 ;; Disable the interprogram cut function when we add the new
1026 ;; text to the kill ring, so Emacs doesn't try to own the
1027 ;; selection, with identical text.
1028 (let ((interprogram-cut-function nil))
1029 (kill-new interprogram-paste))
1031 (or kill-ring (error "Kill ring is empty"))
1032 (let ((ARGth-kill-element
1033 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1037 (setq kill-ring-yank-pointer ARGth-kill-element))
1038 (car ARGth-kill-element)))))
1042 ;;;; Commands for manipulating the kill ring.
1044 (defvar kill-read-only-ok nil
1045 "*Non-nil means don't signal an error for killing read-only text.")
1047 (defun kill-region (beg end)
1048 "Kill between point and mark.
1049 The text is deleted but saved in the kill ring.
1050 The command \\[yank] can retrieve it from there.
1051 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1052 If the buffer is read-only, Emacs will beep and refrain from deleting
1053 the text, but put the text in the kill ring anyway. This means that
1054 you can use the killing commands to copy text from a read-only buffer.
1056 This is the primitive for programs to kill text (as opposed to deleting it).
1057 Supply two arguments, character numbers indicating the stretch of text
1059 Any command that calls this function is a \"kill command\".
1060 If the previous command was also a kill command,
1061 the text killed this time appends to the text killed last time
1062 to make one entry in the kill ring."
1066 ;; If the buffer is read-only, we should beep, in case the person
1067 ;; just isn't aware of this. However, there's no harm in putting
1068 ;; the region's text in the kill ring, anyway.
1069 ((or (and buffer-read-only (not inhibit-read-only))
1070 (text-property-not-all beg end 'read-only nil))
1071 (copy-region-as-kill beg end)
1072 ;; This should always barf, and give us the correct error.
1073 (if kill-read-only-ok
1074 (message "Read only text copied to kill ring")
1075 (barf-if-buffer-read-only)))
1077 ;; In certain cases, we can arrange for the undo list and the kill
1078 ;; ring to share the same string object. This code does that.
1079 ((not (or (eq buffer-undo-list t)
1080 (eq last-command 'kill-region)
1082 ;; Don't let the undo list be truncated before we can even access it.
1083 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1084 (old-list buffer-undo-list)
1086 (delete-region beg end)
1087 ;; Search back in buffer-undo-list for this string,
1088 ;; in case a change hook made property changes.
1089 (setq tail buffer-undo-list)
1090 (while (not (stringp (car (car tail))))
1091 (setq tail (cdr tail)))
1092 ;; Take the same string recorded for undo
1093 ;; and put it in the kill-ring.
1094 (kill-new (car (car tail)))
1095 (setq this-command 'kill-region)))
1098 (copy-region-as-kill beg end)
1099 (delete-region beg end))))
1101 (defun copy-region-as-kill (beg end)
1102 "Save the region as if killed, but don't kill it.
1103 If `interprogram-cut-function' is non-nil, also save the text for a window
1104 system cut and paste."
1106 (if (eq last-command 'kill-region)
1107 (kill-append (buffer-substring beg end) (< end beg))
1108 (kill-new (buffer-substring beg end)))
1109 (setq this-command 'kill-region)
1112 (defun kill-ring-save (beg end)
1113 "Save the region as if killed, but don't kill it.
1114 This command is similar to `copy-region-as-kill', except that it gives
1115 visual feedback indicating the extent of the region being copied.
1116 If `interprogram-cut-function' is non-nil, also save the text for a window
1117 system cut and paste."
1119 (copy-region-as-kill beg end)
1121 (let ((other-end (if (= (point) beg) end beg))
1123 ;; Inhibit quitting so we can make a quit here
1124 ;; look like a C-g typed as a command.
1126 (if (pos-visible-in-window-p other-end (selected-window))
1128 ;; Swap point and mark.
1129 (set-marker (mark-marker) (point) (current-buffer))
1130 (goto-char other-end)
1133 (set-marker (mark-marker) other-end (current-buffer))
1135 ;; If user quit, deactivate the mark
1136 ;; as C-g would as a command.
1137 (and quit-flag mark-active
1139 (let* ((killed-text (current-kill 0))
1140 (message-len (min (length killed-text) 40)))
1142 ;; Don't say "killed"; that is misleading.
1143 (message "Saved text until \"%s\""
1144 (substring killed-text (- message-len)))
1145 (message "Saved text from \"%s\""
1146 (substring killed-text 0 message-len))))))))
1148 (defun append-next-kill ()
1149 "Cause following command, if it kills, to append to previous kill."
1153 (setq this-command 'kill-region)
1154 (message "If the next command is a kill, it will append"))
1155 (setq last-command 'kill-region)))
1157 (defun yank-pop (arg)
1158 "Replace just-yanked stretch of killed text with a different stretch.
1159 This command is allowed only immediately after a `yank' or a `yank-pop'.
1160 At such a time, the region contains a stretch of reinserted
1161 previously-killed text. `yank-pop' deletes that text and inserts in its
1162 place a different stretch of killed text.
1164 With no argument, the previous kill is inserted.
1165 With argument N, insert the Nth previous kill.
1166 If N is negative, this is a more recent kill.
1168 The sequence of kills wraps around, so that after the oldest one
1169 comes the newest one."
1171 (if (not (eq last-command 'yank))
1172 (error "Previous command was not a yank"))
1173 (setq this-command 'yank)
1174 (let ((before (< (point) (mark t))))
1175 (delete-region (point) (mark t))
1176 (set-marker (mark-marker) (point) (current-buffer))
1177 (insert (current-kill arg))
1179 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1180 ;; It is cleaner to avoid activation, even though the command
1181 ;; loop would deactivate the mark because we inserted text.
1182 (goto-char (prog1 (mark t)
1183 (set-marker (mark-marker) (point) (current-buffer))))))
1186 (defun yank (&optional arg)
1187 "Reinsert the last stretch of killed text.
1188 More precisely, reinsert the stretch of killed text most recently
1189 killed OR yanked. Put point at end, and set mark at beginning.
1190 With just C-u as argument, same but put point at beginning (and mark at end).
1191 With argument N, reinsert the Nth most recently killed stretch of killed
1193 See also the command \\[yank-pop]."
1195 ;; If we don't get all the way thru, make last-command indicate that
1196 ;; for the following command.
1197 (setq this-command t)
1199 (insert (current-kill (cond
1204 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1205 ;; It is cleaner to avoid activation, even though the command
1206 ;; loop would deactivate the mark because we inserted text.
1207 (goto-char (prog1 (mark t)
1208 (set-marker (mark-marker) (point) (current-buffer)))))
1209 ;; If we do get all the way thru, make this-command indicate that.
1210 (setq this-command 'yank)
1213 (defun rotate-yank-pointer (arg)
1214 "Rotate the yanking point in the kill ring.
1215 With argument, rotate that many kills forward (or backward, if negative)."
1220 (defun insert-buffer (buffer)
1221 "Insert after point the contents of BUFFER.
1222 Puts mark after the inserted text.
1223 BUFFER may be a buffer or a buffer name."
1224 (interactive (list (progn (barf-if-buffer-read-only)
1225 (read-buffer "Insert buffer: " (other-buffer) t))))
1226 (or (bufferp buffer)
1227 (setq buffer (get-buffer buffer)))
1228 (let (start end newmark)
1232 (setq start (point-min) end (point-max)))
1233 (insert-buffer-substring buffer start end)
1234 (setq newmark (point)))
1235 (push-mark newmark))
1238 (defun append-to-buffer (buffer start end)
1239 "Append to specified buffer the text of the region.
1240 It is inserted into that buffer before its point.
1242 When calling from a program, give three arguments:
1243 BUFFER (or buffer name), START and END.
1244 START and END specify the portion of the current buffer to be copied."
1246 (list (read-buffer "Append to buffer: " (other-buffer nil t))
1247 (region-beginning) (region-end)))
1248 (let ((oldbuf (current-buffer)))
1250 (set-buffer (get-buffer-create buffer))
1251 (insert-buffer-substring oldbuf start end))))
1253 (defun prepend-to-buffer (buffer start end)
1254 "Prepend to specified buffer the text of the region.
1255 It is inserted into that buffer after its point.
1257 When calling from a program, give three arguments:
1258 BUFFER (or buffer name), START and END.
1259 START and END specify the portion of the current buffer to be copied."
1260 (interactive "BPrepend to buffer: \nr")
1261 (let ((oldbuf (current-buffer)))
1263 (set-buffer (get-buffer-create buffer))
1265 (insert-buffer-substring oldbuf start end)))))
1267 (defun copy-to-buffer (buffer start end)
1268 "Copy to specified buffer the text of the region.
1269 It is inserted into that buffer, replacing existing text there.
1271 When calling from a program, give three arguments:
1272 BUFFER (or buffer name), START and END.
1273 START and END specify the portion of the current buffer to be copied."
1274 (interactive "BCopy to buffer: \nr")
1275 (let ((oldbuf (current-buffer)))
1277 (set-buffer (get-buffer-create buffer))
1280 (insert-buffer-substring oldbuf start end)))))
1282 (defvar mark-even-if-inactive nil
1283 "*Non-nil means you can use the mark even when inactive.
1284 This option makes a difference in Transient Mark mode.
1285 When the option is non-nil, deactivation of the mark
1286 turns off region highlighting, but commands that use the mark
1287 behave as if the mark were still active.")
1289 (put 'mark-inactive 'error-conditions '(mark-inactive error))
1290 (put 'mark-inactive 'error-message "The mark is not active now")
1292 (defun mark (&optional force)
1293 "Return this buffer's mark value as integer; error if mark inactive.
1294 If optional argument FORCE is non-nil, access the mark value
1295 even if the mark is not currently active, and return nil
1296 if there is no mark at all.
1298 If you are using this in an editing command, you are most likely making
1299 a mistake; see the documentation of `set-mark'."
1300 (if (or force mark-active mark-even-if-inactive)
1301 (marker-position (mark-marker))
1302 (signal 'mark-inactive nil)))
1304 ;; Many places set mark-active directly, and several of them failed to also
1305 ;; run deactivate-mark-hook. This shorthand should simplify.
1306 (defsubst deactivate-mark ()
1307 "Deactivate the mark by setting `mark-active' to nil.
1308 \(That makes a difference only in Transient Mark mode.)
1309 Also runs the hook `deactivate-mark-hook'."
1310 (if transient-mark-mode
1312 (setq mark-active nil)
1313 (run-hooks 'deactivate-mark-hook))))
1315 (defun set-mark (pos)
1316 "Set this buffer's mark to POS. Don't use this function!
1317 That is to say, don't use this function unless you want
1318 the user to see that the mark has moved, and you want the previous
1319 mark position to be lost.
1321 Normally, when a new mark is set, the old one should go on the stack.
1322 This is why most applications should use push-mark, not set-mark.
1324 Novice Emacs Lisp programmers often try to use the mark for the wrong
1325 purposes. The mark saves a location for the user's convenience.
1326 Most editing commands should not alter the mark.
1327 To remember a location for internal use in the Lisp program,
1328 store it in a Lisp variable. Example:
1330 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1334 (setq mark-active t)
1335 (run-hooks 'activate-mark-hook)
1336 (set-marker (mark-marker) pos (current-buffer)))
1338 (set-marker (mark-marker) pos (current-buffer))))
1340 (defvar mark-ring nil
1341 "The list of saved former marks of the current buffer,
1342 most recent first.")
1343 (make-variable-buffer-local 'mark-ring)
1345 (defconst mark-ring-max 16
1346 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1348 (defvar global-mark-ring nil
1349 "The list of saved global marks, most recent first.")
1351 (defconst global-mark-ring-max 16
1352 "*Maximum size of global mark ring. \
1353 Start discarding off end if gets this big.")
1355 (defun set-mark-command (arg)
1356 "Set mark at where point is, or jump to mark.
1357 With no prefix argument, set mark, push old mark position on local mark
1358 ring, and push mark on global mark ring.
1359 With argument, jump to mark, and pop a new position for mark off the ring
1360 \(does not affect global mark ring\).
1362 Novice Emacs Lisp programmers often try to use the mark for the wrong
1363 purposes. See the documentation of `set-mark' for more information."
1367 (push-mark nil nil t))
1369 (error "No mark set in this buffer")
1370 (goto-char (mark t))
1373 (defun push-mark (&optional location nomsg activate)
1374 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1375 If the last global mark pushed was not in the current buffer,
1376 also push LOCATION on the global mark ring.
1377 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1378 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
1380 Novice Emacs Lisp programmers often try to use the mark for the wrong
1381 purposes. See the documentation of `set-mark' for more information.
1383 In Transient Mark mode, this does not activate the mark."
1386 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1387 (if (> (length mark-ring) mark-ring-max)
1389 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1390 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1391 (set-marker (mark-marker) (or location (point)) (current-buffer))
1392 ;; Now push the mark on the global mark ring.
1393 (if (and global-mark-ring
1394 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
1395 ;; The last global mark pushed was in this same buffer.
1396 ;; Don't push another one.
1398 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1399 (if (> (length global-mark-ring) global-mark-ring-max)
1401 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1403 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
1404 (or nomsg executing-macro (> (minibuffer-depth) 0)
1405 (message "Mark set"))
1406 (if (or activate (not transient-mark-mode))
1407 (set-mark (mark t)))
1411 "Pop off mark ring into the buffer's actual mark.
1412 Does not set point. Does nothing if mark ring is empty."
1415 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1416 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1418 (move-marker (car mark-ring) nil)
1419 (if (null (mark t)) (ding))
1420 (setq mark-ring (cdr mark-ring)))))
1422 (define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
1423 (defun exchange-point-and-mark ()
1424 "Put the mark where point is now, and point where the mark is now.
1425 This command works even when the mark is not active,
1426 and it reactivates the mark."
1428 (let ((omark (mark t)))
1430 (error "No mark set in this buffer"))
1435 (defun transient-mark-mode (arg)
1436 "Toggle Transient Mark mode.
1437 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1439 In Transient Mark mode, when the mark is active, the region is highlighted.
1440 Changing the buffer \"deactivates\" the mark.
1441 So do certain other operations that set the mark
1442 but whose main purpose is something else--for example,
1443 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
1445 (setq transient-mark-mode
1447 (not transient-mark-mode)
1448 (> (prefix-numeric-value arg) 0))))
1450 (defun pop-global-mark ()
1451 "Pop off global mark ring and jump to the top location."
1453 ;; Pop entries which refer to non-existent buffers.
1454 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1455 (setq global-mark-ring (cdr global-mark-ring)))
1456 (or global-mark-ring
1457 (error "No global mark set"))
1458 (let* ((marker (car global-mark-ring))
1459 (buffer (marker-buffer marker))
1460 (position (marker-position marker)))
1461 (setq global-mark-ring (cdr global-mark-ring))
1463 (or (and (>= position (point-min))
1464 (<= position (point-max)))
1466 (goto-char position)
1467 (switch-to-buffer buffer)))
1469 (defvar next-line-add-newlines t
1470 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
1472 (defun next-line (arg)
1473 "Move cursor vertically down ARG lines.
1474 If there is no character in the target line exactly under the current column,
1475 the cursor is positioned after the character in that line which spans this
1476 column, or at the end of the line if it is not long enough.
1477 If there is no line in the buffer after this one, behavior depends on the
1478 value of next-line-add-newlines. If non-nil, a newline character is inserted
1479 to create a line and the cursor moves to that line, otherwise the cursor is
1480 moved to the end of the buffer (if already at the end of the buffer, an error
1483 The command \\[set-goal-column] can be used to create
1484 a semipermanent goal column to which this command always moves.
1485 Then it does not try to move vertically. This goal column is stored
1486 in `goal-column', which is nil when there is none.
1488 If you are thinking of using this in a Lisp program, consider
1489 using `forward-line' instead. It is usually easier to use
1490 and more reliable (no dependence on goal column, etc.)."
1492 (if (and next-line-add-newlines (= arg 1))
1493 (let ((opoint (point)))
1502 (defun previous-line (arg)
1503 "Move cursor vertically up ARG lines.
1504 If there is no character in the target line exactly over the current column,
1505 the cursor is positioned after the character in that line which spans this
1506 column, or at the end of the line if it is not long enough.
1508 The command \\[set-goal-column] can be used to create
1509 a semipermanent goal column to which this command always moves.
1510 Then it does not try to move vertically.
1512 If you are thinking of using this in a Lisp program, consider using
1513 `forward-line' with a negative argument instead. It is usually easier
1514 to use and more reliable (no dependence on goal column, etc.)."
1519 (defconst track-eol nil
1520 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1521 This means moving to the end of each line moved onto.
1522 The beginning of a blank line does not count as the end of a line.")
1524 (defvar goal-column nil
1525 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1526 (make-variable-buffer-local 'goal-column)
1528 (defvar temporary-goal-column 0
1529 "Current goal column for vertical motion.
1530 It is the column where point was
1531 at the start of current run of vertical motion commands.
1532 When the `track-eol' feature is doing its job, the value is 9999.")
1534 (defun line-move (arg)
1535 (if (not (or (eq last-command 'next-line)
1536 (eq last-command 'previous-line)))
1537 (setq temporary-goal-column
1538 (if (and track-eol (eolp)
1539 ;; Don't count beg of empty line as end of line
1540 ;; unless we just did explicit end-of-line.
1541 (or (not (bolp)) (eq last-command 'end-of-line)))
1544 (if (not (integerp selective-display))
1546 (progn (if (> arg 1) (forward-line (1- arg)))
1547 ;; This way of moving forward ARG lines
1548 ;; verifies that we have a newline after the last one.
1549 ;; It doesn't get confused by intangible text.
1551 (zerop (forward-line 1)))
1552 (and (zerop (forward-line arg))
1555 'beginning-of-buffer
1558 ;; Move by arg lines, but ignore invisible ones.
1561 (and (zerop (vertical-motion 1))
1562 (signal 'end-of-buffer nil))
1563 (setq arg (1- arg)))
1566 (and (zerop (vertical-motion -1))
1567 (signal 'beginning-of-buffer nil))
1568 (setq arg (1+ arg))))
1569 (move-to-column (or goal-column temporary-goal-column))
1572 ;;; Many people have said they rarely use this feature, and often type
1573 ;;; it by accident. Maybe it shouldn't even be on a key.
1574 (put 'set-goal-column 'disabled t)
1576 (defun set-goal-column (arg)
1577 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1578 Those commands will move to this position in the line moved to
1579 rather than trying to keep the same horizontal position.
1580 With a non-nil argument, clears out the goal column
1581 so that \\[next-line] and \\[previous-line] resume vertical motion.
1582 The goal column is stored in the variable `goal-column'."
1586 (setq goal-column nil)
1587 (message "No goal column"))
1588 (setq goal-column (current-column))
1589 (message (substitute-command-keys
1590 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1594 ;;; Partial support for horizontal autoscrolling. Someday, this feature
1595 ;;; will be built into the C level and all the (hscroll-point-visible) calls
1598 (defvar hscroll-step 0
1599 "*The number of columns to try scrolling a window by when point moves out.
1600 If that fails to bring point back on frame, point is centered instead.
1601 If this is zero, point is always centered after it moves off frame.")
1603 (defun hscroll-point-visible ()
1604 "Scrolls the selected window horizontally to make point visible."
1606 (set-buffer (window-buffer))
1607 (if (not (or truncate-lines
1608 (> (window-hscroll) 0)
1609 (and truncate-partial-width-windows
1610 (< (window-width) (frame-width)))))
1611 ;; Point is always visible when lines are wrapped.
1613 ;; If point is on the invisible part of the line before window-start,
1614 ;; then hscrolling can't bring it back, so reset window-start first.
1615 (and (< (point) (window-start))
1616 (let ((ws-bol (save-excursion
1617 (goto-char (window-start))
1620 (and (>= (point) ws-bol)
1621 (set-window-start nil ws-bol))))
1622 (let* ((here (hscroll-window-column))
1623 (left (min (window-hscroll) 1))
1624 (right (1- (window-width))))
1625 ;; Allow for the truncation glyph, if we're not exactly at eol.
1626 (if (not (and (= here right)
1627 (= (following-char) ?\n)))
1628 (setq right (1- right)))
1630 ;; If too far away, just recenter. But don't show too much
1631 ;; white space off the end of the line.
1632 ((or (< here (- left hscroll-step))
1633 (> here (+ right hscroll-step)))
1634 (let ((eol (save-excursion (end-of-line) (hscroll-window-column))))
1635 (scroll-left (min (- here (/ (window-width) 2))
1636 (- eol (window-width) -5)))))
1637 ;; Within range. Scroll by one step (or maybe not at all).
1639 (scroll-right hscroll-step))
1641 (scroll-left hscroll-step)))))))
1643 ;; This function returns the window's idea of the display column of point,
1644 ;; assuming that the window is already known to be truncated rather than
1645 ;; wrapped, and that we've already handled the case where point is on the
1646 ;; part of the line before window-start. We ignore window-width; if point
1647 ;; is beyond the right margin, we want to know how far. The return value
1648 ;; includes the effects of window-hscroll, window-start, and the prompt
1649 ;; string in the minibuffer. It may be negative due to hscroll.
1650 (defun hscroll-window-column ()
1651 (let* ((hscroll (window-hscroll))
1652 (startpos (save-excursion
1654 (if (= (point) (save-excursion
1655 (goto-char (window-start))
1658 (goto-char (window-start)))
1660 (hpos (+ (if (and (eq (selected-window) (minibuffer-window))
1661 (= 1 (window-start))
1662 (= startpos (point-min)))
1663 (minibuffer-prompt-width)
1665 (min 0 (- 1 hscroll))))
1667 (car (cdr (compute-motion startpos (cons hpos 0)
1669 1000000 (cons hscroll 0) nil)))))
1672 ;; rms: (1) The definitions of arrow keys should not simply restate
1673 ;; what keys they are. The arrow keys should run the ordinary commands.
1674 ;; (2) The arrow keys are just one of many common ways of moving point
1675 ;; within a line. Real horizontal autoscrolling would be a good feature,
1676 ;; but supporting it only for arrow keys is too incomplete to be desirable.
1678 ;;;;; Make arrow keys do the right thing for improved terminal support
1679 ;;;;; When we implement true horizontal autoscrolling, right-arrow and
1680 ;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1681 ;;;;; aliases. These functions are bound to the corresponding keyboard
1682 ;;;;; events in loaddefs.el.
1684 ;;(defun right-arrow (arg)
1685 ;; "Move right one character on the screen (with prefix ARG, that many chars).
1686 ;;Scroll right if needed to keep point horizontally onscreen."
1687 ;; (interactive "P")
1688 ;; (forward-char arg)
1689 ;; (hscroll-point-visible))
1691 ;;(defun left-arrow (arg)
1692 ;; "Move left one character on the screen (with prefix ARG, that many chars).
1693 ;;Scroll left if needed to keep point horizontally onscreen."
1694 ;; (interactive "P")
1695 ;; (backward-char arg)
1696 ;; (hscroll-point-visible))
1698 (defun scroll-other-window-down (lines)
1699 "Scroll the \"other window\" down."
1701 (scroll-other-window
1702 ;; Just invert the argument's meaning.
1703 ;; We can do that without knowing which window it will be.
1704 (if (eq lines '-) nil
1706 (- (prefix-numeric-value lines))))))
1708 (defun beginning-of-buffer-other-window (arg)
1709 "Move point to the beginning of the buffer in the other window.
1710 Leave mark at previous position.
1711 With arg N, put point N/10 of the way from the true beginning."
1713 (let ((orig-window (selected-window))
1714 (window (other-window-for-scrolling)))
1715 ;; We use unwind-protect rather than save-window-excursion
1716 ;; because the latter would preserve the things we want to change.
1719 (select-window window)
1720 ;; Set point and mark in that window's buffer.
1721 (beginning-of-buffer arg)
1722 ;; Set point accordingly.
1724 (select-window orig-window))))
1726 (defun end-of-buffer-other-window (arg)
1727 "Move point to the end of the buffer in the other window.
1728 Leave mark at previous position.
1729 With arg N, put point N/10 of the way from the true end."
1731 ;; See beginning-of-buffer-other-window for comments.
1732 (let ((orig-window (selected-window))
1733 (window (other-window-for-scrolling)))
1736 (select-window window)
1737 (beginning-of-buffer arg)
1739 (select-window orig-window))))
1741 (defun transpose-chars (arg)
1742 "Interchange characters around point, moving forward one character.
1743 With prefix arg ARG, effect is to take character before point
1744 and drag it forward past ARG other characters (backward if ARG negative).
1745 If no argument and at end of line, the previous two chars are exchanged."
1747 (and (null arg) (eolp) (forward-char -1))
1748 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1750 (defun transpose-words (arg)
1751 "Interchange words around point, leaving point at end of them.
1752 With prefix arg ARG, effect is to take word before or around point
1753 and drag it forward past ARG other words (backward if ARG negative).
1754 If ARG is zero, the words around or after point and around or after mark
1757 (transpose-subr 'forward-word arg))
1759 (defun transpose-sexps (arg)
1760 "Like \\[transpose-words] but applies to sexps.
1761 Does not work on a sexp that point is in the middle of
1762 if it is a list or string."
1764 (transpose-subr 'forward-sexp arg))
1766 (defun transpose-lines (arg)
1767 "Exchange current line and previous line, leaving point after both.
1768 With argument ARG, takes previous line and moves it past ARG lines.
1769 With argument 0, interchanges line point is in with line mark is in."
1771 (transpose-subr (function
1775 ;; Move forward over a line,
1776 ;; but create a newline if none exists yet.
1781 (forward-line arg))))
1784 (defun transpose-subr (mover arg)
1785 (let (start1 end1 start2 end2)
1792 (setq start2 (point))
1797 (setq start1 (point))
1799 (exchange-point-and-mark)))
1802 (setq start1 (point))
1808 (setq start2 (point))
1811 (setq arg (1- arg)))
1814 (setq start2 (point))
1816 (setq start1 (point))
1822 (setq arg (1+ arg)))))
1824 (defun transpose-subr-1 ()
1825 (if (> (min end1 end2) (max start1 start2))
1826 (error "Don't have two things to transpose"))
1827 (let ((word1 (buffer-substring start1 end1))
1828 (word2 (buffer-substring start2 end2)))
1829 (delete-region start2 end2)
1832 (goto-char (if (< start1 start2) start1
1833 (+ start1 (- (length word1) (length word2)))))
1834 (delete-char (length word1))
1837 (defconst comment-column 32
1838 "*Column to indent right-margin comments to.
1839 Setting this variable automatically makes it local to the current buffer.
1840 Each mode establishes a different default value for this variable; you
1841 can set the value for a particular mode using that mode's hook.")
1842 (make-variable-buffer-local 'comment-column)
1844 (defconst comment-start nil
1845 "*String to insert to start a new comment, or nil if no comment syntax defined.")
1847 (defconst comment-start-skip nil
1848 "*Regexp to match the start of a comment plus everything up to its body.
1849 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
1850 at the place matched by the close of the first pair.")
1852 (defconst comment-end ""
1853 "*String to insert to end a new comment.
1854 Should be an empty string if comments are terminated by end-of-line.")
1856 (defconst comment-indent-hook nil
1857 "Obsolete variable for function to compute desired indentation for a comment.
1858 This function is called with no args with point at the beginning of
1859 the comment's starting delimiter.")
1861 (defconst comment-indent-function
1862 '(lambda () comment-column)
1863 "Function to compute desired indentation for a comment.
1864 This function is called with no args with point at the beginning of
1865 the comment's starting delimiter.")
1867 (defun indent-for-comment ()
1868 "Indent this line's comment to comment column, or insert an empty comment."
1870 (beginning-of-line 1)
1871 (if (null comment-start)
1872 (error "No comment syntax defined")
1873 (let* ((eolpos (save-excursion (end-of-line) (point)))
1875 (if (re-search-forward comment-start-skip eolpos 'move)
1876 (progn (setq cpos (point-marker))
1877 ;; Find the start of the comment delimiter.
1878 ;; If there were paren-pairs in comment-start-skip,
1879 ;; position at the end of the first pair.
1881 (goto-char (match-end 1))
1882 ;; If comment-start-skip matched a string with
1883 ;; internal whitespace (not final whitespace) then
1884 ;; the delimiter start at the end of that
1885 ;; whitespace. Otherwise, it starts at the
1886 ;; beginning of what was matched.
1887 (skip-syntax-backward " " (match-beginning 0))
1888 (skip-syntax-backward "^ " (match-beginning 0)))))
1889 (setq begpos (point))
1890 ;; Compute desired indent.
1891 (if (= (current-column)
1892 (setq indent (if comment-indent-hook
1893 (funcall comment-indent-hook)
1894 (funcall comment-indent-function))))
1896 ;; If that's different from current, change it.
1897 (skip-chars-backward " \t")
1898 (delete-region (point) begpos)
1900 ;; An existing comment?
1902 (progn (goto-char cpos)
1903 (set-marker cpos nil))
1905 (insert comment-start)
1907 (insert comment-end))))))
1909 (defun set-comment-column (arg)
1910 "Set the comment column based on point.
1911 With no arg, set the comment column to the current column.
1912 With just minus as arg, kill any comment on this line.
1913 With any other arg, set comment column to indentation of the previous comment
1914 and then align or create a comment on this line at that column."
1922 (re-search-backward comment-start-skip)
1924 (re-search-forward comment-start-skip)
1925 (goto-char (match-beginning 0))
1926 (setq comment-column (current-column))
1927 (message "Comment column set to %d" comment-column))
1928 (indent-for-comment))
1929 (setq comment-column (current-column))
1930 (message "Comment column set to %d" comment-column))))
1932 (defun kill-comment (arg)
1933 "Kill the comment on this line, if any.
1934 With argument, kill comments on that many lines starting with this one."
1935 ;; this function loses in a lot of situations. it incorrectly recognises
1936 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
1937 ;; with multi-line comments, can kill extra whitespace if comment wasn't
1938 ;; through end-of-line, et cetera.
1940 (or comment-start-skip (error "No comment syntax defined"))
1941 (let ((count (prefix-numeric-value arg)) endc)
1947 (and (string< "" comment-end)
1950 (re-search-forward (regexp-quote comment-end) endc 'move)
1951 (skip-chars-forward " \t")
1954 (if (re-search-forward comment-start-skip endc t)
1956 (goto-char (match-beginning 0))
1957 (skip-chars-backward " \t")
1958 (kill-region (point) endc)
1959 ;; to catch comments a line beginnings
1960 (indent-according-to-mode))))
1961 (if arg (forward-line 1))
1962 (setq count (1- count)))))
1964 (defun comment-region (beg end &optional arg)
1965 "Comment or uncomment each line in the region.
1966 With just C-u prefix arg, uncomment each line in region.
1967 Numeric prefix arg ARG means use ARG comment characters.
1968 If ARG is negative, delete that many comment characters instead.
1969 Comments are terminated on each line, even for syntax in which newline does
1970 not end the comment. Blank lines do not get comments."
1971 ;; if someone wants it to only put a comment-start at the beginning and
1972 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
1973 ;; is easy enough. No option is made here for other than commenting
1975 (interactive "r\nP")
1976 (or comment-start (error "No comment syntax is defined"))
1977 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
1980 (let ((cs comment-start) (ce comment-end)
1982 (if (consp arg) (setq numarg t)
1983 (setq numarg (prefix-numeric-value arg))
1984 ;; For positive arg > 1, replicate the comment delims now,
1985 ;; then insert the replicated strings just once.
1987 (setq cs (concat cs comment-start)
1988 ce (concat ce comment-end))
1989 (setq numarg (1- numarg))))
1990 ;; Loop over all lines from BEG to END.
1991 (narrow-to-region beg end)
1994 (if (or (eq numarg t) (< numarg 0))
1996 ;; Delete comment start from beginning of line.
1998 (while (looking-at (regexp-quote cs))
1999 (delete-char (length cs)))
2000 (let ((count numarg))
2001 (while (and (> 1 (setq count (1+ count)))
2002 (looking-at (regexp-quote cs)))
2003 (delete-char (length cs)))))
2004 ;; Delete comment end from end of line.
2010 ;; This is questionable if comment-end ends in
2011 ;; whitespace. That is pretty brain-damaged,
2013 (skip-chars-backward " \t")
2014 (if (and (>= (- (point) (point-min)) (length ce))
2016 (backward-char (length ce))
2017 (looking-at (regexp-quote ce))))
2018 (delete-char (- (length ce)))))
2019 (let ((count numarg))
2020 (while (> 1 (setq count (1+ count)))
2022 ;; this is questionable if comment-end ends in whitespace
2023 ;; that is pretty brain-damaged though
2024 (skip-chars-backward " \t")
2026 (backward-char (length ce))
2027 (if (looking-at (regexp-quote ce))
2028 (delete-char (length ce))))))))
2030 ;; Insert at beginning and at end.
2031 (if (looking-at "[ \t]*$") ()
2033 (if (string= "" ce) ()
2036 (search-forward "\n" nil 'move)))))))
2038 (defun backward-word (arg)
2039 "Move backward until encountering the end of a word.
2040 With argument, do this that many times.
2041 In programs, it is faster to call `forward-word' with negative arg."
2043 (forward-word (- arg)))
2045 (defun mark-word (arg)
2046 "Set mark arg words away from point."
2054 (defun kill-word (arg)
2055 "Kill characters forward until encountering the end of a word.
2056 With argument, do this that many times."
2058 (kill-region (point) (progn (forward-word arg) (point))))
2060 (defun backward-kill-word (arg)
2061 "Kill characters backward until encountering the end of a word.
2062 With argument, do this that many times."
2064 (kill-word (- arg)))
2066 (defun current-word (&optional strict)
2067 "Return the word point is on (or a nearby word) as a string.
2068 If optional arg STRICT is non-nil, return nil unless point is within
2069 or adjacent to a word."
2071 (let ((oldpoint (point)) (start (point)) (end (point)))
2072 (skip-syntax-backward "w_") (setq start (point))
2073 (goto-char oldpoint)
2074 (skip-syntax-forward "w_") (setq end (point))
2075 (if (and (eq start oldpoint) (eq end oldpoint))
2076 ;; Point is neither within nor adjacent to a word.
2079 ;; Look for preceding word in same line.
2080 (skip-syntax-backward "^w_"
2081 (save-excursion (beginning-of-line)
2084 ;; No preceding word in same line.
2085 ;; Look for following word in same line.
2087 (skip-syntax-forward "^w_"
2088 (save-excursion (end-of-line)
2090 (setq start (point))
2091 (skip-syntax-forward "w_")
2094 (skip-syntax-backward "w_")
2095 (setq start (point)))
2096 (buffer-substring start end)))
2097 (buffer-substring start end)))))
2099 (defconst fill-prefix nil
2100 "*String for filling to insert at front of new line, or nil for none.
2101 Setting this variable automatically makes it local to the current buffer.")
2102 (make-variable-buffer-local 'fill-prefix)
2104 (defconst auto-fill-inhibit-regexp nil
2105 "*Regexp to match lines which should not be auto-filled.")
2107 (defun do-auto-fill ()
2109 (or (and auto-fill-inhibit-regexp
2110 (save-excursion (beginning-of-line)
2111 (looking-at auto-fill-inhibit-regexp)))
2112 (while (and (not give-up) (> (current-column) fill-column))
2113 ;; Determine where to split the line.
2115 (let ((opoint (point))
2119 (move-to-column (1+ fill-column))
2120 ;; Move back to a word boundary.
2122 ;; If this is after period and a single space,
2123 ;; move back once more--we don't want to break
2124 ;; the line there and make it look like a
2128 sentence-end-double-space
2129 (save-excursion (forward-char -1)
2130 (and (looking-at "\\. ")
2131 (not (looking-at "\\. "))))))
2133 (skip-chars-backward "^ \t\n")
2134 ;; If we find nowhere on the line to break it,
2135 ;; break after one word. Set bounce to t
2136 ;; so we will not keep going in this while loop.
2139 (re-search-forward "[ \t]" opoint t)
2141 (skip-chars-backward " \t"))
2142 ;; Let fill-point be set to the place where we end up.
2144 ;; If that place is not the beginning of the line,
2145 ;; break the line there.
2147 (goto-char fill-point)
2149 (let ((prev-column (current-column)))
2150 ;; If point is at the fill-point, do not `save-excursion'.
2151 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2152 ;; point will end up before it rather than after it.
2154 (skip-chars-backward " \t")
2155 (= (point) fill-point))
2156 (indent-new-comment-line)
2158 (goto-char fill-point)
2159 (indent-new-comment-line)))
2160 ;; If making the new line didn't reduce the hpos of
2161 ;; the end of the line, then give up now;
2162 ;; trying again will not help.
2163 (if (>= (current-column) prev-column)
2165 ;; No place to break => stop trying.
2166 (setq give-up t)))))))
2168 (defun auto-fill-mode (&optional arg)
2169 "Toggle auto-fill mode.
2170 With arg, turn Auto-Fill mode on if and only if arg is positive.
2171 In Auto-Fill mode, inserting a space at a column beyond `fill-column'
2172 automatically breaks the line at a previous space."
2174 (prog1 (setq auto-fill-function
2176 (not auto-fill-function)
2177 (> (prefix-numeric-value arg) 0))
2181 (set-buffer-modified-p (buffer-modified-p))))
2183 ;; This holds a document string used to document auto-fill-mode.
2184 (defun auto-fill-function ()
2185 "Automatically break line at a previous space, in insertion of text."
2188 (defun turn-on-auto-fill ()
2189 "Unconditionally turn on Auto Fill mode."
2192 (defun set-fill-column (arg)
2193 "Set `fill-column' to current column, or to argument if given.
2194 The variable `fill-column' has a separate value for each buffer."
2196 (setq fill-column (if (integerp arg) arg (current-column)))
2197 (message "fill-column set to %d" fill-column))
2199 (defconst comment-multi-line nil
2200 "*Non-nil means \\[indent-new-comment-line] should continue same comment
2201 on new line, with no new terminator or starter.
2202 This is obsolete because you might as well use \\[newline-and-indent].")
2204 (defun indent-new-comment-line ()
2205 "Break line at point and indent, continuing comment if within one.
2206 This indents the body of the continued comment
2207 under the previous comment line.
2209 This command is intended for styles where you write a comment per line,
2210 starting a new comment (and terminating it if necessary) on each line.
2211 If you want to continue one comment across several lines, use \\[newline-and-indent]."
2213 (let (comcol comstart)
2214 (skip-chars-backward " \t")
2215 (delete-region (point)
2216 (progn (skip-chars-forward " \t")
2219 (if (not comment-multi-line)
2221 (if (and comment-start-skip
2222 (let ((opoint (point)))
2224 (re-search-forward comment-start-skip opoint t)))
2225 ;; The old line is a comment.
2226 ;; Set WIN to the pos of the comment-start.
2227 ;; But if the comment is empty, look at preceding lines
2228 ;; to find one that has a nonempty comment.
2229 (let ((win (match-beginning 0)))
2230 (while (and (eolp) (not (bobp))
2233 (setq opoint (point))
2235 (re-search-forward comment-start-skip opoint t)))
2236 (setq win (match-beginning 0)))
2237 ;; Indent this line like what we found.
2239 (setq comcol (current-column))
2240 (setq comstart (buffer-substring (point) (match-end 0)))))))
2242 (let ((comment-column comcol)
2243 (comment-start comstart)
2244 (comment-end comment-end))
2245 (and comment-end (not (equal comment-end ""))
2246 ; (if (not comment-multi-line)
2249 (insert comment-end)
2251 ; (setq comment-column (+ comment-column (length comment-start))
2256 (setq comment-end ""))
2259 (indent-for-comment)
2261 ;; Make sure we delete the newline inserted above.
2265 (insert fill-prefix)
2266 (indent-according-to-mode)))))
2268 (defun set-selective-display (arg)
2269 "Set `selective-display' to ARG; clear it if no arg.
2270 When the value of `selective-display' is a number > 0,
2271 lines whose indentation is >= that value are not displayed.
2272 The variable `selective-display' has a separate value for each buffer."
2274 (if (eq selective-display t)
2275 (error "selective-display already in use for marked lines"))
2278 (narrow-to-region (point-min) (point))
2279 (goto-char (window-start))
2280 (vertical-motion (window-height)))))
2281 (setq selective-display
2282 (and arg (prefix-numeric-value arg)))
2283 (recenter current-vpos))
2284 (set-window-start (selected-window) (window-start (selected-window)))
2285 (princ "selective-display set to " t)
2286 (prin1 selective-display t)
2289 (defconst overwrite-mode-textual " Ovwrt"
2290 "The string displayed in the mode line when in overwrite mode.")
2291 (defconst overwrite-mode-binary " Bin Ovwrt"
2292 "The string displayed in the mode line when in binary overwrite mode.")
2294 (defun overwrite-mode (arg)
2295 "Toggle overwrite mode.
2296 With arg, turn overwrite mode on iff arg is positive.
2297 In overwrite mode, printing characters typed in replace existing text
2298 on a one-for-one basis, rather than pushing it to the right. At the
2299 end of a line, such characters extend the line. Before a tab,
2300 such characters insert until the tab is filled in.
2301 \\[quoted-insert] still inserts characters in overwrite mode; this
2302 is supposed to make it easier to insert characters when necessary."
2304 (setq overwrite-mode
2305 (if (if (null arg) (not overwrite-mode)
2306 (> (prefix-numeric-value arg) 0))
2307 'overwrite-mode-textual))
2308 (force-mode-line-update))
2310 (defun binary-overwrite-mode (arg)
2311 "Toggle binary overwrite mode.
2312 With arg, turn binary overwrite mode on iff arg is positive.
2313 In binary overwrite mode, printing characters typed in replace
2314 existing text. Newlines are not treated specially, so typing at the
2315 end of a line joins the line to the next, with the typed character
2316 between them. Typing before a tab character simply replaces the tab
2317 with the character typed.
2318 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2319 typing characters do.
2321 Note that binary overwrite mode is not its own minor mode; it is a
2322 specialization of overwrite-mode, entered by setting the
2323 `overwrite-mode' variable to `overwrite-mode-binary'."
2325 (setq overwrite-mode
2327 (not (eq overwrite-mode 'overwrite-mode-binary))
2328 (> (prefix-numeric-value arg) 0))
2329 'overwrite-mode-binary))
2330 (force-mode-line-update))
2332 (defvar line-number-mode nil
2333 "*Non-nil means display line number in mode line.")
2335 (defun line-number-mode (arg)
2336 "Toggle Line Number mode.
2337 With arg, turn Line Number mode on iff arg is positive.
2338 When Line Number mode is enabled, the line number appears
2341 (setq line-number-mode
2342 (if (null arg) (not line-number-mode)
2343 (> (prefix-numeric-value arg) 0)))
2344 (force-mode-line-update))
2346 (defvar blink-matching-paren t
2347 "*Non-nil means show matching open-paren when close-paren is inserted.")
2349 (defconst blink-matching-paren-distance 12000
2350 "*If non-nil, is maximum distance to search for matching open-paren.")
2352 (defun blink-matching-open ()
2353 "Move cursor momentarily to the beginning of the sexp before point."
2355 (and (> (point) (1+ (point-min)))
2356 (not (memq (char-syntax (char-after (- (point) 2))) '(?/ ?\\ )))
2357 blink-matching-paren
2358 (let* ((oldpos (point))
2363 (if blink-matching-paren-distance
2364 (narrow-to-region (max (point-min)
2365 (- (point) blink-matching-paren-distance))
2368 (setq blinkpos (scan-sexps oldpos -1))
2370 (and blinkpos (/= (char-syntax (char-after blinkpos))
2373 (/= (char-after (1- oldpos))
2374 (matching-paren (char-after blinkpos)))))
2375 (if mismatch (setq blinkpos nil))
2378 (goto-char blinkpos)
2379 (if (pos-visible-in-window-p)
2381 (goto-char blinkpos)
2384 ;; Show what precedes the open in its line, if anything.
2386 (skip-chars-backward " \t")
2388 (buffer-substring (progn (beginning-of-line) (point))
2390 ;; Show what follows the open in its line, if anything.
2393 (skip-chars-forward " \t")
2395 (buffer-substring blinkpos
2396 (progn (end-of-line) (point)))
2397 ;; Otherwise show the previous nonblank line.
2399 (buffer-substring (progn
2401 (skip-chars-backward "\n \t")
2404 (progn (end-of-line)
2405 (skip-chars-backward " \t")
2407 ;; Replace the newline and other whitespace with `...'.
2409 (buffer-substring blinkpos (1+ blinkpos))))))))
2411 (message "Mismatched parentheses"))
2412 ((not blink-matching-paren-distance)
2413 (message "Unmatched parenthesis"))))))))
2415 ;Turned off because it makes dbx bomb out.
2416 (setq blink-paren-function 'blink-matching-open)
2418 ;; This executes C-g typed while Emacs is waiting for a command.
2419 ;; Quitting out of a program does not go through here;
2420 ;; that happens in the QUIT macro at the C code level.
2421 (defun keyboard-quit ()
2422 "Signal a quit condition.
2423 During execution of Lisp code, this character causes a quit directly.
2424 At top-level, as an editor command, this simply beeps."
2429 (define-key global-map "\C-g" 'keyboard-quit)
2431 (defun set-variable (var val)
2432 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2433 When using this interactively, supply a Lisp expression for VALUE.
2434 If you want VALUE to be a string, you must surround it with doublequotes.
2436 If VARIABLE has a `variable-interactive' property, that is used as if
2437 it were the arg to `interactive' (which see) to interactively read the value."
2439 (let* ((var (read-variable "Set variable: "))
2440 (minibuffer-help-form
2445 (with-output-to-temp-buffer "*Help*"
2447 (princ "\nDocumentation:\n")
2448 (princ (substring (documentation-property var 'variable-documentation)
2451 (let ((print-length 20))
2452 (princ "\n\nCurrent value: ")
2453 (prin1 (symbol-value var))))
2456 (let ((prop (get var 'variable-interactive)))
2458 ;; Use VAR's `variable-interactive' property
2459 ;; as an interactive spec for prompting.
2460 (call-interactively (list 'lambda '(arg)
2461 (list 'interactive prop)
2463 (eval-minibuffer (format "Set %s to value: " var)))))))
2466 ;; Define the major mode for lists of completions.
2468 (defvar completion-list-mode-map nil)
2469 (or completion-list-mode-map
2470 (let ((map (make-sparse-keymap)))
2471 (define-key map [mouse-2] 'mouse-choose-completion)
2472 (define-key map [down-mouse-2] nil)
2473 (define-key map "\C-m" 'choose-completion)
2474 (define-key map [return] 'choose-completion)
2475 (setq completion-list-mode-map map)))
2477 ;; Completion mode is suitable only for specially formatted data.
2478 (put 'completion-list-mode 'mode-class 'special)
2480 ;; Record the buffer that was current when the completion list was requested.
2481 (defvar completion-reference-buffer)
2483 (defun choose-completion ()
2484 "Choose the completion that point is in or next to."
2487 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
2488 (setq end (point) beg (1+ (point))))
2489 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
2490 (setq end (1- (point)) beg(point)))
2492 (error "No completion here"))
2493 (setq beg (previous-single-property-change beg 'mouse-face))
2494 (setq end (next-single-property-change end 'mouse-face))
2495 (choose-completion-string (buffer-substring beg end))))
2497 ;; Delete the longest partial match for STRING
2498 ;; that can be found before POINT.
2499 (defun choose-completion-delete-max-match (string)
2500 (let ((opoint (point))
2501 (len (min (length string)
2502 (- (point) (point-min)))))
2503 (goto-char (- (point) (length string)))
2504 (if completion-ignore-case
2505 (setq string (downcase string)))
2506 (while (and (> len 0)
2507 (let ((tail (buffer-substring (point)
2509 (if completion-ignore-case
2510 (setq tail (downcase tail)))
2511 (not (string= tail (substring string 0 len)))))
2516 (defun choose-completion-string (choice &optional buffer)
2517 (let ((buffer (or buffer completion-reference-buffer)))
2518 ;; If BUFFER is a minibuffer, barf unless it's the currently
2519 ;; active minibuffer.
2520 (if (and (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))
2521 (or (not (minibuffer-window-active-p (minibuffer-window)))
2522 (not (equal buffer (window-buffer (minibuffer-window))))))
2523 (error "Minibuffer is not active for completion")
2524 ;; Insert the completion into the buffer where completion was requested.
2526 (choose-completion-delete-max-match choice)
2528 (remove-text-properties (- (point) (length choice)) (point)
2530 ;; Update point in the window that BUFFER is showing in.
2531 (let ((window (get-buffer-window buffer t)))
2532 (set-window-point window (point)))
2533 ;; If completing for the minibuffer, exit it with this choice.
2534 (and (equal buffer (window-buffer (minibuffer-window)))
2535 (minibuffer-complete-and-exit)))))
2537 (defun completion-list-mode ()
2538 "Major mode for buffers showing lists of possible completions.
2539 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
2540 to select the completion near point.
2541 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
2544 (kill-all-local-variables)
2545 (use-local-map completion-list-mode-map)
2546 (setq mode-name "Completion List")
2547 (setq major-mode 'completion-list-mode)
2548 (run-hooks 'completion-list-mode-hook))
2550 (defvar completion-fixup-function nil)
2552 (defun completion-setup-function ()
2554 (let ((mainbuf (current-buffer)))
2555 (set-buffer standard-output)
2556 (completion-list-mode)
2557 (make-local-variable 'completion-reference-buffer)
2558 (setq completion-reference-buffer mainbuf)
2559 (goto-char (point-min))
2561 (insert (substitute-command-keys
2562 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
2563 (insert (substitute-command-keys
2564 "In this buffer, type \\[choose-completion] to \
2565 select the completion near point.\n\n"))
2567 (while (re-search-forward "[^ \t\n]+\\( [^ \t\n]+\\)*" nil t)
2568 (let ((beg (match-beginning 0))
2570 (if completion-fixup-function
2571 (funcall completion-fixup-function))
2572 (put-text-property beg (point) 'mouse-face 'highlight)
2573 (goto-char end))))))
2575 (add-hook 'completion-setup-hook 'completion-setup-function)
2577 ;;;; Keypad support.
2579 ;;; Make the keypad keys act like ordinary typing keys. If people add
2580 ;;; bindings for the function key symbols, then those bindings will
2581 ;;; override these, so this shouldn't interfere with any existing
2584 ;; Also tell read-char how to handle these keys.
2586 (lambda (keypad-normal)
2587 (let ((keypad (nth 0 keypad-normal))
2588 (normal (nth 1 keypad-normal)))
2589 (put keypad 'ascii-character normal)
2590 (define-key function-key-map (vector keypad) (vector normal))))
2591 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
2592 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
2604 ;;; simple.el ends here