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