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