* simple.el (previous-line): Doc fix.
[bpt/emacs.git] / lisp / simple.el
1 ;;; simple.el --- basic editing commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
4
5 ;; This file is part of GNU Emacs.
6
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)
10 ;; any later version.
11
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.
16
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.
20
21 ;;; Code:
22
23 (defun open-line (arg)
24 "Insert a newline and leave point before it.
25 If there is a fill prefix, insert the fill prefix on the new line
26 if the line would have been empty.
27 With arg N, insert N newlines."
28 (interactive "*p")
29 (let* ((do-fill-prefix (and fill-prefix (bolp)))
30 (flag (and (null do-fill-prefix) (bolp) (not (bobp)))))
31 ;; If this is a simple case, and we are at the beginning of a line,
32 ;; actually insert the newline *before* the preceding newline
33 ;; instead of after. That makes better display behavior.
34 (if flag
35 (progn
36 ;; If undo is enabled, don't let this hack be visible:
37 ;; record the real value of point as the place to move back to
38 ;; if we undo this insert.
39 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
40 (setq buffer-undo-list (cons (point) buffer-undo-list)))
41 (forward-char -1)))
42 (while (> arg 0)
43 (save-excursion
44 (insert ?\n))
45 (if do-fill-prefix (insert fill-prefix))
46 (setq arg (1- arg)))
47 (if flag (forward-char 1))))
48
49 (defun split-line ()
50 "Split current line, moving portion beyond point vertically down."
51 (interactive "*")
52 (skip-chars-forward " \t")
53 (let ((col (current-column))
54 (pos (point)))
55 (insert ?\n)
56 (indent-to col 0)
57 (goto-char pos)))
58
59 (defun quoted-insert (arg)
60 "Read next input character and insert it.
61 This is useful for inserting control characters.
62 You may also type up to 3 octal digits, to insert a character with that code"
63 (interactive "*p")
64 (let ((char (read-quoted-char)))
65 (while (> arg 0)
66 (insert char)
67 (setq arg (1- arg)))))
68
69 (defun delete-indentation (&optional arg)
70 "Join this line to previous and fix up whitespace at join.
71 If there is a fill prefix, delete it from the beginning of this line.
72 With argument, join this line to following line."
73 (interactive "*P")
74 (beginning-of-line)
75 (if arg (forward-line 1))
76 (if (eq (preceding-char) ?\n)
77 (progn
78 (delete-region (point) (1- (point)))
79 ;; If the second line started with the fill prefix,
80 ;; delete the prefix.
81 (if (and fill-prefix
82 (<= (+ (point) (length fill-prefix)) (point-max))
83 (string= fill-prefix
84 (buffer-substring (point)
85 (+ (point) (length fill-prefix)))))
86 (delete-region (point) (+ (point) (length fill-prefix))))
87 (fixup-whitespace))))
88
89 (defun fixup-whitespace ()
90 "Fixup white space between objects around point.
91 Leave one space or none, according to the context."
92 (interactive "*")
93 (save-excursion
94 (delete-horizontal-space)
95 (if (or (looking-at "^\\|\\s)")
96 (save-excursion (forward-char -1)
97 (looking-at "$\\|\\s(\\|\\s'")))
98 nil
99 (insert ?\ ))))
100
101 (defun delete-horizontal-space ()
102 "Delete all spaces and tabs around point."
103 (interactive "*")
104 (skip-chars-backward " \t")
105 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
106
107 (defun just-one-space ()
108 "Delete all spaces and tabs around point, leaving one space."
109 (interactive "*")
110 (skip-chars-backward " \t")
111 (if (= (following-char) ? )
112 (forward-char 1)
113 (insert ? ))
114 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
115
116 (defun delete-blank-lines ()
117 "On blank line, delete all surrounding blank lines, leaving just one.
118 On isolated blank line, delete that one.
119 On nonblank line, delete all blank lines that follow it."
120 (interactive "*")
121 (let (thisblank singleblank)
122 (save-excursion
123 (beginning-of-line)
124 (setq thisblank (looking-at "[ \t]*$"))
125 ;; Set singleblank if there is just one blank line here.
126 (setq singleblank
127 (and thisblank
128 (not (looking-at "[ \t]*\n[ \t]*$"))
129 (or (bobp)
130 (progn (forward-line -1)
131 (not (looking-at "[ \t]*$")))))))
132 ;; Delete preceding blank lines, and this one too if it's the only one.
133 (if thisblank
134 (progn
135 (beginning-of-line)
136 (if singleblank (forward-line 1))
137 (delete-region (point)
138 (if (re-search-backward "[^ \t\n]" nil t)
139 (progn (forward-line 1) (point))
140 (point-min)))))
141 ;; Delete following blank lines, unless the current line is blank
142 ;; and there are no following blank lines.
143 (if (not (and thisblank singleblank))
144 (save-excursion
145 (end-of-line)
146 (forward-line 1)
147 (delete-region (point)
148 (if (re-search-forward "[^ \t\n]" nil t)
149 (progn (beginning-of-line) (point))
150 (point-max)))))
151 ;; Handle the special case where point is followed by newline and eob.
152 ;; Delete the line, leaving point at eob.
153 (if (looking-at "^[ \t]*\n\\'")
154 (delete-region (point) (point-max)))))
155
156 (defun back-to-indentation ()
157 "Move point to the first non-whitespace character on this line."
158 (interactive)
159 (beginning-of-line 1)
160 (skip-chars-forward " \t"))
161
162 (defun newline-and-indent ()
163 "Insert a newline, then indent according to major mode.
164 Indentation is done using the value of `indent-line-function'.
165 In programming language modes, this is the same as TAB.
166 In some text modes, where TAB inserts a tab, this command indents to the
167 column specified by the variable `left-margin'."
168 (interactive "*")
169 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
170 (newline)
171 (indent-according-to-mode))
172
173 (defun reindent-then-newline-and-indent ()
174 "Reindent current line, insert newline, then indent the new line.
175 Indentation of both lines is done according to the current major mode,
176 which means calling the current value of `indent-line-function'.
177 In programming language modes, this is the same as TAB.
178 In some text modes, where TAB inserts a tab, this indents to the
179 column specified by the variable `left-margin'."
180 (interactive "*")
181 (save-excursion
182 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
183 (indent-according-to-mode))
184 (newline)
185 (indent-according-to-mode))
186
187 ;; Internal subroutine of delete-char
188 (defun kill-forward-chars (arg)
189 (if (listp arg) (setq arg (car arg)))
190 (if (eq arg '-) (setq arg -1))
191 (kill-region (point) (+ (point) arg)))
192
193 ;; Internal subroutine of backward-delete-char
194 (defun kill-backward-chars (arg)
195 (if (listp arg) (setq arg (car arg)))
196 (if (eq arg '-) (setq arg -1))
197 (kill-region (point) (- (point) arg)))
198
199 (defun backward-delete-char-untabify (arg &optional killp)
200 "Delete characters backward, changing tabs into spaces.
201 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
202 Interactively, ARG is the prefix arg (default 1)
203 and KILLP is t if prefix arg is was specified."
204 (interactive "*p\nP")
205 (let ((count arg))
206 (save-excursion
207 (while (and (> count 0) (not (bobp)))
208 (if (= (preceding-char) ?\t)
209 (let ((col (current-column)))
210 (forward-char -1)
211 (setq col (- col (current-column)))
212 (insert-char ?\ col)
213 (delete-char 1)))
214 (forward-char -1)
215 (setq count (1- count)))))
216 (delete-backward-char arg killp)
217 ;; In overwrite mode, back over columns while clearing them out,
218 ;; unless at end of line.
219 (and overwrite-mode (not (eolp))
220 (save-excursion (insert-char ?\ arg))))
221
222 (defun zap-to-char (arg char)
223 "Kill up to and including ARG'th occurrence of CHAR.
224 Goes backward if ARG is negative; error if CHAR not found."
225 (interactive "p\ncZap to char: ")
226 (kill-region (point) (progn
227 (search-forward (char-to-string char) nil nil arg)
228 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
229 (point))))
230
231 (defun beginning-of-buffer (&optional arg)
232 "Move point to the beginning of the buffer; leave mark at previous position.
233 With arg N, put point N/10 of the way from the true beginning.
234
235 Don't use this command in Lisp programs!
236 \(goto-char (point-min)) is faster and avoids clobbering the mark."
237 (interactive "P")
238 (push-mark)
239 (goto-char (if arg
240 (if (> (buffer-size) 10000)
241 ;; Avoid overflow for large buffer sizes!
242 (* (prefix-numeric-value arg)
243 (/ (buffer-size) 10))
244 (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
245 (point-min)))
246 (if arg (forward-line 1)))
247
248 (defun end-of-buffer (&optional arg)
249 "Move point to the end of the buffer; leave mark at previous position.
250 With arg N, put point N/10 of the way from the true end.
251
252 Don't use this command in Lisp programs!
253 \(goto-char (point-max)) is faster and avoids clobbering the mark."
254 (interactive "P")
255 (push-mark)
256 (goto-char (if arg
257 (- (1+ (buffer-size))
258 (if (> (buffer-size) 10000)
259 ;; Avoid overflow for large buffer sizes!
260 (* (prefix-numeric-value arg)
261 (/ (buffer-size) 10))
262 (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
263 (point-max)))
264 ;; If we went to a place in the middle of the buffer,
265 ;; adjust it to the beginning of a line.
266 (if arg (forward-line 1)
267 ;; If the end of the buffer is not already on the screen,
268 ;; then scroll specially to put it near, but not at, the bottom.
269 (if (let ((old-point (point)))
270 (save-excursion
271 (goto-char (window-start))
272 (vertical-motion (window-height))
273 (< (point) old-point)))
274 (recenter -3))))
275
276 (defun mark-whole-buffer ()
277 "Put point at beginning and mark at end of buffer.
278 You probably should not use this function in Lisp programs;
279 it is usually a mistake for a Lisp function to use any subroutine
280 that uses or sets the mark."
281 (interactive)
282 (push-mark (point))
283 (push-mark (point-max))
284 (goto-char (point-min)))
285
286 (defun count-lines-region (start end)
287 "Print number of lines and charcters in the region."
288 (interactive "r")
289 (message "Region has %d lines, %d characters"
290 (count-lines start end) (- end start)))
291
292 (defun what-line ()
293 "Print the current line number (in the buffer) of point."
294 (interactive)
295 (save-restriction
296 (widen)
297 (save-excursion
298 (beginning-of-line)
299 (message "Line %d"
300 (1+ (count-lines 1 (point)))))))
301
302 (defun count-lines (start end)
303 "Return number of lines between START and END.
304 This is usually the number of newlines between them,
305 but can be one more if START is not equal to END
306 and the greater of them is not at the start of a line."
307 (save-excursion
308 (save-restriction
309 (narrow-to-region start end)
310 (goto-char (point-min))
311 (if (eq selective-display t)
312 (let ((done 0))
313 (while (re-search-forward "[\n\C-m]" nil t 40)
314 (setq done (+ 40 done)))
315 (while (re-search-forward "[\n\C-m]" nil t 1)
316 (setq done (+ 1 done)))
317 done)
318 (- (buffer-size) (forward-line (buffer-size)))))))
319
320 (defun what-cursor-position ()
321 "Print info on cursor position (on screen and within buffer)."
322 (interactive)
323 (let* ((char (following-char))
324 (beg (point-min))
325 (end (point-max))
326 (pos (point))
327 (total (buffer-size))
328 (percent (if (> total 50000)
329 ;; Avoid overflow from multiplying by 100!
330 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
331 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
332 (hscroll (if (= (window-hscroll) 0)
333 ""
334 (format " Hscroll=%d" (window-hscroll))))
335 (col (current-column)))
336 (if (= pos end)
337 (if (or (/= beg 1) (/= end (1+ total)))
338 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
339 pos total percent beg end col hscroll)
340 (message "point=%d of %d(%d%%) column %d %s"
341 pos total percent col hscroll))
342 (if (or (/= beg 1) (/= end (1+ total)))
343 (message "Char: %s (0%o) point=%d of %d(%d%%) <%d - %d> column %d %s"
344 (single-key-description char) char pos total percent beg end col hscroll)
345 (message "Char: %s (0%o) point=%d of %d(%d%%) column %d %s"
346 (single-key-description char) char pos total percent col hscroll)))))
347
348 (defun fundamental-mode ()
349 "Major mode not specialized for anything in particular.
350 Other major modes are defined by comparison with this one."
351 (interactive)
352 (kill-all-local-variables))
353
354 (defvar read-expression-map (copy-keymap minibuffer-local-map)
355 "Minibuffer keymap used for reading Lisp expressions.")
356 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
357
358 (put 'eval-expression 'disabled t)
359
360 ;; We define this, rather than making eval interactive,
361 ;; for the sake of completion of names like eval-region, eval-current-buffer.
362 (defun eval-expression (expression)
363 "Evaluate EXPRESSION and print value in minibuffer.
364 Value is also consed on to front of the variable `values'."
365 (interactive (list (read-from-minibuffer "Eval: "
366 nil read-expression-map t)))
367 (setq values (cons (eval expression) values))
368 (prin1 (car values) t))
369
370 (defun edit-and-eval-command (prompt command)
371 "Prompting with PROMPT, let user edit COMMAND and eval result.
372 COMMAND is a Lisp expression. Let user edit that expression in
373 the minibuffer, then read and evaluate the result."
374 (let ((command (read-from-minibuffer prompt
375 (prin1-to-string command)
376 read-expression-map t)))
377 ;; Add edited command to command history, unless redundant.
378 (or (equal command (car command-history))
379 (setq command-history (cons command command-history)))
380 (eval command)))
381
382 (defun repeat-complex-command (arg)
383 "Edit and re-evaluate last complex command, or ARGth from last.
384 A complex command is one which used the minibuffer.
385 The command is placed in the minibuffer as a Lisp form for editing.
386 The result is executed, repeating the command as changed.
387 If the command has been changed or is not the most recent previous command
388 it is added to the front of the command history.
389 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
390 to get different commands to edit and resubmit."
391 (interactive "p")
392 (let ((elt (nth (1- arg) command-history))
393 (minibuffer-history-position arg)
394 (minibuffer-history-sexp-flag t)
395 newcmd)
396 (if elt
397 (progn
398 (setq newcmd (read-from-minibuffer "Redo: "
399 (prin1-to-string elt)
400 read-expression-map
401 t
402 (cons 'command-history
403 arg)))
404 ;; If command was added to command-history as a string,
405 ;; get rid of that. We want only evallable expressions there.
406 (if (stringp (car command-history))
407 (setq command-history (cdr command-history)))
408 ;; If command to be redone does not match front of history,
409 ;; add it to the history.
410 (or (equal newcmd (car command-history))
411 (setq command-history (cons newcmd command-history)))
412 (eval newcmd))
413 (ding))))
414 \f
415 (defvar minibuffer-history nil
416 "Default minibuffer history list.
417 This is used for all minibuffer input
418 except when an alternate history list is specified.")
419 (defvar minibuffer-history-sexp-flag nil
420 "Nonzero when doing history operations on `command-history'.
421 More generally, indicates that the history list being acted on
422 contains expressions rather than strings.")
423 (setq minibuffer-history-variable 'minibuffer-history)
424 (setq minibuffer-history-position nil)
425 (defvar minibuffer-history-search-history nil)
426
427 (mapcar
428 (function (lambda (key-and-command)
429 (mapcar
430 (function (lambda (keymap)
431 (define-key (symbol-value keymap)
432 (car key-and-command)
433 (cdr key-and-command))))
434 '(minibuffer-local-map
435 minibuffer-local-ns-map
436 minibuffer-local-completion-map
437 minibuffer-local-must-match-map
438 read-expression-map))))
439 '(("\en" . next-history-element) ([next] . next-history-element)
440 ("\ep" . previous-history-element) ([prior] . previous-history-element)
441 ("\er" . previous-matching-history-element)
442 ("\es" . next-matching-history-element)))
443
444 (defun previous-matching-history-element (regexp n)
445 "Find the previous history element that matches REGEXP.
446 \(Previous history elements refer to earlier actions.)
447 With prefix argument N, search for Nth previous match.
448 If N is negative, find the next or Nth next match."
449 (interactive
450 (let ((enable-recursive-minibuffers t)
451 (minibuffer-history-sexp-flag nil))
452 (list (read-from-minibuffer "Previous element matching (regexp): "
453 nil
454 minibuffer-local-map
455 nil
456 'minibuffer-history-search-history)
457 (prefix-numeric-value current-prefix-arg))))
458 (let ((history (symbol-value minibuffer-history-variable))
459 prevpos
460 (pos minibuffer-history-position))
461 (while (/= n 0)
462 (setq prevpos pos)
463 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
464 (if (= pos prevpos)
465 (error (if (= pos 1)
466 "No later matching history item"
467 "No earlier matching history item")))
468 (if (string-match regexp
469 (if minibuffer-history-sexp-flag
470 (prin1-to-string (nth (1- pos) history))
471 (nth (1- pos) history)))
472 (setq n (+ n (if (< n 0) 1 -1)))))
473 (setq minibuffer-history-position pos)
474 (erase-buffer)
475 (let ((elt (nth (1- pos) history)))
476 (insert (if minibuffer-history-sexp-flag
477 (prin1-to-string elt)
478 elt)))
479 (goto-char (point-min)))
480 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
481 (eq (car (car command-history)) 'next-matching-history-element))
482 (setq command-history (cdr command-history))))
483
484 (defun next-matching-history-element (regexp n)
485 "Find the next history element that matches REGEXP.
486 \(The next history element refers to a more recent action.)
487 With prefix argument N, search for Nth next match.
488 If N is negative, find the previous or Nth previous match."
489 (interactive
490 (let ((enable-recursive-minibuffers t)
491 (minibuffer-history-sexp-flag nil))
492 (list (read-from-minibuffer "Next element matching (regexp): "
493 nil
494 minibuffer-local-map
495 nil
496 'minibuffer-history-search-history)
497 (prefix-numeric-value current-prefix-arg))))
498 (previous-matching-history-element regexp (- n)))
499
500 (defun next-history-element (n)
501 "Insert the next element of the minibuffer history into the minibuffer."
502 (interactive "p")
503 (let ((narg (min (max 1 (- minibuffer-history-position n))
504 (length (symbol-value minibuffer-history-variable)))))
505 (if (= minibuffer-history-position narg)
506 (error (if (= minibuffer-history-position 1)
507 "End of history; no next item"
508 "Beginning of history; no preceding item"))
509 (erase-buffer)
510 (setq minibuffer-history-position narg)
511 (let ((elt (nth (1- minibuffer-history-position)
512 (symbol-value minibuffer-history-variable))))
513 (insert
514 (if minibuffer-history-sexp-flag
515 (prin1-to-string elt)
516 elt)))
517 (goto-char (point-min)))))
518
519 (defun previous-history-element (n)
520 "Inserts the previous element of the minibuffer history into the minibuffer."
521 (interactive "p")
522 (next-history-element (- n)))
523 \f
524 (defun goto-line (arg)
525 "Goto line ARG, counting from line 1 at beginning of buffer."
526 (interactive "NGoto line: ")
527 (save-restriction
528 (widen)
529 (goto-char 1)
530 (if (eq selective-display t)
531 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
532 (forward-line (1- arg)))))
533
534 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
535 (fset 'advertised-undo 'undo)
536
537 (defun undo (&optional arg)
538 "Undo some previous changes.
539 Repeat this command to undo more changes.
540 A numeric argument serves as a repeat count."
541 (interactive "*p")
542 (let ((modified (buffer-modified-p)))
543 (or (eq (selected-window) (minibuffer-window))
544 (message "Undo!"))
545 (or (eq last-command 'undo)
546 (progn (undo-start)
547 (undo-more 1)))
548 (setq this-command 'undo)
549 (undo-more (or arg 1))
550 (and modified (not (buffer-modified-p))
551 (delete-auto-save-file-if-necessary))))
552
553 (defun undo-start ()
554 "Set `pending-undo-list' to the front of the undo list.
555 The next call to `undo-more' will undo the most recently made change."
556 (if (eq buffer-undo-list t)
557 (error "No undo information in this buffer"))
558 (setq pending-undo-list buffer-undo-list))
559
560 (defun undo-more (count)
561 "Undo back N undo-boundaries beyond what was already undone recently.
562 Call `undo-start' to get ready to undo recent changes,
563 then call `undo-more' one or more times to undo them."
564 (or pending-undo-list
565 (error "No further undo information"))
566 (setq pending-undo-list (primitive-undo count pending-undo-list)))
567
568 (defvar last-shell-command "")
569 (defvar last-shell-command-on-region "")
570
571 (defun shell-command (command &optional flag)
572 "Execute string COMMAND in inferior shell; display output, if any.
573 If COMMAND ends in ampersand, execute it asynchronously.
574
575 Optional second arg non-nil (prefix arg, if interactive)
576 means insert output in current buffer after point (leave mark after it).
577 This cannot be done asynchronously."
578 (interactive (list (read-string "Shell command: " last-shell-command)
579 current-prefix-arg))
580 (if flag
581 (progn (barf-if-buffer-read-only)
582 (push-mark)
583 ;; We do not use -f for csh; we will not support broken use of
584 ;; .cshrcs. Even the BSD csh manual says to use
585 ;; "if ($?prompt) exit" before things which are not useful
586 ;; non-interactively. Besides, if someone wants their other
587 ;; aliases for shell commands then they can still have them.
588 (call-process shell-file-name nil t nil
589 "-c" command)
590 (exchange-point-and-mark))
591 ;; Preserve the match data in case called from a program.
592 (let ((data (match-data)))
593 (unwind-protect
594 (if (string-match "[ \t]*&[ \t]*$" command)
595 ;; Command ending with ampersand means asynchronous.
596 (let ((buffer (get-buffer-create "*shell-command*"))
597 (directory default-directory)
598 proc)
599 ;; Remove the ampersand.
600 (setq command (substring command 0 (match-beginning 0)))
601 ;; If will kill a process, query first.
602 (setq proc (get-buffer-process buffer))
603 (if proc
604 (if (yes-or-no-p "A command is running. Kill it? ")
605 (kill-process proc)
606 (error "Shell command in progress")))
607 (save-excursion
608 (set-buffer buffer)
609 (erase-buffer)
610 (display-buffer buffer)
611 (setq default-directory directory)
612 (setq proc (start-process "Shell" buffer
613 shell-file-name "-c" command))
614 (setq mode-line-process '(": %s"))
615 (set-process-sentinel proc 'shell-command-sentinel)
616 (set-process-filter proc 'shell-command-filter)
617 ))
618 (shell-command-on-region (point) (point) command nil))
619 (store-match-data data)))))
620
621 ;; We have a sentinel to prevent insertion of a termination message
622 ;; in the buffer itself.
623 (defun shell-command-sentinel (process signal)
624 (if (memq (process-status process) '(exit signal))
625 (progn
626 (message "%s: %s."
627 (car (cdr (cdr (process-command process))))
628 (substring signal 0 -1))
629 (save-excursion
630 (set-buffer (process-buffer process))
631 (setq mode-line-process nil))
632 (delete-process process))))
633
634 (defun shell-command-filter (proc string)
635 ;; Do save-excursion by hand so that we can leave point numerically unchanged
636 ;; despite an insertion immediately after it.
637 (let* ((obuf (current-buffer))
638 (buffer (process-buffer proc))
639 opoint
640 (window (get-buffer-window buffer))
641 (pos (window-start window)))
642 (unwind-protect
643 (progn
644 (set-buffer buffer)
645 (setq opoint (point))
646 (goto-char (point-max))
647 (insert-before-markers string))
648 ;; insert-before-markers moved this marker: set it back.
649 (set-window-start window pos)
650 ;; Finish our save-excursion.
651 (goto-char opoint)
652 (set-buffer obuf))))
653
654 (defun shell-command-on-region (start end command &optional flag interactive)
655 "Execute string COMMAND in inferior shell with region as input.
656 Normally display output (if any) in temp buffer `*Shell Command Output*';
657 Prefix arg means replace the region with it.
658 Noninteractive args are START, END, COMMAND, FLAG.
659 Noninteractively FLAG means insert output in place of text from START to END,
660 and put point at the end, but don't alter the mark.
661
662 If the output is one line, it is displayed in the echo area,
663 but it is nonetheless available in buffer `*Shell Command Output*'
664 even though that buffer is not automatically displayed. If there is no output
665 or output is inserted in the current buffer then `*Shell Command Output*' is
666 deleted."
667 (interactive (list (region-beginning) (region-end)
668 (read-string "Shell command on region: "
669 last-shell-command-on-region)
670 current-prefix-arg
671 (prefix-numeric-value current-prefix-arg)))
672 (if flag
673 ;; Replace specified region with output from command.
674 (let ((swap (and interactive (< (point) (mark)))))
675 ;; Don't muck with mark
676 ;; unless called interactively.
677 (and interactive (push-mark))
678 (call-process-region start end shell-file-name t t nil
679 "-c" command)
680 (if (get-buffer "*Shell Command Output*")
681 (kill-buffer "*Shell Command Output*"))
682 (and interactive swap (exchange-point-and-mark)))
683 ;; No prefix argument: put the output in a temp buffer,
684 ;; replacing its entire contents.
685 (let ((buffer (get-buffer-create "*Shell Command Output*")))
686 (if (eq buffer (current-buffer))
687 ;; If the input is the same buffer as the output,
688 ;; delete everything but the specified region,
689 ;; then replace that region with the output.
690 (progn (delete-region end (point-max))
691 (delete-region (point-min) start)
692 (call-process-region (point-min) (point-max)
693 shell-file-name t t nil
694 "-c" command))
695 ;; Clear the output buffer, then run the command with output there.
696 (save-excursion
697 (set-buffer buffer)
698 (erase-buffer))
699 (call-process-region start end shell-file-name
700 nil buffer nil
701 "-c" command))
702 ;; Report the amount of output.
703 (let ((lines (save-excursion
704 (set-buffer buffer)
705 (if (= (buffer-size) 0)
706 0
707 (count-lines (point-min) (point-max))))))
708 (cond ((= lines 0)
709 (message "(Shell command completed with no output)")
710 (kill-buffer "*Shell Command Output*"))
711 ((= lines 1)
712 (message "%s"
713 (save-excursion
714 (set-buffer buffer)
715 (goto-char (point-min))
716 (buffer-substring (point)
717 (progn (end-of-line) (point))))))
718 (t
719 (set-window-start (display-buffer buffer) 1)))))))
720 \f
721 (defun universal-argument ()
722 "Begin a numeric argument for the following command.
723 Digits or minus sign following \\[universal-argument] make up the numeric argument.
724 \\[universal-argument] following the digits or minus sign ends the argument.
725 \\[universal-argument] without digits or minus sign provides 4 as argument.
726 Repeating \\[universal-argument] without digits or minus sign
727 multiplies the argument by 4 each time."
728 (interactive nil)
729 (let ((factor 4)
730 key)
731 ;; (describe-arg (list factor) 1)
732 (setq key (read-key-sequence nil t))
733 (while (equal (key-binding key) 'universal-argument)
734 (setq factor (* 4 factor))
735 ;; (describe-arg (list factor) 1)
736 (setq key (read-key-sequence nil t)))
737 (prefix-arg-internal key factor nil)))
738
739 (defun prefix-arg-internal (key factor value)
740 (let ((sign 1))
741 (if (and (numberp value) (< value 0))
742 (setq sign -1 value (- value)))
743 (if (eq value '-)
744 (setq sign -1 value nil))
745 ;; (describe-arg value sign)
746 (while (equal key "-")
747 (setq sign (- sign) factor nil)
748 ;; (describe-arg value sign)
749 (setq key (read-key-sequence nil t)))
750 (while (and (stringp key)
751 (= (length key) 1)
752 (not (string< key "0"))
753 (not (string< "9" key)))
754 (setq value (+ (* (if (numberp value) value 0) 10)
755 (- (aref key 0) ?0))
756 factor nil)
757 ;; (describe-arg value sign)
758 (setq key (read-key-sequence nil t)))
759 (setq prefix-arg
760 (cond (factor (list factor))
761 ((numberp value) (* value sign))
762 ((= sign -1) '-)))
763 ;; Calling universal-argument after digits
764 ;; terminates the argument but is ignored.
765 (if (eq (key-binding key) 'universal-argument)
766 (progn
767 (describe-arg value sign)
768 (setq key (read-key-sequence nil t))))
769 (if (= (length key) 1)
770 ;; Make sure self-insert-command finds the proper character;
771 ;; unread the character and let the command loop process it.
772 (setq unread-command-char (string-to-char key))
773 ;; We can't push back a longer string, so we'll emulate the
774 ;; command loop ourselves.
775 (command-execute (key-binding key)))))
776
777 (defun describe-arg (value sign)
778 (cond ((numberp value)
779 (message "Arg: %d" (* value sign)))
780 ((consp value)
781 (message "Arg: [%d]" (car value)))
782 ((< sign 0)
783 (message "Arg: -"))))
784
785 (defun digit-argument (arg)
786 "Part of the numeric argument for the next command.
787 \\[universal-argument] following digits or minus sign ends the argument."
788 (interactive "P")
789 (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
790 nil arg))
791
792 (defun negative-argument (arg)
793 "Begin a negative numeric argument for the next command.
794 \\[universal-argument] following digits or minus sign ends the argument."
795 (interactive "P")
796 (prefix-arg-internal "-" nil arg))
797 \f
798 (defun forward-to-indentation (arg)
799 "Move forward ARG lines and position at first nonblank character."
800 (interactive "p")
801 (forward-line arg)
802 (skip-chars-forward " \t"))
803
804 (defun backward-to-indentation (arg)
805 "Move backward ARG lines and position at first nonblank character."
806 (interactive "p")
807 (forward-line (- arg))
808 (skip-chars-forward " \t"))
809
810 (defun kill-line (&optional arg)
811 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
812 With prefix argument, kill that many lines from point.
813 Negative arguments kill lines backward.
814
815 When calling from a program, nil means \"no arg\",
816 a number counts as a prefix arg."
817 (interactive "P")
818 (kill-region (point)
819 ;; Don't shift point before doing the delete; that way,
820 ;; undo will record the right position of point.
821 (save-excursion
822 (if arg
823 (forward-line (prefix-numeric-value arg))
824 (if (eobp)
825 (signal 'end-of-buffer nil))
826 (if (looking-at "[ \t]*$")
827 (forward-line 1)
828 (end-of-line)))
829 (point))))
830 \f
831 ;;;; Window system cut and paste hooks.
832
833 (defvar interprogram-cut-function nil
834 "Function to call to make a killed region available to other programs.
835
836 Most window systems provide some sort of facility for cutting and
837 pasting text between the windows of different programs. On startup,
838 this variable is set to a function which emacs will call whenever text
839 is put in the kill ring to make the new kill available to other
840 programs.
841
842 The function takes one argument, TEXT, which is a string containing
843 the text which should be made available.")
844
845 (defvar interprogram-paste-function nil
846 "Function to call to get text cut from other programs.
847
848 Most window systems provide some sort of facility for cutting and
849 pasting text between the windows of different programs. On startup,
850 this variable is set to a function which emacs will call to obtain
851 text that other programs have provided for pasting.
852
853 The function should be called with no arguments. If the function
854 returns nil, then no other program has provided such text, and the top
855 of the Emacs kill ring should be used. If the function returns a
856 string, that string should be put in the kill ring as the latest kill.
857
858 Note that the function should return a string only if a program other
859 than Emacs has provided a string for pasting; if Emacs provided the
860 most recent string, the function should return nil. If it is
861 difficult to tell whether Emacs or some other program provided the
862 current string, it is probably good enough to return nil if the string
863 is equal (according to `string=') to the last text Emacs provided.")
864
865
866 \f
867 ;;;; The kill ring data structure.
868
869 (defvar kill-ring nil
870 "List of killed text sequences.
871 Since the kill ring is supposed to interact nicely with cut-and-paste
872 facilities offered by window systems, use of this variable should
873 interact nicely with `interprogram-cut-function' and
874 `interprogram-paste-function'. The functions `kill-new',
875 `kill-append', and `current-kill' are supposed to implement this
876 interaction; you may want to use them instead of manipulating the kill
877 ring directly.")
878
879 (defconst kill-ring-max 30
880 "*Maximum length of kill ring before oldest elements are thrown away.")
881
882 (defvar kill-ring-yank-pointer nil
883 "The tail of the kill ring whose car is the last thing yanked.")
884
885 (defun kill-new (string)
886 "Make STRING the latest kill in the kill ring.
887 Set the kill-ring-yank pointer to point to it.
888 If `interprogram-cut-function' is non-nil, apply it to STRING."
889 (setq kill-ring (cons string kill-ring))
890 (if (> (length kill-ring) kill-ring-max)
891 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))
892 (setq kill-ring-yank-pointer kill-ring)
893 (if interprogram-cut-function
894 (funcall interprogram-cut-function string)))
895
896 (defun kill-append (string before-p)
897 "Append STRING to the end of the latest kill in the kill ring.
898 If BEFORE-P is non-nil, prepend STRING to the kill.
899 If 'interprogram-cut-function' is set, pass the resulting kill to
900 it."
901 (setcar kill-ring
902 (if before-p
903 (concat string (car kill-ring))
904 (concat (car kill-ring) string)))
905 (if interprogram-cut-function
906 (funcall interprogram-cut-function (car kill-ring))))
907
908 (defun current-kill (n &optional do-not-move)
909 "Rotate the yanking point by N places, and then return that kill.
910 If N is zero, `interprogram-paste-function' is set, and calling it
911 returns a string, then that string is added to the front of the
912 kill ring and returned as the latest kill.
913 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
914 yanking point; just return the Nth kill forward."
915 (let ((interprogram-paste (and (= n 0)
916 interprogram-paste-function
917 (funcall interprogram-paste-function))))
918 (if interprogram-paste
919 (progn
920 ;; Disable the interprogram cut function when we add the new
921 ;; text to the kill ring, so Emacs doesn't try to own the
922 ;; selection, with identical text.
923 (let ((interprogram-cut-function nil))
924 (kill-new interprogram-paste))
925 interprogram-paste)
926 (or kill-ring (error "Kill ring is empty"))
927 (let* ((length (length kill-ring))
928 (ARGth-kill-element
929 (nthcdr (% (+ n (- length (length kill-ring-yank-pointer)))
930 length)
931 kill-ring)))
932 (or do-not-move
933 (setq kill-ring-yank-pointer ARGth-kill-element))
934 (car ARGth-kill-element)))))
935
936
937 \f
938 ;;;; Commands for manipulating the kill ring.
939
940 (defun kill-region (beg end)
941 "Kill between point and mark.
942 The text is deleted but saved in the kill ring.
943 The command \\[yank] can retrieve it from there.
944 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
945
946 This is the primitive for programs to kill text (as opposed to deleting it).
947 Supply two arguments, character numbers indicating the stretch of text
948 to be killed.
949 Any command that calls this function is a \"kill command\".
950 If the previous command was also a kill command,
951 the text killed this time appends to the text killed last time
952 to make one entry in the kill ring."
953 (interactive "r")
954 (cond
955 (buffer-read-only
956 (copy-region-as-kill beg end))
957 ((not (or (eq buffer-undo-list t)
958 (eq last-command 'kill-region)
959 (eq beg end)))
960 ;; Don't let the undo list be truncated before we can even access it.
961 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100)))
962 (delete-region beg end)
963 ;; Take the same string recorded for undo
964 ;; and put it in the kill-ring.
965 (kill-new (car (car buffer-undo-list)))
966 (setq this-command 'kill-region)))
967 (t
968 (copy-region-as-kill beg end)
969 (delete-region beg end))))
970
971 (defun copy-region-as-kill (beg end)
972 "Save the region as if killed, but don't kill it.
973 If `interprogram-cut-function' is non-nil, also save the text for a window
974 system cut and paste."
975 (interactive "r")
976 (if (eq last-command 'kill-region)
977 (kill-append (buffer-substring beg end) (< end beg))
978 (kill-new (buffer-substring beg end)))
979 (setq this-command 'kill-region)
980 nil)
981
982 (defun kill-ring-save (beg end)
983 "Save the region as if killed, but don't kill it."
984 (interactive "r")
985 (copy-region-as-kill beg end)
986 (if (interactive-p)
987 (save-excursion
988 (let ((other-end (if (= (point) beg) end beg)))
989 (if (pos-visible-in-window-p other-end (selected-window))
990 (progn
991 (goto-char other-end)
992 (sit-for 1))
993 (let* ((killed-text (current-kill 0))
994 (message-len (min (length killed-text) 40)))
995 (if (= (point) beg)
996 ;; Don't say "killed"; that is misleading.
997 (message "Saved text until \"%s\""
998 (substring killed-text (- message-len)))
999 (message "Saved text from \"%s\""
1000 (substring killed-text 0 message-len)))))))))
1001
1002 (defun append-next-kill ()
1003 "Cause following command, if it kills, to append to previous kill."
1004 (interactive)
1005 (if (interactive-p)
1006 (progn
1007 (setq this-command 'kill-region)
1008 (message "If the next command is a kill, it will append"))
1009 (setq last-command 'kill-region)))
1010
1011 (defun yank-pop (arg)
1012 "Replace just-yanked stretch of killed text with a different stretch.
1013 This command is allowed only immediately after a `yank' or a `yank-pop'.
1014 At such a time, the region contains a stretch of reinserted
1015 previously-killed text. `yank-pop' deletes that text and inserts in its
1016 place a different stretch of killed text.
1017
1018 With no argument, the previous kill is inserted.
1019 With argument N, insert the Nth previous kill.
1020 If N is negative, this is a more recent kill.
1021
1022 The sequence of kills wraps around, so that after the oldest one
1023 comes the newest one."
1024 (interactive "*p")
1025 (if (not (eq last-command 'yank))
1026 (error "Previous command was not a yank"))
1027 (setq this-command 'yank)
1028 (let ((before (< (point) (mark))))
1029 (delete-region (point) (mark))
1030 (set-mark (point))
1031 (insert (current-kill arg))
1032 (if before (exchange-point-and-mark))))
1033
1034 (defun yank (&optional arg)
1035 "Reinsert the last stretch of killed text.
1036 More precisely, reinsert the stretch of killed text most recently
1037 killed OR yanked. Put point at end, and set mark at beginning.
1038 With just C-u as argument, same but put point at beginning (and mark at end).
1039 With argument N, reinsert the Nth most recently killed stretch of killed
1040 text.
1041 See also the command \\[yank-pop]."
1042 (interactive "*P")
1043 (push-mark (point))
1044 (insert (current-kill (cond
1045 ((listp arg) 0)
1046 ((eq arg '-) -1)
1047 (t (1- arg)))))
1048 (if (consp arg)
1049 (exchange-point-and-mark)))
1050
1051 (defun rotate-yank-pointer (arg)
1052 "Rotate the yanking point in the kill ring.
1053 With argument, rotate that many kills forward (or backward, if negative)."
1054 (interactive "p")
1055 (current-kill arg))
1056
1057 \f
1058 (defun insert-buffer (buffer)
1059 "Insert after point the contents of BUFFER.
1060 Puts mark after the inserted text.
1061 BUFFER may be a buffer or a buffer name."
1062 (interactive (list (progn (barf-if-buffer-read-only)
1063 (read-buffer "Insert buffer: " (other-buffer) t))))
1064 (or (bufferp buffer)
1065 (setq buffer (get-buffer buffer)))
1066 (let (start end newmark)
1067 (save-excursion
1068 (save-excursion
1069 (set-buffer buffer)
1070 (setq start (point-min) end (point-max)))
1071 (insert-buffer-substring buffer start end)
1072 (setq newmark (point)))
1073 (push-mark newmark)))
1074
1075 (defun append-to-buffer (buffer start end)
1076 "Append to specified buffer the text of the region.
1077 It is inserted into that buffer before its point.
1078
1079 When calling from a program, give three arguments:
1080 BUFFER (or buffer name), START and END.
1081 START and END specify the portion of the current buffer to be copied."
1082 (interactive
1083 (list (read-buffer "Append to buffer: " (other-buffer nil t) t)))
1084 (let ((oldbuf (current-buffer)))
1085 (save-excursion
1086 (set-buffer (get-buffer-create buffer))
1087 (insert-buffer-substring oldbuf start end))))
1088
1089 (defun prepend-to-buffer (buffer start end)
1090 "Prepend to specified buffer the text of the region.
1091 It is inserted into that buffer after its point.
1092
1093 When calling from a program, give three arguments:
1094 BUFFER (or buffer name), START and END.
1095 START and END specify the portion of the current buffer to be copied."
1096 (interactive "BPrepend to buffer: \nr")
1097 (let ((oldbuf (current-buffer)))
1098 (save-excursion
1099 (set-buffer (get-buffer-create buffer))
1100 (save-excursion
1101 (insert-buffer-substring oldbuf start end)))))
1102
1103 (defun copy-to-buffer (buffer start end)
1104 "Copy to specified buffer the text of the region.
1105 It is inserted into that buffer, replacing existing text there.
1106
1107 When calling from a program, give three arguments:
1108 BUFFER (or buffer name), START and END.
1109 START and END specify the portion of the current buffer to be copied."
1110 (interactive "BCopy to buffer: \nr")
1111 (let ((oldbuf (current-buffer)))
1112 (save-excursion
1113 (set-buffer (get-buffer-create buffer))
1114 (erase-buffer)
1115 (save-excursion
1116 (insert-buffer-substring oldbuf start end)))))
1117 \f
1118 (defun mark ()
1119 "Return this buffer's mark value as integer, or nil if no mark.
1120 If you are using this in an editing command, you are most likely making
1121 a mistake; see the documentation of `set-mark'."
1122 (marker-position (mark-marker)))
1123
1124 (defun set-mark (pos)
1125 "Set this buffer's mark to POS. Don't use this function!
1126 That is to say, don't use this function unless you want
1127 the user to see that the mark has moved, and you want the previous
1128 mark position to be lost.
1129
1130 Normally, when a new mark is set, the old one should go on the stack.
1131 This is why most applications should use push-mark, not set-mark.
1132
1133 Novice Emacs Lisp programmers often try to use the mark for the wrong
1134 purposes. The mark saves a location for the user's convenience.
1135 Most editing commands should not alter the mark.
1136 To remember a location for internal use in the Lisp program,
1137 store it in a Lisp variable. Example:
1138
1139 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1140
1141 (set-marker (mark-marker) pos (current-buffer)))
1142
1143 (defvar mark-ring nil
1144 "The list of saved former marks of the current buffer,
1145 most recent first.")
1146 (make-variable-buffer-local 'mark-ring)
1147
1148 (defconst mark-ring-max 16
1149 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1150
1151 (defun set-mark-command (arg)
1152 "Set mark at where point is, or jump to mark.
1153 With no prefix argument, set mark, and push previous mark on mark ring.
1154 With argument, jump to mark, and pop into mark off the mark ring.
1155
1156 Novice Emacs Lisp programmers often try to use the mark for the wrong
1157 purposes. See the documentation of `set-mark' for more information."
1158 (interactive "P")
1159 (if (null arg)
1160 (push-mark)
1161 (if (null (mark))
1162 (error "No mark set in this buffer")
1163 (goto-char (mark))
1164 (pop-mark))))
1165
1166 (defun push-mark (&optional location nomsg)
1167 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1168 Displays \"Mark set\" unless the optional second arg NOMSG is non-nil.
1169
1170 Novice Emacs Lisp programmers often try to use the mark for the wrong
1171 purposes. See the documentation of `set-mark' for more information."
1172 (if (null (mark))
1173 nil
1174 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1175 (if (> (length mark-ring) mark-ring-max)
1176 (progn
1177 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1178 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1179 (set-mark (or location (point)))
1180 (or nomsg executing-macro (> (minibuffer-depth) 0)
1181 (message "Mark set"))
1182 nil)
1183
1184 (defun pop-mark ()
1185 "Pop off mark ring into the buffer's actual mark.
1186 Does not set point. Does nothing if mark ring is empty."
1187 (if mark-ring
1188 (progn
1189 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1190 (set-mark (+ 0 (car mark-ring)))
1191 (move-marker (car mark-ring) nil)
1192 (if (null (mark)) (ding))
1193 (setq mark-ring (cdr mark-ring)))))
1194
1195 (fset 'exchange-dot-and-mark 'exchange-point-and-mark)
1196 (defun exchange-point-and-mark ()
1197 "Put the mark where point is now, and point where the mark is now."
1198 (interactive nil)
1199 (let ((omark (mark)))
1200 (if (null omark)
1201 (error "No mark set in this buffer"))
1202 (set-mark (point))
1203 (goto-char omark)
1204 nil))
1205 \f
1206 (defun next-line (arg)
1207 "Move cursor vertically down ARG lines.
1208 If there is no character in the target line exactly under the current column,
1209 the cursor is positioned after the character in that line which spans this
1210 column, or at the end of the line if it is not long enough.
1211 If there is no line in the buffer after this one,
1212 a newline character is inserted to create a line
1213 and the cursor moves to that line.
1214
1215 The command \\[set-goal-column] can be used to create
1216 a semipermanent goal column to which this command always moves.
1217 Then it does not try to move vertically. This goal column is stored
1218 in `goal-column', which is nil when there is none.
1219
1220 If you are thinking of using this in a Lisp program, consider
1221 using `forward-line' instead. It is usually easier to use
1222 and more reliable (no dependence on goal column, etc.)."
1223 (interactive "p")
1224 (if (= arg 1)
1225 (let ((opoint (point)))
1226 (forward-line 1)
1227 (if (or (= opoint (point))
1228 (not (eq (preceding-char) ?\n)))
1229 (insert ?\n)
1230 (goto-char opoint)
1231 (line-move arg)))
1232 (line-move arg))
1233 nil)
1234
1235 (defun previous-line (arg)
1236 "Move cursor vertically up ARG lines.
1237 If there is no character in the target line exactly over the current column,
1238 the cursor is positioned after the character in that line which spans this
1239 column, or at the end of the line if it is not long enough.
1240
1241 The command \\[set-goal-column] can be used to create
1242 a semipermanent goal column to which this command always moves.
1243 Then it does not try to move vertically.
1244
1245 If you are thinking of using this in a Lisp program, consider using
1246 `forward-line' with a negative argument instead. It is usually easier
1247 to use and more reliable (no dependence on goal column, etc.)."
1248 (interactive "p")
1249 (line-move (- arg))
1250 nil)
1251
1252 (defconst track-eol nil
1253 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1254 This means moving to the end of each line moved onto.
1255 The beginning of a blank line does not count as the end of a line.")
1256
1257 (defvar goal-column nil
1258 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1259 (make-variable-buffer-local 'goal-column)
1260
1261 (defvar temporary-goal-column 0
1262 "Current goal column for vertical motion.
1263 It is the column where point was
1264 at the start of current run of vertical motion commands.
1265 When the `track-eol' feature is doing its job, the value is 9999.")
1266
1267 (defun line-move (arg)
1268 (if (not (or (eq last-command 'next-line)
1269 (eq last-command 'previous-line)))
1270 (setq temporary-goal-column
1271 (if (and track-eol (eolp)
1272 ;; Don't count beg of empty line as end of line
1273 ;; unless we just did explicit end-of-line.
1274 (or (not (bolp)) (eq last-command 'end-of-line)))
1275 9999
1276 (current-column))))
1277 (if (not (integerp selective-display))
1278 (forward-line arg)
1279 ;; Move by arg lines, but ignore invisible ones.
1280 (while (> arg 0)
1281 (vertical-motion 1)
1282 (forward-char -1)
1283 (forward-line 1)
1284 (setq arg (1- arg)))
1285 (while (< arg 0)
1286 (vertical-motion -1)
1287 (beginning-of-line)
1288 (setq arg (1+ arg))))
1289 (move-to-column (or goal-column temporary-goal-column))
1290 nil)
1291
1292
1293 (defun set-goal-column (arg)
1294 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1295 Those commands will move to this position in the line moved to
1296 rather than trying to keep the same horizontal position.
1297 With a non-nil argument, clears out the goal column
1298 so that \\[next-line] and \\[previous-line] resume vertical motion.
1299 The goal column is stored in the variable `goal-column'."
1300 (interactive "P")
1301 (if arg
1302 (progn
1303 (setq goal-column nil)
1304 (message "No goal column"))
1305 (setq goal-column (current-column))
1306 (message (substitute-command-keys
1307 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1308 goal-column))
1309 nil)
1310 \f
1311 (defun transpose-chars (arg)
1312 "Interchange characters around point, moving forward one character.
1313 With prefix arg ARG, effect is to take character before point
1314 and drag it forward past ARG other characters (backward if ARG negative).
1315 If no argument and at end of line, the previous two chars are exchanged."
1316 (interactive "*P")
1317 (and (null arg) (eolp) (forward-char -1))
1318 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1319
1320 (defun transpose-words (arg)
1321 "Interchange words around point, leaving point at end of them.
1322 With prefix arg ARG, effect is to take word before or around point
1323 and drag it forward past ARG other words (backward if ARG negative).
1324 If ARG is zero, the words around or after point and around or after mark
1325 are interchanged."
1326 (interactive "*p")
1327 (transpose-subr 'forward-word arg))
1328
1329 (defun transpose-sexps (arg)
1330 "Like \\[transpose-words] but applies to sexps.
1331 Does not work on a sexp that point is in the middle of
1332 if it is a list or string."
1333 (interactive "*p")
1334 (transpose-subr 'forward-sexp arg))
1335
1336 (defun transpose-lines (arg)
1337 "Exchange current line and previous line, leaving point after both.
1338 With argument ARG, takes previous line and moves it past ARG lines.
1339 With argument 0, interchanges line point is in with line mark is in."
1340 (interactive "*p")
1341 (transpose-subr (function
1342 (lambda (arg)
1343 (if (= arg 1)
1344 (progn
1345 ;; Move forward over a line,
1346 ;; but create a newline if none exists yet.
1347 (end-of-line)
1348 (if (eobp)
1349 (newline)
1350 (forward-char 1)))
1351 (forward-line arg))))
1352 arg))
1353
1354 (defun transpose-subr (mover arg)
1355 (let (start1 end1 start2 end2)
1356 (if (= arg 0)
1357 (progn
1358 (save-excursion
1359 (funcall mover 1)
1360 (setq end2 (point))
1361 (funcall mover -1)
1362 (setq start2 (point))
1363 (goto-char (mark))
1364 (funcall mover 1)
1365 (setq end1 (point))
1366 (funcall mover -1)
1367 (setq start1 (point))
1368 (transpose-subr-1))
1369 (exchange-point-and-mark)))
1370 (while (> arg 0)
1371 (funcall mover -1)
1372 (setq start1 (point))
1373 (funcall mover 1)
1374 (setq end1 (point))
1375 (funcall mover 1)
1376 (setq end2 (point))
1377 (funcall mover -1)
1378 (setq start2 (point))
1379 (transpose-subr-1)
1380 (goto-char end2)
1381 (setq arg (1- arg)))
1382 (while (< arg 0)
1383 (funcall mover -1)
1384 (setq start2 (point))
1385 (funcall mover -1)
1386 (setq start1 (point))
1387 (funcall mover 1)
1388 (setq end1 (point))
1389 (funcall mover 1)
1390 (setq end2 (point))
1391 (transpose-subr-1)
1392 (setq arg (1+ arg)))))
1393
1394 (defun transpose-subr-1 ()
1395 (if (> (min end1 end2) (max start1 start2))
1396 (error "Don't have two things to transpose"))
1397 (let ((word1 (buffer-substring start1 end1))
1398 (word2 (buffer-substring start2 end2)))
1399 (delete-region start2 end2)
1400 (goto-char start2)
1401 (insert word1)
1402 (goto-char (if (< start1 start2) start1
1403 (+ start1 (- (length word1) (length word2)))))
1404 (delete-char (length word1))
1405 (insert word2)))
1406 \f
1407 (defconst comment-column 32
1408 "*Column to indent right-margin comments to.
1409 Setting this variable automatically makes it local to the current buffer.")
1410 (make-variable-buffer-local 'comment-column)
1411
1412 (defconst comment-start nil
1413 "*String to insert to start a new comment, or nil if no comment syntax defined.")
1414
1415 (defconst comment-start-skip nil
1416 "*Regexp to match the start of a comment plus everything up to its body.
1417 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
1418 at the place matched by the close of the first pair.")
1419
1420 (defconst comment-end ""
1421 "*String to insert to end a new comment.
1422 Should be an empty string if comments are terminated by end-of-line.")
1423
1424 (defconst comment-indent-hook
1425 '(lambda () comment-column)
1426 "Function to compute desired indentation for a comment.
1427 This function is called with no args with point at the beginning of
1428 the comment's starting delimiter.")
1429
1430 (defun indent-for-comment ()
1431 "Indent this line's comment to comment column, or insert an empty comment."
1432 (interactive "*")
1433 (beginning-of-line 1)
1434 (if (null comment-start)
1435 (error "No comment syntax defined")
1436 (let* ((eolpos (save-excursion (end-of-line) (point)))
1437 cpos indent begpos)
1438 (if (re-search-forward comment-start-skip eolpos 'move)
1439 (progn (setq cpos (point-marker))
1440 ;; Find the start of the comment delimiter.
1441 ;; If there were paren-pairs in comment-start-skip,
1442 ;; position at the end of the first pair.
1443 (if (match-end 1)
1444 (goto-char (match-end 1))
1445 ;; If comment-start-skip matched a string with internal
1446 ;; whitespace (not final whitespace) then the delimiter
1447 ;; start at the end of that whitespace.
1448 ;; Otherwise, it starts at the beginning of what was matched.
1449 (skip-chars-backward " \t" (match-beginning 0))
1450 (skip-chars-backward "^ \t" (match-beginning 0)))))
1451 (setq begpos (point))
1452 ;; Compute desired indent.
1453 (if (= (current-column)
1454 (setq indent (funcall comment-indent-hook)))
1455 (goto-char begpos)
1456 ;; If that's different from current, change it.
1457 (skip-chars-backward " \t")
1458 (delete-region (point) begpos)
1459 (indent-to indent))
1460 ;; An existing comment?
1461 (if cpos
1462 (progn (goto-char cpos)
1463 (set-marker cpos nil))
1464 ;; No, insert one.
1465 (insert comment-start)
1466 (save-excursion
1467 (insert comment-end))))))
1468
1469 (defun set-comment-column (arg)
1470 "Set the comment column based on point.
1471 With no arg, set the comment column to the current column.
1472 With just minus as arg, kill any comment on this line.
1473 With any other arg, set comment column to indentation of the previous comment
1474 and then align or create a comment on this line at that column."
1475 (interactive "P")
1476 (if (eq arg '-)
1477 (kill-comment nil)
1478 (if arg
1479 (progn
1480 (save-excursion
1481 (beginning-of-line)
1482 (re-search-backward comment-start-skip)
1483 (beginning-of-line)
1484 (re-search-forward comment-start-skip)
1485 (goto-char (match-beginning 0))
1486 (setq comment-column (current-column))
1487 (message "Comment column set to %d" comment-column))
1488 (indent-for-comment))
1489 (setq comment-column (current-column))
1490 (message "Comment column set to %d" comment-column))))
1491
1492 (defun kill-comment (arg)
1493 "Kill the comment on this line, if any.
1494 With argument, kill comments on that many lines starting with this one."
1495 ;; this function loses in a lot of situations. it incorrectly recognises
1496 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
1497 ;; with multi-line comments, can kill extra whitespace if comment wasn't
1498 ;; through end-of-line, et cetera.
1499 (interactive "P")
1500 (or comment-start-skip (error "No comment syntax defined"))
1501 (let ((count (prefix-numeric-value arg)) endc)
1502 (while (> count 0)
1503 (save-excursion
1504 (end-of-line)
1505 (setq endc (point))
1506 (beginning-of-line)
1507 (and (string< "" comment-end)
1508 (setq endc
1509 (progn
1510 (re-search-forward (regexp-quote comment-end) endc 'move)
1511 (skip-chars-forward " \t")
1512 (point))))
1513 (beginning-of-line)
1514 (if (re-search-forward comment-start-skip endc t)
1515 (progn
1516 (goto-char (match-beginning 0))
1517 (skip-chars-backward " \t")
1518 (kill-region (point) endc)
1519 ;; to catch comments a line beginnings
1520 (indent-according-to-mode))))
1521 (if arg (forward-line 1))
1522 (setq count (1- count)))))
1523
1524 (defun comment-region (beg end &optional arg)
1525 "Comment the region; third arg numeric means use ARG comment characters.
1526 If ARG is negative, delete that many comment characters instead.
1527 Comments are terminated on each line, even for syntax in which newline does
1528 not end the comment. Blank lines do not get comments."
1529 ;; if someone wants it to only put a comment-start at the beginning and
1530 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
1531 ;; is easy enough. No option is made here for other than commenting
1532 ;; every line.
1533 (interactive "r\np")
1534 (or comment-start (error "No comment syntax is defined"))
1535 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
1536 (save-excursion
1537 (save-restriction
1538 (let ((cs comment-start) (ce comment-end))
1539 (cond ((not arg) (setq arg 1))
1540 ((> arg 1)
1541 (while (> (setq arg (1- arg)) 0)
1542 (setq cs (concat cs comment-start)
1543 ce (concat ce comment-end)))))
1544 (narrow-to-region beg end)
1545 (goto-char beg)
1546 (while (not (eobp))
1547 (if (< arg 0)
1548 (let ((count arg))
1549 (while (and (> 1 (setq count (1+ count)))
1550 (looking-at (regexp-quote cs)))
1551 (delete-char (length cs)))
1552 (if (string= "" ce) ()
1553 (setq count arg)
1554 (while (> 1 (setq count (1+ count)))
1555 (end-of-line)
1556 ;; this is questionable if comment-end ends in whitespace
1557 ;; that is pretty brain-damaged though
1558 (skip-chars-backward " \t")
1559 (backward-char (length ce))
1560 (if (looking-at (regexp-quote ce))
1561 (delete-char (length ce)))))
1562 (forward-line 1))
1563 (if (looking-at "[ \t]*$") ()
1564 (insert cs)
1565 (if (string= "" ce) ()
1566 (end-of-line)
1567 (insert ce)))
1568 (search-forward "\n" nil 'move)))))))
1569 \f
1570 (defun backward-word (arg)
1571 "Move backward until encountering the end of a word.
1572 With argument, do this that many times.
1573 In programs, it is faster to call `forward-word' with negative arg."
1574 (interactive "p")
1575 (forward-word (- arg)))
1576
1577 (defun mark-word (arg)
1578 "Set mark arg words away from point."
1579 (interactive "p")
1580 (push-mark
1581 (save-excursion
1582 (forward-word arg)
1583 (point))))
1584
1585 (defun kill-word (arg)
1586 "Kill characters forward until encountering the end of a word.
1587 With argument, do this that many times."
1588 (interactive "p")
1589 (kill-region (point) (save-excursion (forward-word arg) (point))))
1590
1591 (defun backward-kill-word (arg)
1592 "Kill characters backward until encountering the end of a word.
1593 With argument, do this that many times."
1594 (interactive "p")
1595 (kill-word (- arg)))
1596 \f
1597 (defconst fill-prefix nil
1598 "*String for filling to insert at front of new line, or nil for none.
1599 Setting this variable automatically makes it local to the current buffer.")
1600 (make-variable-buffer-local 'fill-prefix)
1601
1602 (defconst auto-fill-inhibit-regexp nil
1603 "*Regexp to match lines which should not be auto-filled.")
1604
1605 (defun do-auto-fill ()
1606 (let (give-up)
1607 (or (and auto-fill-inhibit-regexp
1608 (save-excursion (beginning-of-line)
1609 (looking-at auto-fill-inhibit-regexp)))
1610 (while (and (not give-up) (> (current-column) fill-column))
1611 (let ((fill-point
1612 (let ((opoint (point)))
1613 (save-excursion
1614 (move-to-column (1+ fill-column))
1615 (skip-chars-backward "^ \t\n")
1616 (if (bolp)
1617 (re-search-forward "[ \t]" opoint t))
1618 (skip-chars-backward " \t")
1619 (point)))))
1620 ;; If there is a space on the line before fill-point,
1621 ;; and nonspaces precede it, break the line there.
1622 (if (save-excursion
1623 (goto-char fill-point)
1624 (not (bolp)))
1625 ;; If point is at the fill-point, do not `save-excursion'.
1626 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
1627 ;; point will end up before it rather than after it.
1628 (if (save-excursion
1629 (skip-chars-backward " \t")
1630 (= (point) fill-point))
1631 (indent-new-comment-line)
1632 (save-excursion
1633 (goto-char fill-point)
1634 (indent-new-comment-line)))
1635 ;; No place to break => stop trying.
1636 (setq give-up t)))))))
1637
1638 (defconst comment-multi-line nil
1639 "*Non-nil means \\[indent-new-comment-line] should continue same comment
1640 on new line, with no new terminator or starter.
1641 This is obsolete because you might as well use \\[newline-and-indent].")
1642
1643 (defun indent-new-comment-line ()
1644 "Break line at point and indent, continuing comment if presently within one.
1645 The body of the continued comment is indented under the previous comment line.
1646
1647 This command is intended for styles where you write a comment per line,
1648 starting a new comment (and terminating it if necessary) on each line.
1649 If you want to continue one comment across several lines, use \\[newline-and-indent]."
1650 (interactive "*")
1651 (let (comcol comstart)
1652 (skip-chars-backward " \t")
1653 (delete-region (point)
1654 (progn (skip-chars-forward " \t")
1655 (point)))
1656 (insert ?\n)
1657 (if (not comment-multi-line)
1658 (save-excursion
1659 (if (and comment-start-skip
1660 (let ((opoint (point)))
1661 (forward-line -1)
1662 (re-search-forward comment-start-skip opoint t)))
1663 ;; The old line is a comment.
1664 ;; Set WIN to the pos of the comment-start.
1665 ;; But if the comment is empty, look at preceding lines
1666 ;; to find one that has a nonempty comment.
1667 (let ((win (match-beginning 0)))
1668 (while (and (eolp) (not (bobp))
1669 (let (opoint)
1670 (beginning-of-line)
1671 (setq opoint (point))
1672 (forward-line -1)
1673 (re-search-forward comment-start-skip opoint t)))
1674 (setq win (match-beginning 0)))
1675 ;; Indent this line like what we found.
1676 (goto-char win)
1677 (setq comcol (current-column))
1678 (setq comstart (buffer-substring (point) (match-end 0)))))))
1679 (if comcol
1680 (let ((comment-column comcol)
1681 (comment-start comstart)
1682 (comment-end comment-end))
1683 (and comment-end (not (equal comment-end ""))
1684 ; (if (not comment-multi-line)
1685 (progn
1686 (forward-char -1)
1687 (insert comment-end)
1688 (forward-char 1))
1689 ; (setq comment-column (+ comment-column (length comment-start))
1690 ; comment-start "")
1691 ; )
1692 )
1693 (if (not (eolp))
1694 (setq comment-end ""))
1695 (insert ?\n)
1696 (forward-char -1)
1697 (indent-for-comment)
1698 (save-excursion
1699 ;; Make sure we delete the newline inserted above.
1700 (end-of-line)
1701 (delete-char 1)))
1702 (if fill-prefix
1703 (insert fill-prefix)
1704 (indent-according-to-mode)))))
1705
1706 (defun auto-fill-mode (&optional arg)
1707 "Toggle auto-fill mode.
1708 With arg, turn auto-fill mode on if and only if arg is positive.
1709 In auto-fill mode, inserting a space at a column beyond fill-column
1710 automatically breaks the line at a previous space."
1711 (interactive "P")
1712 (prog1 (setq auto-fill-function
1713 (if (if (null arg)
1714 (not auto-fill-function)
1715 (> (prefix-numeric-value arg) 0))
1716 'do-auto-fill
1717 nil))
1718 ;; update mode-line
1719 (set-buffer-modified-p (buffer-modified-p))))
1720
1721 (defun turn-on-auto-fill ()
1722 "Unconditionally turn on Auto Fill mode."
1723 (auto-fill-mode 1))
1724
1725 (defun set-fill-column (arg)
1726 "Set `fill-column' to current column, or to argument if given.
1727 The variable `fill-column' has a separate value for each buffer."
1728 (interactive "P")
1729 (setq fill-column (if (integerp arg) arg (current-column)))
1730 (message "fill-column set to %d" fill-column))
1731 \f
1732 (defun set-selective-display (arg)
1733 "Set `selective-display' to ARG; clear it if no arg.
1734 When the value of `selective-display' is a number > 0,
1735 lines whose indentation is >= that value are not displayed.
1736 The variable `selective-display' has a separate value for each buffer."
1737 (interactive "P")
1738 (if (eq selective-display t)
1739 (error "selective-display already in use for marked lines"))
1740 (let ((current-vpos
1741 (save-restriction
1742 (narrow-to-region (point-min) (point))
1743 (goto-char (window-start))
1744 (vertical-motion (window-height)))))
1745 (setq selective-display
1746 (and arg (prefix-numeric-value arg)))
1747 (recenter current-vpos))
1748 (set-window-start (selected-window) (window-start (selected-window)))
1749 (princ "selective-display set to " t)
1750 (prin1 selective-display t)
1751 (princ "." t))
1752
1753 (defun overwrite-mode (arg)
1754 "Toggle overwrite mode.
1755 With arg, turn overwrite mode on iff arg is positive.
1756 In overwrite mode, printing characters typed in replace existing text
1757 on a one-for-one basis, rather than pushing it to the right."
1758 (interactive "P")
1759 (setq overwrite-mode
1760 (if (null arg) (not overwrite-mode)
1761 (> (prefix-numeric-value arg) 0)))
1762 (set-buffer-modified-p (buffer-modified-p))) ;No-op, but updates mode line.
1763 \f
1764 (defvar blink-matching-paren t
1765 "*Non-nil means show matching open-paren when close-paren is inserted.")
1766
1767 (defconst blink-matching-paren-distance 4000
1768 "*If non-nil, is maximum distance to search for matching open-paren
1769 when close-paren is inserted.")
1770
1771 (defun blink-matching-open ()
1772 "Move cursor momentarily to the beginning of the sexp before point."
1773 (interactive)
1774 (and (> (point) (1+ (point-min)))
1775 (/= (char-syntax (char-after (- (point) 2))) ?\\ )
1776 blink-matching-paren
1777 (let* ((oldpos (point))
1778 (blinkpos)
1779 (mismatch))
1780 (save-excursion
1781 (save-restriction
1782 (if blink-matching-paren-distance
1783 (narrow-to-region (max (point-min)
1784 (- (point) blink-matching-paren-distance))
1785 oldpos))
1786 (condition-case ()
1787 (setq blinkpos (scan-sexps oldpos -1))
1788 (error nil)))
1789 (and blinkpos (/= (char-syntax (char-after blinkpos))
1790 ?\$)
1791 (setq mismatch
1792 (/= (char-after (1- oldpos))
1793 (logand (lsh (aref (syntax-table)
1794 (char-after blinkpos))
1795 -8)
1796 255))))
1797 (if mismatch (setq blinkpos nil))
1798 (if blinkpos
1799 (progn
1800 (goto-char blinkpos)
1801 (if (pos-visible-in-window-p)
1802 (sit-for 1)
1803 (goto-char blinkpos)
1804 (message
1805 "Matches %s"
1806 (if (save-excursion
1807 (skip-chars-backward " \t")
1808 (not (bolp)))
1809 (buffer-substring (progn (beginning-of-line) (point))
1810 (1+ blinkpos))
1811 (buffer-substring blinkpos
1812 (progn
1813 (forward-char 1)
1814 (skip-chars-forward "\n \t")
1815 (end-of-line)
1816 (point)))))))
1817 (cond (mismatch
1818 (message "Mismatched parentheses"))
1819 ((not blink-matching-paren-distance)
1820 (message "Unmatched parenthesis"))))))))
1821
1822 ;Turned off because it makes dbx bomb out.
1823 (setq blink-paren-function 'blink-matching-open)
1824
1825 ; this is just something for the luser to see in a keymap -- this is not
1826 ; how quitting works normally!
1827 (defun keyboard-quit ()
1828 "Signal a quit condition."
1829 (interactive)
1830 (signal 'quit nil))
1831
1832 (define-key global-map "\C-g" 'keyboard-quit)
1833 \f
1834 (defun set-variable (var val)
1835 "Set VARIABLE to VALUE. VALUE is a Lisp object.
1836 When using this interactively, supply a Lisp expression for VALUE.
1837 If you want VALUE to be a string, you must surround it with doublequotes.
1838
1839 If VARIABLE has a `variable-interactive' property, that is used as if
1840 it were the arg to `interactive' (which see) to interactively read the value."
1841 (interactive
1842 (let* ((var (read-variable "Set variable: "))
1843 (minibuffer-help-form
1844 '(funcall myhelp))
1845 (myhelp
1846 (function
1847 (lambda ()
1848 (with-output-to-temp-buffer "*Help*"
1849 (prin1 var)
1850 (princ "\nDocumentation:\n")
1851 (princ (substring (documentation-property var 'variable-documentation)
1852 1))
1853 (if (boundp var)
1854 (let ((print-length 20))
1855 (princ "\n\nCurrent value: ")
1856 (prin1 (symbol-value var))))
1857 nil)))))
1858 (list var
1859 (let ((prop (get var 'variable-interactive)))
1860 (if prop
1861 ;; Use VAR's `variable-interactive' property
1862 ;; as an interactive spec for prompting.
1863 (call-interactively (list 'lambda '(arg)
1864 (list 'interactive prop)
1865 'arg))
1866 (eval-minibuffer (format "Set %s to value: " var)))))))
1867 (set var val))
1868
1869 ;;; simple.el ends here