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