Delete code to write subdirs.el.
[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
d0d74413 661(defun shell-command (command &optional output-buffer)
2076c87c
JB
662 "Execute string COMMAND in inferior shell; display output, if any.
663If COMMAND ends in ampersand, execute it asynchronously.
d0d74413
RS
664The output appears in the buffer `*Shell Command*'.
665
666The optional second argument OUTPUT-BUFFER, if non-nil,
667says to put the output in some other buffer.
668If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
669If OUTPUT-BUFFER is not a buffer and not nil,
670insert output in current buffer. (This cannot be done asynchronously.)
671In either case, the output is inserted after point (leaving mark after it)."
aa00b92d
RS
672 (interactive (list (read-from-minibuffer "Shell command: "
673 nil nil nil 'shell-command-history)
674 current-prefix-arg))
d0d74413
RS
675 (if (and output-buffer
676 (not (or (bufferp output-buffer) (stringp output-buffer))))
2076c87c
JB
677 (progn (barf-if-buffer-read-only)
678 (push-mark)
679 ;; We do not use -f for csh; we will not support broken use of
680 ;; .cshrcs. Even the BSD csh manual says to use
681 ;; "if ($?prompt) exit" before things which are not useful
682 ;; non-interactively. Besides, if someone wants their other
683 ;; aliases for shell commands then they can still have them.
684 (call-process shell-file-name nil t nil
685 "-c" command)
c3e46f0c
RS
686 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
687 ;; It is cleaner to avoid activation, even though the command
688 ;; loop would deactivate the mark because we inserted text.
689 (goto-char (prog1 (mark t)
690 (set-marker (mark-marker) (point)
691 (current-buffer)))))
2076c87c
JB
692 ;; Preserve the match data in case called from a program.
693 (let ((data (match-data)))
694 (unwind-protect
695 (if (string-match "[ \t]*&[ \t]*$" command)
696 ;; Command ending with ampersand means asynchronous.
d0d74413
RS
697 (let ((buffer (get-buffer-create
698 (or output-buffer "*Shell-Command*")))
2076c87c
JB
699 (directory default-directory)
700 proc)
701 ;; Remove the ampersand.
702 (setq command (substring command 0 (match-beginning 0)))
703 ;; If will kill a process, query first.
704 (setq proc (get-buffer-process buffer))
705 (if proc
706 (if (yes-or-no-p "A command is running. Kill it? ")
707 (kill-process proc)
708 (error "Shell command in progress")))
709 (save-excursion
710 (set-buffer buffer)
a9594ce3 711 (setq buffer-read-only nil)
2076c87c
JB
712 (erase-buffer)
713 (display-buffer buffer)
714 (setq default-directory directory)
715 (setq proc (start-process "Shell" buffer
716 shell-file-name "-c" command))
3f655c8a 717 (setq mode-line-process '(":%s"))
2076c87c
JB
718 (set-process-sentinel proc 'shell-command-sentinel)
719 (set-process-filter proc 'shell-command-filter)
720 ))
721 (shell-command-on-region (point) (point) command nil))
722 (store-match-data data)))))
723
724;; We have a sentinel to prevent insertion of a termination message
725;; in the buffer itself.
726(defun shell-command-sentinel (process signal)
d7e84efb
RS
727 (if (and (memq (process-status process) '(exit signal))
728 (buffer-name (process-buffer process)))
2076c87c
JB
729 (progn
730 (message "%s: %s."
731 (car (cdr (cdr (process-command process))))
732 (substring signal 0 -1))
733 (save-excursion
734 (set-buffer (process-buffer process))
735 (setq mode-line-process nil))
736 (delete-process process))))
737
738(defun shell-command-filter (proc string)
739 ;; Do save-excursion by hand so that we can leave point numerically unchanged
740 ;; despite an insertion immediately after it.
741 (let* ((obuf (current-buffer))
742 (buffer (process-buffer proc))
743 opoint
744 (window (get-buffer-window buffer))
745 (pos (window-start window)))
746 (unwind-protect
747 (progn
748 (set-buffer buffer)
3886f8e2
RS
749 (or (= (point) (point-max))
750 (setq opoint (point)))
2076c87c
JB
751 (goto-char (point-max))
752 (insert-before-markers string))
753 ;; insert-before-markers moved this marker: set it back.
754 (set-window-start window pos)
755 ;; Finish our save-excursion.
3886f8e2
RS
756 (if opoint
757 (goto-char opoint))
2076c87c
JB
758 (set-buffer obuf))))
759
d0d74413
RS
760(defun shell-command-on-region (start end command
761 &optional output-buffer interactive)
2076c87c
JB
762 "Execute string COMMAND in inferior shell with region as input.
763Normally display output (if any) in temp buffer `*Shell Command Output*';
764Prefix arg means replace the region with it.
765Noninteractive args are START, END, COMMAND, FLAG.
766Noninteractively FLAG means insert output in place of text from START to END,
767and put point at the end, but don't alter the mark.
768
769If the output is one line, it is displayed in the echo area,
770but it is nonetheless available in buffer `*Shell Command Output*'
771even though that buffer is not automatically displayed. If there is no output
772or output is inserted in the current buffer then `*Shell Command Output*' is
d0d74413
RS
773deleted.
774
775The optional second argument OUTPUT-BUFFER, if non-nil,
776says to put the output in some other buffer.
777If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
778If OUTPUT-BUFFER is not a buffer and not nil,
779insert output in the current buffer.
780In either case, the output is inserted after point (leaving mark after it)."
082c7686 781 (interactive (list (region-beginning) (region-end)
aa00b92d
RS
782 (read-from-minibuffer "Shell command on region: "
783 nil nil nil 'shell-command-history)
2076c87c
JB
784 current-prefix-arg
785 (prefix-numeric-value current-prefix-arg)))
d0d74413
RS
786 (if (and output-buffer
787 (not (or (bufferp output-buffer) (stringp output-buffer))))
2076c87c
JB
788 ;; Replace specified region with output from command.
789 (let ((swap (and interactive (< (point) (mark)))))
790 ;; Don't muck with mark
791 ;; unless called interactively.
792 (and interactive (push-mark))
793 (call-process-region start end shell-file-name t t nil
794 "-c" command)
b5f7c943
KH
795 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
796 (and shell-buffer (not (eq shell-buffer (current-buffer)))
797 (kill-buffer shell-buffer)))
2076c87c
JB
798 (and interactive swap (exchange-point-and-mark)))
799 ;; No prefix argument: put the output in a temp buffer,
800 ;; replacing its entire contents.
d0d74413
RS
801 (let ((buffer (get-buffer-create
802 (or output-buffer "*Shell Command Output*")))
34ee0963
RS
803 (success nil))
804 (unwind-protect
805 (if (eq buffer (current-buffer))
806 ;; If the input is the same buffer as the output,
807 ;; delete everything but the specified region,
808 ;; then replace that region with the output.
a9594ce3
RS
809 (progn (setq buffer-read-only nil)
810 (delete-region end (point-max))
34ee0963
RS
811 (delete-region (point-min) start)
812 (call-process-region (point-min) (point-max)
813 shell-file-name t t nil
814 "-c" command)
815 (setq success t))
816 ;; Clear the output buffer, then run the command with output there.
817 (save-excursion
818 (set-buffer buffer)
a9594ce3 819 (setq buffer-read-only nil)
34ee0963
RS
820 (erase-buffer))
821 (call-process-region start end shell-file-name
822 nil buffer nil
823 "-c" command)
824 (setq success t))
825 ;; Report the amount of output.
826 (let ((lines (save-excursion
827 (set-buffer buffer)
828 (if (= (buffer-size) 0)
829 0
830 (count-lines (point-min) (point-max))))))
831 (cond ((= lines 0)
832 (if success
833 (message "(Shell command completed with no output)"))
834 (kill-buffer buffer))
835 ((and success (= lines 1))
836 (message "%s"
837 (save-excursion
838 (set-buffer buffer)
839 (goto-char (point-min))
840 (buffer-substring (point)
4ec982c5 841 (progn (end-of-line) (point))))))
34ee0963
RS
842 (t
843 (set-window-start (display-buffer buffer) 1))))))))
2076c87c
JB
844\f
845(defun universal-argument ()
846 "Begin a numeric argument for the following command.
847Digits or minus sign following \\[universal-argument] make up the numeric argument.
848\\[universal-argument] following the digits or minus sign ends the argument.
849\\[universal-argument] without digits or minus sign provides 4 as argument.
850Repeating \\[universal-argument] without digits or minus sign
851 multiplies the argument by 4 each time."
852 (interactive nil)
c637ae6f
JB
853 (let ((factor 4)
854 key)
70e14c01
JB
855;; (describe-arg (list factor) 1)
856 (setq key (read-key-sequence nil t))
c637ae6f
JB
857 (while (equal (key-binding key) 'universal-argument)
858 (setq factor (* 4 factor))
70e14c01
JB
859;; (describe-arg (list factor) 1)
860 (setq key (read-key-sequence nil t)))
c637ae6f
JB
861 (prefix-arg-internal key factor nil)))
862
863(defun prefix-arg-internal (key factor value)
2076c87c
JB
864 (let ((sign 1))
865 (if (and (numberp value) (< value 0))
866 (setq sign -1 value (- value)))
867 (if (eq value '-)
868 (setq sign -1 value nil))
70e14c01 869;; (describe-arg value sign)
c637ae6f
JB
870 (while (equal key "-")
871 (setq sign (- sign) factor nil)
70e14c01
JB
872;; (describe-arg value sign)
873 (setq key (read-key-sequence nil t)))
bd307392
JB
874 (while (and (stringp key)
875 (= (length key) 1)
c637ae6f
JB
876 (not (string< key "0"))
877 (not (string< "9" key)))
878 (setq value (+ (* (if (numberp value) value 0) 10)
879 (- (aref key 0) ?0))
880 factor nil)
70e14c01
JB
881;; (describe-arg value sign)
882 (setq key (read-key-sequence nil t)))
2076c87c 883 (setq prefix-arg
c637ae6f 884 (cond (factor (list factor))
2076c87c
JB
885 ((numberp value) (* value sign))
886 ((= sign -1) '-)))
c637ae6f
JB
887 ;; Calling universal-argument after digits
888 ;; terminates the argument but is ignored.
889 (if (eq (key-binding key) 'universal-argument)
890 (progn
891 (describe-arg value sign)
70e14c01 892 (setq key (read-key-sequence nil t))))
d70202c0 893 (setq unread-command-events (listify-key-sequence key))))
c637ae6f
JB
894
895(defun describe-arg (value sign)
896 (cond ((numberp value)
897 (message "Arg: %d" (* value sign)))
898 ((consp value)
899 (message "Arg: [%d]" (car value)))
900 ((< sign 0)
901 (message "Arg: -"))))
2076c87c
JB
902
903(defun digit-argument (arg)
904 "Part of the numeric argument for the next command.
905\\[universal-argument] following digits or minus sign ends the argument."
906 (interactive "P")
c637ae6f
JB
907 (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
908 nil arg))
2076c87c
JB
909
910(defun negative-argument (arg)
911 "Begin a negative numeric argument for the next command.
912\\[universal-argument] following digits or minus sign ends the argument."
913 (interactive "P")
c637ae6f 914 (prefix-arg-internal "-" nil arg))
2076c87c
JB
915\f
916(defun forward-to-indentation (arg)
917 "Move forward ARG lines and position at first nonblank character."
918 (interactive "p")
919 (forward-line arg)
920 (skip-chars-forward " \t"))
921
922(defun backward-to-indentation (arg)
923 "Move backward ARG lines and position at first nonblank character."
924 (interactive "p")
925 (forward-line (- arg))
926 (skip-chars-forward " \t"))
927
38ebcf29 928(defvar kill-whole-line nil
dff7d67f 929 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
38ebcf29 930
2076c87c 931(defun kill-line (&optional arg)
dff7d67f 932 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2076c87c
JB
933With prefix argument, kill that many lines from point.
934Negative arguments kill lines backward.
935
936When calling from a program, nil means \"no arg\",
dff7d67f
RS
937a number counts as a prefix arg.
938
939If `kill-whole-line' is non-nil, then kill the whole line
940when given no argument at the beginning of a line."
2076c87c
JB
941 (interactive "P")
942 (kill-region (point)
e6291fe1
RS
943 ;; It is better to move point to the other end of the kill
944 ;; before killing. That way, in a read-only buffer, point
945 ;; moves across the text that is copied to the kill ring.
946 ;; The choice has no effect on undo now that undo records
947 ;; the value of point from before the command was run.
948 (progn
2076c87c
JB
949 (if arg
950 (forward-line (prefix-numeric-value arg))
951 (if (eobp)
952 (signal 'end-of-buffer nil))
38ebcf29 953 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
2076c87c
JB
954 (forward-line 1)
955 (end-of-line)))
956 (point))))
957\f
70e14c01
JB
958;;;; Window system cut and paste hooks.
959
960(defvar interprogram-cut-function nil
961 "Function to call to make a killed region available to other programs.
962
963Most window systems provide some sort of facility for cutting and
9f112a3d
RS
964pasting text between the windows of different programs.
965This variable holds a function that Emacs calls whenever text
966is put in the kill ring, to make the new kill available to other
70e14c01
JB
967programs.
968
9f112a3d
RS
969The function takes one or two arguments.
970The first argument, TEXT, is a string containing
971the text which should be made available.
972The second, PUSH, if non-nil means this is a \"new\" kill;
973nil means appending to an \"old\" kill.")
70e14c01
JB
974
975(defvar interprogram-paste-function nil
976 "Function to call to get text cut from other programs.
977
978Most window systems provide some sort of facility for cutting and
9f112a3d
RS
979pasting text between the windows of different programs.
980This variable holds a function that Emacs calls to obtain
70e14c01
JB
981text that other programs have provided for pasting.
982
983The function should be called with no arguments. If the function
984returns nil, then no other program has provided such text, and the top
985of the Emacs kill ring should be used. If the function returns a
daa37602
JB
986string, that string should be put in the kill ring as the latest kill.
987
988Note that the function should return a string only if a program other
989than Emacs has provided a string for pasting; if Emacs provided the
990most recent string, the function should return nil. If it is
991difficult to tell whether Emacs or some other program provided the
992current string, it is probably good enough to return nil if the string
993is equal (according to `string=') to the last text Emacs provided.")
70e14c01
JB
994
995
996\f
997;;;; The kill ring data structure.
2076c87c
JB
998
999(defvar kill-ring nil
70e14c01
JB
1000 "List of killed text sequences.
1001Since the kill ring is supposed to interact nicely with cut-and-paste
1002facilities offered by window systems, use of this variable should
1003interact nicely with `interprogram-cut-function' and
1004`interprogram-paste-function'. The functions `kill-new',
1005`kill-append', and `current-kill' are supposed to implement this
1006interaction; you may want to use them instead of manipulating the kill
1007ring directly.")
2076c87c
JB
1008
1009(defconst kill-ring-max 30
1010 "*Maximum length of kill ring before oldest elements are thrown away.")
1011
1012(defvar kill-ring-yank-pointer nil
1013 "The tail of the kill ring whose car is the last thing yanked.")
1014
f914dc91 1015(defun kill-new (string &optional replace)
70e14c01
JB
1016 "Make STRING the latest kill in the kill ring.
1017Set the kill-ring-yank pointer to point to it.
f914dc91
KH
1018If `interprogram-cut-function' is non-nil, apply it to STRING.
1019Optional second argument REPLACE non-nil means that STRING will replace
1020the front of the kill ring, rather than being added to the list."
f1d01ba2
KH
1021 (and (fboundp 'menu-bar-update-yank-menu)
1022 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
f914dc91
KH
1023 (if replace
1024 (setcar kill-ring string)
1025 (setq kill-ring (cons string kill-ring))
1026 (if (> (length kill-ring) kill-ring-max)
1027 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
70e14c01
JB
1028 (setq kill-ring-yank-pointer kill-ring)
1029 (if interprogram-cut-function
9f112a3d 1030 (funcall interprogram-cut-function string t)))
70e14c01 1031
2076c87c 1032(defun kill-append (string before-p)
70e14c01
JB
1033 "Append STRING to the end of the latest kill in the kill ring.
1034If BEFORE-P is non-nil, prepend STRING to the kill.
88c1aa79 1035If `interprogram-cut-function' is set, pass the resulting kill to
70e14c01 1036it."
f914dc91
KH
1037 (kill-new (if before-p
1038 (concat string (car kill-ring))
1039 (concat (car kill-ring) string)) t))
70e14c01
JB
1040
1041(defun current-kill (n &optional do-not-move)
1042 "Rotate the yanking point by N places, and then return that kill.
1043If N is zero, `interprogram-paste-function' is set, and calling it
1044returns a string, then that string is added to the front of the
1045kill ring and returned as the latest kill.
1046If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1047yanking point; just return the Nth kill forward."
1048 (let ((interprogram-paste (and (= n 0)
1049 interprogram-paste-function
1050 (funcall interprogram-paste-function))))
1051 (if interprogram-paste
1052 (progn
1053 ;; Disable the interprogram cut function when we add the new
1054 ;; text to the kill ring, so Emacs doesn't try to own the
1055 ;; selection, with identical text.
1056 (let ((interprogram-cut-function nil))
1057 (kill-new interprogram-paste))
1058 interprogram-paste)
1059 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
1060 (let ((ARGth-kill-element
1061 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1062 (length kill-ring))
1063 kill-ring)))
70e14c01
JB
1064 (or do-not-move
1065 (setq kill-ring-yank-pointer ARGth-kill-element))
1066 (car ARGth-kill-element)))))
c88ab9ce 1067
c88ab9ce 1068
70e14c01
JB
1069\f
1070;;;; Commands for manipulating the kill ring.
c88ab9ce 1071
e6291fe1
RS
1072(defvar kill-read-only-ok nil
1073 "*Non-nil means don't signal an error for killing read-only text.")
1074
2076c87c
JB
1075(defun kill-region (beg end)
1076 "Kill between point and mark.
1077The text is deleted but saved in the kill ring.
1078The command \\[yank] can retrieve it from there.
1079\(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
2aa7a8bf
JB
1080If the buffer is read-only, Emacs will beep and refrain from deleting
1081the text, but put the text in the kill ring anyway. This means that
1082you can use the killing commands to copy text from a read-only buffer.
2076c87c
JB
1083
1084This is the primitive for programs to kill text (as opposed to deleting it).
1085Supply two arguments, character numbers indicating the stretch of text
1086 to be killed.
1087Any command that calls this function is a \"kill command\".
1088If the previous command was also a kill command,
1089the text killed this time appends to the text killed last time
1090to make one entry in the kill ring."
2aa7a8bf 1091 (interactive "r")
70e14c01 1092 (cond
2aa7a8bf
JB
1093
1094 ;; If the buffer is read-only, we should beep, in case the person
1095 ;; just isn't aware of this. However, there's no harm in putting
1096 ;; the region's text in the kill ring, anyway.
e6291fe1
RS
1097 ((or (and buffer-read-only (not inhibit-read-only))
1098 (text-property-not-all beg end 'read-only nil))
2aa7a8bf 1099 (copy-region-as-kill beg end)
1537a263 1100 ;; This should always barf, and give us the correct error.
e6291fe1
RS
1101 (if kill-read-only-ok
1102 (message "Read only text copied to kill ring")
1103 (barf-if-buffer-read-only)))
2aa7a8bf
JB
1104
1105 ;; In certain cases, we can arrange for the undo list and the kill
1106 ;; ring to share the same string object. This code does that.
70e14c01
JB
1107 ((not (or (eq buffer-undo-list t)
1108 (eq last-command 'kill-region)
7e37cd30 1109 (equal beg end)))
70e14c01 1110 ;; Don't let the undo list be truncated before we can even access it.
12bcd3b6
RS
1111 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1112 (old-list buffer-undo-list)
1113 tail)
70e14c01 1114 (delete-region beg end)
12bcd3b6
RS
1115 ;; Search back in buffer-undo-list for this string,
1116 ;; in case a change hook made property changes.
1117 (setq tail buffer-undo-list)
1118 (while (not (stringp (car (car tail))))
1119 (setq tail (cdr tail)))
70e14c01
JB
1120 ;; Take the same string recorded for undo
1121 ;; and put it in the kill-ring.
12bcd3b6 1122 (kill-new (car (car tail)))
70e14c01 1123 (setq this-command 'kill-region)))
2aa7a8bf 1124
70e14c01 1125 (t
2076c87c 1126 (copy-region-as-kill beg end)
70e14c01 1127 (delete-region beg end))))
2076c87c 1128
2076c87c
JB
1129(defun copy-region-as-kill (beg end)
1130 "Save the region as if killed, but don't kill it.
46947372
JB
1131If `interprogram-cut-function' is non-nil, also save the text for a window
1132system cut and paste."
2076c87c
JB
1133 (interactive "r")
1134 (if (eq last-command 'kill-region)
1135 (kill-append (buffer-substring beg end) (< end beg))
70e14c01
JB
1136 (kill-new (buffer-substring beg end)))
1137 (setq this-command 'kill-region)
2076c87c
JB
1138 nil)
1139
1140(defun kill-ring-save (beg end)
0964e562 1141 "Save the region as if killed, but don't kill it.
230c6b36 1142This command is similar to `copy-region-as-kill', except that it gives
0964e562
JB
1143visual feedback indicating the extent of the region being copied.
1144If `interprogram-cut-function' is non-nil, also save the text for a window
1145system cut and paste."
2076c87c
JB
1146 (interactive "r")
1147 (copy-region-as-kill beg end)
3a801d0c 1148 (if (interactive-p)
66050f10
RS
1149 (let ((other-end (if (= (point) beg) end beg))
1150 (opoint (point))
1151 ;; Inhibit quitting so we can make a quit here
1152 ;; look like a C-g typed as a command.
1153 (inhibit-quit t))
1154 (if (pos-visible-in-window-p other-end (selected-window))
1155 (progn
1156 ;; Swap point and mark.
1157 (set-marker (mark-marker) (point) (current-buffer))
1158 (goto-char other-end)
1159 (sit-for 1)
1160 ;; Swap back.
1161 (set-marker (mark-marker) other-end (current-buffer))
1162 (goto-char opoint)
1163 ;; If user quit, deactivate the mark
1164 ;; as C-g would as a command.
e4e593ae 1165 (and quit-flag mark-active
fcadf1c7 1166 (deactivate-mark)))
66050f10
RS
1167 (let* ((killed-text (current-kill 0))
1168 (message-len (min (length killed-text) 40)))
1169 (if (= (point) beg)
1170 ;; Don't say "killed"; that is misleading.
1171 (message "Saved text until \"%s\""
1172 (substring killed-text (- message-len)))
1173 (message "Saved text from \"%s\""
1174 (substring killed-text 0 message-len))))))))
2076c87c
JB
1175
1176(defun append-next-kill ()
ff1fbe3e 1177 "Cause following command, if it kills, to append to previous kill."
2076c87c
JB
1178 (interactive)
1179 (if (interactive-p)
1180 (progn
1181 (setq this-command 'kill-region)
1182 (message "If the next command is a kill, it will append"))
1183 (setq last-command 'kill-region)))
1184
2076c87c 1185(defun yank-pop (arg)
ff1fbe3e
RS
1186 "Replace just-yanked stretch of killed text with a different stretch.
1187This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 1188At such a time, the region contains a stretch of reinserted
ff1fbe3e 1189previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
1190place a different stretch of killed text.
1191
1192With no argument, the previous kill is inserted.
ff1fbe3e
RS
1193With argument N, insert the Nth previous kill.
1194If N is negative, this is a more recent kill.
2076c87c
JB
1195
1196The sequence of kills wraps around, so that after the oldest one
1197comes the newest one."
1198 (interactive "*p")
1199 (if (not (eq last-command 'yank))
1200 (error "Previous command was not a yank"))
1201 (setq this-command 'yank)
9a1277dd
RS
1202 (let ((before (< (point) (mark t))))
1203 (delete-region (point) (mark t))
fd0f4056 1204 (set-marker (mark-marker) (point) (current-buffer))
70e14c01 1205 (insert (current-kill arg))
fd0f4056
RS
1206 (if before
1207 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1208 ;; It is cleaner to avoid activation, even though the command
1209 ;; loop would deactivate the mark because we inserted text.
1210 (goto-char (prog1 (mark t)
1211 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 1212 nil)
2076c87c
JB
1213
1214(defun yank (&optional arg)
1215 "Reinsert the last stretch of killed text.
1216More precisely, reinsert the stretch of killed text most recently
ff1fbe3e
RS
1217killed OR yanked. Put point at end, and set mark at beginning.
1218With just C-u as argument, same but put point at beginning (and mark at end).
1219With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c
JB
1220text.
1221See also the command \\[yank-pop]."
1222 (interactive "*P")
456c617c
RS
1223 ;; If we don't get all the way thru, make last-command indicate that
1224 ;; for the following command.
1225 (setq this-command t)
2076c87c 1226 (push-mark (point))
70e14c01
JB
1227 (insert (current-kill (cond
1228 ((listp arg) 0)
1229 ((eq arg '-) -1)
1230 (t (1- arg)))))
2076c87c 1231 (if (consp arg)
fd0f4056
RS
1232 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1233 ;; It is cleaner to avoid activation, even though the command
1234 ;; loop would deactivate the mark because we inserted text.
1235 (goto-char (prog1 (mark t)
1236 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c
RS
1237 ;; If we do get all the way thru, make this-command indicate that.
1238 (setq this-command 'yank)
0964e562 1239 nil)
70e14c01
JB
1240
1241(defun rotate-yank-pointer (arg)
1242 "Rotate the yanking point in the kill ring.
1243With argument, rotate that many kills forward (or backward, if negative)."
1244 (interactive "p")
1245 (current-kill arg))
1246
2076c87c
JB
1247\f
1248(defun insert-buffer (buffer)
1249 "Insert after point the contents of BUFFER.
1250Puts mark after the inserted text.
1251BUFFER may be a buffer or a buffer name."
58ff020d 1252 (interactive (list (progn (barf-if-buffer-read-only)
8be055fd
RS
1253 (read-buffer "Insert buffer: "
1254 (other-buffer (current-buffer) t)
1255 t))))
2076c87c
JB
1256 (or (bufferp buffer)
1257 (setq buffer (get-buffer buffer)))
1258 (let (start end newmark)
1259 (save-excursion
1260 (save-excursion
1261 (set-buffer buffer)
1262 (setq start (point-min) end (point-max)))
1263 (insert-buffer-substring buffer start end)
1264 (setq newmark (point)))
1537a263
JB
1265 (push-mark newmark))
1266 nil)
2076c87c
JB
1267
1268(defun append-to-buffer (buffer start end)
1269 "Append to specified buffer the text of the region.
1270It is inserted into that buffer before its point.
1271
1272When calling from a program, give three arguments:
1273BUFFER (or buffer name), START and END.
1274START and END specify the portion of the current buffer to be copied."
70e14c01 1275 (interactive
23efee2c
RS
1276 (list (read-buffer "Append to buffer: " (other-buffer nil t))
1277 (region-beginning) (region-end)))
2076c87c
JB
1278 (let ((oldbuf (current-buffer)))
1279 (save-excursion
1280 (set-buffer (get-buffer-create buffer))
1281 (insert-buffer-substring oldbuf start end))))
1282
1283(defun prepend-to-buffer (buffer start end)
1284 "Prepend to specified buffer the text of the region.
1285It is inserted into that buffer after its point.
1286
1287When calling from a program, give three arguments:
1288BUFFER (or buffer name), START and END.
1289START and END specify the portion of the current buffer to be copied."
1290 (interactive "BPrepend to buffer: \nr")
1291 (let ((oldbuf (current-buffer)))
1292 (save-excursion
1293 (set-buffer (get-buffer-create buffer))
1294 (save-excursion
1295 (insert-buffer-substring oldbuf start end)))))
1296
1297(defun copy-to-buffer (buffer start end)
1298 "Copy to specified buffer the text of the region.
1299It is inserted into that buffer, replacing existing text there.
1300
1301When calling from a program, give three arguments:
1302BUFFER (or buffer name), START and END.
1303START and END specify the portion of the current buffer to be copied."
1304 (interactive "BCopy to buffer: \nr")
1305 (let ((oldbuf (current-buffer)))
1306 (save-excursion
1307 (set-buffer (get-buffer-create buffer))
1308 (erase-buffer)
1309 (save-excursion
1310 (insert-buffer-substring oldbuf start end)))))
1311\f
0bf0c097
RS
1312(defvar mark-even-if-inactive nil
1313 "*Non-nil means you can use the mark even when inactive.
1314This option makes a difference in Transient Mark mode.
1315When the option is non-nil, deactivation of the mark
1316turns off region highlighting, but commands that use the mark
1317behave as if the mark were still active.")
1318
62d1c1fc
RM
1319(put 'mark-inactive 'error-conditions '(mark-inactive error))
1320(put 'mark-inactive 'error-message "The mark is not active now")
1321
af39530e 1322(defun mark (&optional force)
c7c8b31e 1323 "Return this buffer's mark value as integer; error if mark inactive.
af39530e 1324If optional argument FORCE is non-nil, access the mark value
c7c8b31e
RS
1325even if the mark is not currently active, and return nil
1326if there is no mark at all.
af39530e 1327
2076c87c
JB
1328If you are using this in an editing command, you are most likely making
1329a mistake; see the documentation of `set-mark'."
0bf0c097 1330 (if (or force mark-active mark-even-if-inactive)
af39530e 1331 (marker-position (mark-marker))
62d1c1fc 1332 (signal 'mark-inactive nil)))
2076c87c 1333
19d35374
RM
1334;; Many places set mark-active directly, and several of them failed to also
1335;; run deactivate-mark-hook. This shorthand should simplify.
1336(defsubst deactivate-mark ()
1337 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 1338\(That makes a difference only in Transient Mark mode.)
19d35374 1339Also runs the hook `deactivate-mark-hook'."
a4b9d3da
RS
1340 (if transient-mark-mode
1341 (progn
1342 (setq mark-active nil)
1343 (run-hooks 'deactivate-mark-hook))))
19d35374 1344
2076c87c
JB
1345(defun set-mark (pos)
1346 "Set this buffer's mark to POS. Don't use this function!
1347That is to say, don't use this function unless you want
1348the user to see that the mark has moved, and you want the previous
1349mark position to be lost.
1350
1351Normally, when a new mark is set, the old one should go on the stack.
1352This is why most applications should use push-mark, not set-mark.
1353
ff1fbe3e 1354Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
1355purposes. The mark saves a location for the user's convenience.
1356Most editing commands should not alter the mark.
1357To remember a location for internal use in the Lisp program,
1358store it in a Lisp variable. Example:
1359
1360 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1361
fcadf1c7
RS
1362 (if pos
1363 (progn
1364 (setq mark-active t)
1365 (run-hooks 'activate-mark-hook)
1366 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
1367 ;; Normally we never clear mark-active except in Transient Mark mode.
1368 ;; But when we actually clear out the mark value too,
1369 ;; we must clear mark-active in any mode.
1370 (setq mark-active nil)
1371 (run-hooks 'deactivate-mark-hook)
1372 (set-marker (mark-marker) nil)))
2076c87c
JB
1373
1374(defvar mark-ring nil
e55e2267 1375 "The list of former marks of the current buffer, most recent first.")
2076c87c 1376(make-variable-buffer-local 'mark-ring)
e55e2267 1377(put 'mark-ring 'permanent-local t)
2076c87c
JB
1378
1379(defconst mark-ring-max 16
1380 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1381
dc029f0b
RM
1382(defvar global-mark-ring nil
1383 "The list of saved global marks, most recent first.")
1384
1385(defconst global-mark-ring-max 16
1386 "*Maximum size of global mark ring. \
1387Start discarding off end if gets this big.")
1388
2076c87c
JB
1389(defun set-mark-command (arg)
1390 "Set mark at where point is, or jump to mark.
dc029f0b
RM
1391With no prefix argument, set mark, push old mark position on local mark
1392ring, and push mark on global mark ring.
1393With argument, jump to mark, and pop a new position for mark off the ring
1394\(does not affect global mark ring\).
2076c87c 1395
ff1fbe3e 1396Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
1397purposes. See the documentation of `set-mark' for more information."
1398 (interactive "P")
1399 (if (null arg)
9a1277dd 1400 (progn
fd0f4056 1401 (push-mark nil nil t))
af39530e 1402 (if (null (mark t))
2076c87c 1403 (error "No mark set in this buffer")
9a1277dd 1404 (goto-char (mark t))
2076c87c
JB
1405 (pop-mark))))
1406
fd0f4056 1407(defun push-mark (&optional location nomsg activate)
2076c87c 1408 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
1409If the last global mark pushed was not in the current buffer,
1410also push LOCATION on the global mark ring.
fd0f4056 1411Display `Mark set' unless the optional second arg NOMSG is non-nil.
8cdc660f 1412In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2076c87c 1413
ff1fbe3e 1414Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
1415purposes. See the documentation of `set-mark' for more information.
1416
1417In Transient Mark mode, this does not activate the mark."
af39530e 1418 (if (null (mark t))
2076c87c
JB
1419 nil
1420 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1421 (if (> (length mark-ring) mark-ring-max)
1422 (progn
1423 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1424 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
9a1277dd 1425 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 1426 ;; Now push the mark on the global mark ring.
f1382a3d 1427 (if (and global-mark-ring
e08d3f7c 1428 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
1429 ;; The last global mark pushed was in this same buffer.
1430 ;; Don't push another one.
1431 nil
1432 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
dc029f0b
RM
1433 (if (> (length global-mark-ring) global-mark-ring-max)
1434 (progn
1435 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1436 nil)
f1382a3d 1437 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2076c87c
JB
1438 (or nomsg executing-macro (> (minibuffer-depth) 0)
1439 (message "Mark set"))
8cdc660f
RS
1440 (if (or activate (not transient-mark-mode))
1441 (set-mark (mark t)))
2076c87c
JB
1442 nil)
1443
1444(defun pop-mark ()
1445 "Pop off mark ring into the buffer's actual mark.
1446Does not set point. Does nothing if mark ring is empty."
1447 (if mark-ring
1448 (progn
1449 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
9a1277dd 1450 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
19d35374 1451 (deactivate-mark)
2076c87c 1452 (move-marker (car mark-ring) nil)
9a1277dd 1453 (if (null (mark t)) (ding))
2076c87c
JB
1454 (setq mark-ring (cdr mark-ring)))))
1455
dff7d67f 1456(define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
2076c87c 1457(defun exchange-point-and-mark ()
af39530e
RS
1458 "Put the mark where point is now, and point where the mark is now.
1459This command works even when the mark is not active,
1460and it reactivates the mark."
2076c87c 1461 (interactive nil)
af39530e 1462 (let ((omark (mark t)))
2076c87c
JB
1463 (if (null omark)
1464 (error "No mark set in this buffer"))
1465 (set-mark (point))
1466 (goto-char omark)
1467 nil))
e23c2c21
RS
1468
1469(defun transient-mark-mode (arg)
1470 "Toggle Transient Mark mode.
b411b5fa 1471With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 1472
5dd1220d
RS
1473In Transient Mark mode, when the mark is active, the region is highlighted.
1474Changing the buffer \"deactivates\" the mark.
1475So do certain other operations that set the mark
1476but whose main purpose is something else--for example,
1477incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
e23c2c21
RS
1478 (interactive "P")
1479 (setq transient-mark-mode
1480 (if (null arg)
1481 (not transient-mark-mode)
1482 (> (prefix-numeric-value arg) 0))))
dc029f0b
RM
1483
1484(defun pop-global-mark ()
1485 "Pop off global mark ring and jump to the top location."
1486 (interactive)
52b6d445
RS
1487 ;; Pop entries which refer to non-existent buffers.
1488 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1489 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
1490 (or global-mark-ring
1491 (error "No global mark set"))
1492 (let* ((marker (car global-mark-ring))
1493 (buffer (marker-buffer marker))
1494 (position (marker-position marker)))
1495 (setq global-mark-ring (cdr global-mark-ring))
1496 (set-buffer buffer)
1497 (or (and (>= position (point-min))
1498 (<= position (point-max)))
1499 (widen))
1500 (goto-char position)
1501 (switch-to-buffer buffer)))
2076c87c 1502\f
38ebcf29 1503(defvar next-line-add-newlines t
dff7d67f 1504 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
38ebcf29 1505
2076c87c
JB
1506(defun next-line (arg)
1507 "Move cursor vertically down ARG lines.
1508If there is no character in the target line exactly under the current column,
1509the cursor is positioned after the character in that line which spans this
1510column, or at the end of the line if it is not long enough.
38ebcf29
ER
1511If there is no line in the buffer after this one, behavior depends on the
1512value of next-line-add-newlines. If non-nil, a newline character is inserted
1513to create a line and the cursor moves to that line, otherwise the cursor is
1514moved to the end of the buffer (if already at the end of the buffer, an error
1515is signaled).
2076c87c
JB
1516
1517The command \\[set-goal-column] can be used to create
1518a semipermanent goal column to which this command always moves.
1519Then it does not try to move vertically. This goal column is stored
1520in `goal-column', which is nil when there is none.
1521
1522If you are thinking of using this in a Lisp program, consider
1523using `forward-line' instead. It is usually easier to use
1524and more reliable (no dependence on goal column, etc.)."
1525 (interactive "p")
028922cf
RS
1526 (if (and next-line-add-newlines (= arg 1))
1527 (let ((opoint (point)))
3534a809
RS
1528 (end-of-line)
1529 (if (eobp)
028922cf
RS
1530 (insert ?\n)
1531 (goto-char opoint)
1532 (line-move arg)))
1533 (line-move arg))
2076c87c
JB
1534 nil)
1535
1536(defun previous-line (arg)
1537 "Move cursor vertically up ARG lines.
1538If there is no character in the target line exactly over the current column,
1539the cursor is positioned after the character in that line which spans this
1540column, or at the end of the line if it is not long enough.
1541
1542The command \\[set-goal-column] can be used to create
1543a semipermanent goal column to which this command always moves.
1544Then it does not try to move vertically.
1545
1546If you are thinking of using this in a Lisp program, consider using
c2e8a012 1547`forward-line' with a negative argument instead. It is usually easier
2076c87c
JB
1548to use and more reliable (no dependence on goal column, etc.)."
1549 (interactive "p")
1550 (line-move (- arg))
1551 nil)
1552
1553(defconst track-eol nil
1554 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1555This means moving to the end of each line moved onto.
1556The beginning of a blank line does not count as the end of a line.")
1557
912c6728
RS
1558(defvar goal-column nil
1559 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1560(make-variable-buffer-local 'goal-column)
2076c87c
JB
1561
1562(defvar temporary-goal-column 0
1563 "Current goal column for vertical motion.
1564It is the column where point was
1565at the start of current run of vertical motion commands.
c637ae6f 1566When the `track-eol' feature is doing its job, the value is 9999.")
2076c87c
JB
1567
1568(defun line-move (arg)
1d8f6c8c
RS
1569 (if (not (or (eq last-command 'next-line)
1570 (eq last-command 'previous-line)))
1571 (setq temporary-goal-column
1572 (if (and track-eol (eolp)
1573 ;; Don't count beg of empty line as end of line
1574 ;; unless we just did explicit end-of-line.
1575 (or (not (bolp)) (eq last-command 'end-of-line)))
1576 9999
1577 (current-column))))
1578 (if (not (integerp selective-display))
3534a809
RS
1579 (or (if (> arg 0)
1580 (progn (if (> arg 1) (forward-line (1- arg)))
1581 ;; This way of moving forward ARG lines
1582 ;; verifies that we have a newline after the last one.
1583 ;; It doesn't get confused by intangible text.
1584 (end-of-line)
1585 (zerop (forward-line 1)))
1586 (and (zerop (forward-line arg))
1587 (bolp)))
1d8f6c8c
RS
1588 (signal (if (bobp)
1589 'beginning-of-buffer
1590 'end-of-buffer)
1591 nil))
1592 ;; Move by arg lines, but ignore invisible ones.
1593 (while (> arg 0)
1594 (end-of-line)
1595 (and (zerop (vertical-motion 1))
1596 (signal 'end-of-buffer nil))
1597 (setq arg (1- arg)))
1598 (while (< arg 0)
1599 (beginning-of-line)
1600 (and (zerop (vertical-motion -1))
1601 (signal 'beginning-of-buffer nil))
1602 (setq arg (1+ arg))))
1603 (move-to-column (or goal-column temporary-goal-column))
1604 nil)
2076c87c 1605
d5ab2033
JB
1606;;; Many people have said they rarely use this feature, and often type
1607;;; it by accident. Maybe it shouldn't even be on a key.
1608(put 'set-goal-column 'disabled t)
2076c87c
JB
1609
1610(defun set-goal-column (arg)
1611 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1612Those commands will move to this position in the line moved to
1613rather than trying to keep the same horizontal position.
1614With a non-nil argument, clears out the goal column
912c6728
RS
1615so that \\[next-line] and \\[previous-line] resume vertical motion.
1616The goal column is stored in the variable `goal-column'."
2076c87c
JB
1617 (interactive "P")
1618 (if arg
1619 (progn
1620 (setq goal-column nil)
1621 (message "No goal column"))
1622 (setq goal-column (current-column))
1623 (message (substitute-command-keys
1624 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1625 goal-column))
1626 nil)
1627\f
0d5bbbf7
ER
1628;;; Partial support for horizontal autoscrolling. Someday, this feature
1629;;; will be built into the C level and all the (hscroll-point-visible) calls
1630;;; will go away.
1631
1632(defvar hscroll-step 0
1633 "*The number of columns to try scrolling a window by when point moves out.
1634If that fails to bring point back on frame, point is centered instead.
1635If this is zero, point is always centered after it moves off frame.")
1636
1637(defun hscroll-point-visible ()
26c5bf8e
KH
1638 "Scrolls the selected window horizontally to make point visible."
1639 (save-excursion
1640 (set-buffer (window-buffer))
1641 (if (not (or truncate-lines
1642 (> (window-hscroll) 0)
1643 (and truncate-partial-width-windows
1644 (< (window-width) (frame-width)))))
1645 ;; Point is always visible when lines are wrapped.
1646 ()
1647 ;; If point is on the invisible part of the line before window-start,
1648 ;; then hscrolling can't bring it back, so reset window-start first.
1649 (and (< (point) (window-start))
1650 (let ((ws-bol (save-excursion
1651 (goto-char (window-start))
1652 (beginning-of-line)
1653 (point))))
1654 (and (>= (point) ws-bol)
1655 (set-window-start nil ws-bol))))
1656 (let* ((here (hscroll-window-column))
1657 (left (min (window-hscroll) 1))
1658 (right (1- (window-width))))
1659 ;; Allow for the truncation glyph, if we're not exactly at eol.
1660 (if (not (and (= here right)
1661 (= (following-char) ?\n)))
1662 (setq right (1- right)))
1663 (cond
1664 ;; If too far away, just recenter. But don't show too much
1665 ;; white space off the end of the line.
1666 ((or (< here (- left hscroll-step))
1667 (> here (+ right hscroll-step)))
1668 (let ((eol (save-excursion (end-of-line) (hscroll-window-column))))
1669 (scroll-left (min (- here (/ (window-width) 2))
1670 (- eol (window-width) -5)))))
1671 ;; Within range. Scroll by one step (or maybe not at all).
1672 ((< here left)
1673 (scroll-right hscroll-step))
1674 ((> here right)
1675 (scroll-left hscroll-step)))))))
1676
1677;; This function returns the window's idea of the display column of point,
1678;; assuming that the window is already known to be truncated rather than
1679;; wrapped, and that we've already handled the case where point is on the
1680;; part of the line before window-start. We ignore window-width; if point
1681;; is beyond the right margin, we want to know how far. The return value
1682;; includes the effects of window-hscroll, window-start, and the prompt
1683;; string in the minibuffer. It may be negative due to hscroll.
1684(defun hscroll-window-column ()
1685 (let* ((hscroll (window-hscroll))
1686 (startpos (save-excursion
1687 (beginning-of-line)
1688 (if (= (point) (save-excursion
1689 (goto-char (window-start))
1690 (beginning-of-line)
1691 (point)))
1692 (goto-char (window-start)))
1693 (point)))
1694 (hpos (+ (if (and (eq (selected-window) (minibuffer-window))
1695 (= 1 (window-start))
1696 (= startpos (point-min)))
1697 (minibuffer-prompt-width)
1698 0)
1699 (min 0 (- 1 hscroll))))
1700 val)
1701 (car (cdr (compute-motion startpos (cons hpos 0)
1702 (point) (cons 0 1)
1703 1000000 (cons hscroll 0) nil)))))
1704
0d5bbbf7 1705
dff7d67f
RS
1706;; rms: (1) The definitions of arrow keys should not simply restate
1707;; what keys they are. The arrow keys should run the ordinary commands.
1708;; (2) The arrow keys are just one of many common ways of moving point
1709;; within a line. Real horizontal autoscrolling would be a good feature,
1710;; but supporting it only for arrow keys is too incomplete to be desirable.
1711
1712;;;;; Make arrow keys do the right thing for improved terminal support
1713;;;;; When we implement true horizontal autoscrolling, right-arrow and
1714;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1715;;;;; aliases. These functions are bound to the corresponding keyboard
1716;;;;; events in loaddefs.el.
1717
1718;;(defun right-arrow (arg)
1719;; "Move right one character on the screen (with prefix ARG, that many chars).
1720;;Scroll right if needed to keep point horizontally onscreen."
1721;; (interactive "P")
1722;; (forward-char arg)
1723;; (hscroll-point-visible))
1724
1725;;(defun left-arrow (arg)
1726;; "Move left one character on the screen (with prefix ARG, that many chars).
1727;;Scroll left if needed to keep point horizontally onscreen."
1728;; (interactive "P")
1729;; (backward-char arg)
1730;; (hscroll-point-visible))
7492f5a6
RS
1731
1732(defun scroll-other-window-down (lines)
1733 "Scroll the \"other window\" down."
1734 (interactive "P")
1735 (scroll-other-window
1736 ;; Just invert the argument's meaning.
1737 ;; We can do that without knowing which window it will be.
1738 (if (eq lines '-) nil
1739 (if (null lines) '-
1740 (- (prefix-numeric-value lines))))))
3aef9604
RS
1741
1742(defun beginning-of-buffer-other-window (arg)
1743 "Move point to the beginning of the buffer in the other window.
1744Leave mark at previous position.
1745With arg N, put point N/10 of the way from the true beginning."
1746 (interactive "P")
1747 (let ((orig-window (selected-window))
1748 (window (other-window-for-scrolling)))
1749 ;; We use unwind-protect rather than save-window-excursion
1750 ;; because the latter would preserve the things we want to change.
1751 (unwind-protect
1752 (progn
1753 (select-window window)
1754 ;; Set point and mark in that window's buffer.
1755 (beginning-of-buffer arg)
1756 ;; Set point accordingly.
1757 (recenter '(t)))
1758 (select-window orig-window))))
1759
1760(defun end-of-buffer-other-window (arg)
1761 "Move point to the end of the buffer in the other window.
1762Leave mark at previous position.
1763With arg N, put point N/10 of the way from the true end."
1764 (interactive "P")
1765 ;; See beginning-of-buffer-other-window for comments.
1766 (let ((orig-window (selected-window))
1767 (window (other-window-for-scrolling)))
1768 (unwind-protect
1769 (progn
1770 (select-window window)
4500ff36 1771 (end-of-buffer arg)
3aef9604
RS
1772 (recenter '(t)))
1773 (select-window orig-window))))
38ebcf29 1774\f
2076c87c
JB
1775(defun transpose-chars (arg)
1776 "Interchange characters around point, moving forward one character.
1777With prefix arg ARG, effect is to take character before point
1778and drag it forward past ARG other characters (backward if ARG negative).
1779If no argument and at end of line, the previous two chars are exchanged."
1780 (interactive "*P")
1781 (and (null arg) (eolp) (forward-char -1))
1782 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1783
1784(defun transpose-words (arg)
1785 "Interchange words around point, leaving point at end of them.
1786With prefix arg ARG, effect is to take word before or around point
1787and drag it forward past ARG other words (backward if ARG negative).
1788If ARG is zero, the words around or after point and around or after mark
1789are interchanged."
1790 (interactive "*p")
1791 (transpose-subr 'forward-word arg))
1792
1793(defun transpose-sexps (arg)
1794 "Like \\[transpose-words] but applies to sexps.
1795Does not work on a sexp that point is in the middle of
1796if it is a list or string."
1797 (interactive "*p")
1798 (transpose-subr 'forward-sexp arg))
1799
1800(defun transpose-lines (arg)
1801 "Exchange current line and previous line, leaving point after both.
1802With argument ARG, takes previous line and moves it past ARG lines.
1803With argument 0, interchanges line point is in with line mark is in."
1804 (interactive "*p")
1805 (transpose-subr (function
1806 (lambda (arg)
1807 (if (= arg 1)
1808 (progn
1809 ;; Move forward over a line,
1810 ;; but create a newline if none exists yet.
1811 (end-of-line)
1812 (if (eobp)
1813 (newline)
1814 (forward-char 1)))
1815 (forward-line arg))))
1816 arg))
1817
1818(defun transpose-subr (mover arg)
1819 (let (start1 end1 start2 end2)
1820 (if (= arg 0)
1821 (progn
1822 (save-excursion
1823 (funcall mover 1)
1824 (setq end2 (point))
1825 (funcall mover -1)
1826 (setq start2 (point))
1827 (goto-char (mark))
1828 (funcall mover 1)
1829 (setq end1 (point))
1830 (funcall mover -1)
1831 (setq start1 (point))
1832 (transpose-subr-1))
1833 (exchange-point-and-mark)))
1834 (while (> arg 0)
1835 (funcall mover -1)
1836 (setq start1 (point))
1837 (funcall mover 1)
1838 (setq end1 (point))
1839 (funcall mover 1)
1840 (setq end2 (point))
1841 (funcall mover -1)
1842 (setq start2 (point))
1843 (transpose-subr-1)
1844 (goto-char end2)
1845 (setq arg (1- arg)))
1846 (while (< arg 0)
1847 (funcall mover -1)
1848 (setq start2 (point))
1849 (funcall mover -1)
1850 (setq start1 (point))
1851 (funcall mover 1)
1852 (setq end1 (point))
1853 (funcall mover 1)
1854 (setq end2 (point))
1855 (transpose-subr-1)
1856 (setq arg (1+ arg)))))
1857
1858(defun transpose-subr-1 ()
1859 (if (> (min end1 end2) (max start1 start2))
1860 (error "Don't have two things to transpose"))
1861 (let ((word1 (buffer-substring start1 end1))
1862 (word2 (buffer-substring start2 end2)))
1863 (delete-region start2 end2)
1864 (goto-char start2)
1865 (insert word1)
1866 (goto-char (if (< start1 start2) start1
1867 (+ start1 (- (length word1) (length word2)))))
1868 (delete-char (length word1))
1869 (insert word2)))
1870\f
1871(defconst comment-column 32
1872 "*Column to indent right-margin comments to.
8a8fa723
JB
1873Setting this variable automatically makes it local to the current buffer.
1874Each mode establishes a different default value for this variable; you
b492f73b 1875can set the value for a particular mode using that mode's hook.")
2076c87c
JB
1876(make-variable-buffer-local 'comment-column)
1877
1878(defconst comment-start nil
1879 "*String to insert to start a new comment, or nil if no comment syntax defined.")
1880
1881(defconst comment-start-skip nil
1882 "*Regexp to match the start of a comment plus everything up to its body.
1883If there are any \\(...\\) pairs, the comment delimiter text is held to begin
1884at the place matched by the close of the first pair.")
1885
1886(defconst comment-end ""
1887 "*String to insert to end a new comment.
1888Should be an empty string if comments are terminated by end-of-line.")
1889
ec9a76e3
JB
1890(defconst comment-indent-hook nil
1891 "Obsolete variable for function to compute desired indentation for a comment.
1892This function is called with no args with point at the beginning of
1893the comment's starting delimiter.")
1894
1895(defconst comment-indent-function
2076c87c
JB
1896 '(lambda () comment-column)
1897 "Function to compute desired indentation for a comment.
1898This function is called with no args with point at the beginning of
1899the comment's starting delimiter.")
1900
1901(defun indent-for-comment ()
1902 "Indent this line's comment to comment column, or insert an empty comment."
1903 (interactive "*")
1904 (beginning-of-line 1)
1905 (if (null comment-start)
1906 (error "No comment syntax defined")
1907 (let* ((eolpos (save-excursion (end-of-line) (point)))
1908 cpos indent begpos)
1909 (if (re-search-forward comment-start-skip eolpos 'move)
1910 (progn (setq cpos (point-marker))
1911 ;; Find the start of the comment delimiter.
1912 ;; If there were paren-pairs in comment-start-skip,
1913 ;; position at the end of the first pair.
1914 (if (match-end 1)
1915 (goto-char (match-end 1))
9d0f559a
RM
1916 ;; If comment-start-skip matched a string with
1917 ;; internal whitespace (not final whitespace) then
1918 ;; the delimiter start at the end of that
1919 ;; whitespace. Otherwise, it starts at the
1920 ;; beginning of what was matched.
1921 (skip-syntax-backward " " (match-beginning 0))
1922 (skip-syntax-backward "^ " (match-beginning 0)))))
2076c87c
JB
1923 (setq begpos (point))
1924 ;; Compute desired indent.
1925 (if (= (current-column)
9d0f559a
RM
1926 (setq indent (if comment-indent-hook
1927 (funcall comment-indent-hook)
1928 (funcall comment-indent-function))))
2076c87c
JB
1929 (goto-char begpos)
1930 ;; If that's different from current, change it.
1931 (skip-chars-backward " \t")
1932 (delete-region (point) begpos)
1933 (indent-to indent))
1934 ;; An existing comment?
1935 (if cpos
1936 (progn (goto-char cpos)
1937 (set-marker cpos nil))
1938 ;; No, insert one.
1939 (insert comment-start)
1940 (save-excursion
1941 (insert comment-end))))))
1942
1943(defun set-comment-column (arg)
1944 "Set the comment column based on point.
1945With no arg, set the comment column to the current column.
1946With just minus as arg, kill any comment on this line.
1947With any other arg, set comment column to indentation of the previous comment
1948 and then align or create a comment on this line at that column."
1949 (interactive "P")
1950 (if (eq arg '-)
1951 (kill-comment nil)
1952 (if arg
1953 (progn
1954 (save-excursion
1955 (beginning-of-line)
1956 (re-search-backward comment-start-skip)
1957 (beginning-of-line)
1958 (re-search-forward comment-start-skip)
1959 (goto-char (match-beginning 0))
1960 (setq comment-column (current-column))
1961 (message "Comment column set to %d" comment-column))
1962 (indent-for-comment))
1963 (setq comment-column (current-column))
1964 (message "Comment column set to %d" comment-column))))
1965
1966(defun kill-comment (arg)
1967 "Kill the comment on this line, if any.
1968With argument, kill comments on that many lines starting with this one."
1969 ;; this function loses in a lot of situations. it incorrectly recognises
1970 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
1971 ;; with multi-line comments, can kill extra whitespace if comment wasn't
1972 ;; through end-of-line, et cetera.
1973 (interactive "P")
1974 (or comment-start-skip (error "No comment syntax defined"))
1975 (let ((count (prefix-numeric-value arg)) endc)
1976 (while (> count 0)
1977 (save-excursion
1978 (end-of-line)
1979 (setq endc (point))
1980 (beginning-of-line)
1981 (and (string< "" comment-end)
1982 (setq endc
1983 (progn
1984 (re-search-forward (regexp-quote comment-end) endc 'move)
1985 (skip-chars-forward " \t")
1986 (point))))
1987 (beginning-of-line)
1988 (if (re-search-forward comment-start-skip endc t)
1989 (progn
1990 (goto-char (match-beginning 0))
1991 (skip-chars-backward " \t")
1992 (kill-region (point) endc)
1993 ;; to catch comments a line beginnings
1994 (indent-according-to-mode))))
1995 (if arg (forward-line 1))
1996 (setq count (1- count)))))
1997
1998(defun comment-region (beg end &optional arg)
f28039bb
RS
1999 "Comment or uncomment each line in the region.
2000With just C-u prefix arg, uncomment each line in region.
2001Numeric prefix arg ARG means use ARG comment characters.
2076c87c
JB
2002If ARG is negative, delete that many comment characters instead.
2003Comments are terminated on each line, even for syntax in which newline does
2004not end the comment. Blank lines do not get comments."
2005 ;; if someone wants it to only put a comment-start at the beginning and
2006 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2007 ;; is easy enough. No option is made here for other than commenting
2008 ;; every line.
f28039bb 2009 (interactive "r\nP")
2076c87c
JB
2010 (or comment-start (error "No comment syntax is defined"))
2011 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
2012 (save-excursion
2013 (save-restriction
f28039bb
RS
2014 (let ((cs comment-start) (ce comment-end)
2015 numarg)
2016 (if (consp arg) (setq numarg t)
2017 (setq numarg (prefix-numeric-value arg))
2018 ;; For positive arg > 1, replicate the comment delims now,
2019 ;; then insert the replicated strings just once.
2020 (while (> numarg 1)
2021 (setq cs (concat cs comment-start)
2022 ce (concat ce comment-end))
2023 (setq numarg (1- numarg))))
2024 ;; Loop over all lines from BEG to END.
2076c87c
JB
2025 (narrow-to-region beg end)
2026 (goto-char beg)
2027 (while (not (eobp))
f28039bb
RS
2028 (if (or (eq numarg t) (< numarg 0))
2029 (progn
2030 ;; Delete comment start from beginning of line.
2031 (if (eq numarg t)
2032 (while (looking-at (regexp-quote cs))
2033 (delete-char (length cs)))
2034 (let ((count numarg))
2035 (while (and (> 1 (setq count (1+ count)))
2036 (looking-at (regexp-quote cs)))
2037 (delete-char (length cs)))))
2038 ;; Delete comment end from end of line.
2039 (if (string= "" ce)
2040 nil
2041 (if (eq numarg t)
2042 (progn
2043 (end-of-line)
2044 ;; This is questionable if comment-end ends in
2045 ;; whitespace. That is pretty brain-damaged,
2046 ;; though.
2047 (skip-chars-backward " \t")
2048 (if (and (>= (- (point) (point-min)) (length ce))
2049 (save-excursion
2050 (backward-char (length ce))
2051 (looking-at (regexp-quote ce))))
2052 (delete-char (- (length ce)))))
ee095968
RS
2053 (let ((count numarg))
2054 (while (> 1 (setq count (1+ count)))
2055 (end-of-line)
2056 ;; this is questionable if comment-end ends in whitespace
2057 ;; that is pretty brain-damaged though
2058 (skip-chars-backward " \t")
2059 (save-excursion
2060 (backward-char (length ce))
2061 (if (looking-at (regexp-quote ce))
2062 (delete-char (length ce))))))))
6e88ed49 2063 (forward-line 1))
f28039bb 2064 ;; Insert at beginning and at end.
2076c87c
JB
2065 (if (looking-at "[ \t]*$") ()
2066 (insert cs)
2067 (if (string= "" ce) ()
2068 (end-of-line)
2069 (insert ce)))
2070 (search-forward "\n" nil 'move)))))))
2071\f
2072(defun backward-word (arg)
2073 "Move backward until encountering the end of a word.
2074With argument, do this that many times.
ff1fbe3e 2075In programs, it is faster to call `forward-word' with negative arg."
9e50756b 2076 (interactive "p")
2076c87c
JB
2077 (forward-word (- arg)))
2078
2079(defun mark-word (arg)
2080 "Set mark arg words away from point."
2081 (interactive "p")
2082 (push-mark
2083 (save-excursion
2084 (forward-word arg)
fd0f4056
RS
2085 (point))
2086 nil t))
2076c87c
JB
2087
2088(defun kill-word (arg)
2089 "Kill characters forward until encountering the end of a word.
2090With argument, do this that many times."
2091 (interactive "p")
e6291fe1 2092 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
2093
2094(defun backward-kill-word (arg)
2095 "Kill characters backward until encountering the end of a word.
2096With argument, do this that many times."
2097 (interactive "p")
2098 (kill-word (- arg)))
d7c64071 2099
1e8c5ac4
RS
2100(defun current-word (&optional strict)
2101 "Return the word point is on (or a nearby word) as a string.
2102If optional arg STRICT is non-nil, return nil unless point is within
2103or adjacent to a word."
d7c64071
ER
2104 (save-excursion
2105 (let ((oldpoint (point)) (start (point)) (end (point)))
2106 (skip-syntax-backward "w_") (setq start (point))
2107 (goto-char oldpoint)
2108 (skip-syntax-forward "w_") (setq end (point))
2109 (if (and (eq start oldpoint) (eq end oldpoint))
1e8c5ac4
RS
2110 ;; Point is neither within nor adjacent to a word.
2111 (and (not strict)
2112 (progn
2113 ;; Look for preceding word in same line.
2114 (skip-syntax-backward "^w_"
2115 (save-excursion (beginning-of-line)
2116 (point)))
2117 (if (bolp)
2118 ;; No preceding word in same line.
2119 ;; Look for following word in same line.
2120 (progn
2121 (skip-syntax-forward "^w_"
2122 (save-excursion (end-of-line)
2123 (point)))
2124 (setq start (point))
2125 (skip-syntax-forward "w_")
2126 (setq end (point)))
2127 (setq end (point))
2128 (skip-syntax-backward "w_")
2129 (setq start (point)))
2130 (buffer-substring start end)))
2131 (buffer-substring start end)))))
2076c87c
JB
2132\f
2133(defconst fill-prefix nil
2134 "*String for filling to insert at front of new line, or nil for none.
2135Setting this variable automatically makes it local to the current buffer.")
2136(make-variable-buffer-local 'fill-prefix)
2137
2138(defconst auto-fill-inhibit-regexp nil
2139 "*Regexp to match lines which should not be auto-filled.")
2140
2141(defun do-auto-fill ()
2142 (let (give-up)
2143 (or (and auto-fill-inhibit-regexp
2144 (save-excursion (beginning-of-line)
2145 (looking-at auto-fill-inhibit-regexp)))
2146 (while (and (not give-up) (> (current-column) fill-column))
756811fb 2147 ;; Determine where to split the line.
2076c87c 2148 (let ((fill-point
756811fb
RS
2149 (let ((opoint (point))
2150 bounce
2151 (first t))
2076c87c
JB
2152 (save-excursion
2153 (move-to-column (1+ fill-column))
756811fb
RS
2154 ;; Move back to a word boundary.
2155 (while (or first
2156 ;; If this is after period and a single space,
2157 ;; move back once more--we don't want to break
2158 ;; the line there and make it look like a
2159 ;; sentence end.
2160 (and (not (bobp))
2161 (not bounce)
2162 sentence-end-double-space
2163 (save-excursion (forward-char -1)
2164 (and (looking-at "\\. ")
2165 (not (looking-at "\\. "))))))
2166 (setq first nil)
2167 (skip-chars-backward "^ \t\n")
2168 ;; If we find nowhere on the line to break it,
2169 ;; break after one word. Set bounce to t
2170 ;; so we will not keep going in this while loop.
2171 (if (bolp)
2172 (progn
2173 (re-search-forward "[ \t]" opoint t)
2174 (setq bounce t)))
2175 (skip-chars-backward " \t"))
2176 ;; Let fill-point be set to the place where we end up.
2076c87c 2177 (point)))))
756811fb
RS
2178 ;; If that place is not the beginning of the line,
2179 ;; break the line there.
2076c87c
JB
2180 (if (save-excursion
2181 (goto-char fill-point)
2182 (not (bolp)))
34b45e32
RS
2183 (let ((prev-column (current-column)))
2184 ;; If point is at the fill-point, do not `save-excursion'.
2185 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2186 ;; point will end up before it rather than after it.
2187 (if (save-excursion
2188 (skip-chars-backward " \t")
2189 (= (point) fill-point))
2190 (indent-new-comment-line)
2191 (save-excursion
2192 (goto-char fill-point)
2193 (indent-new-comment-line)))
2194 ;; If making the new line didn't reduce the hpos of
2195 ;; the end of the line, then give up now;
2196 ;; trying again will not help.
2197 (if (>= (current-column) prev-column)
2198 (setq give-up t)))
2076c87c
JB
2199 ;; No place to break => stop trying.
2200 (setq give-up t)))))))
2201
d7465b15
RS
2202(defun auto-fill-mode (&optional arg)
2203 "Toggle auto-fill mode.
2204With arg, turn Auto-Fill mode on if and only if arg is positive.
2205In Auto-Fill mode, inserting a space at a column beyond `fill-column'
2206automatically breaks the line at a previous space."
2207 (interactive "P")
2208 (prog1 (setq auto-fill-function
2209 (if (if (null arg)
2210 (not auto-fill-function)
2211 (> (prefix-numeric-value arg) 0))
2212 'do-auto-fill
2213 nil))
2214 ;; update mode-line
2215 (set-buffer-modified-p (buffer-modified-p))))
2216
2217;; This holds a document string used to document auto-fill-mode.
2218(defun auto-fill-function ()
2219 "Automatically break line at a previous space, in insertion of text."
2220 nil)
2221
2222(defun turn-on-auto-fill ()
2223 "Unconditionally turn on Auto Fill mode."
2224 (auto-fill-mode 1))
2225
2226(defun set-fill-column (arg)
2227 "Set `fill-column' to current column, or to argument if given.
2228The variable `fill-column' has a separate value for each buffer."
2229 (interactive "P")
2230 (setq fill-column (if (integerp arg) arg (current-column)))
2231 (message "fill-column set to %d" fill-column))
2232\f
2076c87c
JB
2233(defconst comment-multi-line nil
2234 "*Non-nil means \\[indent-new-comment-line] should continue same comment
c88ab9ce
ER
2235on new line, with no new terminator or starter.
2236This is obsolete because you might as well use \\[newline-and-indent].")
2076c87c
JB
2237
2238(defun indent-new-comment-line ()
d7465b15
RS
2239 "Break line at point and indent, continuing comment if within one.
2240This indents the body of the continued comment
2241under the previous comment line.
c88ab9ce
ER
2242
2243This command is intended for styles where you write a comment per line,
2244starting a new comment (and terminating it if necessary) on each line.
2245If you want to continue one comment across several lines, use \\[newline-and-indent]."
2076c87c
JB
2246 (interactive "*")
2247 (let (comcol comstart)
2248 (skip-chars-backward " \t")
2249 (delete-region (point)
2250 (progn (skip-chars-forward " \t")
2251 (point)))
2252 (insert ?\n)
c88ab9ce
ER
2253 (if (not comment-multi-line)
2254 (save-excursion
2255 (if (and comment-start-skip
2256 (let ((opoint (point)))
2257 (forward-line -1)
2258 (re-search-forward comment-start-skip opoint t)))
2259 ;; The old line is a comment.
2260 ;; Set WIN to the pos of the comment-start.
2261 ;; But if the comment is empty, look at preceding lines
2262 ;; to find one that has a nonempty comment.
2263 (let ((win (match-beginning 0)))
2264 (while (and (eolp) (not (bobp))
2265 (let (opoint)
2266 (beginning-of-line)
2267 (setq opoint (point))
2268 (forward-line -1)
2269 (re-search-forward comment-start-skip opoint t)))
2270 (setq win (match-beginning 0)))
2271 ;; Indent this line like what we found.
2272 (goto-char win)
2273 (setq comcol (current-column))
2274 (setq comstart (buffer-substring (point) (match-end 0)))))))
2076c87c
JB
2275 (if comcol
2276 (let ((comment-column comcol)
2277 (comment-start comstart)
2278 (comment-end comment-end))
2279 (and comment-end (not (equal comment-end ""))
c88ab9ce 2280; (if (not comment-multi-line)
2076c87c
JB
2281 (progn
2282 (forward-char -1)
2283 (insert comment-end)
2284 (forward-char 1))
c88ab9ce
ER
2285; (setq comment-column (+ comment-column (length comment-start))
2286; comment-start "")
2287; )
2288 )
2076c87c
JB
2289 (if (not (eolp))
2290 (setq comment-end ""))
2291 (insert ?\n)
2292 (forward-char -1)
2293 (indent-for-comment)
2294 (save-excursion
2295 ;; Make sure we delete the newline inserted above.
2296 (end-of-line)
2297 (delete-char 1)))
2298 (if fill-prefix
2299 (insert fill-prefix)
2300 (indent-according-to-mode)))))
2076c87c
JB
2301\f
2302(defun set-selective-display (arg)
ff1fbe3e
RS
2303 "Set `selective-display' to ARG; clear it if no arg.
2304When the value of `selective-display' is a number > 0,
2305lines whose indentation is >= that value are not displayed.
2306The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
2307 (interactive "P")
2308 (if (eq selective-display t)
2309 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
2310 (let ((current-vpos
2311 (save-restriction
2312 (narrow-to-region (point-min) (point))
2313 (goto-char (window-start))
2314 (vertical-motion (window-height)))))
2315 (setq selective-display
2316 (and arg (prefix-numeric-value arg)))
2317 (recenter current-vpos))
2076c87c
JB
2318 (set-window-start (selected-window) (window-start (selected-window)))
2319 (princ "selective-display set to " t)
2320 (prin1 selective-display t)
2321 (princ "." t))
2322
b6a22db0
JB
2323(defconst overwrite-mode-textual " Ovwrt"
2324 "The string displayed in the mode line when in overwrite mode.")
2325(defconst overwrite-mode-binary " Bin Ovwrt"
2326 "The string displayed in the mode line when in binary overwrite mode.")
2327
2076c87c
JB
2328(defun overwrite-mode (arg)
2329 "Toggle overwrite mode.
2330With arg, turn overwrite mode on iff arg is positive.
2331In overwrite mode, printing characters typed in replace existing text
b6a22db0
JB
2332on a one-for-one basis, rather than pushing it to the right. At the
2333end of a line, such characters extend the line. Before a tab,
2334such characters insert until the tab is filled in.
2335\\[quoted-insert] still inserts characters in overwrite mode; this
2336is supposed to make it easier to insert characters when necessary."
2337 (interactive "P")
2338 (setq overwrite-mode
2339 (if (if (null arg) (not overwrite-mode)
2340 (> (prefix-numeric-value arg) 0))
2341 'overwrite-mode-textual))
2342 (force-mode-line-update))
2343
2344(defun binary-overwrite-mode (arg)
2345 "Toggle binary overwrite mode.
2346With arg, turn binary overwrite mode on iff arg is positive.
2347In binary overwrite mode, printing characters typed in replace
2348existing text. Newlines are not treated specially, so typing at the
2349end of a line joins the line to the next, with the typed character
2350between them. Typing before a tab character simply replaces the tab
2351with the character typed.
2352\\[quoted-insert] replaces the text at the cursor, just as ordinary
2353typing characters do.
2354
2355Note that binary overwrite mode is not its own minor mode; it is a
2356specialization of overwrite-mode, entered by setting the
2357`overwrite-mode' variable to `overwrite-mode-binary'."
2076c87c
JB
2358 (interactive "P")
2359 (setq overwrite-mode
b6a22db0 2360 (if (if (null arg)
a61099dd 2361 (not (eq overwrite-mode 'overwrite-mode-binary))
b6a22db0
JB
2362 (> (prefix-numeric-value arg) 0))
2363 'overwrite-mode-binary))
2364 (force-mode-line-update))
2076c87c 2365\f
a61099dd
RS
2366(defvar line-number-mode nil
2367 "*Non-nil means display line number in mode line.")
2368
2369(defun line-number-mode (arg)
2370 "Toggle Line Number mode.
2371With arg, turn Line Number mode on iff arg is positive.
2372When Line Number mode is enabled, the line number appears
2373in the mode line."
2374 (interactive "P")
2375 (setq line-number-mode
2376 (if (null arg) (not line-number-mode)
2377 (> (prefix-numeric-value arg) 0)))
2378 (force-mode-line-update))
2379
2076c87c
JB
2380(defvar blink-matching-paren t
2381 "*Non-nil means show matching open-paren when close-paren is inserted.")
2382
37315725
RS
2383(defconst blink-matching-paren-distance 12000
2384 "*If non-nil, is maximum distance to search for matching open-paren.")
2076c87c
JB
2385
2386(defun blink-matching-open ()
2387 "Move cursor momentarily to the beginning of the sexp before point."
2388 (interactive)
2389 (and (> (point) (1+ (point-min)))
4e24c6b1 2390 (not (memq (char-syntax (char-after (- (point) 2))) '(?/ ?\\ )))
2076c87c
JB
2391 blink-matching-paren
2392 (let* ((oldpos (point))
2393 (blinkpos)
2394 (mismatch))
2395 (save-excursion
2396 (save-restriction
2397 (if blink-matching-paren-distance
2398 (narrow-to-region (max (point-min)
2399 (- (point) blink-matching-paren-distance))
2400 oldpos))
2401 (condition-case ()
2402 (setq blinkpos (scan-sexps oldpos -1))
2403 (error nil)))
2404 (and blinkpos (/= (char-syntax (char-after blinkpos))
2405 ?\$)
2406 (setq mismatch
2407 (/= (char-after (1- oldpos))
7492f5a6 2408 (matching-paren (char-after blinkpos)))))
2076c87c
JB
2409 (if mismatch (setq blinkpos nil))
2410 (if blinkpos
2411 (progn
2412 (goto-char blinkpos)
2413 (if (pos-visible-in-window-p)
2414 (sit-for 1)
2415 (goto-char blinkpos)
2416 (message
2417 "Matches %s"
e9f1d66d 2418 ;; Show what precedes the open in its line, if anything.
2076c87c
JB
2419 (if (save-excursion
2420 (skip-chars-backward " \t")
2421 (not (bolp)))
2422 (buffer-substring (progn (beginning-of-line) (point))
2423 (1+ blinkpos))
e9f1d66d
RS
2424 ;; Show what follows the open in its line, if anything.
2425 (if (save-excursion
2426 (forward-char 1)
2427 (skip-chars-forward " \t")
2428 (not (eolp)))
2429 (buffer-substring blinkpos
2430 (progn (end-of-line) (point)))
267935b9
RS
2431 ;; Otherwise show the previous nonblank line,
2432 ;; if there is one.
2433 (if (save-excursion
2434 (skip-chars-backward "\n \t")
2435 (not (bobp)))
2436 (concat
2437 (buffer-substring (progn
2438 (skip-chars-backward "\n \t")
2439 (beginning-of-line)
2440 (point))
2441 (progn (end-of-line)
2442 (skip-chars-backward " \t")
2443 (point)))
2444 ;; Replace the newline and other whitespace with `...'.
2445 "..."
2446 (buffer-substring blinkpos (1+ blinkpos)))
2447 ;; There is nothing to show except the char itself.
2448 (buffer-substring blinkpos (1+ blinkpos))))))))
2076c87c
JB
2449 (cond (mismatch
2450 (message "Mismatched parentheses"))
2451 ((not blink-matching-paren-distance)
2452 (message "Unmatched parenthesis"))))))))
2453
2454;Turned off because it makes dbx bomb out.
2455(setq blink-paren-function 'blink-matching-open)
2456
9a1277dd
RS
2457;; This executes C-g typed while Emacs is waiting for a command.
2458;; Quitting out of a program does not go through here;
2459;; that happens in the QUIT macro at the C code level.
2076c87c 2460(defun keyboard-quit ()
af39530e
RS
2461 "Signal a quit condition.
2462During execution of Lisp code, this character causes a quit directly.
2463At top-level, as an editor command, this simply beeps."
2076c87c 2464 (interactive)
19d35374 2465 (deactivate-mark)
2076c87c
JB
2466 (signal 'quit nil))
2467
2468(define-key global-map "\C-g" 'keyboard-quit)
2469\f
2470(defun set-variable (var val)
2471 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2472When using this interactively, supply a Lisp expression for VALUE.
3a801d0c
ER
2473If you want VALUE to be a string, you must surround it with doublequotes.
2474
2475If VARIABLE has a `variable-interactive' property, that is used as if
2476it were the arg to `interactive' (which see) to interactively read the value."
2076c87c
JB
2477 (interactive
2478 (let* ((var (read-variable "Set variable: "))
2479 (minibuffer-help-form
2480 '(funcall myhelp))
2481 (myhelp
2482 (function
2483 (lambda ()
2484 (with-output-to-temp-buffer "*Help*"
2485 (prin1 var)
2486 (princ "\nDocumentation:\n")
2487 (princ (substring (documentation-property var 'variable-documentation)
2488 1))
2489 (if (boundp var)
2490 (let ((print-length 20))
2491 (princ "\n\nCurrent value: ")
2492 (prin1 (symbol-value var))))
2493 nil)))))
2494 (list var
3a801d0c
ER
2495 (let ((prop (get var 'variable-interactive)))
2496 (if prop
2497 ;; Use VAR's `variable-interactive' property
2498 ;; as an interactive spec for prompting.
2499 (call-interactively (list 'lambda '(arg)
2500 (list 'interactive prop)
2501 'arg))
2502 (eval-minibuffer (format "Set %s to value: " var)))))))
2076c87c 2503 (set var val))
e8a700bf
RS
2504\f
2505;; Define the major mode for lists of completions.
2506
ac29eb79
RS
2507(defvar completion-list-mode-map nil)
2508(or completion-list-mode-map
e8a700bf
RS
2509 (let ((map (make-sparse-keymap)))
2510 (define-key map [mouse-2] 'mouse-choose-completion)
eaf76065 2511 (define-key map [down-mouse-2] nil)
80298193
RS
2512 (define-key map "\C-m" 'choose-completion)
2513 (define-key map [return] 'choose-completion)
ac29eb79 2514 (setq completion-list-mode-map map)))
e8a700bf
RS
2515
2516;; Completion mode is suitable only for specially formatted data.
ac29eb79 2517(put 'completion-list-mode 'mode-class 'special)
e8a700bf 2518
3819736b
RS
2519;; Record the buffer that was current when the completion list was requested.
2520(defvar completion-reference-buffer)
2521
f6b293e3
RS
2522;; This records the length of the text at the beginning of the buffer
2523;; which was not included in the completion.
2524(defvar completion-base-size nil)
2525
80298193
RS
2526(defun choose-completion ()
2527 "Choose the completion that point is in or next to."
2528 (interactive)
f6b293e3
RS
2529 (let (beg end completion (buffer completion-reference-buffer)
2530 (base-size completion-base-size))
6096f362
RS
2531 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
2532 (setq end (point) beg (1+ (point))))
2533 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
2534 (setq end (1- (point)) beg(point)))
2535 (if (null beg)
2536 (error "No completion here"))
2537 (setq beg (previous-single-property-change beg 'mouse-face))
88dd3c24 2538 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
ab63960f
RS
2539 (setq completion (buffer-substring beg end))
2540 (let ((owindow (selected-window)))
2541 (if (and (one-window-p t 'selected-frame)
2542 (window-dedicated-p (selected-window)))
2543 ;; This is a special buffer's frame
2544 (iconify-frame (selected-frame))
2545 (or (window-dedicated-p (selected-window))
2546 (bury-buffer)))
2547 (select-window owindow))
f6b293e3 2548 (choose-completion-string completion buffer base-size)))
80298193
RS
2549
2550;; Delete the longest partial match for STRING
2551;; that can be found before POINT.
2552(defun choose-completion-delete-max-match (string)
2553 (let ((opoint (point))
2554 (len (min (length string)
2555 (- (point) (point-min)))))
2556 (goto-char (- (point) (length string)))
61bbf6fe
RS
2557 (if completion-ignore-case
2558 (setq string (downcase string)))
80298193
RS
2559 (while (and (> len 0)
2560 (let ((tail (buffer-substring (point)
2561 (+ (point) len))))
61bbf6fe
RS
2562 (if completion-ignore-case
2563 (setq tail (downcase tail)))
80298193
RS
2564 (not (string= tail (substring string 0 len)))))
2565 (setq len (1- len))
2566 (forward-char 1))
2567 (delete-char len)))
2568
f6b293e3 2569(defun choose-completion-string (choice &optional buffer base-size)
80298193 2570 (let ((buffer (or buffer completion-reference-buffer)))
cf52ad58
RS
2571 ;; If BUFFER is a minibuffer, barf unless it's the currently
2572 ;; active minibuffer.
2573 (if (and (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))
2574 (or (not (minibuffer-window-active-p (minibuffer-window)))
2575 (not (equal buffer (window-buffer (minibuffer-window))))))
2576 (error "Minibuffer is not active for completion")
2577 ;; Insert the completion into the buffer where completion was requested.
2578 (set-buffer buffer)
f6b293e3
RS
2579 (if base-size
2580 (delete-region (+ base-size (point-min)) (point))
2581 (choose-completion-delete-max-match choice))
cf52ad58 2582 (insert choice)
63240af1
RS
2583 (remove-text-properties (- (point) (length choice)) (point)
2584 '(mouse-face nil))
cf52ad58
RS
2585 ;; Update point in the window that BUFFER is showing in.
2586 (let ((window (get-buffer-window buffer t)))
2587 (set-window-point window (point)))
2588 ;; If completing for the minibuffer, exit it with this choice.
2589 (and (equal buffer (window-buffer (minibuffer-window)))
8881ad9a
RS
2590 minibuffer-completion-table
2591 (exit-minibuffer)))))
80298193 2592
ac29eb79 2593(defun completion-list-mode ()
e8a700bf 2594 "Major mode for buffers showing lists of possible completions.
80298193
RS
2595Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
2596 to select the completion near point.
2597Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
2598 with the mouse."
e8a700bf
RS
2599 (interactive)
2600 (kill-all-local-variables)
ac29eb79
RS
2601 (use-local-map completion-list-mode-map)
2602 (setq mode-name "Completion List")
2603 (setq major-mode 'completion-list-mode)
f6b293e3
RS
2604 (make-local-variable 'completion-base-size)
2605 (setq completion-base-size nil)
ac29eb79 2606 (run-hooks 'completion-list-mode-hook))
e8a700bf 2607
6096f362
RS
2608(defvar completion-fixup-function nil)
2609
e8a700bf
RS
2610(defun completion-setup-function ()
2611 (save-excursion
3819736b
RS
2612 (let ((mainbuf (current-buffer)))
2613 (set-buffer standard-output)
2614 (completion-list-mode)
2615 (make-local-variable 'completion-reference-buffer)
2616 (setq completion-reference-buffer mainbuf)
2617 (goto-char (point-min))
2618 (if window-system
2619 (insert (substitute-command-keys
80298193
RS
2620 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
2621 (insert (substitute-command-keys
2622 "In this buffer, type \\[choose-completion] to \
c26bb96e
KH
2623select the completion near point.\n\n"))
2624 (forward-line 1)
6096f362
RS
2625 (while (re-search-forward "[^ \t\n]+\\( [^ \t\n]+\\)*" nil t)
2626 (let ((beg (match-beginning 0))
2627 (end (point)))
2628 (if completion-fixup-function
2629 (funcall completion-fixup-function))
2630 (put-text-property beg (point) 'mouse-face 'highlight)
2631 (goto-char end))))))
c88ab9ce 2632
e8a700bf 2633(add-hook 'completion-setup-hook 'completion-setup-function)
a3d1480b
JB
2634\f
2635;;;; Keypad support.
2636
2637;;; Make the keypad keys act like ordinary typing keys. If people add
2638;;; bindings for the function key symbols, then those bindings will
2639;;; override these, so this shouldn't interfere with any existing
2640;;; bindings.
2641
0d173134 2642;; Also tell read-char how to handle these keys.
a3d1480b
JB
2643(mapcar
2644 (lambda (keypad-normal)
2645 (let ((keypad (nth 0 keypad-normal))
2646 (normal (nth 1 keypad-normal)))
0d173134 2647 (put keypad 'ascii-character normal)
a3d1480b
JB
2648 (define-key function-key-map (vector keypad) (vector normal))))
2649 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
2650 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
2651 (kp-space ?\ )
2652 (kp-tab ?\t)
2653 (kp-enter ?\r)
2654 (kp-multiply ?*)
2655 (kp-add ?+)
2656 (kp-separator ?,)
2657 (kp-subtract ?-)
2658 (kp-decimal ?.)
2659 (kp-divide ?/)
2660 (kp-equal ?=)))
2661
c88ab9ce 2662;;; simple.el ends here