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