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