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