Fix doc strings and error message syntax.
[emacs.git] / lisp / simple.el
blobbf99a38a11ae0d7d1537e36afcdb33c4415a1fde
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
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 ;;; Commentary:
23 ;; A grab-bag of basic Emacs commands not specifically related to some
24 ;; major mode or to file-handling.
26 ;;; Code:
28 (defun open-line (arg)
29 "Insert a newline and leave point before it.
30 If there is a fill prefix, insert the fill prefix on the new line
31 if the line would have been empty.
32 With arg N, insert N newlines."
33 (interactive "*p")
34 (let* ((do-fill-prefix (and fill-prefix (bolp)))
35 (flag (and (null do-fill-prefix) (bolp) (not (bobp)))))
36 ;; If this is a simple case, and we are at the beginning of a line,
37 ;; actually insert the newline *before* the preceding newline
38 ;; instead of after. That makes better display behavior.
39 (if flag
40 (progn
41 ;; If undo is enabled, don't let this hack be visible:
42 ;; record the real value of point as the place to move back to
43 ;; if we undo this insert.
44 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
45 (setq buffer-undo-list (cons (point) buffer-undo-list)))
46 (forward-char -1)))
47 (while (> arg 0)
48 (save-excursion
49 (insert ?\n))
50 (if do-fill-prefix (insert fill-prefix))
51 (setq arg (1- arg)))
52 (if flag (forward-char 1))))
54 (defun split-line ()
55 "Split current line, moving portion beyond point vertically down."
56 (interactive "*")
57 (skip-chars-forward " \t")
58 (let ((col (current-column))
59 (pos (point)))
60 (insert ?\n)
61 (indent-to col 0)
62 (goto-char pos)))
64 (defun quoted-insert (arg)
65 "Read next input character and insert it.
66 This is useful for inserting control characters.
67 You may also type up to 3 octal digits, to insert a character with that code.
69 In overwrite mode, this function inserts the character anyway, and
70 does not handle octal digits specially. This means that if you use
71 overwrite as your normal editing mode, you can use this function to
72 insert characters when necessary.
74 In binary overwrite mode, this function does overwrite, and octal
75 digits are interpreted as a character code. This is supposed to make
76 this function useful in editing binary files."
77 (interactive "*p")
78 (let ((char (if (or (not overwrite-mode)
79 (eq overwrite-mode 'overwrite-mode-binary))
80 (read-quoted-char)
81 (read-char))))
82 (if (eq overwrite-mode 'overwrite-mode-binary)
83 (delete-char arg))
84 (insert-char char arg)))
86 (defun delete-indentation (&optional arg)
87 "Join this line to previous and fix up whitespace at join.
88 If there is a fill prefix, delete it from the beginning of this line.
89 With argument, join this line to following line."
90 (interactive "*P")
91 (beginning-of-line)
92 (if arg (forward-line 1))
93 (if (eq (preceding-char) ?\n)
94 (progn
95 (delete-region (point) (1- (point)))
96 ;; If the second line started with the fill prefix,
97 ;; delete the prefix.
98 (if (and fill-prefix
99 (<= (+ (point) (length fill-prefix)) (point-max))
100 (string= fill-prefix
101 (buffer-substring (point)
102 (+ (point) (length fill-prefix)))))
103 (delete-region (point) (+ (point) (length fill-prefix))))
104 (fixup-whitespace))))
106 (defun fixup-whitespace ()
107 "Fixup white space between objects around point.
108 Leave one space or none, according to the context."
109 (interactive "*")
110 (save-excursion
111 (delete-horizontal-space)
112 (if (or (looking-at "^\\|\\s)")
113 (save-excursion (forward-char -1)
114 (looking-at "$\\|\\s(\\|\\s'")))
116 (insert ?\ ))))
118 (defun delete-horizontal-space ()
119 "Delete all spaces and tabs around point."
120 (interactive "*")
121 (skip-chars-backward " \t")
122 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
124 (defun just-one-space ()
125 "Delete all spaces and tabs around point, leaving one space."
126 (interactive "*")
127 (skip-chars-backward " \t")
128 (if (= (following-char) ? )
129 (forward-char 1)
130 (insert ? ))
131 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
133 (defun delete-blank-lines ()
134 "On blank line, delete all surrounding blank lines, leaving just one.
135 On isolated blank line, delete that one.
136 On nonblank line, delete all blank lines that follow it."
137 (interactive "*")
138 (let (thisblank singleblank)
139 (save-excursion
140 (beginning-of-line)
141 (setq thisblank (looking-at "[ \t]*$"))
142 ;; Set singleblank if there is just one blank line here.
143 (setq singleblank
144 (and thisblank
145 (not (looking-at "[ \t]*\n[ \t]*$"))
146 (or (bobp)
147 (progn (forward-line -1)
148 (not (looking-at "[ \t]*$")))))))
149 ;; Delete preceding blank lines, and this one too if it's the only one.
150 (if thisblank
151 (progn
152 (beginning-of-line)
153 (if singleblank (forward-line 1))
154 (delete-region (point)
155 (if (re-search-backward "[^ \t\n]" nil t)
156 (progn (forward-line 1) (point))
157 (point-min)))))
158 ;; Delete following blank lines, unless the current line is blank
159 ;; and there are no following blank lines.
160 (if (not (and thisblank singleblank))
161 (save-excursion
162 (end-of-line)
163 (forward-line 1)
164 (delete-region (point)
165 (if (re-search-forward "[^ \t\n]" nil t)
166 (progn (beginning-of-line) (point))
167 (point-max)))))
168 ;; Handle the special case where point is followed by newline and eob.
169 ;; Delete the line, leaving point at eob.
170 (if (looking-at "^[ \t]*\n\\'")
171 (delete-region (point) (point-max)))))
173 (defun back-to-indentation ()
174 "Move point to the first non-whitespace character on this line."
175 (interactive)
176 (beginning-of-line 1)
177 (skip-chars-forward " \t"))
179 (defun newline-and-indent ()
180 "Insert a newline, then indent according to major mode.
181 Indentation is done using the value of `indent-line-function'.
182 In programming language modes, this is the same as TAB.
183 In some text modes, where TAB inserts a tab, this command indents to the
184 column specified by the variable `left-margin'."
185 (interactive "*")
186 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
187 (newline)
188 (indent-according-to-mode))
190 (defun reindent-then-newline-and-indent ()
191 "Reindent current line, insert newline, then indent the new line.
192 Indentation of both lines is done according to the current major mode,
193 which means calling the current value of `indent-line-function'.
194 In programming language modes, this is the same as TAB.
195 In some text modes, where TAB inserts a tab, this indents to the
196 column specified by the variable `left-margin'."
197 (interactive "*")
198 (save-excursion
199 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
200 (indent-according-to-mode))
201 (newline)
202 (indent-according-to-mode))
204 ;; Internal subroutine of delete-char
205 (defun kill-forward-chars (arg)
206 (if (listp arg) (setq arg (car arg)))
207 (if (eq arg '-) (setq arg -1))
208 (kill-region (point) (+ (point) arg)))
210 ;; Internal subroutine of backward-delete-char
211 (defun kill-backward-chars (arg)
212 (if (listp arg) (setq arg (car arg)))
213 (if (eq arg '-) (setq arg -1))
214 (kill-region (point) (- (point) arg)))
216 (defun backward-delete-char-untabify (arg &optional killp)
217 "Delete characters backward, changing tabs into spaces.
218 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
219 Interactively, ARG is the prefix arg (default 1)
220 and KILLP is t if prefix arg is was specified."
221 (interactive "*p\nP")
222 (let ((count arg))
223 (save-excursion
224 (while (and (> count 0) (not (bobp)))
225 (if (= (preceding-char) ?\t)
226 (let ((col (current-column)))
227 (forward-char -1)
228 (setq col (- col (current-column)))
229 (insert-char ?\ col)
230 (delete-char 1)))
231 (forward-char -1)
232 (setq count (1- count)))))
233 (delete-backward-char arg killp)
234 ;; In overwrite mode, back over columns while clearing them out,
235 ;; unless at end of line.
236 (and overwrite-mode (not (eolp))
237 (save-excursion (insert-char ?\ arg))))
239 (defun zap-to-char (arg char)
240 "Kill up to and including ARG'th occurrence of CHAR.
241 Goes backward if ARG is negative; error if CHAR not found."
242 (interactive "p\ncZap to char: ")
243 (kill-region (point) (progn
244 (search-forward (char-to-string char) nil nil arg)
245 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
246 (point))))
248 (defun beginning-of-buffer (&optional arg)
249 "Move point to the beginning of the buffer; leave mark at previous position.
250 With arg N, put point N/10 of the way from the true beginning.
252 Don't use this command in Lisp programs!
253 \(goto-char (point-min)) is faster and avoids clobbering the mark."
254 (interactive "P")
255 (push-mark)
256 (goto-char (if arg
257 (if (> (buffer-size) 10000)
258 ;; Avoid overflow for large buffer sizes!
259 (* (prefix-numeric-value arg)
260 (/ (buffer-size) 10))
261 (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
262 (point-min)))
263 (if arg (forward-line 1)))
265 (defun end-of-buffer (&optional arg)
266 "Move point to the end of the buffer; leave mark at previous position.
267 With arg N, put point N/10 of the way from the true end.
269 Don't use this command in Lisp programs!
270 \(goto-char (point-max)) is faster and avoids clobbering the mark."
271 (interactive "P")
272 (push-mark)
273 (goto-char (if arg
274 (- (1+ (buffer-size))
275 (if (> (buffer-size) 10000)
276 ;; Avoid overflow for large buffer sizes!
277 (* (prefix-numeric-value arg)
278 (/ (buffer-size) 10))
279 (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
280 (point-max)))
281 ;; If we went to a place in the middle of the buffer,
282 ;; adjust it to the beginning of a line.
283 (if arg (forward-line 1)
284 ;; If the end of the buffer is not already on the screen,
285 ;; then scroll specially to put it near, but not at, the bottom.
286 (if (let ((old-point (point)))
287 (save-excursion
288 (goto-char (window-start))
289 (vertical-motion (window-height))
290 (< (point) old-point)))
291 (recenter -3))))
293 (defun mark-whole-buffer ()
294 "Put point at beginning and mark at end of buffer.
295 You probably should not use this function in Lisp programs;
296 it is usually a mistake for a Lisp function to use any subroutine
297 that uses or sets the mark."
298 (interactive)
299 (push-mark (point))
300 (push-mark (point-max) nil t)
301 (goto-char (point-min)))
303 (defun count-lines-region (start end)
304 "Print number of lines and characters in the region."
305 (interactive "r")
306 (message "Region has %d lines, %d characters"
307 (count-lines start end) (- end start)))
309 (defun what-line ()
310 "Print the current line number (in the buffer) of point."
311 (interactive)
312 (save-restriction
313 (widen)
314 (save-excursion
315 (beginning-of-line)
316 (message "Line %d"
317 (1+ (count-lines 1 (point)))))))
319 (defun count-lines (start end)
320 "Return number of lines between START and END.
321 This is usually the number of newlines between them,
322 but can be one more if START is not equal to END
323 and the greater of them is not at the start of a line."
324 (save-match-data
325 (save-excursion
326 (save-restriction
327 (narrow-to-region start end)
328 (goto-char (point-min))
329 (if (eq selective-display t)
330 (let ((done 0))
331 (while (re-search-forward "[\n\C-m]" nil t 40)
332 (setq done (+ 40 done)))
333 (while (re-search-forward "[\n\C-m]" nil t 1)
334 (setq done (+ 1 done)))
335 done)
336 (- (buffer-size) (forward-line (buffer-size))))))))
338 (defun what-cursor-position ()
339 "Print info on cursor position (on screen and within buffer)."
340 (interactive)
341 (let* ((char (following-char))
342 (beg (point-min))
343 (end (point-max))
344 (pos (point))
345 (total (buffer-size))
346 (percent (if (> total 50000)
347 ;; Avoid overflow from multiplying by 100!
348 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
349 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
350 (hscroll (if (= (window-hscroll) 0)
352 (format " Hscroll=%d" (window-hscroll))))
353 (col (current-column)))
354 (if (= pos end)
355 (if (or (/= beg 1) (/= end (1+ total)))
356 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
357 pos total percent beg end col hscroll)
358 (message "point=%d of %d(%d%%) column %d %s"
359 pos total percent col hscroll))
360 (if (or (/= beg 1) (/= end (1+ total)))
361 (message "Char: %s (0%o) point=%d of %d(%d%%) <%d - %d> column %d %s"
362 (single-key-description char) char pos total percent beg end col hscroll)
363 (message "Char: %s (0%o) point=%d of %d(%d%%) column %d %s"
364 (single-key-description char) char pos total percent col hscroll)))))
366 (defun fundamental-mode ()
367 "Major mode not specialized for anything in particular.
368 Other major modes are defined by comparison with this one."
369 (interactive)
370 (kill-all-local-variables))
372 (defvar read-expression-map (copy-keymap minibuffer-local-map)
373 "Minibuffer keymap used for reading Lisp expressions.")
374 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
376 (put 'eval-expression 'disabled t)
378 (defvar read-expression-history nil)
380 ;; We define this, rather than making `eval' interactive,
381 ;; for the sake of completion of names like eval-region, eval-current-buffer.
382 (defun eval-expression (expression)
383 "Evaluate EXPRESSION and print value in minibuffer.
384 Value is also consed on to front of the variable `values'."
385 (interactive (list (read-from-minibuffer "Eval: "
386 nil read-expression-map t
387 'read-expression-history)))
388 (setq values (cons (eval expression) values))
389 (prin1 (car values) t))
391 (defun edit-and-eval-command (prompt command)
392 "Prompting with PROMPT, let user edit COMMAND and eval result.
393 COMMAND is a Lisp expression. Let user edit that expression in
394 the minibuffer, then read and evaluate the result."
395 (let ((command (read-from-minibuffer prompt
396 (prin1-to-string command)
397 read-expression-map t)))
398 ;; Add edited command to command history, unless redundant.
399 (or (equal command (car command-history))
400 (setq command-history (cons command command-history)))
401 (eval command)))
403 (defun repeat-complex-command (arg)
404 "Edit and re-evaluate last complex command, or ARGth from last.
405 A complex command is one which used the minibuffer.
406 The command is placed in the minibuffer as a Lisp form for editing.
407 The result is executed, repeating the command as changed.
408 If the command has been changed or is not the most recent previous command
409 it is added to the front of the command history.
410 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
411 to get different commands to edit and resubmit."
412 (interactive "p")
413 (let ((elt (nth (1- arg) command-history))
414 (minibuffer-history-position arg)
415 (minibuffer-history-sexp-flag t)
416 newcmd)
417 (if elt
418 (progn
419 (setq newcmd (read-from-minibuffer "Redo: "
420 (prin1-to-string elt)
421 read-expression-map
423 (cons 'command-history
424 arg)))
425 ;; If command was added to command-history as a string,
426 ;; get rid of that. We want only evallable expressions there.
427 (if (stringp (car command-history))
428 (setq command-history (cdr command-history)))
429 ;; If command to be redone does not match front of history,
430 ;; add it to the history.
431 (or (equal newcmd (car command-history))
432 (setq command-history (cons newcmd command-history)))
433 (eval newcmd))
434 (ding))))
436 (defvar minibuffer-history nil
437 "Default minibuffer history list.
438 This is used for all minibuffer input
439 except when an alternate history list is specified.")
440 (defvar minibuffer-history-sexp-flag nil
441 "Nonzero when doing history operations on `command-history'.
442 More generally, indicates that the history list being acted on
443 contains expressions rather than strings.")
444 (setq minibuffer-history-variable 'minibuffer-history)
445 (setq minibuffer-history-position nil)
446 (defvar minibuffer-history-search-history nil)
448 (mapcar
449 (lambda (key-and-command)
450 (mapcar
451 (lambda (keymap-and-completionp)
452 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
453 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
454 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
455 (define-key (symbol-value (car keymap-and-completionp))
456 (car key-and-command)
457 (let ((command (cdr key-and-command)))
458 (if (consp command)
459 ;; (and ... nil) => ... turns back on the completion-oriented
460 ;; history commands which rms turned off since they seem to
461 ;; do things he doesn't like.
462 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
463 (progn (error "EMACS BUG!") (cdr command))
464 (car command))
465 command))))
466 '((minibuffer-local-map . nil)
467 (minibuffer-local-ns-map . nil)
468 (minibuffer-local-completion-map . t)
469 (minibuffer-local-must-match-map . t)
470 (read-expression-map . nil))))
471 '(("\en" . (next-history-element . next-complete-history-element))
472 ([next] . (next-history-element . next-complete-history-element))
473 ("\ep" . (previous-history-element . previous-complete-history-element))
474 ([prior] . (previous-history-element . previous-complete-history-element))
475 ("\er" . previous-matching-history-element)
476 ("\es" . next-matching-history-element)))
478 (defun previous-matching-history-element (regexp n)
479 "Find the previous history element that matches REGEXP.
480 \(Previous history elements refer to earlier actions.)
481 With prefix argument N, search for Nth previous match.
482 If N is negative, find the next or Nth next match."
483 (interactive
484 (let* ((enable-recursive-minibuffers t)
485 (minibuffer-history-sexp-flag nil)
486 (regexp (read-from-minibuffer "Previous element matching (regexp): "
488 minibuffer-local-map
490 'minibuffer-history-search-history)))
491 ;; Use the last regexp specified, by default, if input is empty.
492 (list (if (string= regexp "")
493 (setcar minibuffer-history-search-history
494 (nth 1 minibuffer-history-search-history))
495 regexp)
496 (prefix-numeric-value current-prefix-arg))))
497 (let ((history (symbol-value minibuffer-history-variable))
498 prevpos
499 (pos minibuffer-history-position))
500 (while (/= n 0)
501 (setq prevpos pos)
502 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
503 (if (= pos prevpos)
504 (error (if (= pos 1)
505 "No later matching history item"
506 "No earlier matching history item")))
507 (if (string-match regexp
508 (if minibuffer-history-sexp-flag
509 (prin1-to-string (nth (1- pos) history))
510 (nth (1- pos) history)))
511 (setq n (+ n (if (< n 0) 1 -1)))))
512 (setq minibuffer-history-position pos)
513 (erase-buffer)
514 (let ((elt (nth (1- pos) history)))
515 (insert (if minibuffer-history-sexp-flag
516 (prin1-to-string elt)
517 elt)))
518 (goto-char (point-min)))
519 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
520 (eq (car (car command-history)) 'next-matching-history-element))
521 (setq command-history (cdr command-history))))
523 (defun next-matching-history-element (regexp n)
524 "Find the next history element that matches REGEXP.
525 \(The next history element refers to a more recent action.)
526 With prefix argument N, search for Nth next match.
527 If N is negative, find the previous or Nth previous match."
528 (interactive
529 (let* ((enable-recursive-minibuffers t)
530 (minibuffer-history-sexp-flag nil)
531 (regexp (read-from-minibuffer "Next element matching (regexp): "
533 minibuffer-local-map
535 'minibuffer-history-search-history)))
536 ;; Use the last regexp specified, by default, if input is empty.
537 (list (if (string= regexp "")
538 (setcar minibuffer-history-search-history
539 (nth 1 minibuffer-history-search-history))
540 regexp)
541 (prefix-numeric-value current-prefix-arg))))
542 (previous-matching-history-element regexp (- n)))
544 (defun next-history-element (n)
545 "Insert the next element of the minibuffer history into the minibuffer."
546 (interactive "p")
547 (let ((narg (min (max 1 (- minibuffer-history-position n))
548 (length (symbol-value minibuffer-history-variable)))))
549 (if (= minibuffer-history-position narg)
550 (error (if (= minibuffer-history-position 1)
551 "End of history; no next item"
552 "Beginning of history; no preceding item"))
553 (erase-buffer)
554 (setq minibuffer-history-position narg)
555 (let ((elt (nth (1- minibuffer-history-position)
556 (symbol-value minibuffer-history-variable))))
557 (insert
558 (if minibuffer-history-sexp-flag
559 (prin1-to-string elt)
560 elt)))
561 (goto-char (point-min)))))
563 (defun previous-history-element (n)
564 "Inserts the previous element of the minibuffer history into the minibuffer."
565 (interactive "p")
566 (next-history-element (- n)))
568 (defun next-complete-history-element (n)
570 Get previous element of history which is a completion of minibuffer contents."
571 (interactive "p")
572 (let ((point-at-start (point)))
573 (next-matching-history-element
574 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
575 ;; next-matching-history-element always puts us at (point-min).
576 ;; Move to the position we were at before changing the buffer contents.
577 ;; This is still sensical, because the text before point has not changed.
578 (goto-char point-at-start)))
580 (defun previous-complete-history-element (n)
581 "Get next element of history which is a completion of minibuffer contents."
582 (interactive "p")
583 (next-complete-history-element (- n)))
585 (defun goto-line (arg)
586 "Goto line ARG, counting from line 1 at beginning of buffer."
587 (interactive "NGoto line: ")
588 (save-restriction
589 (widen)
590 (goto-char 1)
591 (if (eq selective-display t)
592 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
593 (forward-line (1- arg)))))
595 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
596 (define-function 'advertised-undo 'undo)
598 (defun undo (&optional arg)
599 "Undo some previous changes.
600 Repeat this command to undo more changes.
601 A numeric argument serves as a repeat count."
602 (interactive "*p")
603 (let ((modified (buffer-modified-p))
604 (recent-save (recent-auto-save-p)))
605 (or (eq (selected-window) (minibuffer-window))
606 (message "Undo!"))
607 (or (eq last-command 'undo)
608 (progn (undo-start)
609 (undo-more 1)))
610 (setq this-command 'undo)
611 (undo-more (or arg 1))
612 (and modified (not (buffer-modified-p))
613 (delete-auto-save-file-if-necessary recent-save))))
615 (defvar pending-undo-list nil
616 "Within a run of consecutive undo commands, list remaining to be undone.")
618 (defun undo-start ()
619 "Set `pending-undo-list' to the front of the undo list.
620 The next call to `undo-more' will undo the most recently made change."
621 (if (eq buffer-undo-list t)
622 (error "No undo information in this buffer"))
623 (setq pending-undo-list buffer-undo-list))
625 (defun undo-more (count)
626 "Undo back N undo-boundaries beyond what was already undone recently.
627 Call `undo-start' to get ready to undo recent changes,
628 then call `undo-more' one or more times to undo them."
629 (or pending-undo-list
630 (error "No further undo information"))
631 (setq pending-undo-list (primitive-undo count pending-undo-list)))
633 (defvar last-shell-command "")
634 (defvar last-shell-command-on-region "")
636 (defvar shell-command-history nil
637 "History list for some commands that read shell commands.")
639 (defun shell-command (command &optional flag)
640 "Execute string COMMAND in inferior shell; display output, if any.
641 If COMMAND ends in ampersand, execute it asynchronously.
643 Optional second arg non-nil (prefix arg, if interactive)
644 means insert output in current buffer after point (leave mark after it).
645 This cannot be done asynchronously."
646 (interactive (list (read-string "Shell command: " last-shell-command)
647 current-prefix-arg nil nil 'shell-command-history))
648 (if flag
649 (progn (barf-if-buffer-read-only)
650 (push-mark)
651 ;; We do not use -f for csh; we will not support broken use of
652 ;; .cshrcs. Even the BSD csh manual says to use
653 ;; "if ($?prompt) exit" before things which are not useful
654 ;; non-interactively. Besides, if someone wants their other
655 ;; aliases for shell commands then they can still have them.
656 (call-process shell-file-name nil t nil
657 "-c" command)
658 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
659 ;; It is cleaner to avoid activation, even though the command
660 ;; loop would deactivate the mark because we inserted text.
661 (goto-char (prog1 (mark t)
662 (set-marker (mark-marker) (point)
663 (current-buffer)))))
664 ;; Preserve the match data in case called from a program.
665 (let ((data (match-data)))
666 (unwind-protect
667 (if (string-match "[ \t]*&[ \t]*$" command)
668 ;; Command ending with ampersand means asynchronous.
669 (let ((buffer (get-buffer-create "*shell-command*"))
670 (directory default-directory)
671 proc)
672 ;; Remove the ampersand.
673 (setq command (substring command 0 (match-beginning 0)))
674 ;; If will kill a process, query first.
675 (setq proc (get-buffer-process buffer))
676 (if proc
677 (if (yes-or-no-p "A command is running. Kill it? ")
678 (kill-process proc)
679 (error "Shell command in progress")))
680 (save-excursion
681 (set-buffer buffer)
682 (erase-buffer)
683 (display-buffer buffer)
684 (setq default-directory directory)
685 (setq proc (start-process "Shell" buffer
686 shell-file-name "-c" command))
687 (setq mode-line-process '(": %s"))
688 (set-process-sentinel proc 'shell-command-sentinel)
689 (set-process-filter proc 'shell-command-filter)
691 (shell-command-on-region (point) (point) command nil))
692 (store-match-data data)))))
694 ;; We have a sentinel to prevent insertion of a termination message
695 ;; in the buffer itself.
696 (defun shell-command-sentinel (process signal)
697 (if (memq (process-status process) '(exit signal))
698 (progn
699 (message "%s: %s."
700 (car (cdr (cdr (process-command process))))
701 (substring signal 0 -1))
702 (save-excursion
703 (set-buffer (process-buffer process))
704 (setq mode-line-process nil))
705 (delete-process process))))
707 (defun shell-command-filter (proc string)
708 ;; Do save-excursion by hand so that we can leave point numerically unchanged
709 ;; despite an insertion immediately after it.
710 (let* ((obuf (current-buffer))
711 (buffer (process-buffer proc))
712 opoint
713 (window (get-buffer-window buffer))
714 (pos (window-start window)))
715 (unwind-protect
716 (progn
717 (set-buffer buffer)
718 (setq opoint (point))
719 (goto-char (point-max))
720 (insert-before-markers string))
721 ;; insert-before-markers moved this marker: set it back.
722 (set-window-start window pos)
723 ;; Finish our save-excursion.
724 (goto-char opoint)
725 (set-buffer obuf))))
727 (defun shell-command-on-region (start end command &optional flag interactive)
728 "Execute string COMMAND in inferior shell with region as input.
729 Normally display output (if any) in temp buffer `*Shell Command Output*';
730 Prefix arg means replace the region with it.
731 Noninteractive args are START, END, COMMAND, FLAG.
732 Noninteractively FLAG means insert output in place of text from START to END,
733 and put point at the end, but don't alter the mark.
735 If the output is one line, it is displayed in the echo area,
736 but it is nonetheless available in buffer `*Shell Command Output*'
737 even though that buffer is not automatically displayed. If there is no output
738 or output is inserted in the current buffer then `*Shell Command Output*' is
739 deleted."
740 (interactive (list (region-beginning) (region-end)
741 (read-string "Shell command on region: "
742 last-shell-command-on-region
743 nil nil 'shell-command-history)
744 current-prefix-arg
745 (prefix-numeric-value current-prefix-arg)))
746 (if flag
747 ;; Replace specified region with output from command.
748 (let ((swap (and interactive (< (point) (mark)))))
749 ;; Don't muck with mark
750 ;; unless called interactively.
751 (and interactive (push-mark))
752 (call-process-region start end shell-file-name t t nil
753 "-c" command)
754 (if (get-buffer "*Shell Command Output*")
755 (kill-buffer "*Shell Command Output*"))
756 (and interactive swap (exchange-point-and-mark)))
757 ;; No prefix argument: put the output in a temp buffer,
758 ;; replacing its entire contents.
759 (let ((buffer (get-buffer-create "*Shell Command Output*")))
760 (if (eq buffer (current-buffer))
761 ;; If the input is the same buffer as the output,
762 ;; delete everything but the specified region,
763 ;; then replace that region with the output.
764 (progn (delete-region end (point-max))
765 (delete-region (point-min) start)
766 (call-process-region (point-min) (point-max)
767 shell-file-name t t nil
768 "-c" command))
769 ;; Clear the output buffer, then run the command with output there.
770 (save-excursion
771 (set-buffer buffer)
772 (erase-buffer))
773 (call-process-region start end shell-file-name
774 nil buffer nil
775 "-c" command))
776 ;; Report the amount of output.
777 (let ((lines (save-excursion
778 (set-buffer buffer)
779 (if (= (buffer-size) 0)
781 (count-lines (point-min) (point-max))))))
782 (cond ((= lines 0)
783 (message "(Shell command completed with no output)")
784 (kill-buffer "*Shell Command Output*"))
785 ((= lines 1)
786 (message "%s"
787 (save-excursion
788 (set-buffer buffer)
789 (goto-char (point-min))
790 (buffer-substring (point)
791 (progn (end-of-line) (point))))))
793 (set-window-start (display-buffer buffer) 1)))))))
795 (defun universal-argument ()
796 "Begin a numeric argument for the following command.
797 Digits or minus sign following \\[universal-argument] make up the numeric argument.
798 \\[universal-argument] following the digits or minus sign ends the argument.
799 \\[universal-argument] without digits or minus sign provides 4 as argument.
800 Repeating \\[universal-argument] without digits or minus sign
801 multiplies the argument by 4 each time."
802 (interactive nil)
803 (let ((factor 4)
804 key)
805 ;; (describe-arg (list factor) 1)
806 (setq key (read-key-sequence nil t))
807 (while (equal (key-binding key) 'universal-argument)
808 (setq factor (* 4 factor))
809 ;; (describe-arg (list factor) 1)
810 (setq key (read-key-sequence nil t)))
811 (prefix-arg-internal key factor nil)))
813 (defun prefix-arg-internal (key factor value)
814 (let ((sign 1))
815 (if (and (numberp value) (< value 0))
816 (setq sign -1 value (- value)))
817 (if (eq value '-)
818 (setq sign -1 value nil))
819 ;; (describe-arg value sign)
820 (while (equal key "-")
821 (setq sign (- sign) factor nil)
822 ;; (describe-arg value sign)
823 (setq key (read-key-sequence nil t)))
824 (while (and (stringp key)
825 (= (length key) 1)
826 (not (string< key "0"))
827 (not (string< "9" key)))
828 (setq value (+ (* (if (numberp value) value 0) 10)
829 (- (aref key 0) ?0))
830 factor nil)
831 ;; (describe-arg value sign)
832 (setq key (read-key-sequence nil t)))
833 (setq prefix-arg
834 (cond (factor (list factor))
835 ((numberp value) (* value sign))
836 ((= sign -1) '-)))
837 ;; Calling universal-argument after digits
838 ;; terminates the argument but is ignored.
839 (if (eq (key-binding key) 'universal-argument)
840 (progn
841 (describe-arg value sign)
842 (setq key (read-key-sequence nil t))))
843 (setq unread-command-events (listify-key-sequence key))))
845 (defun describe-arg (value sign)
846 (cond ((numberp value)
847 (message "Arg: %d" (* value sign)))
848 ((consp value)
849 (message "Arg: [%d]" (car value)))
850 ((< sign 0)
851 (message "Arg: -"))))
853 (defun digit-argument (arg)
854 "Part of the numeric argument for the next command.
855 \\[universal-argument] following digits or minus sign ends the argument."
856 (interactive "P")
857 (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
858 nil arg))
860 (defun negative-argument (arg)
861 "Begin a negative numeric argument for the next command.
862 \\[universal-argument] following digits or minus sign ends the argument."
863 (interactive "P")
864 (prefix-arg-internal "-" nil arg))
866 (defun forward-to-indentation (arg)
867 "Move forward ARG lines and position at first nonblank character."
868 (interactive "p")
869 (forward-line arg)
870 (skip-chars-forward " \t"))
872 (defun backward-to-indentation (arg)
873 "Move backward ARG lines and position at first nonblank character."
874 (interactive "p")
875 (forward-line (- arg))
876 (skip-chars-forward " \t"))
878 (defvar kill-whole-line nil
879 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
881 (defun kill-line (&optional arg)
882 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
883 With prefix argument, kill that many lines from point.
884 Negative arguments kill lines backward.
886 When calling from a program, nil means \"no arg\",
887 a number counts as a prefix arg.
889 If `kill-whole-line' is non-nil, then kill the whole line
890 when given no argument at the beginning of a line."
891 (interactive "P")
892 (kill-region (point)
893 ;; Don't shift point before doing the delete; that way,
894 ;; undo will record the right position of point.
895 (save-excursion
896 (if arg
897 (forward-line (prefix-numeric-value arg))
898 (if (eobp)
899 (signal 'end-of-buffer nil))
900 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
901 (forward-line 1)
902 (end-of-line)))
903 (point))))
905 ;;;; Window system cut and paste hooks.
907 (defvar interprogram-cut-function nil
908 "Function to call to make a killed region available to other programs.
910 Most window systems provide some sort of facility for cutting and
911 pasting text between the windows of different programs.
912 This variable holds a function that Emacs calls whenever text
913 is put in the kill ring, to make the new kill available to other
914 programs.
916 The function takes one or two arguments.
917 The first argument, TEXT, is a string containing
918 the text which should be made available.
919 The second, PUSH, if non-nil means this is a \"new\" kill;
920 nil means appending to an \"old\" kill.")
922 (defvar interprogram-paste-function nil
923 "Function to call to get text cut from other programs.
925 Most window systems provide some sort of facility for cutting and
926 pasting text between the windows of different programs.
927 This variable holds a function that Emacs calls to obtain
928 text that other programs have provided for pasting.
930 The function should be called with no arguments. If the function
931 returns nil, then no other program has provided such text, and the top
932 of the Emacs kill ring should be used. If the function returns a
933 string, that string should be put in the kill ring as the latest kill.
935 Note that the function should return a string only if a program other
936 than Emacs has provided a string for pasting; if Emacs provided the
937 most recent string, the function should return nil. If it is
938 difficult to tell whether Emacs or some other program provided the
939 current string, it is probably good enough to return nil if the string
940 is equal (according to `string=') to the last text Emacs provided.")
944 ;;;; The kill ring data structure.
946 (defvar kill-ring nil
947 "List of killed text sequences.
948 Since the kill ring is supposed to interact nicely with cut-and-paste
949 facilities offered by window systems, use of this variable should
950 interact nicely with `interprogram-cut-function' and
951 `interprogram-paste-function'. The functions `kill-new',
952 `kill-append', and `current-kill' are supposed to implement this
953 interaction; you may want to use them instead of manipulating the kill
954 ring directly.")
956 (defconst kill-ring-max 30
957 "*Maximum length of kill ring before oldest elements are thrown away.")
959 (defvar kill-ring-yank-pointer nil
960 "The tail of the kill ring whose car is the last thing yanked.")
962 (defun kill-new (string)
963 "Make STRING the latest kill in the kill ring.
964 Set the kill-ring-yank pointer to point to it.
965 If `interprogram-cut-function' is non-nil, apply it to STRING."
966 (setq kill-ring (cons string kill-ring))
967 (if (> (length kill-ring) kill-ring-max)
968 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))
969 (setq kill-ring-yank-pointer kill-ring)
970 (if interprogram-cut-function
971 (funcall interprogram-cut-function string t)))
973 (defun kill-append (string before-p)
974 "Append STRING to the end of the latest kill in the kill ring.
975 If BEFORE-P is non-nil, prepend STRING to the kill.
976 If `interprogram-cut-function' is set, pass the resulting kill to
977 it."
978 (setcar kill-ring
979 (if before-p
980 (concat string (car kill-ring))
981 (concat (car kill-ring) string)))
982 (if interprogram-cut-function
983 (funcall interprogram-cut-function (car kill-ring))))
985 (defun current-kill (n &optional do-not-move)
986 "Rotate the yanking point by N places, and then return that kill.
987 If N is zero, `interprogram-paste-function' is set, and calling it
988 returns a string, then that string is added to the front of the
989 kill ring and returned as the latest kill.
990 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
991 yanking point; just return the Nth kill forward."
992 (let ((interprogram-paste (and (= n 0)
993 interprogram-paste-function
994 (funcall interprogram-paste-function))))
995 (if interprogram-paste
996 (progn
997 ;; Disable the interprogram cut function when we add the new
998 ;; text to the kill ring, so Emacs doesn't try to own the
999 ;; selection, with identical text.
1000 (let ((interprogram-cut-function nil))
1001 (kill-new interprogram-paste))
1002 interprogram-paste)
1003 (or kill-ring (error "Kill ring is empty"))
1004 (let* ((length (length kill-ring))
1005 (ARGth-kill-element
1006 (nthcdr (% (+ n (- length (length kill-ring-yank-pointer)))
1007 length)
1008 kill-ring)))
1009 (or do-not-move
1010 (setq kill-ring-yank-pointer ARGth-kill-element))
1011 (car ARGth-kill-element)))))
1015 ;;;; Commands for manipulating the kill ring.
1017 (defun kill-region (beg end)
1018 "Kill between point and mark.
1019 The text is deleted but saved in the kill ring.
1020 The command \\[yank] can retrieve it from there.
1021 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1022 If the buffer is read-only, Emacs will beep and refrain from deleting
1023 the text, but put the text in the kill ring anyway. This means that
1024 you can use the killing commands to copy text from a read-only buffer.
1026 This is the primitive for programs to kill text (as opposed to deleting it).
1027 Supply two arguments, character numbers indicating the stretch of text
1028 to be killed.
1029 Any command that calls this function is a \"kill command\".
1030 If the previous command was also a kill command,
1031 the text killed this time appends to the text killed last time
1032 to make one entry in the kill ring."
1033 (interactive "r")
1034 (cond
1036 ;; If the buffer is read-only, we should beep, in case the person
1037 ;; just isn't aware of this. However, there's no harm in putting
1038 ;; the region's text in the kill ring, anyway.
1039 (buffer-read-only
1040 (copy-region-as-kill beg end)
1041 ;; This should always barf, and give us the correct error.
1042 (barf-if-buffer-read-only))
1044 ;; In certain cases, we can arrange for the undo list and the kill
1045 ;; ring to share the same string object. This code does that.
1046 ((not (or (eq buffer-undo-list t)
1047 (eq last-command 'kill-region)
1048 (eq beg end)))
1049 ;; Don't let the undo list be truncated before we can even access it.
1050 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1051 (old-list buffer-undo-list)
1052 tail)
1053 (delete-region beg end)
1054 ;; Search back in buffer-undo-list for this string,
1055 ;; in case a change hook made property changes.
1056 (setq tail buffer-undo-list)
1057 (while (not (stringp (car (car tail))))
1058 (setq tail (cdr tail)))
1059 ;; Take the same string recorded for undo
1060 ;; and put it in the kill-ring.
1061 (kill-new (car (car tail)))
1062 (setq this-command 'kill-region)))
1065 (copy-region-as-kill beg end)
1066 (delete-region beg end))))
1068 (defun copy-region-as-kill (beg end)
1069 "Save the region as if killed, but don't kill it.
1070 If `interprogram-cut-function' is non-nil, also save the text for a window
1071 system cut and paste."
1072 (interactive "r")
1073 (if (eq last-command 'kill-region)
1074 (kill-append (buffer-substring beg end) (< end beg))
1075 (kill-new (buffer-substring beg end)))
1076 (setq this-command 'kill-region)
1077 nil)
1079 (defun kill-ring-save (beg end)
1080 "Save the region as if killed, but don't kill it.
1081 This command is similar to `copy-region-as-kill', except that it gives
1082 visual feedback indicating the extent of the region being copied.
1083 If `interprogram-cut-function' is non-nil, also save the text for a window
1084 system cut and paste."
1085 (interactive "r")
1086 (copy-region-as-kill beg end)
1087 (if (interactive-p)
1088 (let ((other-end (if (= (point) beg) end beg))
1089 (opoint (point))
1090 ;; Inhibit quitting so we can make a quit here
1091 ;; look like a C-g typed as a command.
1092 (inhibit-quit t))
1093 (if (pos-visible-in-window-p other-end (selected-window))
1094 (progn
1095 ;; Swap point and mark.
1096 (set-marker (mark-marker) (point) (current-buffer))
1097 (goto-char other-end)
1098 (sit-for 1)
1099 ;; Swap back.
1100 (set-marker (mark-marker) other-end (current-buffer))
1101 (goto-char opoint)
1102 ;; If user quit, deactivate the mark
1103 ;; as C-g would as a command.
1104 (and quit-flag mark-active
1105 (deactivate-mark)))
1106 (let* ((killed-text (current-kill 0))
1107 (message-len (min (length killed-text) 40)))
1108 (if (= (point) beg)
1109 ;; Don't say "killed"; that is misleading.
1110 (message "Saved text until \"%s\""
1111 (substring killed-text (- message-len)))
1112 (message "Saved text from \"%s\""
1113 (substring killed-text 0 message-len))))))))
1115 (defun append-next-kill ()
1116 "Cause following command, if it kills, to append to previous kill."
1117 (interactive)
1118 (if (interactive-p)
1119 (progn
1120 (setq this-command 'kill-region)
1121 (message "If the next command is a kill, it will append"))
1122 (setq last-command 'kill-region)))
1124 (defun yank-pop (arg)
1125 "Replace just-yanked stretch of killed text with a different stretch.
1126 This command is allowed only immediately after a `yank' or a `yank-pop'.
1127 At such a time, the region contains a stretch of reinserted
1128 previously-killed text. `yank-pop' deletes that text and inserts in its
1129 place a different stretch of killed text.
1131 With no argument, the previous kill is inserted.
1132 With argument N, insert the Nth previous kill.
1133 If N is negative, this is a more recent kill.
1135 The sequence of kills wraps around, so that after the oldest one
1136 comes the newest one."
1137 (interactive "*p")
1138 (if (not (eq last-command 'yank))
1139 (error "Previous command was not a yank"))
1140 (setq this-command 'yank)
1141 (let ((before (< (point) (mark t))))
1142 (delete-region (point) (mark t))
1143 (set-marker (mark-marker) (point) (current-buffer))
1144 (insert (current-kill arg))
1145 (if before
1146 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1147 ;; It is cleaner to avoid activation, even though the command
1148 ;; loop would deactivate the mark because we inserted text.
1149 (goto-char (prog1 (mark t)
1150 (set-marker (mark-marker) (point) (current-buffer))))))
1151 nil)
1153 (defun yank (&optional arg)
1154 "Reinsert the last stretch of killed text.
1155 More precisely, reinsert the stretch of killed text most recently
1156 killed OR yanked. Put point at end, and set mark at beginning.
1157 With just C-u as argument, same but put point at beginning (and mark at end).
1158 With argument N, reinsert the Nth most recently killed stretch of killed
1159 text.
1160 See also the command \\[yank-pop]."
1161 (interactive "*P")
1162 (push-mark (point))
1163 (insert (current-kill (cond
1164 ((listp arg) 0)
1165 ((eq arg '-) -1)
1166 (t (1- arg)))))
1167 (if (consp arg)
1168 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1169 ;; It is cleaner to avoid activation, even though the command
1170 ;; loop would deactivate the mark because we inserted text.
1171 (goto-char (prog1 (mark t)
1172 (set-marker (mark-marker) (point) (current-buffer)))))
1173 nil)
1175 (defun rotate-yank-pointer (arg)
1176 "Rotate the yanking point in the kill ring.
1177 With argument, rotate that many kills forward (or backward, if negative)."
1178 (interactive "p")
1179 (current-kill arg))
1182 (defun insert-buffer (buffer)
1183 "Insert after point the contents of BUFFER.
1184 Puts mark after the inserted text.
1185 BUFFER may be a buffer or a buffer name."
1186 (interactive (list (progn (barf-if-buffer-read-only)
1187 (read-buffer "Insert buffer: " (other-buffer) t))))
1188 (or (bufferp buffer)
1189 (setq buffer (get-buffer buffer)))
1190 (let (start end newmark)
1191 (save-excursion
1192 (save-excursion
1193 (set-buffer buffer)
1194 (setq start (point-min) end (point-max)))
1195 (insert-buffer-substring buffer start end)
1196 (setq newmark (point)))
1197 (push-mark newmark))
1198 nil)
1200 (defun append-to-buffer (buffer start end)
1201 "Append to specified buffer the text of the region.
1202 It is inserted into that buffer before its point.
1204 When calling from a program, give three arguments:
1205 BUFFER (or buffer name), START and END.
1206 START and END specify the portion of the current buffer to be copied."
1207 (interactive
1208 (list (read-buffer "Append to buffer: " (other-buffer nil t))
1209 (region-beginning) (region-end)))
1210 (let ((oldbuf (current-buffer)))
1211 (save-excursion
1212 (set-buffer (get-buffer-create buffer))
1213 (insert-buffer-substring oldbuf start end))))
1215 (defun prepend-to-buffer (buffer start end)
1216 "Prepend to specified buffer the text of the region.
1217 It is inserted into that buffer after its point.
1219 When calling from a program, give three arguments:
1220 BUFFER (or buffer name), START and END.
1221 START and END specify the portion of the current buffer to be copied."
1222 (interactive "BPrepend to buffer: \nr")
1223 (let ((oldbuf (current-buffer)))
1224 (save-excursion
1225 (set-buffer (get-buffer-create buffer))
1226 (save-excursion
1227 (insert-buffer-substring oldbuf start end)))))
1229 (defun copy-to-buffer (buffer start end)
1230 "Copy to specified buffer the text of the region.
1231 It is inserted into that buffer, replacing existing text there.
1233 When calling from a program, give three arguments:
1234 BUFFER (or buffer name), START and END.
1235 START and END specify the portion of the current buffer to be copied."
1236 (interactive "BCopy to buffer: \nr")
1237 (let ((oldbuf (current-buffer)))
1238 (save-excursion
1239 (set-buffer (get-buffer-create buffer))
1240 (erase-buffer)
1241 (save-excursion
1242 (insert-buffer-substring oldbuf start end)))))
1244 (defvar mark-even-if-inactive nil
1245 "*Non-nil means you can use the mark even when inactive.
1246 This option makes a difference in Transient Mark mode.
1247 When the option is non-nil, deactivation of the mark
1248 turns off region highlighting, but commands that use the mark
1249 behave as if the mark were still active.")
1251 (put 'mark-inactive 'error-conditions '(mark-inactive error))
1252 (put 'mark-inactive 'error-message "The mark is not active now")
1254 (defun mark (&optional force)
1255 "Return this buffer's mark value as integer; error if mark inactive.
1256 If optional argument FORCE is non-nil, access the mark value
1257 even if the mark is not currently active, and return nil
1258 if there is no mark at all.
1260 If you are using this in an editing command, you are most likely making
1261 a mistake; see the documentation of `set-mark'."
1262 (if (or force mark-active mark-even-if-inactive)
1263 (marker-position (mark-marker))
1264 (signal 'mark-inactive nil)))
1266 ;; Many places set mark-active directly, and several of them failed to also
1267 ;; run deactivate-mark-hook. This shorthand should simplify.
1268 (defsubst deactivate-mark ()
1269 "Deactivate the mark by setting `mark-active' to nil.
1270 \(That makes a difference only in Transient Mark mode.)
1271 Also runs the hook `deactivate-mark-hook'."
1272 (setq mark-active nil)
1273 (run-hooks 'deactivate-mark-hook))
1275 (defun set-mark (pos)
1276 "Set this buffer's mark to POS. Don't use this function!
1277 That is to say, don't use this function unless you want
1278 the user to see that the mark has moved, and you want the previous
1279 mark position to be lost.
1281 Normally, when a new mark is set, the old one should go on the stack.
1282 This is why most applications should use push-mark, not set-mark.
1284 Novice Emacs Lisp programmers often try to use the mark for the wrong
1285 purposes. The mark saves a location for the user's convenience.
1286 Most editing commands should not alter the mark.
1287 To remember a location for internal use in the Lisp program,
1288 store it in a Lisp variable. Example:
1290 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1292 (if pos
1293 (progn
1294 (setq mark-active t)
1295 (run-hooks 'activate-mark-hook)
1296 (set-marker (mark-marker) pos (current-buffer)))
1297 (deactivate-mark)
1298 (set-marker (mark-marker) pos (current-buffer))))
1300 (defvar mark-ring nil
1301 "The list of saved former marks of the current buffer,
1302 most recent first.")
1303 (make-variable-buffer-local 'mark-ring)
1305 (defconst mark-ring-max 16
1306 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1308 (defun set-mark-command (arg)
1309 "Set mark at where point is, or jump to mark.
1310 With no prefix argument, set mark, and push old mark position on mark ring.
1311 With argument, jump to mark, and pop a new position for mark off the ring.
1313 Novice Emacs Lisp programmers often try to use the mark for the wrong
1314 purposes. See the documentation of `set-mark' for more information."
1315 (interactive "P")
1316 (if (null arg)
1317 (progn
1318 (push-mark nil nil t))
1319 (if (null (mark t))
1320 (error "No mark set in this buffer")
1321 (goto-char (mark t))
1322 (pop-mark))))
1324 (defun push-mark (&optional location nomsg activate)
1325 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1326 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1327 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
1329 Novice Emacs Lisp programmers often try to use the mark for the wrong
1330 purposes. See the documentation of `set-mark' for more information.
1332 In Transient Mark mode, this does not activate the mark."
1333 (if (null (mark t))
1335 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1336 (if (> (length mark-ring) mark-ring-max)
1337 (progn
1338 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1339 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1340 (set-marker (mark-marker) (or location (point)) (current-buffer))
1341 (or nomsg executing-macro (> (minibuffer-depth) 0)
1342 (message "Mark set"))
1343 (if (or activate (not transient-mark-mode))
1344 (set-mark (mark t)))
1345 nil)
1347 (defun pop-mark ()
1348 "Pop off mark ring into the buffer's actual mark.
1349 Does not set point. Does nothing if mark ring is empty."
1350 (if mark-ring
1351 (progn
1352 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1353 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1354 (deactivate-mark)
1355 (move-marker (car mark-ring) nil)
1356 (if (null (mark t)) (ding))
1357 (setq mark-ring (cdr mark-ring)))))
1359 (define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
1360 (defun exchange-point-and-mark ()
1361 "Put the mark where point is now, and point where the mark is now.
1362 This command works even when the mark is not active,
1363 and it reactivates the mark."
1364 (interactive nil)
1365 (let ((omark (mark t)))
1366 (if (null omark)
1367 (error "No mark set in this buffer"))
1368 (set-mark (point))
1369 (goto-char omark)
1370 nil))
1372 (defun transient-mark-mode (arg)
1373 "Toggle Transient Mark mode.
1374 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1376 In Transient Mark mode, changing the buffer \"deactivates\" the mark.
1377 While the mark is active, the region is highlighted."
1378 (interactive "P")
1379 (setq transient-mark-mode
1380 (if (null arg)
1381 (not transient-mark-mode)
1382 (> (prefix-numeric-value arg) 0))))
1384 (defvar next-line-add-newlines t
1385 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
1387 (defun next-line (arg)
1388 "Move cursor vertically down ARG lines.
1389 If there is no character in the target line exactly under the current column,
1390 the cursor is positioned after the character in that line which spans this
1391 column, or at the end of the line if it is not long enough.
1392 If there is no line in the buffer after this one, behavior depends on the
1393 value of next-line-add-newlines. If non-nil, a newline character is inserted
1394 to create a line and the cursor moves to that line, otherwise the cursor is
1395 moved to the end of the buffer (if already at the end of the buffer, an error
1396 is signaled).
1398 The command \\[set-goal-column] can be used to create
1399 a semipermanent goal column to which this command always moves.
1400 Then it does not try to move vertically. This goal column is stored
1401 in `goal-column', which is nil when there is none.
1403 If you are thinking of using this in a Lisp program, consider
1404 using `forward-line' instead. It is usually easier to use
1405 and more reliable (no dependence on goal column, etc.)."
1406 (interactive "p")
1407 (let ((opoint (point)))
1408 (if next-line-add-newlines
1409 (if (/= arg 1)
1410 (line-move arg)
1411 (forward-line 1)
1412 (if (or (= opoint (point)) (not (eq (preceding-char) ?\n)))
1413 (insert ?\n)
1414 (goto-char opoint)
1415 (line-move arg)))
1416 (if (eobp)
1417 (signal 'end-of-buffer nil))
1418 (line-move arg)
1419 (if (= opoint (point))
1420 (end-of-line))))
1421 nil)
1423 (defun previous-line (arg)
1424 "Move cursor vertically up ARG lines.
1425 If there is no character in the target line exactly over the current column,
1426 the cursor is positioned after the character in that line which spans this
1427 column, or at the end of the line if it is not long enough.
1429 The command \\[set-goal-column] can be used to create
1430 a semipermanent goal column to which this command always moves.
1431 Then it does not try to move vertically.
1433 If you are thinking of using this in a Lisp program, consider using
1434 `forward-line' with a negative argument instead. It is usually easier
1435 to use and more reliable (no dependence on goal column, etc.)."
1436 (interactive "p")
1437 (line-move (- arg))
1438 nil)
1440 (defconst track-eol nil
1441 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1442 This means moving to the end of each line moved onto.
1443 The beginning of a blank line does not count as the end of a line.")
1445 (defvar goal-column nil
1446 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1447 (make-variable-buffer-local 'goal-column)
1449 (defvar temporary-goal-column 0
1450 "Current goal column for vertical motion.
1451 It is the column where point was
1452 at the start of current run of vertical motion commands.
1453 When the `track-eol' feature is doing its job, the value is 9999.")
1455 (defun line-move (arg)
1456 (if (not (or (eq last-command 'next-line)
1457 (eq last-command 'previous-line)))
1458 (setq temporary-goal-column
1459 (if (and track-eol (eolp)
1460 ;; Don't count beg of empty line as end of line
1461 ;; unless we just did explicit end-of-line.
1462 (or (not (bolp)) (eq last-command 'end-of-line)))
1463 9999
1464 (current-column))))
1465 (if (not (integerp selective-display))
1466 (forward-line arg)
1467 ;; Move by arg lines, but ignore invisible ones.
1468 (while (> arg 0)
1469 (vertical-motion 1)
1470 (forward-char -1)
1471 (forward-line 1)
1472 (setq arg (1- arg)))
1473 (while (< arg 0)
1474 (vertical-motion -1)
1475 (beginning-of-line)
1476 (setq arg (1+ arg))))
1477 (move-to-column (or goal-column temporary-goal-column))
1478 nil)
1480 ;;; Many people have said they rarely use this feature, and often type
1481 ;;; it by accident. Maybe it shouldn't even be on a key.
1482 (put 'set-goal-column 'disabled t)
1484 (defun set-goal-column (arg)
1485 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1486 Those commands will move to this position in the line moved to
1487 rather than trying to keep the same horizontal position.
1488 With a non-nil argument, clears out the goal column
1489 so that \\[next-line] and \\[previous-line] resume vertical motion.
1490 The goal column is stored in the variable `goal-column'."
1491 (interactive "P")
1492 (if arg
1493 (progn
1494 (setq goal-column nil)
1495 (message "No goal column"))
1496 (setq goal-column (current-column))
1497 (message (substitute-command-keys
1498 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1499 goal-column))
1500 nil)
1502 ;;; Partial support for horizontal autoscrolling. Someday, this feature
1503 ;;; will be built into the C level and all the (hscroll-point-visible) calls
1504 ;;; will go away.
1506 (defvar hscroll-step 0
1507 "*The number of columns to try scrolling a window by when point moves out.
1508 If that fails to bring point back on frame, point is centered instead.
1509 If this is zero, point is always centered after it moves off frame.")
1511 (defun hscroll-point-visible ()
1512 "Scrolls the window horizontally to make point visible."
1513 (let* ((here (current-column))
1514 (left (window-hscroll))
1515 (right (- (+ left (window-width)) 3)))
1516 (cond
1517 ;; Should we recenter?
1518 ((or (< here (- left hscroll-step))
1519 (> here (+ right hscroll-step)))
1520 (set-window-hscroll
1521 (selected-window)
1522 ;; Recenter, but don't show too much white space off the end of
1523 ;; the line.
1524 (max 0
1525 (min (- (save-excursion (end-of-line) (current-column))
1526 (window-width)
1528 (- here (/ (window-width) 2))))))
1529 ;; Should we scroll left?
1530 ((> here right)
1531 (scroll-left hscroll-step))
1532 ;; Or right?
1533 ((< here left)
1534 (scroll-right hscroll-step)))))
1536 ;; rms: (1) The definitions of arrow keys should not simply restate
1537 ;; what keys they are. The arrow keys should run the ordinary commands.
1538 ;; (2) The arrow keys are just one of many common ways of moving point
1539 ;; within a line. Real horizontal autoscrolling would be a good feature,
1540 ;; but supporting it only for arrow keys is too incomplete to be desirable.
1542 ;;;;; Make arrow keys do the right thing for improved terminal support
1543 ;;;;; When we implement true horizontal autoscrolling, right-arrow and
1544 ;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1545 ;;;;; aliases. These functions are bound to the corresponding keyboard
1546 ;;;;; events in loaddefs.el.
1548 ;;(defun right-arrow (arg)
1549 ;; "Move right one character on the screen (with prefix ARG, that many chars).
1550 ;;Scroll right if needed to keep point horizontally onscreen."
1551 ;; (interactive "P")
1552 ;; (forward-char arg)
1553 ;; (hscroll-point-visible))
1555 ;;(defun left-arrow (arg)
1556 ;; "Move left one character on the screen (with prefix ARG, that many chars).
1557 ;;Scroll left if needed to keep point horizontally onscreen."
1558 ;; (interactive "P")
1559 ;; (backward-char arg)
1560 ;; (hscroll-point-visible))
1562 (defun transpose-chars (arg)
1563 "Interchange characters around point, moving forward one character.
1564 With prefix arg ARG, effect is to take character before point
1565 and drag it forward past ARG other characters (backward if ARG negative).
1566 If no argument and at end of line, the previous two chars are exchanged."
1567 (interactive "*P")
1568 (and (null arg) (eolp) (forward-char -1))
1569 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1571 (defun transpose-words (arg)
1572 "Interchange words around point, leaving point at end of them.
1573 With prefix arg ARG, effect is to take word before or around point
1574 and drag it forward past ARG other words (backward if ARG negative).
1575 If ARG is zero, the words around or after point and around or after mark
1576 are interchanged."
1577 (interactive "*p")
1578 (transpose-subr 'forward-word arg))
1580 (defun transpose-sexps (arg)
1581 "Like \\[transpose-words] but applies to sexps.
1582 Does not work on a sexp that point is in the middle of
1583 if it is a list or string."
1584 (interactive "*p")
1585 (transpose-subr 'forward-sexp arg))
1587 (defun transpose-lines (arg)
1588 "Exchange current line and previous line, leaving point after both.
1589 With argument ARG, takes previous line and moves it past ARG lines.
1590 With argument 0, interchanges line point is in with line mark is in."
1591 (interactive "*p")
1592 (transpose-subr (function
1593 (lambda (arg)
1594 (if (= arg 1)
1595 (progn
1596 ;; Move forward over a line,
1597 ;; but create a newline if none exists yet.
1598 (end-of-line)
1599 (if (eobp)
1600 (newline)
1601 (forward-char 1)))
1602 (forward-line arg))))
1603 arg))
1605 (defun transpose-subr (mover arg)
1606 (let (start1 end1 start2 end2)
1607 (if (= arg 0)
1608 (progn
1609 (save-excursion
1610 (funcall mover 1)
1611 (setq end2 (point))
1612 (funcall mover -1)
1613 (setq start2 (point))
1614 (goto-char (mark))
1615 (funcall mover 1)
1616 (setq end1 (point))
1617 (funcall mover -1)
1618 (setq start1 (point))
1619 (transpose-subr-1))
1620 (exchange-point-and-mark)))
1621 (while (> arg 0)
1622 (funcall mover -1)
1623 (setq start1 (point))
1624 (funcall mover 1)
1625 (setq end1 (point))
1626 (funcall mover 1)
1627 (setq end2 (point))
1628 (funcall mover -1)
1629 (setq start2 (point))
1630 (transpose-subr-1)
1631 (goto-char end2)
1632 (setq arg (1- arg)))
1633 (while (< arg 0)
1634 (funcall mover -1)
1635 (setq start2 (point))
1636 (funcall mover -1)
1637 (setq start1 (point))
1638 (funcall mover 1)
1639 (setq end1 (point))
1640 (funcall mover 1)
1641 (setq end2 (point))
1642 (transpose-subr-1)
1643 (setq arg (1+ arg)))))
1645 (defun transpose-subr-1 ()
1646 (if (> (min end1 end2) (max start1 start2))
1647 (error "Don't have two things to transpose"))
1648 (let ((word1 (buffer-substring start1 end1))
1649 (word2 (buffer-substring start2 end2)))
1650 (delete-region start2 end2)
1651 (goto-char start2)
1652 (insert word1)
1653 (goto-char (if (< start1 start2) start1
1654 (+ start1 (- (length word1) (length word2)))))
1655 (delete-char (length word1))
1656 (insert word2)))
1658 (defconst comment-column 32
1659 "*Column to indent right-margin comments to.
1660 Setting this variable automatically makes it local to the current buffer.
1661 Each mode establishes a different default value for this variable; you
1662 can the value for a particular mode using that mode's hook.")
1663 (make-variable-buffer-local 'comment-column)
1665 (defconst comment-start nil
1666 "*String to insert to start a new comment, or nil if no comment syntax defined.")
1668 (defconst comment-start-skip nil
1669 "*Regexp to match the start of a comment plus everything up to its body.
1670 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
1671 at the place matched by the close of the first pair.")
1673 (defconst comment-end ""
1674 "*String to insert to end a new comment.
1675 Should be an empty string if comments are terminated by end-of-line.")
1677 (defconst comment-indent-hook nil
1678 "Obsolete variable for function to compute desired indentation for a comment.
1679 This function is called with no args with point at the beginning of
1680 the comment's starting delimiter.")
1682 (defconst comment-indent-function
1683 '(lambda () comment-column)
1684 "Function to compute desired indentation for a comment.
1685 This function is called with no args with point at the beginning of
1686 the comment's starting delimiter.")
1688 (defun indent-for-comment ()
1689 "Indent this line's comment to comment column, or insert an empty comment."
1690 (interactive "*")
1691 (beginning-of-line 1)
1692 (if (null comment-start)
1693 (error "No comment syntax defined")
1694 (let* ((eolpos (save-excursion (end-of-line) (point)))
1695 cpos indent begpos)
1696 (if (re-search-forward comment-start-skip eolpos 'move)
1697 (progn (setq cpos (point-marker))
1698 ;; Find the start of the comment delimiter.
1699 ;; If there were paren-pairs in comment-start-skip,
1700 ;; position at the end of the first pair.
1701 (if (match-end 1)
1702 (goto-char (match-end 1))
1703 ;; If comment-start-skip matched a string with
1704 ;; internal whitespace (not final whitespace) then
1705 ;; the delimiter start at the end of that
1706 ;; whitespace. Otherwise, it starts at the
1707 ;; beginning of what was matched.
1708 (skip-syntax-backward " " (match-beginning 0))
1709 (skip-syntax-backward "^ " (match-beginning 0)))))
1710 (setq begpos (point))
1711 ;; Compute desired indent.
1712 (if (= (current-column)
1713 (setq indent (if comment-indent-hook
1714 (funcall comment-indent-hook)
1715 (funcall comment-indent-function))))
1716 (goto-char begpos)
1717 ;; If that's different from current, change it.
1718 (skip-chars-backward " \t")
1719 (delete-region (point) begpos)
1720 (indent-to indent))
1721 ;; An existing comment?
1722 (if cpos
1723 (progn (goto-char cpos)
1724 (set-marker cpos nil))
1725 ;; No, insert one.
1726 (insert comment-start)
1727 (save-excursion
1728 (insert comment-end))))))
1730 (defun set-comment-column (arg)
1731 "Set the comment column based on point.
1732 With no arg, set the comment column to the current column.
1733 With just minus as arg, kill any comment on this line.
1734 With any other arg, set comment column to indentation of the previous comment
1735 and then align or create a comment on this line at that column."
1736 (interactive "P")
1737 (if (eq arg '-)
1738 (kill-comment nil)
1739 (if arg
1740 (progn
1741 (save-excursion
1742 (beginning-of-line)
1743 (re-search-backward comment-start-skip)
1744 (beginning-of-line)
1745 (re-search-forward comment-start-skip)
1746 (goto-char (match-beginning 0))
1747 (setq comment-column (current-column))
1748 (message "Comment column set to %d" comment-column))
1749 (indent-for-comment))
1750 (setq comment-column (current-column))
1751 (message "Comment column set to %d" comment-column))))
1753 (defun kill-comment (arg)
1754 "Kill the comment on this line, if any.
1755 With argument, kill comments on that many lines starting with this one."
1756 ;; this function loses in a lot of situations. it incorrectly recognises
1757 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
1758 ;; with multi-line comments, can kill extra whitespace if comment wasn't
1759 ;; through end-of-line, et cetera.
1760 (interactive "P")
1761 (or comment-start-skip (error "No comment syntax defined"))
1762 (let ((count (prefix-numeric-value arg)) endc)
1763 (while (> count 0)
1764 (save-excursion
1765 (end-of-line)
1766 (setq endc (point))
1767 (beginning-of-line)
1768 (and (string< "" comment-end)
1769 (setq endc
1770 (progn
1771 (re-search-forward (regexp-quote comment-end) endc 'move)
1772 (skip-chars-forward " \t")
1773 (point))))
1774 (beginning-of-line)
1775 (if (re-search-forward comment-start-skip endc t)
1776 (progn
1777 (goto-char (match-beginning 0))
1778 (skip-chars-backward " \t")
1779 (kill-region (point) endc)
1780 ;; to catch comments a line beginnings
1781 (indent-according-to-mode))))
1782 (if arg (forward-line 1))
1783 (setq count (1- count)))))
1785 (defun comment-region (beg end &optional arg)
1786 "Comment the region; third arg numeric means use ARG comment characters.
1787 If ARG is negative, delete that many comment characters instead.
1788 Comments are terminated on each line, even for syntax in which newline does
1789 not end the comment. Blank lines do not get comments."
1790 ;; if someone wants it to only put a comment-start at the beginning and
1791 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
1792 ;; is easy enough. No option is made here for other than commenting
1793 ;; every line.
1794 (interactive "r\np")
1795 (or comment-start (error "No comment syntax is defined"))
1796 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
1797 (save-excursion
1798 (save-restriction
1799 (let ((cs comment-start) (ce comment-end))
1800 (cond ((not arg) (setq arg 1))
1801 ((> arg 1)
1802 (while (> (setq arg (1- arg)) 0)
1803 (setq cs (concat cs comment-start)
1804 ce (concat ce comment-end)))))
1805 (narrow-to-region beg end)
1806 (goto-char beg)
1807 (while (not (eobp))
1808 (if (< arg 0)
1809 (let ((count arg))
1810 (while (and (> 1 (setq count (1+ count)))
1811 (looking-at (regexp-quote cs)))
1812 (delete-char (length cs)))
1813 (if (string= "" ce) ()
1814 (setq count arg)
1815 (while (> 1 (setq count (1+ count)))
1816 (end-of-line)
1817 ;; this is questionable if comment-end ends in whitespace
1818 ;; that is pretty brain-damaged though
1819 (skip-chars-backward " \t")
1820 (backward-char (length ce))
1821 (if (looking-at (regexp-quote ce))
1822 (delete-char (length ce)))))
1823 (forward-line 1))
1824 (if (looking-at "[ \t]*$") ()
1825 (insert cs)
1826 (if (string= "" ce) ()
1827 (end-of-line)
1828 (insert ce)))
1829 (search-forward "\n" nil 'move)))))))
1831 (defun backward-word (arg)
1832 "Move backward until encountering the end of a word.
1833 With argument, do this that many times.
1834 In programs, it is faster to call `forward-word' with negative arg."
1835 (interactive "p")
1836 (forward-word (- arg)))
1838 (defun mark-word (arg)
1839 "Set mark arg words away from point."
1840 (interactive "p")
1841 (push-mark
1842 (save-excursion
1843 (forward-word arg)
1844 (point))
1845 nil t))
1847 (defun kill-word (arg)
1848 "Kill characters forward until encountering the end of a word.
1849 With argument, do this that many times."
1850 (interactive "p")
1851 (kill-region (point) (save-excursion (forward-word arg) (point))))
1853 (defun backward-kill-word (arg)
1854 "Kill characters backward until encountering the end of a word.
1855 With argument, do this that many times."
1856 (interactive "p")
1857 (kill-word (- arg)))
1859 (defun current-word ()
1860 "Return the word point is on as a string, if it's between two
1861 word-constituent characters. If not, but it immediately follows one,
1862 move back first. Otherwise, if point precedes a word constituent,
1863 move forward first. Otherwise, move backwards until a word constituent
1864 is found and get that word; if you reach a newline first, move forward
1865 instead."
1866 (interactive)
1867 (save-excursion
1868 (let ((oldpoint (point)) (start (point)) (end (point)))
1869 (skip-syntax-backward "w_") (setq start (point))
1870 (goto-char oldpoint)
1871 (skip-syntax-forward "w_") (setq end (point))
1872 (if (and (eq start oldpoint) (eq end oldpoint))
1873 (progn
1874 (skip-syntax-backward "^w_"
1875 (save-excursion (beginning-of-line) (point)))
1876 (if (eq (preceding-char) ?\n)
1877 (progn
1878 (skip-syntax-forward "^w_")
1879 (setq start (point))
1880 (skip-syntax-forward "w_")
1881 (setq end (point)))
1882 (setq end (point))
1883 (skip-syntax-backward "w_")
1884 (setq start (point)))))
1885 (buffer-substring start end))))
1887 (defconst fill-prefix nil
1888 "*String for filling to insert at front of new line, or nil for none.
1889 Setting this variable automatically makes it local to the current buffer.")
1890 (make-variable-buffer-local 'fill-prefix)
1892 (defconst auto-fill-inhibit-regexp nil
1893 "*Regexp to match lines which should not be auto-filled.")
1895 (defun do-auto-fill ()
1896 (let (give-up)
1897 (or (and auto-fill-inhibit-regexp
1898 (save-excursion (beginning-of-line)
1899 (looking-at auto-fill-inhibit-regexp)))
1900 (while (and (not give-up) (> (current-column) fill-column))
1901 (let ((fill-point
1902 (let ((opoint (point)))
1903 (save-excursion
1904 (move-to-column (1+ fill-column))
1905 (skip-chars-backward "^ \t\n")
1906 (if (bolp)
1907 (re-search-forward "[ \t]" opoint t))
1908 (skip-chars-backward " \t")
1909 (point)))))
1910 ;; If there is a space on the line before fill-point,
1911 ;; and nonspaces precede it, break the line there.
1912 (if (save-excursion
1913 (goto-char fill-point)
1914 (not (bolp)))
1915 ;; If point is at the fill-point, do not `save-excursion'.
1916 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
1917 ;; point will end up before it rather than after it.
1918 (if (save-excursion
1919 (skip-chars-backward " \t")
1920 (= (point) fill-point))
1921 (indent-new-comment-line)
1922 (save-excursion
1923 (goto-char fill-point)
1924 (indent-new-comment-line)))
1925 ;; No place to break => stop trying.
1926 (setq give-up t)))))))
1928 (defconst comment-multi-line nil
1929 "*Non-nil means \\[indent-new-comment-line] should continue same comment
1930 on new line, with no new terminator or starter.
1931 This is obsolete because you might as well use \\[newline-and-indent].")
1933 (defun indent-new-comment-line ()
1934 "Break line at point and indent, continuing comment if presently within one.
1935 The body of the continued comment is indented under the previous comment line.
1937 This command is intended for styles where you write a comment per line,
1938 starting a new comment (and terminating it if necessary) on each line.
1939 If you want to continue one comment across several lines, use \\[newline-and-indent]."
1940 (interactive "*")
1941 (let (comcol comstart)
1942 (skip-chars-backward " \t")
1943 (delete-region (point)
1944 (progn (skip-chars-forward " \t")
1945 (point)))
1946 (insert ?\n)
1947 (if (not comment-multi-line)
1948 (save-excursion
1949 (if (and comment-start-skip
1950 (let ((opoint (point)))
1951 (forward-line -1)
1952 (re-search-forward comment-start-skip opoint t)))
1953 ;; The old line is a comment.
1954 ;; Set WIN to the pos of the comment-start.
1955 ;; But if the comment is empty, look at preceding lines
1956 ;; to find one that has a nonempty comment.
1957 (let ((win (match-beginning 0)))
1958 (while (and (eolp) (not (bobp))
1959 (let (opoint)
1960 (beginning-of-line)
1961 (setq opoint (point))
1962 (forward-line -1)
1963 (re-search-forward comment-start-skip opoint t)))
1964 (setq win (match-beginning 0)))
1965 ;; Indent this line like what we found.
1966 (goto-char win)
1967 (setq comcol (current-column))
1968 (setq comstart (buffer-substring (point) (match-end 0)))))))
1969 (if comcol
1970 (let ((comment-column comcol)
1971 (comment-start comstart)
1972 (comment-end comment-end))
1973 (and comment-end (not (equal comment-end ""))
1974 ; (if (not comment-multi-line)
1975 (progn
1976 (forward-char -1)
1977 (insert comment-end)
1978 (forward-char 1))
1979 ; (setq comment-column (+ comment-column (length comment-start))
1980 ; comment-start "")
1983 (if (not (eolp))
1984 (setq comment-end ""))
1985 (insert ?\n)
1986 (forward-char -1)
1987 (indent-for-comment)
1988 (save-excursion
1989 ;; Make sure we delete the newline inserted above.
1990 (end-of-line)
1991 (delete-char 1)))
1992 (if fill-prefix
1993 (insert fill-prefix)
1994 (indent-according-to-mode)))))
1996 (defun auto-fill-mode (&optional arg)
1997 "Toggle auto-fill mode.
1998 With arg, turn auto-fill mode on if and only if arg is positive.
1999 In auto-fill mode, inserting a space at a column beyond fill-column
2000 automatically breaks the line at a previous space."
2001 (interactive "P")
2002 (prog1 (setq auto-fill-function
2003 (if (if (null arg)
2004 (not auto-fill-function)
2005 (> (prefix-numeric-value arg) 0))
2006 'do-auto-fill
2007 nil))
2008 ;; update mode-line
2009 (set-buffer-modified-p (buffer-modified-p))))
2011 (defun turn-on-auto-fill ()
2012 "Unconditionally turn on Auto Fill mode."
2013 (auto-fill-mode 1))
2015 (defun set-fill-column (arg)
2016 "Set `fill-column' to current column, or to argument if given.
2017 The variable `fill-column' has a separate value for each buffer."
2018 (interactive "P")
2019 (setq fill-column (if (integerp arg) arg (current-column)))
2020 (message "fill-column set to %d" fill-column))
2022 (defun set-selective-display (arg)
2023 "Set `selective-display' to ARG; clear it if no arg.
2024 When the value of `selective-display' is a number > 0,
2025 lines whose indentation is >= that value are not displayed.
2026 The variable `selective-display' has a separate value for each buffer."
2027 (interactive "P")
2028 (if (eq selective-display t)
2029 (error "selective-display already in use for marked lines"))
2030 (let ((current-vpos
2031 (save-restriction
2032 (narrow-to-region (point-min) (point))
2033 (goto-char (window-start))
2034 (vertical-motion (window-height)))))
2035 (setq selective-display
2036 (and arg (prefix-numeric-value arg)))
2037 (recenter current-vpos))
2038 (set-window-start (selected-window) (window-start (selected-window)))
2039 (princ "selective-display set to " t)
2040 (prin1 selective-display t)
2041 (princ "." t))
2043 (defconst overwrite-mode-textual " Ovwrt"
2044 "The string displayed in the mode line when in overwrite mode.")
2045 (defconst overwrite-mode-binary " Bin Ovwrt"
2046 "The string displayed in the mode line when in binary overwrite mode.")
2048 (defun overwrite-mode (arg)
2049 "Toggle overwrite mode.
2050 With arg, turn overwrite mode on iff arg is positive.
2051 In overwrite mode, printing characters typed in replace existing text
2052 on a one-for-one basis, rather than pushing it to the right. At the
2053 end of a line, such characters extend the line. Before a tab,
2054 such characters insert until the tab is filled in.
2055 \\[quoted-insert] still inserts characters in overwrite mode; this
2056 is supposed to make it easier to insert characters when necessary."
2057 (interactive "P")
2058 (setq overwrite-mode
2059 (if (if (null arg) (not overwrite-mode)
2060 (> (prefix-numeric-value arg) 0))
2061 'overwrite-mode-textual))
2062 (force-mode-line-update))
2064 (defun binary-overwrite-mode (arg)
2065 "Toggle binary overwrite mode.
2066 With arg, turn binary overwrite mode on iff arg is positive.
2067 In binary overwrite mode, printing characters typed in replace
2068 existing text. Newlines are not treated specially, so typing at the
2069 end of a line joins the line to the next, with the typed character
2070 between them. Typing before a tab character simply replaces the tab
2071 with the character typed.
2072 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2073 typing characters do.
2075 Note that binary overwrite mode is not its own minor mode; it is a
2076 specialization of overwrite-mode, entered by setting the
2077 `overwrite-mode' variable to `overwrite-mode-binary'."
2078 (interactive "P")
2079 (setq overwrite-mode
2080 (if (if (null arg)
2081 (not (eq overwrite-mode 'overwrite-mode-binary))
2082 (> (prefix-numeric-value arg) 0))
2083 'overwrite-mode-binary))
2084 (force-mode-line-update))
2086 (defvar line-number-mode nil
2087 "*Non-nil means display line number in mode line.")
2089 (defun line-number-mode (arg)
2090 "Toggle Line Number mode.
2091 With arg, turn Line Number mode on iff arg is positive.
2092 When Line Number mode is enabled, the line number appears
2093 in the mode line."
2094 (interactive "P")
2095 (setq line-number-mode
2096 (if (null arg) (not line-number-mode)
2097 (> (prefix-numeric-value arg) 0)))
2098 (force-mode-line-update))
2100 (defvar blink-matching-paren t
2101 "*Non-nil means show matching open-paren when close-paren is inserted.")
2103 (defconst blink-matching-paren-distance 12000
2104 "*If non-nil, is maximum distance to search for matching open-paren.")
2106 (defun blink-matching-open ()
2107 "Move cursor momentarily to the beginning of the sexp before point."
2108 (interactive)
2109 (and (> (point) (1+ (point-min)))
2110 (/= (char-syntax (char-after (- (point) 2))) ?\\ )
2111 blink-matching-paren
2112 (let* ((oldpos (point))
2113 (blinkpos)
2114 (mismatch))
2115 (save-excursion
2116 (save-restriction
2117 (if blink-matching-paren-distance
2118 (narrow-to-region (max (point-min)
2119 (- (point) blink-matching-paren-distance))
2120 oldpos))
2121 (condition-case ()
2122 (setq blinkpos (scan-sexps oldpos -1))
2123 (error nil)))
2124 (and blinkpos (/= (char-syntax (char-after blinkpos))
2125 ?\$)
2126 (setq mismatch
2127 (/= (char-after (1- oldpos))
2128 (logand (lsh (aref (syntax-table)
2129 (char-after blinkpos))
2131 255))))
2132 (if mismatch (setq blinkpos nil))
2133 (if blinkpos
2134 (progn
2135 (goto-char blinkpos)
2136 (if (pos-visible-in-window-p)
2137 (sit-for 1)
2138 (goto-char blinkpos)
2139 (message
2140 "Matches %s"
2141 (if (save-excursion
2142 (skip-chars-backward " \t")
2143 (not (bolp)))
2144 (buffer-substring (progn (beginning-of-line) (point))
2145 (1+ blinkpos))
2146 (buffer-substring blinkpos
2147 (progn
2148 (forward-char 1)
2149 (skip-chars-forward "\n \t")
2150 (end-of-line)
2151 (point)))))))
2152 (cond (mismatch
2153 (message "Mismatched parentheses"))
2154 ((not blink-matching-paren-distance)
2155 (message "Unmatched parenthesis"))))))))
2157 ;Turned off because it makes dbx bomb out.
2158 (setq blink-paren-function 'blink-matching-open)
2160 ;; This executes C-g typed while Emacs is waiting for a command.
2161 ;; Quitting out of a program does not go through here;
2162 ;; that happens in the QUIT macro at the C code level.
2163 (defun keyboard-quit ()
2164 "Signal a quit condition.
2165 During execution of Lisp code, this character causes a quit directly.
2166 At top-level, as an editor command, this simply beeps."
2167 (interactive)
2168 (deactivate-mark)
2169 (signal 'quit nil))
2171 (define-key global-map "\C-g" 'keyboard-quit)
2173 (defun set-variable (var val)
2174 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2175 When using this interactively, supply a Lisp expression for VALUE.
2176 If you want VALUE to be a string, you must surround it with doublequotes.
2178 If VARIABLE has a `variable-interactive' property, that is used as if
2179 it were the arg to `interactive' (which see) to interactively read the value."
2180 (interactive
2181 (let* ((var (read-variable "Set variable: "))
2182 (minibuffer-help-form
2183 '(funcall myhelp))
2184 (myhelp
2185 (function
2186 (lambda ()
2187 (with-output-to-temp-buffer "*Help*"
2188 (prin1 var)
2189 (princ "\nDocumentation:\n")
2190 (princ (substring (documentation-property var 'variable-documentation)
2192 (if (boundp var)
2193 (let ((print-length 20))
2194 (princ "\n\nCurrent value: ")
2195 (prin1 (symbol-value var))))
2196 nil)))))
2197 (list var
2198 (let ((prop (get var 'variable-interactive)))
2199 (if prop
2200 ;; Use VAR's `variable-interactive' property
2201 ;; as an interactive spec for prompting.
2202 (call-interactively (list 'lambda '(arg)
2203 (list 'interactive prop)
2204 'arg))
2205 (eval-minibuffer (format "Set %s to value: " var)))))))
2206 (set var val))
2208 ;; Define the major mode for lists of completions.
2210 (defvar completion-list-mode-map nil)
2211 (or completion-list-mode-map
2212 (let ((map (make-sparse-keymap)))
2213 (define-key map [mouse-2] 'mouse-choose-completion)
2214 (setq completion-list-mode-map map)))
2216 ;; Completion mode is suitable only for specially formatted data.
2217 (put 'completion-list-mode 'mode-class 'special)
2219 (defun completion-list-mode ()
2220 "Major mode for buffers showing lists of possible completions.
2221 Type \\<completion-list-mode-map>\\[mouse-choose-completion] to select
2222 a completion with the mouse."
2223 (interactive)
2224 (kill-all-local-variables)
2225 (use-local-map completion-list-mode-map)
2226 (setq mode-name "Completion List")
2227 (setq major-mode 'completion-list-mode)
2228 (run-hooks 'completion-list-mode-hook))
2230 (defun completion-setup-function ()
2231 (save-excursion
2232 (completion-list-mode)
2233 (goto-char (point-min))
2234 (if window-system
2235 (insert (substitute-command-keys
2236 "Click \\[mouse-choose-completion] on a completion to select it.\n\n")))))
2238 (add-hook 'completion-setup-hook 'completion-setup-function)
2240 ;;;; Keypad support.
2242 ;;; Make the keypad keys act like ordinary typing keys. If people add
2243 ;;; bindings for the function key symbols, then those bindings will
2244 ;;; override these, so this shouldn't interfere with any existing
2245 ;;; bindings.
2247 (mapcar
2248 (lambda (keypad-normal)
2249 (let ((keypad (nth 0 keypad-normal))
2250 (normal (nth 1 keypad-normal)))
2251 (define-key function-key-map (vector keypad) (vector normal))))
2252 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
2253 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
2254 (kp-space ?\ )
2255 (kp-tab ?\t)
2256 (kp-enter ?\r)
2257 (kp-multiply ?*)
2258 (kp-add ?+)
2259 (kp-separator ?,)
2260 (kp-subtract ?-)
2261 (kp-decimal ?.)
2262 (kp-divide ?/)
2263 (kp-equal ?=)))
2265 ;;; simple.el ends here