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