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