Recommend doc strings for all functions and variables.
[bpt/emacs.git] / lisp / simple.el
CommitLineData
c88ab9ce
ER
1;;; simple.el --- basic editing commands for Emacs
2
9e50756b 3;; Copyright (C) 1985, 1986, 1987, 1993, 1994 Free Software Foundation, Inc.
2076c87c
JB
4
5;; This file is part of GNU Emacs.
6
7;; GNU Emacs is free software; you can redistribute it and/or modify
8;; it under the terms of the GNU General Public License as published by
3a801d0c 9;; the Free Software Foundation; either version 2, or (at your option)
2076c87c
JB
10;; any later version.
11
12;; GNU Emacs is distributed in the hope that it will be useful,
13;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15;; GNU General Public License for more details.
16
17;; You should have received a copy of the GNU General Public License
18;; along with GNU Emacs; see the file COPYING. If not, write to
19;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20
d9ecc911
ER
21;;; Commentary:
22
23;; A grab-bag of basic Emacs commands not specifically related to some
24;; major mode or to file-handling.
25
3a801d0c 26;;; Code:
2076c87c
JB
27
28(defun open-line (arg)
ff1fbe3e 29 "Insert a newline and leave point before it.
616ed245
RS
30If there is a fill prefix, insert the fill prefix on the new line
31if the line would have been empty.
32With arg N, insert N newlines."
2076c87c 33 (interactive "*p")
616ed245
RS
34 (let* ((do-fill-prefix (and fill-prefix (bolp)))
35 (flag (and (null do-fill-prefix) (bolp) (not (bobp)))))
62c48f87
RS
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.
e917fa07 44 (if (not (eq buffer-undo-list t))
62c48f87
RS
45 (setq buffer-undo-list (cons (point) buffer-undo-list)))
46 (forward-char -1)))
aa648601
RS
47 (save-excursion
48 (while (> arg 0)
49 (if do-fill-prefix (insert fill-prefix))
50 (insert ?\n)
51 (setq arg (1- arg))))
52 (end-of-line)
2076c87c
JB
53 (if flag (forward-char 1))))
54
55(defun split-line ()
56 "Split current line, moving portion beyond point vertically down."
57 (interactive "*")
58 (skip-chars-forward " \t")
59 (let ((col (current-column))
60 (pos (point)))
61 (insert ?\n)
62 (indent-to col 0)
63 (goto-char pos)))
64
65(defun quoted-insert (arg)
66 "Read next input character and insert it.
ff1fbe3e 67This is useful for inserting control characters.
dbc4e1c1 68You may also type up to 3 octal digits, to insert a character with that code.
b6a22db0
JB
69
70In overwrite mode, this function inserts the character anyway, and
71does not handle octal digits specially. This means that if you use
72overwrite as your normal editing mode, you can use this function to
73insert characters when necessary.
74
75In binary overwrite mode, this function does overwrite, and octal
76digits are interpreted as a character code. This is supposed to make
77this function useful in editing binary files."
2076c87c 78 (interactive "*p")
b6a22db0
JB
79 (let ((char (if (or (not overwrite-mode)
80 (eq overwrite-mode 'overwrite-mode-binary))
81 (read-quoted-char)
82 (read-char))))
83 (if (eq overwrite-mode 'overwrite-mode-binary)
84 (delete-char arg))
1537a263 85 (insert-char char arg)))
2076c87c
JB
86
87(defun delete-indentation (&optional arg)
88 "Join this line to previous and fix up whitespace at join.
ccc58657 89If there is a fill prefix, delete it from the beginning of this line.
2076c87c
JB
90With argument, join this line to following line."
91 (interactive "*P")
92 (beginning-of-line)
93 (if arg (forward-line 1))
94 (if (eq (preceding-char) ?\n)
95 (progn
96 (delete-region (point) (1- (point)))
ccc58657
RS
97 ;; If the second line started with the fill prefix,
98 ;; delete the prefix.
99 (if (and fill-prefix
01b8e020 100 (<= (+ (point) (length fill-prefix)) (point-max))
ccc58657
RS
101 (string= fill-prefix
102 (buffer-substring (point)
103 (+ (point) (length fill-prefix)))))
104 (delete-region (point) (+ (point) (length fill-prefix))))
2076c87c
JB
105 (fixup-whitespace))))
106
107(defun fixup-whitespace ()
108 "Fixup white space between objects around point.
109Leave one space or none, according to the context."
110 (interactive "*")
111 (save-excursion
112 (delete-horizontal-space)
113 (if (or (looking-at "^\\|\\s)")
114 (save-excursion (forward-char -1)
115 (looking-at "$\\|\\s(\\|\\s'")))
116 nil
117 (insert ?\ ))))
118
119(defun delete-horizontal-space ()
120 "Delete all spaces and tabs around point."
121 (interactive "*")
122 (skip-chars-backward " \t")
123 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
124
125(defun just-one-space ()
126 "Delete all spaces and tabs around point, leaving one space."
127 (interactive "*")
128 (skip-chars-backward " \t")
129 (if (= (following-char) ? )
130 (forward-char 1)
131 (insert ? ))
132 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
133
134(defun delete-blank-lines ()
135 "On blank line, delete all surrounding blank lines, leaving just one.
136On isolated blank line, delete that one.
6d30d416 137On nonblank line, delete any immediately following blank lines."
2076c87c
JB
138 (interactive "*")
139 (let (thisblank singleblank)
140 (save-excursion
141 (beginning-of-line)
142 (setq thisblank (looking-at "[ \t]*$"))
70e14c01 143 ;; Set singleblank if there is just one blank line here.
2076c87c
JB
144 (setq singleblank
145 (and thisblank
146 (not (looking-at "[ \t]*\n[ \t]*$"))
147 (or (bobp)
148 (progn (forward-line -1)
149 (not (looking-at "[ \t]*$")))))))
70e14c01 150 ;; Delete preceding blank lines, and this one too if it's the only one.
2076c87c
JB
151 (if thisblank
152 (progn
153 (beginning-of-line)
154 (if singleblank (forward-line 1))
155 (delete-region (point)
156 (if (re-search-backward "[^ \t\n]" nil t)
157 (progn (forward-line 1) (point))
158 (point-min)))))
70e14c01
JB
159 ;; Delete following blank lines, unless the current line is blank
160 ;; and there are no following blank lines.
2076c87c
JB
161 (if (not (and thisblank singleblank))
162 (save-excursion
163 (end-of-line)
164 (forward-line 1)
165 (delete-region (point)
166 (if (re-search-forward "[^ \t\n]" nil t)
167 (progn (beginning-of-line) (point))
70e14c01
JB
168 (point-max)))))
169 ;; Handle the special case where point is followed by newline and eob.
170 ;; Delete the line, leaving point at eob.
171 (if (looking-at "^[ \t]*\n\\'")
172 (delete-region (point) (point-max)))))
2076c87c
JB
173
174(defun back-to-indentation ()
175 "Move point to the first non-whitespace character on this line."
176 (interactive)
177 (beginning-of-line 1)
178 (skip-chars-forward " \t"))
179
180(defun newline-and-indent ()
181 "Insert a newline, then indent according to major mode.
ff1fbe3e 182Indentation is done using the value of `indent-line-function'.
2076c87c 183In programming language modes, this is the same as TAB.
ff1fbe3e
RS
184In some text modes, where TAB inserts a tab, this command indents to the
185column specified by the variable `left-margin'."
2076c87c
JB
186 (interactive "*")
187 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
46947372 188 (newline)
2076c87c
JB
189 (indent-according-to-mode))
190
191(defun reindent-then-newline-and-indent ()
192 "Reindent current line, insert newline, then indent the new line.
193Indentation of both lines is done according to the current major mode,
ff1fbe3e 194which means calling the current value of `indent-line-function'.
2076c87c
JB
195In programming language modes, this is the same as TAB.
196In some text modes, where TAB inserts a tab, this indents to the
ff1fbe3e 197column specified by the variable `left-margin'."
2076c87c
JB
198 (interactive "*")
199 (save-excursion
200 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
201 (indent-according-to-mode))
46947372 202 (newline)
2076c87c
JB
203 (indent-according-to-mode))
204
dff7d67f
RS
205;; Internal subroutine of delete-char
206(defun kill-forward-chars (arg)
207 (if (listp arg) (setq arg (car arg)))
208 (if (eq arg '-) (setq arg -1))
209 (kill-region (point) (+ (point) arg)))
210
211;; Internal subroutine of backward-delete-char
212(defun kill-backward-chars (arg)
213 (if (listp arg) (setq arg (car arg)))
214 (if (eq arg '-) (setq arg -1))
215 (kill-region (point) (- (point) arg)))
216
2076c87c
JB
217(defun backward-delete-char-untabify (arg &optional killp)
218 "Delete characters backward, changing tabs into spaces.
219Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
220Interactively, ARG is the prefix arg (default 1)
aba05ae4 221and KILLP is t if a prefix arg was specified."
2076c87c
JB
222 (interactive "*p\nP")
223 (let ((count arg))
224 (save-excursion
225 (while (and (> count 0) (not (bobp)))
226 (if (= (preceding-char) ?\t)
227 (let ((col (current-column)))
228 (forward-char -1)
229 (setq col (- col (current-column)))
230 (insert-char ?\ col)
231 (delete-char 1)))
232 (forward-char -1)
233 (setq count (1- count)))))
234 (delete-backward-char arg killp)
235 ;; In overwrite mode, back over columns while clearing them out,
236 ;; unless at end of line.
237 (and overwrite-mode (not (eolp))
238 (save-excursion (insert-char ?\ arg))))
239
240(defun zap-to-char (arg char)
241 "Kill up to and including ARG'th occurrence of CHAR.
242Goes backward if ARG is negative; error if CHAR not found."
243 (interactive "p\ncZap to char: ")
244 (kill-region (point) (progn
245 (search-forward (char-to-string char) nil nil arg)
246; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
247 (point))))
248
249(defun beginning-of-buffer (&optional arg)
250 "Move point to the beginning of the buffer; leave mark at previous position.
c66587fe
RS
251With arg N, put point N/10 of the way from the beginning.
252
253If the buffer is narrowed, this command uses the beginning and size
254of the accessible part of the buffer.
ff1fbe3e
RS
255
256Don't use this command in Lisp programs!
2076c87c
JB
257\(goto-char (point-min)) is faster and avoids clobbering the mark."
258 (interactive "P")
259 (push-mark)
c66587fe
RS
260 (let ((size (- (point-max) (point-min))))
261 (goto-char (if arg
262 (+ (point-min)
263 (if (> size 10000)
264 ;; Avoid overflow for large buffer sizes!
265 (* (prefix-numeric-value arg)
266 (/ size 10))
267 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
268 (point-min))))
2076c87c
JB
269 (if arg (forward-line 1)))
270
271(defun end-of-buffer (&optional arg)
272 "Move point to the end of the buffer; leave mark at previous position.
c66587fe
RS
273With arg N, put point N/10 of the way from the end.
274
275If the buffer is narrowed, this command uses the beginning and size
276of the accessible part of the buffer.
ff1fbe3e
RS
277
278Don't use this command in Lisp programs!
2076c87c
JB
279\(goto-char (point-max)) is faster and avoids clobbering the mark."
280 (interactive "P")
281 (push-mark)
c66587fe
RS
282 (let ((size (- (point-max) (point-min))))
283 (goto-char (if arg
284 (- (point-max)
285 (if (> size 10000)
286 ;; Avoid overflow for large buffer sizes!
287 (* (prefix-numeric-value arg)
288 (/ size 10))
289 (/ (* size (prefix-numeric-value arg)) 10)))
290 (point-max))))
3a801d0c
ER
291 ;; If we went to a place in the middle of the buffer,
292 ;; adjust it to the beginning of a line.
2076c87c 293 (if arg (forward-line 1)
3a801d0c
ER
294 ;; If the end of the buffer is not already on the screen,
295 ;; then scroll specially to put it near, but not at, the bottom.
296 (if (let ((old-point (point)))
297 (save-excursion
298 (goto-char (window-start))
299 (vertical-motion (window-height))
300 (< (point) old-point)))
97dfc68c
RS
301 (progn
302 (overlay-recenter (point))
303 (recenter -3)))))
2076c87c
JB
304
305(defun mark-whole-buffer ()
70e14c01
JB
306 "Put point at beginning and mark at end of buffer.
307You probably should not use this function in Lisp programs;
308it is usually a mistake for a Lisp function to use any subroutine
309that uses or sets the mark."
2076c87c
JB
310 (interactive)
311 (push-mark (point))
fd0f4056 312 (push-mark (point-max) nil t)
2076c87c
JB
313 (goto-char (point-min)))
314
315(defun count-lines-region (start end)
eb8c3be9 316 "Print number of lines and characters in the region."
2076c87c
JB
317 (interactive "r")
318 (message "Region has %d lines, %d characters"
319 (count-lines start end) (- end start)))
320
321(defun what-line ()
322 "Print the current line number (in the buffer) of point."
323 (interactive)
324 (save-restriction
325 (widen)
326 (save-excursion
327 (beginning-of-line)
328 (message "Line %d"
329 (1+ (count-lines 1 (point)))))))
330
331(defun count-lines (start end)
332 "Return number of lines between START and END.
333This is usually the number of newlines between them,
ff1fbe3e 334but can be one more if START is not equal to END
2076c87c 335and the greater of them is not at the start of a line."
e406700d
RS
336 (save-excursion
337 (save-restriction
338 (narrow-to-region start end)
339 (goto-char (point-min))
340 (if (eq selective-display t)
341 (save-match-data
dde92ca6
RS
342 (let ((done 0))
343 (while (re-search-forward "[\n\C-m]" nil t 40)
344 (setq done (+ 40 done)))
345 (while (re-search-forward "[\n\C-m]" nil t 1)
346 (setq done (+ 1 done)))
043efc41
RS
347 (goto-char (point-max))
348 (if (and (/= start end)
349 (not (bolp)))
350 (1+ done)
e406700d
RS
351 done)))
352 (- (buffer-size) (forward-line (buffer-size)))))))
2076c87c
JB
353
354(defun what-cursor-position ()
355 "Print info on cursor position (on screen and within buffer)."
356 (interactive)
357 (let* ((char (following-char))
358 (beg (point-min))
359 (end (point-max))
360 (pos (point))
361 (total (buffer-size))
362 (percent (if (> total 50000)
363 ;; Avoid overflow from multiplying by 100!
364 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
365 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
366 (hscroll (if (= (window-hscroll) 0)
367 ""
368 (format " Hscroll=%d" (window-hscroll))))
369 (col (current-column)))
370 (if (= pos end)
371 (if (or (/= beg 1) (/= end (1+ total)))
372 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
373 pos total percent beg end col hscroll)
374 (message "point=%d of %d(%d%%) column %d %s"
375 pos total percent col hscroll))
376 (if (or (/= beg 1) (/= end (1+ total)))
377 (message "Char: %s (0%o) point=%d of %d(%d%%) <%d - %d> column %d %s"
378 (single-key-description char) char pos total percent beg end col hscroll)
379 (message "Char: %s (0%o) point=%d of %d(%d%%) column %d %s"
380 (single-key-description char) char pos total percent col hscroll)))))
381
382(defun fundamental-mode ()
383 "Major mode not specialized for anything in particular.
384Other major modes are defined by comparison with this one."
385 (interactive)
386 (kill-all-local-variables))
387
4578d35d 388(defvar read-expression-map (cons 'keymap minibuffer-local-map)
854c16c5
RS
389 "Minibuffer keymap used for reading Lisp expressions.")
390(define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
391
2076c87c
JB
392(put 'eval-expression 'disabled t)
393
8570b0ca
RM
394(defvar read-expression-history nil)
395
396;; We define this, rather than making `eval' interactive,
2076c87c
JB
397;; for the sake of completion of names like eval-region, eval-current-buffer.
398(defun eval-expression (expression)
399 "Evaluate EXPRESSION and print value in minibuffer.
eb57c304 400Value is also consed on to front of the variable `values'."
adca5fa6 401 (interactive
b387ef9a
RS
402 (list (read-from-minibuffer "Eval: "
403 nil read-expression-map t
404 'read-expression-history)))
2076c87c
JB
405 (setq values (cons (eval expression) values))
406 (prin1 (car values) t))
407
408(defun edit-and-eval-command (prompt command)
409 "Prompting with PROMPT, let user edit COMMAND and eval result.
410COMMAND is a Lisp expression. Let user edit that expression in
411the minibuffer, then read and evaluate the result."
b387ef9a
RS
412 (let ((command (read-from-minibuffer prompt
413 (prin1-to-string command)
414 read-expression-map t
415 '(command-history . 1))))
5d6c83ae
KH
416 ;; If command was added to command-history as a string,
417 ;; get rid of that. We want only evallable expressions there.
418 (if (stringp (car command-history))
419 (setq command-history (cdr command-history)))
420
421 ;; If command to be redone does not match front of history,
422 ;; add it to the history.
423 (or (equal command (car command-history))
424 (setq command-history (cons command command-history)))
2076c87c
JB
425 (eval command)))
426
ebb61177 427(defun repeat-complex-command (arg)
2076c87c
JB
428 "Edit and re-evaluate last complex command, or ARGth from last.
429A complex command is one which used the minibuffer.
430The command is placed in the minibuffer as a Lisp form for editing.
431The result is executed, repeating the command as changed.
432If the command has been changed or is not the most recent previous command
433it is added to the front of the command history.
eb6e9899
RS
434You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
435to get different commands to edit and resubmit."
2076c87c 436 (interactive "p")
ba343182 437 (let ((elt (nth (1- arg) command-history))
ebb61177 438 (minibuffer-history-position arg)
ba343182 439 (minibuffer-history-sexp-flag t)
2076c87c
JB
440 newcmd)
441 (if elt
854c16c5 442 (progn
eab22e27 443 (setq newcmd
7908d27c
RS
444 (let ((print-level nil))
445 (read-from-minibuffer
446 "Redo: " (prin1-to-string elt) read-expression-map t
447 (cons 'command-history arg))))
eab22e27 448
db16f109
RS
449 ;; If command was added to command-history as a string,
450 ;; get rid of that. We want only evallable expressions there.
451 (if (stringp (car command-history))
452 (setq command-history (cdr command-history)))
453
454 ;; If command to be redone does not match front of history,
455 ;; add it to the history.
456 (or (equal newcmd (car command-history))
457 (setq command-history (cons newcmd command-history)))
2076c87c
JB
458 (eval newcmd))
459 (ding))))
e91f80c4 460\f
854c16c5
RS
461(defvar minibuffer-history nil
462 "Default minibuffer history list.
463This is used for all minibuffer input
464except when an alternate history list is specified.")
465(defvar minibuffer-history-sexp-flag nil
c2d4b6d9 466 "Non-nil when doing history operations on `command-history'.
854c16c5
RS
467More generally, indicates that the history list being acted on
468contains expressions rather than strings.")
e91f80c4
RS
469(setq minibuffer-history-variable 'minibuffer-history)
470(setq minibuffer-history-position nil)
854c16c5 471(defvar minibuffer-history-search-history nil)
e91f80c4 472
29929437 473(mapcar
d0678801
RM
474 (lambda (key-and-command)
475 (mapcar
476 (lambda (keymap-and-completionp)
477 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
478 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
479 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
480 (define-key (symbol-value (car keymap-and-completionp))
481 (car key-and-command)
482 (let ((command (cdr key-and-command)))
483 (if (consp command)
b5e6f936
RM
484 ;; (and ... nil) => ... turns back on the completion-oriented
485 ;; history commands which rms turned off since they seem to
486 ;; do things he doesn't like.
487 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
d81362b0 488 (progn (error "EMACS BUG!") (cdr command))
d0678801
RM
489 (car command))
490 command))))
491 '((minibuffer-local-map . nil)
492 (minibuffer-local-ns-map . nil)
493 (minibuffer-local-completion-map . t)
494 (minibuffer-local-must-match-map . t)
495 (read-expression-map . nil))))
d81362b0
RM
496 '(("\en" . (next-history-element . next-complete-history-element))
497 ([next] . (next-history-element . next-complete-history-element))
498 ("\ep" . (previous-history-element . previous-complete-history-element))
499 ([prior] . (previous-history-element . previous-complete-history-element))
29929437
JB
500 ("\er" . previous-matching-history-element)
501 ("\es" . next-matching-history-element)))
e91f80c4 502
e91f80c4 503(defun previous-matching-history-element (regexp n)
854c16c5
RS
504 "Find the previous history element that matches REGEXP.
505\(Previous history elements refer to earlier actions.)
506With prefix argument N, search for Nth previous match.
507If N is negative, find the next or Nth next match."
508 (interactive
c1172a19
RS
509 (let* ((enable-recursive-minibuffers t)
510 (minibuffer-history-sexp-flag nil)
511 (regexp (read-from-minibuffer "Previous element matching (regexp): "
512 nil
513 minibuffer-local-map
514 nil
515 'minibuffer-history-search-history)))
516 ;; Use the last regexp specified, by default, if input is empty.
517 (list (if (string= regexp "")
518 (setcar minibuffer-history-search-history
519 (nth 1 minibuffer-history-search-history))
520 regexp)
854c16c5 521 (prefix-numeric-value current-prefix-arg))))
e91f80c4 522 (let ((history (symbol-value minibuffer-history-variable))
ccc58657 523 prevpos
e91f80c4
RS
524 (pos minibuffer-history-position))
525 (while (/= n 0)
526 (setq prevpos pos)
527 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
528 (if (= pos prevpos)
529 (error (if (= pos 1)
ccc58657
RS
530 "No later matching history item"
531 "No earlier matching history item")))
e91f80c4
RS
532 (if (string-match regexp
533 (if minibuffer-history-sexp-flag
7908d27c
RS
534 (let ((print-level nil))
535 (prin1-to-string (nth (1- pos) history)))
e91f80c4 536 (nth (1- pos) history)))
854c16c5 537 (setq n (+ n (if (< n 0) 1 -1)))))
e91f80c4
RS
538 (setq minibuffer-history-position pos)
539 (erase-buffer)
540 (let ((elt (nth (1- pos) history)))
541 (insert (if minibuffer-history-sexp-flag
7908d27c
RS
542 (let ((print-level nil))
543 (prin1-to-string elt))
e91f80c4 544 elt)))
854c16c5
RS
545 (goto-char (point-min)))
546 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
547 (eq (car (car command-history)) 'next-matching-history-element))
548 (setq command-history (cdr command-history))))
e91f80c4 549
e91f80c4 550(defun next-matching-history-element (regexp n)
854c16c5
RS
551 "Find the next history element that matches REGEXP.
552\(The next history element refers to a more recent action.)
553With prefix argument N, search for Nth next match.
554If N is negative, find the previous or Nth previous match."
555 (interactive
c1172a19
RS
556 (let* ((enable-recursive-minibuffers t)
557 (minibuffer-history-sexp-flag nil)
558 (regexp (read-from-minibuffer "Next element matching (regexp): "
559 nil
560 minibuffer-local-map
561 nil
562 'minibuffer-history-search-history)))
563 ;; Use the last regexp specified, by default, if input is empty.
564 (list (if (string= regexp "")
565 (setcar minibuffer-history-search-history
566 (nth 1 minibuffer-history-search-history))
567 regexp)
854c16c5 568 (prefix-numeric-value current-prefix-arg))))
e91f80c4 569 (previous-matching-history-element regexp (- n)))
2076c87c 570
ebb61177
RS
571(defun next-history-element (n)
572 "Insert the next element of the minibuffer history into the minibuffer."
2076c87c 573 (interactive "p")
ebb61177
RS
574 (let ((narg (min (max 1 (- minibuffer-history-position n))
575 (length (symbol-value minibuffer-history-variable)))))
576 (if (= minibuffer-history-position narg)
577 (error (if (= minibuffer-history-position 1)
ccc58657
RS
578 "End of history; no next item"
579 "Beginning of history; no preceding item"))
2076c87c 580 (erase-buffer)
ebb61177 581 (setq minibuffer-history-position narg)
ba343182
RS
582 (let ((elt (nth (1- minibuffer-history-position)
583 (symbol-value minibuffer-history-variable))))
584 (insert
585 (if minibuffer-history-sexp-flag
7908d27c
RS
586 (let ((print-level nil))
587 (prin1-to-string elt))
770970cb 588 elt)))
2076c87c
JB
589 (goto-char (point-min)))))
590
ebb61177 591(defun previous-history-element (n)
3ee3a076 592 "Inserts the previous element of the minibuffer history into the minibuffer."
2076c87c 593 (interactive "p")
2c5e21c1 594 (next-history-element (- n)))
d0678801
RM
595
596(defun next-complete-history-element (n)
1f6fcec3 597 "Get next element of history which is a completion of minibuffer contents."
d0678801 598 (interactive "p")
b5e6f936
RM
599 (let ((point-at-start (point)))
600 (next-matching-history-element
601 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
602 ;; next-matching-history-element always puts us at (point-min).
603 ;; Move to the position we were at before changing the buffer contents.
604 ;; This is still sensical, because the text before point has not changed.
605 (goto-char point-at-start)))
d0678801
RM
606
607(defun previous-complete-history-element (n)
1f6fcec3
RS
608 "\
609Get previous element of history which is a completion of minibuffer contents."
d0678801
RM
610 (interactive "p")
611 (next-complete-history-element (- n)))
e91f80c4 612\f
2076c87c
JB
613(defun goto-line (arg)
614 "Goto line ARG, counting from line 1 at beginning of buffer."
615 (interactive "NGoto line: ")
5f1a943c 616 (setq arg (prefix-numeric-value arg))
2076c87c
JB
617 (save-restriction
618 (widen)
619 (goto-char 1)
620 (if (eq selective-display t)
621 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
622 (forward-line (1- arg)))))
623
624;Put this on C-x u, so we can force that rather than C-_ into startup msg
dff7d67f 625(define-function 'advertised-undo 'undo)
2076c87c
JB
626
627(defun undo (&optional arg)
628 "Undo some previous changes.
629Repeat this command to undo more changes.
630A numeric argument serves as a repeat count."
631 (interactive "*p")
456c617c
RS
632 ;; If we don't get all the way thru, make last-command indicate that
633 ;; for the following command.
634 (setq this-command t)
b553cffa
RS
635 (let ((modified (buffer-modified-p))
636 (recent-save (recent-auto-save-p)))
71e40adf
JB
637 (or (eq (selected-window) (minibuffer-window))
638 (message "Undo!"))
2076c87c
JB
639 (or (eq last-command 'undo)
640 (progn (undo-start)
641 (undo-more 1)))
2076c87c 642 (undo-more (or arg 1))
2512c9f0
RS
643 ;; Don't specify a position in the undo record for the undo command.
644 ;; Instead, undoing this should move point to where the change is.
645 (let ((tail buffer-undo-list)
646 done)
647 (while (and tail (not done) (not (null (car tail))))
648 (if (integerp (car tail))
649 (progn
650 (setq done t)
651 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
652 (setq tail (cdr tail))))
2076c87c 653 (and modified (not (buffer-modified-p))
456c617c
RS
654 (delete-auto-save-file-if-necessary recent-save)))
655 ;; If we do get all the way thru, make this-command indicate that.
656 (setq this-command 'undo))
2076c87c 657
278b0a58
RS
658(defvar pending-undo-list nil
659 "Within a run of consecutive undo commands, list remaining to be undone.")
660
2076c87c 661(defun undo-start ()
ff1fbe3e
RS
662 "Set `pending-undo-list' to the front of the undo list.
663The next call to `undo-more' will undo the most recently made change."
2076c87c
JB
664 (if (eq buffer-undo-list t)
665 (error "No undo information in this buffer"))
666 (setq pending-undo-list buffer-undo-list))
667
668(defun undo-more (count)
669 "Undo back N undo-boundaries beyond what was already undone recently.
ff1fbe3e
RS
670Call `undo-start' to get ready to undo recent changes,
671then call `undo-more' one or more times to undo them."
2076c87c
JB
672 (or pending-undo-list
673 (error "No further undo information"))
674 (setq pending-undo-list (primitive-undo count pending-undo-list)))
675
009ef402
RS
676(defvar shell-command-history nil
677 "History list for some commands that read shell commands.")
678
59fc41e5
RS
679(defvar shell-command-switch "-c"
680 "Switch used to have the shell execute its command line argument.")
681
d0d74413 682(defun shell-command (command &optional output-buffer)
2076c87c
JB
683 "Execute string COMMAND in inferior shell; display output, if any.
684If COMMAND ends in ampersand, execute it asynchronously.
d0d74413
RS
685The output appears in the buffer `*Shell Command*'.
686
687The optional second argument OUTPUT-BUFFER, if non-nil,
688says to put the output in some other buffer.
689If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
690If OUTPUT-BUFFER is not a buffer and not nil,
691insert output in current buffer. (This cannot be done asynchronously.)
692In either case, the output is inserted after point (leaving mark after it)."
aa00b92d
RS
693 (interactive (list (read-from-minibuffer "Shell command: "
694 nil nil nil 'shell-command-history)
695 current-prefix-arg))
d0d74413
RS
696 (if (and output-buffer
697 (not (or (bufferp output-buffer) (stringp output-buffer))))
2076c87c
JB
698 (progn (barf-if-buffer-read-only)
699 (push-mark)
700 ;; We do not use -f for csh; we will not support broken use of
701 ;; .cshrcs. Even the BSD csh manual says to use
702 ;; "if ($?prompt) exit" before things which are not useful
703 ;; non-interactively. Besides, if someone wants their other
704 ;; aliases for shell commands then they can still have them.
705 (call-process shell-file-name nil t nil
59fc41e5 706 shell-command-switch command)
c3e46f0c
RS
707 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
708 ;; It is cleaner to avoid activation, even though the command
709 ;; loop would deactivate the mark because we inserted text.
710 (goto-char (prog1 (mark t)
711 (set-marker (mark-marker) (point)
712 (current-buffer)))))
2076c87c
JB
713 ;; Preserve the match data in case called from a program.
714 (let ((data (match-data)))
715 (unwind-protect
716 (if (string-match "[ \t]*&[ \t]*$" command)
717 ;; Command ending with ampersand means asynchronous.
d0d74413
RS
718 (let ((buffer (get-buffer-create
719 (or output-buffer "*Shell-Command*")))
2076c87c
JB
720 (directory default-directory)
721 proc)
722 ;; Remove the ampersand.
723 (setq command (substring command 0 (match-beginning 0)))
724 ;; If will kill a process, query first.
725 (setq proc (get-buffer-process buffer))
726 (if proc
727 (if (yes-or-no-p "A command is running. Kill it? ")
728 (kill-process proc)
729 (error "Shell command in progress")))
730 (save-excursion
731 (set-buffer buffer)
a9594ce3 732 (setq buffer-read-only nil)
2076c87c
JB
733 (erase-buffer)
734 (display-buffer buffer)
735 (setq default-directory directory)
736 (setq proc (start-process "Shell" buffer
59fc41e5
RS
737 shell-file-name
738 shell-command-switch command))
3f655c8a 739 (setq mode-line-process '(":%s"))
2076c87c
JB
740 (set-process-sentinel proc 'shell-command-sentinel)
741 (set-process-filter proc 'shell-command-filter)
742 ))
743 (shell-command-on-region (point) (point) command nil))
744 (store-match-data data)))))
745
746;; We have a sentinel to prevent insertion of a termination message
747;; in the buffer itself.
748(defun shell-command-sentinel (process signal)
d7e84efb
RS
749 (if (and (memq (process-status process) '(exit signal))
750 (buffer-name (process-buffer process)))
2076c87c
JB
751 (progn
752 (message "%s: %s."
753 (car (cdr (cdr (process-command process))))
754 (substring signal 0 -1))
755 (save-excursion
756 (set-buffer (process-buffer process))
757 (setq mode-line-process nil))
758 (delete-process process))))
759
760(defun shell-command-filter (proc string)
761 ;; Do save-excursion by hand so that we can leave point numerically unchanged
762 ;; despite an insertion immediately after it.
763 (let* ((obuf (current-buffer))
764 (buffer (process-buffer proc))
765 opoint
766 (window (get-buffer-window buffer))
767 (pos (window-start window)))
768 (unwind-protect
769 (progn
770 (set-buffer buffer)
3886f8e2
RS
771 (or (= (point) (point-max))
772 (setq opoint (point)))
2076c87c
JB
773 (goto-char (point-max))
774 (insert-before-markers string))
775 ;; insert-before-markers moved this marker: set it back.
776 (set-window-start window pos)
777 ;; Finish our save-excursion.
3886f8e2
RS
778 (if opoint
779 (goto-char opoint))
2076c87c
JB
780 (set-buffer obuf))))
781
d0d74413
RS
782(defun shell-command-on-region (start end command
783 &optional output-buffer interactive)
2076c87c
JB
784 "Execute string COMMAND in inferior shell with region as input.
785Normally display output (if any) in temp buffer `*Shell Command Output*';
786Prefix arg means replace the region with it.
787Noninteractive args are START, END, COMMAND, FLAG.
788Noninteractively FLAG means insert output in place of text from START to END,
789and put point at the end, but don't alter the mark.
790
791If the output is one line, it is displayed in the echo area,
792but it is nonetheless available in buffer `*Shell Command Output*'
793even though that buffer is not automatically displayed. If there is no output
794or output is inserted in the current buffer then `*Shell Command Output*' is
d0d74413
RS
795deleted.
796
797The optional second argument OUTPUT-BUFFER, if non-nil,
798says to put the output in some other buffer.
799If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
800If OUTPUT-BUFFER is not a buffer and not nil,
801insert output in the current buffer.
802In either case, the output is inserted after point (leaving mark after it)."
082c7686 803 (interactive (list (region-beginning) (region-end)
aa00b92d
RS
804 (read-from-minibuffer "Shell command on region: "
805 nil nil nil 'shell-command-history)
2076c87c
JB
806 current-prefix-arg
807 (prefix-numeric-value current-prefix-arg)))
d0d74413
RS
808 (if (and output-buffer
809 (not (or (bufferp output-buffer) (stringp output-buffer))))
2076c87c
JB
810 ;; Replace specified region with output from command.
811 (let ((swap (and interactive (< (point) (mark)))))
812 ;; Don't muck with mark
813 ;; unless called interactively.
814 (and interactive (push-mark))
815 (call-process-region start end shell-file-name t t nil
59fc41e5 816 shell-command-switch command)
b5f7c943
KH
817 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
818 (and shell-buffer (not (eq shell-buffer (current-buffer)))
819 (kill-buffer shell-buffer)))
2076c87c
JB
820 (and interactive swap (exchange-point-and-mark)))
821 ;; No prefix argument: put the output in a temp buffer,
822 ;; replacing its entire contents.
d0d74413
RS
823 (let ((buffer (get-buffer-create
824 (or output-buffer "*Shell Command Output*")))
34ee0963
RS
825 (success nil))
826 (unwind-protect
827 (if (eq buffer (current-buffer))
828 ;; If the input is the same buffer as the output,
829 ;; delete everything but the specified region,
830 ;; then replace that region with the output.
a9594ce3
RS
831 (progn (setq buffer-read-only nil)
832 (delete-region end (point-max))
34ee0963
RS
833 (delete-region (point-min) start)
834 (call-process-region (point-min) (point-max)
835 shell-file-name t t nil
59fc41e5 836 shell-command-switch command)
34ee0963
RS
837 (setq success t))
838 ;; Clear the output buffer, then run the command with output there.
839 (save-excursion
840 (set-buffer buffer)
a9594ce3 841 (setq buffer-read-only nil)
34ee0963
RS
842 (erase-buffer))
843 (call-process-region start end shell-file-name
844 nil buffer nil
59fc41e5 845 shell-command-switch command)
34ee0963
RS
846 (setq success t))
847 ;; Report the amount of output.
848 (let ((lines (save-excursion
849 (set-buffer buffer)
850 (if (= (buffer-size) 0)
851 0
852 (count-lines (point-min) (point-max))))))
853 (cond ((= lines 0)
854 (if success
855 (message "(Shell command completed with no output)"))
856 (kill-buffer buffer))
857 ((and success (= lines 1))
858 (message "%s"
859 (save-excursion
860 (set-buffer buffer)
861 (goto-char (point-min))
862 (buffer-substring (point)
4ec982c5 863 (progn (end-of-line) (point))))))
34ee0963
RS
864 (t
865 (set-window-start (display-buffer buffer) 1))))))))
2076c87c
JB
866\f
867(defun universal-argument ()
868 "Begin a numeric argument for the following command.
869Digits or minus sign following \\[universal-argument] make up the numeric argument.
870\\[universal-argument] following the digits or minus sign ends the argument.
871\\[universal-argument] without digits or minus sign provides 4 as argument.
872Repeating \\[universal-argument] without digits or minus sign
873 multiplies the argument by 4 each time."
874 (interactive nil)
c637ae6f
JB
875 (let ((factor 4)
876 key)
70e14c01
JB
877;; (describe-arg (list factor) 1)
878 (setq key (read-key-sequence nil t))
c637ae6f
JB
879 (while (equal (key-binding key) 'universal-argument)
880 (setq factor (* 4 factor))
70e14c01
JB
881;; (describe-arg (list factor) 1)
882 (setq key (read-key-sequence nil t)))
c637ae6f
JB
883 (prefix-arg-internal key factor nil)))
884
885(defun prefix-arg-internal (key factor value)
2076c87c
JB
886 (let ((sign 1))
887 (if (and (numberp value) (< value 0))
888 (setq sign -1 value (- value)))
889 (if (eq value '-)
890 (setq sign -1 value nil))
70e14c01 891;; (describe-arg value sign)
c637ae6f
JB
892 (while (equal key "-")
893 (setq sign (- sign) factor nil)
70e14c01
JB
894;; (describe-arg value sign)
895 (setq key (read-key-sequence nil t)))
bd307392
JB
896 (while (and (stringp key)
897 (= (length key) 1)
c637ae6f
JB
898 (not (string< key "0"))
899 (not (string< "9" key)))
900 (setq value (+ (* (if (numberp value) value 0) 10)
901 (- (aref key 0) ?0))
902 factor nil)
70e14c01
JB
903;; (describe-arg value sign)
904 (setq key (read-key-sequence nil t)))
2076c87c 905 (setq prefix-arg
c637ae6f 906 (cond (factor (list factor))
2076c87c
JB
907 ((numberp value) (* value sign))
908 ((= sign -1) '-)))
c637ae6f
JB
909 ;; Calling universal-argument after digits
910 ;; terminates the argument but is ignored.
911 (if (eq (key-binding key) 'universal-argument)
912 (progn
913 (describe-arg value sign)
70e14c01 914 (setq key (read-key-sequence nil t))))
d70202c0 915 (setq unread-command-events (listify-key-sequence key))))
c637ae6f
JB
916
917(defun describe-arg (value sign)
918 (cond ((numberp value)
919 (message "Arg: %d" (* value sign)))
920 ((consp value)
921 (message "Arg: [%d]" (car value)))
922 ((< sign 0)
923 (message "Arg: -"))))
2076c87c
JB
924
925(defun digit-argument (arg)
926 "Part of the numeric argument for the next command.
927\\[universal-argument] following digits or minus sign ends the argument."
928 (interactive "P")
c637ae6f
JB
929 (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
930 nil arg))
2076c87c
JB
931
932(defun negative-argument (arg)
933 "Begin a negative numeric argument for the next command.
934\\[universal-argument] following digits or minus sign ends the argument."
935 (interactive "P")
c637ae6f 936 (prefix-arg-internal "-" nil arg))
2076c87c
JB
937\f
938(defun forward-to-indentation (arg)
939 "Move forward ARG lines and position at first nonblank character."
940 (interactive "p")
941 (forward-line arg)
942 (skip-chars-forward " \t"))
943
944(defun backward-to-indentation (arg)
945 "Move backward ARG lines and position at first nonblank character."
946 (interactive "p")
947 (forward-line (- arg))
948 (skip-chars-forward " \t"))
949
38ebcf29 950(defvar kill-whole-line nil
dff7d67f 951 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
38ebcf29 952
2076c87c 953(defun kill-line (&optional arg)
dff7d67f 954 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2076c87c
JB
955With prefix argument, kill that many lines from point.
956Negative arguments kill lines backward.
957
958When calling from a program, nil means \"no arg\",
dff7d67f
RS
959a number counts as a prefix arg.
960
961If `kill-whole-line' is non-nil, then kill the whole line
962when given no argument at the beginning of a line."
2076c87c
JB
963 (interactive "P")
964 (kill-region (point)
e6291fe1
RS
965 ;; It is better to move point to the other end of the kill
966 ;; before killing. That way, in a read-only buffer, point
967 ;; moves across the text that is copied to the kill ring.
968 ;; The choice has no effect on undo now that undo records
969 ;; the value of point from before the command was run.
970 (progn
2076c87c
JB
971 (if arg
972 (forward-line (prefix-numeric-value arg))
973 (if (eobp)
974 (signal 'end-of-buffer nil))
38ebcf29 975 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
2076c87c
JB
976 (forward-line 1)
977 (end-of-line)))
978 (point))))
979\f
70e14c01
JB
980;;;; Window system cut and paste hooks.
981
982(defvar interprogram-cut-function nil
983 "Function to call to make a killed region available to other programs.
984
985Most window systems provide some sort of facility for cutting and
9f112a3d
RS
986pasting text between the windows of different programs.
987This variable holds a function that Emacs calls whenever text
988is put in the kill ring, to make the new kill available to other
70e14c01
JB
989programs.
990
9f112a3d
RS
991The function takes one or two arguments.
992The first argument, TEXT, is a string containing
993the text which should be made available.
994The second, PUSH, if non-nil means this is a \"new\" kill;
995nil means appending to an \"old\" kill.")
70e14c01
JB
996
997(defvar interprogram-paste-function nil
998 "Function to call to get text cut from other programs.
999
1000Most window systems provide some sort of facility for cutting and
9f112a3d
RS
1001pasting text between the windows of different programs.
1002This variable holds a function that Emacs calls to obtain
70e14c01
JB
1003text that other programs have provided for pasting.
1004
1005The function should be called with no arguments. If the function
1006returns nil, then no other program has provided such text, and the top
1007of the Emacs kill ring should be used. If the function returns a
daa37602
JB
1008string, that string should be put in the kill ring as the latest kill.
1009
1010Note that the function should return a string only if a program other
1011than Emacs has provided a string for pasting; if Emacs provided the
1012most recent string, the function should return nil. If it is
1013difficult to tell whether Emacs or some other program provided the
1014current string, it is probably good enough to return nil if the string
1015is equal (according to `string=') to the last text Emacs provided.")
70e14c01
JB
1016
1017
1018\f
1019;;;; The kill ring data structure.
2076c87c
JB
1020
1021(defvar kill-ring nil
70e14c01
JB
1022 "List of killed text sequences.
1023Since the kill ring is supposed to interact nicely with cut-and-paste
1024facilities offered by window systems, use of this variable should
1025interact nicely with `interprogram-cut-function' and
1026`interprogram-paste-function'. The functions `kill-new',
1027`kill-append', and `current-kill' are supposed to implement this
1028interaction; you may want to use them instead of manipulating the kill
1029ring directly.")
2076c87c
JB
1030
1031(defconst kill-ring-max 30
1032 "*Maximum length of kill ring before oldest elements are thrown away.")
1033
1034(defvar kill-ring-yank-pointer nil
1035 "The tail of the kill ring whose car is the last thing yanked.")
1036
f914dc91 1037(defun kill-new (string &optional replace)
70e14c01
JB
1038 "Make STRING the latest kill in the kill ring.
1039Set the kill-ring-yank pointer to point to it.
f914dc91
KH
1040If `interprogram-cut-function' is non-nil, apply it to STRING.
1041Optional second argument REPLACE non-nil means that STRING will replace
1042the front of the kill ring, rather than being added to the list."
f1d01ba2
KH
1043 (and (fboundp 'menu-bar-update-yank-menu)
1044 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
f914dc91
KH
1045 (if replace
1046 (setcar kill-ring string)
1047 (setq kill-ring (cons string kill-ring))
1048 (if (> (length kill-ring) kill-ring-max)
1049 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
70e14c01
JB
1050 (setq kill-ring-yank-pointer kill-ring)
1051 (if interprogram-cut-function
9f112a3d 1052 (funcall interprogram-cut-function string t)))
70e14c01 1053
2076c87c 1054(defun kill-append (string before-p)
70e14c01
JB
1055 "Append STRING to the end of the latest kill in the kill ring.
1056If BEFORE-P is non-nil, prepend STRING to the kill.
88c1aa79 1057If `interprogram-cut-function' is set, pass the resulting kill to
70e14c01 1058it."
f914dc91
KH
1059 (kill-new (if before-p
1060 (concat string (car kill-ring))
1061 (concat (car kill-ring) string)) t))
70e14c01
JB
1062
1063(defun current-kill (n &optional do-not-move)
1064 "Rotate the yanking point by N places, and then return that kill.
1065If N is zero, `interprogram-paste-function' is set, and calling it
1066returns a string, then that string is added to the front of the
1067kill ring and returned as the latest kill.
1068If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1069yanking point; just return the Nth kill forward."
1070 (let ((interprogram-paste (and (= n 0)
1071 interprogram-paste-function
1072 (funcall interprogram-paste-function))))
1073 (if interprogram-paste
1074 (progn
1075 ;; Disable the interprogram cut function when we add the new
1076 ;; text to the kill ring, so Emacs doesn't try to own the
1077 ;; selection, with identical text.
1078 (let ((interprogram-cut-function nil))
1079 (kill-new interprogram-paste))
1080 interprogram-paste)
1081 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
1082 (let ((ARGth-kill-element
1083 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1084 (length kill-ring))
1085 kill-ring)))
70e14c01
JB
1086 (or do-not-move
1087 (setq kill-ring-yank-pointer ARGth-kill-element))
1088 (car ARGth-kill-element)))))
c88ab9ce 1089
c88ab9ce 1090
70e14c01
JB
1091\f
1092;;;; Commands for manipulating the kill ring.
c88ab9ce 1093
e6291fe1
RS
1094(defvar kill-read-only-ok nil
1095 "*Non-nil means don't signal an error for killing read-only text.")
1096
2076c87c
JB
1097(defun kill-region (beg end)
1098 "Kill between point and mark.
1099The text is deleted but saved in the kill ring.
1100The command \\[yank] can retrieve it from there.
1101\(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
2aa7a8bf
JB
1102If the buffer is read-only, Emacs will beep and refrain from deleting
1103the text, but put the text in the kill ring anyway. This means that
1104you can use the killing commands to copy text from a read-only buffer.
2076c87c
JB
1105
1106This is the primitive for programs to kill text (as opposed to deleting it).
1107Supply two arguments, character numbers indicating the stretch of text
1108 to be killed.
1109Any command that calls this function is a \"kill command\".
1110If the previous command was also a kill command,
1111the text killed this time appends to the text killed last time
1112to make one entry in the kill ring."
2aa7a8bf 1113 (interactive "r")
70e14c01 1114 (cond
2aa7a8bf
JB
1115
1116 ;; If the buffer is read-only, we should beep, in case the person
1117 ;; just isn't aware of this. However, there's no harm in putting
1118 ;; the region's text in the kill ring, anyway.
e6291fe1
RS
1119 ((or (and buffer-read-only (not inhibit-read-only))
1120 (text-property-not-all beg end 'read-only nil))
2aa7a8bf 1121 (copy-region-as-kill beg end)
1537a263 1122 ;; This should always barf, and give us the correct error.
e6291fe1
RS
1123 (if kill-read-only-ok
1124 (message "Read only text copied to kill ring")
626a097c 1125 (setq this-command 'kill-region)
e6291fe1 1126 (barf-if-buffer-read-only)))
2aa7a8bf
JB
1127
1128 ;; In certain cases, we can arrange for the undo list and the kill
1129 ;; ring to share the same string object. This code does that.
70e14c01
JB
1130 ((not (or (eq buffer-undo-list t)
1131 (eq last-command 'kill-region)
713dca1c
RS
1132 ;; Use = since positions may be numbers or markers.
1133 (= beg end)))
70e14c01 1134 ;; Don't let the undo list be truncated before we can even access it.
12bcd3b6
RS
1135 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1136 (old-list buffer-undo-list)
1137 tail)
70e14c01 1138 (delete-region beg end)
12bcd3b6
RS
1139 ;; Search back in buffer-undo-list for this string,
1140 ;; in case a change hook made property changes.
1141 (setq tail buffer-undo-list)
1142 (while (not (stringp (car (car tail))))
1143 (setq tail (cdr tail)))
70e14c01
JB
1144 ;; Take the same string recorded for undo
1145 ;; and put it in the kill-ring.
626a097c 1146 (kill-new (car (car tail)))))
2aa7a8bf 1147
70e14c01 1148 (t
2076c87c 1149 (copy-region-as-kill beg end)
626a097c
KH
1150 (delete-region beg end)))
1151 (setq this-command 'kill-region))
2076c87c 1152
a382890a
KH
1153;; copy-region-as-kill no longer sets this-command, because it's confusing
1154;; to get two copies of the text when the user accidentally types M-w and
1155;; then corrects it with the intended C-w.
2076c87c
JB
1156(defun copy-region-as-kill (beg end)
1157 "Save the region as if killed, but don't kill it.
46947372
JB
1158If `interprogram-cut-function' is non-nil, also save the text for a window
1159system cut and paste."
2076c87c
JB
1160 (interactive "r")
1161 (if (eq last-command 'kill-region)
1162 (kill-append (buffer-substring beg end) (< end beg))
70e14c01 1163 (kill-new (buffer-substring beg end)))
2076c87c
JB
1164 nil)
1165
1166(defun kill-ring-save (beg end)
0964e562 1167 "Save the region as if killed, but don't kill it.
230c6b36 1168This command is similar to `copy-region-as-kill', except that it gives
0964e562
JB
1169visual feedback indicating the extent of the region being copied.
1170If `interprogram-cut-function' is non-nil, also save the text for a window
1171system cut and paste."
2076c87c
JB
1172 (interactive "r")
1173 (copy-region-as-kill beg end)
3a801d0c 1174 (if (interactive-p)
66050f10
RS
1175 (let ((other-end (if (= (point) beg) end beg))
1176 (opoint (point))
1177 ;; Inhibit quitting so we can make a quit here
1178 ;; look like a C-g typed as a command.
1179 (inhibit-quit t))
1180 (if (pos-visible-in-window-p other-end (selected-window))
1181 (progn
1182 ;; Swap point and mark.
1183 (set-marker (mark-marker) (point) (current-buffer))
1184 (goto-char other-end)
1185 (sit-for 1)
1186 ;; Swap back.
1187 (set-marker (mark-marker) other-end (current-buffer))
1188 (goto-char opoint)
1189 ;; If user quit, deactivate the mark
1190 ;; as C-g would as a command.
e4e593ae 1191 (and quit-flag mark-active
fcadf1c7 1192 (deactivate-mark)))
66050f10
RS
1193 (let* ((killed-text (current-kill 0))
1194 (message-len (min (length killed-text) 40)))
1195 (if (= (point) beg)
1196 ;; Don't say "killed"; that is misleading.
1197 (message "Saved text until \"%s\""
1198 (substring killed-text (- message-len)))
1199 (message "Saved text from \"%s\""
1200 (substring killed-text 0 message-len))))))))
2076c87c
JB
1201
1202(defun append-next-kill ()
ff1fbe3e 1203 "Cause following command, if it kills, to append to previous kill."
2076c87c
JB
1204 (interactive)
1205 (if (interactive-p)
1206 (progn
1207 (setq this-command 'kill-region)
1208 (message "If the next command is a kill, it will append"))
1209 (setq last-command 'kill-region)))
1210
2076c87c 1211(defun yank-pop (arg)
ff1fbe3e
RS
1212 "Replace just-yanked stretch of killed text with a different stretch.
1213This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 1214At such a time, the region contains a stretch of reinserted
ff1fbe3e 1215previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
1216place a different stretch of killed text.
1217
1218With no argument, the previous kill is inserted.
ff1fbe3e
RS
1219With argument N, insert the Nth previous kill.
1220If N is negative, this is a more recent kill.
2076c87c
JB
1221
1222The sequence of kills wraps around, so that after the oldest one
1223comes the newest one."
1224 (interactive "*p")
1225 (if (not (eq last-command 'yank))
1226 (error "Previous command was not a yank"))
1227 (setq this-command 'yank)
9a1277dd
RS
1228 (let ((before (< (point) (mark t))))
1229 (delete-region (point) (mark t))
fd0f4056 1230 (set-marker (mark-marker) (point) (current-buffer))
70e14c01 1231 (insert (current-kill arg))
fd0f4056
RS
1232 (if before
1233 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1234 ;; It is cleaner to avoid activation, even though the command
1235 ;; loop would deactivate the mark because we inserted text.
1236 (goto-char (prog1 (mark t)
1237 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 1238 nil)
2076c87c
JB
1239
1240(defun yank (&optional arg)
1241 "Reinsert the last stretch of killed text.
1242More precisely, reinsert the stretch of killed text most recently
ff1fbe3e
RS
1243killed OR yanked. Put point at end, and set mark at beginning.
1244With just C-u as argument, same but put point at beginning (and mark at end).
1245With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c
JB
1246text.
1247See also the command \\[yank-pop]."
1248 (interactive "*P")
456c617c
RS
1249 ;; If we don't get all the way thru, make last-command indicate that
1250 ;; for the following command.
1251 (setq this-command t)
2076c87c 1252 (push-mark (point))
70e14c01
JB
1253 (insert (current-kill (cond
1254 ((listp arg) 0)
1255 ((eq arg '-) -1)
1256 (t (1- arg)))))
2076c87c 1257 (if (consp arg)
fd0f4056
RS
1258 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1259 ;; It is cleaner to avoid activation, even though the command
1260 ;; loop would deactivate the mark because we inserted text.
1261 (goto-char (prog1 (mark t)
1262 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c
RS
1263 ;; If we do get all the way thru, make this-command indicate that.
1264 (setq this-command 'yank)
0964e562 1265 nil)
70e14c01
JB
1266
1267(defun rotate-yank-pointer (arg)
1268 "Rotate the yanking point in the kill ring.
1269With argument, rotate that many kills forward (or backward, if negative)."
1270 (interactive "p")
1271 (current-kill arg))
1272
2076c87c
JB
1273\f
1274(defun insert-buffer (buffer)
1275 "Insert after point the contents of BUFFER.
1276Puts mark after the inserted text.
1277BUFFER may be a buffer or a buffer name."
58ff020d 1278 (interactive (list (progn (barf-if-buffer-read-only)
8be055fd
RS
1279 (read-buffer "Insert buffer: "
1280 (other-buffer (current-buffer) t)
1281 t))))
2076c87c
JB
1282 (or (bufferp buffer)
1283 (setq buffer (get-buffer buffer)))
1284 (let (start end newmark)
1285 (save-excursion
1286 (save-excursion
1287 (set-buffer buffer)
1288 (setq start (point-min) end (point-max)))
1289 (insert-buffer-substring buffer start end)
1290 (setq newmark (point)))
1537a263
JB
1291 (push-mark newmark))
1292 nil)
2076c87c
JB
1293
1294(defun append-to-buffer (buffer start end)
1295 "Append to specified buffer the text of the region.
1296It is inserted into that buffer before its point.
1297
1298When calling from a program, give three arguments:
1299BUFFER (or buffer name), START and END.
1300START and END specify the portion of the current buffer to be copied."
70e14c01 1301 (interactive
5d771766 1302 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 1303 (region-beginning) (region-end)))
2076c87c
JB
1304 (let ((oldbuf (current-buffer)))
1305 (save-excursion
1306 (set-buffer (get-buffer-create buffer))
1307 (insert-buffer-substring oldbuf start end))))
1308
1309(defun prepend-to-buffer (buffer start end)
1310 "Prepend to specified buffer the text of the region.
1311It is inserted into that buffer after its point.
1312
1313When calling from a program, give three arguments:
1314BUFFER (or buffer name), START and END.
1315START and END specify the portion of the current buffer to be copied."
1316 (interactive "BPrepend to buffer: \nr")
1317 (let ((oldbuf (current-buffer)))
1318 (save-excursion
1319 (set-buffer (get-buffer-create buffer))
1320 (save-excursion
1321 (insert-buffer-substring oldbuf start end)))))
1322
1323(defun copy-to-buffer (buffer start end)
1324 "Copy to specified buffer the text of the region.
1325It is inserted into that buffer, replacing existing text there.
1326
1327When calling from a program, give three arguments:
1328BUFFER (or buffer name), START and END.
1329START and END specify the portion of the current buffer to be copied."
1330 (interactive "BCopy to buffer: \nr")
1331 (let ((oldbuf (current-buffer)))
1332 (save-excursion
1333 (set-buffer (get-buffer-create buffer))
1334 (erase-buffer)
1335 (save-excursion
1336 (insert-buffer-substring oldbuf start end)))))
1337\f
0bf0c097
RS
1338(defvar mark-even-if-inactive nil
1339 "*Non-nil means you can use the mark even when inactive.
1340This option makes a difference in Transient Mark mode.
1341When the option is non-nil, deactivation of the mark
1342turns off region highlighting, but commands that use the mark
1343behave as if the mark were still active.")
1344
62d1c1fc
RM
1345(put 'mark-inactive 'error-conditions '(mark-inactive error))
1346(put 'mark-inactive 'error-message "The mark is not active now")
1347
af39530e 1348(defun mark (&optional force)
c7c8b31e 1349 "Return this buffer's mark value as integer; error if mark inactive.
af39530e 1350If optional argument FORCE is non-nil, access the mark value
c7c8b31e
RS
1351even if the mark is not currently active, and return nil
1352if there is no mark at all.
af39530e 1353
2076c87c
JB
1354If you are using this in an editing command, you are most likely making
1355a mistake; see the documentation of `set-mark'."
0bf0c097 1356 (if (or force mark-active mark-even-if-inactive)
af39530e 1357 (marker-position (mark-marker))
62d1c1fc 1358 (signal 'mark-inactive nil)))
2076c87c 1359
19d35374
RM
1360;; Many places set mark-active directly, and several of them failed to also
1361;; run deactivate-mark-hook. This shorthand should simplify.
1362(defsubst deactivate-mark ()
1363 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 1364\(That makes a difference only in Transient Mark mode.)
19d35374 1365Also runs the hook `deactivate-mark-hook'."
a4b9d3da
RS
1366 (if transient-mark-mode
1367 (progn
1368 (setq mark-active nil)
1369 (run-hooks 'deactivate-mark-hook))))
19d35374 1370
2076c87c
JB
1371(defun set-mark (pos)
1372 "Set this buffer's mark to POS. Don't use this function!
1373That is to say, don't use this function unless you want
1374the user to see that the mark has moved, and you want the previous
1375mark position to be lost.
1376
1377Normally, when a new mark is set, the old one should go on the stack.
1378This is why most applications should use push-mark, not set-mark.
1379
ff1fbe3e 1380Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
1381purposes. The mark saves a location for the user's convenience.
1382Most editing commands should not alter the mark.
1383To remember a location for internal use in the Lisp program,
1384store it in a Lisp variable. Example:
1385
1386 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1387
fcadf1c7
RS
1388 (if pos
1389 (progn
1390 (setq mark-active t)
1391 (run-hooks 'activate-mark-hook)
1392 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
1393 ;; Normally we never clear mark-active except in Transient Mark mode.
1394 ;; But when we actually clear out the mark value too,
1395 ;; we must clear mark-active in any mode.
1396 (setq mark-active nil)
1397 (run-hooks 'deactivate-mark-hook)
1398 (set-marker (mark-marker) nil)))
2076c87c
JB
1399
1400(defvar mark-ring nil
e55e2267 1401 "The list of former marks of the current buffer, most recent first.")
2076c87c 1402(make-variable-buffer-local 'mark-ring)
e55e2267 1403(put 'mark-ring 'permanent-local t)
2076c87c
JB
1404
1405(defconst mark-ring-max 16
1406 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1407
dc029f0b
RM
1408(defvar global-mark-ring nil
1409 "The list of saved global marks, most recent first.")
1410
1411(defconst global-mark-ring-max 16
1412 "*Maximum size of global mark ring. \
1413Start discarding off end if gets this big.")
1414
2076c87c
JB
1415(defun set-mark-command (arg)
1416 "Set mark at where point is, or jump to mark.
dc029f0b
RM
1417With no prefix argument, set mark, push old mark position on local mark
1418ring, and push mark on global mark ring.
1419With argument, jump to mark, and pop a new position for mark off the ring
1420\(does not affect global mark ring\).
2076c87c 1421
ff1fbe3e 1422Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
1423purposes. See the documentation of `set-mark' for more information."
1424 (interactive "P")
1425 (if (null arg)
9a1277dd 1426 (progn
fd0f4056 1427 (push-mark nil nil t))
af39530e 1428 (if (null (mark t))
2076c87c 1429 (error "No mark set in this buffer")
9a1277dd 1430 (goto-char (mark t))
2076c87c
JB
1431 (pop-mark))))
1432
fd0f4056 1433(defun push-mark (&optional location nomsg activate)
2076c87c 1434 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
1435If the last global mark pushed was not in the current buffer,
1436also push LOCATION on the global mark ring.
fd0f4056 1437Display `Mark set' unless the optional second arg NOMSG is non-nil.
8cdc660f 1438In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2076c87c 1439
ff1fbe3e 1440Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
1441purposes. See the documentation of `set-mark' for more information.
1442
1443In Transient Mark mode, this does not activate the mark."
af39530e 1444 (if (null (mark t))
2076c87c
JB
1445 nil
1446 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1447 (if (> (length mark-ring) mark-ring-max)
1448 (progn
1449 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1450 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
9a1277dd 1451 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 1452 ;; Now push the mark on the global mark ring.
f1382a3d 1453 (if (and global-mark-ring
e08d3f7c 1454 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
1455 ;; The last global mark pushed was in this same buffer.
1456 ;; Don't push another one.
1457 nil
1458 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
dc029f0b
RM
1459 (if (> (length global-mark-ring) global-mark-ring-max)
1460 (progn
1461 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1462 nil)
f1382a3d 1463 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2076c87c
JB
1464 (or nomsg executing-macro (> (minibuffer-depth) 0)
1465 (message "Mark set"))
8cdc660f
RS
1466 (if (or activate (not transient-mark-mode))
1467 (set-mark (mark t)))
2076c87c
JB
1468 nil)
1469
1470(defun pop-mark ()
1471 "Pop off mark ring into the buffer's actual mark.
1472Does not set point. Does nothing if mark ring is empty."
1473 (if mark-ring
1474 (progn
1475 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
9a1277dd 1476 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
19d35374 1477 (deactivate-mark)
2076c87c 1478 (move-marker (car mark-ring) nil)
9a1277dd 1479 (if (null (mark t)) (ding))
2076c87c
JB
1480 (setq mark-ring (cdr mark-ring)))))
1481
dff7d67f 1482(define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
2076c87c 1483(defun exchange-point-and-mark ()
af39530e
RS
1484 "Put the mark where point is now, and point where the mark is now.
1485This command works even when the mark is not active,
1486and it reactivates the mark."
2076c87c 1487 (interactive nil)
af39530e 1488 (let ((omark (mark t)))
2076c87c
JB
1489 (if (null omark)
1490 (error "No mark set in this buffer"))
1491 (set-mark (point))
1492 (goto-char omark)
1493 nil))
e23c2c21
RS
1494
1495(defun transient-mark-mode (arg)
1496 "Toggle Transient Mark mode.
b411b5fa 1497With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 1498
5dd1220d
RS
1499In Transient Mark mode, when the mark is active, the region is highlighted.
1500Changing the buffer \"deactivates\" the mark.
1501So do certain other operations that set the mark
1502but whose main purpose is something else--for example,
1503incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
e23c2c21
RS
1504 (interactive "P")
1505 (setq transient-mark-mode
1506 (if (null arg)
1507 (not transient-mark-mode)
1508 (> (prefix-numeric-value arg) 0))))
dc029f0b
RM
1509
1510(defun pop-global-mark ()
1511 "Pop off global mark ring and jump to the top location."
1512 (interactive)
52b6d445
RS
1513 ;; Pop entries which refer to non-existent buffers.
1514 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1515 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
1516 (or global-mark-ring
1517 (error "No global mark set"))
1518 (let* ((marker (car global-mark-ring))
1519 (buffer (marker-buffer marker))
1520 (position (marker-position marker)))
1521 (setq global-mark-ring (cdr global-mark-ring))
1522 (set-buffer buffer)
1523 (or (and (>= position (point-min))
1524 (<= position (point-max)))
1525 (widen))
1526 (goto-char position)
1527 (switch-to-buffer buffer)))
2076c87c 1528\f
38ebcf29 1529(defvar next-line-add-newlines t
dff7d67f 1530 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
38ebcf29 1531
2076c87c
JB
1532(defun next-line (arg)
1533 "Move cursor vertically down ARG lines.
1534If there is no character in the target line exactly under the current column,
1535the cursor is positioned after the character in that line which spans this
1536column, or at the end of the line if it is not long enough.
38ebcf29
ER
1537If there is no line in the buffer after this one, behavior depends on the
1538value of next-line-add-newlines. If non-nil, a newline character is inserted
1539to create a line and the cursor moves to that line, otherwise the cursor is
1540moved to the end of the buffer (if already at the end of the buffer, an error
1541is signaled).
2076c87c
JB
1542
1543The command \\[set-goal-column] can be used to create
1544a semipermanent goal column to which this command always moves.
1545Then it does not try to move vertically. This goal column is stored
1546in `goal-column', which is nil when there is none.
1547
1548If you are thinking of using this in a Lisp program, consider
1549using `forward-line' instead. It is usually easier to use
1550and more reliable (no dependence on goal column, etc.)."
1551 (interactive "p")
028922cf
RS
1552 (if (and next-line-add-newlines (= arg 1))
1553 (let ((opoint (point)))
3534a809
RS
1554 (end-of-line)
1555 (if (eobp)
028922cf
RS
1556 (insert ?\n)
1557 (goto-char opoint)
1558 (line-move arg)))
1559 (line-move arg))
2076c87c
JB
1560 nil)
1561
1562(defun previous-line (arg)
1563 "Move cursor vertically up ARG lines.
1564If there is no character in the target line exactly over the current column,
1565the cursor is positioned after the character in that line which spans this
1566column, or at the end of the line if it is not long enough.
1567
1568The command \\[set-goal-column] can be used to create
1569a semipermanent goal column to which this command always moves.
1570Then it does not try to move vertically.
1571
1572If you are thinking of using this in a Lisp program, consider using
c2e8a012 1573`forward-line' with a negative argument instead. It is usually easier
2076c87c
JB
1574to use and more reliable (no dependence on goal column, etc.)."
1575 (interactive "p")
1576 (line-move (- arg))
1577 nil)
1578
1579(defconst track-eol nil
1580 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1581This means moving to the end of each line moved onto.
1582The beginning of a blank line does not count as the end of a line.")
1583
912c6728
RS
1584(defvar goal-column nil
1585 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1586(make-variable-buffer-local 'goal-column)
2076c87c
JB
1587
1588(defvar temporary-goal-column 0
1589 "Current goal column for vertical motion.
1590It is the column where point was
1591at the start of current run of vertical motion commands.
c637ae6f 1592When the `track-eol' feature is doing its job, the value is 9999.")
2076c87c
JB
1593
1594(defun line-move (arg)
1d8f6c8c
RS
1595 (if (not (or (eq last-command 'next-line)
1596 (eq last-command 'previous-line)))
1597 (setq temporary-goal-column
1598 (if (and track-eol (eolp)
1599 ;; Don't count beg of empty line as end of line
1600 ;; unless we just did explicit end-of-line.
1601 (or (not (bolp)) (eq last-command 'end-of-line)))
1602 9999
1603 (current-column))))
1604 (if (not (integerp selective-display))
3534a809
RS
1605 (or (if (> arg 0)
1606 (progn (if (> arg 1) (forward-line (1- arg)))
1607 ;; This way of moving forward ARG lines
1608 ;; verifies that we have a newline after the last one.
1609 ;; It doesn't get confused by intangible text.
1610 (end-of-line)
1611 (zerop (forward-line 1)))
1612 (and (zerop (forward-line arg))
1613 (bolp)))
da4871b3 1614 (signal (if (< arg 0)
1d8f6c8c
RS
1615 'beginning-of-buffer
1616 'end-of-buffer)
1617 nil))
1618 ;; Move by arg lines, but ignore invisible ones.
1619 (while (> arg 0)
1620 (end-of-line)
1621 (and (zerop (vertical-motion 1))
1622 (signal 'end-of-buffer nil))
1623 (setq arg (1- arg)))
1624 (while (< arg 0)
1625 (beginning-of-line)
1626 (and (zerop (vertical-motion -1))
1627 (signal 'beginning-of-buffer nil))
1628 (setq arg (1+ arg))))
1629 (move-to-column (or goal-column temporary-goal-column))
1630 nil)
2076c87c 1631
d5ab2033
JB
1632;;; Many people have said they rarely use this feature, and often type
1633;;; it by accident. Maybe it shouldn't even be on a key.
1634(put 'set-goal-column 'disabled t)
2076c87c
JB
1635
1636(defun set-goal-column (arg)
1637 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1638Those commands will move to this position in the line moved to
1639rather than trying to keep the same horizontal position.
1640With a non-nil argument, clears out the goal column
912c6728
RS
1641so that \\[next-line] and \\[previous-line] resume vertical motion.
1642The goal column is stored in the variable `goal-column'."
2076c87c
JB
1643 (interactive "P")
1644 (if arg
1645 (progn
1646 (setq goal-column nil)
1647 (message "No goal column"))
1648 (setq goal-column (current-column))
1649 (message (substitute-command-keys
1650 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1651 goal-column))
1652 nil)
1653\f
0d5bbbf7
ER
1654;;; Partial support for horizontal autoscrolling. Someday, this feature
1655;;; will be built into the C level and all the (hscroll-point-visible) calls
1656;;; will go away.
1657
1658(defvar hscroll-step 0
1659 "*The number of columns to try scrolling a window by when point moves out.
1660If that fails to bring point back on frame, point is centered instead.
1661If this is zero, point is always centered after it moves off frame.")
1662
1663(defun hscroll-point-visible ()
26c5bf8e
KH
1664 "Scrolls the selected window horizontally to make point visible."
1665 (save-excursion
1666 (set-buffer (window-buffer))
1667 (if (not (or truncate-lines
1668 (> (window-hscroll) 0)
1669 (and truncate-partial-width-windows
1670 (< (window-width) (frame-width)))))
1671 ;; Point is always visible when lines are wrapped.
1672 ()
1673 ;; If point is on the invisible part of the line before window-start,
1674 ;; then hscrolling can't bring it back, so reset window-start first.
1675 (and (< (point) (window-start))
1676 (let ((ws-bol (save-excursion
1677 (goto-char (window-start))
1678 (beginning-of-line)
1679 (point))))
1680 (and (>= (point) ws-bol)
1681 (set-window-start nil ws-bol))))
1682 (let* ((here (hscroll-window-column))
1683 (left (min (window-hscroll) 1))
1684 (right (1- (window-width))))
1685 ;; Allow for the truncation glyph, if we're not exactly at eol.
1686 (if (not (and (= here right)
1687 (= (following-char) ?\n)))
1688 (setq right (1- right)))
1689 (cond
1690 ;; If too far away, just recenter. But don't show too much
1691 ;; white space off the end of the line.
1692 ((or (< here (- left hscroll-step))
1693 (> here (+ right hscroll-step)))
1694 (let ((eol (save-excursion (end-of-line) (hscroll-window-column))))
1695 (scroll-left (min (- here (/ (window-width) 2))
1696 (- eol (window-width) -5)))))
1697 ;; Within range. Scroll by one step (or maybe not at all).
1698 ((< here left)
1699 (scroll-right hscroll-step))
1700 ((> here right)
1701 (scroll-left hscroll-step)))))))
1702
1703;; This function returns the window's idea of the display column of point,
1704;; assuming that the window is already known to be truncated rather than
1705;; wrapped, and that we've already handled the case where point is on the
1706;; part of the line before window-start. We ignore window-width; if point
1707;; is beyond the right margin, we want to know how far. The return value
1708;; includes the effects of window-hscroll, window-start, and the prompt
1709;; string in the minibuffer. It may be negative due to hscroll.
1710(defun hscroll-window-column ()
1711 (let* ((hscroll (window-hscroll))
1712 (startpos (save-excursion
1713 (beginning-of-line)
1714 (if (= (point) (save-excursion
1715 (goto-char (window-start))
1716 (beginning-of-line)
1717 (point)))
1718 (goto-char (window-start)))
1719 (point)))
1720 (hpos (+ (if (and (eq (selected-window) (minibuffer-window))
1721 (= 1 (window-start))
1722 (= startpos (point-min)))
1723 (minibuffer-prompt-width)
1724 0)
1725 (min 0 (- 1 hscroll))))
1726 val)
1727 (car (cdr (compute-motion startpos (cons hpos 0)
1728 (point) (cons 0 1)
1729 1000000 (cons hscroll 0) nil)))))
1730
0d5bbbf7 1731
dff7d67f
RS
1732;; rms: (1) The definitions of arrow keys should not simply restate
1733;; what keys they are. The arrow keys should run the ordinary commands.
1734;; (2) The arrow keys are just one of many common ways of moving point
1735;; within a line. Real horizontal autoscrolling would be a good feature,
1736;; but supporting it only for arrow keys is too incomplete to be desirable.
1737
1738;;;;; Make arrow keys do the right thing for improved terminal support
1739;;;;; When we implement true horizontal autoscrolling, right-arrow and
1740;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1741;;;;; aliases. These functions are bound to the corresponding keyboard
1742;;;;; events in loaddefs.el.
1743
1744;;(defun right-arrow (arg)
1745;; "Move right one character on the screen (with prefix ARG, that many chars).
1746;;Scroll right if needed to keep point horizontally onscreen."
1747;; (interactive "P")
1748;; (forward-char arg)
1749;; (hscroll-point-visible))
1750
1751;;(defun left-arrow (arg)
1752;; "Move left one character on the screen (with prefix ARG, that many chars).
1753;;Scroll left if needed to keep point horizontally onscreen."
1754;; (interactive "P")
1755;; (backward-char arg)
1756;; (hscroll-point-visible))
7492f5a6
RS
1757
1758(defun scroll-other-window-down (lines)
1759 "Scroll the \"other window\" down."
1760 (interactive "P")
1761 (scroll-other-window
1762 ;; Just invert the argument's meaning.
1763 ;; We can do that without knowing which window it will be.
1764 (if (eq lines '-) nil
1765 (if (null lines) '-
1766 (- (prefix-numeric-value lines))))))
3aef9604
RS
1767
1768(defun beginning-of-buffer-other-window (arg)
1769 "Move point to the beginning of the buffer in the other window.
1770Leave mark at previous position.
1771With arg N, put point N/10 of the way from the true beginning."
1772 (interactive "P")
1773 (let ((orig-window (selected-window))
1774 (window (other-window-for-scrolling)))
1775 ;; We use unwind-protect rather than save-window-excursion
1776 ;; because the latter would preserve the things we want to change.
1777 (unwind-protect
1778 (progn
1779 (select-window window)
1780 ;; Set point and mark in that window's buffer.
1781 (beginning-of-buffer arg)
1782 ;; Set point accordingly.
1783 (recenter '(t)))
1784 (select-window orig-window))))
1785
1786(defun end-of-buffer-other-window (arg)
1787 "Move point to the end of the buffer in the other window.
1788Leave mark at previous position.
1789With arg N, put point N/10 of the way from the true end."
1790 (interactive "P")
1791 ;; See beginning-of-buffer-other-window for comments.
1792 (let ((orig-window (selected-window))
1793 (window (other-window-for-scrolling)))
1794 (unwind-protect
1795 (progn
1796 (select-window window)
4500ff36 1797 (end-of-buffer arg)
3aef9604
RS
1798 (recenter '(t)))
1799 (select-window orig-window))))
38ebcf29 1800\f
2076c87c
JB
1801(defun transpose-chars (arg)
1802 "Interchange characters around point, moving forward one character.
1803With prefix arg ARG, effect is to take character before point
1804and drag it forward past ARG other characters (backward if ARG negative).
1805If no argument and at end of line, the previous two chars are exchanged."
1806 (interactive "*P")
1807 (and (null arg) (eolp) (forward-char -1))
1808 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1809
1810(defun transpose-words (arg)
1811 "Interchange words around point, leaving point at end of them.
1812With prefix arg ARG, effect is to take word before or around point
1813and drag it forward past ARG other words (backward if ARG negative).
1814If ARG is zero, the words around or after point and around or after mark
1815are interchanged."
1816 (interactive "*p")
1817 (transpose-subr 'forward-word arg))
1818
1819(defun transpose-sexps (arg)
1820 "Like \\[transpose-words] but applies to sexps.
1821Does not work on a sexp that point is in the middle of
1822if it is a list or string."
1823 (interactive "*p")
1824 (transpose-subr 'forward-sexp arg))
1825
1826(defun transpose-lines (arg)
1827 "Exchange current line and previous line, leaving point after both.
1828With argument ARG, takes previous line and moves it past ARG lines.
1829With argument 0, interchanges line point is in with line mark is in."
1830 (interactive "*p")
1831 (transpose-subr (function
1832 (lambda (arg)
1833 (if (= arg 1)
1834 (progn
1835 ;; Move forward over a line,
1836 ;; but create a newline if none exists yet.
1837 (end-of-line)
1838 (if (eobp)
1839 (newline)
1840 (forward-char 1)))
1841 (forward-line arg))))
1842 arg))
1843
1844(defun transpose-subr (mover arg)
1845 (let (start1 end1 start2 end2)
1846 (if (= arg 0)
1847 (progn
1848 (save-excursion
1849 (funcall mover 1)
1850 (setq end2 (point))
1851 (funcall mover -1)
1852 (setq start2 (point))
1853 (goto-char (mark))
1854 (funcall mover 1)
1855 (setq end1 (point))
1856 (funcall mover -1)
1857 (setq start1 (point))
1858 (transpose-subr-1))
1859 (exchange-point-and-mark)))
1860 (while (> arg 0)
1861 (funcall mover -1)
1862 (setq start1 (point))
1863 (funcall mover 1)
1864 (setq end1 (point))
1865 (funcall mover 1)
1866 (setq end2 (point))
1867 (funcall mover -1)
1868 (setq start2 (point))
1869 (transpose-subr-1)
1870 (goto-char end2)
1871 (setq arg (1- arg)))
1872 (while (< arg 0)
1873 (funcall mover -1)
1874 (setq start2 (point))
1875 (funcall mover -1)
1876 (setq start1 (point))
1877 (funcall mover 1)
1878 (setq end1 (point))
1879 (funcall mover 1)
1880 (setq end2 (point))
1881 (transpose-subr-1)
1882 (setq arg (1+ arg)))))
1883
1884(defun transpose-subr-1 ()
1885 (if (> (min end1 end2) (max start1 start2))
1886 (error "Don't have two things to transpose"))
1887 (let ((word1 (buffer-substring start1 end1))
1888 (word2 (buffer-substring start2 end2)))
1889 (delete-region start2 end2)
1890 (goto-char start2)
1891 (insert word1)
1892 (goto-char (if (< start1 start2) start1
1893 (+ start1 (- (length word1) (length word2)))))
1894 (delete-char (length word1))
1895 (insert word2)))
1896\f
1897(defconst comment-column 32
1898 "*Column to indent right-margin comments to.
8a8fa723
JB
1899Setting this variable automatically makes it local to the current buffer.
1900Each mode establishes a different default value for this variable; you
b492f73b 1901can set the value for a particular mode using that mode's hook.")
2076c87c
JB
1902(make-variable-buffer-local 'comment-column)
1903
1904(defconst comment-start nil
1905 "*String to insert to start a new comment, or nil if no comment syntax defined.")
1906
1907(defconst comment-start-skip nil
1908 "*Regexp to match the start of a comment plus everything up to its body.
1909If there are any \\(...\\) pairs, the comment delimiter text is held to begin
1910at the place matched by the close of the first pair.")
1911
1912(defconst comment-end ""
1913 "*String to insert to end a new comment.
1914Should be an empty string if comments are terminated by end-of-line.")
1915
ec9a76e3
JB
1916(defconst comment-indent-hook nil
1917 "Obsolete variable for function to compute desired indentation for a comment.
1918This function is called with no args with point at the beginning of
1919the comment's starting delimiter.")
1920
1921(defconst comment-indent-function
2076c87c
JB
1922 '(lambda () comment-column)
1923 "Function to compute desired indentation for a comment.
1924This function is called with no args with point at the beginning of
1925the comment's starting delimiter.")
1926
1927(defun indent-for-comment ()
1928 "Indent this line's comment to comment column, or insert an empty comment."
1929 (interactive "*")
1930 (beginning-of-line 1)
1931 (if (null comment-start)
1932 (error "No comment syntax defined")
1933 (let* ((eolpos (save-excursion (end-of-line) (point)))
1934 cpos indent begpos)
1935 (if (re-search-forward comment-start-skip eolpos 'move)
1936 (progn (setq cpos (point-marker))
1937 ;; Find the start of the comment delimiter.
1938 ;; If there were paren-pairs in comment-start-skip,
1939 ;; position at the end of the first pair.
1940 (if (match-end 1)
1941 (goto-char (match-end 1))
9d0f559a
RM
1942 ;; If comment-start-skip matched a string with
1943 ;; internal whitespace (not final whitespace) then
1944 ;; the delimiter start at the end of that
1945 ;; whitespace. Otherwise, it starts at the
1946 ;; beginning of what was matched.
1947 (skip-syntax-backward " " (match-beginning 0))
1948 (skip-syntax-backward "^ " (match-beginning 0)))))
2076c87c
JB
1949 (setq begpos (point))
1950 ;; Compute desired indent.
1951 (if (= (current-column)
9d0f559a
RM
1952 (setq indent (if comment-indent-hook
1953 (funcall comment-indent-hook)
1954 (funcall comment-indent-function))))
2076c87c
JB
1955 (goto-char begpos)
1956 ;; If that's different from current, change it.
1957 (skip-chars-backward " \t")
1958 (delete-region (point) begpos)
1959 (indent-to indent))
1960 ;; An existing comment?
1961 (if cpos
1962 (progn (goto-char cpos)
1963 (set-marker cpos nil))
1964 ;; No, insert one.
1965 (insert comment-start)
1966 (save-excursion
1967 (insert comment-end))))))
1968
1969(defun set-comment-column (arg)
1970 "Set the comment column based on point.
1971With no arg, set the comment column to the current column.
1972With just minus as arg, kill any comment on this line.
1973With any other arg, set comment column to indentation of the previous comment
1974 and then align or create a comment on this line at that column."
1975 (interactive "P")
1976 (if (eq arg '-)
1977 (kill-comment nil)
1978 (if arg
1979 (progn
1980 (save-excursion
1981 (beginning-of-line)
1982 (re-search-backward comment-start-skip)
1983 (beginning-of-line)
1984 (re-search-forward comment-start-skip)
1985 (goto-char (match-beginning 0))
1986 (setq comment-column (current-column))
1987 (message "Comment column set to %d" comment-column))
1988 (indent-for-comment))
1989 (setq comment-column (current-column))
1990 (message "Comment column set to %d" comment-column))))
1991
1992(defun kill-comment (arg)
1993 "Kill the comment on this line, if any.
1994With argument, kill comments on that many lines starting with this one."
1995 ;; this function loses in a lot of situations. it incorrectly recognises
1996 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
1997 ;; with multi-line comments, can kill extra whitespace if comment wasn't
1998 ;; through end-of-line, et cetera.
1999 (interactive "P")
2000 (or comment-start-skip (error "No comment syntax defined"))
2001 (let ((count (prefix-numeric-value arg)) endc)
2002 (while (> count 0)
2003 (save-excursion
2004 (end-of-line)
2005 (setq endc (point))
2006 (beginning-of-line)
2007 (and (string< "" comment-end)
2008 (setq endc
2009 (progn
2010 (re-search-forward (regexp-quote comment-end) endc 'move)
2011 (skip-chars-forward " \t")
2012 (point))))
2013 (beginning-of-line)
2014 (if (re-search-forward comment-start-skip endc t)
2015 (progn
2016 (goto-char (match-beginning 0))
2017 (skip-chars-backward " \t")
2018 (kill-region (point) endc)
2019 ;; to catch comments a line beginnings
2020 (indent-according-to-mode))))
2021 (if arg (forward-line 1))
2022 (setq count (1- count)))))
2023
2024(defun comment-region (beg end &optional arg)
f28039bb
RS
2025 "Comment or uncomment each line in the region.
2026With just C-u prefix arg, uncomment each line in region.
2027Numeric prefix arg ARG means use ARG comment characters.
2076c87c
JB
2028If ARG is negative, delete that many comment characters instead.
2029Comments are terminated on each line, even for syntax in which newline does
2030not end the comment. Blank lines do not get comments."
2031 ;; if someone wants it to only put a comment-start at the beginning and
2032 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2033 ;; is easy enough. No option is made here for other than commenting
2034 ;; every line.
f28039bb 2035 (interactive "r\nP")
2076c87c
JB
2036 (or comment-start (error "No comment syntax is defined"))
2037 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
2038 (save-excursion
2039 (save-restriction
f28039bb
RS
2040 (let ((cs comment-start) (ce comment-end)
2041 numarg)
2042 (if (consp arg) (setq numarg t)
2043 (setq numarg (prefix-numeric-value arg))
2044 ;; For positive arg > 1, replicate the comment delims now,
2045 ;; then insert the replicated strings just once.
2046 (while (> numarg 1)
2047 (setq cs (concat cs comment-start)
2048 ce (concat ce comment-end))
2049 (setq numarg (1- numarg))))
2050 ;; Loop over all lines from BEG to END.
2076c87c
JB
2051 (narrow-to-region beg end)
2052 (goto-char beg)
2053 (while (not (eobp))
f28039bb
RS
2054 (if (or (eq numarg t) (< numarg 0))
2055 (progn
2056 ;; Delete comment start from beginning of line.
2057 (if (eq numarg t)
2058 (while (looking-at (regexp-quote cs))
2059 (delete-char (length cs)))
2060 (let ((count numarg))
2061 (while (and (> 1 (setq count (1+ count)))
2062 (looking-at (regexp-quote cs)))
2063 (delete-char (length cs)))))
2064 ;; Delete comment end from end of line.
2065 (if (string= "" ce)
2066 nil
2067 (if (eq numarg t)
2068 (progn
2069 (end-of-line)
2070 ;; This is questionable if comment-end ends in
2071 ;; whitespace. That is pretty brain-damaged,
2072 ;; though.
2073 (skip-chars-backward " \t")
2074 (if (and (>= (- (point) (point-min)) (length ce))
2075 (save-excursion
2076 (backward-char (length ce))
2077 (looking-at (regexp-quote ce))))
2078 (delete-char (- (length ce)))))
ee095968
RS
2079 (let ((count numarg))
2080 (while (> 1 (setq count (1+ count)))
2081 (end-of-line)
2082 ;; this is questionable if comment-end ends in whitespace
2083 ;; that is pretty brain-damaged though
2084 (skip-chars-backward " \t")
2085 (save-excursion
2086 (backward-char (length ce))
2087 (if (looking-at (regexp-quote ce))
2088 (delete-char (length ce))))))))
6e88ed49 2089 (forward-line 1))
f28039bb 2090 ;; Insert at beginning and at end.
2076c87c
JB
2091 (if (looking-at "[ \t]*$") ()
2092 (insert cs)
2093 (if (string= "" ce) ()
2094 (end-of-line)
2095 (insert ce)))
2096 (search-forward "\n" nil 'move)))))))
2097\f
2098(defun backward-word (arg)
2099 "Move backward until encountering the end of a word.
2100With argument, do this that many times.
ff1fbe3e 2101In programs, it is faster to call `forward-word' with negative arg."
9e50756b 2102 (interactive "p")
2076c87c
JB
2103 (forward-word (- arg)))
2104
2105(defun mark-word (arg)
2106 "Set mark arg words away from point."
2107 (interactive "p")
2108 (push-mark
2109 (save-excursion
2110 (forward-word arg)
fd0f4056
RS
2111 (point))
2112 nil t))
2076c87c
JB
2113
2114(defun kill-word (arg)
2115 "Kill characters forward until encountering the end of a word.
2116With argument, do this that many times."
2117 (interactive "p")
e6291fe1 2118 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
2119
2120(defun backward-kill-word (arg)
2121 "Kill characters backward until encountering the end of a word.
2122With argument, do this that many times."
2123 (interactive "p")
2124 (kill-word (- arg)))
d7c64071 2125
1e8c5ac4
RS
2126(defun current-word (&optional strict)
2127 "Return the word point is on (or a nearby word) as a string.
2128If optional arg STRICT is non-nil, return nil unless point is within
2129or adjacent to a word."
d7c64071
ER
2130 (save-excursion
2131 (let ((oldpoint (point)) (start (point)) (end (point)))
2132 (skip-syntax-backward "w_") (setq start (point))
2133 (goto-char oldpoint)
2134 (skip-syntax-forward "w_") (setq end (point))
2135 (if (and (eq start oldpoint) (eq end oldpoint))
1e8c5ac4
RS
2136 ;; Point is neither within nor adjacent to a word.
2137 (and (not strict)
2138 (progn
2139 ;; Look for preceding word in same line.
2140 (skip-syntax-backward "^w_"
2141 (save-excursion (beginning-of-line)
2142 (point)))
2143 (if (bolp)
2144 ;; No preceding word in same line.
2145 ;; Look for following word in same line.
2146 (progn
2147 (skip-syntax-forward "^w_"
2148 (save-excursion (end-of-line)
2149 (point)))
2150 (setq start (point))
2151 (skip-syntax-forward "w_")
2152 (setq end (point)))
2153 (setq end (point))
2154 (skip-syntax-backward "w_")
2155 (setq start (point)))
2156 (buffer-substring start end)))
2157 (buffer-substring start end)))))
2076c87c
JB
2158\f
2159(defconst fill-prefix nil
2160 "*String for filling to insert at front of new line, or nil for none.
2161Setting this variable automatically makes it local to the current buffer.")
2162(make-variable-buffer-local 'fill-prefix)
2163
2164(defconst auto-fill-inhibit-regexp nil
2165 "*Regexp to match lines which should not be auto-filled.")
2166
2167(defun do-auto-fill ()
2168 (let (give-up)
2169 (or (and auto-fill-inhibit-regexp
2170 (save-excursion (beginning-of-line)
2171 (looking-at auto-fill-inhibit-regexp)))
2172 (while (and (not give-up) (> (current-column) fill-column))
756811fb 2173 ;; Determine where to split the line.
2076c87c 2174 (let ((fill-point
756811fb
RS
2175 (let ((opoint (point))
2176 bounce
2177 (first t))
2076c87c
JB
2178 (save-excursion
2179 (move-to-column (1+ fill-column))
756811fb
RS
2180 ;; Move back to a word boundary.
2181 (while (or first
2182 ;; If this is after period and a single space,
2183 ;; move back once more--we don't want to break
2184 ;; the line there and make it look like a
2185 ;; sentence end.
2186 (and (not (bobp))
2187 (not bounce)
2188 sentence-end-double-space
2189 (save-excursion (forward-char -1)
2190 (and (looking-at "\\. ")
2191 (not (looking-at "\\. "))))))
2192 (setq first nil)
2193 (skip-chars-backward "^ \t\n")
2194 ;; If we find nowhere on the line to break it,
2195 ;; break after one word. Set bounce to t
2196 ;; so we will not keep going in this while loop.
2197 (if (bolp)
2198 (progn
2199 (re-search-forward "[ \t]" opoint t)
2200 (setq bounce t)))
2201 (skip-chars-backward " \t"))
2202 ;; Let fill-point be set to the place where we end up.
2076c87c 2203 (point)))))
756811fb
RS
2204 ;; If that place is not the beginning of the line,
2205 ;; break the line there.
2076c87c
JB
2206 (if (save-excursion
2207 (goto-char fill-point)
2208 (not (bolp)))
34b45e32
RS
2209 (let ((prev-column (current-column)))
2210 ;; If point is at the fill-point, do not `save-excursion'.
2211 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2212 ;; point will end up before it rather than after it.
2213 (if (save-excursion
2214 (skip-chars-backward " \t")
2215 (= (point) fill-point))
2216 (indent-new-comment-line)
2217 (save-excursion
2218 (goto-char fill-point)
2219 (indent-new-comment-line)))
2220 ;; If making the new line didn't reduce the hpos of
2221 ;; the end of the line, then give up now;
2222 ;; trying again will not help.
2223 (if (>= (current-column) prev-column)
2224 (setq give-up t)))
2076c87c
JB
2225 ;; No place to break => stop trying.
2226 (setq give-up t)))))))
2227
d7465b15
RS
2228(defun auto-fill-mode (&optional arg)
2229 "Toggle auto-fill mode.
2230With arg, turn Auto-Fill mode on if and only if arg is positive.
2231In Auto-Fill mode, inserting a space at a column beyond `fill-column'
2232automatically breaks the line at a previous space."
2233 (interactive "P")
2234 (prog1 (setq auto-fill-function
2235 (if (if (null arg)
2236 (not auto-fill-function)
2237 (> (prefix-numeric-value arg) 0))
2238 'do-auto-fill
2239 nil))
2240 ;; update mode-line
2241 (set-buffer-modified-p (buffer-modified-p))))
2242
2243;; This holds a document string used to document auto-fill-mode.
2244(defun auto-fill-function ()
2245 "Automatically break line at a previous space, in insertion of text."
2246 nil)
2247
2248(defun turn-on-auto-fill ()
2249 "Unconditionally turn on Auto Fill mode."
2250 (auto-fill-mode 1))
2251
2252(defun set-fill-column (arg)
2253 "Set `fill-column' to current column, or to argument if given.
2254The variable `fill-column' has a separate value for each buffer."
2255 (interactive "P")
2256 (setq fill-column (if (integerp arg) arg (current-column)))
2257 (message "fill-column set to %d" fill-column))
2258\f
2076c87c
JB
2259(defconst comment-multi-line nil
2260 "*Non-nil means \\[indent-new-comment-line] should continue same comment
c88ab9ce
ER
2261on new line, with no new terminator or starter.
2262This is obsolete because you might as well use \\[newline-and-indent].")
2076c87c
JB
2263
2264(defun indent-new-comment-line ()
d7465b15
RS
2265 "Break line at point and indent, continuing comment if within one.
2266This indents the body of the continued comment
2267under the previous comment line.
c88ab9ce
ER
2268
2269This command is intended for styles where you write a comment per line,
2270starting a new comment (and terminating it if necessary) on each line.
2271If you want to continue one comment across several lines, use \\[newline-and-indent]."
2076c87c
JB
2272 (interactive "*")
2273 (let (comcol comstart)
2274 (skip-chars-backward " \t")
2275 (delete-region (point)
2276 (progn (skip-chars-forward " \t")
2277 (point)))
2278 (insert ?\n)
c88ab9ce
ER
2279 (if (not comment-multi-line)
2280 (save-excursion
2281 (if (and comment-start-skip
2282 (let ((opoint (point)))
2283 (forward-line -1)
2284 (re-search-forward comment-start-skip opoint t)))
2285 ;; The old line is a comment.
2286 ;; Set WIN to the pos of the comment-start.
2287 ;; But if the comment is empty, look at preceding lines
2288 ;; to find one that has a nonempty comment.
2289 (let ((win (match-beginning 0)))
2290 (while (and (eolp) (not (bobp))
2291 (let (opoint)
2292 (beginning-of-line)
2293 (setq opoint (point))
2294 (forward-line -1)
2295 (re-search-forward comment-start-skip opoint t)))
2296 (setq win (match-beginning 0)))
2297 ;; Indent this line like what we found.
2298 (goto-char win)
2299 (setq comcol (current-column))
2300 (setq comstart (buffer-substring (point) (match-end 0)))))))
2076c87c
JB
2301 (if comcol
2302 (let ((comment-column comcol)
2303 (comment-start comstart)
2304 (comment-end comment-end))
2305 (and comment-end (not (equal comment-end ""))
c88ab9ce 2306; (if (not comment-multi-line)
2076c87c
JB
2307 (progn
2308 (forward-char -1)
2309 (insert comment-end)
2310 (forward-char 1))
c88ab9ce
ER
2311; (setq comment-column (+ comment-column (length comment-start))
2312; comment-start "")
2313; )
2314 )
2076c87c
JB
2315 (if (not (eolp))
2316 (setq comment-end ""))
2317 (insert ?\n)
2318 (forward-char -1)
2319 (indent-for-comment)
2320 (save-excursion
2321 ;; Make sure we delete the newline inserted above.
2322 (end-of-line)
2323 (delete-char 1)))
2324 (if fill-prefix
2325 (insert fill-prefix)
2326 (indent-according-to-mode)))))
2076c87c
JB
2327\f
2328(defun set-selective-display (arg)
ff1fbe3e
RS
2329 "Set `selective-display' to ARG; clear it if no arg.
2330When the value of `selective-display' is a number > 0,
2331lines whose indentation is >= that value are not displayed.
2332The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
2333 (interactive "P")
2334 (if (eq selective-display t)
2335 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
2336 (let ((current-vpos
2337 (save-restriction
2338 (narrow-to-region (point-min) (point))
2339 (goto-char (window-start))
2340 (vertical-motion (window-height)))))
2341 (setq selective-display
2342 (and arg (prefix-numeric-value arg)))
2343 (recenter current-vpos))
2076c87c
JB
2344 (set-window-start (selected-window) (window-start (selected-window)))
2345 (princ "selective-display set to " t)
2346 (prin1 selective-display t)
2347 (princ "." t))
2348
b6a22db0
JB
2349(defconst overwrite-mode-textual " Ovwrt"
2350 "The string displayed in the mode line when in overwrite mode.")
2351(defconst overwrite-mode-binary " Bin Ovwrt"
2352 "The string displayed in the mode line when in binary overwrite mode.")
2353
2076c87c
JB
2354(defun overwrite-mode (arg)
2355 "Toggle overwrite mode.
2356With arg, turn overwrite mode on iff arg is positive.
2357In overwrite mode, printing characters typed in replace existing text
b6a22db0
JB
2358on a one-for-one basis, rather than pushing it to the right. At the
2359end of a line, such characters extend the line. Before a tab,
2360such characters insert until the tab is filled in.
2361\\[quoted-insert] still inserts characters in overwrite mode; this
2362is supposed to make it easier to insert characters when necessary."
2363 (interactive "P")
2364 (setq overwrite-mode
2365 (if (if (null arg) (not overwrite-mode)
2366 (> (prefix-numeric-value arg) 0))
2367 'overwrite-mode-textual))
2368 (force-mode-line-update))
2369
2370(defun binary-overwrite-mode (arg)
2371 "Toggle binary overwrite mode.
2372With arg, turn binary overwrite mode on iff arg is positive.
2373In binary overwrite mode, printing characters typed in replace
2374existing text. Newlines are not treated specially, so typing at the
2375end of a line joins the line to the next, with the typed character
2376between them. Typing before a tab character simply replaces the tab
2377with the character typed.
2378\\[quoted-insert] replaces the text at the cursor, just as ordinary
2379typing characters do.
2380
2381Note that binary overwrite mode is not its own minor mode; it is a
2382specialization of overwrite-mode, entered by setting the
2383`overwrite-mode' variable to `overwrite-mode-binary'."
2076c87c
JB
2384 (interactive "P")
2385 (setq overwrite-mode
b6a22db0 2386 (if (if (null arg)
a61099dd 2387 (not (eq overwrite-mode 'overwrite-mode-binary))
b6a22db0
JB
2388 (> (prefix-numeric-value arg) 0))
2389 'overwrite-mode-binary))
2390 (force-mode-line-update))
2076c87c 2391\f
a61099dd
RS
2392(defvar line-number-mode nil
2393 "*Non-nil means display line number in mode line.")
2394
2395(defun line-number-mode (arg)
2396 "Toggle Line Number mode.
2397With arg, turn Line Number mode on iff arg is positive.
2398When Line Number mode is enabled, the line number appears
2399in the mode line."
2400 (interactive "P")
2401 (setq line-number-mode
2402 (if (null arg) (not line-number-mode)
2403 (> (prefix-numeric-value arg) 0)))
2404 (force-mode-line-update))
2405
2076c87c
JB
2406(defvar blink-matching-paren t
2407 "*Non-nil means show matching open-paren when close-paren is inserted.")
2408
37315725
RS
2409(defconst blink-matching-paren-distance 12000
2410 "*If non-nil, is maximum distance to search for matching open-paren.")
2076c87c 2411
72dddf8b
RS
2412(defconst blink-matching-delay 1
2413 "*The number of seconds that `blink-matching-open' will delay at a match.")
2414
2076c87c
JB
2415(defun blink-matching-open ()
2416 "Move cursor momentarily to the beginning of the sexp before point."
2417 (interactive)
2418 (and (> (point) (1+ (point-min)))
2076c87c 2419 blink-matching-paren
7e1ddd45
RS
2420 ;; Verify an even number of quoting characters precede the close.
2421 (= 1 (logand 1 (- (point)
2422 (save-excursion
2423 (forward-char -1)
2424 (skip-syntax-backward "/\\")
2425 (point)))))
2076c87c
JB
2426 (let* ((oldpos (point))
2427 (blinkpos)
2428 (mismatch))
2429 (save-excursion
2430 (save-restriction
2431 (if blink-matching-paren-distance
2432 (narrow-to-region (max (point-min)
2433 (- (point) blink-matching-paren-distance))
2434 oldpos))
2435 (condition-case ()
2436 (setq blinkpos (scan-sexps oldpos -1))
2437 (error nil)))
2438 (and blinkpos (/= (char-syntax (char-after blinkpos))
2439 ?\$)
2440 (setq mismatch
2441 (/= (char-after (1- oldpos))
7492f5a6 2442 (matching-paren (char-after blinkpos)))))
2076c87c
JB
2443 (if mismatch (setq blinkpos nil))
2444 (if blinkpos
2445 (progn
2446 (goto-char blinkpos)
2447 (if (pos-visible-in-window-p)
72dddf8b 2448 (sit-for blink-matching-delay)
2076c87c
JB
2449 (goto-char blinkpos)
2450 (message
2451 "Matches %s"
e9f1d66d 2452 ;; Show what precedes the open in its line, if anything.
2076c87c
JB
2453 (if (save-excursion
2454 (skip-chars-backward " \t")
2455 (not (bolp)))
2456 (buffer-substring (progn (beginning-of-line) (point))
2457 (1+ blinkpos))
e9f1d66d
RS
2458 ;; Show what follows the open in its line, if anything.
2459 (if (save-excursion
2460 (forward-char 1)
2461 (skip-chars-forward " \t")
2462 (not (eolp)))
2463 (buffer-substring blinkpos
2464 (progn (end-of-line) (point)))
267935b9
RS
2465 ;; Otherwise show the previous nonblank line,
2466 ;; if there is one.
2467 (if (save-excursion
2468 (skip-chars-backward "\n \t")
2469 (not (bobp)))
2470 (concat
2471 (buffer-substring (progn
2472 (skip-chars-backward "\n \t")
2473 (beginning-of-line)
2474 (point))
2475 (progn (end-of-line)
2476 (skip-chars-backward " \t")
2477 (point)))
2478 ;; Replace the newline and other whitespace with `...'.
2479 "..."
2480 (buffer-substring blinkpos (1+ blinkpos)))
2481 ;; There is nothing to show except the char itself.
2482 (buffer-substring blinkpos (1+ blinkpos))))))))
2076c87c
JB
2483 (cond (mismatch
2484 (message "Mismatched parentheses"))
2485 ((not blink-matching-paren-distance)
2486 (message "Unmatched parenthesis"))))))))
2487
2488;Turned off because it makes dbx bomb out.
2489(setq blink-paren-function 'blink-matching-open)
2490
9a1277dd
RS
2491;; This executes C-g typed while Emacs is waiting for a command.
2492;; Quitting out of a program does not go through here;
2493;; that happens in the QUIT macro at the C code level.
2076c87c 2494(defun keyboard-quit ()
af39530e
RS
2495 "Signal a quit condition.
2496During execution of Lisp code, this character causes a quit directly.
2497At top-level, as an editor command, this simply beeps."
2076c87c 2498 (interactive)
19d35374 2499 (deactivate-mark)
2076c87c
JB
2500 (signal 'quit nil))
2501
2502(define-key global-map "\C-g" 'keyboard-quit)
c66587fe 2503
1c6c6fde
RS
2504(defvar buffer-quit-function nil
2505 "Function to call to \"quit\" the current buffer, or nil if none.
2506\\[keyboard-escape-quit] calls this function when its more local actions
2507\(such as cancelling a prefix argument, minibuffer or region) do not apply.")
2508
c66587fe
RS
2509(defun keyboard-escape-quit ()
2510 "Exit the current \"mode\" (in a generalized sense of the word).
2511This command can exit an interactive command such as `query-replace',
2512can clear out a prefix argument or a region,
2513can get out of the minibuffer or other recursive edit,
1c6c6fde
RS
2514cancel the use of the current buffer (for special-purpose buffers),
2515or go back to just one window (by deleting all but the selected window)."
c66587fe
RS
2516 (interactive)
2517 (cond ((eq last-command 'mode-exited) nil)
2518 ((> (minibuffer-depth) 0)
2519 (abort-recursive-edit))
2520 (current-prefix-arg
2521 nil)
2522 ((and transient-mark-mode
2523 mark-active)
2524 (deactivate-mark))
1c6c6fde
RS
2525 (buffer-quit-function
2526 (funcall buffer-quit-function))
c66587fe
RS
2527 ((not (one-window-p t))
2528 (delete-other-windows))))
2529
1c6c6fde 2530(define-key global-map "\e\e\e" 'keyboard-escape-quit)
2076c87c
JB
2531\f
2532(defun set-variable (var val)
2533 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2534When using this interactively, supply a Lisp expression for VALUE.
3a801d0c
ER
2535If you want VALUE to be a string, you must surround it with doublequotes.
2536
2537If VARIABLE has a `variable-interactive' property, that is used as if
2538it were the arg to `interactive' (which see) to interactively read the value."
2076c87c
JB
2539 (interactive
2540 (let* ((var (read-variable "Set variable: "))
2541 (minibuffer-help-form
2542 '(funcall myhelp))
2543 (myhelp
2544 (function
2545 (lambda ()
2546 (with-output-to-temp-buffer "*Help*"
2547 (prin1 var)
2548 (princ "\nDocumentation:\n")
2549 (princ (substring (documentation-property var 'variable-documentation)
2550 1))
2551 (if (boundp var)
2552 (let ((print-length 20))
2553 (princ "\n\nCurrent value: ")
2554 (prin1 (symbol-value var))))
e6bcd155
KH
2555 (save-excursion
2556 (set-buffer standard-output)
2557 (help-mode))
2076c87c
JB
2558 nil)))))
2559 (list var
3a801d0c
ER
2560 (let ((prop (get var 'variable-interactive)))
2561 (if prop
2562 ;; Use VAR's `variable-interactive' property
2563 ;; as an interactive spec for prompting.
2564 (call-interactively (list 'lambda '(arg)
2565 (list 'interactive prop)
2566 'arg))
2567 (eval-minibuffer (format "Set %s to value: " var)))))))
2076c87c 2568 (set var val))
e8a700bf
RS
2569\f
2570;; Define the major mode for lists of completions.
2571
ac29eb79
RS
2572(defvar completion-list-mode-map nil)
2573(or completion-list-mode-map
e8a700bf
RS
2574 (let ((map (make-sparse-keymap)))
2575 (define-key map [mouse-2] 'mouse-choose-completion)
eaf76065 2576 (define-key map [down-mouse-2] nil)
80298193
RS
2577 (define-key map "\C-m" 'choose-completion)
2578 (define-key map [return] 'choose-completion)
1c6c6fde 2579 (define-key map "\e\e\e" 'delete-completion-window)
ac29eb79 2580 (setq completion-list-mode-map map)))
e8a700bf
RS
2581
2582;; Completion mode is suitable only for specially formatted data.
ac29eb79 2583(put 'completion-list-mode 'mode-class 'special)
e8a700bf 2584
3819736b
RS
2585;; Record the buffer that was current when the completion list was requested.
2586(defvar completion-reference-buffer)
2587
f6b293e3
RS
2588;; This records the length of the text at the beginning of the buffer
2589;; which was not included in the completion.
2590(defvar completion-base-size nil)
2591
1c6c6fde
RS
2592(defun delete-completion-window ()
2593 "Delete the completion list window.
2594Go to the window from which completion was requested."
2595 (interactive)
2596 (let ((buf completion-reference-buffer))
2597 (delete-window (selected-window))
2598 (if (get-buffer-window buf)
2599 (select-window (get-buffer-window buf)))))
2600
80298193
RS
2601(defun choose-completion ()
2602 "Choose the completion that point is in or next to."
2603 (interactive)
f6b293e3
RS
2604 (let (beg end completion (buffer completion-reference-buffer)
2605 (base-size completion-base-size))
6096f362
RS
2606 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
2607 (setq end (point) beg (1+ (point))))
2608 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
2609 (setq end (1- (point)) beg(point)))
2610 (if (null beg)
2611 (error "No completion here"))
2612 (setq beg (previous-single-property-change beg 'mouse-face))
88dd3c24 2613 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
ab63960f
RS
2614 (setq completion (buffer-substring beg end))
2615 (let ((owindow (selected-window)))
2616 (if (and (one-window-p t 'selected-frame)
2617 (window-dedicated-p (selected-window)))
2618 ;; This is a special buffer's frame
2619 (iconify-frame (selected-frame))
2620 (or (window-dedicated-p (selected-window))
2621 (bury-buffer)))
2622 (select-window owindow))
f6b293e3 2623 (choose-completion-string completion buffer base-size)))
80298193
RS
2624
2625;; Delete the longest partial match for STRING
2626;; that can be found before POINT.
2627(defun choose-completion-delete-max-match (string)
2628 (let ((opoint (point))
2629 (len (min (length string)
2630 (- (point) (point-min)))))
2631 (goto-char (- (point) (length string)))
61bbf6fe
RS
2632 (if completion-ignore-case
2633 (setq string (downcase string)))
80298193
RS
2634 (while (and (> len 0)
2635 (let ((tail (buffer-substring (point)
2636 (+ (point) len))))
61bbf6fe
RS
2637 (if completion-ignore-case
2638 (setq tail (downcase tail)))
80298193
RS
2639 (not (string= tail (substring string 0 len)))))
2640 (setq len (1- len))
2641 (forward-char 1))
2642 (delete-char len)))
2643
f6b293e3 2644(defun choose-completion-string (choice &optional buffer base-size)
80298193 2645 (let ((buffer (or buffer completion-reference-buffer)))
cf52ad58
RS
2646 ;; If BUFFER is a minibuffer, barf unless it's the currently
2647 ;; active minibuffer.
2648 (if (and (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))
2649 (or (not (minibuffer-window-active-p (minibuffer-window)))
2650 (not (equal buffer (window-buffer (minibuffer-window))))))
2651 (error "Minibuffer is not active for completion")
2652 ;; Insert the completion into the buffer where completion was requested.
2653 (set-buffer buffer)
f6b293e3
RS
2654 (if base-size
2655 (delete-region (+ base-size (point-min)) (point))
2656 (choose-completion-delete-max-match choice))
cf52ad58 2657 (insert choice)
63240af1
RS
2658 (remove-text-properties (- (point) (length choice)) (point)
2659 '(mouse-face nil))
cf52ad58
RS
2660 ;; Update point in the window that BUFFER is showing in.
2661 (let ((window (get-buffer-window buffer t)))
2662 (set-window-point window (point)))
2663 ;; If completing for the minibuffer, exit it with this choice.
2664 (and (equal buffer (window-buffer (minibuffer-window)))
8881ad9a
RS
2665 minibuffer-completion-table
2666 (exit-minibuffer)))))
80298193 2667
ac29eb79 2668(defun completion-list-mode ()
e8a700bf 2669 "Major mode for buffers showing lists of possible completions.
80298193
RS
2670Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
2671 to select the completion near point.
2672Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
2673 with the mouse."
e8a700bf
RS
2674 (interactive)
2675 (kill-all-local-variables)
ac29eb79
RS
2676 (use-local-map completion-list-mode-map)
2677 (setq mode-name "Completion List")
2678 (setq major-mode 'completion-list-mode)
f6b293e3
RS
2679 (make-local-variable 'completion-base-size)
2680 (setq completion-base-size nil)
ac29eb79 2681 (run-hooks 'completion-list-mode-hook))
e8a700bf 2682
6096f362
RS
2683(defvar completion-fixup-function nil)
2684
e8a700bf
RS
2685(defun completion-setup-function ()
2686 (save-excursion
3819736b
RS
2687 (let ((mainbuf (current-buffer)))
2688 (set-buffer standard-output)
2689 (completion-list-mode)
2690 (make-local-variable 'completion-reference-buffer)
2691 (setq completion-reference-buffer mainbuf)
2692 (goto-char (point-min))
2693 (if window-system
2694 (insert (substitute-command-keys
80298193
RS
2695 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
2696 (insert (substitute-command-keys
2697 "In this buffer, type \\[choose-completion] to \
c26bb96e
KH
2698select the completion near point.\n\n"))
2699 (forward-line 1)
6096f362
RS
2700 (while (re-search-forward "[^ \t\n]+\\( [^ \t\n]+\\)*" nil t)
2701 (let ((beg (match-beginning 0))
2702 (end (point)))
2703 (if completion-fixup-function
2704 (funcall completion-fixup-function))
2705 (put-text-property beg (point) 'mouse-face 'highlight)
2706 (goto-char end))))))
c88ab9ce 2707
e8a700bf 2708(add-hook 'completion-setup-hook 'completion-setup-function)
a3d1480b
JB
2709\f
2710;;;; Keypad support.
2711
2712;;; Make the keypad keys act like ordinary typing keys. If people add
2713;;; bindings for the function key symbols, then those bindings will
2714;;; override these, so this shouldn't interfere with any existing
2715;;; bindings.
2716
0d173134 2717;; Also tell read-char how to handle these keys.
a3d1480b
JB
2718(mapcar
2719 (lambda (keypad-normal)
2720 (let ((keypad (nth 0 keypad-normal))
2721 (normal (nth 1 keypad-normal)))
0d173134 2722 (put keypad 'ascii-character normal)
a3d1480b
JB
2723 (define-key function-key-map (vector keypad) (vector normal))))
2724 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
2725 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
2726 (kp-space ?\ )
2727 (kp-tab ?\t)
2728 (kp-enter ?\r)
2729 (kp-multiply ?*)
2730 (kp-add ?+)
2731 (kp-separator ?,)
2732 (kp-subtract ?-)
2733 (kp-decimal ?.)
2734 (kp-divide ?/)
2735 (kp-equal ?=)))
2736
c88ab9ce 2737;;; simple.el ends here