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