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