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