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