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