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