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