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