(internal_self_insert): Don't return 2 for auto-fill
[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 896 (delete-region (max start end) (point-max))
aa247686 897 (delete-region (point-min) (min 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."
c3d4f949 1376 (interactive
a3e7c391
FP
1377 (list
1378 (progn
1379 (barf-if-buffer-read-only)
1380 (read-buffer "Insert buffer: "
1381 (if (eq (selected-window) (next-window (selected-window)))
1382 (other-buffer (current-buffer))
1383 (window-buffer (next-window (selected-window))))
1384 t))))
2076c87c
JB
1385 (or (bufferp buffer)
1386 (setq buffer (get-buffer buffer)))
1387 (let (start end newmark)
1388 (save-excursion
1389 (save-excursion
1390 (set-buffer buffer)
1391 (setq start (point-min) end (point-max)))
1392 (insert-buffer-substring buffer start end)
1393 (setq newmark (point)))
1537a263
JB
1394 (push-mark newmark))
1395 nil)
2076c87c
JB
1396
1397(defun append-to-buffer (buffer start end)
1398 "Append to specified buffer the text of the region.
1399It is inserted into that buffer before its point.
1400
1401When calling from a program, give three arguments:
1402BUFFER (or buffer name), START and END.
1403START and END specify the portion of the current buffer to be copied."
70e14c01 1404 (interactive
5d771766 1405 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 1406 (region-beginning) (region-end)))
2076c87c
JB
1407 (let ((oldbuf (current-buffer)))
1408 (save-excursion
1409 (set-buffer (get-buffer-create buffer))
1410 (insert-buffer-substring oldbuf start end))))
1411
1412(defun prepend-to-buffer (buffer start end)
1413 "Prepend to specified buffer the text of the region.
1414It is inserted into that buffer after its point.
1415
1416When calling from a program, give three arguments:
1417BUFFER (or buffer name), START and END.
1418START and END specify the portion of the current buffer to be copied."
1419 (interactive "BPrepend to buffer: \nr")
1420 (let ((oldbuf (current-buffer)))
1421 (save-excursion
1422 (set-buffer (get-buffer-create buffer))
1423 (save-excursion
1424 (insert-buffer-substring oldbuf start end)))))
1425
1426(defun copy-to-buffer (buffer start end)
1427 "Copy to specified buffer the text of the region.
1428It is inserted into that buffer, replacing existing text there.
1429
1430When calling from a program, give three arguments:
1431BUFFER (or buffer name), START and END.
1432START and END specify the portion of the current buffer to be copied."
1433 (interactive "BCopy to buffer: \nr")
1434 (let ((oldbuf (current-buffer)))
1435 (save-excursion
1436 (set-buffer (get-buffer-create buffer))
1437 (erase-buffer)
1438 (save-excursion
1439 (insert-buffer-substring oldbuf start end)))))
1440\f
62d1c1fc
RM
1441(put 'mark-inactive 'error-conditions '(mark-inactive error))
1442(put 'mark-inactive 'error-message "The mark is not active now")
1443
af39530e 1444(defun mark (&optional force)
c7c8b31e 1445 "Return this buffer's mark value as integer; error if mark inactive.
af39530e 1446If optional argument FORCE is non-nil, access the mark value
c7c8b31e
RS
1447even if the mark is not currently active, and return nil
1448if there is no mark at all.
af39530e 1449
2076c87c
JB
1450If you are using this in an editing command, you are most likely making
1451a mistake; see the documentation of `set-mark'."
0e3a7b14 1452 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
af39530e 1453 (marker-position (mark-marker))
62d1c1fc 1454 (signal 'mark-inactive nil)))
2076c87c 1455
19d35374
RM
1456;; Many places set mark-active directly, and several of them failed to also
1457;; run deactivate-mark-hook. This shorthand should simplify.
1458(defsubst deactivate-mark ()
1459 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 1460\(That makes a difference only in Transient Mark mode.)
19d35374 1461Also runs the hook `deactivate-mark-hook'."
a4b9d3da
RS
1462 (if transient-mark-mode
1463 (progn
1464 (setq mark-active nil)
1465 (run-hooks 'deactivate-mark-hook))))
19d35374 1466
2076c87c
JB
1467(defun set-mark (pos)
1468 "Set this buffer's mark to POS. Don't use this function!
1469That is to say, don't use this function unless you want
1470the user to see that the mark has moved, and you want the previous
1471mark position to be lost.
1472
1473Normally, when a new mark is set, the old one should go on the stack.
1474This is why most applications should use push-mark, not set-mark.
1475
ff1fbe3e 1476Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
1477purposes. The mark saves a location for the user's convenience.
1478Most editing commands should not alter the mark.
1479To remember a location for internal use in the Lisp program,
1480store it in a Lisp variable. Example:
1481
1482 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1483
fcadf1c7
RS
1484 (if pos
1485 (progn
1486 (setq mark-active t)
1487 (run-hooks 'activate-mark-hook)
1488 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
1489 ;; Normally we never clear mark-active except in Transient Mark mode.
1490 ;; But when we actually clear out the mark value too,
1491 ;; we must clear mark-active in any mode.
1492 (setq mark-active nil)
1493 (run-hooks 'deactivate-mark-hook)
1494 (set-marker (mark-marker) nil)))
2076c87c
JB
1495
1496(defvar mark-ring nil
e55e2267 1497 "The list of former marks of the current buffer, most recent first.")
2076c87c 1498(make-variable-buffer-local 'mark-ring)
e55e2267 1499(put 'mark-ring 'permanent-local t)
2076c87c
JB
1500
1501(defconst mark-ring-max 16
1502 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1503
dc029f0b
RM
1504(defvar global-mark-ring nil
1505 "The list of saved global marks, most recent first.")
1506
1507(defconst global-mark-ring-max 16
1508 "*Maximum size of global mark ring. \
1509Start discarding off end if gets this big.")
1510
2076c87c
JB
1511(defun set-mark-command (arg)
1512 "Set mark at where point is, or jump to mark.
dc029f0b
RM
1513With no prefix argument, set mark, push old mark position on local mark
1514ring, and push mark on global mark ring.
1515With argument, jump to mark, and pop a new position for mark off the ring
1516\(does not affect global mark ring\).
2076c87c 1517
ff1fbe3e 1518Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
1519purposes. See the documentation of `set-mark' for more information."
1520 (interactive "P")
1521 (if (null arg)
9a1277dd 1522 (progn
fd0f4056 1523 (push-mark nil nil t))
af39530e 1524 (if (null (mark t))
2076c87c 1525 (error "No mark set in this buffer")
9a1277dd 1526 (goto-char (mark t))
2076c87c
JB
1527 (pop-mark))))
1528
fd0f4056 1529(defun push-mark (&optional location nomsg activate)
2076c87c 1530 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
1531If the last global mark pushed was not in the current buffer,
1532also push LOCATION on the global mark ring.
fd0f4056 1533Display `Mark set' unless the optional second arg NOMSG is non-nil.
8cdc660f 1534In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2076c87c 1535
ff1fbe3e 1536Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
1537purposes. See the documentation of `set-mark' for more information.
1538
1539In Transient Mark mode, this does not activate the mark."
af39530e 1540 (if (null (mark t))
2076c87c
JB
1541 nil
1542 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1543 (if (> (length mark-ring) mark-ring-max)
1544 (progn
1545 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1546 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
9a1277dd 1547 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 1548 ;; Now push the mark on the global mark ring.
f1382a3d 1549 (if (and global-mark-ring
e08d3f7c 1550 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
1551 ;; The last global mark pushed was in this same buffer.
1552 ;; Don't push another one.
1553 nil
1554 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
dc029f0b
RM
1555 (if (> (length global-mark-ring) global-mark-ring-max)
1556 (progn
1557 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1558 nil)
f1382a3d 1559 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2076c87c
JB
1560 (or nomsg executing-macro (> (minibuffer-depth) 0)
1561 (message "Mark set"))
8cdc660f
RS
1562 (if (or activate (not transient-mark-mode))
1563 (set-mark (mark t)))
2076c87c
JB
1564 nil)
1565
1566(defun pop-mark ()
1567 "Pop off mark ring into the buffer's actual mark.
1568Does not set point. Does nothing if mark ring is empty."
1569 (if mark-ring
1570 (progn
1571 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
9a1277dd 1572 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
19d35374 1573 (deactivate-mark)
2076c87c 1574 (move-marker (car mark-ring) nil)
9a1277dd 1575 (if (null (mark t)) (ding))
2076c87c
JB
1576 (setq mark-ring (cdr mark-ring)))))
1577
dff7d67f 1578(define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
2076c87c 1579(defun exchange-point-and-mark ()
af39530e
RS
1580 "Put the mark where point is now, and point where the mark is now.
1581This command works even when the mark is not active,
1582and it reactivates the mark."
2076c87c 1583 (interactive nil)
af39530e 1584 (let ((omark (mark t)))
2076c87c
JB
1585 (if (null omark)
1586 (error "No mark set in this buffer"))
1587 (set-mark (point))
1588 (goto-char omark)
1589 nil))
e23c2c21
RS
1590
1591(defun transient-mark-mode (arg)
1592 "Toggle Transient Mark mode.
b411b5fa 1593With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 1594
5dd1220d
RS
1595In Transient Mark mode, when the mark is active, the region is highlighted.
1596Changing the buffer \"deactivates\" the mark.
1597So do certain other operations that set the mark
1598but whose main purpose is something else--for example,
1599incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
e23c2c21
RS
1600 (interactive "P")
1601 (setq transient-mark-mode
1602 (if (null arg)
1603 (not transient-mark-mode)
1604 (> (prefix-numeric-value arg) 0))))
dc029f0b
RM
1605
1606(defun pop-global-mark ()
1607 "Pop off global mark ring and jump to the top location."
1608 (interactive)
52b6d445
RS
1609 ;; Pop entries which refer to non-existent buffers.
1610 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1611 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
1612 (or global-mark-ring
1613 (error "No global mark set"))
1614 (let* ((marker (car global-mark-ring))
1615 (buffer (marker-buffer marker))
1616 (position (marker-position marker)))
34c31301
RS
1617 (setq global-mark-ring (nconc (cdr global-mark-ring)
1618 (list (car global-mark-ring))))
dc029f0b
RM
1619 (set-buffer buffer)
1620 (or (and (>= position (point-min))
1621 (<= position (point-max)))
1622 (widen))
1623 (goto-char position)
1624 (switch-to-buffer buffer)))
2076c87c 1625\f
38ebcf29 1626(defvar next-line-add-newlines t
dff7d67f 1627 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
38ebcf29 1628
2076c87c
JB
1629(defun next-line (arg)
1630 "Move cursor vertically down ARG lines.
1631If there is no character in the target line exactly under the current column,
1632the cursor is positioned after the character in that line which spans this
1633column, or at the end of the line if it is not long enough.
38ebcf29 1634If there is no line in the buffer after this one, behavior depends on the
1a2c3941
RS
1635value of `next-line-add-newlines'. If non-nil, it inserts a newline character
1636to create a line, and moves the cursor to that line. Otherwise it moves the
e47d38f6 1637cursor to the end of the buffer.
2076c87c
JB
1638
1639The command \\[set-goal-column] can be used to create
1640a semipermanent goal column to which this command always moves.
1641Then it does not try to move vertically. This goal column is stored
1642in `goal-column', which is nil when there is none.
1643
1644If you are thinking of using this in a Lisp program, consider
1645using `forward-line' instead. It is usually easier to use
1646and more reliable (no dependence on goal column, etc.)."
1647 (interactive "p")
028922cf
RS
1648 (if (and next-line-add-newlines (= arg 1))
1649 (let ((opoint (point)))
3534a809
RS
1650 (end-of-line)
1651 (if (eobp)
28191e20 1652 (newline 1)
028922cf
RS
1653 (goto-char opoint)
1654 (line-move arg)))
1a2c3941
RS
1655 (if (interactive-p)
1656 (condition-case nil
1657 (line-move arg)
1658 ((beginning-of-buffer end-of-buffer) (ding)))
1659 (line-move arg)))
2076c87c
JB
1660 nil)
1661
1662(defun previous-line (arg)
1663 "Move cursor vertically up ARG lines.
1664If there is no character in the target line exactly over the current column,
1665the cursor is positioned after the character in that line which spans this
1666column, or at the end of the line if it is not long enough.
1667
1668The command \\[set-goal-column] can be used to create
1669a semipermanent goal column to which this command always moves.
1670Then it does not try to move vertically.
1671
1672If you are thinking of using this in a Lisp program, consider using
c2e8a012 1673`forward-line' with a negative argument instead. It is usually easier
2076c87c
JB
1674to use and more reliable (no dependence on goal column, etc.)."
1675 (interactive "p")
1a2c3941
RS
1676 (if (interactive-p)
1677 (condition-case nil
1678 (line-move (- arg))
1679 ((beginning-of-buffer end-of-buffer) (ding)))
1680 (line-move (- arg)))
2076c87c
JB
1681 nil)
1682
1683(defconst track-eol nil
1684 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1685This means moving to the end of each line moved onto.
1686The beginning of a blank line does not count as the end of a line.")
1687
912c6728
RS
1688(defvar goal-column nil
1689 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1690(make-variable-buffer-local 'goal-column)
2076c87c
JB
1691
1692(defvar temporary-goal-column 0
1693 "Current goal column for vertical motion.
1694It is the column where point was
1695at the start of current run of vertical motion commands.
c637ae6f 1696When the `track-eol' feature is doing its job, the value is 9999.")
2076c87c 1697
098fc1fb
RS
1698(defvar line-move-ignore-invisible nil
1699 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
1700Outline mode sets this.")
1701
8c745744
RS
1702;; This is the guts of next-line and previous-line.
1703;; Arg says how many lines to move.
2076c87c 1704(defun line-move (arg)
2596511d
RS
1705 ;; Don't run any point-motion hooks, and disregard intangibility,
1706 ;; for intermediate positions.
1707 (let ((inhibit-point-motion-hooks t)
1708 (opoint (point))
1709 new)
1710 (unwind-protect
1711 (progn
1712 (if (not (or (eq last-command 'next-line)
1713 (eq last-command 'previous-line)))
1714 (setq temporary-goal-column
1715 (if (and track-eol (eolp)
1716 ;; Don't count beg of empty line as end of line
1717 ;; unless we just did explicit end-of-line.
1718 (or (not (bolp)) (eq last-command 'end-of-line)))
1719 9999
1720 (current-column))))
1721 (if (and (not (integerp selective-display))
1722 (not line-move-ignore-invisible))
1723 ;; Use just newline characters.
1724 (or (if (> arg 0)
1725 (progn (if (> arg 1) (forward-line (1- arg)))
1726 ;; This way of moving forward ARG lines
1727 ;; verifies that we have a newline after the last one.
1728 ;; It doesn't get confused by intangible text.
1729 (end-of-line)
1730 (zerop (forward-line 1)))
1731 (and (zerop (forward-line arg))
1732 (bolp)))
1733 (signal (if (< arg 0)
1734 'beginning-of-buffer
1735 'end-of-buffer)
1736 nil))
1737 ;; Move by arg lines, but ignore invisible ones.
1738 (while (> arg 0)
1739 (end-of-line)
1740 (and (zerop (vertical-motion 1))
1741 (signal 'end-of-buffer nil))
1742 ;; If the following character is currently invisible,
1743 ;; skip all characters with that same `invisible' property value.
1744 (while (and (not (eobp))
1745 (let ((prop
1746 (get-char-property (point) 'invisible)))
1747 (if (eq buffer-invisibility-spec t)
1748 prop
1749 (or (memq prop buffer-invisibility-spec)
1750 (assq prop buffer-invisibility-spec)))))
1751 (if (get-text-property (point) 'invisible)
1752 (goto-char (next-single-property-change (point) 'invisible))
1753 (goto-char (next-overlay-change (point)))))
1754 (setq arg (1- arg)))
1755 (while (< arg 0)
1756 (beginning-of-line)
1757 (and (zerop (vertical-motion -1))
1758 (signal 'beginning-of-buffer nil))
1759 (while (and (not (bobp))
1760 (let ((prop
1761 (get-char-property (1- (point)) 'invisible)))
1762 (if (eq buffer-invisibility-spec t)
1763 prop
1764 (or (memq prop buffer-invisibility-spec)
1765 (assq prop buffer-invisibility-spec)))))
1766 (if (get-text-property (1- (point)) 'invisible)
1767 (goto-char (previous-single-property-change (point) 'invisible))
1768 (goto-char (previous-overlay-change (point)))))
1769 (setq arg (1+ arg))))
1770 (move-to-column (or goal-column temporary-goal-column)))
1771 ;; Remember where we moved to, go back home,
1772 ;; then do the motion over again
1773 ;; in just one step, with intangibility and point-motion hooks
1774 ;; enabled this time.
1775 (setq new (point))
1776 (goto-char opoint)
1777 (setq inhibit-point-motion-hooks nil)
1778 (goto-char new)))
1779 nil)
2076c87c 1780
d5ab2033
JB
1781;;; Many people have said they rarely use this feature, and often type
1782;;; it by accident. Maybe it shouldn't even be on a key.
1783(put 'set-goal-column 'disabled t)
2076c87c
JB
1784
1785(defun set-goal-column (arg)
1786 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1787Those commands will move to this position in the line moved to
1788rather than trying to keep the same horizontal position.
1789With a non-nil argument, clears out the goal column
912c6728
RS
1790so that \\[next-line] and \\[previous-line] resume vertical motion.
1791The goal column is stored in the variable `goal-column'."
2076c87c
JB
1792 (interactive "P")
1793 (if arg
1794 (progn
1795 (setq goal-column nil)
1796 (message "No goal column"))
1797 (setq goal-column (current-column))
1798 (message (substitute-command-keys
1799 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1800 goal-column))
1801 nil)
1802\f
0d5bbbf7
ER
1803;;; Partial support for horizontal autoscrolling. Someday, this feature
1804;;; will be built into the C level and all the (hscroll-point-visible) calls
1805;;; will go away.
1806
1807(defvar hscroll-step 0
1808 "*The number of columns to try scrolling a window by when point moves out.
1809If that fails to bring point back on frame, point is centered instead.
1810If this is zero, point is always centered after it moves off frame.")
1811
1812(defun hscroll-point-visible ()
26c5bf8e
KH
1813 "Scrolls the selected window horizontally to make point visible."
1814 (save-excursion
1815 (set-buffer (window-buffer))
1816 (if (not (or truncate-lines
1817 (> (window-hscroll) 0)
1818 (and truncate-partial-width-windows
1819 (< (window-width) (frame-width)))))
1820 ;; Point is always visible when lines are wrapped.
1821 ()
1822 ;; If point is on the invisible part of the line before window-start,
1823 ;; then hscrolling can't bring it back, so reset window-start first.
1824 (and (< (point) (window-start))
1825 (let ((ws-bol (save-excursion
1826 (goto-char (window-start))
1827 (beginning-of-line)
1828 (point))))
1829 (and (>= (point) ws-bol)
1830 (set-window-start nil ws-bol))))
1831 (let* ((here (hscroll-window-column))
1832 (left (min (window-hscroll) 1))
1833 (right (1- (window-width))))
1834 ;; Allow for the truncation glyph, if we're not exactly at eol.
1835 (if (not (and (= here right)
1836 (= (following-char) ?\n)))
1837 (setq right (1- right)))
1838 (cond
1839 ;; If too far away, just recenter. But don't show too much
1840 ;; white space off the end of the line.
1841 ((or (< here (- left hscroll-step))
1842 (> here (+ right hscroll-step)))
1843 (let ((eol (save-excursion (end-of-line) (hscroll-window-column))))
1844 (scroll-left (min (- here (/ (window-width) 2))
1845 (- eol (window-width) -5)))))
1846 ;; Within range. Scroll by one step (or maybe not at all).
1847 ((< here left)
1848 (scroll-right hscroll-step))
1849 ((> here right)
1850 (scroll-left hscroll-step)))))))
1851
1852;; This function returns the window's idea of the display column of point,
1853;; assuming that the window is already known to be truncated rather than
1854;; wrapped, and that we've already handled the case where point is on the
1855;; part of the line before window-start. We ignore window-width; if point
1856;; is beyond the right margin, we want to know how far. The return value
1857;; includes the effects of window-hscroll, window-start, and the prompt
1858;; string in the minibuffer. It may be negative due to hscroll.
1859(defun hscroll-window-column ()
1860 (let* ((hscroll (window-hscroll))
1861 (startpos (save-excursion
1862 (beginning-of-line)
1863 (if (= (point) (save-excursion
1864 (goto-char (window-start))
1865 (beginning-of-line)
1866 (point)))
1867 (goto-char (window-start)))
1868 (point)))
1869 (hpos (+ (if (and (eq (selected-window) (minibuffer-window))
1870 (= 1 (window-start))
1871 (= startpos (point-min)))
1872 (minibuffer-prompt-width)
1873 0)
1874 (min 0 (- 1 hscroll))))
1875 val)
1876 (car (cdr (compute-motion startpos (cons hpos 0)
1877 (point) (cons 0 1)
1878 1000000 (cons hscroll 0) nil)))))
1879
0d5bbbf7 1880
dff7d67f
RS
1881;; rms: (1) The definitions of arrow keys should not simply restate
1882;; what keys they are. The arrow keys should run the ordinary commands.
1883;; (2) The arrow keys are just one of many common ways of moving point
1884;; within a line. Real horizontal autoscrolling would be a good feature,
1885;; but supporting it only for arrow keys is too incomplete to be desirable.
1886
1887;;;;; Make arrow keys do the right thing for improved terminal support
1888;;;;; When we implement true horizontal autoscrolling, right-arrow and
1889;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1890;;;;; aliases. These functions are bound to the corresponding keyboard
1891;;;;; events in loaddefs.el.
1892
1893;;(defun right-arrow (arg)
1894;; "Move right one character on the screen (with prefix ARG, that many chars).
1895;;Scroll right if needed to keep point horizontally onscreen."
1896;; (interactive "P")
1897;; (forward-char arg)
1898;; (hscroll-point-visible))
1899
1900;;(defun left-arrow (arg)
1901;; "Move left one character on the screen (with prefix ARG, that many chars).
1902;;Scroll left if needed to keep point horizontally onscreen."
1903;; (interactive "P")
1904;; (backward-char arg)
1905;; (hscroll-point-visible))
7492f5a6
RS
1906
1907(defun scroll-other-window-down (lines)
e47d38f6
RS
1908 "Scroll the \"other window\" down.
1909For more details, see the documentation for `scroll-other-window'."
7492f5a6
RS
1910 (interactive "P")
1911 (scroll-other-window
1912 ;; Just invert the argument's meaning.
1913 ;; We can do that without knowing which window it will be.
1914 (if (eq lines '-) nil
1915 (if (null lines) '-
1916 (- (prefix-numeric-value lines))))))
e47d38f6 1917(define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
3aef9604
RS
1918
1919(defun beginning-of-buffer-other-window (arg)
1920 "Move point to the beginning of the buffer in the other window.
1921Leave mark at previous position.
1922With arg N, put point N/10 of the way from the true beginning."
1923 (interactive "P")
1924 (let ((orig-window (selected-window))
1925 (window (other-window-for-scrolling)))
1926 ;; We use unwind-protect rather than save-window-excursion
1927 ;; because the latter would preserve the things we want to change.
1928 (unwind-protect
1929 (progn
1930 (select-window window)
1931 ;; Set point and mark in that window's buffer.
1932 (beginning-of-buffer arg)
1933 ;; Set point accordingly.
1934 (recenter '(t)))
1935 (select-window orig-window))))
1936
1937(defun end-of-buffer-other-window (arg)
1938 "Move point to the end of the buffer in the other window.
1939Leave mark at previous position.
1940With arg N, put point N/10 of the way from the true end."
1941 (interactive "P")
1942 ;; See beginning-of-buffer-other-window for comments.
1943 (let ((orig-window (selected-window))
1944 (window (other-window-for-scrolling)))
1945 (unwind-protect
1946 (progn
1947 (select-window window)
4500ff36 1948 (end-of-buffer arg)
3aef9604
RS
1949 (recenter '(t)))
1950 (select-window orig-window))))
38ebcf29 1951\f
2076c87c
JB
1952(defun transpose-chars (arg)
1953 "Interchange characters around point, moving forward one character.
1954With prefix arg ARG, effect is to take character before point
1955and drag it forward past ARG other characters (backward if ARG negative).
1956If no argument and at end of line, the previous two chars are exchanged."
1957 (interactive "*P")
1958 (and (null arg) (eolp) (forward-char -1))
1959 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1960
1961(defun transpose-words (arg)
1962 "Interchange words around point, leaving point at end of them.
1963With prefix arg ARG, effect is to take word before or around point
1964and drag it forward past ARG other words (backward if ARG negative).
1965If ARG is zero, the words around or after point and around or after mark
1966are interchanged."
1967 (interactive "*p")
1968 (transpose-subr 'forward-word arg))
1969
1970(defun transpose-sexps (arg)
1971 "Like \\[transpose-words] but applies to sexps.
1972Does not work on a sexp that point is in the middle of
1973if it is a list or string."
1974 (interactive "*p")
1975 (transpose-subr 'forward-sexp arg))
1976
1977(defun transpose-lines (arg)
1978 "Exchange current line and previous line, leaving point after both.
1979With argument ARG, takes previous line and moves it past ARG lines.
1980With argument 0, interchanges line point is in with line mark is in."
1981 (interactive "*p")
1982 (transpose-subr (function
1983 (lambda (arg)
1984 (if (= arg 1)
1985 (progn
1986 ;; Move forward over a line,
1987 ;; but create a newline if none exists yet.
1988 (end-of-line)
1989 (if (eobp)
1990 (newline)
1991 (forward-char 1)))
1992 (forward-line arg))))
1993 arg))
1994
1995(defun transpose-subr (mover arg)
1996 (let (start1 end1 start2 end2)
1997 (if (= arg 0)
1998 (progn
1999 (save-excursion
2000 (funcall mover 1)
2001 (setq end2 (point))
2002 (funcall mover -1)
2003 (setq start2 (point))
2004 (goto-char (mark))
2005 (funcall mover 1)
2006 (setq end1 (point))
2007 (funcall mover -1)
2008 (setq start1 (point))
2009 (transpose-subr-1))
2010 (exchange-point-and-mark)))
2011 (while (> arg 0)
2012 (funcall mover -1)
2013 (setq start1 (point))
2014 (funcall mover 1)
2015 (setq end1 (point))
2016 (funcall mover 1)
2017 (setq end2 (point))
2018 (funcall mover -1)
2019 (setq start2 (point))
2020 (transpose-subr-1)
2021 (goto-char end2)
2022 (setq arg (1- arg)))
2023 (while (< arg 0)
2024 (funcall mover -1)
2025 (setq start2 (point))
2026 (funcall mover -1)
2027 (setq start1 (point))
2028 (funcall mover 1)
2029 (setq end1 (point))
2030 (funcall mover 1)
2031 (setq end2 (point))
2032 (transpose-subr-1)
2033 (setq arg (1+ arg)))))
2034
2035(defun transpose-subr-1 ()
2036 (if (> (min end1 end2) (max start1 start2))
2037 (error "Don't have two things to transpose"))
2038 (let ((word1 (buffer-substring start1 end1))
2039 (word2 (buffer-substring start2 end2)))
2040 (delete-region start2 end2)
2041 (goto-char start2)
2042 (insert word1)
2043 (goto-char (if (< start1 start2) start1
2044 (+ start1 (- (length word1) (length word2)))))
2045 (delete-char (length word1))
2046 (insert word2)))
2047\f
2048(defconst comment-column 32
2049 "*Column to indent right-margin comments to.
8a8fa723
JB
2050Setting this variable automatically makes it local to the current buffer.
2051Each mode establishes a different default value for this variable; you
b492f73b 2052can set the value for a particular mode using that mode's hook.")
2076c87c
JB
2053(make-variable-buffer-local 'comment-column)
2054
2055(defconst comment-start nil
534a0de5 2056 "*String to insert to start a new comment, or nil if no comment syntax.")
2076c87c
JB
2057
2058(defconst comment-start-skip nil
2059 "*Regexp to match the start of a comment plus everything up to its body.
2060If there are any \\(...\\) pairs, the comment delimiter text is held to begin
2061at the place matched by the close of the first pair.")
2062
2063(defconst comment-end ""
2064 "*String to insert to end a new comment.
2065Should be an empty string if comments are terminated by end-of-line.")
2066
ec9a76e3
JB
2067(defconst comment-indent-hook nil
2068 "Obsolete variable for function to compute desired indentation for a comment.
2069This function is called with no args with point at the beginning of
2070the comment's starting delimiter.")
2071
2072(defconst comment-indent-function
2076c87c
JB
2073 '(lambda () comment-column)
2074 "Function to compute desired indentation for a comment.
2075This function is called with no args with point at the beginning of
2076the comment's starting delimiter.")
2077
534a0de5
RS
2078(defconst block-comment-start nil
2079 "*String to insert to start a new comment on a line by itself.
2080If nil, use `comment-start' instead.
2081Note that the regular expression `comment-start-skip' should skip this string
2082as well as the `comment-start' string.")
2083
2084(defconst block-comment-end nil
2085 "*String to insert to end a new comment on a line by itself.
2086Should be an empty string if comments are terminated by end-of-line.
2087If nil, use `comment-end' instead.")
2088
2076c87c
JB
2089(defun indent-for-comment ()
2090 "Indent this line's comment to comment column, or insert an empty comment."
2091 (interactive "*")
534a0de5
RS
2092 (let* ((empty (save-excursion (beginning-of-line)
2093 (looking-at "[ \t]*$")))
2094 (starter (or (and empty block-comment-start) comment-start))
2095 (ender (or (and empty block-comment-end) comment-end)))
2096 (if (null starter)
2097 (error "No comment syntax defined")
2098 (let* ((eolpos (save-excursion (end-of-line) (point)))
2099 cpos indent begpos)
6389928d 2100 (beginning-of-line)
534a0de5
RS
2101 (if (re-search-forward comment-start-skip eolpos 'move)
2102 (progn (setq cpos (point-marker))
2103 ;; Find the start of the comment delimiter.
2104 ;; If there were paren-pairs in comment-start-skip,
2105 ;; position at the end of the first pair.
2106 (if (match-end 1)
2107 (goto-char (match-end 1))
2108 ;; If comment-start-skip matched a string with
2109 ;; internal whitespace (not final whitespace) then
2110 ;; the delimiter start at the end of that
2111 ;; whitespace. Otherwise, it starts at the
2112 ;; beginning of what was matched.
2113 (skip-syntax-backward " " (match-beginning 0))
2114 (skip-syntax-backward "^ " (match-beginning 0)))))
2115 (setq begpos (point))
2116 ;; Compute desired indent.
2117 (if (= (current-column)
2118 (setq indent (if comment-indent-hook
2119 (funcall comment-indent-hook)
2120 (funcall comment-indent-function))))
2121 (goto-char begpos)
2122 ;; If that's different from current, change it.
2123 (skip-chars-backward " \t")
2124 (delete-region (point) begpos)
2125 (indent-to indent))
2126 ;; An existing comment?
2127 (if cpos
2128 (progn (goto-char cpos)
2129 (set-marker cpos nil))
2130 ;; No, insert one.
2131 (insert starter)
2132 (save-excursion
2133 (insert ender)))))))
2076c87c
JB
2134
2135(defun set-comment-column (arg)
2136 "Set the comment column based on point.
2137With no arg, set the comment column to the current column.
2138With just minus as arg, kill any comment on this line.
2139With any other arg, set comment column to indentation of the previous comment
2140 and then align or create a comment on this line at that column."
2141 (interactive "P")
2142 (if (eq arg '-)
2143 (kill-comment nil)
2144 (if arg
2145 (progn
2146 (save-excursion
2147 (beginning-of-line)
2148 (re-search-backward comment-start-skip)
2149 (beginning-of-line)
2150 (re-search-forward comment-start-skip)
2151 (goto-char (match-beginning 0))
2152 (setq comment-column (current-column))
2153 (message "Comment column set to %d" comment-column))
2154 (indent-for-comment))
2155 (setq comment-column (current-column))
2156 (message "Comment column set to %d" comment-column))))
2157
2158(defun kill-comment (arg)
2159 "Kill the comment on this line, if any.
2160With argument, kill comments on that many lines starting with this one."
2161 ;; this function loses in a lot of situations. it incorrectly recognises
2162 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
2163 ;; with multi-line comments, can kill extra whitespace if comment wasn't
2164 ;; through end-of-line, et cetera.
2165 (interactive "P")
2166 (or comment-start-skip (error "No comment syntax defined"))
2167 (let ((count (prefix-numeric-value arg)) endc)
2168 (while (> count 0)
2169 (save-excursion
2170 (end-of-line)
2171 (setq endc (point))
2172 (beginning-of-line)
2173 (and (string< "" comment-end)
2174 (setq endc
2175 (progn
2176 (re-search-forward (regexp-quote comment-end) endc 'move)
2177 (skip-chars-forward " \t")
2178 (point))))
2179 (beginning-of-line)
2180 (if (re-search-forward comment-start-skip endc t)
2181 (progn
2182 (goto-char (match-beginning 0))
2183 (skip-chars-backward " \t")
2184 (kill-region (point) endc)
2185 ;; to catch comments a line beginnings
2186 (indent-according-to-mode))))
2187 (if arg (forward-line 1))
2188 (setq count (1- count)))))
2189
2190(defun comment-region (beg end &optional arg)
f28039bb
RS
2191 "Comment or uncomment each line in the region.
2192With just C-u prefix arg, uncomment each line in region.
2193Numeric prefix arg ARG means use ARG comment characters.
2076c87c
JB
2194If ARG is negative, delete that many comment characters instead.
2195Comments are terminated on each line, even for syntax in which newline does
2196not end the comment. Blank lines do not get comments."
2197 ;; if someone wants it to only put a comment-start at the beginning and
2198 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2199 ;; is easy enough. No option is made here for other than commenting
2200 ;; every line.
f28039bb 2201 (interactive "r\nP")
2076c87c
JB
2202 (or comment-start (error "No comment syntax is defined"))
2203 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
2204 (save-excursion
2205 (save-restriction
f28039bb
RS
2206 (let ((cs comment-start) (ce comment-end)
2207 numarg)
2208 (if (consp arg) (setq numarg t)
2209 (setq numarg (prefix-numeric-value arg))
2210 ;; For positive arg > 1, replicate the comment delims now,
2211 ;; then insert the replicated strings just once.
2212 (while (> numarg 1)
2213 (setq cs (concat cs comment-start)
2214 ce (concat ce comment-end))
2215 (setq numarg (1- numarg))))
2216 ;; Loop over all lines from BEG to END.
2076c87c
JB
2217 (narrow-to-region beg end)
2218 (goto-char beg)
2219 (while (not (eobp))
f28039bb
RS
2220 (if (or (eq numarg t) (< numarg 0))
2221 (progn
2222 ;; Delete comment start from beginning of line.
2223 (if (eq numarg t)
2224 (while (looking-at (regexp-quote cs))
2225 (delete-char (length cs)))
2226 (let ((count numarg))
2227 (while (and (> 1 (setq count (1+ count)))
2228 (looking-at (regexp-quote cs)))
2229 (delete-char (length cs)))))
2230 ;; Delete comment end from end of line.
2231 (if (string= "" ce)
2232 nil
2233 (if (eq numarg t)
2234 (progn
2235 (end-of-line)
2236 ;; This is questionable if comment-end ends in
2237 ;; whitespace. That is pretty brain-damaged,
2238 ;; though.
2239 (skip-chars-backward " \t")
2240 (if (and (>= (- (point) (point-min)) (length ce))
2241 (save-excursion
2242 (backward-char (length ce))
2243 (looking-at (regexp-quote ce))))
2244 (delete-char (- (length ce)))))
ee095968
RS
2245 (let ((count numarg))
2246 (while (> 1 (setq count (1+ count)))
2247 (end-of-line)
2248 ;; this is questionable if comment-end ends in whitespace
2249 ;; that is pretty brain-damaged though
2250 (skip-chars-backward " \t")
2251 (save-excursion
2252 (backward-char (length ce))
2253 (if (looking-at (regexp-quote ce))
2254 (delete-char (length ce))))))))
6e88ed49 2255 (forward-line 1))
f28039bb 2256 ;; Insert at beginning and at end.
2076c87c
JB
2257 (if (looking-at "[ \t]*$") ()
2258 (insert cs)
2259 (if (string= "" ce) ()
2260 (end-of-line)
2261 (insert ce)))
2262 (search-forward "\n" nil 'move)))))))
2263\f
2264(defun backward-word (arg)
2265 "Move backward until encountering the end of a word.
2266With argument, do this that many times.
ff1fbe3e 2267In programs, it is faster to call `forward-word' with negative arg."
9e50756b 2268 (interactive "p")
2076c87c
JB
2269 (forward-word (- arg)))
2270
2271(defun mark-word (arg)
2272 "Set mark arg words away from point."
2273 (interactive "p")
2274 (push-mark
2275 (save-excursion
2276 (forward-word arg)
fd0f4056
RS
2277 (point))
2278 nil t))
2076c87c
JB
2279
2280(defun kill-word (arg)
2281 "Kill characters forward until encountering the end of a word.
2282With argument, do this that many times."
2283 (interactive "p")
e6291fe1 2284 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
2285
2286(defun backward-kill-word (arg)
2287 "Kill characters backward until encountering the end of a word.
2288With argument, do this that many times."
2289 (interactive "p")
2290 (kill-word (- arg)))
d7c64071 2291
1e8c5ac4
RS
2292(defun current-word (&optional strict)
2293 "Return the word point is on (or a nearby word) as a string.
2294If optional arg STRICT is non-nil, return nil unless point is within
2295or adjacent to a word."
d7c64071
ER
2296 (save-excursion
2297 (let ((oldpoint (point)) (start (point)) (end (point)))
2298 (skip-syntax-backward "w_") (setq start (point))
2299 (goto-char oldpoint)
2300 (skip-syntax-forward "w_") (setq end (point))
2301 (if (and (eq start oldpoint) (eq end oldpoint))
1e8c5ac4
RS
2302 ;; Point is neither within nor adjacent to a word.
2303 (and (not strict)
2304 (progn
2305 ;; Look for preceding word in same line.
2306 (skip-syntax-backward "^w_"
2307 (save-excursion (beginning-of-line)
2308 (point)))
2309 (if (bolp)
2310 ;; No preceding word in same line.
2311 ;; Look for following word in same line.
2312 (progn
2313 (skip-syntax-forward "^w_"
2314 (save-excursion (end-of-line)
2315 (point)))
2316 (setq start (point))
2317 (skip-syntax-forward "w_")
2318 (setq end (point)))
2319 (setq end (point))
2320 (skip-syntax-backward "w_")
2321 (setq start (point)))
2322 (buffer-substring start end)))
2323 (buffer-substring start end)))))
2076c87c
JB
2324\f
2325(defconst fill-prefix nil
2326 "*String for filling to insert at front of new line, or nil for none.
2327Setting this variable automatically makes it local to the current buffer.")
2328(make-variable-buffer-local 'fill-prefix)
2329
2330(defconst auto-fill-inhibit-regexp nil
2331 "*Regexp to match lines which should not be auto-filled.")
2332
2333(defun do-auto-fill ()
a0170800
RS
2334 (let (fc justify bol give-up
2335 (fill-prefix fill-prefix))
c18465c4 2336 (if (or (not (setq justify (current-justification)))
8f066a20
RS
2337 (null (setq fc (current-fill-column)))
2338 (and (eq justify 'left)
2339 (<= (current-column) fc))
eed5698b
RS
2340 (save-excursion (beginning-of-line)
2341 (setq bol (point))
2342 (and auto-fill-inhibit-regexp
2343 (looking-at auto-fill-inhibit-regexp))))
2344 nil ;; Auto-filling not required
3db1e3b5
BG
2345 (if (memq justify '(full center right))
2346 (save-excursion (unjustify-current-line)))
a0170800
RS
2347
2348 ;; Choose a fill-prefix automatically.
2349 (if (and adaptive-fill-mode
2350 (or (null fill-prefix) (string= fill-prefix "")))
e4b62d7c
RS
2351 (let ((prefix
2352 (fill-context-prefix
2353 (save-excursion (backward-paragraph 1) (point))
2354 (save-excursion (forward-paragraph 1) (point))
2355 ;; Don't accept a non-whitespace fill prefix
2356 ;; from the first line of a paragraph.
2357 "^[ \t]*$")))
2358 (and prefix (not (equal prefix ""))
2359 (setq fill-prefix prefix))))
a0170800 2360
eed5698b 2361 (while (and (not give-up) (> (current-column) fc))
e47d38f6
RS
2362 ;; Determine where to split the line.
2363 (let ((fill-point
2364 (let ((opoint (point))
2365 bounce
2366 (first t))
2367 (save-excursion
2368 (move-to-column (1+ fc))
2369 ;; Move back to a word boundary.
2370 (while (or first
2371 ;; If this is after period and a single space,
2372 ;; move back once more--we don't want to break
2373 ;; the line there and make it look like a
2374 ;; sentence end.
2375 (and (not (bobp))
2376 (not bounce)
2377 sentence-end-double-space
2378 (save-excursion (forward-char -1)
2379 (and (looking-at "\\. ")
2380 (not (looking-at "\\. "))))))
2381 (setq first nil)
2382 (skip-chars-backward "^ \t\n")
2383 ;; If we find nowhere on the line to break it,
2384 ;; break after one word. Set bounce to t
2385 ;; so we will not keep going in this while loop.
2386 (if (bolp)
2387 (progn
2388 (re-search-forward "[ \t]" opoint t)
2389 (setq bounce t)))
2390 (skip-chars-backward " \t"))
2391 ;; Let fill-point be set to the place where we end up.
2392 (point)))))
2393 ;; If that place is not the beginning of the line,
2394 ;; break the line there.
2395 (if (save-excursion
2396 (goto-char fill-point)
2397 (not (bolp)))
2398 (let ((prev-column (current-column)))
2399 ;; If point is at the fill-point, do not `save-excursion'.
2400 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2401 ;; point will end up before it rather than after it.
2402 (if (save-excursion
2403 (skip-chars-backward " \t")
2404 (= (point) fill-point))
2405 (indent-new-comment-line t)
2406 (save-excursion
2407 (goto-char fill-point)
2408 (indent-new-comment-line t)))
2409 ;; Now do justification, if required
2410 (if (not (eq justify 'left))
2411 (save-excursion
2412 (end-of-line 0)
2413 (justify-current-line justify nil t)))
2414 ;; If making the new line didn't reduce the hpos of
2415 ;; the end of the line, then give up now;
2416 ;; trying again will not help.
2417 (if (>= (current-column) prev-column)
2418 (setq give-up t)))
2419 ;; No place to break => stop trying.
2420 (setq give-up t))))
eed5698b
RS
2421 ;; justify last line
2422 (justify-current-line justify t t))))
2076c87c 2423
d7465b15
RS
2424(defun auto-fill-mode (&optional arg)
2425 "Toggle auto-fill mode.
2426With arg, turn Auto-Fill mode on if and only if arg is positive.
eed5698b 2427In Auto-Fill mode, inserting a space at a column beyond `current-fill-column'
d7465b15
RS
2428automatically breaks the line at a previous space."
2429 (interactive "P")
2430 (prog1 (setq auto-fill-function
2431 (if (if (null arg)
2432 (not auto-fill-function)
2433 (> (prefix-numeric-value arg) 0))
2434 'do-auto-fill
2435 nil))
7911ecc8 2436 (force-mode-line-update)))
d7465b15
RS
2437
2438;; This holds a document string used to document auto-fill-mode.
2439(defun auto-fill-function ()
2440 "Automatically break line at a previous space, in insertion of text."
2441 nil)
2442
2443(defun turn-on-auto-fill ()
2444 "Unconditionally turn on Auto Fill mode."
2445 (auto-fill-mode 1))
2446
2447(defun set-fill-column (arg)
2448 "Set `fill-column' to current column, or to argument if given.
2449The variable `fill-column' has a separate value for each buffer."
2450 (interactive "P")
2451 (setq fill-column (if (integerp arg) arg (current-column)))
2452 (message "fill-column set to %d" fill-column))
2453\f
2076c87c
JB
2454(defconst comment-multi-line nil
2455 "*Non-nil means \\[indent-new-comment-line] should continue same comment
c88ab9ce
ER
2456on new line, with no new terminator or starter.
2457This is obsolete because you might as well use \\[newline-and-indent].")
2076c87c 2458
28191e20 2459(defun indent-new-comment-line (&optional soft)
d7465b15
RS
2460 "Break line at point and indent, continuing comment if within one.
2461This indents the body of the continued comment
2462under the previous comment line.
c88ab9ce
ER
2463
2464This command is intended for styles where you write a comment per line,
2465starting a new comment (and terminating it if necessary) on each line.
28191e20
RS
2466If you want to continue one comment across several lines, use \\[newline-and-indent].
2467
3a0c4755
RS
2468If a fill column is specified, it overrides the use of the comment column
2469or comment indentation.
2470
28191e20
RS
2471The inserted newline is marked hard if `use-hard-newlines' is true,
2472unless optional argument SOFT is non-nil."
2473 (interactive)
2076c87c
JB
2474 (let (comcol comstart)
2475 (skip-chars-backward " \t")
2476 (delete-region (point)
2477 (progn (skip-chars-forward " \t")
2478 (point)))
eed5698b 2479 (if soft (insert-and-inherit ?\n) (newline 1))
3a0c4755
RS
2480 (if fill-prefix
2481 (progn
2482 (indent-to-left-margin)
2483 (insert-and-inherit fill-prefix))
2484 (if (not comment-multi-line)
2076c87c 2485 (save-excursion
3a0c4755
RS
2486 (if (and comment-start-skip
2487 (let ((opoint (point)))
2488 (forward-line -1)
2489 (re-search-forward comment-start-skip opoint t)))
2490 ;; The old line is a comment.
2491 ;; Set WIN to the pos of the comment-start.
2492 ;; But if the comment is empty, look at preceding lines
2493 ;; to find one that has a nonempty comment.
2494
2495 ;; If comment-start-skip contains a \(...\) pair,
2496 ;; the real comment delimiter starts at the end of that pair.
2497 (let ((win (or (match-end 1) (match-beginning 0))))
2498 (while (and (eolp) (not (bobp))
2499 (let (opoint)
2500 (beginning-of-line)
2501 (setq opoint (point))
2502 (forward-line -1)
2503 (re-search-forward comment-start-skip opoint t)))
2504 (setq win (or (match-end 1) (match-beginning 0))))
2505 ;; Indent this line like what we found.
2506 (goto-char win)
2507 (setq comcol (current-column))
2508 (setq comstart
2509 (buffer-substring (point) (match-end 0)))))))
2510 (if comcol
2511 (let ((comment-column comcol)
2512 (comment-start comstart)
2513 (comment-end comment-end))
2514 (and comment-end (not (equal comment-end ""))
2515 ; (if (not comment-multi-line)
2516 (progn
2517 (forward-char -1)
2518 (insert comment-end)
2519 (forward-char 1))
2520 ; (setq comment-column (+ comment-column (length comment-start))
2521 ; comment-start "")
2522 ; )
2523 )
2524 (if (not (eolp))
2525 (setq comment-end ""))
2526 (insert-and-inherit ?\n)
2527 (forward-char -1)
2528 (indent-for-comment)
2529 (save-excursion
2530 ;; Make sure we delete the newline inserted above.
2531 (end-of-line)
2532 (delete-char 1)))
2533 (indent-according-to-mode)))))
2076c87c
JB
2534\f
2535(defun set-selective-display (arg)
ff1fbe3e
RS
2536 "Set `selective-display' to ARG; clear it if no arg.
2537When the value of `selective-display' is a number > 0,
2538lines whose indentation is >= that value are not displayed.
2539The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
2540 (interactive "P")
2541 (if (eq selective-display t)
2542 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
2543 (let ((current-vpos
2544 (save-restriction
2545 (narrow-to-region (point-min) (point))
2546 (goto-char (window-start))
2547 (vertical-motion (window-height)))))
2548 (setq selective-display
2549 (and arg (prefix-numeric-value arg)))
2550 (recenter current-vpos))
2076c87c
JB
2551 (set-window-start (selected-window) (window-start (selected-window)))
2552 (princ "selective-display set to " t)
2553 (prin1 selective-display t)
2554 (princ "." t))
2555
b6a22db0
JB
2556(defconst overwrite-mode-textual " Ovwrt"
2557 "The string displayed in the mode line when in overwrite mode.")
2558(defconst overwrite-mode-binary " Bin Ovwrt"
2559 "The string displayed in the mode line when in binary overwrite mode.")
2560
2076c87c
JB
2561(defun overwrite-mode (arg)
2562 "Toggle overwrite mode.
2563With arg, turn overwrite mode on iff arg is positive.
2564In overwrite mode, printing characters typed in replace existing text
b6a22db0
JB
2565on a one-for-one basis, rather than pushing it to the right. At the
2566end of a line, such characters extend the line. Before a tab,
2567such characters insert until the tab is filled in.
2568\\[quoted-insert] still inserts characters in overwrite mode; this
2569is supposed to make it easier to insert characters when necessary."
2570 (interactive "P")
2571 (setq overwrite-mode
2572 (if (if (null arg) (not overwrite-mode)
2573 (> (prefix-numeric-value arg) 0))
2574 'overwrite-mode-textual))
2575 (force-mode-line-update))
2576
2577(defun binary-overwrite-mode (arg)
2578 "Toggle binary overwrite mode.
2579With arg, turn binary overwrite mode on iff arg is positive.
2580In binary overwrite mode, printing characters typed in replace
2581existing text. Newlines are not treated specially, so typing at the
2582end of a line joins the line to the next, with the typed character
2583between them. Typing before a tab character simply replaces the tab
2584with the character typed.
2585\\[quoted-insert] replaces the text at the cursor, just as ordinary
2586typing characters do.
2587
2588Note that binary overwrite mode is not its own minor mode; it is a
2589specialization of overwrite-mode, entered by setting the
2590`overwrite-mode' variable to `overwrite-mode-binary'."
2076c87c
JB
2591 (interactive "P")
2592 (setq overwrite-mode
b6a22db0 2593 (if (if (null arg)
a61099dd 2594 (not (eq overwrite-mode 'overwrite-mode-binary))
b6a22db0
JB
2595 (> (prefix-numeric-value arg) 0))
2596 'overwrite-mode-binary))
2597 (force-mode-line-update))
2076c87c 2598\f
81e98f1a 2599(defvar line-number-mode t
a61099dd
RS
2600 "*Non-nil means display line number in mode line.")
2601
2602(defun line-number-mode (arg)
2603 "Toggle Line Number mode.
2604With arg, turn Line Number mode on iff arg is positive.
2605When Line Number mode is enabled, the line number appears
2606in the mode line."
2607 (interactive "P")
2608 (setq line-number-mode
2609 (if (null arg) (not line-number-mode)
2610 (> (prefix-numeric-value arg) 0)))
2611 (force-mode-line-update))
2612
71601101 2613(defvar column-number-mode nil
bcad4985
KH
2614 "*Non-nil means display column number in mode line.")
2615
2616(defun column-number-mode (arg)
2617 "Toggle Column Number mode.
2618With arg, turn Column Number mode on iff arg is positive.
2619When Column Number mode is enabled, the column number appears
2620in the mode line."
2621 (interactive "P")
2622 (setq column-number-mode
2623 (if (null arg) (not column-number-mode)
2624 (> (prefix-numeric-value arg) 0)))
2625 (force-mode-line-update))
2626
2076c87c
JB
2627(defvar blink-matching-paren t
2628 "*Non-nil means show matching open-paren when close-paren is inserted.")
2629
29fc44dd
KH
2630(defvar blink-matching-paren-on-screen t
2631 "*Non-nil means show matching open-paren when it is on screen.
2632nil means don't show it (but the open-paren can still be shown
2633when it is off screen.")
2634
37315725
RS
2635(defconst blink-matching-paren-distance 12000
2636 "*If non-nil, is maximum distance to search for matching open-paren.")
2076c87c 2637
72dddf8b
RS
2638(defconst blink-matching-delay 1
2639 "*The number of seconds that `blink-matching-open' will delay at a match.")
2640
903b7f65
RS
2641(defconst blink-matching-paren-dont-ignore-comments nil
2642 "*Non-nil means `blink-matching-paren' should not ignore comments.")
2643
2076c87c
JB
2644(defun blink-matching-open ()
2645 "Move cursor momentarily to the beginning of the sexp before point."
2646 (interactive)
2647 (and (> (point) (1+ (point-min)))
2076c87c 2648 blink-matching-paren
7e1ddd45
RS
2649 ;; Verify an even number of quoting characters precede the close.
2650 (= 1 (logand 1 (- (point)
2651 (save-excursion
2652 (forward-char -1)
2653 (skip-syntax-backward "/\\")
2654 (point)))))
2076c87c
JB
2655 (let* ((oldpos (point))
2656 (blinkpos)
2657 (mismatch))
2658 (save-excursion
2659 (save-restriction
2660 (if blink-matching-paren-distance
2661 (narrow-to-region (max (point-min)
2662 (- (point) blink-matching-paren-distance))
2663 oldpos))
2664 (condition-case ()
903b7f65
RS
2665 (let ((parse-sexp-ignore-comments
2666 (and parse-sexp-ignore-comments
2667 (not blink-matching-paren-dont-ignore-comments))))
2668 (setq blinkpos (scan-sexps oldpos -1)))
2076c87c 2669 (error nil)))
903b7f65
RS
2670 (and blinkpos
2671 (/= (char-syntax (char-after blinkpos))
2672 ?\$)
2076c87c 2673 (setq mismatch
903b7f65
RS
2674 (or (null (matching-paren (char-after blinkpos)))
2675 (/= (char-after (1- oldpos))
2676 (matching-paren (char-after blinkpos))))))
2076c87c
JB
2677 (if mismatch (setq blinkpos nil))
2678 (if blinkpos
2679 (progn
2680 (goto-char blinkpos)
2681 (if (pos-visible-in-window-p)
29fc44dd
KH
2682 (and blink-matching-paren-on-screen
2683 (sit-for blink-matching-delay))
2076c87c
JB
2684 (goto-char blinkpos)
2685 (message
2686 "Matches %s"
e9f1d66d 2687 ;; Show what precedes the open in its line, if anything.
2076c87c
JB
2688 (if (save-excursion
2689 (skip-chars-backward " \t")
2690 (not (bolp)))
2691 (buffer-substring (progn (beginning-of-line) (point))
2692 (1+ blinkpos))
e9f1d66d
RS
2693 ;; Show what follows the open in its line, if anything.
2694 (if (save-excursion
2695 (forward-char 1)
2696 (skip-chars-forward " \t")
2697 (not (eolp)))
2698 (buffer-substring blinkpos
2699 (progn (end-of-line) (point)))
267935b9
RS
2700 ;; Otherwise show the previous nonblank line,
2701 ;; if there is one.
2702 (if (save-excursion
2703 (skip-chars-backward "\n \t")
2704 (not (bobp)))
2705 (concat
2706 (buffer-substring (progn
2707 (skip-chars-backward "\n \t")
2708 (beginning-of-line)
2709 (point))
2710 (progn (end-of-line)
2711 (skip-chars-backward " \t")
2712 (point)))
2713 ;; Replace the newline and other whitespace with `...'.
2714 "..."
2715 (buffer-substring blinkpos (1+ blinkpos)))
2716 ;; There is nothing to show except the char itself.
2717 (buffer-substring blinkpos (1+ blinkpos))))))))
2076c87c
JB
2718 (cond (mismatch
2719 (message "Mismatched parentheses"))
2720 ((not blink-matching-paren-distance)
2721 (message "Unmatched parenthesis"))))))))
2722
2723;Turned off because it makes dbx bomb out.
2724(setq blink-paren-function 'blink-matching-open)
2725
9a1277dd
RS
2726;; This executes C-g typed while Emacs is waiting for a command.
2727;; Quitting out of a program does not go through here;
2728;; that happens in the QUIT macro at the C code level.
2076c87c 2729(defun keyboard-quit ()
af39530e
RS
2730 "Signal a quit condition.
2731During execution of Lisp code, this character causes a quit directly.
2732At top-level, as an editor command, this simply beeps."
2076c87c 2733 (interactive)
19d35374 2734 (deactivate-mark)
2076c87c
JB
2735 (signal 'quit nil))
2736
2737(define-key global-map "\C-g" 'keyboard-quit)
c66587fe 2738
1c6c6fde
RS
2739(defvar buffer-quit-function nil
2740 "Function to call to \"quit\" the current buffer, or nil if none.
2741\\[keyboard-escape-quit] calls this function when its more local actions
2742\(such as cancelling a prefix argument, minibuffer or region) do not apply.")
2743
c66587fe
RS
2744(defun keyboard-escape-quit ()
2745 "Exit the current \"mode\" (in a generalized sense of the word).
2746This command can exit an interactive command such as `query-replace',
2747can clear out a prefix argument or a region,
2748can get out of the minibuffer or other recursive edit,
1c6c6fde
RS
2749cancel the use of the current buffer (for special-purpose buffers),
2750or go back to just one window (by deleting all but the selected window)."
c66587fe
RS
2751 (interactive)
2752 (cond ((eq last-command 'mode-exited) nil)
2753 ((> (minibuffer-depth) 0)
2754 (abort-recursive-edit))
2755 (current-prefix-arg
2756 nil)
2757 ((and transient-mark-mode
2758 mark-active)
2759 (deactivate-mark))
1c6c6fde
RS
2760 (buffer-quit-function
2761 (funcall buffer-quit-function))
c66587fe
RS
2762 ((not (one-window-p t))
2763 (delete-other-windows))))
2764
1c6c6fde 2765(define-key global-map "\e\e\e" 'keyboard-escape-quit)
2076c87c
JB
2766\f
2767(defun set-variable (var val)
2768 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2769When using this interactively, supply a Lisp expression for VALUE.
3a801d0c
ER
2770If you want VALUE to be a string, you must surround it with doublequotes.
2771
2772If VARIABLE has a `variable-interactive' property, that is used as if
2773it were the arg to `interactive' (which see) to interactively read the value."
2076c87c
JB
2774 (interactive
2775 (let* ((var (read-variable "Set variable: "))
2776 (minibuffer-help-form
2777 '(funcall myhelp))
2778 (myhelp
2779 (function
2780 (lambda ()
2781 (with-output-to-temp-buffer "*Help*"
2782 (prin1 var)
2783 (princ "\nDocumentation:\n")
2784 (princ (substring (documentation-property var 'variable-documentation)
2785 1))
2786 (if (boundp var)
2787 (let ((print-length 20))
2788 (princ "\n\nCurrent value: ")
2789 (prin1 (symbol-value var))))
e6bcd155
KH
2790 (save-excursion
2791 (set-buffer standard-output)
2792 (help-mode))
2076c87c
JB
2793 nil)))))
2794 (list var
3a801d0c
ER
2795 (let ((prop (get var 'variable-interactive)))
2796 (if prop
2797 ;; Use VAR's `variable-interactive' property
2798 ;; as an interactive spec for prompting.
2799 (call-interactively (list 'lambda '(arg)
2800 (list 'interactive prop)
2801 'arg))
2802 (eval-minibuffer (format "Set %s to value: " var)))))))
2076c87c 2803 (set var val))
e8a700bf
RS
2804\f
2805;; Define the major mode for lists of completions.
2806
98b45886
RS
2807(defvar completion-list-mode-map nil
2808 "Local map for completion list buffers.")
ac29eb79 2809(or completion-list-mode-map
e8a700bf
RS
2810 (let ((map (make-sparse-keymap)))
2811 (define-key map [mouse-2] 'mouse-choose-completion)
eaf76065 2812 (define-key map [down-mouse-2] nil)
80298193 2813 (define-key map "\C-m" 'choose-completion)
1c6c6fde 2814 (define-key map "\e\e\e" 'delete-completion-window)
dde69dbe
RS
2815 (define-key map [left] 'previous-completion)
2816 (define-key map [right] 'next-completion)
ac29eb79 2817 (setq completion-list-mode-map map)))
e8a700bf
RS
2818
2819;; Completion mode is suitable only for specially formatted data.
ac29eb79 2820(put 'completion-list-mode 'mode-class 'special)
e8a700bf 2821
98b45886
RS
2822(defvar completion-reference-buffer nil
2823 "Record the buffer that was current when the completion list was requested.
2824This is a local variable in the completion list buffer.
ec39964e 2825Initial value is nil to avoid some compiler warnings.")
3819736b 2826
98b45886
RS
2827(defvar completion-base-size nil
2828 "Number of chars at beginning of minibuffer not involved in completion.
2829This is a local variable in the completion list buffer
2830but it talks about the buffer in `completion-reference-buffer'.
2831If this is nil, it means to compare text to determine which part
2832of the tail end of the buffer's text is involved in completion.")
f6b293e3 2833
1c6c6fde
RS
2834(defun delete-completion-window ()
2835 "Delete the completion list window.
2836Go to the window from which completion was requested."
2837 (interactive)
2838 (let ((buf completion-reference-buffer))
2839 (delete-window (selected-window))
2840 (if (get-buffer-window buf)
2841 (select-window (get-buffer-window buf)))))
2842
dde69dbe
RS
2843(defun previous-completion (n)
2844 "Move to the previous item in the completion list."
2845 (interactive "p")
2846 (next-completion (- n)))
2847
2848(defun next-completion (n)
2849 "Move to the next item in the completion list.
1f238ac2 2850With prefix argument N, move N items (negative N means move backward)."
dde69dbe
RS
2851 (interactive "p")
2852 (while (and (> n 0) (not (eobp)))
b61a81c2
RS
2853 (let ((prop (get-text-property (point) 'mouse-face))
2854 (end (point-max)))
dde69dbe
RS
2855 ;; If in a completion, move to the end of it.
2856 (if prop
b61a81c2 2857 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe 2858 ;; Move to start of next one.
b61a81c2 2859 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe
RS
2860 (setq n (1- n)))
2861 (while (and (< n 0) (not (bobp)))
b61a81c2
RS
2862 (let ((prop (get-text-property (1- (point)) 'mouse-face))
2863 (end (point-min)))
dde69dbe
RS
2864 ;; If in a completion, move to the start of it.
2865 (if prop
b61a81c2
RS
2866 (goto-char (previous-single-property-change
2867 (point) 'mouse-face nil end)))
dde69dbe 2868 ;; Move to end of the previous completion.
b61a81c2 2869 (goto-char (previous-single-property-change (point) 'mouse-face nil end))
dde69dbe 2870 ;; Move to the start of that one.
b61a81c2 2871 (goto-char (previous-single-property-change (point) 'mouse-face nil end)))
dde69dbe
RS
2872 (setq n (1+ n))))
2873
80298193
RS
2874(defun choose-completion ()
2875 "Choose the completion that point is in or next to."
2876 (interactive)
f6b293e3
RS
2877 (let (beg end completion (buffer completion-reference-buffer)
2878 (base-size completion-base-size))
6096f362
RS
2879 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
2880 (setq end (point) beg (1+ (point))))
2881 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3f299281 2882 (setq end (1- (point)) beg (point)))
6096f362
RS
2883 (if (null beg)
2884 (error "No completion here"))
2885 (setq beg (previous-single-property-change beg 'mouse-face))
88dd3c24 2886 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
ab63960f
RS
2887 (setq completion (buffer-substring beg end))
2888 (let ((owindow (selected-window)))
2889 (if (and (one-window-p t 'selected-frame)
2890 (window-dedicated-p (selected-window)))
2891 ;; This is a special buffer's frame
2892 (iconify-frame (selected-frame))
2893 (or (window-dedicated-p (selected-window))
2894 (bury-buffer)))
2895 (select-window owindow))
f6b293e3 2896 (choose-completion-string completion buffer base-size)))
80298193
RS
2897
2898;; Delete the longest partial match for STRING
2899;; that can be found before POINT.
2900(defun choose-completion-delete-max-match (string)
2901 (let ((opoint (point))
2902 (len (min (length string)
2903 (- (point) (point-min)))))
2904 (goto-char (- (point) (length string)))
61bbf6fe
RS
2905 (if completion-ignore-case
2906 (setq string (downcase string)))
80298193
RS
2907 (while (and (> len 0)
2908 (let ((tail (buffer-substring (point)
2909 (+ (point) len))))
61bbf6fe
RS
2910 (if completion-ignore-case
2911 (setq tail (downcase tail)))
80298193
RS
2912 (not (string= tail (substring string 0 len)))))
2913 (setq len (1- len))
2914 (forward-char 1))
2915 (delete-char len)))
2916
98b45886
RS
2917;; Switch to BUFFER and insert the completion choice CHOICE.
2918;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
2919;; to keep. If it is nil, use choose-completion-delete-max-match instead.
f6b293e3 2920(defun choose-completion-string (choice &optional buffer base-size)
80298193 2921 (let ((buffer (or buffer completion-reference-buffer)))
cf52ad58
RS
2922 ;; If BUFFER is a minibuffer, barf unless it's the currently
2923 ;; active minibuffer.
2924 (if (and (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))
45486731
RS
2925 (or (not (active-minibuffer-window))
2926 (not (equal buffer
2927 (window-buffer (active-minibuffer-window))))))
cf52ad58
RS
2928 (error "Minibuffer is not active for completion")
2929 ;; Insert the completion into the buffer where completion was requested.
2930 (set-buffer buffer)
f6b293e3
RS
2931 (if base-size
2932 (delete-region (+ base-size (point-min)) (point))
2933 (choose-completion-delete-max-match choice))
cf52ad58 2934 (insert choice)
63240af1
RS
2935 (remove-text-properties (- (point) (length choice)) (point)
2936 '(mouse-face nil))
cf52ad58
RS
2937 ;; Update point in the window that BUFFER is showing in.
2938 (let ((window (get-buffer-window buffer t)))
2939 (set-window-point window (point)))
2940 ;; If completing for the minibuffer, exit it with this choice.
2941 (and (equal buffer (window-buffer (minibuffer-window)))
8881ad9a
RS
2942 minibuffer-completion-table
2943 (exit-minibuffer)))))
80298193 2944
ac29eb79 2945(defun completion-list-mode ()
e8a700bf 2946 "Major mode for buffers showing lists of possible completions.
80298193
RS
2947Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
2948 to select the completion near point.
2949Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
2950 with the mouse."
e8a700bf
RS
2951 (interactive)
2952 (kill-all-local-variables)
ac29eb79
RS
2953 (use-local-map completion-list-mode-map)
2954 (setq mode-name "Completion List")
2955 (setq major-mode 'completion-list-mode)
f6b293e3
RS
2956 (make-local-variable 'completion-base-size)
2957 (setq completion-base-size nil)
ac29eb79 2958 (run-hooks 'completion-list-mode-hook))
e8a700bf 2959
98b45886
RS
2960(defvar completion-fixup-function nil
2961 "A function to customize how completions are identified in completion lists.
2962`completion-setup-function' calls this function with no arguments
2963each time it has found what it thinks is one completion.
2964Point is at the end of the completion in the completion list buffer.
2965If this function moves point, it can alter the end of that completion.")
2966
2967;; This function goes in completion-setup-hook, so that it is called
2968;; after the text of the completion list buffer is written.
6096f362 2969
e8a700bf
RS
2970(defun completion-setup-function ()
2971 (save-excursion
98b45886 2972 (let ((mainbuf (current-buffer)))
3819736b
RS
2973 (set-buffer standard-output)
2974 (completion-list-mode)
2975 (make-local-variable 'completion-reference-buffer)
2976 (setq completion-reference-buffer mainbuf)
98b45886
RS
2977;;; The value 0 is right in most cases, but not for file name completion.
2978;;; so this has to be turned off.
2979;;; (setq completion-base-size 0)
3819736b
RS
2980 (goto-char (point-min))
2981 (if window-system
2982 (insert (substitute-command-keys
80298193
RS
2983 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
2984 (insert (substitute-command-keys
2985 "In this buffer, type \\[choose-completion] to \
c26bb96e
KH
2986select the completion near point.\n\n"))
2987 (forward-line 1)
6096f362
RS
2988 (while (re-search-forward "[^ \t\n]+\\( [^ \t\n]+\\)*" nil t)
2989 (let ((beg (match-beginning 0))
2990 (end (point)))
2991 (if completion-fixup-function
2992 (funcall completion-fixup-function))
2993 (put-text-property beg (point) 'mouse-face 'highlight)
2994 (goto-char end))))))
c88ab9ce 2995
e8a700bf 2996(add-hook 'completion-setup-hook 'completion-setup-function)
dde69dbe
RS
2997
2998(define-key minibuffer-local-completion-map [prior]
2999 'switch-to-completions)
3000(define-key minibuffer-local-must-match-map [prior]
3001 'switch-to-completions)
3002(define-key minibuffer-local-completion-map "\M-v"
3003 'switch-to-completions)
3004(define-key minibuffer-local-must-match-map "\M-v"
3005 'switch-to-completions)
3006
3007(defun switch-to-completions ()
3008 "Select the completion list window."
3009 (interactive)
9595fbdb
RS
3010 ;; Make sure we have a completions window.
3011 (or (get-buffer-window "*Completions*")
3012 (minibuffer-completion-help))
dde69dbe
RS
3013 (select-window (get-buffer-window "*Completions*"))
3014 (goto-char (point-min))
3015 (search-forward "\n\n")
3016 (forward-line 1))
a3d1480b 3017\f
82072f33
RS
3018;; Support keyboard commands to turn on various modifiers.
3019
3020;; These functions -- which are not commands -- each add one modifier
3021;; to the following event.
3022
3023(defun event-apply-alt-modifier (ignore-prompt)
3024 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3025(defun event-apply-super-modifier (ignore-prompt)
3026 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3027(defun event-apply-hyper-modifier (ignore-prompt)
3028 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3029(defun event-apply-shift-modifier (ignore-prompt)
3030 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3031(defun event-apply-control-modifier (ignore-prompt)
3032 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3033(defun event-apply-meta-modifier (ignore-prompt)
3034 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3035
3036(defun event-apply-modifier (event symbol lshiftby prefix)
3037 "Apply a modifier flag to event EVENT.
3038SYMBOL is the name of this modifier, as a symbol.
3039LSHIFTBY is the numeric value of this modifier, in keyboard events.
3040PREFIX is the string that represents this modifier in an event type symbol."
3041 (if (numberp event)
3042 (cond ((eq symbol 'control)
90bebcb0
KH
3043 (if (and (<= (downcase event) ?z)
3044 (>= (downcase event) ?a))
82072f33 3045 (- (downcase event) ?a -1)
90bebcb0
KH
3046 (if (and (<= (downcase event) ?Z)
3047 (>= (downcase event) ?A))
82072f33
RS
3048 (- (downcase event) ?A -1)
3049 (logior (lsh 1 lshiftby) event))))
3050 ((eq symbol 'shift)
3051 (if (and (<= (downcase event) ?z)
3052 (>= (downcase event) ?a))
3053 (upcase event)
3054 (logior (lsh 1 lshiftby) event)))
3055 (t
3056 (logior (lsh 1 lshiftby) event)))
3057 (if (memq symbol (event-modifiers event))
3058 event
3059 (let ((event-type (if (symbolp event) event (car event))))
3060 (setq event-type (intern (concat prefix (symbol-name event-type))))
3061 (if (symbolp event)
3062 event-type
3063 (cons event-type (cdr event)))))))
3064
e5fff738
KH
3065(define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3066(define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3067(define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3068(define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3069(define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3070(define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
82072f33 3071\f
a3d1480b
JB
3072;;;; Keypad support.
3073
3074;;; Make the keypad keys act like ordinary typing keys. If people add
3075;;; bindings for the function key symbols, then those bindings will
3076;;; override these, so this shouldn't interfere with any existing
3077;;; bindings.
3078
0d173134 3079;; Also tell read-char how to handle these keys.
a3d1480b
JB
3080(mapcar
3081 (lambda (keypad-normal)
3082 (let ((keypad (nth 0 keypad-normal))
3083 (normal (nth 1 keypad-normal)))
0d173134 3084 (put keypad 'ascii-character normal)
a3d1480b
JB
3085 (define-key function-key-map (vector keypad) (vector normal))))
3086 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3087 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3088 (kp-space ?\ )
3089 (kp-tab ?\t)
3090 (kp-enter ?\r)
3091 (kp-multiply ?*)
3092 (kp-add ?+)
3093 (kp-separator ?,)
3094 (kp-subtract ?-)
3095 (kp-decimal ?.)
3096 (kp-divide ?/)
3097 (kp-equal ?=)))
3098
c88ab9ce 3099;;; simple.el ends here