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