1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993 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 (and buffer-undo-list (not (eq buffer-undo-list t)))
45 (setq buffer-undo-list (cons (point) buffer-undo-list)))
50 (if do-fill-prefix (insert fill-prefix))
52 (if flag (forward-char 1))))
55 "Split current line, moving portion beyond point vertically down."
57 (skip-chars-forward " \t")
58 (let ((col (current-column))
64 (defun quoted-insert (arg)
65 "Read next input character and insert it.
66 This is useful for inserting control characters.
67 You may also type up to 3 octal digits, to insert a character with that code.
69 In overwrite mode, this function inserts the character anyway, and
70 does not handle octal digits specially. This means that if you use
71 overwrite as your normal editing mode, you can use this function to
72 insert characters when necessary.
74 In binary overwrite mode, this function does overwrite, and octal
75 digits are interpreted as a character code. This is supposed to make
76 this function useful in editing binary files."
78 (let ((char (if (or (not overwrite-mode)
79 (eq overwrite-mode 'overwrite-mode-binary))
82 (if (eq overwrite-mode 'overwrite-mode-binary)
84 (insert-char char arg)))
86 (defun delete-indentation (&optional arg)
87 "Join this line to previous and fix up whitespace at join.
88 If there is a fill prefix, delete it from the beginning of this line.
89 With argument, join this line to following line."
92 (if arg (forward-line 1))
93 (if (eq (preceding-char) ?\n)
95 (delete-region (point) (1- (point)))
96 ;; If the second line started with the fill prefix,
99 (<= (+ (point) (length fill-prefix)) (point-max))
101 (buffer-substring (point)
102 (+ (point) (length fill-prefix)))))
103 (delete-region (point) (+ (point) (length fill-prefix))))
104 (fixup-whitespace))))
106 (defun fixup-whitespace ()
107 "Fixup white space between objects around point.
108 Leave one space or none, according to the context."
111 (delete-horizontal-space)
112 (if (or (looking-at "^\\|\\s)")
113 (save-excursion (forward-char -1)
114 (looking-at "$\\|\\s(\\|\\s'")))
118 (defun delete-horizontal-space ()
119 "Delete all spaces and tabs around point."
121 (skip-chars-backward " \t")
122 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
124 (defun just-one-space ()
125 "Delete all spaces and tabs around point, leaving one space."
127 (skip-chars-backward " \t")
128 (if (= (following-char) ? )
131 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
133 (defun delete-blank-lines ()
134 "On blank line, delete all surrounding blank lines, leaving just one.
135 On isolated blank line, delete that one.
136 On nonblank line, delete all blank lines that follow it."
138 (let (thisblank singleblank)
141 (setq thisblank (looking-at "[ \t]*$"))
142 ;; Set singleblank if there is just one blank line here.
145 (not (looking-at "[ \t]*\n[ \t]*$"))
147 (progn (forward-line -1)
148 (not (looking-at "[ \t]*$")))))))
149 ;; Delete preceding blank lines, and this one too if it's the only one.
153 (if singleblank (forward-line 1))
154 (delete-region (point)
155 (if (re-search-backward "[^ \t\n]" nil t)
156 (progn (forward-line 1) (point))
158 ;; Delete following blank lines, unless the current line is blank
159 ;; and there are no following blank lines.
160 (if (not (and thisblank singleblank))
164 (delete-region (point)
165 (if (re-search-forward "[^ \t\n]" nil t)
166 (progn (beginning-of-line) (point))
168 ;; Handle the special case where point is followed by newline and eob.
169 ;; Delete the line, leaving point at eob.
170 (if (looking-at "^[ \t]*\n\\'")
171 (delete-region (point) (point-max)))))
173 (defun back-to-indentation ()
174 "Move point to the first non-whitespace character on this line."
176 (beginning-of-line 1)
177 (skip-chars-forward " \t"))
179 (defun newline-and-indent ()
180 "Insert a newline, then indent according to major mode.
181 Indentation is done using the value of `indent-line-function'.
182 In programming language modes, this is the same as TAB.
183 In some text modes, where TAB inserts a tab, this command indents to the
184 column specified by the variable `left-margin'."
186 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
188 (indent-according-to-mode))
190 (defun reindent-then-newline-and-indent ()
191 "Reindent current line, insert newline, then indent the new line.
192 Indentation of both lines is done according to the current major mode,
193 which means calling the current value of `indent-line-function'.
194 In programming language modes, this is the same as TAB.
195 In some text modes, where TAB inserts a tab, this indents to the
196 column specified by the variable `left-margin'."
199 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
200 (indent-according-to-mode))
202 (indent-according-to-mode))
204 ;; Internal subroutine of delete-char
205 (defun kill-forward-chars (arg)
206 (if (listp arg) (setq arg (car arg)))
207 (if (eq arg '-) (setq arg -1))
208 (kill-region (point) (+ (point) arg)))
210 ;; Internal subroutine of backward-delete-char
211 (defun kill-backward-chars (arg)
212 (if (listp arg) (setq arg (car arg)))
213 (if (eq arg '-) (setq arg -1))
214 (kill-region (point) (- (point) arg)))
216 (defun backward-delete-char-untabify (arg &optional killp)
217 "Delete characters backward, changing tabs into spaces.
218 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
219 Interactively, ARG is the prefix arg (default 1)
220 and KILLP is t if prefix arg is was specified."
221 (interactive "*p\nP")
224 (while (and (> count 0) (not (bobp)))
225 (if (= (preceding-char) ?\t)
226 (let ((col (current-column)))
228 (setq col (- col (current-column)))
232 (setq count (1- count)))))
233 (delete-backward-char arg killp)
234 ;; In overwrite mode, back over columns while clearing them out,
235 ;; unless at end of line.
236 (and overwrite-mode (not (eolp))
237 (save-excursion (insert-char ?\ arg))))
239 (defun zap-to-char (arg char)
240 "Kill up to and including ARG'th occurrence of CHAR.
241 Goes backward if ARG is negative; error if CHAR not found."
242 (interactive "p\ncZap to char: ")
243 (kill-region (point) (progn
244 (search-forward (char-to-string char) nil nil arg)
245 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
248 (defun beginning-of-buffer (&optional arg)
249 "Move point to the beginning of the buffer; leave mark at previous position.
250 With arg N, put point N/10 of the way from the true beginning.
252 Don't use this command in Lisp programs!
253 \(goto-char (point-min)) is faster and avoids clobbering the mark."
257 (if (> (buffer-size) 10000)
258 ;; Avoid overflow for large buffer sizes!
259 (* (prefix-numeric-value arg)
260 (/ (buffer-size) 10))
261 (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
263 (if arg (forward-line 1)))
265 (defun end-of-buffer (&optional arg)
266 "Move point to the end of the buffer; leave mark at previous position.
267 With arg N, put point N/10 of the way from the true end.
269 Don't use this command in Lisp programs!
270 \(goto-char (point-max)) is faster and avoids clobbering the mark."
274 (- (1+ (buffer-size))
275 (if (> (buffer-size) 10000)
276 ;; Avoid overflow for large buffer sizes!
277 (* (prefix-numeric-value arg)
278 (/ (buffer-size) 10))
279 (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
281 ;; If we went to a place in the middle of the buffer,
282 ;; adjust it to the beginning of a line.
283 (if arg (forward-line 1)
284 ;; If the end of the buffer is not already on the screen,
285 ;; then scroll specially to put it near, but not at, the bottom.
286 (if (let ((old-point (point)))
288 (goto-char (window-start))
289 (vertical-motion (window-height))
290 (< (point) old-point)))
293 (defun mark-whole-buffer ()
294 "Put point at beginning and mark at end of buffer.
295 You probably should not use this function in Lisp programs;
296 it is usually a mistake for a Lisp function to use any subroutine
297 that uses or sets the mark."
300 (push-mark (point-max))
301 (goto-char (point-min)))
303 (defun count-lines-region (start end)
304 "Print number of lines and charcters in the region."
306 (message "Region has %d lines, %d characters"
307 (count-lines start end) (- end start)))
310 "Print the current line number (in the buffer) of point."
317 (1+ (count-lines 1 (point)))))))
319 (defun count-lines (start end)
320 "Return number of lines between START and END.
321 This is usually the number of newlines between them,
322 but can be one more if START is not equal to END
323 and the greater of them is not at the start of a line."
327 (narrow-to-region start end)
328 (goto-char (point-min))
329 (if (eq selective-display t)
331 (while (re-search-forward "[\n\C-m]" nil t 40)
332 (setq done (+ 40 done)))
333 (while (re-search-forward "[\n\C-m]" nil t 1)
334 (setq done (+ 1 done)))
336 (- (buffer-size) (forward-line (buffer-size))))))))
338 (defun what-cursor-position ()
339 "Print info on cursor position (on screen and within buffer)."
341 (let* ((char (following-char))
345 (total (buffer-size))
346 (percent (if (> total 50000)
347 ;; Avoid overflow from multiplying by 100!
348 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
349 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
350 (hscroll (if (= (window-hscroll) 0)
352 (format " Hscroll=%d" (window-hscroll))))
353 (col (current-column)))
355 (if (or (/= beg 1) (/= end (1+ total)))
356 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
357 pos total percent beg end col hscroll)
358 (message "point=%d of %d(%d%%) column %d %s"
359 pos total percent col hscroll))
360 (if (or (/= beg 1) (/= end (1+ total)))
361 (message "Char: %s (0%o) point=%d of %d(%d%%) <%d - %d> column %d %s"
362 (single-key-description char) char pos total percent beg end col hscroll)
363 (message "Char: %s (0%o) point=%d of %d(%d%%) column %d %s"
364 (single-key-description char) char pos total percent col hscroll)))))
366 (defun fundamental-mode ()
367 "Major mode not specialized for anything in particular.
368 Other major modes are defined by comparison with this one."
370 (kill-all-local-variables))
372 (defvar read-expression-map (copy-keymap minibuffer-local-map)
373 "Minibuffer keymap used for reading Lisp expressions.")
374 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
376 (put 'eval-expression 'disabled t)
378 ;; We define this, rather than making eval interactive,
379 ;; for the sake of completion of names like eval-region, eval-current-buffer.
380 (defun eval-expression (expression)
381 "Evaluate EXPRESSION and print value in minibuffer.
382 Value is also consed on to front of the variable `values'."
383 (interactive (list (read-from-minibuffer "Eval: "
384 nil read-expression-map t)))
385 (setq values (cons (eval expression) values))
386 (prin1 (car values) t))
388 (defun edit-and-eval-command (prompt command)
389 "Prompting with PROMPT, let user edit COMMAND and eval result.
390 COMMAND is a Lisp expression. Let user edit that expression in
391 the minibuffer, then read and evaluate the result."
392 (let ((command (read-from-minibuffer prompt
393 (prin1-to-string command)
394 read-expression-map t)))
395 ;; Add edited command to command history, unless redundant.
396 (or (equal command (car command-history))
397 (setq command-history (cons command command-history)))
400 (defun repeat-complex-command (arg)
401 "Edit and re-evaluate last complex command, or ARGth from last.
402 A complex command is one which used the minibuffer.
403 The command is placed in the minibuffer as a Lisp form for editing.
404 The result is executed, repeating the command as changed.
405 If the command has been changed or is not the most recent previous command
406 it is added to the front of the command history.
407 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
408 to get different commands to edit and resubmit."
410 (let ((elt (nth (1- arg) command-history))
411 (minibuffer-history-position arg)
412 (minibuffer-history-sexp-flag t)
416 (setq newcmd (read-from-minibuffer "Redo: "
417 (prin1-to-string elt)
420 (cons 'command-history
422 ;; If command was added to command-history as a string,
423 ;; get rid of that. We want only evallable expressions there.
424 (if (stringp (car command-history))
425 (setq command-history (cdr command-history)))
426 ;; If command to be redone does not match front of history,
427 ;; add it to the history.
428 (or (equal newcmd (car command-history))
429 (setq command-history (cons newcmd command-history)))
433 (defvar minibuffer-history nil
434 "Default minibuffer history list.
435 This is used for all minibuffer input
436 except when an alternate history list is specified.")
437 (defvar minibuffer-history-sexp-flag nil
438 "Nonzero when doing history operations on `command-history'.
439 More generally, indicates that the history list being acted on
440 contains expressions rather than strings.")
441 (setq minibuffer-history-variable 'minibuffer-history)
442 (setq minibuffer-history-position nil)
443 (defvar minibuffer-history-search-history nil)
446 (lambda (key-and-command)
448 (lambda (keymap-and-completionp)
449 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
450 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
451 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
452 (define-key (symbol-value (car keymap-and-completionp))
453 (car key-and-command)
454 (let ((command (cdr key-and-command)))
456 ;; (and ... nil) => ... turns back on the completion-oriented
457 ;; history commands which rms turned off since they seem to
458 ;; do things he doesn't like.
459 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
460 (progn (error "EMACS BUG!") (cdr command))
463 '((minibuffer-local-map . nil)
464 (minibuffer-local-ns-map . nil)
465 (minibuffer-local-completion-map . t)
466 (minibuffer-local-must-match-map . t)
467 (read-expression-map . nil))))
468 '(("\en" . (next-history-element . next-complete-history-element))
469 ([next] . (next-history-element . next-complete-history-element))
470 ("\ep" . (previous-history-element . previous-complete-history-element))
471 ([prior] . (previous-history-element . previous-complete-history-element))
472 ("\er" . previous-matching-history-element)
473 ("\es" . next-matching-history-element)))
475 (defun previous-matching-history-element (regexp n)
476 "Find the previous history element that matches REGEXP.
477 \(Previous history elements refer to earlier actions.)
478 With prefix argument N, search for Nth previous match.
479 If N is negative, find the next or Nth next match."
481 (let ((enable-recursive-minibuffers t)
482 (minibuffer-history-sexp-flag nil))
483 (list (read-from-minibuffer "Previous element matching (regexp): "
487 'minibuffer-history-search-history)
488 (prefix-numeric-value current-prefix-arg))))
489 (let ((history (symbol-value minibuffer-history-variable))
491 (pos minibuffer-history-position))
494 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
497 "No later matching history item"
498 "No earlier matching history item")))
499 (if (string-match regexp
500 (if minibuffer-history-sexp-flag
501 (prin1-to-string (nth (1- pos) history))
502 (nth (1- pos) history)))
503 (setq n (+ n (if (< n 0) 1 -1)))))
504 (setq minibuffer-history-position pos)
506 (let ((elt (nth (1- pos) history)))
507 (insert (if minibuffer-history-sexp-flag
508 (prin1-to-string elt)
510 (goto-char (point-min)))
511 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
512 (eq (car (car command-history)) 'next-matching-history-element))
513 (setq command-history (cdr command-history))))
515 (defun next-matching-history-element (regexp n)
516 "Find the next history element that matches REGEXP.
517 \(The next history element refers to a more recent action.)
518 With prefix argument N, search for Nth next match.
519 If N is negative, find the previous or Nth previous match."
521 (let ((enable-recursive-minibuffers t)
522 (minibuffer-history-sexp-flag nil))
523 (list (read-from-minibuffer "Next element matching (regexp): "
527 'minibuffer-history-search-history)
528 (prefix-numeric-value current-prefix-arg))))
529 (previous-matching-history-element regexp (- n)))
531 (defun next-history-element (n)
532 "Insert the next element of the minibuffer history into the minibuffer."
534 (let ((narg (min (max 1 (- minibuffer-history-position n))
535 (length (symbol-value minibuffer-history-variable)))))
536 (if (= minibuffer-history-position narg)
537 (error (if (= minibuffer-history-position 1)
538 "End of history; no next item"
539 "Beginning of history; no preceding item"))
541 (setq minibuffer-history-position narg)
542 (let ((elt (nth (1- minibuffer-history-position)
543 (symbol-value minibuffer-history-variable))))
545 (if minibuffer-history-sexp-flag
546 (prin1-to-string elt)
548 (goto-char (point-min)))))
550 (defun previous-history-element (n)
551 "Inserts the previous element of the minibuffer history into the minibuffer."
553 (next-history-element (- n)))
555 (defun next-complete-history-element (n)
557 Get previous element of history which is a completion of minibuffer contents."
559 (let ((point-at-start (point)))
560 (next-matching-history-element
561 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
562 ;; next-matching-history-element always puts us at (point-min).
563 ;; Move to the position we were at before changing the buffer contents.
564 ;; This is still sensical, because the text before point has not changed.
565 (goto-char point-at-start)))
567 (defun previous-complete-history-element (n)
568 "Get next element of history which is a completion of minibuffer contents."
570 (next-complete-history-element (- n)))
572 (defun goto-line (arg)
573 "Goto line ARG, counting from line 1 at beginning of buffer."
574 (interactive "NGoto line: ")
578 (if (eq selective-display t)
579 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
580 (forward-line (1- arg)))))
582 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
583 (fset 'advertised-undo 'undo)
585 (defun undo (&optional arg)
586 "Undo some previous changes.
587 Repeat this command to undo more changes.
588 A numeric argument serves as a repeat count."
590 (let ((modified (buffer-modified-p)))
591 (or (eq (selected-window) (minibuffer-window))
593 (or (eq last-command 'undo)
596 (setq this-command 'undo)
597 (undo-more (or arg 1))
598 (and modified (not (buffer-modified-p))
599 (delete-auto-save-file-if-necessary))))
602 "Set `pending-undo-list' to the front of the undo list.
603 The next call to `undo-more' will undo the most recently made change."
604 (if (eq buffer-undo-list t)
605 (error "No undo information in this buffer"))
606 (setq pending-undo-list buffer-undo-list))
608 (defun undo-more (count)
609 "Undo back N undo-boundaries beyond what was already undone recently.
610 Call `undo-start' to get ready to undo recent changes,
611 then call `undo-more' one or more times to undo them."
612 (or pending-undo-list
613 (error "No further undo information"))
614 (setq pending-undo-list (primitive-undo count pending-undo-list)))
616 (defvar last-shell-command "")
617 (defvar last-shell-command-on-region "")
619 (defun shell-command (command &optional flag)
620 "Execute string COMMAND in inferior shell; display output, if any.
621 If COMMAND ends in ampersand, execute it asynchronously.
623 Optional second arg non-nil (prefix arg, if interactive)
624 means insert output in current buffer after point (leave mark after it).
625 This cannot be done asynchronously."
626 (interactive (list (read-string "Shell command: " last-shell-command)
629 (progn (barf-if-buffer-read-only)
631 ;; We do not use -f for csh; we will not support broken use of
632 ;; .cshrcs. Even the BSD csh manual says to use
633 ;; "if ($?prompt) exit" before things which are not useful
634 ;; non-interactively. Besides, if someone wants their other
635 ;; aliases for shell commands then they can still have them.
636 (call-process shell-file-name nil t nil
638 (exchange-point-and-mark))
639 ;; Preserve the match data in case called from a program.
640 (let ((data (match-data)))
642 (if (string-match "[ \t]*&[ \t]*$" command)
643 ;; Command ending with ampersand means asynchronous.
644 (let ((buffer (get-buffer-create "*shell-command*"))
645 (directory default-directory)
647 ;; Remove the ampersand.
648 (setq command (substring command 0 (match-beginning 0)))
649 ;; If will kill a process, query first.
650 (setq proc (get-buffer-process buffer))
652 (if (yes-or-no-p "A command is running. Kill it? ")
654 (error "Shell command in progress")))
658 (display-buffer buffer)
659 (setq default-directory directory)
660 (setq proc (start-process "Shell" buffer
661 shell-file-name "-c" command))
662 (setq mode-line-process '(": %s"))
663 (set-process-sentinel proc 'shell-command-sentinel)
664 (set-process-filter proc 'shell-command-filter)
666 (shell-command-on-region (point) (point) command nil))
667 (store-match-data data)))))
669 ;; We have a sentinel to prevent insertion of a termination message
670 ;; in the buffer itself.
671 (defun shell-command-sentinel (process signal)
672 (if (memq (process-status process) '(exit signal))
675 (car (cdr (cdr (process-command process))))
676 (substring signal 0 -1))
678 (set-buffer (process-buffer process))
679 (setq mode-line-process nil))
680 (delete-process process))))
682 (defun shell-command-filter (proc string)
683 ;; Do save-excursion by hand so that we can leave point numerically unchanged
684 ;; despite an insertion immediately after it.
685 (let* ((obuf (current-buffer))
686 (buffer (process-buffer proc))
688 (window (get-buffer-window buffer))
689 (pos (window-start window)))
693 (setq opoint (point))
694 (goto-char (point-max))
695 (insert-before-markers string))
696 ;; insert-before-markers moved this marker: set it back.
697 (set-window-start window pos)
698 ;; Finish our save-excursion.
702 (defun shell-command-on-region (start end command &optional flag interactive)
703 "Execute string COMMAND in inferior shell with region as input.
704 Normally display output (if any) in temp buffer `*Shell Command Output*';
705 Prefix arg means replace the region with it.
706 Noninteractive args are START, END, COMMAND, FLAG.
707 Noninteractively FLAG means insert output in place of text from START to END,
708 and put point at the end, but don't alter the mark.
710 If the output is one line, it is displayed in the echo area,
711 but it is nonetheless available in buffer `*Shell Command Output*'
712 even though that buffer is not automatically displayed. If there is no output
713 or output is inserted in the current buffer then `*Shell Command Output*' is
715 (interactive (list (region-beginning) (region-end)
716 (read-string "Shell command on region: "
717 last-shell-command-on-region)
719 (prefix-numeric-value current-prefix-arg)))
721 ;; Replace specified region with output from command.
722 (let ((swap (and interactive (< (point) (mark)))))
723 ;; Don't muck with mark
724 ;; unless called interactively.
725 (and interactive (push-mark))
726 (call-process-region start end shell-file-name t t nil
728 (if (get-buffer "*Shell Command Output*")
729 (kill-buffer "*Shell Command Output*"))
730 (and interactive swap (exchange-point-and-mark)))
731 ;; No prefix argument: put the output in a temp buffer,
732 ;; replacing its entire contents.
733 (let ((buffer (get-buffer-create "*Shell Command Output*")))
734 (if (eq buffer (current-buffer))
735 ;; If the input is the same buffer as the output,
736 ;; delete everything but the specified region,
737 ;; then replace that region with the output.
738 (progn (delete-region end (point-max))
739 (delete-region (point-min) start)
740 (call-process-region (point-min) (point-max)
741 shell-file-name t t nil
743 ;; Clear the output buffer, then run the command with output there.
747 (call-process-region start end shell-file-name
750 ;; Report the amount of output.
751 (let ((lines (save-excursion
753 (if (= (buffer-size) 0)
755 (count-lines (point-min) (point-max))))))
757 (message "(Shell command completed with no output)")
758 (kill-buffer "*Shell Command Output*"))
763 (goto-char (point-min))
764 (buffer-substring (point)
765 (progn (end-of-line) (point))))))
767 (set-window-start (display-buffer buffer) 1)))))))
769 (defun universal-argument ()
770 "Begin a numeric argument for the following command.
771 Digits or minus sign following \\[universal-argument] make up the numeric argument.
772 \\[universal-argument] following the digits or minus sign ends the argument.
773 \\[universal-argument] without digits or minus sign provides 4 as argument.
774 Repeating \\[universal-argument] without digits or minus sign
775 multiplies the argument by 4 each time."
779 ;; (describe-arg (list factor) 1)
780 (setq key (read-key-sequence nil t))
781 (while (equal (key-binding key) 'universal-argument)
782 (setq factor (* 4 factor))
783 ;; (describe-arg (list factor) 1)
784 (setq key (read-key-sequence nil t)))
785 (prefix-arg-internal key factor nil)))
787 (defun prefix-arg-internal (key factor value)
789 (if (and (numberp value) (< value 0))
790 (setq sign -1 value (- value)))
792 (setq sign -1 value nil))
793 ;; (describe-arg value sign)
794 (while (equal key "-")
795 (setq sign (- sign) factor nil)
796 ;; (describe-arg value sign)
797 (setq key (read-key-sequence nil t)))
798 (while (and (stringp key)
800 (not (string< key "0"))
801 (not (string< "9" key)))
802 (setq value (+ (* (if (numberp value) value 0) 10)
805 ;; (describe-arg value sign)
806 (setq key (read-key-sequence nil t)))
808 (cond (factor (list factor))
809 ((numberp value) (* value sign))
811 ;; Calling universal-argument after digits
812 ;; terminates the argument but is ignored.
813 (if (eq (key-binding key) 'universal-argument)
815 (describe-arg value sign)
816 (setq key (read-key-sequence nil t))))
817 (setq unread-command-events (listify-key-sequence key))))
819 (defun describe-arg (value sign)
820 (cond ((numberp value)
821 (message "Arg: %d" (* value sign)))
823 (message "Arg: [%d]" (car value)))
825 (message "Arg: -"))))
827 (defun digit-argument (arg)
828 "Part of the numeric argument for the next command.
829 \\[universal-argument] following digits or minus sign ends the argument."
831 (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
834 (defun negative-argument (arg)
835 "Begin a negative numeric argument for the next command.
836 \\[universal-argument] following digits or minus sign ends the argument."
838 (prefix-arg-internal "-" nil arg))
840 (defun forward-to-indentation (arg)
841 "Move forward ARG lines and position at first nonblank character."
844 (skip-chars-forward " \t"))
846 (defun backward-to-indentation (arg)
847 "Move backward ARG lines and position at first nonblank character."
849 (forward-line (- arg))
850 (skip-chars-forward " \t"))
852 (defun kill-line (&optional arg)
853 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
854 With prefix argument, kill that many lines from point.
855 Negative arguments kill lines backward.
857 When calling from a program, nil means \"no arg\",
858 a number counts as a prefix arg."
861 ;; Don't shift point before doing the delete; that way,
862 ;; undo will record the right position of point.
865 (forward-line (prefix-numeric-value arg))
867 (signal 'end-of-buffer nil))
868 (if (looking-at "[ \t]*$")
873 ;;;; Window system cut and paste hooks.
875 (defvar interprogram-cut-function nil
876 "Function to call to make a killed region available to other programs.
878 Most window systems provide some sort of facility for cutting and
879 pasting text between the windows of different programs. On startup,
880 this variable is set to a function which emacs will call whenever text
881 is put in the kill ring to make the new kill available to other
884 The function takes one argument, TEXT, which is a string containing
885 the text which should be made available.")
887 (defvar interprogram-paste-function nil
888 "Function to call to get text cut from other programs.
890 Most window systems provide some sort of facility for cutting and
891 pasting text between the windows of different programs. On startup,
892 this variable is set to a function which emacs will call to obtain
893 text that other programs have provided for pasting.
895 The function should be called with no arguments. If the function
896 returns nil, then no other program has provided such text, and the top
897 of the Emacs kill ring should be used. If the function returns a
898 string, that string should be put in the kill ring as the latest kill.
900 Note that the function should return a string only if a program other
901 than Emacs has provided a string for pasting; if Emacs provided the
902 most recent string, the function should return nil. If it is
903 difficult to tell whether Emacs or some other program provided the
904 current string, it is probably good enough to return nil if the string
905 is equal (according to `string=') to the last text Emacs provided.")
909 ;;;; The kill ring data structure.
911 (defvar kill-ring nil
912 "List of killed text sequences.
913 Since the kill ring is supposed to interact nicely with cut-and-paste
914 facilities offered by window systems, use of this variable should
915 interact nicely with `interprogram-cut-function' and
916 `interprogram-paste-function'. The functions `kill-new',
917 `kill-append', and `current-kill' are supposed to implement this
918 interaction; you may want to use them instead of manipulating the kill
921 (defconst kill-ring-max 30
922 "*Maximum length of kill ring before oldest elements are thrown away.")
924 (defvar kill-ring-yank-pointer nil
925 "The tail of the kill ring whose car is the last thing yanked.")
927 (defun kill-new (string)
928 "Make STRING the latest kill in the kill ring.
929 Set the kill-ring-yank pointer to point to it.
930 If `interprogram-cut-function' is non-nil, apply it to STRING."
931 (setq kill-ring (cons string kill-ring))
932 (if (> (length kill-ring) kill-ring-max)
933 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))
934 (setq kill-ring-yank-pointer kill-ring)
935 (if interprogram-cut-function
936 (funcall interprogram-cut-function string)))
938 (defun kill-append (string before-p)
939 "Append STRING to the end of the latest kill in the kill ring.
940 If BEFORE-P is non-nil, prepend STRING to the kill.
941 If `interprogram-cut-function' is set, pass the resulting kill to
945 (concat string (car kill-ring))
946 (concat (car kill-ring) string)))
947 (if interprogram-cut-function
948 (funcall interprogram-cut-function (car kill-ring))))
950 (defun current-kill (n &optional do-not-move)
951 "Rotate the yanking point by N places, and then return that kill.
952 If N is zero, `interprogram-paste-function' is set, and calling it
953 returns a string, then that string is added to the front of the
954 kill ring and returned as the latest kill.
955 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
956 yanking point; just return the Nth kill forward."
957 (let ((interprogram-paste (and (= n 0)
958 interprogram-paste-function
959 (funcall interprogram-paste-function))))
960 (if interprogram-paste
962 ;; Disable the interprogram cut function when we add the new
963 ;; text to the kill ring, so Emacs doesn't try to own the
964 ;; selection, with identical text.
965 (let ((interprogram-cut-function nil))
966 (kill-new interprogram-paste))
968 (or kill-ring (error "Kill ring is empty"))
969 (let* ((length (length kill-ring))
971 (nthcdr (% (+ n (- length (length kill-ring-yank-pointer)))
975 (setq kill-ring-yank-pointer ARGth-kill-element))
976 (car ARGth-kill-element)))))
980 ;;;; Commands for manipulating the kill ring.
982 (defun kill-region (beg end)
983 "Kill between point and mark.
984 The text is deleted but saved in the kill ring.
985 The command \\[yank] can retrieve it from there.
986 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
987 If the buffer is read-only, Emacs will beep and refrain from deleting
988 the text, but put the text in the kill ring anyway. This means that
989 you can use the killing commands to copy text from a read-only buffer.
991 This is the primitive for programs to kill text (as opposed to deleting it).
992 Supply two arguments, character numbers indicating the stretch of text
994 Any command that calls this function is a \"kill command\".
995 If the previous command was also a kill command,
996 the text killed this time appends to the text killed last time
997 to make one entry in the kill ring."
1001 ;; If the buffer is read-only, we should beep, in case the person
1002 ;; just isn't aware of this. However, there's no harm in putting
1003 ;; the region's text in the kill ring, anyway.
1005 (copy-region-as-kill beg end)
1006 ;; This should always barf, and give us the correct error.
1007 (barf-if-buffer-read-only))
1009 ;; In certain cases, we can arrange for the undo list and the kill
1010 ;; ring to share the same string object. This code does that.
1011 ((not (or (eq buffer-undo-list t)
1012 (eq last-command 'kill-region)
1014 ;; Don't let the undo list be truncated before we can even access it.
1015 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100)))
1016 (delete-region beg end)
1017 ;; Take the same string recorded for undo
1018 ;; and put it in the kill-ring.
1019 (kill-new (car (car buffer-undo-list)))
1020 (setq this-command 'kill-region)))
1023 (copy-region-as-kill beg end)
1024 (delete-region beg end))))
1026 (defun copy-region-as-kill (beg end)
1027 "Save the region as if killed, but don't kill it.
1028 If `interprogram-cut-function' is non-nil, also save the text for a window
1029 system cut and paste."
1031 (if (eq last-command 'kill-region)
1032 (kill-append (buffer-substring beg end) (< end beg))
1033 (kill-new (buffer-substring beg end)))
1034 (setq this-command 'kill-region)
1037 (defun kill-ring-save (beg end)
1038 "Save the region as if killed, but don't kill it.
1039 This command is similar to copy-region-as-kill, except that it gives
1040 visual feedback indicating the extent of the region being copied.
1041 If `interprogram-cut-function' is non-nil, also save the text for a window
1042 system cut and paste."
1044 (copy-region-as-kill beg end)
1047 (let ((other-end (if (= (point) beg) end beg)))
1048 (if (pos-visible-in-window-p other-end (selected-window))
1050 (goto-char other-end)
1052 (let* ((killed-text (current-kill 0))
1053 (message-len (min (length killed-text) 40)))
1055 ;; Don't say "killed"; that is misleading.
1056 (message "Saved text until \"%s\""
1057 (substring killed-text (- message-len)))
1058 (message "Saved text from \"%s\""
1059 (substring killed-text 0 message-len)))))))))
1061 (defun append-next-kill ()
1062 "Cause following command, if it kills, to append to previous kill."
1066 (setq this-command 'kill-region)
1067 (message "If the next command is a kill, it will append"))
1068 (setq last-command 'kill-region)))
1070 (defun yank-pop (arg)
1071 "Replace just-yanked stretch of killed text with a different stretch.
1072 This command is allowed only immediately after a `yank' or a `yank-pop'.
1073 At such a time, the region contains a stretch of reinserted
1074 previously-killed text. `yank-pop' deletes that text and inserts in its
1075 place a different stretch of killed text.
1077 With no argument, the previous kill is inserted.
1078 With argument N, insert the Nth previous kill.
1079 If N is negative, this is a more recent kill.
1081 The sequence of kills wraps around, so that after the oldest one
1082 comes the newest one."
1084 (if (not (eq last-command 'yank))
1085 (error "Previous command was not a yank"))
1086 (setq this-command 'yank)
1087 (let ((before (< (point) (mark))))
1088 (delete-region (point) (mark))
1090 (insert (current-kill arg))
1091 (if before (exchange-point-and-mark)))
1094 (defun yank (&optional arg)
1095 "Reinsert the last stretch of killed text.
1096 More precisely, reinsert the stretch of killed text most recently
1097 killed OR yanked. Put point at end, and set mark at beginning.
1098 With just C-u as argument, same but put point at beginning (and mark at end).
1099 With argument N, reinsert the Nth most recently killed stretch of killed
1101 See also the command \\[yank-pop]."
1104 (insert (current-kill (cond
1109 (exchange-point-and-mark))
1112 (defun rotate-yank-pointer (arg)
1113 "Rotate the yanking point in the kill ring.
1114 With argument, rotate that many kills forward (or backward, if negative)."
1119 (defun insert-buffer (buffer)
1120 "Insert after point the contents of BUFFER.
1121 Puts mark after the inserted text.
1122 BUFFER may be a buffer or a buffer name."
1123 (interactive (list (progn (barf-if-buffer-read-only)
1124 (read-buffer "Insert buffer: " (other-buffer) t))))
1125 (or (bufferp buffer)
1126 (setq buffer (get-buffer buffer)))
1127 (let (start end newmark)
1131 (setq start (point-min) end (point-max)))
1132 (insert-buffer-substring buffer start end)
1133 (setq newmark (point)))
1134 (push-mark newmark))
1137 (defun append-to-buffer (buffer start end)
1138 "Append to specified buffer the text of the region.
1139 It is inserted into that buffer before its point.
1141 When calling from a program, give three arguments:
1142 BUFFER (or buffer name), START and END.
1143 START and END specify the portion of the current buffer to be copied."
1145 (list (read-buffer "Append to buffer: " (other-buffer nil t) t)))
1146 (let ((oldbuf (current-buffer)))
1148 (set-buffer (get-buffer-create buffer))
1149 (insert-buffer-substring oldbuf start end))))
1151 (defun prepend-to-buffer (buffer start end)
1152 "Prepend to specified buffer the text of the region.
1153 It is inserted into that buffer after its point.
1155 When calling from a program, give three arguments:
1156 BUFFER (or buffer name), START and END.
1157 START and END specify the portion of the current buffer to be copied."
1158 (interactive "BPrepend to buffer: \nr")
1159 (let ((oldbuf (current-buffer)))
1161 (set-buffer (get-buffer-create buffer))
1163 (insert-buffer-substring oldbuf start end)))))
1165 (defun copy-to-buffer (buffer start end)
1166 "Copy to specified buffer the text of the region.
1167 It is inserted into that buffer, replacing existing text there.
1169 When calling from a program, give three arguments:
1170 BUFFER (or buffer name), START and END.
1171 START and END specify the portion of the current buffer to be copied."
1172 (interactive "BCopy to buffer: \nr")
1173 (let ((oldbuf (current-buffer)))
1175 (set-buffer (get-buffer-create buffer))
1178 (insert-buffer-substring oldbuf start end)))))
1180 (defun mark (&optional force)
1181 "Return this buffer's mark value as integer, or nil if no active mark now.
1182 If optional argument FORCE is non-nil, access the mark value
1183 even if the mark is not currently active.
1185 If you are using this in an editing command, you are most likely making
1186 a mistake; see the documentation of `set-mark'."
1187 (if (or force mark-active)
1188 (marker-position (mark-marker))
1189 (error "The mark is not currently active")))
1191 (defun set-mark (pos)
1192 "Set this buffer's mark to POS. Don't use this function!
1193 That is to say, don't use this function unless you want
1194 the user to see that the mark has moved, and you want the previous
1195 mark position to be lost.
1197 Normally, when a new mark is set, the old one should go on the stack.
1198 This is why most applications should use push-mark, not set-mark.
1200 Novice Emacs Lisp programmers often try to use the mark for the wrong
1201 purposes. The mark saves a location for the user's convenience.
1202 Most editing commands should not alter the mark.
1203 To remember a location for internal use in the Lisp program,
1204 store it in a Lisp variable. Example:
1206 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1208 (setq mark-active t)
1209 (run-hooks 'activate-mark-hook)
1210 (set-marker (mark-marker) pos (current-buffer)))
1212 (defvar mark-ring nil
1213 "The list of saved former marks of the current buffer,
1214 most recent first.")
1215 (make-variable-buffer-local 'mark-ring)
1217 (defconst mark-ring-max 16
1218 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1220 (defun set-mark-command (arg)
1221 "Set mark at where point is, or jump to mark.
1222 With no prefix argument, set mark, and push old mark position on mark ring.
1223 With argument, jump to mark, and pop a new position for mark off the ring.
1225 Novice Emacs Lisp programmers often try to use the mark for the wrong
1226 purposes. See the documentation of `set-mark' for more information."
1231 (error "No mark set in this buffer")
1235 (defun push-mark (&optional location nomsg)
1236 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1237 Displays \"Mark set\" unless the optional second arg NOMSG is non-nil.
1239 Novice Emacs Lisp programmers often try to use the mark for the wrong
1240 purposes. See the documentation of `set-mark' for more information."
1243 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1244 (if (> (length mark-ring) mark-ring-max)
1246 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1247 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1248 (set-mark (or location (point)))
1249 (or nomsg executing-macro (> (minibuffer-depth) 0)
1250 (message "Mark set"))
1254 "Pop off mark ring into the buffer's actual mark.
1255 Does not set point. Does nothing if mark ring is empty."
1258 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1259 (set-mark (+ 0 (car mark-ring)))
1260 (move-marker (car mark-ring) nil)
1261 (if (null (mark)) (ding))
1262 (setq mark-ring (cdr mark-ring)))))
1264 (fset 'exchange-dot-and-mark 'exchange-point-and-mark)
1265 (defun exchange-point-and-mark ()
1266 "Put the mark where point is now, and point where the mark is now.
1267 This command works even when the mark is not active,
1268 and it reactivates the mark."
1270 (let ((omark (mark t)))
1272 (error "No mark set in this buffer"))
1277 (defun next-line (arg)
1278 "Move cursor vertically down ARG lines.
1279 If there is no character in the target line exactly under the current column,
1280 the cursor is positioned after the character in that line which spans this
1281 column, or at the end of the line if it is not long enough.
1282 If there is no line in the buffer after this one,
1283 a newline character is inserted to create a line
1284 and the cursor moves to that line.
1286 The command \\[set-goal-column] can be used to create
1287 a semipermanent goal column to which this command always moves.
1288 Then it does not try to move vertically. This goal column is stored
1289 in `goal-column', which is nil when there is none.
1291 If you are thinking of using this in a Lisp program, consider
1292 using `forward-line' instead. It is usually easier to use
1293 and more reliable (no dependence on goal column, etc.)."
1296 (let ((opoint (point)))
1298 (if (or (= opoint (point))
1299 (not (eq (preceding-char) ?\n)))
1306 (defun previous-line (arg)
1307 "Move cursor vertically up ARG lines.
1308 If there is no character in the target line exactly over the current column,
1309 the cursor is positioned after the character in that line which spans this
1310 column, or at the end of the line if it is not long enough.
1312 The command \\[set-goal-column] can be used to create
1313 a semipermanent goal column to which this command always moves.
1314 Then it does not try to move vertically.
1316 If you are thinking of using this in a Lisp program, consider using
1317 `forward-line' with a negative argument instead. It is usually easier
1318 to use and more reliable (no dependence on goal column, etc.)."
1323 (defconst track-eol nil
1324 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1325 This means moving to the end of each line moved onto.
1326 The beginning of a blank line does not count as the end of a line.")
1328 (defvar goal-column nil
1329 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1330 (make-variable-buffer-local 'goal-column)
1332 (defvar temporary-goal-column 0
1333 "Current goal column for vertical motion.
1334 It is the column where point was
1335 at the start of current run of vertical motion commands.
1336 When the `track-eol' feature is doing its job, the value is 9999.")
1338 (defun line-move (arg)
1339 (if (not (or (eq last-command 'next-line)
1340 (eq last-command 'previous-line)))
1341 (setq temporary-goal-column
1342 (if (and track-eol (eolp)
1343 ;; Don't count beg of empty line as end of line
1344 ;; unless we just did explicit end-of-line.
1345 (or (not (bolp)) (eq last-command 'end-of-line)))
1348 (if (not (integerp selective-display))
1350 ;; Move by arg lines, but ignore invisible ones.
1355 (setq arg (1- arg)))
1357 (vertical-motion -1)
1359 (setq arg (1+ arg))))
1360 (move-to-column (or goal-column temporary-goal-column))
1363 ;;; Many people have said they rarely use this feature, and often type
1364 ;;; it by accident. Maybe it shouldn't even be on a key.
1365 (put 'set-goal-column 'disabled t)
1367 (defun set-goal-column (arg)
1368 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1369 Those commands will move to this position in the line moved to
1370 rather than trying to keep the same horizontal position.
1371 With a non-nil argument, clears out the goal column
1372 so that \\[next-line] and \\[previous-line] resume vertical motion.
1373 The goal column is stored in the variable `goal-column'."
1377 (setq goal-column nil)
1378 (message "No goal column"))
1379 (setq goal-column (current-column))
1380 (message (substitute-command-keys
1381 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1385 (defun transpose-chars (arg)
1386 "Interchange characters around point, moving forward one character.
1387 With prefix arg ARG, effect is to take character before point
1388 and drag it forward past ARG other characters (backward if ARG negative).
1389 If no argument and at end of line, the previous two chars are exchanged."
1391 (and (null arg) (eolp) (forward-char -1))
1392 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1394 (defun transpose-words (arg)
1395 "Interchange words around point, leaving point at end of them.
1396 With prefix arg ARG, effect is to take word before or around point
1397 and drag it forward past ARG other words (backward if ARG negative).
1398 If ARG is zero, the words around or after point and around or after mark
1401 (transpose-subr 'forward-word arg))
1403 (defun transpose-sexps (arg)
1404 "Like \\[transpose-words] but applies to sexps.
1405 Does not work on a sexp that point is in the middle of
1406 if it is a list or string."
1408 (transpose-subr 'forward-sexp arg))
1410 (defun transpose-lines (arg)
1411 "Exchange current line and previous line, leaving point after both.
1412 With argument ARG, takes previous line and moves it past ARG lines.
1413 With argument 0, interchanges line point is in with line mark is in."
1415 (transpose-subr (function
1419 ;; Move forward over a line,
1420 ;; but create a newline if none exists yet.
1425 (forward-line arg))))
1428 (defun transpose-subr (mover arg)
1429 (let (start1 end1 start2 end2)
1436 (setq start2 (point))
1441 (setq start1 (point))
1443 (exchange-point-and-mark)))
1446 (setq start1 (point))
1452 (setq start2 (point))
1455 (setq arg (1- arg)))
1458 (setq start2 (point))
1460 (setq start1 (point))
1466 (setq arg (1+ arg)))))
1468 (defun transpose-subr-1 ()
1469 (if (> (min end1 end2) (max start1 start2))
1470 (error "Don't have two things to transpose"))
1471 (let ((word1 (buffer-substring start1 end1))
1472 (word2 (buffer-substring start2 end2)))
1473 (delete-region start2 end2)
1476 (goto-char (if (< start1 start2) start1
1477 (+ start1 (- (length word1) (length word2)))))
1478 (delete-char (length word1))
1481 (defconst comment-column 32
1482 "*Column to indent right-margin comments to.
1483 Setting this variable automatically makes it local to the current buffer.
1484 Each mode establishes a different default value for this variable; you
1485 can the value for a particular mode using that mode's hook.")
1486 (make-variable-buffer-local 'comment-column)
1488 (defconst comment-start nil
1489 "*String to insert to start a new comment, or nil if no comment syntax defined.")
1491 (defconst comment-start-skip nil
1492 "*Regexp to match the start of a comment plus everything up to its body.
1493 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
1494 at the place matched by the close of the first pair.")
1496 (defconst comment-end ""
1497 "*String to insert to end a new comment.
1498 Should be an empty string if comments are terminated by end-of-line.")
1500 (defconst comment-indent-hook nil
1501 "Obsolete variable for function to compute desired indentation for a comment.
1502 This function is called with no args with point at the beginning of
1503 the comment's starting delimiter.")
1505 (defconst comment-indent-function
1506 '(lambda () comment-column)
1507 "Function to compute desired indentation for a comment.
1508 This function is called with no args with point at the beginning of
1509 the comment's starting delimiter.")
1511 (defun indent-for-comment ()
1512 "Indent this line's comment to comment column, or insert an empty comment."
1514 (beginning-of-line 1)
1515 (if (null comment-start)
1516 (error "No comment syntax defined")
1517 (let* ((eolpos (save-excursion (end-of-line) (point)))
1519 (if (re-search-forward comment-start-skip eolpos 'move)
1520 (progn (setq cpos (point-marker))
1521 ;; Find the start of the comment delimiter.
1522 ;; If there were paren-pairs in comment-start-skip,
1523 ;; position at the end of the first pair.
1525 (goto-char (match-end 1))
1526 ;; If comment-start-skip matched a string with
1527 ;; internal whitespace (not final whitespace) then
1528 ;; the delimiter start at the end of that
1529 ;; whitespace. Otherwise, it starts at the
1530 ;; beginning of what was matched.
1531 (skip-syntax-backward " " (match-beginning 0))
1532 (skip-syntax-backward "^ " (match-beginning 0)))))
1533 (setq begpos (point))
1534 ;; Compute desired indent.
1535 (if (= (current-column)
1536 (setq indent (if comment-indent-hook
1537 (funcall comment-indent-hook)
1538 (funcall comment-indent-function))))
1540 ;; If that's different from current, change it.
1541 (skip-chars-backward " \t")
1542 (delete-region (point) begpos)
1544 ;; An existing comment?
1546 (progn (goto-char cpos)
1547 (set-marker cpos nil))
1549 (insert comment-start)
1551 (insert comment-end))))))
1553 (defun set-comment-column (arg)
1554 "Set the comment column based on point.
1555 With no arg, set the comment column to the current column.
1556 With just minus as arg, kill any comment on this line.
1557 With any other arg, set comment column to indentation of the previous comment
1558 and then align or create a comment on this line at that column."
1566 (re-search-backward comment-start-skip)
1568 (re-search-forward comment-start-skip)
1569 (goto-char (match-beginning 0))
1570 (setq comment-column (current-column))
1571 (message "Comment column set to %d" comment-column))
1572 (indent-for-comment))
1573 (setq comment-column (current-column))
1574 (message "Comment column set to %d" comment-column))))
1576 (defun kill-comment (arg)
1577 "Kill the comment on this line, if any.
1578 With argument, kill comments on that many lines starting with this one."
1579 ;; this function loses in a lot of situations. it incorrectly recognises
1580 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
1581 ;; with multi-line comments, can kill extra whitespace if comment wasn't
1582 ;; through end-of-line, et cetera.
1584 (or comment-start-skip (error "No comment syntax defined"))
1585 (let ((count (prefix-numeric-value arg)) endc)
1591 (and (string< "" comment-end)
1594 (re-search-forward (regexp-quote comment-end) endc 'move)
1595 (skip-chars-forward " \t")
1598 (if (re-search-forward comment-start-skip endc t)
1600 (goto-char (match-beginning 0))
1601 (skip-chars-backward " \t")
1602 (kill-region (point) endc)
1603 ;; to catch comments a line beginnings
1604 (indent-according-to-mode))))
1605 (if arg (forward-line 1))
1606 (setq count (1- count)))))
1608 (defun comment-region (beg end &optional arg)
1609 "Comment the region; third arg numeric means use ARG comment characters.
1610 If ARG is negative, delete that many comment characters instead.
1611 Comments are terminated on each line, even for syntax in which newline does
1612 not end the comment. Blank lines do not get comments."
1613 ;; if someone wants it to only put a comment-start at the beginning and
1614 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
1615 ;; is easy enough. No option is made here for other than commenting
1617 (interactive "r\np")
1618 (or comment-start (error "No comment syntax is defined"))
1619 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
1622 (let ((cs comment-start) (ce comment-end))
1623 (cond ((not arg) (setq arg 1))
1625 (while (> (setq arg (1- arg)) 0)
1626 (setq cs (concat cs comment-start)
1627 ce (concat ce comment-end)))))
1628 (narrow-to-region beg end)
1633 (while (and (> 1 (setq count (1+ count)))
1634 (looking-at (regexp-quote cs)))
1635 (delete-char (length cs)))
1636 (if (string= "" ce) ()
1638 (while (> 1 (setq count (1+ count)))
1640 ;; this is questionable if comment-end ends in whitespace
1641 ;; that is pretty brain-damaged though
1642 (skip-chars-backward " \t")
1643 (backward-char (length ce))
1644 (if (looking-at (regexp-quote ce))
1645 (delete-char (length ce)))))
1647 (if (looking-at "[ \t]*$") ()
1649 (if (string= "" ce) ()
1652 (search-forward "\n" nil 'move)))))))
1654 (defun backward-word (arg)
1655 "Move backward until encountering the end of a word.
1656 With argument, do this that many times.
1657 In programs, it is faster to call `forward-word' with negative arg."
1659 (forward-word (- arg)))
1661 (defun mark-word (arg)
1662 "Set mark arg words away from point."
1669 (defun kill-word (arg)
1670 "Kill characters forward until encountering the end of a word.
1671 With argument, do this that many times."
1673 (kill-region (point) (save-excursion (forward-word arg) (point))))
1675 (defun backward-kill-word (arg)
1676 "Kill characters backward until encountering the end of a word.
1677 With argument, do this that many times."
1679 (kill-word (- arg)))
1681 (defun current-word ()
1682 "Return the word point is on as a string, if it's between two
1683 word-constituent characters. If not, but it immediately follows one,
1684 move back first. Otherwise, if point precedes a word constituent,
1685 move forward first. Otherwise, move backwards until a word constituent
1686 is found and get that word; if you reach a newline first, move forward
1690 (let ((oldpoint (point)) (start (point)) (end (point)))
1691 (skip-syntax-backward "w_") (setq start (point))
1692 (goto-char oldpoint)
1693 (skip-syntax-forward "w_") (setq end (point))
1694 (if (and (eq start oldpoint) (eq end oldpoint))
1696 (skip-syntax-backward "^w_"
1697 (save-excursion (beginning-of-line) (point)))
1698 (if (eq (preceding-char) ?\n)
1700 (skip-syntax-forward "^w_")
1701 (setq start (point))
1702 (skip-syntax-forward "w_")
1705 (skip-syntax-backward "w_")
1706 (setq start (point)))))
1707 (buffer-substring start end))))
1709 (defconst fill-prefix nil
1710 "*String for filling to insert at front of new line, or nil for none.
1711 Setting this variable automatically makes it local to the current buffer.")
1712 (make-variable-buffer-local 'fill-prefix)
1714 (defconst auto-fill-inhibit-regexp nil
1715 "*Regexp to match lines which should not be auto-filled.")
1717 (defun do-auto-fill ()
1719 (or (and auto-fill-inhibit-regexp
1720 (save-excursion (beginning-of-line)
1721 (looking-at auto-fill-inhibit-regexp)))
1722 (while (and (not give-up) (> (current-column) fill-column))
1724 (let ((opoint (point)))
1726 (move-to-column (1+ fill-column))
1727 (skip-chars-backward "^ \t\n")
1729 (re-search-forward "[ \t]" opoint t))
1730 (skip-chars-backward " \t")
1732 ;; If there is a space on the line before fill-point,
1733 ;; and nonspaces precede it, break the line there.
1735 (goto-char fill-point)
1737 ;; If point is at the fill-point, do not `save-excursion'.
1738 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
1739 ;; point will end up before it rather than after it.
1741 (skip-chars-backward " \t")
1742 (= (point) fill-point))
1743 (indent-new-comment-line)
1745 (goto-char fill-point)
1746 (indent-new-comment-line)))
1747 ;; No place to break => stop trying.
1748 (setq give-up t)))))))
1750 (defconst comment-multi-line nil
1751 "*Non-nil means \\[indent-new-comment-line] should continue same comment
1752 on new line, with no new terminator or starter.
1753 This is obsolete because you might as well use \\[newline-and-indent].")
1755 (defun indent-new-comment-line ()
1756 "Break line at point and indent, continuing comment if presently within one.
1757 The body of the continued comment is indented under the previous comment line.
1759 This command is intended for styles where you write a comment per line,
1760 starting a new comment (and terminating it if necessary) on each line.
1761 If you want to continue one comment across several lines, use \\[newline-and-indent]."
1763 (let (comcol comstart)
1764 (skip-chars-backward " \t")
1765 (delete-region (point)
1766 (progn (skip-chars-forward " \t")
1769 (if (not comment-multi-line)
1771 (if (and comment-start-skip
1772 (let ((opoint (point)))
1774 (re-search-forward comment-start-skip opoint t)))
1775 ;; The old line is a comment.
1776 ;; Set WIN to the pos of the comment-start.
1777 ;; But if the comment is empty, look at preceding lines
1778 ;; to find one that has a nonempty comment.
1779 (let ((win (match-beginning 0)))
1780 (while (and (eolp) (not (bobp))
1783 (setq opoint (point))
1785 (re-search-forward comment-start-skip opoint t)))
1786 (setq win (match-beginning 0)))
1787 ;; Indent this line like what we found.
1789 (setq comcol (current-column))
1790 (setq comstart (buffer-substring (point) (match-end 0)))))))
1792 (let ((comment-column comcol)
1793 (comment-start comstart)
1794 (comment-end comment-end))
1795 (and comment-end (not (equal comment-end ""))
1796 ; (if (not comment-multi-line)
1799 (insert comment-end)
1801 ; (setq comment-column (+ comment-column (length comment-start))
1806 (setq comment-end ""))
1809 (indent-for-comment)
1811 ;; Make sure we delete the newline inserted above.
1815 (insert fill-prefix)
1816 (indent-according-to-mode)))))
1818 (defun auto-fill-mode (&optional arg)
1819 "Toggle auto-fill mode.
1820 With arg, turn auto-fill mode on if and only if arg is positive.
1821 In auto-fill mode, inserting a space at a column beyond fill-column
1822 automatically breaks the line at a previous space."
1824 (prog1 (setq auto-fill-function
1826 (not auto-fill-function)
1827 (> (prefix-numeric-value arg) 0))
1831 (set-buffer-modified-p (buffer-modified-p))))
1833 (defun turn-on-auto-fill ()
1834 "Unconditionally turn on Auto Fill mode."
1837 (defun set-fill-column (arg)
1838 "Set `fill-column' to current column, or to argument if given.
1839 The variable `fill-column' has a separate value for each buffer."
1841 (setq fill-column (if (integerp arg) arg (current-column)))
1842 (message "fill-column set to %d" fill-column))
1844 (defun set-selective-display (arg)
1845 "Set `selective-display' to ARG; clear it if no arg.
1846 When the value of `selective-display' is a number > 0,
1847 lines whose indentation is >= that value are not displayed.
1848 The variable `selective-display' has a separate value for each buffer."
1850 (if (eq selective-display t)
1851 (error "selective-display already in use for marked lines"))
1854 (narrow-to-region (point-min) (point))
1855 (goto-char (window-start))
1856 (vertical-motion (window-height)))))
1857 (setq selective-display
1858 (and arg (prefix-numeric-value arg)))
1859 (recenter current-vpos))
1860 (set-window-start (selected-window) (window-start (selected-window)))
1861 (princ "selective-display set to " t)
1862 (prin1 selective-display t)
1865 (defconst overwrite-mode-textual " Ovwrt"
1866 "The string displayed in the mode line when in overwrite mode.")
1867 (defconst overwrite-mode-binary " Bin Ovwrt"
1868 "The string displayed in the mode line when in binary overwrite mode.")
1870 (defun overwrite-mode (arg)
1871 "Toggle overwrite mode.
1872 With arg, turn overwrite mode on iff arg is positive.
1873 In overwrite mode, printing characters typed in replace existing text
1874 on a one-for-one basis, rather than pushing it to the right. At the
1875 end of a line, such characters extend the line. Before a tab,
1876 such characters insert until the tab is filled in.
1877 \\[quoted-insert] still inserts characters in overwrite mode; this
1878 is supposed to make it easier to insert characters when necessary."
1880 (setq overwrite-mode
1881 (if (if (null arg) (not overwrite-mode)
1882 (> (prefix-numeric-value arg) 0))
1883 'overwrite-mode-textual))
1884 (force-mode-line-update))
1886 (defun binary-overwrite-mode (arg)
1887 "Toggle binary overwrite mode.
1888 With arg, turn binary overwrite mode on iff arg is positive.
1889 In binary overwrite mode, printing characters typed in replace
1890 existing text. Newlines are not treated specially, so typing at the
1891 end of a line joins the line to the next, with the typed character
1892 between them. Typing before a tab character simply replaces the tab
1893 with the character typed.
1894 \\[quoted-insert] replaces the text at the cursor, just as ordinary
1895 typing characters do.
1897 Note that binary overwrite mode is not its own minor mode; it is a
1898 specialization of overwrite-mode, entered by setting the
1899 `overwrite-mode' variable to `overwrite-mode-binary'."
1901 (setq overwrite-mode
1903 (not (eq overwrite-mode 'overwrite-mode-binary))
1904 (> (prefix-numeric-value arg) 0))
1905 'overwrite-mode-binary))
1906 (force-mode-line-update))
1908 (defvar line-number-mode nil
1909 "*Non-nil means display line number in mode line.")
1911 (defun line-number-mode (arg)
1912 "Toggle Line Number mode.
1913 With arg, turn Line Number mode on iff arg is positive.
1914 When Line Number mode is enabled, the line number appears
1917 (setq line-number-mode
1918 (if (null arg) (not line-number-mode)
1919 (> (prefix-numeric-value arg) 0)))
1920 (force-mode-line-update))
1922 (defvar blink-matching-paren t
1923 "*Non-nil means show matching open-paren when close-paren is inserted.")
1925 (defconst blink-matching-paren-distance 4000
1926 "*If non-nil, is maximum distance to search for matching open-paren
1927 when close-paren is inserted.")
1929 (defun blink-matching-open ()
1930 "Move cursor momentarily to the beginning of the sexp before point."
1932 (and (> (point) (1+ (point-min)))
1933 (/= (char-syntax (char-after (- (point) 2))) ?\\ )
1934 blink-matching-paren
1935 (let* ((oldpos (point))
1940 (if blink-matching-paren-distance
1941 (narrow-to-region (max (point-min)
1942 (- (point) blink-matching-paren-distance))
1945 (setq blinkpos (scan-sexps oldpos -1))
1947 (and blinkpos (/= (char-syntax (char-after blinkpos))
1950 (/= (char-after (1- oldpos))
1951 (logand (lsh (aref (syntax-table)
1952 (char-after blinkpos))
1955 (if mismatch (setq blinkpos nil))
1958 (goto-char blinkpos)
1959 (if (pos-visible-in-window-p)
1961 (goto-char blinkpos)
1965 (skip-chars-backward " \t")
1967 (buffer-substring (progn (beginning-of-line) (point))
1969 (buffer-substring blinkpos
1972 (skip-chars-forward "\n \t")
1976 (message "Mismatched parentheses"))
1977 ((not blink-matching-paren-distance)
1978 (message "Unmatched parenthesis"))))))))
1980 ;Turned off because it makes dbx bomb out.
1981 (setq blink-paren-function 'blink-matching-open)
1983 ; this is just something for the luser to see in a keymap -- this is not
1984 ; how quitting works normally!
1985 (defun keyboard-quit ()
1986 "Signal a quit condition.
1987 During execution of Lisp code, this character causes a quit directly.
1988 At top-level, as an editor command, this simply beeps."
1992 (define-key global-map "\C-g" 'keyboard-quit)
1994 (defun set-variable (var val)
1995 "Set VARIABLE to VALUE. VALUE is a Lisp object.
1996 When using this interactively, supply a Lisp expression for VALUE.
1997 If you want VALUE to be a string, you must surround it with doublequotes.
1999 If VARIABLE has a `variable-interactive' property, that is used as if
2000 it were the arg to `interactive' (which see) to interactively read the value."
2002 (let* ((var (read-variable "Set variable: "))
2003 (minibuffer-help-form
2008 (with-output-to-temp-buffer "*Help*"
2010 (princ "\nDocumentation:\n")
2011 (princ (substring (documentation-property var 'variable-documentation)
2014 (let ((print-length 20))
2015 (princ "\n\nCurrent value: ")
2016 (prin1 (symbol-value var))))
2019 (let ((prop (get var 'variable-interactive)))
2021 ;; Use VAR's `variable-interactive' property
2022 ;; as an interactive spec for prompting.
2023 (call-interactively (list 'lambda '(arg)
2024 (list 'interactive prop)
2026 (eval-minibuffer (format "Set %s to value: " var)))))))
2029 ;;; simple.el ends here