* mh-init.el (mh-image-load-path-called-flag): New variable which
[bpt/emacs.git] / lisp / simple.el
CommitLineData
c88ab9ce
ER
1;;; simple.el --- basic editing commands for Emacs
2
c6db81aa 3;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
0d30b337 4;; 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
2076c87c 5
30764597
PJ
6;; Maintainer: FSF
7;; Keywords: internal
8
2076c87c
JB
9;; This file is part of GNU Emacs.
10
11;; GNU Emacs is free software; you can redistribute it and/or modify
12;; it under the terms of the GNU General Public License as published by
3a801d0c 13;; the Free Software Foundation; either version 2, or (at your option)
2076c87c
JB
14;; any later version.
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
b578f267 22;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15
LK
23;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24;; Boston, MA 02110-1301, USA.
2076c87c 25
d9ecc911
ER
26;;; Commentary:
27
28;; A grab-bag of basic Emacs commands not specifically related to some
29;; major mode or to file-handling.
30
3a801d0c 31;;; Code:
2076c87c 32
d01a33cf 33(eval-when-compile
a339f909 34 (autoload 'widget-convert "wid-edit")
cc76a58c 35 (autoload 'shell-mode "shell"))
d01a33cf 36
ca60ee11
JB
37(defvar compilation-current-error)
38
7fcce20f
RS
39(defcustom idle-update-delay 0.5
40 "*Idle time delay before updating various things on the screen.
41Various Emacs features that update auxiliary information when point moves
42wait this many seconds after Emacs becomes idle before doing an update."
43 :type 'number
44 :group 'display
45 :version "22.1")
d01a33cf 46
69c1dd37 47(defgroup killing nil
c9f0110e 48 "Killing and yanking commands."
69c1dd37
RS
49 :group 'editing)
50
69c1dd37
RS
51(defgroup paren-matching nil
52 "Highlight (un)matching of parens and expressions."
69c1dd37
RS
53 :group 'matching)
54
f54b0d85
RS
55(defun next-buffer ()
56 "Switch to the next buffer in cyclic order."
57 (interactive)
58 (let ((buffer (current-buffer)))
59 (switch-to-buffer (other-buffer buffer))
60 (bury-buffer buffer)))
61
62(defun prev-buffer ()
63 "Switch to the previous buffer in cyclic order."
64 (interactive)
65 (let ((list (nreverse (buffer-list)))
66 found)
67 (while (and (not found) list)
68 (let ((buffer (car list)))
69 (if (and (not (get-buffer-window buffer))
70 (not (string-match "\\` " (buffer-name buffer))))
71 (setq found buffer)))
72 (setq list (cdr list)))
73 (switch-to-buffer found)))
ee9c5954 74\f
50f007fb 75;;; next-error support framework
bbf41690
RS
76
77(defgroup next-error nil
f33321ad 78 "`next-error' support framework."
bbf41690 79 :group 'compilation
bf247b6e 80 :version "22.1")
bbf41690
RS
81
82(defface next-error
83 '((t (:inherit region)))
84 "Face used to highlight next error locus."
85 :group 'next-error
bf247b6e 86 :version "22.1")
bbf41690
RS
87
88(defcustom next-error-highlight 0.1
89 "*Highlighting of locations in selected source buffers.
f33321ad
JB
90If number, highlight the locus in `next-error' face for given time in seconds.
91If t, use persistent overlays fontified in `next-error' face.
bbf41690
RS
92If nil, don't highlight the locus in the source buffer.
93If `fringe-arrow', indicate the locus by the fringe arrow."
94 :type '(choice (number :tag "Delay")
95 (const :tag "Persistent overlay" t)
96 (const :tag "No highlighting" nil)
97 (const :tag "Fringe arrow" 'fringe-arrow))
98 :group 'next-error
bf247b6e 99 :version "22.1")
bbf41690
RS
100
101(defcustom next-error-highlight-no-select 0.1
102 "*Highlighting of locations in non-selected source buffers.
f33321ad
JB
103If number, highlight the locus in `next-error' face for given time in seconds.
104If t, use persistent overlays fontified in `next-error' face.
bbf41690
RS
105If nil, don't highlight the locus in the source buffer.
106If `fringe-arrow', indicate the locus by the fringe arrow."
107 :type '(choice (number :tag "Delay")
108 (const :tag "Persistent overlay" t)
109 (const :tag "No highlighting" nil)
110 (const :tag "Fringe arrow" 'fringe-arrow))
111 :group 'next-error
bf247b6e 112 :version "22.1")
bbf41690 113
d634a3a2
JL
114(defcustom next-error-hook nil
115 "*List of hook functions run by `next-error' after visiting source file."
116 :type 'hook
117 :group 'next-error)
118
814c3037
JL
119(defvar next-error-highlight-timer nil)
120
9c9b00d6 121(defvar next-error-overlay-arrow-position nil)
c29d24ea 122(put 'next-error-overlay-arrow-position 'overlay-arrow-string "=>")
9c9b00d6
JL
123(add-to-list 'overlay-arrow-variable-list 'next-error-overlay-arrow-position)
124
50f007fb 125(defvar next-error-last-buffer nil
f33321ad 126 "The most recent `next-error' buffer.
50f007fb
KS
127A buffer becomes most recent when its compilation, grep, or
128similar mode is started, or when it is used with \\[next-error]
129or \\[compile-goto-error].")
130
131(defvar next-error-function nil
e462ab77
SM
132 "Function to use to find the next error in the current buffer.
133The function is called with 2 parameters:
134ARG is an integer specifying by how many errors to move.
135RESET is a boolean which, if non-nil, says to go back to the beginning
136of the errors before moving.
137Major modes providing compile-like functionality should set this variable
138to indicate to `next-error' that this is a candidate buffer and how
139to navigate in it.")
50f007fb
KS
140
141(make-variable-buffer-local 'next-error-function)
142
f1e2a033 143(defsubst next-error-buffer-p (buffer
e967cd11 144 &optional avoid-current
f1e2a033 145 extra-test-inclusive
5f9e0ca5 146 extra-test-exclusive)
f33321ad 147 "Test if BUFFER is a `next-error' capable buffer.
e967cd11
RS
148
149If AVOID-CURRENT is non-nil, treat the current buffer
150as an absolute last resort only.
151
152The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
153that normally would not qualify. If it returns t, the buffer
154in question is treated as usable.
155
156The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
01ba9662 157that would normally be considered usable. If it returns nil,
e967cd11
RS
158that buffer is rejected."
159 (and (buffer-name buffer) ;First make sure it's live.
160 (not (and avoid-current (eq buffer (current-buffer))))
161 (with-current-buffer buffer
162 (if next-error-function ; This is the normal test.
163 ;; Optionally reject some buffers.
164 (if extra-test-exclusive
165 (funcall extra-test-exclusive)
166 t)
167 ;; Optionally accept some other buffers.
168 (and extra-test-inclusive
169 (funcall extra-test-inclusive))))))
170
171(defun next-error-find-buffer (&optional avoid-current
f1e2a033 172 extra-test-inclusive
5f9e0ca5 173 extra-test-exclusive)
f33321ad 174 "Return a `next-error' capable buffer.
e967cd11
RS
175If AVOID-CURRENT is non-nil, treat the current buffer
176as an absolute last resort only.
177
01ba9662 178The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
e967cd11
RS
179that normally would not qualify. If it returns t, the buffer
180in question is treated as usable.
181
182The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
183that would normally be considered usable. If it returns nil,
184that buffer is rejected."
03e75c7e
JL
185 (or
186 ;; 1. If one window on the selected frame displays such buffer, return it.
187 (let ((window-buffers
188 (delete-dups
189 (delq nil (mapcar (lambda (w)
190 (if (next-error-buffer-p
e967cd11
RS
191 (window-buffer w)
192 avoid-current
f1e2a033 193 extra-test-inclusive extra-test-exclusive)
03e75c7e
JL
194 (window-buffer w)))
195 (window-list))))))
03e75c7e
JL
196 (if (eq (length window-buffers) 1)
197 (car window-buffers)))
e967cd11 198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
03e75c7e 199 (if (and next-error-last-buffer
e967cd11 200 (next-error-buffer-p next-error-last-buffer avoid-current
f1e2a033 201 extra-test-inclusive extra-test-exclusive))
e967cd11
RS
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
204 (if (next-error-buffer-p (current-buffer) avoid-current
205 extra-test-inclusive extra-test-exclusive)
03e75c7e 206 (current-buffer))
e967cd11 207 ;; 4. Look for any acceptable buffer.
03e75c7e
JL
208 (let ((buffers (buffer-list)))
209 (while (and buffers
e967cd11
RS
210 (not (next-error-buffer-p
211 (car buffers) avoid-current
212 extra-test-inclusive extra-test-exclusive)))
03e75c7e 213 (setq buffers (cdr buffers)))
e967cd11
RS
214 (car buffers))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
217 (and avoid-current
218 (next-error-buffer-p (current-buffer) nil
219 extra-test-inclusive extra-test-exclusive)
220 (progn
221 (message "This is the only next-error capable buffer")
222 (current-buffer)))
223 ;; 6. Give up.
224 (error "No next-error capable buffer found")))
50f007fb 225
310abb0b 226(defun next-error (&optional arg reset)
f33321ad 227 "Visit next `next-error' message and corresponding source code.
50f007fb
KS
228
229If all the error messages parsed so far have been processed already,
230the message buffer is checked for new ones.
231
e462ab77 232A prefix ARG specifies how many error messages to move;
50f007fb
KS
233negative means move back to previous error messages.
234Just \\[universal-argument] as a prefix means reparse the error message buffer
235and start at the first error.
236
e249a6d8 237The RESET argument specifies that we should restart from the beginning.
50f007fb
KS
238
239\\[next-error] normally uses the most recently started
240compilation, grep, or occur buffer. It can also operate on any
241buffer with output from the \\[compile], \\[grep] commands, or,
242more generally, on any buffer in Compilation mode or with
243Compilation Minor mode enabled, or any buffer in which
03e75c7e
JL
244`next-error-function' is bound to an appropriate function.
245To specify use of a particular buffer for error messages, type
246\\[next-error] in that buffer when it is the only one displayed
247in the current frame.
50f007fb 248
d634a3a2
JL
249Once \\[next-error] has chosen the buffer for error messages, it
250runs `next-error-hook' with `run-hooks', and stays with that buffer
251until you use it in some other buffer which uses Compilation mode
252or Compilation Minor mode.
50f007fb
KS
253
254See variables `compilation-parse-errors-function' and
255\`compilation-error-regexp-alist' for customization ideas."
256 (interactive "P")
e462ab77 257 (if (consp arg) (setq reset t arg nil))
50f007fb
KS
258 (when (setq next-error-last-buffer (next-error-find-buffer))
259 ;; we know here that next-error-function is a valid symbol we can funcall
260 (with-current-buffer next-error-last-buffer
d634a3a2
JL
261 (funcall next-error-function (prefix-numeric-value arg) reset)
262 (run-hooks 'next-error-hook))))
50f007fb 263
56ab610b
RS
264(defun next-error-internal ()
265 "Visit the source code corresponding to the `next-error' message at point."
266 (setq next-error-last-buffer (current-buffer))
267 ;; we know here that next-error-function is a valid symbol we can funcall
268 (with-current-buffer next-error-last-buffer
269 (funcall next-error-function 0 nil)
270 (run-hooks 'next-error-hook)))
271
50f007fb
KS
272(defalias 'goto-next-locus 'next-error)
273(defalias 'next-match 'next-error)
274
310abb0b 275(defun previous-error (&optional n)
f33321ad 276 "Visit previous `next-error' message and corresponding source code.
50f007fb
KS
277
278Prefix arg N says how many error messages to move backwards (or
279forwards, if negative).
280
281This operates on the output from the \\[compile] and \\[grep] commands."
282 (interactive "p")
310abb0b 283 (next-error (- (or n 1))))
50f007fb 284
310abb0b 285(defun first-error (&optional n)
50f007fb
KS
286 "Restart at the first error.
287Visit corresponding source code.
288With prefix arg N, visit the source code of the Nth error.
289This operates on the output from the \\[compile] command, for instance."
290 (interactive "p")
291 (next-error n t))
292
310abb0b 293(defun next-error-no-select (&optional n)
f33321ad 294 "Move point to the next error in the `next-error' buffer and highlight match.
50f007fb
KS
295Prefix arg N says how many error messages to move forwards (or
296backwards, if negative).
297Finds and highlights the source line like \\[next-error], but does not
298select the source buffer."
299 (interactive "p")
ee9c5954
JL
300 (let ((next-error-highlight next-error-highlight-no-select))
301 (next-error n))
50f007fb
KS
302 (pop-to-buffer next-error-last-buffer))
303
310abb0b 304(defun previous-error-no-select (&optional n)
f33321ad 305 "Move point to the previous error in the `next-error' buffer and highlight match.
50f007fb
KS
306Prefix arg N says how many error messages to move backwards (or
307forwards, if negative).
308Finds and highlights the source line like \\[previous-error], but does not
309select the source buffer."
310 (interactive "p")
310abb0b 311 (next-error-no-select (- (or n 1))))
50f007fb 312
282d6eae
EZ
313;;; Internal variable for `next-error-follow-mode-post-command-hook'.
314(defvar next-error-follow-last-line nil)
315
2a223f35 316(define-minor-mode next-error-follow-minor-mode
282d6eae 317 "Minor mode for compilation, occur and diff modes.
2a223f35
EZ
318When turned on, cursor motion in the compilation, grep, occur or diff
319buffer causes automatic display of the corresponding source code
320location."
ed8e0f0a 321 :group 'next-error :init-value nil :lighter " Fol"
8a98a6c2 322 (if (not next-error-follow-minor-mode)
282d6eae
EZ
323 (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t)
324 (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t)
e56dd5c6 325 (make-local-variable 'next-error-follow-last-line)))
282d6eae
EZ
326
327;;; Used as a `post-command-hook' by `next-error-follow-mode'
328;;; for the *Compilation* *grep* and *Occur* buffers.
329(defun next-error-follow-mode-post-command-hook ()
330 (unless (equal next-error-follow-last-line (line-number-at-pos))
331 (setq next-error-follow-last-line (line-number-at-pos))
332 (condition-case nil
333 (let ((compilation-context-lines nil))
334 (setq compilation-current-error (point))
335 (next-error-no-select 0))
336 (error t))))
337
ee9c5954 338\f
50f007fb
KS
339;;;
340
93be67de
KH
341(defun fundamental-mode ()
342 "Major mode not specialized for anything in particular.
343Other major modes are defined by comparison with this one."
344 (interactive)
e174f8db 345 (kill-all-local-variables)
52167727
LK
346 (unless delay-mode-hooks
347 (run-hooks 'after-change-major-mode-hook)))
eaae8106 348
93be67de
KH
349;; Making and deleting lines.
350
30bb9754 351(defun newline (&optional arg)
d133d835 352 "Insert a newline, and move to left margin of the new line if it's blank.
058d4999
DL
353If `use-hard-newlines' is non-nil, the newline is marked with the
354text-property `hard'.
76c64e24 355With ARG, insert that many newlines.
058d4999 356Call `auto-fill-function' if the current column number is greater
6688f85f 357than the value of `fill-column' and ARG is nil."
30bb9754 358 (interactive "*P")
4c4cbf11 359 (barf-if-buffer-read-only)
30bb9754
BG
360 ;; Inserting a newline at the end of a line produces better redisplay in
361 ;; try_window_id than inserting at the beginning of a line, and the textual
362 ;; result is the same. So, if we're at beginning of line, pretend to be at
363 ;; the end of the previous line.
1e722f9f 364 (let ((flag (and (not (bobp))
30bb9754 365 (bolp)
1cd24721
RS
366 ;; Make sure no functions want to be told about
367 ;; the range of the changes.
1cd24721
RS
368 (not after-change-functions)
369 (not before-change-functions)
fd977703
RS
370 ;; Make sure there are no markers here.
371 (not (buffer-has-markers-at (1- (point))))
2f047f6c 372 (not (buffer-has-markers-at (point)))
1cd24721
RS
373 ;; Make sure no text properties want to know
374 ;; where the change was.
375 (not (get-char-property (1- (point)) 'modification-hooks))
376 (not (get-char-property (1- (point)) 'insert-behind-hooks))
377 (or (eobp)
378 (not (get-char-property (point) 'insert-in-front-hooks)))
31a5333f
MB
379 ;; Make sure the newline before point isn't intangible.
380 (not (get-char-property (1- (point)) 'intangible))
381 ;; Make sure the newline before point isn't read-only.
382 (not (get-char-property (1- (point)) 'read-only))
383 ;; Make sure the newline before point isn't invisible.
384 (not (get-char-property (1- (point)) 'invisible))
385 ;; Make sure the newline before point has the same
386 ;; properties as the char before it (if any).
1e722f9f 387 (< (or (previous-property-change (point)) -2)
d133d835
RS
388 (- (point) 2))))
389 (was-page-start (and (bolp)
390 (looking-at page-delimiter)))
391 (beforepos (point)))
30bb9754
BG
392 (if flag (backward-char 1))
393 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
394 ;; Set last-command-char to tell self-insert what to insert.
395 (let ((last-command-char ?\n)
396 ;; Don't auto-fill if we have a numeric argument.
3954fff9
RS
397 ;; Also not if flag is true (it would fill wrong line);
398 ;; there is no need to since we're at BOL.
399 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
4cc9d0dc
RS
400 (unwind-protect
401 (self-insert-command (prefix-numeric-value arg))
402 ;; If we get an error in self-insert-command, put point at right place.
403 (if flag (forward-char 1))))
2f047f6c
KH
404 ;; Even if we did *not* get an error, keep that forward-char;
405 ;; all further processing should apply to the newline that the user
406 ;; thinks he inserted.
407
30bb9754
BG
408 ;; Mark the newline(s) `hard'.
409 (if use-hard-newlines
2f047f6c 410 (set-hard-newline-properties
55741b46 411 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
d133d835
RS
412 ;; If the newline leaves the previous line blank,
413 ;; and we have a left margin, delete that from the blank line.
414 (or flag
415 (save-excursion
416 (goto-char beforepos)
417 (beginning-of-line)
418 (and (looking-at "[ \t]$")
419 (> (current-left-margin) 0)
420 (delete-region (point) (progn (end-of-line) (point))))))
d133d835
RS
421 ;; Indent the line after the newline, except in one case:
422 ;; when we added the newline at the beginning of a line
423 ;; which starts a page.
424 (or was-page-start
425 (move-to-left-margin nil t)))
30bb9754
BG
426 nil)
427
55741b46
RS
428(defun set-hard-newline-properties (from to)
429 (let ((sticky (get-text-property from 'rear-nonsticky)))
430 (put-text-property from to 'hard 't)
431 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
432 (if (and (listp sticky) (not (memq 'hard sticky)))
433 (put-text-property from (point) 'rear-nonsticky
434 (cons 'hard sticky)))))
eaae8106 435
e249a6d8 436(defun open-line (n)
ff1fbe3e 437 "Insert a newline and leave point before it.
f33321ad
JB
438If there is a fill prefix and/or a `left-margin', insert them
439on the new line if the line would have been blank.
616ed245 440With arg N, insert N newlines."
2076c87c 441 (interactive "*p")
616ed245 442 (let* ((do-fill-prefix (and fill-prefix (bolp)))
3db1e3b5 443 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
207d7545
GM
444 (loc (point))
445 ;; Don't expand an abbrev before point.
446 (abbrev-mode nil))
e249a6d8 447 (newline n)
d133d835 448 (goto-char loc)
e249a6d8 449 (while (> n 0)
d133d835
RS
450 (cond ((bolp)
451 (if do-left-margin (indent-to (current-left-margin)))
452 (if do-fill-prefix (insert-and-inherit fill-prefix))))
453 (forward-line 1)
e249a6d8 454 (setq n (1- n)))
d133d835
RS
455 (goto-char loc)
456 (end-of-line)))
2076c87c 457
da7d231b
KS
458(defun split-line (&optional arg)
459 "Split current line, moving portion beyond point vertically down.
460If the current line starts with `fill-prefix', insert it on the new
f33321ad 461line as well. With prefix ARG, don't insert `fill-prefix' on new line.
da7d231b 462
e249a6d8 463When called from Lisp code, ARG may be a prefix string to copy."
da7d231b 464 (interactive "*P")
2076c87c 465 (skip-chars-forward " \t")
d77bbdc9
RS
466 (let* ((col (current-column))
467 (pos (point))
468 ;; What prefix should we check for (nil means don't).
469 (prefix (cond ((stringp arg) arg)
470 (arg nil)
471 (t fill-prefix)))
472 ;; Does this line start with it?
473 (have-prfx (and prefix
474 (save-excursion
475 (beginning-of-line)
476 (looking-at (regexp-quote prefix))))))
28191e20 477 (newline 1)
d77bbdc9 478 (if have-prfx (insert-and-inherit prefix))
2076c87c
JB
479 (indent-to col 0)
480 (goto-char pos)))
481
2076c87c
JB
482(defun delete-indentation (&optional arg)
483 "Join this line to previous and fix up whitespace at join.
ccc58657 484If there is a fill prefix, delete it from the beginning of this line.
2076c87c
JB
485With argument, join this line to following line."
486 (interactive "*P")
487 (beginning-of-line)
488 (if arg (forward-line 1))
489 (if (eq (preceding-char) ?\n)
490 (progn
491 (delete-region (point) (1- (point)))
ccc58657
RS
492 ;; If the second line started with the fill prefix,
493 ;; delete the prefix.
494 (if (and fill-prefix
01b8e020 495 (<= (+ (point) (length fill-prefix)) (point-max))
ccc58657
RS
496 (string= fill-prefix
497 (buffer-substring (point)
498 (+ (point) (length fill-prefix)))))
499 (delete-region (point) (+ (point) (length fill-prefix))))
2076c87c
JB
500 (fixup-whitespace))))
501
fc025090 502(defalias 'join-line #'delete-indentation) ; easier to find
eaae8106 503
2076c87c
JB
504(defun delete-blank-lines ()
505 "On blank line, delete all surrounding blank lines, leaving just one.
506On isolated blank line, delete that one.
6d30d416 507On nonblank line, delete any immediately following blank lines."
2076c87c
JB
508 (interactive "*")
509 (let (thisblank singleblank)
510 (save-excursion
511 (beginning-of-line)
512 (setq thisblank (looking-at "[ \t]*$"))
70e14c01 513 ;; Set singleblank if there is just one blank line here.
2076c87c
JB
514 (setq singleblank
515 (and thisblank
516 (not (looking-at "[ \t]*\n[ \t]*$"))
517 (or (bobp)
518 (progn (forward-line -1)
519 (not (looking-at "[ \t]*$")))))))
70e14c01 520 ;; Delete preceding blank lines, and this one too if it's the only one.
2076c87c
JB
521 (if thisblank
522 (progn
523 (beginning-of-line)
524 (if singleblank (forward-line 1))
525 (delete-region (point)
526 (if (re-search-backward "[^ \t\n]" nil t)
527 (progn (forward-line 1) (point))
528 (point-min)))))
70e14c01
JB
529 ;; Delete following blank lines, unless the current line is blank
530 ;; and there are no following blank lines.
2076c87c
JB
531 (if (not (and thisblank singleblank))
532 (save-excursion
533 (end-of-line)
534 (forward-line 1)
535 (delete-region (point)
536 (if (re-search-forward "[^ \t\n]" nil t)
537 (progn (beginning-of-line) (point))
70e14c01
JB
538 (point-max)))))
539 ;; Handle the special case where point is followed by newline and eob.
540 ;; Delete the line, leaving point at eob.
541 (if (looking-at "^[ \t]*\n\\'")
542 (delete-region (point) (point-max)))))
2076c87c 543
eaae8106
SS
544(defun delete-trailing-whitespace ()
545 "Delete all the trailing whitespace across the current buffer.
546All whitespace after the last non-whitespace character in a line is deleted.
103db06c
RS
547This respects narrowing, created by \\[narrow-to-region] and friends.
548A formfeed is not considered whitespace by this function."
eaae8106
SS
549 (interactive "*")
550 (save-match-data
551 (save-excursion
552 (goto-char (point-min))
5c9b3fac
MB
553 (while (re-search-forward "\\s-$" nil t)
554 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
3a768251 555 ;; Don't delete formfeeds, even if they are considered whitespace.
661aa5c7
GM
556 (save-match-data
557 (if (looking-at ".*\f")
558 (goto-char (match-end 0))))
7981d89f 559 (delete-region (point) (match-end 0))))))
eaae8106 560
2076c87c
JB
561(defun newline-and-indent ()
562 "Insert a newline, then indent according to major mode.
ff1fbe3e 563Indentation is done using the value of `indent-line-function'.
2076c87c 564In programming language modes, this is the same as TAB.
ff1fbe3e 565In some text modes, where TAB inserts a tab, this command indents to the
eed5698b 566column specified by the function `current-left-margin'."
2076c87c 567 (interactive "*")
5ff4ba3d 568 (delete-horizontal-space t)
46947372 569 (newline)
2076c87c
JB
570 (indent-according-to-mode))
571
572(defun reindent-then-newline-and-indent ()
573 "Reindent current line, insert newline, then indent the new line.
574Indentation of both lines is done according to the current major mode,
ff1fbe3e 575which means calling the current value of `indent-line-function'.
2076c87c
JB
576In programming language modes, this is the same as TAB.
577In some text modes, where TAB inserts a tab, this indents to the
eed5698b 578column specified by the function `current-left-margin'."
2076c87c 579 (interactive "*")
e1e04350
SM
580 (let ((pos (point)))
581 ;; Be careful to insert the newline before indenting the line.
582 ;; Otherwise, the indentation might be wrong.
583 (newline)
584 (save-excursion
585 (goto-char pos)
fd2c4cd8
SM
586 (indent-according-to-mode)
587 (delete-horizontal-space t))
e1e04350 588 (indent-according-to-mode)))
eaae8106 589
93be67de
KH
590(defun quoted-insert (arg)
591 "Read next input character and insert it.
592This is useful for inserting control characters.
2076c87c 593
93be67de
KH
594If the first character you type after this command is an octal digit,
595you should type a sequence of octal digits which specify a character code.
596Any nondigit terminates the sequence. If the terminator is a RET,
597it is discarded; any other terminator is used itself as input.
598The variable `read-quoted-char-radix' specifies the radix for this feature;
599set it to 10 or 16 to use decimal or hex instead of octal.
dff7d67f 600
93be67de
KH
601In overwrite mode, this function inserts the character anyway, and
602does not handle octal digits specially. This means that if you use
603overwrite as your normal editing mode, you can use this function to
604insert characters when necessary.
dff7d67f 605
93be67de
KH
606In binary overwrite mode, this function does overwrite, and octal
607digits are interpreted as a character code. This is intended to be
608useful for editing binary files."
609 (interactive "*p")
c2f51635 610 (let* ((char (let (translation-table-for-input)
940fe486
DL
611 (if (or (not overwrite-mode)
612 (eq overwrite-mode 'overwrite-mode-binary))
613 (read-quoted-char)
614 (read-char)))))
93be67de
KH
615 ;; Assume character codes 0240 - 0377 stand for characters in some
616 ;; single-byte character set, and convert them to Emacs
617 ;; characters.
618 (if (and enable-multibyte-characters
619 (>= char ?\240)
620 (<= char ?\377))
621 (setq char (unibyte-char-to-multibyte char)))
622 (if (> arg 0)
623 (if (eq overwrite-mode 'overwrite-mode-binary)
624 (delete-char arg)))
625 (while (> arg 0)
626 (insert-and-inherit char)
627 (setq arg (1- arg)))))
eaae8106 628
b82d844f 629(defun forward-to-indentation (&optional arg)
93be67de
KH
630 "Move forward ARG lines and position at first nonblank character."
631 (interactive "p")
b82d844f 632 (forward-line (or arg 1))
93be67de 633 (skip-chars-forward " \t"))
cc2b2b6c 634
b82d844f 635(defun backward-to-indentation (&optional arg)
93be67de
KH
636 "Move backward ARG lines and position at first nonblank character."
637 (interactive "p")
b82d844f 638 (forward-line (- (or arg 1)))
93be67de 639 (skip-chars-forward " \t"))
2076c87c 640
93be67de
KH
641(defun back-to-indentation ()
642 "Move point to the first non-whitespace character on this line."
643 (interactive)
644 (beginning-of-line 1)
1e96c007 645 (skip-syntax-forward " " (line-end-position))
b9863466
RS
646 ;; Move back over chars that have whitespace syntax but have the p flag.
647 (backward-prefix-chars))
93be67de
KH
648
649(defun fixup-whitespace ()
650 "Fixup white space between objects around point.
651Leave one space or none, according to the context."
652 (interactive "*")
653 (save-excursion
654 (delete-horizontal-space)
655 (if (or (looking-at "^\\|\\s)")
656 (save-excursion (forward-char -1)
657 (looking-at "$\\|\\s(\\|\\s'")))
658 nil
f33321ad 659 (insert ?\s))))
93be67de 660
5ff4ba3d
MB
661(defun delete-horizontal-space (&optional backward-only)
662 "Delete all spaces and tabs around point.
663If BACKWARD-ONLY is non-nil, only delete spaces before point."
93be67de 664 (interactive "*")
9ab59a1a
MB
665 (let ((orig-pos (point)))
666 (delete-region
667 (if backward-only
668 orig-pos
669 (progn
670 (skip-chars-forward " \t")
671 (constrain-to-field nil orig-pos t)))
5ff4ba3d 672 (progn
9ab59a1a
MB
673 (skip-chars-backward " \t")
674 (constrain-to-field nil orig-pos)))))
93be67de 675
68c16b59 676(defun just-one-space (&optional n)
56abefac
RS
677 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
678 (interactive "*p")
9ab59a1a
MB
679 (let ((orig-pos (point)))
680 (skip-chars-backward " \t")
681 (constrain-to-field nil orig-pos)
68c16b59 682 (dotimes (i (or n 1))
f33321ad 683 (if (= (following-char) ?\s)
56abefac 684 (forward-char 1)
f33321ad 685 (insert ?\s)))
9ab59a1a
MB
686 (delete-region
687 (point)
688 (progn
689 (skip-chars-forward " \t")
690 (constrain-to-field nil orig-pos t)))))
2d88b556 691\f
2076c87c
JB
692(defun beginning-of-buffer (&optional arg)
693 "Move point to the beginning of the buffer; leave mark at previous position.
a416e7ef
KS
694With \\[universal-argument] prefix, do not set mark at previous position.
695With numeric arg N, put point N/10 of the way from the beginning.
c66587fe
RS
696
697If the buffer is narrowed, this command uses the beginning and size
698of the accessible part of the buffer.
ff1fbe3e
RS
699
700Don't use this command in Lisp programs!
2076c87c
JB
701\(goto-char (point-min)) is faster and avoids clobbering the mark."
702 (interactive "P")
24199fe7 703 (or (consp arg)
705a5933
JL
704 (and transient-mark-mode mark-active)
705 (push-mark))
c66587fe 706 (let ((size (- (point-max) (point-min))))
a416e7ef 707 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
708 (+ (point-min)
709 (if (> size 10000)
710 ;; Avoid overflow for large buffer sizes!
711 (* (prefix-numeric-value arg)
712 (/ size 10))
713 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
714 (point-min))))
2076c87c
JB
715 (if arg (forward-line 1)))
716
717(defun end-of-buffer (&optional arg)
718 "Move point to the end of the buffer; leave mark at previous position.
a416e7ef
KS
719With \\[universal-argument] prefix, do not set mark at previous position.
720With numeric arg N, put point N/10 of the way from the end.
c66587fe
RS
721
722If the buffer is narrowed, this command uses the beginning and size
723of the accessible part of the buffer.
ff1fbe3e
RS
724
725Don't use this command in Lisp programs!
2076c87c
JB
726\(goto-char (point-max)) is faster and avoids clobbering the mark."
727 (interactive "P")
24199fe7 728 (or (consp arg)
705a5933
JL
729 (and transient-mark-mode mark-active)
730 (push-mark))
c66587fe 731 (let ((size (- (point-max) (point-min))))
a416e7ef 732 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
733 (- (point-max)
734 (if (> size 10000)
735 ;; Avoid overflow for large buffer sizes!
736 (* (prefix-numeric-value arg)
737 (/ size 10))
738 (/ (* size (prefix-numeric-value arg)) 10)))
739 (point-max))))
3a801d0c
ER
740 ;; If we went to a place in the middle of the buffer,
741 ;; adjust it to the beginning of a line.
314808dc 742 (cond (arg (forward-line 1))
919f2812 743 ((> (point) (window-end nil t))
314808dc
GM
744 ;; If the end of the buffer is not already on the screen,
745 ;; then scroll specially to put it near, but not at, the bottom.
746 (overlay-recenter (point))
747 (recenter -3))))
2076c87c
JB
748
749(defun mark-whole-buffer ()
70e14c01
JB
750 "Put point at beginning and mark at end of buffer.
751You probably should not use this function in Lisp programs;
752it is usually a mistake for a Lisp function to use any subroutine
753that uses or sets the mark."
2076c87c
JB
754 (interactive)
755 (push-mark (point))
fd0f4056 756 (push-mark (point-max) nil t)
2076c87c 757 (goto-char (point-min)))
2d88b556 758\f
eaae8106 759
93be67de
KH
760;; Counting lines, one way or another.
761
00a369ac
RS
762(defun goto-line (arg &optional buffer)
763 "Goto line ARG, counting from line 1 at beginning of buffer.
09ad1a5b
EZ
764Normally, move point in the current buffer.
765With just \\[universal-argument] as argument, move point in the most recently
766displayed other buffer, and switch to it. When called from Lisp code,
767the optional argument BUFFER specifies a buffer to switch to.
00a369ac
RS
768
769If there's a number in the buffer at point, it is the default for ARG."
770 (interactive
771 (if (and current-prefix-arg (not (consp current-prefix-arg)))
772 (list (prefix-numeric-value current-prefix-arg))
773 ;; Look for a default, a number in the buffer at point.
774 (let* ((default
775 (save-excursion
776 (skip-chars-backward "0-9")
777 (if (looking-at "[0-9]")
778 (buffer-substring-no-properties
779 (point)
780 (progn (skip-chars-forward "0-9")
781 (point))))))
782 ;; Decide if we're switching buffers.
783 (buffer
784 (if (consp current-prefix-arg)
785 (other-buffer (current-buffer) t)))
786 (buffer-prompt
787 (if buffer
788 (concat " in " (buffer-name buffer))
789 "")))
790 ;; Read the argument, offering that number (if any) as default.
791 (list (read-from-minibuffer (format (if default "Goto line%s (%s): "
792 "Goto line%s: ")
793 buffer-prompt
794 default)
795 nil nil t
796 'minibuffer-history
797 default)
798 buffer))))
799 ;; Switch to the desired buffer, one way or another.
800 (if buffer
801 (let ((window (get-buffer-window buffer)))
802 (if window (select-window window)
803 (switch-to-buffer-other-window buffer))))
804 ;; Move to the specified line number in that buffer.
93be67de
KH
805 (save-restriction
806 (widen)
807 (goto-char 1)
808 (if (eq selective-display t)
809 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
f38c52df 810 (forward-line (1- arg)))))
2076c87c
JB
811
812(defun count-lines-region (start end)
eb8c3be9 813 "Print number of lines and characters in the region."
2076c87c
JB
814 (interactive "r")
815 (message "Region has %d lines, %d characters"
816 (count-lines start end) (- end start)))
817
818(defun what-line ()
2578be76 819 "Print the current buffer line number and narrowed line number of point."
2076c87c 820 (interactive)
c6db81aa 821 (let ((start (point-min))
4109ce02 822 (n (line-number-at-pos)))
f076870a
KS
823 (if (= start 1)
824 (message "Line %d" n)
825 (save-excursion
826 (save-restriction
827 (widen)
8e5d85ff 828 (message "line %d (narrowed line %d)"
4109ce02 829 (+ n (line-number-at-pos start) -1) n))))))
2578be76 830
2076c87c
JB
831(defun count-lines (start end)
832 "Return number of lines between START and END.
833This is usually the number of newlines between them,
ff1fbe3e 834but can be one more if START is not equal to END
2076c87c 835and the greater of them is not at the start of a line."
e406700d
RS
836 (save-excursion
837 (save-restriction
838 (narrow-to-region start end)
839 (goto-char (point-min))
840 (if (eq selective-display t)
841 (save-match-data
dde92ca6
RS
842 (let ((done 0))
843 (while (re-search-forward "[\n\C-m]" nil t 40)
844 (setq done (+ 40 done)))
845 (while (re-search-forward "[\n\C-m]" nil t 1)
846 (setq done (+ 1 done)))
043efc41
RS
847 (goto-char (point-max))
848 (if (and (/= start end)
849 (not (bolp)))
850 (1+ done)
e406700d
RS
851 done)))
852 (- (buffer-size) (forward-line (buffer-size)))))))
eaae8106 853
4109ce02 854(defun line-number-at-pos (&optional pos)
f076870a
KS
855 "Return (narrowed) buffer line number at position POS.
856If POS is nil, use current buffer location."
857 (let ((opoint (or pos (point))) start)
858 (save-excursion
859 (goto-char (point-min))
860 (setq start (point))
861 (goto-char opoint)
862 (forward-line 0)
863 (1+ (count-lines start (point))))))
864
d5d99b80
KH
865(defun what-cursor-position (&optional detail)
866 "Print info on cursor position (on screen and within buffer).
e38dff0c 867Also describe the character after point, and give its character code
c6fcc518
KH
868in octal, decimal and hex.
869
870For a non-ASCII multibyte character, also give its encoding in the
871buffer's selected coding system if the coding system encodes the
872character safely. If the character is encoded into one byte, that
873code is shown in hex. If the character is encoded into more than one
874byte, just \"...\" is shown.
e5a902cf 875
24dad5d5 876In addition, with prefix argument, show details about that character
0b69eec5 877in *Help* buffer. See also the command `describe-char'."
d5d99b80 878 (interactive "P")
2076c87c
JB
879 (let* ((char (following-char))
880 (beg (point-min))
881 (end (point-max))
882 (pos (point))
883 (total (buffer-size))
884 (percent (if (> total 50000)
885 ;; Avoid overflow from multiplying by 100!
886 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
887 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
888 (hscroll (if (= (window-hscroll) 0)
889 ""
890 (format " Hscroll=%d" (window-hscroll))))
891 (col (current-column)))
892 (if (= pos end)
893 (if (or (/= beg 1) (/= end (1+ total)))
74fd2380 894 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
2076c87c 895 pos total percent beg end col hscroll)
74fd2380 896 (message "point=%d of %d (%d%%) column %d %s"
2076c87c 897 pos total percent col hscroll))
c6fcc518 898 (let ((coding buffer-file-coding-system)
a41b50ca 899 encoded encoding-msg display-prop under-display)
c6fcc518
KH
900 (if (or (not coding)
901 (eq (coding-system-type coding) t))
902 (setq coding default-buffer-file-coding-system))
28fd4883
KH
903 (if (not (char-valid-p char))
904 (setq encoding-msg
905 (format "(0%o, %d, 0x%x, invalid)" char char char))
a41b50ca
KH
906 ;; Check if the character is displayed with some `display'
907 ;; text property. In that case, set under-display to the
908 ;; buffer substring covered by that property.
909 (setq display-prop (get-text-property pos 'display))
910 (if display-prop
911 (let ((to (or (next-single-property-change pos 'display)
912 (point-max))))
913 (if (< to (+ pos 4))
914 (setq under-display "")
915 (setq under-display "..."
916 to (+ pos 4)))
917 (setq under-display
918 (concat (buffer-substring-no-properties pos to)
919 under-display)))
920 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
28fd4883 921 (setq encoding-msg
a41b50ca
KH
922 (if display-prop
923 (if (not (stringp display-prop))
924 (format "(0%o, %d, 0x%x, part of display \"%s\")"
925 char char char under-display)
926 (format "(0%o, %d, 0x%x, part of display \"%s\"->\"%s\")"
927 char char char under-display display-prop))
928 (if encoded
929 (format "(0%o, %d, 0x%x, file %s)"
930 char char char
931 (if (> (length encoded) 1)
932 "..."
933 (encoded-string-description encoded coding)))
934 (format "(0%o, %d, 0x%x)" char char char)))))
e5e89e48 935 (if detail
24dad5d5 936 ;; We show the detailed information about CHAR.
0b69eec5 937 (describe-char (point)))
24dad5d5
KH
938 (if (or (/= beg 1) (/= end (1+ total)))
939 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
e5a902cf
KH
940 (if (< char 256)
941 (single-key-description char)
f0d16a7f 942 (buffer-substring-no-properties (point) (1+ (point))))
24dad5d5
KH
943 encoding-msg pos total percent beg end col hscroll)
944 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
a41b50ca
KH
945 (if enable-multibyte-characters
946 (if (< char 128)
947 (single-key-description char)
948 (buffer-substring-no-properties (point) (1+ (point))))
949 (single-key-description char))
24dad5d5 950 encoding-msg pos total percent col hscroll))))))
2d88b556 951\f
76c64e24
SM
952(defvar read-expression-map
953 (let ((m (make-sparse-keymap)))
954 (define-key m "\M-\t" 'lisp-complete-symbol)
955 (set-keymap-parent m minibuffer-local-map)
956 m)
854c16c5 957 "Minibuffer keymap used for reading Lisp expressions.")
854c16c5 958
8570b0ca
RM
959(defvar read-expression-history nil)
960
b49df39d 961(defcustom eval-expression-print-level 4
2f7e1f5a 962 "Value for `print-level' while printing value in `eval-expression'.
d26b26dc 963A value of nil means no limit."
b49df39d 964 :group 'lisp
058d4999 965 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
966 :version "21.1")
967
968(defcustom eval-expression-print-length 12
2f7e1f5a 969 "Value for `print-length' while printing value in `eval-expression'.
d26b26dc 970A value of nil means no limit."
b49df39d 971 :group 'lisp
058d4999 972 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
973 :version "21.1")
974
975(defcustom eval-expression-debug-on-error t
2f7e1f5a 976 "If non-nil set `debug-on-error' to t in `eval-expression'.
ed8bcabe 977If nil, don't change the value of `debug-on-error'."
b49df39d
RS
978 :group 'lisp
979 :type 'boolean
980 :version "21.1")
981
fa219ebd
JL
982(defun eval-expression-print-format (value)
983 "Format VALUE as a result of evaluated expression.
984Return a formatted string which is displayed in the echo area
985in addition to the value printed by prin1 in functions which
986display the result of expression evaluation."
987 (if (and (integerp value)
c9f0110e 988 (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd 989 (eq this-command last-command)
56abefac 990 (if (boundp 'edebug-active) edebug-active)))
fa219ebd 991 (let ((char-string
9bb25ed3 992 (if (or (if (boundp 'edebug-active) edebug-active)
c9f0110e 993 (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd
JL
994 (prin1-char value))))
995 (if char-string
996 (format " (0%o, 0x%x) = %s" value value char-string)
997 (format " (0%o, 0x%x)" value value)))))
998
8570b0ca 999;; We define this, rather than making `eval' interactive,
2076c87c 1000;; for the sake of completion of names like eval-region, eval-current-buffer.
ecb7ad00
RS
1001(defun eval-expression (eval-expression-arg
1002 &optional eval-expression-insert-value)
a6a1ee53
EZ
1003 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1004Value is also consed on to front of the variable `values'.
1005Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1006insert the result into the current buffer instead of printing it in
1007the echo area."
adca5fa6 1008 (interactive
b387ef9a
RS
1009 (list (read-from-minibuffer "Eval: "
1010 nil read-expression-map t
ecb7ad00
RS
1011 'read-expression-history)
1012 current-prefix-arg))
eaae8106 1013
ed8bcabe
GM
1014 (if (null eval-expression-debug-on-error)
1015 (setq values (cons (eval eval-expression-arg) values))
1016 (let ((old-value (make-symbol "t")) new-value)
1017 ;; Bind debug-on-error to something unique so that we can
1018 ;; detect when evaled code changes it.
1019 (let ((debug-on-error old-value))
1020 (setq values (cons (eval eval-expression-arg) values))
1021 (setq new-value debug-on-error))
1022 ;; If evaled code has changed the value of debug-on-error,
1023 ;; propagate that change to the global binding.
1024 (unless (eq old-value new-value)
1025 (setq debug-on-error new-value))))
eaae8106 1026
b49df39d
RS
1027 (let ((print-length eval-expression-print-length)
1028 (print-level eval-expression-print-level))
b82d844f
RS
1029 (if eval-expression-insert-value
1030 (with-no-warnings
683e7415
RS
1031 (let ((standard-output (current-buffer)))
1032 (eval-last-sexp-print-value (car values))))
fa219ebd
JL
1033 (prog1
1034 (prin1 (car values) t)
1035 (let ((str (eval-expression-print-format (car values))))
1036 (if str (princ str t)))))))
2076c87c
JB
1037
1038(defun edit-and-eval-command (prompt command)
1039 "Prompting with PROMPT, let user edit COMMAND and eval result.
1040COMMAND is a Lisp expression. Let user edit that expression in
1041the minibuffer, then read and evaluate the result."
9f4b6084 1042 (let ((command
11178a06
LT
1043 (let ((print-level nil)
1044 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1045 (unwind-protect
1046 (read-from-minibuffer prompt
1047 (prin1-to-string command)
1048 read-expression-map t
1049 'command-history)
1050 ;; If command was added to command-history as a string,
1051 ;; get rid of that. We want only evaluable expressions there.
1052 (if (stringp (car command-history))
1053 (setq command-history (cdr command-history)))))))
5d6c83ae
KH
1054
1055 ;; If command to be redone does not match front of history,
1056 ;; add it to the history.
1057 (or (equal command (car command-history))
1058 (setq command-history (cons command command-history)))
2076c87c
JB
1059 (eval command)))
1060
ebb61177 1061(defun repeat-complex-command (arg)
2076c87c
JB
1062 "Edit and re-evaluate last complex command, or ARGth from last.
1063A complex command is one which used the minibuffer.
1064The command is placed in the minibuffer as a Lisp form for editing.
1065The result is executed, repeating the command as changed.
1066If the command has been changed or is not the most recent previous command
1067it is added to the front of the command history.
eb6e9899
RS
1068You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1069to get different commands to edit and resubmit."
2076c87c 1070 (interactive "p")
ba343182 1071 (let ((elt (nth (1- arg) command-history))
2076c87c
JB
1072 newcmd)
1073 (if elt
854c16c5 1074 (progn
eab22e27 1075 (setq newcmd
74ae5fab
RS
1076 (let ((print-level nil)
1077 (minibuffer-history-position arg)
99ea24de 1078 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
9f4b6084
MR
1079 (unwind-protect
1080 (read-from-minibuffer
1081 "Redo: " (prin1-to-string elt) read-expression-map t
1082 (cons 'command-history arg))
1083
1084 ;; If command was added to command-history as a
1085 ;; string, get rid of that. We want only
1086 ;; evaluable expressions there.
1087 (if (stringp (car command-history))
1088 (setq command-history (cdr command-history))))))
db16f109
RS
1089
1090 ;; If command to be redone does not match front of history,
1091 ;; add it to the history.
1092 (or (equal newcmd (car command-history))
1093 (setq command-history (cons newcmd command-history)))
2076c87c 1094 (eval newcmd))
536b728a
RS
1095 (if command-history
1096 (error "Argument %d is beyond length of command history" arg)
1097 (error "There are no previous complex commands to repeat")))))
2d88b556 1098\f
854c16c5
RS
1099(defvar minibuffer-history nil
1100 "Default minibuffer history list.
1101This is used for all minibuffer input
1102except when an alternate history list is specified.")
1103(defvar minibuffer-history-sexp-flag nil
2c6a2254
RS
1104 "Control whether history list elements are expressions or strings.
1105If the value of this variable equals current minibuffer depth,
1106they are expressions; otherwise they are strings.
1107\(That convention is designed to do the right thing fora
1108recursive uses of the minibuffer.)")
e91f80c4
RS
1109(setq minibuffer-history-variable 'minibuffer-history)
1110(setq minibuffer-history-position nil)
854c16c5 1111(defvar minibuffer-history-search-history nil)
e91f80c4 1112
93cee14b
RS
1113(defvar minibuffer-text-before-history nil
1114 "Text that was in this minibuffer before any history commands.
1115This is nil if there have not yet been any history commands
1116in this use of the minibuffer.")
1117
1118(add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1119
1120(defun minibuffer-history-initialize ()
1121 (setq minibuffer-text-before-history nil))
1122
6e7d0ff7
MB
1123(defun minibuffer-avoid-prompt (new old)
1124 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1125 (constrain-to-field nil (point-max)))
1126
6e30a99a
RS
1127(defcustom minibuffer-history-case-insensitive-variables nil
1128 "*Minibuffer history variables for which matching should ignore case.
1129If a history variable is a member of this list, then the
1130\\[previous-matching-history-element] and \\[next-matching-history-element]\
1131 commands ignore case when searching it, regardless of `case-fold-search'."
1132 :type '(repeat variable)
1133 :group 'minibuffer)
1134
e91f80c4 1135(defun previous-matching-history-element (regexp n)
854c16c5
RS
1136 "Find the previous history element that matches REGEXP.
1137\(Previous history elements refer to earlier actions.)
1138With prefix argument N, search for Nth previous match.
5c2010f0 1139If N is negative, find the next or Nth next match.
9889af08
EZ
1140Normally, history elements are matched case-insensitively if
1141`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1142makes the search case-sensitive.
6e30a99a 1143See also `minibuffer-history-case-insensitive-variables'."
854c16c5 1144 (interactive
c1172a19 1145 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1146 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1147 nil
1148 minibuffer-local-map
1149 nil
5794c45d
RS
1150 'minibuffer-history-search-history
1151 (car minibuffer-history-search-history))))
c1172a19
RS
1152 ;; Use the last regexp specified, by default, if input is empty.
1153 (list (if (string= regexp "")
a8e96cea
KH
1154 (if minibuffer-history-search-history
1155 (car minibuffer-history-search-history)
1156 (error "No previous history search regexp"))
c1172a19 1157 regexp)
854c16c5 1158 (prefix-numeric-value current-prefix-arg))))
e276a14a
MB
1159 (unless (zerop n)
1160 (if (and (zerop minibuffer-history-position)
1161 (null minibuffer-text-before-history))
efaac2e6 1162 (setq minibuffer-text-before-history
6d74d713 1163 (minibuffer-contents-no-properties)))
e276a14a
MB
1164 (let ((history (symbol-value minibuffer-history-variable))
1165 (case-fold-search
1166 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1167 ;; On some systems, ignore case for file names.
1168 (if (memq minibuffer-history-variable
1169 minibuffer-history-case-insensitive-variables)
1170 t
1171 ;; Respect the user's setting for case-fold-search:
1172 case-fold-search)
1173 nil))
1174 prevpos
1175 match-string
1176 match-offset
1177 (pos minibuffer-history-position))
1178 (while (/= n 0)
1179 (setq prevpos pos)
1180 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1181 (when (= pos prevpos)
e91f80c4 1182 (error (if (= pos 1)
ccc58657
RS
1183 "No later matching history item"
1184 "No earlier matching history item")))
e276a14a
MB
1185 (setq match-string
1186 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
7908d27c 1187 (let ((print-level nil))
e276a14a
MB
1188 (prin1-to-string (nth (1- pos) history)))
1189 (nth (1- pos) history)))
1190 (setq match-offset
1191 (if (< n 0)
1192 (and (string-match regexp match-string)
1193 (match-end 0))
1194 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1195 (match-beginning 1))))
1196 (when match-offset
1197 (setq n (+ n (if (< n 0) 1 -1)))))
1198 (setq minibuffer-history-position pos)
1199 (goto-char (point-max))
efaac2e6 1200 (delete-minibuffer-contents)
e276a14a 1201 (insert match-string)
6d74d713 1202 (goto-char (+ (minibuffer-prompt-end) match-offset))))
e1e04350
SM
1203 (if (memq (car (car command-history)) '(previous-matching-history-element
1204 next-matching-history-element))
854c16c5 1205 (setq command-history (cdr command-history))))
e91f80c4 1206
e91f80c4 1207(defun next-matching-history-element (regexp n)
854c16c5
RS
1208 "Find the next history element that matches REGEXP.
1209\(The next history element refers to a more recent action.)
1210With prefix argument N, search for Nth next match.
5c2010f0 1211If N is negative, find the previous or Nth previous match.
9889af08
EZ
1212Normally, history elements are matched case-insensitively if
1213`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1214makes the search case-sensitive."
854c16c5 1215 (interactive
c1172a19 1216 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1217 (regexp (read-from-minibuffer "Next element matching (regexp): "
1218 nil
1219 minibuffer-local-map
1220 nil
e967cd11
RS
1221 'minibuffer-history-search-history
1222 (car minibuffer-history-search-history))))
c1172a19
RS
1223 ;; Use the last regexp specified, by default, if input is empty.
1224 (list (if (string= regexp "")
e967cd11
RS
1225 (if minibuffer-history-search-history
1226 (car minibuffer-history-search-history)
1227 (error "No previous history search regexp"))
c1172a19 1228 regexp)
854c16c5 1229 (prefix-numeric-value current-prefix-arg))))
e91f80c4 1230 (previous-matching-history-element regexp (- n)))
2076c87c 1231
8dc3ba7d
MB
1232(defvar minibuffer-temporary-goal-position nil)
1233
ebb61177
RS
1234(defun next-history-element (n)
1235 "Insert the next element of the minibuffer history into the minibuffer."
2076c87c 1236 (interactive "p")
0818b15e 1237 (or (zerop n)
93cee14b
RS
1238 (let ((narg (- minibuffer-history-position n))
1239 (minimum (if minibuffer-default -1 0))
068c712c 1240 elt minibuffer-returned-to-present)
93cee14b
RS
1241 (if (and (zerop minibuffer-history-position)
1242 (null minibuffer-text-before-history))
efaac2e6
MB
1243 (setq minibuffer-text-before-history
1244 (minibuffer-contents-no-properties)))
93cee14b 1245 (if (< narg minimum)
81091543
RS
1246 (if minibuffer-default
1247 (error "End of history; no next item")
1248 (error "End of history; no default available")))
93cee14b
RS
1249 (if (> narg (length (symbol-value minibuffer-history-variable)))
1250 (error "Beginning of history; no preceding item"))
e1e04350
SM
1251 (unless (memq last-command '(next-history-element
1252 previous-history-element))
efaac2e6 1253 (let ((prompt-end (minibuffer-prompt-end)))
8dc3ba7d
MB
1254 (set (make-local-variable 'minibuffer-temporary-goal-position)
1255 (cond ((<= (point) prompt-end) prompt-end)
1256 ((eobp) nil)
1257 (t (point))))))
a4d1159b 1258 (goto-char (point-max))
efaac2e6 1259 (delete-minibuffer-contents)
93cee14b
RS
1260 (setq minibuffer-history-position narg)
1261 (cond ((= narg -1)
1262 (setq elt minibuffer-default))
1263 ((= narg 0)
54c548db 1264 (setq elt (or minibuffer-text-before-history ""))
068c712c 1265 (setq minibuffer-returned-to-present t)
93cee14b
RS
1266 (setq minibuffer-text-before-history nil))
1267 (t (setq elt (nth (1- minibuffer-history-position)
1268 (symbol-value minibuffer-history-variable)))))
1269 (insert
068c712c
KH
1270 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1271 (not minibuffer-returned-to-present))
93cee14b
RS
1272 (let ((print-level nil))
1273 (prin1-to-string elt))
1274 elt))
8dc3ba7d 1275 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
2076c87c 1276
ebb61177 1277(defun previous-history-element (n)
3ee3a076 1278 "Inserts the previous element of the minibuffer history into the minibuffer."
2076c87c 1279 (interactive "p")
2c5e21c1 1280 (next-history-element (- n)))
d0678801
RM
1281
1282(defun next-complete-history-element (n)
a4d1159b
GM
1283 "Get next history element which completes the minibuffer before the point.
1284The contents of the minibuffer after the point are deleted, and replaced
1285by the new completion."
d0678801 1286 (interactive "p")
b5e6f936
RM
1287 (let ((point-at-start (point)))
1288 (next-matching-history-element
a4d1159b 1289 (concat
efaac2e6 1290 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
a4d1159b 1291 n)
b5e6f936
RM
1292 ;; next-matching-history-element always puts us at (point-min).
1293 ;; Move to the position we were at before changing the buffer contents.
1294 ;; This is still sensical, because the text before point has not changed.
1295 (goto-char point-at-start)))
d0678801
RM
1296
1297(defun previous-complete-history-element (n)
1f6fcec3 1298 "\
a4d1159b
GM
1299Get previous history element which completes the minibuffer before the point.
1300The contents of the minibuffer after the point are deleted, and replaced
1301by the new completion."
d0678801
RM
1302 (interactive "p")
1303 (next-complete-history-element (- n)))
a4d1159b 1304
efaac2e6 1305;; For compatibility with the old subr of the same name.
a4d1159b
GM
1306(defun minibuffer-prompt-width ()
1307 "Return the display width of the minibuffer prompt.
f33321ad 1308Return 0 if current buffer is not a minibuffer."
a4d1159b
GM
1309 ;; Return the width of everything before the field at the end of
1310 ;; the buffer; this should be 0 for normal buffers.
efaac2e6 1311 (1- (minibuffer-prompt-end)))
2d88b556 1312\f
2076c87c 1313;Put this on C-x u, so we can force that rather than C-_ into startup msg
e462e42f 1314(defalias 'advertised-undo 'undo)
2076c87c 1315
1e96c007 1316(defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
713c9020
RS
1317 "Table mapping redo records to the corresponding undo one.
1318A redo record for undo-in-region maps to t.
1319A redo record for ordinary undo maps to the following (earlier) undo.")
1e96c007
SM
1320
1321(defvar undo-in-region nil
1322 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
1323
1324(defvar undo-no-redo nil
1325 "If t, `undo' doesn't go through redo entries.")
1326
a7fe694c
RS
1327(defvar pending-undo-list nil
1328 "Within a run of consecutive undo commands, list remaining to be undone.
8ac28be5 1329If t, we undid all the way to the end of it.")
a7fe694c 1330
2076c87c
JB
1331(defun undo (&optional arg)
1332 "Undo some previous changes.
1333Repeat this command to undo more changes.
65627aad
RS
1334A numeric argument serves as a repeat count.
1335
3c1b77ca 1336In Transient Mark mode when the mark is active, only undo changes within
1e96c007 1337the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
3c1b77ca 1338as an argument limits undo to changes within the current region."
65627aad 1339 (interactive "*P")
2e033693
RS
1340 ;; Make last-command indicate for the next command that this was an undo.
1341 ;; That way, another undo will undo more.
1342 ;; If we get to the end of the undo history and get an error,
1343 ;; another undo command will find the undo history empty
1344 ;; and will get another error. To begin undoing the undos,
1345 ;; you must type some other command.
b553cffa
RS
1346 (let ((modified (buffer-modified-p))
1347 (recent-save (recent-auto-save-p)))
2c6a2254
RS
1348 ;; If we get an error in undo-start,
1349 ;; the next command should not be a "consecutive undo".
1350 ;; So set `this-command' to something other than `undo'.
1351 (setq this-command 'undo-start)
1352
e967cd11 1353 (unless (and (eq last-command 'undo)
a7fe694c
RS
1354 (or (eq pending-undo-list t)
1355 ;; If something (a timer or filter?) changed the buffer
1356 ;; since the previous command, don't continue the undo seq.
1357 (let ((list buffer-undo-list))
1358 (while (eq (car list) nil)
1359 (setq list (cdr list)))
1360 ;; If the last undo record made was made by undo
1361 ;; it shows nothing else happened in between.
1362 (gethash list undo-equiv-table))))
1e96c007
SM
1363 (setq undo-in-region
1364 (if transient-mark-mode mark-active (and arg (not (numberp arg)))))
1365 (if undo-in-region
3c1b77ca
MB
1366 (undo-start (region-beginning) (region-end))
1367 (undo-start))
1368 ;; get rid of initial undo boundary
1369 (undo-more 1))
9a1120ea 1370 ;; If we got this far, the next command should be a consecutive undo.
2c6a2254 1371 (setq this-command 'undo)
1e96c007
SM
1372 ;; Check to see whether we're hitting a redo record, and if
1373 ;; so, ask the user whether she wants to skip the redo/undo pair.
1374 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
1375 (or (eq (selected-window) (minibuffer-window))
1376 (message (if undo-in-region
1377 (if equiv "Redo in region!" "Undo in region!")
1378 (if equiv "Redo!" "Undo!"))))
0047373b 1379 (when (and (consp equiv) undo-no-redo)
1e96c007
SM
1380 ;; The equiv entry might point to another redo record if we have done
1381 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1382 (while (let ((next (gethash equiv undo-equiv-table)))
1383 (if next (setq equiv next))))
1384 (setq pending-undo-list equiv)))
3c1b77ca
MB
1385 (undo-more
1386 (if (or transient-mark-mode (numberp arg))
1387 (prefix-numeric-value arg)
1388 1))
1e96c007 1389 ;; Record the fact that the just-generated undo records come from an
713c9020
RS
1390 ;; undo operation--that is, they are redo records.
1391 ;; In the ordinary case (not within a region), map the redo
1392 ;; record to the following undos.
1e96c007 1393 ;; I don't know how to do that in the undo-in-region case.
713c9020
RS
1394 (puthash buffer-undo-list
1395 (if undo-in-region t pending-undo-list)
1396 undo-equiv-table)
2512c9f0
RS
1397 ;; Don't specify a position in the undo record for the undo command.
1398 ;; Instead, undoing this should move point to where the change is.
1399 (let ((tail buffer-undo-list)
003550c5
GM
1400 (prev nil))
1401 (while (car tail)
1402 (when (integerp (car tail))
1403 (let ((pos (car tail)))
1e96c007
SM
1404 (if prev
1405 (setcdr prev (cdr tail))
1406 (setq buffer-undo-list (cdr tail)))
003550c5
GM
1407 (setq tail (cdr tail))
1408 (while (car tail)
1409 (if (eq pos (car tail))
1410 (if prev
1411 (setcdr prev (cdr tail))
1412 (setq buffer-undo-list (cdr tail)))
1413 (setq prev tail))
1414 (setq tail (cdr tail)))
1415 (setq tail nil)))
1416 (setq prev tail tail (cdr tail))))
e967cd11
RS
1417 ;; Record what the current undo list says,
1418 ;; so the next command can tell if the buffer was modified in between.
2076c87c 1419 (and modified (not (buffer-modified-p))
2e033693 1420 (delete-auto-save-file-if-necessary recent-save))))
2076c87c 1421
e967cd11
RS
1422(defun buffer-disable-undo (&optional buffer)
1423 "Make BUFFER stop keeping undo information.
1424No argument or nil as argument means do this for the current buffer."
1425 (interactive)
0d808a63 1426 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
d020fce0 1427 (setq buffer-undo-list t)))
e967cd11 1428
1e96c007
SM
1429(defun undo-only (&optional arg)
1430 "Undo some previous changes.
1431Repeat this command to undo more changes.
1432A numeric argument serves as a repeat count.
1433Contrary to `undo', this will not redo a previous undo."
1434 (interactive "*p")
1435 (let ((undo-no-redo t)) (undo arg)))
1e96c007 1436
52d1110d
RS
1437(defvar undo-in-progress nil
1438 "Non-nil while performing an undo.
1439Some change-hooks test this variable to do something different.")
1440
8ac28be5 1441(defun undo-more (n)
2076c87c 1442 "Undo back N undo-boundaries beyond what was already undone recently.
ff1fbe3e
RS
1443Call `undo-start' to get ready to undo recent changes,
1444then call `undo-more' one or more times to undo them."
a7fe694c 1445 (or (listp pending-undo-list)
8ac28be5
JB
1446 (error (concat "No further undo information"
1447 (and transient-mark-mode mark-active
1448 " for region"))))
52d1110d 1449 (let ((undo-in-progress t))
8ac28be5 1450 (setq pending-undo-list (primitive-undo n pending-undo-list))
a7fe694c
RS
1451 (if (null pending-undo-list)
1452 (setq pending-undo-list t))))
2076c87c 1453
65627aad
RS
1454;; Deep copy of a list
1455(defun undo-copy-list (list)
1456 "Make a copy of undo list LIST."
1457 (mapcar 'undo-copy-list-1 list))
1458
1459(defun undo-copy-list-1 (elt)
1460 (if (consp elt)
1461 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1462 elt))
1463
1464(defun undo-start (&optional beg end)
1465 "Set `pending-undo-list' to the front of the undo list.
1466The next call to `undo-more' will undo the most recently made change.
1467If BEG and END are specified, then only undo elements
1468that apply to text between BEG and END are used; other undo elements
1469are ignored. If BEG and END are nil, all undo elements are used."
1470 (if (eq buffer-undo-list t)
1471 (error "No undo information in this buffer"))
1e722f9f 1472 (setq pending-undo-list
65627aad
RS
1473 (if (and beg end (not (= beg end)))
1474 (undo-make-selective-list (min beg end) (max beg end))
1475 buffer-undo-list)))
1476
1477(defvar undo-adjusted-markers)
1478
1479(defun undo-make-selective-list (start end)
1480 "Return a list of undo elements for the region START to END.
1481The elements come from `buffer-undo-list', but we keep only
1482the elements inside this region, and discard those outside this region.
1483If we find an element that crosses an edge of this region,
1484we stop and ignore all further elements."
1485 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1486 (undo-list (list nil))
1487 undo-adjusted-markers
1488 some-rejected
1489 undo-elt undo-elt temp-undo-list delta)
1490 (while undo-list-copy
1491 (setq undo-elt (car undo-list-copy))
1492 (let ((keep-this
1493 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1494 ;; This is a "was unmodified" element.
1495 ;; Keep it if we have kept everything thus far.
1496 (not some-rejected))
1497 (t
1498 (undo-elt-in-region undo-elt start end)))))
1499 (if keep-this
1500 (progn
1501 (setq end (+ end (cdr (undo-delta undo-elt))))
1502 ;; Don't put two nils together in the list
1503 (if (not (and (eq (car undo-list) nil)
1504 (eq undo-elt nil)))
1505 (setq undo-list (cons undo-elt undo-list))))
1506 (if (undo-elt-crosses-region undo-elt start end)
1507 (setq undo-list-copy nil)
1508 (setq some-rejected t)
1509 (setq temp-undo-list (cdr undo-list-copy))
1510 (setq delta (undo-delta undo-elt))
1511
1512 (when (/= (cdr delta) 0)
1513 (let ((position (car delta))
1514 (offset (cdr delta)))
1515
e1e04350
SM
1516 ;; Loop down the earlier events adjusting their buffer
1517 ;; positions to reflect the fact that a change to the buffer
1518 ;; isn't being undone. We only need to process those element
1519 ;; types which undo-elt-in-region will return as being in
1520 ;; the region since only those types can ever get into the
1521 ;; output
65627aad
RS
1522
1523 (while temp-undo-list
1524 (setq undo-elt (car temp-undo-list))
1525 (cond ((integerp undo-elt)
1526 (if (>= undo-elt position)
1527 (setcar temp-undo-list (- undo-elt offset))))
1528 ((atom undo-elt) nil)
1529 ((stringp (car undo-elt))
1530 ;; (TEXT . POSITION)
1531 (let ((text-pos (abs (cdr undo-elt)))
1532 (point-at-end (< (cdr undo-elt) 0 )))
1533 (if (>= text-pos position)
1e722f9f 1534 (setcdr undo-elt (* (if point-at-end -1 1)
65627aad
RS
1535 (- text-pos offset))))))
1536 ((integerp (car undo-elt))
1537 ;; (BEGIN . END)
1538 (when (>= (car undo-elt) position)
1539 (setcar undo-elt (- (car undo-elt) offset))
1540 (setcdr undo-elt (- (cdr undo-elt) offset))))
1541 ((null (car undo-elt))
1542 ;; (nil PROPERTY VALUE BEG . END)
1543 (let ((tail (nthcdr 3 undo-elt)))
1544 (when (>= (car tail) position)
1545 (setcar tail (- (car tail) offset))
1546 (setcdr tail (- (cdr tail) offset))))))
1547 (setq temp-undo-list (cdr temp-undo-list))))))))
1548 (setq undo-list-copy (cdr undo-list-copy)))
1549 (nreverse undo-list)))
1550
1551(defun undo-elt-in-region (undo-elt start end)
1552 "Determine whether UNDO-ELT falls inside the region START ... END.
1553If it crosses the edge, we return nil."
1554 (cond ((integerp undo-elt)
1555 (and (>= undo-elt start)
12a93712 1556 (<= undo-elt end)))
65627aad
RS
1557 ((eq undo-elt nil)
1558 t)
1559 ((atom undo-elt)
1560 nil)
1561 ((stringp (car undo-elt))
1562 ;; (TEXT . POSITION)
1563 (and (>= (abs (cdr undo-elt)) start)
1564 (< (abs (cdr undo-elt)) end)))
1565 ((and (consp undo-elt) (markerp (car undo-elt)))
1566 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1567 ;; See if MARKER is inside the region.
1568 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1569 (unless alist-elt
1570 (setq alist-elt (cons (car undo-elt)
1571 (marker-position (car undo-elt))))
1572 (setq undo-adjusted-markers
1573 (cons alist-elt undo-adjusted-markers)))
1574 (and (cdr alist-elt)
1575 (>= (cdr alist-elt) start)
12a93712 1576 (<= (cdr alist-elt) end))))
65627aad
RS
1577 ((null (car undo-elt))
1578 ;; (nil PROPERTY VALUE BEG . END)
1579 (let ((tail (nthcdr 3 undo-elt)))
1580 (and (>= (car tail) start)
12a93712 1581 (<= (cdr tail) end))))
65627aad
RS
1582 ((integerp (car undo-elt))
1583 ;; (BEGIN . END)
1584 (and (>= (car undo-elt) start)
12a93712 1585 (<= (cdr undo-elt) end)))))
65627aad
RS
1586
1587(defun undo-elt-crosses-region (undo-elt start end)
1588 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1589This assumes we have already decided that UNDO-ELT
1590is not *inside* the region START...END."
1591 (cond ((atom undo-elt) nil)
1592 ((null (car undo-elt))
1593 ;; (nil PROPERTY VALUE BEG . END)
1594 (let ((tail (nthcdr 3 undo-elt)))
1595 (not (or (< (car tail) end)
1596 (> (cdr tail) start)))))
1597 ((integerp (car undo-elt))
1598 ;; (BEGIN . END)
1599 (not (or (< (car undo-elt) end)
1600 (> (cdr undo-elt) start))))))
1601
1602;; Return the first affected buffer position and the delta for an undo element
1603;; delta is defined as the change in subsequent buffer positions if we *did*
1604;; the undo.
1605(defun undo-delta (undo-elt)
1606 (if (consp undo-elt)
1607 (cond ((stringp (car undo-elt))
1608 ;; (TEXT . POSITION)
1609 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1610 ((integerp (car undo-elt))
1611 ;; (BEGIN . END)
1612 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1613 (t
1614 '(0 . 0)))
1615 '(0 . 0)))
b6e8e8e5 1616
28cb725d
LT
1617(defcustom undo-ask-before-discard t
1618 "If non-nil ask about discarding undo info for the current command.
1619Normally, Emacs discards the undo info for the current command if
1620it exceeds `undo-outer-limit'. But if you set this option
1621non-nil, it asks in the echo area whether to discard the info.
1622If you answer no, there a slight risk that Emacs might crash, so
1623only do it if you really want to undo the command.
1624
1625This option is mainly intended for debugging. You have to be
1626careful if you use it for other purposes. Garbage collection is
1627inhibited while the question is asked, meaning that Emacs might
1628leak memory. So you should make sure that you do not wait
1629excessively long before answering the question."
1630 :type 'boolean
1631 :group 'undo
bf247b6e 1632 :version "22.1")
28cb725d 1633
a1a801de
RS
1634(defvar undo-extra-outer-limit nil
1635 "If non-nil, an extra level of size that's ok in an undo item.
1636We don't ask the user about truncating the undo list until the
28cb725d
LT
1637current item gets bigger than this amount.
1638
1639This variable only matters if `undo-ask-before-discard' is non-nil.")
a1a801de
RS
1640(make-variable-buffer-local 'undo-extra-outer-limit)
1641
28cb725d
LT
1642;; When the first undo batch in an undo list is longer than
1643;; undo-outer-limit, this function gets called to warn the user that
1644;; the undo info for the current command was discarded. Garbage
1645;; collection is inhibited around the call, so it had better not do a
1646;; lot of consing.
b6e8e8e5
RS
1647(setq undo-outer-limit-function 'undo-outer-limit-truncate)
1648(defun undo-outer-limit-truncate (size)
28cb725d
LT
1649 (if undo-ask-before-discard
1650 (when (or (null undo-extra-outer-limit)
1651 (> size undo-extra-outer-limit))
1652 ;; Don't ask the question again unless it gets even bigger.
1653 ;; This applies, in particular, if the user quits from the question.
1654 ;; Such a quit quits out of GC, but something else will call GC
1655 ;; again momentarily. It will call this function again,
1656 ;; but we don't want to ask the question again.
1657 (setq undo-extra-outer-limit (+ size 50000))
1658 (if (let (use-dialog-box track-mouse executing-kbd-macro )
1659 (yes-or-no-p (format "Buffer %s undo info is %d bytes long; discard it? "
1660 (buffer-name) size)))
1661 (progn (setq buffer-undo-list nil)
1662 (setq undo-extra-outer-limit nil)
1663 t)
1664 nil))
1665 (display-warning '(undo discard-info)
1666 (concat
1667 (format "Buffer %s undo info was %d bytes long.\n"
1668 (buffer-name) size)
1669 "The undo info was discarded because it exceeded \
1670`undo-outer-limit'.
1671
1672This is normal if you executed a command that made a huge change
1673to the buffer. In that case, to prevent similar problems in the
1674future, set `undo-outer-limit' to a value that is large enough to
1675cover the maximum size of normal changes you expect a single
1676command to make, but not so large that it might exceed the
1677maximum memory allotted to Emacs.
1678
1679If you did not execute any such command, the situation is
1680probably due to a bug and you should report it.
1681
1682You can disable the popping up of this buffer by adding the entry
1683\(undo discard-info) to the user option `warning-suppress-types'.\n")
1684 :warning)
1685 (setq buffer-undo-list nil)
1686 t))
e1e04350 1687\f
009ef402
RS
1688(defvar shell-command-history nil
1689 "History list for some commands that read shell commands.")
1690
59fc41e5
RS
1691(defvar shell-command-switch "-c"
1692 "Switch used to have the shell execute its command line argument.")
1693
cc039f78
KH
1694(defvar shell-command-default-error-buffer nil
1695 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
637fff82 1696This buffer is used when `shell-command' or `shell-command-on-region'
cc039f78
KH
1697is run interactively. A value of nil means that output to stderr and
1698stdout will be intermixed in the output stream.")
1699
1700(defun shell-command (command &optional output-buffer error-buffer)
2076c87c 1701 "Execute string COMMAND in inferior shell; display output, if any.
0b3f96d4 1702With prefix argument, insert the COMMAND's output at point.
d382f610 1703
2076c87c 1704If COMMAND ends in ampersand, execute it asynchronously.
d382f610 1705The output appears in the buffer `*Async Shell Command*'.
bcad4985 1706That buffer is in shell mode.
d382f610 1707
939ac10c
GM
1708Otherwise, COMMAND is executed synchronously. The output appears in
1709the buffer `*Shell Command Output*'. If the output is short enough to
1710display in the echo area (which is determined by the variables
1711`resize-mini-windows' and `max-mini-window-height'), it is shown
1712there, but it is nonetheless available in buffer `*Shell Command
e1e04350 1713Output*' even though that buffer is not automatically displayed.
d0d74413 1714
07f458c1
RS
1715To specify a coding system for converting non-ASCII characters
1716in the shell command output, use \\[universal-coding-system-argument]
1717before this command.
1718
1719Noninteractive callers can specify coding systems by binding
1720`coding-system-for-read' and `coding-system-for-write'.
1721
d0d74413
RS
1722The optional second argument OUTPUT-BUFFER, if non-nil,
1723says to put the output in some other buffer.
1724If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1725If OUTPUT-BUFFER is not a buffer and not nil,
1726insert output in current buffer. (This cannot be done asynchronously.)
cc039f78
KH
1727In either case, the output is inserted after point (leaving mark after it).
1728
2e033693
RS
1729If the command terminates without error, but generates output,
1730and you did not specify \"insert it in the current buffer\",
1731the output can be displayed in the echo area or in its buffer.
1732If the output is short enough to display in the echo area
1733\(determined by the variable `max-mini-window-height' if
1734`resize-mini-windows' is non-nil), it is shown there. Otherwise,
1735the buffer containing the output is displayed.
1736
1737If there is output and an error, and you did not specify \"insert it
1738in the current buffer\", a message about the error goes at the end
1739of the output.
1740
1741If there is no output, or if output is inserted in the current buffer,
1742then `*Shell Command Output*' is deleted.
1743
cc039f78
KH
1744If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1745or buffer name to which to direct the command's standard error output.
1746If it is nil, error output is mingled with regular output.
1747In an interactive call, the variable `shell-command-default-error-buffer'
1748specifies the value of ERROR-BUFFER."
1749
aa00b92d
RS
1750 (interactive (list (read-from-minibuffer "Shell command: "
1751 nil nil nil 'shell-command-history)
cc039f78
KH
1752 current-prefix-arg
1753 shell-command-default-error-buffer))
c7edd03c
KH
1754 ;; Look for a handler in case default-directory is a remote file name.
1755 (let ((handler
1756 (find-file-name-handler (directory-file-name default-directory)
1757 'shell-command)))
1758 (if handler
cc039f78 1759 (funcall handler 'shell-command command output-buffer error-buffer)
c7edd03c
KH
1760 (if (and output-buffer
1761 (not (or (bufferp output-buffer) (stringp output-buffer))))
2e033693 1762 ;; Output goes in current buffer.
cc039f78 1763 (let ((error-file
1e722f9f 1764 (if error-buffer
b005abd5 1765 (make-temp-file
171a45d9
EZ
1766 (expand-file-name "scor"
1767 (or small-temporary-file-directory
1768 temporary-file-directory)))
cc039f78
KH
1769 nil)))
1770 (barf-if-buffer-read-only)
63437623 1771 (push-mark nil t)
cc039f78
KH
1772 ;; We do not use -f for csh; we will not support broken use of
1773 ;; .cshrcs. Even the BSD csh manual says to use
1774 ;; "if ($?prompt) exit" before things which are not useful
1775 ;; non-interactively. Besides, if someone wants their other
1776 ;; aliases for shell commands then they can still have them.
1e722f9f 1777 (call-process shell-file-name nil
cc039f78
KH
1778 (if error-file
1779 (list t error-file)
1780 t)
1781 nil shell-command-switch command)
1782 (when (and error-file (file-exists-p error-file))
1783 (if (< 0 (nth 7 (file-attributes error-file)))
1784 (with-current-buffer (get-buffer-create error-buffer)
1785 (let ((pos-from-end (- (point-max) (point))))
1786 (or (bobp)
1787 (insert "\f\n"))
1788 ;; Do no formatting while reading error file,
1789 ;; because that can run a shell command, and we
1790 ;; don't want that to cause an infinite recursion.
1791 (format-insert-file error-file nil)
1792 ;; Put point after the inserted errors.
1793 (goto-char (- (point-max) pos-from-end)))
1794 (display-buffer (current-buffer))))
1795 (delete-file error-file))
1796 ;; This is like exchange-point-and-mark, but doesn't
1797 ;; activate the mark. It is cleaner to avoid activation,
1798 ;; even though the command loop would deactivate the mark
1799 ;; because we inserted text.
1800 (goto-char (prog1 (mark t)
1801 (set-marker (mark-marker) (point)
1802 (current-buffer)))))
2e033693 1803 ;; Output goes in a separate buffer.
c7edd03c
KH
1804 ;; Preserve the match data in case called from a program.
1805 (save-match-data
aab5d2c5 1806 (if (string-match "[ \t]*&[ \t]*\\'" command)
c7edd03c
KH
1807 ;; Command ending with ampersand means asynchronous.
1808 (let ((buffer (get-buffer-create
1809 (or output-buffer "*Async Shell Command*")))
1810 (directory default-directory)
1811 proc)
1812 ;; Remove the ampersand.
1813 (setq command (substring command 0 (match-beginning 0)))
1814 ;; If will kill a process, query first.
1815 (setq proc (get-buffer-process buffer))
1816 (if proc
1817 (if (yes-or-no-p "A command is running. Kill it? ")
1818 (kill-process proc)
1819 (error "Shell command in progress")))
1e96c007 1820 (with-current-buffer buffer
c7edd03c
KH
1821 (setq buffer-read-only nil)
1822 (erase-buffer)
1823 (display-buffer buffer)
1824 (setq default-directory directory)
1e722f9f 1825 (setq proc (start-process "Shell" buffer shell-file-name
c7edd03c
KH
1826 shell-command-switch command))
1827 (setq mode-line-process '(":%s"))
c2020c27 1828 (require 'shell) (shell-mode)
c7edd03c
KH
1829 (set-process-sentinel proc 'shell-command-sentinel)
1830 ))
cc039f78
KH
1831 (shell-command-on-region (point) (point) command
1832 output-buffer nil error-buffer)))))))
eaae8106 1833
f69aad2b
MB
1834(defun display-message-or-buffer (message
1835 &optional buffer-name not-this-window frame)
1836 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1837MESSAGE may be either a string or a buffer.
1838
1839A buffer is displayed using `display-buffer' if MESSAGE is too long for
939ac10c
GM
1840the maximum height of the echo area, as defined by `max-mini-window-height'
1841if `resize-mini-windows' is non-nil.
f69aad2b 1842
2a3f00bf
MB
1843Returns either the string shown in the echo area, or when a pop-up
1844buffer is used, the window used to display it.
1845
f69aad2b
MB
1846If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1847name of the buffer used to display it in the case where a pop-up buffer
1848is used, defaulting to `*Message*'. In the case where MESSAGE is a
1849string and it is displayed in the echo area, it is not specified whether
1850the contents are inserted into the buffer anyway.
1851
1852Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1853and only used if a buffer is displayed."
1854 (cond ((and (stringp message) (not (string-match "\n" message)))
1855 ;; Trivial case where we can use the echo area
1856 (message "%s" message))
1857 ((and (stringp message)
1858 (= (string-match "\n" message) (1- (length message))))
1859 ;; Trivial case where we can just remove single trailing newline
1860 (message "%s" (substring message 0 (1- (length message)))))
1861 (t
1862 ;; General case
1863 (with-current-buffer
1864 (if (bufferp message)
1865 message
1866 (get-buffer-create (or buffer-name "*Message*")))
1867
1868 (unless (bufferp message)
1869 (erase-buffer)
1870 (insert message))
1871
1872 (let ((lines
1873 (if (= (buffer-size) 0)
1874 0
1875 (count-lines (point-min) (point-max)))))
4f017185
RS
1876 (cond ((= lines 0))
1877 ((and (or (<= lines 1)
aab5d2c5
RS
1878 (<= lines
1879 (if resize-mini-windows
1880 (cond ((floatp max-mini-window-height)
1881 (* (frame-height)
1882 max-mini-window-height))
1883 ((integerp max-mini-window-height)
1884 max-mini-window-height)
1885 (t
1886 1))
1887 1)))
1888 ;; Don't use the echo area if the output buffer is
1889 ;; already dispayed in the selected frame.
61b80ebf 1890 (not (get-buffer-window (current-buffer))))
f69aad2b
MB
1891 ;; Echo area
1892 (goto-char (point-max))
1893 (when (bolp)
1894 (backward-char 1))
1895 (message "%s" (buffer-substring (point-min) (point))))
1896 (t
1897 ;; Buffer
1898 (goto-char (point-min))
31252c00
MB
1899 (display-buffer (current-buffer)
1900 not-this-window frame))))))))
f69aad2b
MB
1901
1902
2076c87c
JB
1903;; We have a sentinel to prevent insertion of a termination message
1904;; in the buffer itself.
1905(defun shell-command-sentinel (process signal)
bcad4985 1906 (if (memq (process-status process) '(exit signal))
1e722f9f 1907 (message "%s: %s."
bcad4985
KH
1908 (car (cdr (cdr (process-command process))))
1909 (substring signal 0 -1))))
2076c87c 1910
d0d74413 1911(defun shell-command-on-region (start end command
cce1c318 1912 &optional output-buffer replace
63619f42 1913 error-buffer display-error-buffer)
2076c87c
JB
1914 "Execute string COMMAND in inferior shell with region as input.
1915Normally display output (if any) in temp buffer `*Shell Command Output*';
a0184aeb
DL
1916Prefix arg means replace the region with it. Return the exit code of
1917COMMAND.
56c0450e 1918
07f458c1
RS
1919To specify a coding system for converting non-ASCII characters
1920in the input and output to the shell command, use \\[universal-coding-system-argument]
1921before this command. By default, the input (from the current buffer)
1922is encoded in the same coding system that will be used to save the file,
1923`buffer-file-coding-system'. If the output is going to replace the region,
1924then it is decoded from that same coding system.
1925
63619f42
RS
1926The noninteractive arguments are START, END, COMMAND,
1927OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1928Noninteractive callers can specify coding systems by binding
1929`coding-system-for-read' and `coding-system-for-write'.
2076c87c 1930
2e033693
RS
1931If the command generates output, the output may be displayed
1932in the echo area or in a buffer.
1933If the output is short enough to display in the echo area
1934\(determined by the variable `max-mini-window-height' if
1935`resize-mini-windows' is non-nil), it is shown there. Otherwise
1936it is displayed in the buffer `*Shell Command Output*'. The output
1937is available in that buffer in both cases.
1938
1939If there is output and an error, a message about the error
1940appears at the end of the output.
1941
1942If there is no output, or if output is inserted in the current buffer,
1943then `*Shell Command Output*' is deleted.
d0d74413 1944
56c0450e
RS
1945If the optional fourth argument OUTPUT-BUFFER is non-nil,
1946that says to put the output in some other buffer.
d0d74413
RS
1947If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1948If OUTPUT-BUFFER is not a buffer and not nil,
1949insert output in the current buffer.
cce1c318
RS
1950In either case, the output is inserted after point (leaving mark after it).
1951
8923a211
RS
1952If REPLACE, the optional fifth argument, is non-nil, that means insert
1953the output in place of text from START to END, putting point and mark
1954around it.
1955
b735c991 1956If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
cce1c318 1957or buffer name to which to direct the command's standard error output.
7fd47839 1958If it is nil, error output is mingled with regular output.
63619f42
RS
1959If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
1960were any errors. (This is always t, interactively.)
cc039f78
KH
1961In an interactive call, the variable `shell-command-default-error-buffer'
1962specifies the value of ERROR-BUFFER."
195ce311
RS
1963 (interactive (let (string)
1964 (unless (mark)
1965 (error "The mark is not set now, so there is no region"))
1966 ;; Do this before calling region-beginning
1967 ;; and region-end, in case subprocess output
1968 ;; relocates them while we are in the minibuffer.
1969 (setq string (read-from-minibuffer "Shell command on region: "
1970 nil nil nil
1971 'shell-command-history))
2b03c506
RS
1972 ;; call-interactively recognizes region-beginning and
1973 ;; region-end specially, leaving them in the history.
1974 (list (region-beginning) (region-end)
cae49185
RS
1975 string
1976 current-prefix-arg
7fd47839 1977 current-prefix-arg
63619f42
RS
1978 shell-command-default-error-buffer
1979 t)))
cce1c318 1980 (let ((error-file
171a45d9 1981 (if error-buffer
b005abd5 1982 (make-temp-file
171a45d9
EZ
1983 (expand-file-name "scor"
1984 (or small-temporary-file-directory
1985 temporary-file-directory)))
a0184aeb
DL
1986 nil))
1987 exit-status)
7fd47839
RS
1988 (if (or replace
1989 (and output-buffer
748d6ca4 1990 (not (or (bufferp output-buffer) (stringp output-buffer)))))
7fd47839
RS
1991 ;; Replace specified region with output from command.
1992 (let ((swap (and replace (< start end))))
1993 ;; Don't muck with mark unless REPLACE says we should.
1994 (goto-char start)
30883773 1995 (and replace (push-mark (point) 'nomsg))
a0184aeb
DL
1996 (setq exit-status
1997 (call-process-region start end shell-file-name t
1998 (if error-file
1999 (list t error-file)
2000 t)
2001 nil shell-command-switch command))
e1e04350
SM
2002 ;; It is rude to delete a buffer which the command is not using.
2003 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2004 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2005 ;; (kill-buffer shell-buffer)))
7fd47839
RS
2006 ;; Don't muck with mark unless REPLACE says we should.
2007 (and replace swap (exchange-point-and-mark)))
2008 ;; No prefix argument: put the output in a temp buffer,
2009 ;; replacing its entire contents.
2010 (let ((buffer (get-buffer-create
d4bbcbb4 2011 (or output-buffer "*Shell Command Output*"))))
7fd47839
RS
2012 (unwind-protect
2013 (if (eq buffer (current-buffer))
2014 ;; If the input is the same buffer as the output,
2015 ;; delete everything but the specified region,
2016 ;; then replace that region with the output.
2017 (progn (setq buffer-read-only nil)
2018 (delete-region (max start end) (point-max))
2019 (delete-region (point-min) (min start end))
2020 (setq exit-status
2021 (call-process-region (point-min) (point-max)
1e722f9f 2022 shell-file-name t
7fd47839
RS
2023 (if error-file
2024 (list t error-file)
2025 t)
a0184aeb
DL
2026 nil shell-command-switch
2027 command)))
2028 ;; Clear the output buffer, then run the command with
2029 ;; output there.
c2e303c8
GM
2030 (let ((directory default-directory))
2031 (save-excursion
2032 (set-buffer buffer)
2033 (setq buffer-read-only nil)
2034 (if (not output-buffer)
2035 (setq default-directory directory))
2036 (erase-buffer)))
7fd47839
RS
2037 (setq exit-status
2038 (call-process-region start end shell-file-name nil
2039 (if error-file
2040 (list buffer error-file)
2041 buffer)
a0184aeb 2042 nil shell-command-switch command)))
2e033693 2043 ;; Report the output.
9a98fa64 2044 (with-current-buffer buffer
f1180544 2045 (setq mode-line-process
d4bbcbb4
AS
2046 (cond ((null exit-status)
2047 " - Error")
2048 ((stringp exit-status)
2049 (format " - Signal [%s]" exit-status))
2050 ((not (equal 0 exit-status))
2051 (format " - Exit [%d]" exit-status)))))
f69aad2b
MB
2052 (if (with-current-buffer buffer (> (point-max) (point-min)))
2053 ;; There's some output, display it
9a98fa64 2054 (display-message-or-buffer buffer)
f69aad2b 2055 ;; No output; error?
94ddbe6d
RS
2056 (let ((output
2057 (if (and error-file
2058 (< 0 (nth 7 (file-attributes error-file))))
2059 "some error output"
2060 "no output")))
d4bbcbb4
AS
2061 (cond ((null exit-status)
2062 (message "(Shell command failed with error)"))
2063 ((equal 0 exit-status)
2064 (message "(Shell command succeeded with %s)"
2065 output))
2066 ((stringp exit-status)
2067 (message "(Shell command killed by signal %s)"
2068 exit-status))
2069 (t
2070 (message "(Shell command failed with code %d and %s)"
2071 exit-status output))))
e1e04350
SM
2072 ;; Don't kill: there might be useful info in the undo-log.
2073 ;; (kill-buffer buffer)
2074 ))))
f69aad2b 2075
cc039f78
KH
2076 (when (and error-file (file-exists-p error-file))
2077 (if (< 0 (nth 7 (file-attributes error-file)))
2078 (with-current-buffer (get-buffer-create error-buffer)
2079 (let ((pos-from-end (- (point-max) (point))))
2080 (or (bobp)
2081 (insert "\f\n"))
2082 ;; Do no formatting while reading error file,
2083 ;; because that can run a shell command, and we
2084 ;; don't want that to cause an infinite recursion.
2085 (format-insert-file error-file nil)
2086 ;; Put point after the inserted errors.
2087 (goto-char (- (point-max) pos-from-end)))
63619f42
RS
2088 (and display-error-buffer
2089 (display-buffer (current-buffer)))))
cc039f78 2090 (delete-file error-file))
a0184aeb 2091 exit-status))
1e722f9f 2092
d589bd99
RS
2093(defun shell-command-to-string (command)
2094 "Execute shell command COMMAND and return its output as a string."
2095 (with-output-to-string
17cc9013
RS
2096 (with-current-buffer
2097 standard-output
2098 (call-process shell-file-name nil t nil shell-command-switch command))))
0457dd55
KG
2099
2100(defun process-file (program &optional infile buffer display &rest args)
2101 "Process files synchronously in a separate process.
2102Similar to `call-process', but may invoke a file handler based on
2103`default-directory'. The current working directory of the
2104subprocess is `default-directory'.
2105
2106File names in INFILE and BUFFER are handled normally, but file
2107names in ARGS should be relative to `default-directory', as they
2108are passed to the process verbatim. \(This is a difference to
2109`call-process' which does not support file handlers for INFILE
2110and BUFFER.\)
2111
2112Some file handlers might not support all variants, for example
2113they might behave as if DISPLAY was nil, regardless of the actual
2114value passed."
2115 (let ((fh (find-file-name-handler default-directory 'process-file))
2116 lc stderr-file)
2117 (unwind-protect
2118 (if fh (apply fh 'process-file program infile buffer display args)
8de40f9f 2119 (when infile (setq lc (file-local-copy infile)))
0457dd55 2120 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
85af630d
KG
2121 (make-temp-file "emacs")))
2122 (prog1
2123 (apply 'call-process program
2124 (or lc infile)
2125 (if stderr-file (list (car buffer) stderr-file) buffer)
2126 display args)
2127 (when stderr-file (copy-file stderr-file (cadr buffer)))))
0457dd55
KG
2128 (when stderr-file (delete-file stderr-file))
2129 (when lc (delete-file lc)))))
2130
2131
2d88b556 2132\f
1b43f83f 2133(defvar universal-argument-map
69d4c3c4
KH
2134 (let ((map (make-sparse-keymap)))
2135 (define-key map [t] 'universal-argument-other-key)
b9ff190d 2136 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
69d4c3c4
KH
2137 (define-key map [switch-frame] nil)
2138 (define-key map [?\C-u] 'universal-argument-more)
2139 (define-key map [?-] 'universal-argument-minus)
2140 (define-key map [?0] 'digit-argument)
2141 (define-key map [?1] 'digit-argument)
2142 (define-key map [?2] 'digit-argument)
2143 (define-key map [?3] 'digit-argument)
2144 (define-key map [?4] 'digit-argument)
2145 (define-key map [?5] 'digit-argument)
2146 (define-key map [?6] 'digit-argument)
2147 (define-key map [?7] 'digit-argument)
2148 (define-key map [?8] 'digit-argument)
2149 (define-key map [?9] 'digit-argument)
bd7acc8d
GM
2150 (define-key map [kp-0] 'digit-argument)
2151 (define-key map [kp-1] 'digit-argument)
2152 (define-key map [kp-2] 'digit-argument)
2153 (define-key map [kp-3] 'digit-argument)
2154 (define-key map [kp-4] 'digit-argument)
2155 (define-key map [kp-5] 'digit-argument)
2156 (define-key map [kp-6] 'digit-argument)
2157 (define-key map [kp-7] 'digit-argument)
2158 (define-key map [kp-8] 'digit-argument)
2159 (define-key map [kp-9] 'digit-argument)
2160 (define-key map [kp-subtract] 'universal-argument-minus)
69d4c3c4
KH
2161 map)
2162 "Keymap used while processing \\[universal-argument].")
2163
0de84e16
RS
2164(defvar universal-argument-num-events nil
2165 "Number of argument-specifying events read by `universal-argument'.
2166`universal-argument-other-key' uses this to discard those events
2167from (this-command-keys), and reread only the final command.")
2168
6904b34b
EZ
2169(defvar overriding-map-is-bound nil
2170 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2171
2172(defvar saved-overriding-map nil
2173 "The saved value of `overriding-terminal-local-map'.
2174That variable gets restored to this value on exiting \"universal
2175argument mode\".")
2176
2177(defun ensure-overriding-map-is-bound ()
2178 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2179 (unless overriding-map-is-bound
2180 (setq saved-overriding-map overriding-terminal-local-map)
2181 (setq overriding-terminal-local-map universal-argument-map)
2182 (setq overriding-map-is-bound t)))
2183
2184(defun restore-overriding-map ()
2185 "Restore `overriding-terminal-local-map' to its saved value."
2186 (setq overriding-terminal-local-map saved-overriding-map)
2187 (setq overriding-map-is-bound nil))
2188
e8d1a377
KH
2189(defun universal-argument ()
2190 "Begin a numeric argument for the following command.
2191Digits or minus sign following \\[universal-argument] make up the numeric argument.
2192\\[universal-argument] following the digits or minus sign ends the argument.
2193\\[universal-argument] without digits or minus sign provides 4 as argument.
2194Repeating \\[universal-argument] without digits or minus sign
0565d307
RS
2195 multiplies the argument by 4 each time.
2196For some commands, just \\[universal-argument] by itself serves as a flag
a697fc62
RS
2197which is different in effect from any particular numeric argument.
2198These commands include \\[set-mark-command] and \\[start-kbd-macro]."
69d4c3c4
KH
2199 (interactive)
2200 (setq prefix-arg (list 4))
0de84e16 2201 (setq universal-argument-num-events (length (this-command-keys)))
6904b34b 2202 (ensure-overriding-map-is-bound))
e8d1a377 2203
69d4c3c4
KH
2204;; A subsequent C-u means to multiply the factor by 4 if we've typed
2205;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2206(defun universal-argument-more (arg)
e8d1a377 2207 (interactive "P")
69d4c3c4
KH
2208 (if (consp arg)
2209 (setq prefix-arg (list (* 4 (car arg))))
1cd24721
RS
2210 (if (eq arg '-)
2211 (setq prefix-arg (list -4))
2212 (setq prefix-arg arg)
6904b34b 2213 (restore-overriding-map)))
0de84e16 2214 (setq universal-argument-num-events (length (this-command-keys))))
e8d1a377
KH
2215
2216(defun negative-argument (arg)
2217 "Begin a negative numeric argument for the next command.
2218\\[universal-argument] following digits or minus sign ends the argument."
2219 (interactive "P")
69d4c3c4
KH
2220 (cond ((integerp arg)
2221 (setq prefix-arg (- arg)))
2222 ((eq arg '-)
2223 (setq prefix-arg nil))
2224 (t
b9ff190d 2225 (setq prefix-arg '-)))
0de84e16 2226 (setq universal-argument-num-events (length (this-command-keys)))
6904b34b 2227 (ensure-overriding-map-is-bound))
69d4c3c4
KH
2228
2229(defun digit-argument (arg)
2230 "Part of the numeric argument for the next command.
2231\\[universal-argument] following digits or minus sign ends the argument."
2232 (interactive "P")
bd7acc8d
GM
2233 (let* ((char (if (integerp last-command-char)
2234 last-command-char
2235 (get last-command-char 'ascii-character)))
2236 (digit (- (logand char ?\177) ?0)))
69d4c3c4
KH
2237 (cond ((integerp arg)
2238 (setq prefix-arg (+ (* arg 10)
2239 (if (< arg 0) (- digit) digit))))
2240 ((eq arg '-)
2241 ;; Treat -0 as just -, so that -01 will work.
2242 (setq prefix-arg (if (zerop digit) '- (- digit))))
2243 (t
b9ff190d 2244 (setq prefix-arg digit))))
0de84e16 2245 (setq universal-argument-num-events (length (this-command-keys)))
6904b34b 2246 (ensure-overriding-map-is-bound))
69d4c3c4
KH
2247
2248;; For backward compatibility, minus with no modifiers is an ordinary
2249;; command if digits have already been entered.
2250(defun universal-argument-minus (arg)
2251 (interactive "P")
2252 (if (integerp arg)
2253 (universal-argument-other-key arg)
2254 (negative-argument arg)))
2255
2256;; Anything else terminates the argument and is left in the queue to be
2257;; executed as a command.
2258(defun universal-argument-other-key (arg)
2259 (interactive "P")
2260 (setq prefix-arg arg)
0de84e16
RS
2261 (let* ((key (this-command-keys))
2262 (keylist (listify-key-sequence key)))
2263 (setq unread-command-events
06697cdb
RS
2264 (append (nthcdr universal-argument-num-events keylist)
2265 unread-command-events)))
f0ef2555 2266 (reset-this-command-lengths)
6904b34b 2267 (restore-overriding-map))
2d88b556 2268\f
7fcce20f
RS
2269(defvar buffer-substring-filters nil
2270 "List of filter functions for `filter-buffer-substring'.
2271Each function must accept a single argument, a string, and return
2272a string. The buffer substring is passed to the first function
2273in the list, and the return value of each function is passed to
2274the next. The return value of the last function is used as the
2275return value of `filter-buffer-substring'.
2276
2277If this variable is nil, no filtering is performed.")
2278
2279(defun filter-buffer-substring (beg end &optional delete)
2280 "Return the buffer substring between BEG and END, after filtering.
2281The buffer substring is passed through each of the filter
2282functions in `buffer-substring-filters', and the value from the
2283last filter function is returned. If `buffer-substring-filters'
2284is nil, the buffer substring is returned unaltered.
2285
2286If DELETE is non-nil, the text between BEG and END is deleted
2287from the buffer.
2288
2cd16d74 2289Point is temporarily set to BEG before calling
7fcce20f
RS
2290`buffer-substring-filters', in case the functions need to know
2291where the text came from.
2292
2293This function should be used instead of `buffer-substring' or
2294`delete-and-extract-region' when you want to allow filtering to
2295take place. For example, major or minor modes can use
2296`buffer-substring-filters' to extract characters that are special
2297to a buffer, and should not be copied into other buffers."
2298 (save-excursion
2299 (goto-char beg)
2300 (let ((string (if delete (delete-and-extract-region beg end)
2301 (buffer-substring beg end))))
2302 (dolist (filter buffer-substring-filters string)
2303 (setq string (funcall filter string))))))
2304
93be67de 2305;;;; Window system cut and paste hooks.
70e14c01
JB
2306
2307(defvar interprogram-cut-function nil
2308 "Function to call to make a killed region available to other programs.
2309
2310Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2311pasting text between the windows of different programs.
2312This variable holds a function that Emacs calls whenever text
2313is put in the kill ring, to make the new kill available to other
70e14c01
JB
2314programs.
2315
9f112a3d
RS
2316The function takes one or two arguments.
2317The first argument, TEXT, is a string containing
2318the text which should be made available.
8e5d85ff
LT
2319The second, optional, argument PUSH, has the same meaning as the
2320similar argument to `x-set-cut-buffer', which see.")
70e14c01
JB
2321
2322(defvar interprogram-paste-function nil
2323 "Function to call to get text cut from other programs.
2324
2325Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2326pasting text between the windows of different programs.
2327This variable holds a function that Emacs calls to obtain
70e14c01
JB
2328text that other programs have provided for pasting.
2329
2330The function should be called with no arguments. If the function
2331returns nil, then no other program has provided such text, and the top
2332of the Emacs kill ring should be used. If the function returns a
8e5d85ff
LT
2333string, then the caller of the function \(usually `current-kill')
2334should put this string in the kill ring as the latest kill.
daa37602
JB
2335
2336Note that the function should return a string only if a program other
2337than Emacs has provided a string for pasting; if Emacs provided the
2338most recent string, the function should return nil. If it is
2339difficult to tell whether Emacs or some other program provided the
2340current string, it is probably good enough to return nil if the string
2341is equal (according to `string=') to the last text Emacs provided.")
2d88b556 2342\f
70e14c01 2343
eaae8106 2344
70e14c01 2345;;;; The kill ring data structure.
2076c87c
JB
2346
2347(defvar kill-ring nil
70e14c01
JB
2348 "List of killed text sequences.
2349Since the kill ring is supposed to interact nicely with cut-and-paste
2350facilities offered by window systems, use of this variable should
2351interact nicely with `interprogram-cut-function' and
2352`interprogram-paste-function'. The functions `kill-new',
2353`kill-append', and `current-kill' are supposed to implement this
2354interaction; you may want to use them instead of manipulating the kill
2355ring directly.")
2076c87c 2356
bffa4d92 2357(defcustom kill-ring-max 60
69c1dd37
RS
2358 "*Maximum length of kill ring before oldest elements are thrown away."
2359 :type 'integer
2360 :group 'killing)
2076c87c
JB
2361
2362(defvar kill-ring-yank-pointer nil
2363 "The tail of the kill ring whose car is the last thing yanked.")
2364
be5936a7 2365(defun kill-new (string &optional replace yank-handler)
70e14c01 2366 "Make STRING the latest kill in the kill ring.
3e505153 2367Set `kill-ring-yank-pointer' to point to it.
f914dc91
KH
2368If `interprogram-cut-function' is non-nil, apply it to STRING.
2369Optional second argument REPLACE non-nil means that STRING will replace
be5936a7
KS
2370the front of the kill ring, rather than being added to the list.
2371
2372Optional third arguments YANK-HANDLER controls how the STRING is later
f1180544 2373inserted into a buffer; see `insert-for-yank' for details.
2a262563 2374When a yank handler is specified, STRING must be non-empty (the yank
8e5d85ff 2375handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2a262563
KS
2376
2377When the yank handler has a non-nil PARAM element, the original STRING
2378argument is not used by `insert-for-yank'. However, since Lisp code
f33321ad 2379may access and use elements from the kill ring directly, the STRING
2a262563
KS
2380argument should still be a \"useful\" string for such uses."
2381 (if (> (length string) 0)
f1180544 2382 (if yank-handler
7e46b7bf
LT
2383 (put-text-property 0 (length string)
2384 'yank-handler yank-handler string))
2a262563 2385 (if yank-handler
f1180544 2386 (signal 'args-out-of-range
2a262563
KS
2387 (list string "yank-handler specified for empty string"))))
2388 (if (fboundp 'menu-bar-update-yank-menu)
2389 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
ab7e20d5 2390 (if (and replace kill-ring)
f914dc91
KH
2391 (setcar kill-ring string)
2392 (setq kill-ring (cons string kill-ring))
2393 (if (> (length kill-ring) kill-ring-max)
2394 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
70e14c01
JB
2395 (setq kill-ring-yank-pointer kill-ring)
2396 (if interprogram-cut-function
657a33ab 2397 (funcall interprogram-cut-function string (not replace))))
70e14c01 2398
be5936a7 2399(defun kill-append (string before-p &optional yank-handler)
70e14c01
JB
2400 "Append STRING to the end of the latest kill in the kill ring.
2401If BEFORE-P is non-nil, prepend STRING to the kill.
8e5d85ff
LT
2402Optional third argument YANK-HANDLER, if non-nil, specifies the
2403yank-handler text property to be set on the combined kill ring
2404string. If the specified yank-handler arg differs from the
2405yank-handler property of the latest kill string, this function
2406adds the combined string to the kill ring as a new element,
2407instead of replacing the last kill with it.
be5936a7
KS
2408If `interprogram-cut-function' is set, pass the resulting kill to it."
2409 (let* ((cur (car kill-ring)))
2410 (kill-new (if before-p (concat string cur) (concat cur string))
2411 (or (= (length cur) 0)
2412 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2413 yank-handler)))
70e14c01
JB
2414
2415(defun current-kill (n &optional do-not-move)
2416 "Rotate the yanking point by N places, and then return that kill.
2417If N is zero, `interprogram-paste-function' is set, and calling it
2418returns a string, then that string is added to the front of the
2419kill ring and returned as the latest kill.
1e722f9f 2420If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
70e14c01
JB
2421yanking point; just return the Nth kill forward."
2422 (let ((interprogram-paste (and (= n 0)
2423 interprogram-paste-function
2424 (funcall interprogram-paste-function))))
2425 (if interprogram-paste
2426 (progn
2427 ;; Disable the interprogram cut function when we add the new
2428 ;; text to the kill ring, so Emacs doesn't try to own the
2429 ;; selection, with identical text.
2430 (let ((interprogram-cut-function nil))
2431 (kill-new interprogram-paste))
2432 interprogram-paste)
2433 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
2434 (let ((ARGth-kill-element
2435 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2436 (length kill-ring))
2437 kill-ring)))
70e14c01
JB
2438 (or do-not-move
2439 (setq kill-ring-yank-pointer ARGth-kill-element))
2440 (car ARGth-kill-element)))))
c88ab9ce 2441
c88ab9ce 2442
eaae8106 2443
70e14c01 2444;;;; Commands for manipulating the kill ring.
c88ab9ce 2445
69c1dd37
RS
2446(defcustom kill-read-only-ok nil
2447 "*Non-nil means don't signal an error for killing read-only text."
2448 :type 'boolean
2449 :group 'killing)
e6291fe1 2450
3a5da8a8
RS
2451(put 'text-read-only 'error-conditions
2452 '(text-read-only buffer-read-only error))
2453(put 'text-read-only 'error-message "Text is read-only")
2454
be5936a7 2455(defun kill-region (beg end &optional yank-handler)
2076c87c
JB
2456 "Kill between point and mark.
2457The text is deleted but saved in the kill ring.
2458The command \\[yank] can retrieve it from there.
81558867
EZ
2459\(If you want to kill and then yank immediately, use \\[kill-ring-save].)
2460
2461If you want to append the killed region to the last killed text,
2462use \\[append-next-kill] before \\[kill-region].
2463
2aa7a8bf
JB
2464If the buffer is read-only, Emacs will beep and refrain from deleting
2465the text, but put the text in the kill ring anyway. This means that
2466you can use the killing commands to copy text from a read-only buffer.
2076c87c
JB
2467
2468This is the primitive for programs to kill text (as opposed to deleting it).
c15dc81f 2469Supply two arguments, character positions indicating the stretch of text
2076c87c
JB
2470 to be killed.
2471Any command that calls this function is a \"kill command\".
2472If the previous command was also a kill command,
2473the text killed this time appends to the text killed last time
be5936a7
KS
2474to make one entry in the kill ring.
2475
8e5d85ff
LT
2476In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2477specifies the yank-handler text property to be set on the killed
2478text. See `insert-for-yank'."
e761e42c 2479 (interactive "r")
ccd19b9f 2480 (condition-case nil
7fcce20f 2481 (let ((string (filter-buffer-substring beg end t)))
a1eb02bd
SM
2482 (when string ;STRING is nil if BEG = END
2483 ;; Add that string to the kill ring, one way or another.
2484 (if (eq last-command 'kill-region)
be5936a7
KS
2485 (kill-append string (< end beg) yank-handler)
2486 (kill-new string nil yank-handler)))
8a7cda9b 2487 (when (or string (eq last-command 'kill-region))
8e5d85ff
LT
2488 (setq this-command 'kill-region))
2489 nil)
ccd19b9f
KH
2490 ((buffer-read-only text-read-only)
2491 ;; The code above failed because the buffer, or some of the characters
2492 ;; in the region, are read-only.
2493 ;; We should beep, in case the user just isn't aware of this.
2494 ;; However, there's no harm in putting
2495 ;; the region's text in the kill ring, anyway.
2496 (copy-region-as-kill beg end)
cb3e1b4c
RS
2497 ;; Set this-command now, so it will be set even if we get an error.
2498 (setq this-command 'kill-region)
2499 ;; This should barf, if appropriate, and give us the correct error.
ccd19b9f 2500 (if kill-read-only-ok
8e5d85ff 2501 (progn (message "Read only text copied to kill ring") nil)
ccd19b9f
KH
2502 ;; Signal an error if the buffer is read-only.
2503 (barf-if-buffer-read-only)
2504 ;; If the buffer isn't read-only, the text is.
2505 (signal 'text-read-only (list (current-buffer)))))))
2076c87c 2506
a382890a
KH
2507;; copy-region-as-kill no longer sets this-command, because it's confusing
2508;; to get two copies of the text when the user accidentally types M-w and
2509;; then corrects it with the intended C-w.
2076c87c
JB
2510(defun copy-region-as-kill (beg end)
2511 "Save the region as if killed, but don't kill it.
0e264847 2512In Transient Mark mode, deactivate the mark.
46947372
JB
2513If `interprogram-cut-function' is non-nil, also save the text for a window
2514system cut and paste."
2076c87c
JB
2515 (interactive "r")
2516 (if (eq last-command 'kill-region)
7fcce20f
RS
2517 (kill-append (filter-buffer-substring beg end) (< end beg))
2518 (kill-new (filter-buffer-substring beg end)))
1e722f9f 2519 (if transient-mark-mode
5c7319b6 2520 (setq deactivate-mark t))
2076c87c
JB
2521 nil)
2522
2523(defun kill-ring-save (beg end)
0964e562 2524 "Save the region as if killed, but don't kill it.
0e264847 2525In Transient Mark mode, deactivate the mark.
0964e562 2526If `interprogram-cut-function' is non-nil, also save the text for a window
0e264847
RS
2527system cut and paste.
2528
81558867
EZ
2529If you want to append the killed line to the last killed text,
2530use \\[append-next-kill] before \\[kill-ring-save].
2531
0e264847
RS
2532This command is similar to `copy-region-as-kill', except that it gives
2533visual feedback indicating the extent of the region being copied."
2076c87c
JB
2534 (interactive "r")
2535 (copy-region-as-kill beg end)
bbf41690
RS
2536 ;; This use of interactive-p is correct
2537 ;; because the code it controls just gives the user visual feedback.
3a801d0c 2538 (if (interactive-p)
66050f10
RS
2539 (let ((other-end (if (= (point) beg) end beg))
2540 (opoint (point))
2541 ;; Inhibit quitting so we can make a quit here
2542 ;; look like a C-g typed as a command.
2543 (inhibit-quit t))
2544 (if (pos-visible-in-window-p other-end (selected-window))
977e2654
KS
2545 (unless (and transient-mark-mode
2546 (face-background 'region))
66050f10
RS
2547 ;; Swap point and mark.
2548 (set-marker (mark-marker) (point) (current-buffer))
2549 (goto-char other-end)
e4ef3e92 2550 (sit-for blink-matching-delay)
66050f10
RS
2551 ;; Swap back.
2552 (set-marker (mark-marker) other-end (current-buffer))
2553 (goto-char opoint)
2554 ;; If user quit, deactivate the mark
2555 ;; as C-g would as a command.
e4e593ae 2556 (and quit-flag mark-active
fcadf1c7 2557 (deactivate-mark)))
66050f10
RS
2558 (let* ((killed-text (current-kill 0))
2559 (message-len (min (length killed-text) 40)))
2560 (if (= (point) beg)
2561 ;; Don't say "killed"; that is misleading.
2562 (message "Saved text until \"%s\""
2563 (substring killed-text (- message-len)))
2564 (message "Saved text from \"%s\""
2565 (substring killed-text 0 message-len))))))))
2076c87c 2566
c75d4986
KH
2567(defun append-next-kill (&optional interactive)
2568 "Cause following command, if it kills, to append to previous kill.
2569The argument is used for internal purposes; do not supply one."
2570 (interactive "p")
2571 ;; We don't use (interactive-p), since that breaks kbd macros.
2572 (if interactive
2076c87c
JB
2573 (progn
2574 (setq this-command 'kill-region)
2575 (message "If the next command is a kill, it will append"))
2576 (setq last-command 'kill-region)))
cfb4f123 2577\f
93be67de 2578;; Yanking.
2076c87c 2579
cfb4f123
RS
2580;; This is actually used in subr.el but defcustom does not work there.
2581(defcustom yank-excluded-properties
be5936a7 2582 '(read-only invisible intangible field mouse-face help-echo local-map keymap
9e60c724 2583 yank-handler follow-link)
c6ff5a4c
LT
2584 "*Text properties to discard when yanking.
2585The value should be a list of text properties to discard or t,
2586which means to discard all text properties."
cfb4f123 2587 :type '(choice (const :tag "All" t) (repeat symbol))
c9f0110e 2588 :group 'killing
bf247b6e 2589 :version "22.1")
cfb4f123 2590
120de5bd 2591(defvar yank-window-start nil)
be5936a7 2592(defvar yank-undo-function nil
44f5a7b2
KS
2593 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2594Function is called with two parameters, START and END corresponding to
2595the value of the mark and point; it is guaranteed that START <= END.
2596Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
120de5bd 2597
8e5d85ff 2598(defun yank-pop (&optional arg)
ff1fbe3e
RS
2599 "Replace just-yanked stretch of killed text with a different stretch.
2600This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 2601At such a time, the region contains a stretch of reinserted
ff1fbe3e 2602previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
2603place a different stretch of killed text.
2604
2605With no argument, the previous kill is inserted.
ff1fbe3e
RS
2606With argument N, insert the Nth previous kill.
2607If N is negative, this is a more recent kill.
2076c87c
JB
2608
2609The sequence of kills wraps around, so that after the oldest one
a0e8eaa3
EZ
2610comes the newest one.
2611
2612When this command inserts killed text into the buffer, it honors
2613`yank-excluded-properties' and `yank-handler' as described in the
2614doc string for `insert-for-yank-1', which see."
2076c87c
JB
2615 (interactive "*p")
2616 (if (not (eq last-command 'yank))
2617 (error "Previous command was not a yank"))
2618 (setq this-command 'yank)
8e5d85ff 2619 (unless arg (setq arg 1))
3a5da8a8
RS
2620 (let ((inhibit-read-only t)
2621 (before (< (point) (mark t))))
8254897f
KS
2622 (if before
2623 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2624 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
be5936a7 2625 (setq yank-undo-function nil)
fd0f4056 2626 (set-marker (mark-marker) (point) (current-buffer))
cfb4f123 2627 (insert-for-yank (current-kill arg))
120de5bd
RS
2628 ;; Set the window start back where it was in the yank command,
2629 ;; if possible.
2630 (set-window-start (selected-window) yank-window-start t)
fd0f4056
RS
2631 (if before
2632 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2633 ;; It is cleaner to avoid activation, even though the command
2634 ;; loop would deactivate the mark because we inserted text.
2635 (goto-char (prog1 (mark t)
2636 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 2637 nil)
2076c87c
JB
2638
2639(defun yank (&optional arg)
2640 "Reinsert the last stretch of killed text.
2641More precisely, reinsert the stretch of killed text most recently
ff1fbe3e 2642killed OR yanked. Put point at end, and set mark at beginning.
d99f8496 2643With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
ff1fbe3e 2644With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c 2645text.
a0e8eaa3
EZ
2646
2647When this command inserts killed text into the buffer, it honors
2648`yank-excluded-properties' and `yank-handler' as described in the
2649doc string for `insert-for-yank-1', which see.
2650
2076c87c
JB
2651See also the command \\[yank-pop]."
2652 (interactive "*P")
120de5bd 2653 (setq yank-window-start (window-start))
456c617c
RS
2654 ;; If we don't get all the way thru, make last-command indicate that
2655 ;; for the following command.
2656 (setq this-command t)
2076c87c 2657 (push-mark (point))
cfb4f123
RS
2658 (insert-for-yank (current-kill (cond
2659 ((listp arg) 0)
8e5d85ff 2660 ((eq arg '-) -2)
cfb4f123 2661 (t (1- arg)))))
2076c87c 2662 (if (consp arg)
fd0f4056
RS
2663 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2664 ;; It is cleaner to avoid activation, even though the command
2665 ;; loop would deactivate the mark because we inserted text.
2666 (goto-char (prog1 (mark t)
2667 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c 2668 ;; If we do get all the way thru, make this-command indicate that.
be5936a7
KS
2669 (if (eq this-command t)
2670 (setq this-command 'yank))
0964e562 2671 nil)
70e14c01
JB
2672
2673(defun rotate-yank-pointer (arg)
2674 "Rotate the yanking point in the kill ring.
2675With argument, rotate that many kills forward (or backward, if negative)."
2676 (interactive "p")
2677 (current-kill arg))
2d88b556 2678\f
93be67de
KH
2679;; Some kill commands.
2680
2681;; Internal subroutine of delete-char
2682(defun kill-forward-chars (arg)
2683 (if (listp arg) (setq arg (car arg)))
2684 (if (eq arg '-) (setq arg -1))
2685 (kill-region (point) (forward-point arg)))
2686
2687;; Internal subroutine of backward-delete-char
2688(defun kill-backward-chars (arg)
2689 (if (listp arg) (setq arg (car arg)))
2690 (if (eq arg '-) (setq arg -1))
2691 (kill-region (point) (forward-point (- arg))))
2692
2693(defcustom backward-delete-char-untabify-method 'untabify
2694 "*The method for untabifying when deleting backward.
1e722f9f
SS
2695Can be `untabify' -- turn a tab to many spaces, then delete one space;
2696 `hungry' -- delete all whitespace, both tabs and spaces;
2697 `all' -- delete all whitespace, including tabs, spaces and newlines;
93be67de 2698 nil -- just delete one character."
1e722f9f 2699 :type '(choice (const untabify) (const hungry) (const all) (const nil))
03167a34 2700 :version "20.3"
93be67de
KH
2701 :group 'killing)
2702
2703(defun backward-delete-char-untabify (arg &optional killp)
2704 "Delete characters backward, changing tabs into spaces.
2705The exact behavior depends on `backward-delete-char-untabify-method'.
2706Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2707Interactively, ARG is the prefix arg (default 1)
2708and KILLP is t if a prefix arg was specified."
2709 (interactive "*p\nP")
2710 (when (eq backward-delete-char-untabify-method 'untabify)
2711 (let ((count arg))
2712 (save-excursion
2713 (while (and (> count 0) (not (bobp)))
2714 (if (= (preceding-char) ?\t)
2715 (let ((col (current-column)))
2716 (forward-char -1)
2717 (setq col (- col (current-column)))
f33321ad 2718 (insert-char ?\s col)
93be67de
KH
2719 (delete-char 1)))
2720 (forward-char -1)
2721 (setq count (1- count))))))
2722 (delete-backward-char
1e722f9f
SS
2723 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
2724 ((eq backward-delete-char-untabify-method 'all)
2725 " \t\n\r"))))
2726 (if skip
2727 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
93be67de
KH
2728 (point)))))
2729 (+ arg (if (zerop wh) 0 (1- wh))))
1e722f9f 2730 arg))
93be67de
KH
2731 killp))
2732
2733(defun zap-to-char (arg char)
2734 "Kill up to and including ARG'th occurrence of CHAR.
2735Case is ignored if `case-fold-search' is non-nil in the current buffer.
2736Goes backward if ARG is negative; error if CHAR not found."
e761e42c 2737 (interactive "p\ncZap to char: ")
93be67de
KH
2738 (kill-region (point) (progn
2739 (search-forward (char-to-string char) nil nil arg)
2740; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2741 (point))))
eaae8106 2742
93be67de
KH
2743;; kill-line and its subroutines.
2744
2745(defcustom kill-whole-line nil
2746 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2747 :type 'boolean
2748 :group 'killing)
2749
2750(defun kill-line (&optional arg)
2751 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2752With prefix argument, kill that many lines from point.
2753Negative arguments kill lines backward.
8be7408c 2754With zero argument, kills the text before point on the current line.
93be67de
KH
2755
2756When calling from a program, nil means \"no arg\",
2757a number counts as a prefix arg.
2758
2759To kill a whole line, when point is not at the beginning, type \
2760\\[beginning-of-line] \\[kill-line] \\[kill-line].
2761
2762If `kill-whole-line' is non-nil, then this command kills the whole line
2763including its terminating newline, when used at the beginning of a line
2764with no argument. As a consequence, you can always kill a whole line
d3f22784
EZ
2765by typing \\[beginning-of-line] \\[kill-line].
2766
81558867
EZ
2767If you want to append the killed line to the last killed text,
2768use \\[append-next-kill] before \\[kill-line].
2769
d3f22784
EZ
2770If the buffer is read-only, Emacs will beep and refrain from deleting
2771the line, but put the line in the kill ring anyway. This means that
1a534b89
RS
2772you can use this command to copy text from a read-only buffer.
2773\(If the variable `kill-read-only-ok' is non-nil, then this won't
2774even beep.)"
e761e42c 2775 (interactive "P")
93be67de
KH
2776 (kill-region (point)
2777 ;; It is better to move point to the other end of the kill
2778 ;; before killing. That way, in a read-only buffer, point
2779 ;; moves across the text that is copied to the kill ring.
2780 ;; The choice has no effect on undo now that undo records
2781 ;; the value of point from before the command was run.
2782 (progn
2783 (if arg
2784 (forward-visible-line (prefix-numeric-value arg))
2785 (if (eobp)
2786 (signal 'end-of-buffer nil))
5560dc5d
RS
2787 (let ((end
2788 (save-excursion
2789 (end-of-visible-line) (point))))
2790 (if (or (save-excursion
2c6a2254
RS
2791 ;; If trailing whitespace is visible,
2792 ;; don't treat it as nothing.
2793 (unless show-trailing-whitespace
2794 (skip-chars-forward " \t" end))
5560dc5d
RS
2795 (= (point) end))
2796 (and kill-whole-line (bolp)))
2797 (forward-visible-line 1)
2798 (goto-char end))))
93be67de
KH
2799 (point))))
2800
348de80b
KG
2801(defun kill-whole-line (&optional arg)
2802 "Kill current line.
6c770e38
LT
2803With prefix arg, kill that many lines starting from the current line.
2804If arg is negative, kill backward. Also kill the preceding newline.
01ba9662 2805\(This is meant to make \\[repeat] work well with negative arguments.\)
348de80b 2806If arg is zero, kill current line but exclude the trailing newline."
f8b0f284 2807 (interactive "p")
6c770e38
LT
2808 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2809 (signal 'end-of-buffer nil))
2810 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2811 (signal 'beginning-of-buffer nil))
2812 (unless (eq last-command 'kill-region)
2813 (kill-new "")
2814 (setq last-command 'kill-region))
348de80b 2815 (cond ((zerop arg)
6c770e38
LT
2816 ;; We need to kill in two steps, because the previous command
2817 ;; could have been a kill command, in which case the text
2818 ;; before point needs to be prepended to the current kill
2819 ;; ring entry and the text after point appended. Also, we
2820 ;; need to use save-excursion to avoid copying the same text
2821 ;; twice to the kill ring in read-only buffers.
2822 (save-excursion
2823 (kill-region (point) (progn (forward-visible-line 0) (point))))
348de80b
KG
2824 (kill-region (point) (progn (end-of-visible-line) (point))))
2825 ((< arg 0)
6c770e38
LT
2826 (save-excursion
2827 (kill-region (point) (progn (end-of-visible-line) (point))))
2828 (kill-region (point)
2829 (progn (forward-visible-line (1+ arg))
2830 (unless (bobp) (backward-char))
2831 (point))))
348de80b 2832 (t
6c770e38
LT
2833 (save-excursion
2834 (kill-region (point) (progn (forward-visible-line 0) (point))))
2835 (kill-region (point)
2836 (progn (forward-visible-line arg) (point))))))
12a93712 2837
93be67de
KH
2838(defun forward-visible-line (arg)
2839 "Move forward by ARG lines, ignoring currently invisible newlines only.
2840If ARG is negative, move backward -ARG lines.
2841If ARG is zero, move to the beginning of the current line."
2842 (condition-case nil
2843 (if (> arg 0)
12a93712
RS
2844 (progn
2845 (while (> arg 0)
93be67de 2846 (or (zerop (forward-line 1))
12a93712
RS
2847 (signal 'end-of-buffer nil))
2848 ;; If the newline we just skipped is invisible,
2849 ;; don't count it.
2850 (let ((prop
2851 (get-char-property (1- (point)) 'invisible)))
2852 (if (if (eq buffer-invisibility-spec t)
2853 prop
2854 (or (memq prop buffer-invisibility-spec)
2855 (assq prop buffer-invisibility-spec)))
2856 (setq arg (1+ arg))))
2857 (setq arg (1- arg)))
2858 ;; If invisible text follows, and it is a number of complete lines,
2859 ;; skip it.
2860 (let ((opoint (point)))
2861 (while (and (not (eobp))
2862 (let ((prop
2863 (get-char-property (point) 'invisible)))
2864 (if (eq buffer-invisibility-spec t)
2865 prop
2866 (or (memq prop buffer-invisibility-spec)
2867 (assq prop buffer-invisibility-spec)))))
2868 (goto-char
2869 (if (get-text-property (point) 'invisible)
2870 (or (next-single-property-change (point) 'invisible)
2871 (point-max))
2872 (next-overlay-change (point)))))
2873 (unless (bolp)
2874 (goto-char opoint))))
93be67de 2875 (let ((first t))
f5fd8833
JB
2876 (while (or first (<= arg 0))
2877 (if first
93be67de
KH
2878 (beginning-of-line)
2879 (or (zerop (forward-line -1))
2880 (signal 'beginning-of-buffer nil)))
12a93712
RS
2881 ;; If the newline we just moved to is invisible,
2882 ;; don't count it.
2883 (unless (bobp)
2884 (let ((prop
2885 (get-char-property (1- (point)) 'invisible)))
f5fd8833
JB
2886 (unless (if (eq buffer-invisibility-spec t)
2887 prop
2888 (or (memq prop buffer-invisibility-spec)
2889 (assq prop buffer-invisibility-spec)))
2890 (setq arg (1+ arg)))))
2891 (setq first nil))
12a93712
RS
2892 ;; If invisible text follows, and it is a number of complete lines,
2893 ;; skip it.
2894 (let ((opoint (point)))
93be67de
KH
2895 (while (and (not (bobp))
2896 (let ((prop
2897 (get-char-property (1- (point)) 'invisible)))
2898 (if (eq buffer-invisibility-spec t)
2899 prop
2900 (or (memq prop buffer-invisibility-spec)
2901 (assq prop buffer-invisibility-spec)))))
2902 (goto-char
2903 (if (get-text-property (1- (point)) 'invisible)
2904 (or (previous-single-property-change (point) 'invisible)
2905 (point-min))
12a93712
RS
2906 (previous-overlay-change (point)))))
2907 (unless (bolp)
2908 (goto-char opoint)))))
93be67de
KH
2909 ((beginning-of-buffer end-of-buffer)
2910 nil)))
70e14c01 2911
93be67de
KH
2912(defun end-of-visible-line ()
2913 "Move to end of current visible line."
2914 (end-of-line)
2915 ;; If the following character is currently invisible,
2916 ;; skip all characters with that same `invisible' property value,
2917 ;; then find the next newline.
2918 (while (and (not (eobp))
5560dc5d
RS
2919 (save-excursion
2920 (skip-chars-forward "^\n")
2921 (let ((prop
2922 (get-char-property (point) 'invisible)))
2923 (if (eq buffer-invisibility-spec t)
2924 prop
2925 (or (memq prop buffer-invisibility-spec)
2926 (assq prop buffer-invisibility-spec))))))
2927 (skip-chars-forward "^\n")
93be67de
KH
2928 (if (get-text-property (point) 'invisible)
2929 (goto-char (next-single-property-change (point) 'invisible))
2930 (goto-char (next-overlay-change (point))))
2931 (end-of-line)))
2d88b556 2932\f
2076c87c
JB
2933(defun insert-buffer (buffer)
2934 "Insert after point the contents of BUFFER.
2935Puts mark after the inserted text.
6cb6e7a2
GM
2936BUFFER may be a buffer or a buffer name.
2937
2938This function is meant for the user to run interactively.
1e96c007 2939Don't call it from programs: use `insert-buffer-substring' instead!"
c3d4f949 2940 (interactive
a3e7c391
FP
2941 (list
2942 (progn
2943 (barf-if-buffer-read-only)
2944 (read-buffer "Insert buffer: "
2945 (if (eq (selected-window) (next-window (selected-window)))
2946 (other-buffer (current-buffer))
2947 (window-buffer (next-window (selected-window))))
2948 t))))
1e96c007
SM
2949 (push-mark
2950 (save-excursion
2951 (insert-buffer-substring (get-buffer buffer))
2952 (point)))
1537a263 2953 nil)
2076c87c
JB
2954
2955(defun append-to-buffer (buffer start end)
2956 "Append to specified buffer the text of the region.
2957It is inserted into that buffer before its point.
2958
2959When calling from a program, give three arguments:
2960BUFFER (or buffer name), START and END.
2961START and END specify the portion of the current buffer to be copied."
70e14c01 2962 (interactive
5d771766 2963 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 2964 (region-beginning) (region-end)))
2076c87c
JB
2965 (let ((oldbuf (current-buffer)))
2966 (save-excursion
c069a480
GM
2967 (let* ((append-to (get-buffer-create buffer))
2968 (windows (get-buffer-window-list append-to t t))
2969 point)
2970 (set-buffer append-to)
2971 (setq point (point))
2972 (barf-if-buffer-read-only)
2973 (insert-buffer-substring oldbuf start end)
2974 (dolist (window windows)
2975 (when (= (window-point window) point)
2976 (set-window-point window (point))))))))
2076c87c
JB
2977
2978(defun prepend-to-buffer (buffer start end)
2979 "Prepend to specified buffer the text of the region.
2980It is inserted into that buffer after its point.
2981
2982When calling from a program, give three arguments:
2983BUFFER (or buffer name), START and END.
2984START and END specify the portion of the current buffer to be copied."
2985 (interactive "BPrepend to buffer: \nr")
2986 (let ((oldbuf (current-buffer)))
2987 (save-excursion
2988 (set-buffer (get-buffer-create buffer))
74399eac 2989 (barf-if-buffer-read-only)
2076c87c
JB
2990 (save-excursion
2991 (insert-buffer-substring oldbuf start end)))))
2992
2993(defun copy-to-buffer (buffer start end)
2994 "Copy to specified buffer the text of the region.
2995It is inserted into that buffer, replacing existing text there.
2996
2997When calling from a program, give three arguments:
2998BUFFER (or buffer name), START and END.
2999START and END specify the portion of the current buffer to be copied."
3000 (interactive "BCopy to buffer: \nr")
3001 (let ((oldbuf (current-buffer)))
3002 (save-excursion
3003 (set-buffer (get-buffer-create buffer))
74399eac 3004 (barf-if-buffer-read-only)
2076c87c
JB
3005 (erase-buffer)
3006 (save-excursion
3007 (insert-buffer-substring oldbuf start end)))))
2d88b556 3008\f
62d1c1fc
RM
3009(put 'mark-inactive 'error-conditions '(mark-inactive error))
3010(put 'mark-inactive 'error-message "The mark is not active now")
3011
0251bafb
RS
3012(defvar activate-mark-hook nil
3013 "Hook run when the mark becomes active.
3014It is also run at the end of a command, if the mark is active and
3015it is possible that the region may have changed")
3016
3017(defvar deactivate-mark-hook nil
3018 "Hook run when the mark becomes inactive.")
3019
af39530e 3020(defun mark (&optional force)
c7c8b31e 3021 "Return this buffer's mark value as integer; error if mark inactive.
af39530e 3022If optional argument FORCE is non-nil, access the mark value
c7c8b31e
RS
3023even if the mark is not currently active, and return nil
3024if there is no mark at all.
af39530e 3025
2076c87c
JB
3026If you are using this in an editing command, you are most likely making
3027a mistake; see the documentation of `set-mark'."
0e3a7b14 3028 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
af39530e 3029 (marker-position (mark-marker))
62d1c1fc 3030 (signal 'mark-inactive nil)))
2076c87c 3031
19d35374
RM
3032;; Many places set mark-active directly, and several of them failed to also
3033;; run deactivate-mark-hook. This shorthand should simplify.
3034(defsubst deactivate-mark ()
3035 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 3036\(That makes a difference only in Transient Mark mode.)
19d35374 3037Also runs the hook `deactivate-mark-hook'."
868c2f49
KS
3038 (cond
3039 ((eq transient-mark-mode 'lambda)
3040 (setq transient-mark-mode nil))
3041 (transient-mark-mode
3042 (setq mark-active nil)
3043 (run-hooks 'deactivate-mark-hook))))
19d35374 3044
2076c87c
JB
3045(defun set-mark (pos)
3046 "Set this buffer's mark to POS. Don't use this function!
3047That is to say, don't use this function unless you want
3048the user to see that the mark has moved, and you want the previous
3049mark position to be lost.
3050
3051Normally, when a new mark is set, the old one should go on the stack.
f59006cb 3052This is why most applications should use `push-mark', not `set-mark'.
2076c87c 3053
ff1fbe3e 3054Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3055purposes. The mark saves a location for the user's convenience.
3056Most editing commands should not alter the mark.
3057To remember a location for internal use in the Lisp program,
3058store it in a Lisp variable. Example:
3059
3060 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3061
fcadf1c7
RS
3062 (if pos
3063 (progn
3064 (setq mark-active t)
3065 (run-hooks 'activate-mark-hook)
3066 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
3067 ;; Normally we never clear mark-active except in Transient Mark mode.
3068 ;; But when we actually clear out the mark value too,
3069 ;; we must clear mark-active in any mode.
3070 (setq mark-active nil)
3071 (run-hooks 'deactivate-mark-hook)
3072 (set-marker (mark-marker) nil)))
2076c87c
JB
3073
3074(defvar mark-ring nil
e55e2267 3075 "The list of former marks of the current buffer, most recent first.")
2076c87c 3076(make-variable-buffer-local 'mark-ring)
e55e2267 3077(put 'mark-ring 'permanent-local t)
2076c87c 3078
69c1dd37
RS
3079(defcustom mark-ring-max 16
3080 "*Maximum size of mark ring. Start discarding off end if gets this big."
3081 :type 'integer
3082 :group 'editing-basics)
2076c87c 3083
dc029f0b
RM
3084(defvar global-mark-ring nil
3085 "The list of saved global marks, most recent first.")
3086
69c1dd37 3087(defcustom global-mark-ring-max 16
dc029f0b 3088 "*Maximum size of global mark ring. \
69c1dd37
RS
3089Start discarding off end if gets this big."
3090 :type 'integer
3091 :group 'editing-basics)
dc029f0b 3092
868c2f49
KS
3093(defun pop-to-mark-command ()
3094 "Jump to mark, and pop a new position for mark off the ring
3095\(does not affect global mark ring\)."
3096 (interactive)
3097 (if (null (mark t))
3098 (error "No mark set in this buffer")
868c2f49
KS
3099 (goto-char (mark t))
3100 (pop-mark)))
3101
d00ffe21 3102(defun push-mark-command (arg &optional nomsg)
868c2f49 3103 "Set mark at where point is.
d00ffe21
KS
3104If no prefix arg and mark is already set there, just activate it.
3105Display `Mark set' unless the optional second arg NOMSG is non-nil."
868c2f49
KS
3106 (interactive "P")
3107 (let ((mark (marker-position (mark-marker))))
3108 (if (or arg (null mark) (/= mark (point)))
d00ffe21 3109 (push-mark nil nomsg t)
868c2f49 3110 (setq mark-active t)
0251bafb 3111 (run-hooks 'activate-mark-hook)
d00ffe21
KS
3112 (unless nomsg
3113 (message "Mark activated")))))
868c2f49 3114
2076c87c
JB
3115(defun set-mark-command (arg)
3116 "Set mark at where point is, or jump to mark.
66ef2df9
KS
3117With no prefix argument, set mark, and push old mark position on local
3118mark ring; also push mark on global mark ring if last mark was set in
3119another buffer. Immediately repeating the command activates
3120`transient-mark-mode' temporarily.
3121
3122With argument, e.g. \\[universal-argument] \\[set-mark-command], \
3123jump to mark, and pop a new position
3124for mark off the local mark ring \(this does not affect the global
3125mark ring\). Use \\[pop-global-mark] to jump to a mark off the global
3126mark ring \(see `pop-global-mark'\).
18c5df40 3127
de02e8b4
KS
3128Repeating the \\[set-mark-command] command without the prefix jumps to
3129the next position off the local (or global) mark ring.
66ef2df9
KS
3130
3131With a double \\[universal-argument] prefix argument, e.g. \\[universal-argument] \
3132\\[universal-argument] \\[set-mark-command], unconditionally
3133set mark where point is.
2076c87c 3134
ff1fbe3e 3135Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3136purposes. See the documentation of `set-mark' for more information."
3137 (interactive "P")
868c2f49
KS
3138 (if (eq transient-mark-mode 'lambda)
3139 (setq transient-mark-mode nil))
3140 (cond
18c5df40
KS
3141 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3142 (push-mark-command nil))
868c2f49 3143 ((not (eq this-command 'set-mark-command))
1841f9e3
KS
3144 (if arg
3145 (pop-to-mark-command)
3146 (push-mark-command t)))
868c2f49 3147 ((eq last-command 'pop-to-mark-command)
66ef2df9
KS
3148 (setq this-command 'pop-to-mark-command)
3149 (pop-to-mark-command))
de02e8b4 3150 ((and (eq last-command 'pop-global-mark) (not arg))
66ef2df9
KS
3151 (setq this-command 'pop-global-mark)
3152 (pop-global-mark))
868c2f49 3153 (arg
1841f9e3 3154 (setq this-command 'pop-to-mark-command)
868c2f49
KS
3155 (pop-to-mark-command))
3156 ((and (eq last-command 'set-mark-command)
3157 mark-active (null transient-mark-mode))
3158 (setq transient-mark-mode 'lambda)
3159 (message "Transient-mark-mode temporarily enabled"))
3160 (t
3161 (push-mark-command nil))))
2076c87c 3162
fd0f4056 3163(defun push-mark (&optional location nomsg activate)
2076c87c 3164 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
3165If the last global mark pushed was not in the current buffer,
3166also push LOCATION on the global mark ring.
fd0f4056 3167Display `Mark set' unless the optional second arg NOMSG is non-nil.
8cdc660f 3168In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2076c87c 3169
ff1fbe3e 3170Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
3171purposes. See the documentation of `set-mark' for more information.
3172
3173In Transient Mark mode, this does not activate the mark."
1a0d0b6a 3174 (unless (null (mark t))
2076c87c 3175 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1a0d0b6a
JPW
3176 (when (> (length mark-ring) mark-ring-max)
3177 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3178 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
9a1277dd 3179 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 3180 ;; Now push the mark on the global mark ring.
f1382a3d 3181 (if (and global-mark-ring
e08d3f7c 3182 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
3183 ;; The last global mark pushed was in this same buffer.
3184 ;; Don't push another one.
3185 nil
3186 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1a0d0b6a
JPW
3187 (when (> (length global-mark-ring) global-mark-ring-max)
3188 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3189 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
efcf38c7 3190 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2076c87c 3191 (message "Mark set"))
8cdc660f
RS
3192 (if (or activate (not transient-mark-mode))
3193 (set-mark (mark t)))
2076c87c
JB
3194 nil)
3195
3196(defun pop-mark ()
3197 "Pop off mark ring into the buffer's actual mark.
3198Does not set point. Does nothing if mark ring is empty."
1a0d0b6a
JPW
3199 (when mark-ring
3200 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3201 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1a0d0b6a
JPW
3202 (move-marker (car mark-ring) nil)
3203 (if (null (mark t)) (ding))
0137bae6
JL
3204 (setq mark-ring (cdr mark-ring)))
3205 (deactivate-mark))
2076c87c 3206
e462e42f 3207(defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
868c2f49 3208(defun exchange-point-and-mark (&optional arg)
af39530e
RS
3209 "Put the mark where point is now, and point where the mark is now.
3210This command works even when the mark is not active,
868c2f49
KS
3211and it reactivates the mark.
3212With prefix arg, `transient-mark-mode' is enabled temporarily."
3213 (interactive "P")
3214 (if arg
f1180544 3215 (if mark-active
868c2f49
KS
3216 (if (null transient-mark-mode)
3217 (setq transient-mark-mode 'lambda))
3218 (setq arg nil)))
3219 (unless arg
3220 (let ((omark (mark t)))
3221 (if (null omark)
3222 (error "No mark set in this buffer"))
3223 (set-mark (point))
3224 (goto-char omark)
3225 nil)))
e23c2c21 3226
6710df48 3227(define-minor-mode transient-mark-mode
e23c2c21 3228 "Toggle Transient Mark mode.
b411b5fa 3229With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 3230
5dd1220d
RS
3231In Transient Mark mode, when the mark is active, the region is highlighted.
3232Changing the buffer \"deactivates\" the mark.
3233So do certain other operations that set the mark
3234but whose main purpose is something else--for example,
cfa70244
EZ
3235incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
3236
8e843bc4
EZ
3237You can also deactivate the mark by typing \\[keyboard-quit] or
3238\\[keyboard-escape-quit].
1465c66b 3239
cfa70244
EZ
3240Many commands change their behavior when Transient Mark mode is in effect
3241and the mark is active, by acting on the region instead of their usual
4c5f7215 3242default part of the buffer's text. Examples of such commands include
705a5933
JL
3243\\[comment-dwim], \\[flush-lines], \\[keep-lines], \
3244\\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
3245Invoke \\[apropos-documentation] and type \"transient\" or
3246\"mark.*active\" at the prompt, to see the documentation of
3247commands which are sensitive to the Transient Mark mode."
82dc968c 3248 :global t :group 'editing-basics :require nil)
dc029f0b 3249
d0c4882d
RS
3250(defvar widen-automatically t
3251 "Non-nil means it is ok for commands to call `widen' when they want to.
3252Some commands will do this in order to go to positions outside
3253the current accessible part of the buffer.
3254
3255If `widen-automatically' is nil, these commands will do something else
3256as a fallback, and won't change the buffer bounds.")
3257
dc029f0b
RM
3258(defun pop-global-mark ()
3259 "Pop off global mark ring and jump to the top location."
3260 (interactive)
52b6d445
RS
3261 ;; Pop entries which refer to non-existent buffers.
3262 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3263 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
3264 (or global-mark-ring
3265 (error "No global mark set"))
3266 (let* ((marker (car global-mark-ring))
3267 (buffer (marker-buffer marker))
3268 (position (marker-position marker)))
34c31301
RS
3269 (setq global-mark-ring (nconc (cdr global-mark-ring)
3270 (list (car global-mark-ring))))
dc029f0b
RM
3271 (set-buffer buffer)
3272 (or (and (>= position (point-min))
3273 (<= position (point-max)))
d0c4882d 3274 (if widen-automatically
60aee8b2
RS
3275 (widen)
3276 (error "Global mark position is outside accessible part of buffer")))
dc029f0b
RM
3277 (goto-char position)
3278 (switch-to-buffer buffer)))
2d88b556 3279\f
95791033 3280(defcustom next-line-add-newlines nil
69c1dd37
RS
3281 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3282 :type 'boolean
e1d6e383 3283 :version "21.1"
69c1dd37 3284 :group 'editing-basics)
38ebcf29 3285
295f6616 3286(defun next-line (&optional arg try-vscroll)
2076c87c 3287 "Move cursor vertically down ARG lines.
295f6616 3288Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
3289If there is no character in the target line exactly under the current column,
3290the cursor is positioned after the character in that line which spans this
3291column, or at the end of the line if it is not long enough.
38ebcf29 3292If there is no line in the buffer after this one, behavior depends on the
1a2c3941
RS
3293value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3294to create a line, and moves the cursor to that line. Otherwise it moves the
e47d38f6 3295cursor to the end of the buffer.
2076c87c
JB
3296
3297The command \\[set-goal-column] can be used to create
85969cb1
RS
3298a semipermanent goal column for this command.
3299Then instead of trying to move exactly vertically (or as close as possible),
3300this command moves to the specified goal column (or as close as possible).
3301The goal column is stored in the variable `goal-column', which is nil
3302when there is no goal column.
2076c87c
JB
3303
3304If you are thinking of using this in a Lisp program, consider
3305using `forward-line' instead. It is usually easier to use
3306and more reliable (no dependence on goal column, etc.)."
295f6616 3307 (interactive "p\np")
b82d844f 3308 (or arg (setq arg 1))
028922cf 3309 (if (and next-line-add-newlines (= arg 1))
207d7545
GM
3310 (if (save-excursion (end-of-line) (eobp))
3311 ;; When adding a newline, don't expand an abbrev.
3312 (let ((abbrev-mode nil))
24886813
GM
3313 (end-of-line)
3314 (insert "\n"))
295f6616 3315 (line-move arg nil nil try-vscroll))
1a2c3941
RS
3316 (if (interactive-p)
3317 (condition-case nil
295f6616 3318 (line-move arg nil nil try-vscroll)
1a2c3941 3319 ((beginning-of-buffer end-of-buffer) (ding)))
295f6616 3320 (line-move arg nil nil try-vscroll)))
2076c87c
JB
3321 nil)
3322
295f6616 3323(defun previous-line (&optional arg try-vscroll)
2076c87c 3324 "Move cursor vertically up ARG lines.
295f6616 3325Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
3326If there is no character in the target line exactly over the current column,
3327the cursor is positioned after the character in that line which spans this
3328column, or at the end of the line if it is not long enough.
3329
3330The command \\[set-goal-column] can be used to create
85969cb1
RS
3331a semipermanent goal column for this command.
3332Then instead of trying to move exactly vertically (or as close as possible),
3333this command moves to the specified goal column (or as close as possible).
3334The goal column is stored in the variable `goal-column', which is nil
3335when there is no goal column.
2076c87c
JB
3336
3337If you are thinking of using this in a Lisp program, consider using
c2e8a012 3338`forward-line' with a negative argument instead. It is usually easier
2076c87c 3339to use and more reliable (no dependence on goal column, etc.)."
295f6616 3340 (interactive "p\np")
b82d844f 3341 (or arg (setq arg 1))
1a2c3941
RS
3342 (if (interactive-p)
3343 (condition-case nil
295f6616 3344 (line-move (- arg) nil nil try-vscroll)
1a2c3941 3345 ((beginning-of-buffer end-of-buffer) (ding)))
295f6616 3346 (line-move (- arg) nil nil try-vscroll))
2076c87c 3347 nil)
eaae8106 3348
69c1dd37 3349(defcustom track-eol nil
2076c87c
JB
3350 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3351This means moving to the end of each line moved onto.
69c1dd37
RS
3352The beginning of a blank line does not count as the end of a line."
3353 :type 'boolean
3354 :group 'editing-basics)
3355
3356(defcustom goal-column nil
3357 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
3358 :type '(choice integer
3359 (const :tag "None" nil))
3360 :group 'editing-basics)
912c6728 3361(make-variable-buffer-local 'goal-column)
2076c87c
JB
3362
3363(defvar temporary-goal-column 0
3364 "Current goal column for vertical motion.
3365It is the column where point was
3366at the start of current run of vertical motion commands.
c637ae6f 3367When the `track-eol' feature is doing its job, the value is 9999.")
2076c87c 3368
bbf41690 3369(defcustom line-move-ignore-invisible t
098fc1fb 3370 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
69c1dd37
RS
3371Outline mode sets this."
3372 :type 'boolean
3373 :group 'editing-basics)
098fc1fb 3374
bbf41690 3375(defun line-move-invisible-p (pos)
af894fc9
RS
3376 "Return non-nil if the character after POS is currently invisible."
3377 (let ((prop
3378 (get-char-property pos 'invisible)))
3379 (if (eq buffer-invisibility-spec t)
3380 prop
3381 (or (memq prop buffer-invisibility-spec)
3382 (assq prop buffer-invisibility-spec)))))
3383
03ceda9e
RS
3384;; This is like line-move-1 except that it also performs
3385;; vertical scrolling of tall images if appropriate.
3386;; That is not really a clean thing to do, since it mixes
3387;; scrolling with cursor motion. But so far we don't have
3388;; a cleaner solution to the problem of making C-n do something
3389;; useful given a tall image.
ed02c1db 3390(defun line-move (arg &optional noerror to-end try-vscroll)
295f6616 3391 (if (and auto-window-vscroll try-vscroll
03ceda9e 3392 ;; But don't vscroll in a keyboard macro.
295f6616
KS
3393 (not defining-kbd-macro)
3394 (not executing-kbd-macro))
16c2f92f 3395 (let ((forward (> arg 0))
257a694c
KS
3396 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3397 (if (and (consp part)
0fc367df 3398 (> (if forward (cdr part) (car part)) 0))
16c2f92f
KS
3399 (set-window-vscroll nil
3400 (if forward
3401 (+ (window-vscroll nil t)
0fc367df 3402 (min (cdr part)
16c2f92f
KS
3403 (* (frame-char-height) arg)))
3404 (max 0
3405 (- (window-vscroll nil t)
0fc367df 3406 (min (car part)
16c2f92f
KS
3407 (* (frame-char-height) (- arg))))))
3408 t)
3409 (set-window-vscroll nil 0)
ed02c1db 3410 (when (line-move-1 arg noerror to-end)
0fc367df 3411 (when (not forward)
98f4a29e
KS
3412 ;; Update display before calling pos-visible-in-window-p,
3413 ;; because it depends on window-start being up-to-date.
0fc367df 3414 (sit-for 0)
03ceda9e
RS
3415 ;; If the current line is partly hidden at the bottom,
3416 ;; scroll it partially up so as to unhide the bottom.
0fc367df
KS
3417 (if (and (setq part (nth 2 (pos-visible-in-window-p
3418 (line-beginning-position) nil t)))
3419 (> (cdr part) 0))
3420 (set-window-vscroll nil (cdr part) t)))
ed02c1db 3421 t)))
16c2f92f
KS
3422 (line-move-1 arg noerror to-end)))
3423
8c745744
RS
3424;; This is the guts of next-line and previous-line.
3425;; Arg says how many lines to move.
bbf41690 3426;; The value is t if we can move the specified number of lines.
16c2f92f 3427(defun line-move-1 (arg &optional noerror to-end)
2596511d
RS
3428 ;; Don't run any point-motion hooks, and disregard intangibility,
3429 ;; for intermediate positions.
3430 (let ((inhibit-point-motion-hooks t)
3431 (opoint (point))
c6db81aa 3432 (forward (> arg 0)))
2596511d
RS
3433 (unwind-protect
3434 (progn
41d22ee0 3435 (if (not (memq last-command '(next-line previous-line)))
2596511d
RS
3436 (setq temporary-goal-column
3437 (if (and track-eol (eolp)
3438 ;; Don't count beg of empty line as end of line
3439 ;; unless we just did explicit end-of-line.
3440 (or (not (bolp)) (eq last-command 'end-of-line)))
3441 9999
3442 (current-column))))
bbf41690 3443
2596511d
RS
3444 (if (and (not (integerp selective-display))
3445 (not line-move-ignore-invisible))
3446 ;; Use just newline characters.
e9cd25fe 3447 ;; Set ARG to 0 if we move as many lines as requested.
2596511d
RS
3448 (or (if (> arg 0)
3449 (progn (if (> arg 1) (forward-line (1- arg)))
3450 ;; This way of moving forward ARG lines
3451 ;; verifies that we have a newline after the last one.
3452 ;; It doesn't get confused by intangible text.
3453 (end-of-line)
e9cd25fe
RS
3454 (if (zerop (forward-line 1))
3455 (setq arg 0)))
2596511d 3456 (and (zerop (forward-line arg))
e9cd25fe
RS
3457 (bolp)
3458 (setq arg 0)))
bbf41690
RS
3459 (unless noerror
3460 (signal (if (< arg 0)
3461 'beginning-of-buffer
3462 'end-of-buffer)
3463 nil)))
2596511d 3464 ;; Move by arg lines, but ignore invisible ones.
bbf41690
RS
3465 (let (done)
3466 (while (and (> arg 0) (not done))
3467 ;; If the following character is currently invisible,
3468 ;; skip all characters with that same `invisible' property value.
3469 (while (and (not (eobp)) (line-move-invisible-p (point)))
3470 (goto-char (next-char-property-change (point))))
3471 ;; Now move a line.
3472 (end-of-line)
e9ab825f 3473 ;; If there's no invisibility here, move over the newline.
3e43ae87
KS
3474 (cond
3475 ((eobp)
3476 (if (not noerror)
3477 (signal 'end-of-buffer nil)
3478 (setq done t)))
3479 ((and (> arg 1) ;; Use vertical-motion for last move
3480 (not (integerp selective-display))
3481 (not (line-move-invisible-p (point))))
3482 ;; We avoid vertical-motion when possible
3483 ;; because that has to fontify.
3484 (forward-line 1))
3485 ;; Otherwise move a more sophisticated way.
3486 ((zerop (vertical-motion 1))
3487 (if (not noerror)
3488 (signal 'end-of-buffer nil)
3489 (setq done t))))
bbf41690
RS
3490 (unless done
3491 (setq arg (1- arg))))
22c8bff1 3492 ;; The logic of this is the same as the loop above,
e9ab825f 3493 ;; it just goes in the other direction.
bbf41690
RS
3494 (while (and (< arg 0) (not done))
3495 (beginning-of-line)
3e43ae87
KS
3496 (cond
3497 ((bobp)
3498 (if (not noerror)
3499 (signal 'beginning-of-buffer nil)
3500 (setq done t)))
3501 ((and (< arg -1) ;; Use vertical-motion for last move
3502 (not (integerp selective-display))
3503 (not (line-move-invisible-p (1- (point)))))
3504 (forward-line -1))
3505 ((zerop (vertical-motion -1))
3506 (if (not noerror)
3507 (signal 'beginning-of-buffer nil)
3508 (setq done t))))
bbf41690
RS
3509 (unless done
3510 (setq arg (1+ arg))
3511 (while (and ;; Don't move over previous invis lines
3512 ;; if our target is the middle of this line.
3513 (or (zerop (or goal-column temporary-goal-column))
3514 (< arg 0))
3515 (not (bobp)) (line-move-invisible-p (1- (point))))
3516 (goto-char (previous-char-property-change (point))))))))
3517 ;; This is the value the function returns.
3518 (= arg 0))
af894fc9 3519
e9cd25fe
RS
3520 (cond ((> arg 0)
3521 ;; If we did not move down as far as desired,
3522 ;; at least go to end of line.
3523 (end-of-line))
3524 ((< arg 0)
f9872a6b
JL
3525 ;; If we did not move up as far as desired,
3526 ;; at least go to beginning of line.
e9cd25fe
RS
3527 (beginning-of-line))
3528 (t
20782abb
RS
3529 (line-move-finish (or goal-column temporary-goal-column)
3530 opoint forward))))))
2076c87c 3531
20782abb 3532(defun line-move-finish (column opoint forward)
af894fc9
RS
3533 (let ((repeat t))
3534 (while repeat
3535 ;; Set REPEAT to t to repeat the whole thing.
3536 (setq repeat nil)
3537
1f980920 3538 (let (new
af894fc9 3539 (line-beg (save-excursion (beginning-of-line) (point)))
1f980920
RS
3540 (line-end
3541 ;; Compute the end of the line
20782abb 3542 ;; ignoring effectively invisible newlines.
bbf41690 3543 (save-excursion
20782abb
RS
3544 (end-of-line)
3545 (while (and (not (eobp)) (line-move-invisible-p (point)))
3546 (goto-char (next-char-property-change (point)))
bbf41690
RS
3547 (end-of-line))
3548 (point))))
1f980920
RS
3549
3550 ;; Move to the desired column.
3551 (line-move-to-column column)
3552 (setq new (point))
af894fc9
RS
3553
3554 ;; Process intangibility within a line.
3555 ;; Move to the chosen destination position from above,
3556 ;; with intangibility processing enabled.
3557
3558 (goto-char (point-min))
3559 (let ((inhibit-point-motion-hooks nil))
3560 (goto-char new)
3561
3562 ;; If intangibility moves us to a different (later) place
3563 ;; in the same line, use that as the destination.
3564 (if (<= (point) line-end)
1f980920
RS
3565 (setq new (point))
3566 ;; If that position is "too late",
3567 ;; try the previous allowable position.
3568 ;; See if it is ok.
3569 (backward-char)
20782abb
RS
3570 (if (if forward
3571 ;; If going forward, don't accept the previous
3572 ;; allowable position if it is before the target line.
f1e2a033 3573 (< line-beg (point))
20782abb
RS
3574 ;; If going backward, don't accept the previous
3575 ;; allowable position if it is still after the target line.
3576 (<= (point) line-end))
1f980920
RS
3577 (setq new (point))
3578 ;; As a last resort, use the end of the line.
3579 (setq new line-end))))
af894fc9
RS
3580
3581 ;; Now move to the updated destination, processing fields
3582 ;; as well as intangibility.
3583 (goto-char opoint)
3584 (let ((inhibit-point-motion-hooks nil))
3585 (goto-char
3586 (constrain-to-field new opoint nil t
3587 'inhibit-line-move-field-capture)))
3588
1f980920 3589 ;; If all this moved us to a different line,
af894fc9
RS
3590 ;; retry everything within that new line.
3591 (when (or (< (point) line-beg) (> (point) line-end))
3592 ;; Repeat the intangibility and field processing.
3593 (setq repeat t))))))
3594
3595(defun line-move-to-column (col)
3596 "Try to find column COL, considering invisibility.
3597This function works only in certain cases,
3598because what we really need is for `move-to-column'
3599and `current-column' to be able to ignore invisible text."
a615252b
RS
3600 (if (zerop col)
3601 (beginning-of-line)
3602 (move-to-column col))
af894fc9
RS
3603
3604 (when (and line-move-ignore-invisible
bbf41690 3605 (not (bolp)) (line-move-invisible-p (1- (point))))
af894fc9
RS
3606 (let ((normal-location (point))
3607 (normal-column (current-column)))
3608 ;; If the following character is currently invisible,
3609 ;; skip all characters with that same `invisible' property value.
3610 (while (and (not (eobp))
bbf41690 3611 (line-move-invisible-p (point)))
af894fc9
RS
3612 (goto-char (next-char-property-change (point))))
3613 ;; Have we advanced to a larger column position?
3614 (if (> (current-column) normal-column)
3615 ;; We have made some progress towards the desired column.
3616 ;; See if we can make any further progress.
3617 (line-move-to-column (+ (current-column) (- col normal-column)))
3618 ;; Otherwise, go to the place we originally found
3619 ;; and move back over invisible text.
3620 ;; that will get us to the same place on the screen
3621 ;; but with a more reasonable buffer position.
3622 (goto-char normal-location)
3623 (let ((line-beg (save-excursion (beginning-of-line) (point))))
bbf41690 3624 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
af894fc9
RS
3625 (goto-char (previous-char-property-change (point) line-beg))))))))
3626
bbf41690
RS
3627(defun move-end-of-line (arg)
3628 "Move point to end of current line.
3629With argument ARG not nil or 1, move forward ARG - 1 lines first.
3630If point reaches the beginning or end of buffer, it stops there.
3631To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3632
3633This command does not move point across a field boundary unless doing so
3634would move beyond there to a different line; if ARG is nil or 1, and
3635point starts at a field boundary, point does not move. To ignore field
3636boundaries bind `inhibit-field-text-motion' to t."
3637 (interactive "p")
3638 (or arg (setq arg 1))
3639 (let (done)
3640 (while (not done)
3641 (let ((newpos
3642 (save-excursion
3643 (let ((goal-column 0))
3644 (and (line-move arg t)
3645 (not (bobp))
3646 (progn
3647 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3648 (goto-char (previous-char-property-change (point))))
3649 (backward-char 1)))
3650 (point)))))
3651 (goto-char newpos)
3652 (if (and (> (point) newpos)
3653 (eq (preceding-char) ?\n))
3654 (backward-char 1)
3655 (if (and (> (point) newpos) (not (eobp))
3656 (not (eq (following-char) ?\n)))
3657 ;; If we skipped something intangible
3658 ;; and now we're not really at eol,
3659 ;; keep going.
3660 (setq arg 1)
3661 (setq done t)))))))
3662
0cbb497c
KS
3663(defun move-beginning-of-line (arg)
3664 "Move point to beginning of current display line.
3665With argument ARG not nil or 1, move forward ARG - 1 lines first.
3666If point reaches the beginning or end of buffer, it stops there.
3667To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3668
3669This command does not move point across a field boundary unless doing so
3670would move beyond there to a different line; if ARG is nil or 1, and
3671point starts at a field boundary, point does not move. To ignore field
3672boundaries bind `inhibit-field-text-motion' to t."
3673 (interactive "p")
3674 (or arg (setq arg 1))
3675 (if (/= arg 1)
3676 (line-move (1- arg) t))
bfb1a447 3677 (beginning-of-line 1)
89767eec
KS
3678 (let ((orig (point)))
3679 (vertical-motion 0)
bfb1a447
KS
3680 (if (/= orig (point))
3681 (goto-char (constrain-to-field (point) orig (/= arg 1) t nil)))))
0cbb497c
KS
3682
3683
d5ab2033
JB
3684;;; Many people have said they rarely use this feature, and often type
3685;;; it by accident. Maybe it shouldn't even be on a key.
3686(put 'set-goal-column 'disabled t)
2076c87c
JB
3687
3688(defun set-goal-column (arg)
3689 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
3690Those commands will move to this position in the line moved to
3691rather than trying to keep the same horizontal position.
3692With a non-nil argument, clears out the goal column
912c6728
RS
3693so that \\[next-line] and \\[previous-line] resume vertical motion.
3694The goal column is stored in the variable `goal-column'."
2076c87c
JB
3695 (interactive "P")
3696 (if arg
3697 (progn
3698 (setq goal-column nil)
3699 (message "No goal column"))
3700 (setq goal-column (current-column))
8a26c165
DG
3701 ;; The older method below can be erroneous if `set-goal-column' is bound
3702 ;; to a sequence containing %
3703 ;;(message (substitute-command-keys
3704 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
3705 ;;goal-column)
3706 (message "%s"
3707 (concat
3708 (format "Goal column %d " goal-column)
3709 (substitute-command-keys
3710 "(use \\[set-goal-column] with an arg to unset it)")))
3711
3712 )
2076c87c 3713 nil)
2d88b556 3714\f
7492f5a6
RS
3715
3716(defun scroll-other-window-down (lines)
e47d38f6
RS
3717 "Scroll the \"other window\" down.
3718For more details, see the documentation for `scroll-other-window'."
7492f5a6
RS
3719 (interactive "P")
3720 (scroll-other-window
3721 ;; Just invert the argument's meaning.
3722 ;; We can do that without knowing which window it will be.
3723 (if (eq lines '-) nil
3724 (if (null lines) '-
3725 (- (prefix-numeric-value lines))))))
3aef9604
RS
3726
3727(defun beginning-of-buffer-other-window (arg)
3728 "Move point to the beginning of the buffer in the other window.
3729Leave mark at previous position.
3730With arg N, put point N/10 of the way from the true beginning."
3731 (interactive "P")
3732 (let ((orig-window (selected-window))
3733 (window (other-window-for-scrolling)))
3734 ;; We use unwind-protect rather than save-window-excursion
3735 ;; because the latter would preserve the things we want to change.
3736 (unwind-protect
3737 (progn
3738 (select-window window)
3739 ;; Set point and mark in that window's buffer.
bbf41690
RS
3740 (with-no-warnings
3741 (beginning-of-buffer arg))
3aef9604
RS
3742 ;; Set point accordingly.
3743 (recenter '(t)))
3744 (select-window orig-window))))
3745
3746(defun end-of-buffer-other-window (arg)
3747 "Move point to the end of the buffer in the other window.
3748Leave mark at previous position.
3749With arg N, put point N/10 of the way from the true end."
3750 (interactive "P")
3751 ;; See beginning-of-buffer-other-window for comments.
3752 (let ((orig-window (selected-window))
3753 (window (other-window-for-scrolling)))
3754 (unwind-protect
3755 (progn
3756 (select-window window)
bbf41690
RS
3757 (with-no-warnings
3758 (end-of-buffer arg))
3aef9604
RS
3759 (recenter '(t)))
3760 (select-window orig-window))))
2d88b556 3761\f
2076c87c
JB
3762(defun transpose-chars (arg)
3763 "Interchange characters around point, moving forward one character.
3764With prefix arg ARG, effect is to take character before point
3765and drag it forward past ARG other characters (backward if ARG negative).
3766If no argument and at end of line, the previous two chars are exchanged."
3767 (interactive "*P")
3768 (and (null arg) (eolp) (forward-char -1))
3769 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3770
3771(defun transpose-words (arg)
3772 "Interchange words around point, leaving point at end of them.
3773With prefix arg ARG, effect is to take word before or around point
3774and drag it forward past ARG other words (backward if ARG negative).
3775If ARG is zero, the words around or after point and around or after mark
3776are interchanged."
41d22ee0 3777 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
2076c87c
JB
3778 (interactive "*p")
3779 (transpose-subr 'forward-word arg))
3780
3781(defun transpose-sexps (arg)
3782 "Like \\[transpose-words] but applies to sexps.
3783Does not work on a sexp that point is in the middle of
3784if it is a list or string."
3785 (interactive "*p")
41d22ee0
SM
3786 (transpose-subr
3787 (lambda (arg)
3788 ;; Here we should try to simulate the behavior of
3789 ;; (cons (progn (forward-sexp x) (point))
3790 ;; (progn (forward-sexp (- x)) (point)))
3791 ;; Except that we don't want to rely on the second forward-sexp
3792 ;; putting us back to where we want to be, since forward-sexp-function
3793 ;; might do funny things like infix-precedence.
3794 (if (if (> arg 0)
3795 (looking-at "\\sw\\|\\s_")
3796 (and (not (bobp))
3797 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
3798 ;; Jumping over a symbol. We might be inside it, mind you.
3799 (progn (funcall (if (> arg 0)
3800 'skip-syntax-backward 'skip-syntax-forward)
3801 "w_")
3802 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3803 ;; Otherwise, we're between sexps. Take a step back before jumping
3804 ;; to make sure we'll obey the same precedence no matter which direction
3805 ;; we're going.
3806 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3807 (cons (save-excursion (forward-sexp arg) (point))
3808 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3809 (not (zerop (funcall (if (> arg 0)
3810 'skip-syntax-forward
3811 'skip-syntax-backward)
3812 ".")))))
3813 (point)))))
3814 arg 'special))
2076c87c
JB
3815
3816(defun transpose-lines (arg)
3817 "Exchange current line and previous line, leaving point after both.
3818With argument ARG, takes previous line and moves it past ARG lines.
3819With argument 0, interchanges line point is in with line mark is in."
3820 (interactive "*p")
3821 (transpose-subr (function
3822 (lambda (arg)
d3f4ef3f 3823 (if (> arg 0)
2076c87c 3824 (progn
d3f4ef3f
AS
3825 ;; Move forward over ARG lines,
3826 ;; but create newlines if necessary.
3827 (setq arg (forward-line arg))
3828 (if (/= (preceding-char) ?\n)
3829 (setq arg (1+ arg)))
3830 (if (> arg 0)
3831 (newline arg)))
2076c87c
JB
3832 (forward-line arg))))
3833 arg))
3834
e1e04350
SM
3835(defun transpose-subr (mover arg &optional special)
3836 (let ((aux (if special mover
3837 (lambda (x)
3838 (cons (progn (funcall mover x) (point))
3839 (progn (funcall mover (- x)) (point))))))
3840 pos1 pos2)
3841 (cond
3842 ((= arg 0)
3843 (save-excursion
3844 (setq pos1 (funcall aux 1))
3845 (goto-char (mark))
3846 (setq pos2 (funcall aux 1))
3847 (transpose-subr-1 pos1 pos2))
3848 (exchange-point-and-mark))
3849 ((> arg 0)
3850 (setq pos1 (funcall aux -1))
3851 (setq pos2 (funcall aux arg))
3852 (transpose-subr-1 pos1 pos2)
3853 (goto-char (car pos2)))
3854 (t
3855 (setq pos1 (funcall aux -1))
3856 (goto-char (car pos1))
3857 (setq pos2 (funcall aux arg))
3858 (transpose-subr-1 pos1 pos2)))))
3859
3860(defun transpose-subr-1 (pos1 pos2)
3861 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3862 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3863 (when (> (car pos1) (car pos2))
3864 (let ((swap pos1))
3865 (setq pos1 pos2 pos2 swap)))
3866 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
dc7d7552
RS
3867 (atomic-change-group
3868 (let (word2)
1e96c007
SM
3869 ;; FIXME: We first delete the two pieces of text, so markers that
3870 ;; used to point to after the text end up pointing to before it :-(
dc7d7552
RS
3871 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3872 (goto-char (car pos2))
3873 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3874 (goto-char (car pos1))
3875 (insert word2))))
2d88b556 3876\f
b82d844f 3877(defun backward-word (&optional arg)
b7e91b0c 3878 "Move backward until encountering the beginning of a word.
20ecc110 3879With argument, do this that many times."
9e50756b 3880 (interactive "p")
b82d844f 3881 (forward-word (- (or arg 1))))
2076c87c 3882
a1a801de 3883(defun mark-word (&optional arg allow-extend)
705a5933
JL
3884 "Set mark ARG words away from point.
3885The place mark goes is the same place \\[forward-word] would
3886move to with the same argument.
a1a801de 3887Interactively, if this command is repeated
771069f8 3888or (in Transient Mark mode) if the mark is active,
705a5933 3889it marks the next ARG words after the ones already marked."
a1a801de
RS
3890 (interactive "P\np")
3891 (cond ((and allow-extend
3892 (or (and (eq last-command this-command) (mark t))
3893 (and transient-mark-mode mark-active)))
705a5933
JL
3894 (setq arg (if arg (prefix-numeric-value arg)
3895 (if (< (mark) (point)) -1 1)))
cad113ae
KG
3896 (set-mark
3897 (save-excursion
3898 (goto-char (mark))
3899 (forward-word arg)
3900 (point))))
3901 (t
3902 (push-mark
3903 (save-excursion
705a5933 3904 (forward-word (prefix-numeric-value arg))
cad113ae
KG
3905 (point))
3906 nil t))))
2076c87c
JB
3907
3908(defun kill-word (arg)
3909 "Kill characters forward until encountering the end of a word.
3910With argument, do this that many times."
e761e42c 3911 (interactive "p")
89ee2bf6 3912 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
3913
3914(defun backward-kill-word (arg)
3915 "Kill characters backward until encountering the end of a word.
3916With argument, do this that many times."
e761e42c 3917 (interactive "p")
2076c87c 3918 (kill-word (- arg)))
d7c64071 3919
0f7df535
RS
3920(defun current-word (&optional strict really-word)
3921 "Return the symbol or word that point is on (or a nearby one) as a string.
3922The return value includes no text properties.
1e8c5ac4 3923If optional arg STRICT is non-nil, return nil unless point is within
0fa19a57
RS
3924or adjacent to a symbol or word. In all cases the value can be nil
3925if there is no word nearby.
0f7df535
RS
3926The function, belying its name, normally finds a symbol.
3927If optional arg REALLY-WORD is non-nil, it finds just a word."
d7c64071 3928 (save-excursion
0f7df535 3929 (let* ((oldpoint (point)) (start (point)) (end (point))
81d17173 3930 (syntaxes (if really-word "w" "w_"))
0f7df535
RS
3931 (not-syntaxes (concat "^" syntaxes)))
3932 (skip-syntax-backward syntaxes) (setq start (point))
d7c64071 3933 (goto-char oldpoint)
0f7df535
RS
3934 (skip-syntax-forward syntaxes) (setq end (point))
3935 (when (and (eq start oldpoint) (eq end oldpoint)
3936 ;; Point is neither within nor adjacent to a word.
3937 (not strict))
3938 ;; Look for preceding word in same line.
3939 (skip-syntax-backward not-syntaxes
3940 (save-excursion (beginning-of-line)
3941 (point)))
3942 (if (bolp)
3943 ;; No preceding word in same line.
3944 ;; Look for following word in same line.
3945 (progn
3946 (skip-syntax-forward not-syntaxes
3947 (save-excursion (end-of-line)
3948 (point)))
3949 (setq start (point))
3950 (skip-syntax-forward syntaxes)
3951 (setq end (point)))
3952 (setq end (point))
3953 (skip-syntax-backward syntaxes)
3954 (setq start (point))))
3955 ;; If we found something nonempty, return it as a string.
3956 (unless (= start end)
020db25f 3957 (buffer-substring-no-properties start end)))))
2d88b556 3958\f
69c1dd37 3959(defcustom fill-prefix nil
e1e04350 3960 "*String for filling to insert at front of new line, or nil for none."
69c1dd37
RS
3961 :type '(choice (const :tag "None" nil)
3962 string)
3963 :group 'fill)
2076c87c
JB
3964(make-variable-buffer-local 'fill-prefix)
3965
69c1dd37
RS
3966(defcustom auto-fill-inhibit-regexp nil
3967 "*Regexp to match lines which should not be auto-filled."
3968 :type '(choice (const :tag "None" nil)
3969 regexp)
3970 :group 'fill)
2076c87c 3971
58dd38f1 3972(defvar comment-line-break-function 'comment-indent-new-line
b3ac9fa9
RS
3973 "*Mode-specific function which line breaks and continues a comment.
3974
3975This function is only called during auto-filling of a comment section.
3976The function should take a single optional argument, which is a flag
cc4cb0f5 3977indicating whether it should use soft newlines.")
b3ac9fa9 3978
dbe524b6 3979;; This function is used as the auto-fill-function of a buffer
e2504204
KH
3980;; when Auto-Fill mode is enabled.
3981;; It returns t if it really did any work.
dbe524b6
RS
3982;; (Actually some major modes use a different auto-fill function,
3983;; but this one is the default one.)
2076c87c 3984(defun do-auto-fill ()
621a3f62 3985 (let (fc justify give-up
a0170800 3986 (fill-prefix fill-prefix))
c18465c4 3987 (if (or (not (setq justify (current-justification)))
8f066a20
RS
3988 (null (setq fc (current-fill-column)))
3989 (and (eq justify 'left)
3990 (<= (current-column) fc))
621a3f62
SM
3991 (and auto-fill-inhibit-regexp
3992 (save-excursion (beginning-of-line)
eed5698b
RS
3993 (looking-at auto-fill-inhibit-regexp))))
3994 nil ;; Auto-filling not required
3db1e3b5
BG
3995 (if (memq justify '(full center right))
3996 (save-excursion (unjustify-current-line)))
a0170800
RS
3997
3998 ;; Choose a fill-prefix automatically.
e1e04350
SM
3999 (when (and adaptive-fill-mode
4000 (or (null fill-prefix) (string= fill-prefix "")))
4001 (let ((prefix
4002 (fill-context-prefix
4003 (save-excursion (backward-paragraph 1) (point))
4004 (save-excursion (forward-paragraph 1) (point)))))
4005 (and prefix (not (equal prefix ""))
4006 ;; Use auto-indentation rather than a guessed empty prefix.
0e53a373 4007 (not (and fill-indent-according-to-mode
d99f8496 4008 (string-match "\\`[ \t]*\\'" prefix)))
e1e04350 4009 (setq fill-prefix prefix))))
f1180544 4010
eed5698b 4011 (while (and (not give-up) (> (current-column) fc))
e47d38f6 4012 ;; Determine where to split the line.
db893d00
RS
4013 (let* (after-prefix
4014 (fill-point
621a3f62
SM
4015 (save-excursion
4016 (beginning-of-line)
4017 (setq after-prefix (point))
4018 (and fill-prefix
4019 (looking-at (regexp-quote fill-prefix))
4020 (setq after-prefix (match-end 0)))
4021 (move-to-column (1+ fc))
4022 (fill-move-to-break-point after-prefix)
4023 (point))))
db893d00
RS
4024
4025 ;; See whether the place we found is any good.
e47d38f6
RS
4026 (if (save-excursion
4027 (goto-char fill-point)
41d22ee0
SM
4028 (or (bolp)
4029 ;; There is no use breaking at end of line.
4030 (save-excursion (skip-chars-forward " ") (eolp))
4031 ;; It is futile to split at the end of the prefix
4032 ;; since we would just insert the prefix again.
4033 (and after-prefix (<= (point) after-prefix))
4034 ;; Don't split right after a comment starter
4035 ;; since we would just make another comment starter.
4036 (and comment-start-skip
4037 (let ((limit (point)))
4038 (beginning-of-line)
4039 (and (re-search-forward comment-start-skip
4040 limit t)
4041 (eq (point) limit))))))
4042 ;; No good place to break => stop trying.
4043 (setq give-up t)
4044 ;; Ok, we have a useful place to break the line. Do it.
4045 (let ((prev-column (current-column)))
4046 ;; If point is at the fill-point, do not `save-excursion'.
4047 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4048 ;; point will end up before it rather than after it.
4049 (if (save-excursion
4050 (skip-chars-backward " \t")
4051 (= (point) fill-point))
4052 (funcall comment-line-break-function t)
4053 (save-excursion
4054 (goto-char fill-point)
4055 (funcall comment-line-break-function t)))
4056 ;; Now do justification, if required
4057 (if (not (eq justify 'left))
e47d38f6 4058 (save-excursion
e1e04350
SM
4059 (end-of-line 0)
4060 (justify-current-line justify nil t)))
41d22ee0
SM
4061 ;; If making the new line didn't reduce the hpos of
4062 ;; the end of the line, then give up now;
4063 ;; trying again will not help.
4064 (if (>= (current-column) prev-column)
4065 (setq give-up t))))))
24ebf92e 4066 ;; Justify last line.
e2504204 4067 (justify-current-line justify t t)
1e722f9f 4068 t)))
2076c87c 4069
24ebf92e
RS
4070(defvar normal-auto-fill-function 'do-auto-fill
4071 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4072Some major modes set this.")
4073
c75505b4 4074(put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
d99f8496
SM
4075;; FIXME: turn into a proper minor mode.
4076;; Add a global minor mode version of it.
d7465b15 4077(defun auto-fill-mode (&optional arg)
24ebf92e
RS
4078 "Toggle Auto Fill mode.
4079With arg, turn Auto Fill mode on if and only if arg is positive.
4080In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4081automatically breaks the line at a previous space.
4082
4083The value of `normal-auto-fill-function' specifies the function to use
4084for `auto-fill-function' when turning Auto Fill mode on."
d7465b15
RS
4085 (interactive "P")
4086 (prog1 (setq auto-fill-function
4087 (if (if (null arg)
4088 (not auto-fill-function)
4089 (> (prefix-numeric-value arg) 0))
24ebf92e 4090 normal-auto-fill-function
d7465b15 4091 nil))
7911ecc8 4092 (force-mode-line-update)))
d7465b15
RS
4093
4094;; This holds a document string used to document auto-fill-mode.
4095(defun auto-fill-function ()
4096 "Automatically break line at a previous space, in insertion of text."
4097 nil)
4098
4099(defun turn-on-auto-fill ()
4100 "Unconditionally turn on Auto Fill mode."
4101 (auto-fill-mode 1))
3a99c819
GM
4102
4103(defun turn-off-auto-fill ()
4104 "Unconditionally turn off Auto Fill mode."
4105 (auto-fill-mode -1))
4106
7cbf1dc1 4107(custom-add-option 'text-mode-hook 'turn-on-auto-fill)
d7465b15
RS
4108
4109(defun set-fill-column (arg)
4cc0ea11 4110 "Set `fill-column' to specified argument.
923efb99 4111Use \\[universal-argument] followed by a number to specify a column.
4cc0ea11 4112Just \\[universal-argument] as argument means to use the current column."
d7465b15 4113 (interactive "P")
f4520363
RS
4114 (if (consp arg)
4115 (setq arg (current-column)))
4116 (if (not (integerp arg))
4117 ;; Disallow missing argument; it's probably a typo for C-x C-f.
f33321ad 4118 (error "set-fill-column requires an explicit argument")
f4520363
RS
4119 (message "Fill column set to %d (was %d)" arg fill-column)
4120 (setq fill-column arg)))
2d88b556 4121\f
2076c87c 4122(defun set-selective-display (arg)
ff1fbe3e
RS
4123 "Set `selective-display' to ARG; clear it if no arg.
4124When the value of `selective-display' is a number > 0,
4125lines whose indentation is >= that value are not displayed.
4126The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
4127 (interactive "P")
4128 (if (eq selective-display t)
4129 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
4130 (let ((current-vpos
4131 (save-restriction
4132 (narrow-to-region (point-min) (point))
4133 (goto-char (window-start))
4134 (vertical-motion (window-height)))))
4135 (setq selective-display
4136 (and arg (prefix-numeric-value arg)))
4137 (recenter current-vpos))
2076c87c
JB
4138 (set-window-start (selected-window) (window-start (selected-window)))
4139 (princ "selective-display set to " t)
4140 (prin1 selective-display t)
4141 (princ "." t))
4142
40a64816
RS
4143(defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4144(defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4145
0bb64d76
PA
4146(defun toggle-truncate-lines (arg)
4147 "Toggle whether to fold or truncate long lines on the screen.
46cdfe8f
RS
4148With arg, truncate long lines iff arg is positive.
4149Note that in side-by-side windows, truncation is always enabled."
0bb64d76
PA
4150 (interactive "P")
4151 (setq truncate-lines
4152 (if (null arg)
4153 (not truncate-lines)
46cdfe8f
RS
4154 (> (prefix-numeric-value arg) 0)))
4155 (force-mode-line-update)
4f017185
RS
4156 (unless truncate-lines
4157 (let ((buffer (current-buffer)))
4158 (walk-windows (lambda (window)
4159 (if (eq buffer (window-buffer window))
4160 (set-window-hscroll window 0)))
4161 nil t)))
46cdfe8f
RS
4162 (message "Truncate long lines %s"
4163 (if truncate-lines "enabled" "disabled")))
0bb64d76 4164
4f8f7f9f 4165(defvar overwrite-mode-textual " Ovwrt"
b6a22db0 4166 "The string displayed in the mode line when in overwrite mode.")
4f8f7f9f 4167(defvar overwrite-mode-binary " Bin Ovwrt"
b6a22db0
JB
4168 "The string displayed in the mode line when in binary overwrite mode.")
4169
2076c87c
JB
4170(defun overwrite-mode (arg)
4171 "Toggle overwrite mode.
4172With arg, turn overwrite mode on iff arg is positive.
4173In overwrite mode, printing characters typed in replace existing text
b6a22db0
JB
4174on a one-for-one basis, rather than pushing it to the right. At the
4175end of a line, such characters extend the line. Before a tab,
4176such characters insert until the tab is filled in.
4177\\[quoted-insert] still inserts characters in overwrite mode; this
4178is supposed to make it easier to insert characters when necessary."
4179 (interactive "P")
4180 (setq overwrite-mode
4181 (if (if (null arg) (not overwrite-mode)
4182 (> (prefix-numeric-value arg) 0))
4183 'overwrite-mode-textual))
4184 (force-mode-line-update))
4185
4186(defun binary-overwrite-mode (arg)
4187 "Toggle binary overwrite mode.
4188With arg, turn binary overwrite mode on iff arg is positive.
4189In binary overwrite mode, printing characters typed in replace
4190existing text. Newlines are not treated specially, so typing at the
4191end of a line joins the line to the next, with the typed character
4192between them. Typing before a tab character simply replaces the tab
4193with the character typed.
4194\\[quoted-insert] replaces the text at the cursor, just as ordinary
4195typing characters do.
4196
4197Note that binary overwrite mode is not its own minor mode; it is a
f33321ad 4198specialization of overwrite mode, entered by setting the
b6a22db0 4199`overwrite-mode' variable to `overwrite-mode-binary'."
2076c87c
JB
4200 (interactive "P")
4201 (setq overwrite-mode
b6a22db0 4202 (if (if (null arg)
a61099dd 4203 (not (eq overwrite-mode 'overwrite-mode-binary))
b6a22db0
JB
4204 (> (prefix-numeric-value arg) 0))
4205 'overwrite-mode-binary))
4206 (force-mode-line-update))
eaae8106 4207
6710df48 4208(define-minor-mode line-number-mode
a61099dd
RS
4209 "Toggle Line Number mode.
4210With arg, turn Line Number mode on iff arg is positive.
4211When Line Number mode is enabled, the line number appears
8dc9e2ef
KH
4212in the mode line.
4213
32f2f98e
EZ
4214Line numbers do not appear for very large buffers and buffers
4215with very long lines; see variables `line-number-display-limit'
4216and `line-number-display-limit-width'."
82dc968c 4217 :init-value t :global t :group 'editing-basics :require nil)
bcad4985 4218
6710df48 4219(define-minor-mode column-number-mode
bcad4985
KH
4220 "Toggle Column Number mode.
4221With arg, turn Column Number mode on iff arg is positive.
4222When Column Number mode is enabled, the column number appears
4223in the mode line."
82dc968c 4224 :global t :group 'editing-basics :require nil)
cf045f9a
LK
4225
4226(define-minor-mode size-indication-mode
4227 "Toggle Size Indication mode.
4228With arg, turn Size Indication mode on iff arg is positive. When
4229Size Indication mode is enabled, the size of the accessible part
4230of the buffer appears in the mode line."
4231 :global t :group 'editing-basics :require nil)
2d88b556 4232\f
4b384a8f 4233(defgroup paren-blinking nil
020db25f 4234 "Blinking matching of parens and expressions."
4b384a8f
SM
4235 :prefix "blink-matching-"
4236 :group 'paren-matching)
4237
69c1dd37
RS
4238(defcustom blink-matching-paren t
4239 "*Non-nil means show matching open-paren when close-paren is inserted."
4240 :type 'boolean
4b384a8f 4241 :group 'paren-blinking)
2076c87c 4242
69c1dd37 4243(defcustom blink-matching-paren-on-screen t
29fc44dd 4244 "*Non-nil means show matching open-paren when it is on screen.
4b384a8f
SM
4245If nil, means don't show it (but the open-paren can still be shown
4246when it is off screen)."
69c1dd37 4247 :type 'boolean
4b384a8f 4248 :group 'paren-blinking)
29fc44dd 4249
4b384a8f 4250(defcustom blink-matching-paren-distance (* 25 1024)
66d44a36
EZ
4251 "*If non-nil, maximum distance to search backwards for matching open-paren.
4252If nil, search stops at the beginning of the accessible portion of the buffer."
4253 :type '(choice (const nil) integer)
4b384a8f 4254 :group 'paren-blinking)
2076c87c 4255
69c1dd37 4256(defcustom blink-matching-delay 1
4b384a8f
SM
4257 "*Time in seconds to delay after showing a matching paren."
4258 :type 'number
4259 :group 'paren-blinking)
72dddf8b 4260
69c1dd37 4261(defcustom blink-matching-paren-dont-ignore-comments nil
4b384a8f 4262 "*Non-nil means `blink-matching-paren' will not ignore comments."
69c1dd37 4263 :type 'boolean
4b384a8f 4264 :group 'paren-blinking)
903b7f65 4265
2076c87c
JB
4266(defun blink-matching-open ()
4267 "Move cursor momentarily to the beginning of the sexp before point."
4268 (interactive)
c448d316 4269 (when (and (> (point) (point-min))
1d0e3fc8
RS
4270 blink-matching-paren
4271 ;; Verify an even number of quoting characters precede the close.
4272 (= 1 (logand 1 (- (point)
4273 (save-excursion
4274 (forward-char -1)
4275 (skip-syntax-backward "/\\")
4276 (point))))))
4277 (let* ((oldpos (point))
4278 blinkpos
4279 message-log-max ; Don't log messages about paren matching.
4280 matching-paren
4281 open-paren-line-string)
4282 (save-excursion
4283 (save-restriction
4284 (if blink-matching-paren-distance
4285 (narrow-to-region (max (point-min)
4286 (- (point) blink-matching-paren-distance))
4287 oldpos))
4288 (condition-case ()
4289 (let ((parse-sexp-ignore-comments
4290 (and parse-sexp-ignore-comments
4291 (not blink-matching-paren-dont-ignore-comments))))
4292 (setq blinkpos (scan-sexps oldpos -1)))
4293 (error nil)))
4294 (and blinkpos
4295 ;; Not syntax '$'.
4296 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4297 (setq matching-paren
4298 (let ((syntax (syntax-after blinkpos)))
4299 (and (consp syntax)
4300 (eq (syntax-class syntax) 4)
4301 (cdr syntax)))))
4302 (cond
4303 ((or (null matching-paren)
4304 (/= (char-before oldpos)
4305 matching-paren))
4306 (message "Mismatched parentheses"))
4307 ((not blinkpos)
4308 (if (not blink-matching-paren-distance)
4309 (message "Unmatched parenthesis")))
4310 ((pos-visible-in-window-p blinkpos)
4311 ;; Matching open within window, temporarily move to blinkpos but only
4312 ;; if `blink-matching-paren-on-screen' is non-nil.
4313 (when blink-matching-paren-on-screen
4314 (save-excursion
4315 (goto-char blinkpos)
4316 (sit-for blink-matching-delay))))
4317 (t
4318 (save-excursion
4319 (goto-char blinkpos)
4320 (setq open-paren-line-string
4321 ;; Show what precedes the open in its line, if anything.
4322 (if (save-excursion
4323 (skip-chars-backward " \t")
4324 (not (bolp)))
4325 (buffer-substring (line-beginning-position)
4326 (1+ blinkpos))
4327 ;; Show what follows the open in its line, if anything.
4328 (if (save-excursion
4329 (forward-char 1)
4330 (skip-chars-forward " \t")
4331 (not (eolp)))
4332 (buffer-substring blinkpos
4333 (line-end-position))
4334 ;; Otherwise show the previous nonblank line,
4335 ;; if there is one.
4336 (if (save-excursion
4337 (skip-chars-backward "\n \t")
4338 (not (bobp)))
4339 (concat
4340 (buffer-substring (progn
267935b9 4341 (skip-chars-backward "\n \t")
1d0e3fc8
RS
4342 (line-beginning-position))
4343 (progn (end-of-line)
4344 (skip-chars-backward " \t")
4345 (point)))
4346 ;; Replace the newline and other whitespace with `...'.
4347 "..."
4348 (buffer-substring blinkpos (1+ blinkpos)))
4349 ;; There is nothing to show except the char itself.
4350 (buffer-substring blinkpos (1+ blinkpos)))))))
4351 (message "Matches %s"
4352 (substring-no-properties open-paren-line-string))))))))
2076c87c
JB
4353
4354;Turned off because it makes dbx bomb out.
4355(setq blink-paren-function 'blink-matching-open)
2d88b556 4356\f
9a1277dd
RS
4357;; This executes C-g typed while Emacs is waiting for a command.
4358;; Quitting out of a program does not go through here;
4359;; that happens in the QUIT macro at the C code level.
2076c87c 4360(defun keyboard-quit ()
d5dae4e1 4361 "Signal a `quit' condition.
af39530e
RS
4362During execution of Lisp code, this character causes a quit directly.
4363At top-level, as an editor command, this simply beeps."
2076c87c 4364 (interactive)
19d35374 4365 (deactivate-mark)
8a7644e9
KS
4366 (if (fboundp 'kmacro-keyboard-quit)
4367 (kmacro-keyboard-quit))
f5e13057 4368 (setq defining-kbd-macro nil)
2076c87c
JB
4369 (signal 'quit nil))
4370
1c6c6fde
RS
4371(defvar buffer-quit-function nil
4372 "Function to call to \"quit\" the current buffer, or nil if none.
4373\\[keyboard-escape-quit] calls this function when its more local actions
4374\(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4375
c66587fe
RS
4376(defun keyboard-escape-quit ()
4377 "Exit the current \"mode\" (in a generalized sense of the word).
4378This command can exit an interactive command such as `query-replace',
4379can clear out a prefix argument or a region,
4380can get out of the minibuffer or other recursive edit,
1c6c6fde
RS
4381cancel the use of the current buffer (for special-purpose buffers),
4382or go back to just one window (by deleting all but the selected window)."
c66587fe
RS
4383 (interactive)
4384 (cond ((eq last-command 'mode-exited) nil)
4385 ((> (minibuffer-depth) 0)
4386 (abort-recursive-edit))
4387 (current-prefix-arg
4388 nil)
705a5933 4389 ((and transient-mark-mode mark-active)
c66587fe 4390 (deactivate-mark))
1b657835
RS
4391 ((> (recursion-depth) 0)
4392 (exit-recursive-edit))
1c6c6fde
RS
4393 (buffer-quit-function
4394 (funcall buffer-quit-function))
c66587fe 4395 ((not (one-window-p t))
1b657835
RS
4396 (delete-other-windows))
4397 ((string-match "^ \\*" (buffer-name (current-buffer)))
4398 (bury-buffer))))
c66587fe 4399
2d88b556
RS
4400(defun play-sound-file (file &optional volume device)
4401 "Play sound stored in FILE.
4402VOLUME and DEVICE correspond to the keywords of the sound
4403specification for `play-sound'."
4404 (interactive "fPlay sound file: ")
4405 (let ((sound (list :file file)))
4406 (if volume
4407 (plist-put sound :volume volume))
4408 (if device
4409 (plist-put sound :device device))
4410 (push 'sound sound)
4411 (play-sound sound)))
4412
56abefac 4413\f
7683b5c2
DL
4414(defcustom read-mail-command 'rmail
4415 "*Your preference for a mail reading package.
9023837e
DL
4416This is used by some keybindings which support reading mail.
4417See also `mail-user-agent' concerning sending mail."
7683b5c2
DL
4418 :type '(choice (function-item rmail)
4419 (function-item gnus)
4420 (function-item mh-rmail)
4421 (function :tag "Other"))
4422 :version "21.1"
4423 :group 'mail)
4424
69c1dd37 4425(defcustom mail-user-agent 'sendmail-user-agent
a31ca314 4426 "*Your preference for a mail composition package.
9023837e 4427Various Emacs Lisp packages (e.g. Reporter) require you to compose an
a31ca314
RS
4428outgoing email message. This variable lets you specify which
4429mail-sending package you prefer.
4430
4431Valid values include:
4432
9023837e
DL
4433 `sendmail-user-agent' -- use the default Emacs Mail package.
4434 See Info node `(emacs)Sending Mail'.
4435 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4436 See Info node `(mh-e)'.
4437 `message-user-agent' -- use the Gnus Message package.
4438 See Info node `(message)'.
4439 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4440 paraphernalia, particularly the Gcc: header for
4441 archiving.
a31ca314
RS
4442
4443Additional valid symbols may be available; check with the author of
15d0c9b1
DL
4444your package for details. The function should return non-nil if it
4445succeeds.
9023837e
DL
4446
4447See also `read-mail-command' concerning reading mail."
69c1dd37
RS
4448 :type '(radio (function-item :tag "Default Emacs mail"
4449 :format "%t\n"
4450 sendmail-user-agent)
4451 (function-item :tag "Emacs interface to MH"
4452 :format "%t\n"
4453 mh-e-user-agent)
9023837e 4454 (function-item :tag "Gnus Message package"
69c1dd37
RS
4455 :format "%t\n"
4456 message-user-agent)
9023837e
DL
4457 (function-item :tag "Gnus Message with full Gnus features"
4458 :format "%t\n"
4459 gnus-user-agent)
69c1dd37
RS
4460 (function :tag "Other"))
4461 :group 'mail)
a31ca314 4462
a31ca314 4463(define-mail-user-agent 'sendmail-user-agent
34fbcdf3 4464 'sendmail-user-agent-compose
a31ca314
RS
4465 'mail-send-and-exit)
4466
360b5483
RS
4467(defun rfc822-goto-eoh ()
4468 ;; Go to header delimiter line in a mail message, following RFC822 rules
4469 (goto-char (point-min))
e1e04350
SM
4470 (when (re-search-forward
4471 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
4472 (goto-char (match-beginning 0))))
360b5483 4473
34fbcdf3
RS
4474(defun sendmail-user-agent-compose (&optional to subject other-headers continue
4475 switch-function yank-action
4476 send-actions)
4477 (if switch-function
4478 (let ((special-display-buffer-names nil)
4479 (special-display-regexps nil)
4480 (same-window-buffer-names nil)
4481 (same-window-regexps nil))
4482 (funcall switch-function "*mail*")))
9462bf2c
RS
4483 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4484 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4485 (body (cdr (assoc-string "body" other-headers t))))
a9267c2c
CY
4486 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4487 continue
4488 (error "Message aborted"))
34fbcdf3 4489 (save-excursion
360b5483 4490 (rfc822-goto-eoh)
34fbcdf3 4491 (while other-headers
0740c738
GM
4492 (unless (member-ignore-case (car (car other-headers))
4493 '("in-reply-to" "cc" "body"))
34fbcdf3
RS
4494 (insert (car (car other-headers)) ": "
4495 (cdr (car other-headers)) "\n"))
4496 (setq other-headers (cdr other-headers)))
0740c738
GM
4497 (when body
4498 (forward-line 1)
4499 (insert body))
34fbcdf3
RS
4500 t)))
4501
a31ca314
RS
4502(define-mail-user-agent 'mh-e-user-agent
4503 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
4504 'mh-before-send-letter-hook)
d0008a00
RS
4505
4506(defun compose-mail (&optional to subject other-headers continue
4507 switch-function yank-action send-actions)
4508 "Start composing a mail message to send.
4509This uses the user's chosen mail composition package
4510as selected with the variable `mail-user-agent'.
4511The optional arguments TO and SUBJECT specify recipients
4512and the initial Subject field, respectively.
4513
4514OTHER-HEADERS is an alist specifying additional
4515header fields. Elements look like (HEADER . VALUE) where both
4516HEADER and VALUE are strings.
4517
4518CONTINUE, if non-nil, says to continue editing a message already
4519being composed.
4520
4521SWITCH-FUNCTION, if non-nil, is a function to use to
4522switch to and display the buffer used for mail composition.
4523
4524YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
06720de2
RS
4525to insert the raw text of the message being replied to.
4526It has the form (FUNCTION . ARGS). The user agent will apply
4527FUNCTION to ARGS, to insert the raw text of the original message.
4528\(The user agent will also run `mail-citation-hook', *after* the
4529original text has been inserted in this way.)
d0008a00
RS
4530
4531SEND-ACTIONS is a list of actions to call when the message is sent.
4532Each action has the form (FUNCTION . ARGS)."
b5f019be
RS
4533 (interactive
4534 (list nil nil nil current-prefix-arg))
d0008a00
RS
4535 (let ((function (get mail-user-agent 'composefunc)))
4536 (funcall function to subject other-headers continue
4537 switch-function yank-action send-actions)))
b5f019be
RS
4538
4539(defun compose-mail-other-window (&optional to subject other-headers continue
4540 yank-action send-actions)
4541 "Like \\[compose-mail], but edit the outgoing message in another window."
4542 (interactive
4543 (list nil nil nil current-prefix-arg))
4544 (compose-mail to subject other-headers continue
4545 'switch-to-buffer-other-window yank-action send-actions))
4546
4547
4548(defun compose-mail-other-frame (&optional to subject other-headers continue
4549 yank-action send-actions)
4550 "Like \\[compose-mail], but edit the outgoing message in another frame."
4551 (interactive
4552 (list nil nil nil current-prefix-arg))
4553 (compose-mail to subject other-headers continue
4554 'switch-to-buffer-other-frame yank-action send-actions))
56abefac 4555\f
610c1c68
RS
4556(defvar set-variable-value-history nil
4557 "History of values entered with `set-variable'.")
4558
d6281b4e 4559(defun set-variable (variable value &optional make-local)
610c1c68 4560 "Set VARIABLE to VALUE. VALUE is a Lisp object.
d6281b4e
RS
4561VARIABLE should be a user option variable name, a Lisp variable
4562meant to be customized by users. You should enter VALUE in Lisp syntax,
4563so if you want VALUE to be a string, you must surround it with doublequotes.
610c1c68
RS
4564VALUE is used literally, not evaluated.
4565
4566If VARIABLE has a `variable-interactive' property, that is used as if
4567it were the arg to `interactive' (which see) to interactively read VALUE.
4568
4569If VARIABLE has been defined with `defcustom', then the type information
16236388
RS
4570in the definition is used to check that VALUE is valid.
4571
4572With a prefix argument, set VARIABLE to VALUE buffer-locally."
e9dfb72e
RS
4573 (interactive
4574 (let* ((default-var (variable-at-point))
4575 (var (if (symbolp default-var)
d6281b4e
RS
4576 (read-variable (format "Set variable (default %s): " default-var)
4577 default-var)
4578 (read-variable "Set variable: ")))
7dcd2d16
AS
4579 (minibuffer-help-form '(describe-variable var))
4580 (prop (get var 'variable-interactive))
0684376b
JB
4581 (obsolete (car (get var 'byte-obsolete-variable)))
4582 (prompt (format "Set %s %s to value: " var
7dcd2d16 4583 (cond ((local-variable-p var)
0684376b 4584 "(buffer-local)")
7dcd2d16
AS
4585 ((or current-prefix-arg
4586 (local-variable-if-set-p var))
0684376b
JB
4587 "buffer-locally")
4588 (t "globally"))))
4589 (val (progn
4590 (when obsolete
4591 (message (concat "`%S' is obsolete; "
4592 (if (symbolp obsolete) "use `%S' instead" "%s"))
4593 var obsolete)
4594 (sit-for 3))
4595 (if prop
4596 ;; Use VAR's `variable-interactive' property
4597 ;; as an interactive spec for prompting.
4598 (call-interactively `(lambda (arg)
4599 (interactive ,prop)
4600 arg))
4601 (read
4602 (read-string prompt nil
4603 'set-variable-value-history))))))
7dcd2d16 4604 (list var val current-prefix-arg)))
610c1c68 4605
d6281b4e
RS
4606 (and (custom-variable-p variable)
4607 (not (get variable 'custom-type))
4608 (custom-load-symbol variable))
4609 (let ((type (get variable 'custom-type)))
610c1c68
RS
4610 (when type
4611 ;; Match with custom type.
36755dd9 4612 (require 'cus-edit)
610c1c68 4613 (setq type (widget-convert type))
d6281b4e 4614 (unless (widget-apply type :match value)
1e722f9f 4615 (error "Value `%S' does not match type %S of %S"
d6281b4e 4616 value (car type) variable))))
16236388
RS
4617
4618 (if make-local
d6281b4e 4619 (make-local-variable variable))
f1180544 4620
d6281b4e 4621 (set variable value)
a2aef080
GM
4622
4623 ;; Force a thorough redisplay for the case that the variable
4624 ;; has an effect on the display, like `tab-width' has.
4625 (force-mode-line-update))
56abefac 4626\f
e8a700bf
RS
4627;; Define the major mode for lists of completions.
4628
98b45886
RS
4629(defvar completion-list-mode-map nil
4630 "Local map for completion list buffers.")
ac29eb79 4631(or completion-list-mode-map
e8a700bf
RS
4632 (let ((map (make-sparse-keymap)))
4633 (define-key map [mouse-2] 'mouse-choose-completion)
771069f8 4634 (define-key map [follow-link] 'mouse-face)
eaf76065 4635 (define-key map [down-mouse-2] nil)
80298193 4636 (define-key map "\C-m" 'choose-completion)
1c6c6fde 4637 (define-key map "\e\e\e" 'delete-completion-window)
dde69dbe
RS
4638 (define-key map [left] 'previous-completion)
4639 (define-key map [right] 'next-completion)
ac29eb79 4640 (setq completion-list-mode-map map)))
e8a700bf
RS
4641
4642;; Completion mode is suitable only for specially formatted data.
ac29eb79 4643(put 'completion-list-mode 'mode-class 'special)
e8a700bf 4644
98b45886
RS
4645(defvar completion-reference-buffer nil
4646 "Record the buffer that was current when the completion list was requested.
4647This is a local variable in the completion list buffer.
ec39964e 4648Initial value is nil to avoid some compiler warnings.")
3819736b 4649
83434bda
RS
4650(defvar completion-no-auto-exit nil
4651 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4652This also applies to other functions such as `choose-completion'
4653and `mouse-choose-completion'.")
4654
98b45886
RS
4655(defvar completion-base-size nil
4656 "Number of chars at beginning of minibuffer not involved in completion.
4657This is a local variable in the completion list buffer
4658but it talks about the buffer in `completion-reference-buffer'.
4659If this is nil, it means to compare text to determine which part
4660of the tail end of the buffer's text is involved in completion.")
f6b293e3 4661
1c6c6fde
RS
4662(defun delete-completion-window ()
4663 "Delete the completion list window.
4664Go to the window from which completion was requested."
4665 (interactive)
4666 (let ((buf completion-reference-buffer))
ddb2b181
RS
4667 (if (one-window-p t)
4668 (if (window-dedicated-p (selected-window))
4669 (delete-frame (selected-frame)))
4670 (delete-window (selected-window))
4671 (if (get-buffer-window buf)
4672 (select-window (get-buffer-window buf))))))
1c6c6fde 4673
dde69dbe
RS
4674(defun previous-completion (n)
4675 "Move to the previous item in the completion list."
4676 (interactive "p")
4677 (next-completion (- n)))
4678
4679(defun next-completion (n)
4680 "Move to the next item in the completion list.
1f238ac2 4681With prefix argument N, move N items (negative N means move backward)."
dde69dbe 4682 (interactive "p")
58dd38f1
SM
4683 (let ((beg (point-min)) (end (point-max)))
4684 (while (and (> n 0) (not (eobp)))
dde69dbe 4685 ;; If in a completion, move to the end of it.
58dd38f1
SM
4686 (when (get-text-property (point) 'mouse-face)
4687 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe 4688 ;; Move to start of next one.
58dd38f1
SM
4689 (unless (get-text-property (point) 'mouse-face)
4690 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4691 (setq n (1- n)))
4692 (while (and (< n 0) (not (bobp)))
4693 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4694 ;; If in a completion, move to the start of it.
4695 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
b61a81c2 4696 (goto-char (previous-single-property-change
58dd38f1
SM
4697 (point) 'mouse-face nil beg)))
4698 ;; Move to end of the previous completion.
4699 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4700 (goto-char (previous-single-property-change
4701 (point) 'mouse-face nil beg)))
4702 ;; Move to the start of that one.
4703 (goto-char (previous-single-property-change
4704 (point) 'mouse-face nil beg))
4705 (setq n (1+ n))))))
dde69dbe 4706
80298193
RS
4707(defun choose-completion ()
4708 "Choose the completion that point is in or next to."
4709 (interactive)
f6b293e3
RS
4710 (let (beg end completion (buffer completion-reference-buffer)
4711 (base-size completion-base-size))
6096f362
RS
4712 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4713 (setq end (point) beg (1+ (point))))
4714 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3f299281 4715 (setq end (1- (point)) beg (point)))
6096f362
RS
4716 (if (null beg)
4717 (error "No completion here"))
4718 (setq beg (previous-single-property-change beg 'mouse-face))
88dd3c24 4719 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
ab63960f
RS
4720 (setq completion (buffer-substring beg end))
4721 (let ((owindow (selected-window)))
4722 (if (and (one-window-p t 'selected-frame)
4723 (window-dedicated-p (selected-window)))
4724 ;; This is a special buffer's frame
4725 (iconify-frame (selected-frame))
4726 (or (window-dedicated-p (selected-window))
4727 (bury-buffer)))
4728 (select-window owindow))
f6b293e3 4729 (choose-completion-string completion buffer base-size)))
80298193
RS
4730
4731;; Delete the longest partial match for STRING
4732;; that can be found before POINT.
4733(defun choose-completion-delete-max-match (string)
4734 (let ((opoint (point))
f0bfada7
RS
4735 len)
4736 ;; Try moving back by the length of the string.
4737 (goto-char (max (- (point) (length string))
4738 (minibuffer-prompt-end)))
4739 ;; See how far back we were actually able to move. That is the
4740 ;; upper bound on how much we can match and delete.
4741 (setq len (- opoint (point)))
61bbf6fe
RS
4742 (if completion-ignore-case
4743 (setq string (downcase string)))
80298193 4744 (while (and (> len 0)
f0bfada7 4745 (let ((tail (buffer-substring (point) opoint)))
61bbf6fe
RS
4746 (if completion-ignore-case
4747 (setq tail (downcase tail)))
80298193
RS
4748 (not (string= tail (substring string 0 len)))))
4749 (setq len (1- len))
4750 (forward-char 1))
4751 (delete-char len)))
4752
ba36181b 4753(defvar choose-completion-string-functions nil
bbbbb15b
KS
4754 "Functions that may override the normal insertion of a completion choice.
4755These functions are called in order with four arguments:
4756CHOICE - the string to insert in the buffer,
4757BUFFER - the buffer in which the choice should be inserted,
89a6cfe3 4758MINI-P - non-nil iff BUFFER is a minibuffer, and
12829a07
RS
4759BASE-SIZE - the number of characters in BUFFER before
4760the string being completed.
4761
bbbbb15b
KS
4762If a function in the list returns non-nil, that function is supposed
4763to have inserted the CHOICE in the BUFFER, and possibly exited
12829a07 4764the minibuffer; no further functions will be called.
ba36181b 4765
12829a07
RS
4766If all functions in the list return nil, that means to use
4767the default method of inserting the completion in BUFFER.")
74d0290b 4768
f6b293e3 4769(defun choose-completion-string (choice &optional buffer base-size)
12829a07
RS
4770 "Switch to BUFFER and insert the completion choice CHOICE.
4771BASE-SIZE, if non-nil, says how many characters of BUFFER's text
e36aeef9
RS
4772to keep. If it is nil, we call `choose-completion-delete-max-match'
4773to decide what to delete."
12829a07
RS
4774
4775 ;; If BUFFER is the minibuffer, exit the minibuffer
4776 ;; unless it is reading a file name and CHOICE is a directory,
4777 ;; or completion-no-auto-exit is non-nil.
4778
1a0d0b6a
JPW
4779 (let* ((buffer (or buffer completion-reference-buffer))
4780 (mini-p (minibufferp buffer)))
cf52ad58
RS
4781 ;; If BUFFER is a minibuffer, barf unless it's the currently
4782 ;; active minibuffer.
f436a90a 4783 (if (and mini-p
45486731
RS
4784 (or (not (active-minibuffer-window))
4785 (not (equal buffer
4786 (window-buffer (active-minibuffer-window))))))
cf52ad58 4787 (error "Minibuffer is not active for completion")
17aa3385
KS
4788 ;; Set buffer so buffer-local choose-completion-string-functions works.
4789 (set-buffer buffer)
f1180544 4790 (unless (run-hook-with-args-until-success
d99f8496
SM
4791 'choose-completion-string-functions
4792 choice buffer mini-p base-size)
4793 ;; Insert the completion into the buffer where it was requested.
bbbbb15b
KS
4794 (if base-size
4795 (delete-region (+ base-size (if mini-p
4796 (minibuffer-prompt-end)
4797 (point-min)))
4798 (point))
4799 (choose-completion-delete-max-match choice))
4800 (insert choice)
4801 (remove-text-properties (- (point) (length choice)) (point)
4802 '(mouse-face nil))
4803 ;; Update point in the window that BUFFER is showing in.
4804 (let ((window (get-buffer-window buffer t)))
4805 (set-window-point window (point)))
4806 ;; If completing for the minibuffer, exit it with this choice.
4807 (and (not completion-no-auto-exit)
4808 (equal buffer (window-buffer (minibuffer-window)))
4809 minibuffer-completion-table
4810 ;; If this is reading a file name, and the file name chosen
4811 ;; is a directory, don't exit the minibuffer.
4812 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4813 (file-directory-p (field-string (point-max))))
4814 (let ((mini (active-minibuffer-window)))
4815 (select-window mini)
4816 (when minibuffer-auto-raise
4817 (raise-frame (window-frame mini))))
4818 (exit-minibuffer)))))))
80298193 4819
ac29eb79 4820(defun completion-list-mode ()
e8a700bf 4821 "Major mode for buffers showing lists of possible completions.
80298193
RS
4822Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
4823 to select the completion near point.
4824Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
4825 with the mouse."
e8a700bf
RS
4826 (interactive)
4827 (kill-all-local-variables)
ac29eb79
RS
4828 (use-local-map completion-list-mode-map)
4829 (setq mode-name "Completion List")
4830 (setq major-mode 'completion-list-mode)
f6b293e3
RS
4831 (make-local-variable 'completion-base-size)
4832 (setq completion-base-size nil)
b2777913 4833 (run-mode-hooks 'completion-list-mode-hook))
e8a700bf 4834
c8d6d636
GM
4835(defun completion-list-mode-finish ()
4836 "Finish setup of the completions buffer.
4837Called from `temp-buffer-show-hook'."
4838 (when (eq major-mode 'completion-list-mode)
4839 (toggle-read-only 1)))
4840
4841(add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4842
747a0e2f
RS
4843(defvar completion-setup-hook nil
4844 "Normal hook run at the end of setting up a completion list buffer.
4845When this hook is run, the current buffer is the one in which the
4846command to display the completion list buffer was run.
4847The completion list buffer is available as the value of `standard-output'.")
4848
98b45886
RS
4849;; This function goes in completion-setup-hook, so that it is called
4850;; after the text of the completion list buffer is written.
6a4940b2 4851(defface completions-first-difference
abcdd45a
MY
4852 '((t (:inherit bold)))
4853 "Face put on the first uncommon character in completions in *Completions* buffer."
4854 :group 'completion)
4855
6a4940b2 4856(defface completions-common-part
abcdd45a 4857 '((t (:inherit default)))
e4ef3e92
JL
4858 "Face put on the common prefix substring in completions in *Completions* buffer.
4859The idea of `completions-common-part' is that you can use it to
4860make the common parts less visible than normal, so that the rest
4861of the differing parts is, by contrast, slightly highlighted."
abcdd45a 4862 :group 'completion)
6096f362 4863
abaf2e77
EZ
4864;; This is for packages that need to bind it to a non-default regexp
4865;; in order to make the first-differing character highlight work
4866;; to their liking
4867(defvar completion-root-regexp "^/"
4868 "Regexp to use in `completion-setup-function' to find the root directory.")
4869
e8a700bf 4870(defun completion-setup-function ()
621a3f62
SM
4871 (let ((mainbuf (current-buffer))
4872 (mbuf-contents (minibuffer-contents)))
4873 ;; When reading a file name in the minibuffer,
4874 ;; set default-directory in the minibuffer
4875 ;; so it will get copied into the completion list buffer.
4876 (if minibuffer-completing-file-name
4877 (with-current-buffer mainbuf
4878 (setq default-directory (file-name-directory mbuf-contents))))
55c4a67c
EZ
4879 ;; If partial-completion-mode is on, point might not be after the
4880 ;; last character in the minibuffer.
4881 ;; FIXME: This still doesn't work if the text to be completed
4882 ;; starts with a `-'.
4883 (when (and partial-completion-mode (not (eobp)))
4884 (setq mbuf-contents
4885 (substring mbuf-contents 0 (- (point) (point-max)))))
621a3f62 4886 (with-current-buffer standard-output
3819736b
RS
4887 (completion-list-mode)
4888 (make-local-variable 'completion-reference-buffer)
4889 (setq completion-reference-buffer mainbuf)
2d64b6f6 4890 (if minibuffer-completing-file-name
50be475d
RS
4891 ;; For file name completion,
4892 ;; use the number of chars before the start of the
4893 ;; last file name component.
4894 (setq completion-base-size
621a3f62
SM
4895 (with-current-buffer mainbuf
4896 (save-excursion
4897 (goto-char (point-max))
abaf2e77 4898 (skip-chars-backward completion-root-regexp)
621a3f62 4899 (- (point) (minibuffer-prompt-end)))))
19183a29 4900 ;; Otherwise, in minibuffer, the whole input is being completed.
621a3f62 4901 (if (minibufferp mainbuf)
77da2107
RS
4902 (if (and (symbolp minibuffer-completion-table)
4903 (get minibuffer-completion-table 'completion-base-size-function))
52167727 4904 (setq completion-base-size
77da2107
RS
4905 (funcall (get minibuffer-completion-table 'completion-base-size-function)))
4906 (setq completion-base-size 0))))
621a3f62 4907 ;; Put faces on first uncommon characters and common parts.
abcdd45a 4908 (when completion-base-size
621a3f62
SM
4909 (let* ((common-string-length
4910 (- (length mbuf-contents) completion-base-size))
9a1120ea
MY
4911 (element-start (next-single-property-change
4912 (point-min)
4913 'mouse-face))
621a3f62 4914 (element-common-end
9bb25ed3
RS
4915 (and element-start
4916 (+ (or element-start nil) common-string-length)))
9a1120ea
MY
4917 (maxp (point-max)))
4918 (while (and element-start (< element-common-end maxp))
abcdd45a
MY
4919 (when (and (get-char-property element-start 'mouse-face)
4920 (get-char-property element-common-end 'mouse-face))
4921 (put-text-property element-start element-common-end
6a4940b2 4922 'font-lock-face 'completions-common-part)
abcdd45a 4923 (put-text-property element-common-end (1+ element-common-end)
6a4940b2 4924 'font-lock-face 'completions-first-difference))
9a1120ea 4925 (setq element-start (next-single-property-change
abcdd45a 4926 element-start
9a1120ea
MY
4927 'mouse-face))
4928 (if element-start
4929 (setq element-common-end (+ element-start common-string-length))))))
abcdd45a 4930 ;; Insert help string.
3819736b 4931 (goto-char (point-min))
0d6e23cf 4932 (if (display-mouse-p)
3819736b 4933 (insert (substitute-command-keys
80298193
RS
4934 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
4935 (insert (substitute-command-keys
4936 "In this buffer, type \\[choose-completion] to \
7d22ed15 4937select the completion near point.\n\n")))))
c88ab9ce 4938
e8a700bf 4939(add-hook 'completion-setup-hook 'completion-setup-function)
dde69dbe
RS
4940
4941(define-key minibuffer-local-completion-map [prior]
4942 'switch-to-completions)
4943(define-key minibuffer-local-must-match-map [prior]
4944 'switch-to-completions)
4945(define-key minibuffer-local-completion-map "\M-v"
4946 'switch-to-completions)
4947(define-key minibuffer-local-must-match-map "\M-v"
4948 'switch-to-completions)
4949
4950(defun switch-to-completions ()
4951 "Select the completion list window."
4952 (interactive)
9595fbdb
RS
4953 ;; Make sure we have a completions window.
4954 (or (get-buffer-window "*Completions*")
4955 (minibuffer-completion-help))
fdbd7c4d
KH
4956 (let ((window (get-buffer-window "*Completions*")))
4957 (when window
4958 (select-window window)
4959 (goto-char (point-min))
4960 (search-forward "\n\n")
4961 (forward-line 1))))
eaae8106 4962
82072f33
RS
4963;; Support keyboard commands to turn on various modifiers.
4964
4965;; These functions -- which are not commands -- each add one modifier
4966;; to the following event.
4967
4968(defun event-apply-alt-modifier (ignore-prompt)
1e96c007 4969 "\\<function-key-map>Add the Alt modifier to the following event.
70cf9f08 4970For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
82072f33
RS
4971 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4972(defun event-apply-super-modifier (ignore-prompt)
1e96c007 4973 "\\<function-key-map>Add the Super modifier to the following event.
70cf9f08 4974For example, type \\[event-apply-super-modifier] & to enter Super-&."
82072f33
RS
4975 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4976(defun event-apply-hyper-modifier (ignore-prompt)
1e96c007 4977 "\\<function-key-map>Add the Hyper modifier to the following event.
70cf9f08 4978For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
82072f33
RS
4979 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
4980(defun event-apply-shift-modifier (ignore-prompt)
1e96c007 4981 "\\<function-key-map>Add the Shift modifier to the following event.
70cf9f08 4982For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
82072f33
RS
4983 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
4984(defun event-apply-control-modifier (ignore-prompt)
1e96c007 4985 "\\<function-key-map>Add the Ctrl modifier to the following event.
70cf9f08 4986For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
82072f33
RS
4987 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
4988(defun event-apply-meta-modifier (ignore-prompt)
1e96c007 4989 "\\<function-key-map>Add the Meta modifier to the following event.
70cf9f08 4990For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
82072f33
RS
4991 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
4992
4993(defun event-apply-modifier (event symbol lshiftby prefix)
4994 "Apply a modifier flag to event EVENT.
4995SYMBOL is the name of this modifier, as a symbol.
4996LSHIFTBY is the numeric value of this modifier, in keyboard events.
4997PREFIX is the string that represents this modifier in an event type symbol."
4998 (if (numberp event)
4999 (cond ((eq symbol 'control)
90bebcb0
KH
5000 (if (and (<= (downcase event) ?z)
5001 (>= (downcase event) ?a))
82072f33 5002 (- (downcase event) ?a -1)
90bebcb0
KH
5003 (if (and (<= (downcase event) ?Z)
5004 (>= (downcase event) ?A))
82072f33
RS
5005 (- (downcase event) ?A -1)
5006 (logior (lsh 1 lshiftby) event))))
5007 ((eq symbol 'shift)
5008 (if (and (<= (downcase event) ?z)
5009 (>= (downcase event) ?a))
5010 (upcase event)
5011 (logior (lsh 1 lshiftby) event)))
5012 (t
5013 (logior (lsh 1 lshiftby) event)))
5014 (if (memq symbol (event-modifiers event))
5015 event
5016 (let ((event-type (if (symbolp event) event (car event))))
5017 (setq event-type (intern (concat prefix (symbol-name event-type))))
5018 (if (symbolp event)
5019 event-type
5020 (cons event-type (cdr event)))))))
5021
e5fff738
KH
5022(define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5023(define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5024(define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5025(define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5026(define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5027(define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
eaae8106 5028
a3d1480b
JB
5029;;;; Keypad support.
5030
5031;;; Make the keypad keys act like ordinary typing keys. If people add
5032;;; bindings for the function key symbols, then those bindings will
5033;;; override these, so this shouldn't interfere with any existing
5034;;; bindings.
5035
0d173134 5036;; Also tell read-char how to handle these keys.
e1e04350 5037(mapc
a3d1480b
JB
5038 (lambda (keypad-normal)
5039 (let ((keypad (nth 0 keypad-normal))
5040 (normal (nth 1 keypad-normal)))
0d173134 5041 (put keypad 'ascii-character normal)
a3d1480b
JB
5042 (define-key function-key-map (vector keypad) (vector normal))))
5043 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5044 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
f33321ad 5045 (kp-space ?\s)
a3d1480b
JB
5046 (kp-tab ?\t)
5047 (kp-enter ?\r)
5048 (kp-multiply ?*)
5049 (kp-add ?+)
5050 (kp-separator ?,)
5051 (kp-subtract ?-)
5052 (kp-decimal ?.)
5053 (kp-divide ?/)
5054 (kp-equal ?=)))
f54b0d85 5055\f
1e722f9f 5056;;;;
b005abd5 5057;;;; forking a twin copy of a buffer.
1e722f9f 5058;;;;
b005abd5
SM
5059
5060(defvar clone-buffer-hook nil
5061 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5062
5063(defun clone-process (process &optional newname)
5064 "Create a twin copy of PROCESS.
5065If NEWNAME is nil, it defaults to PROCESS' name;
5066NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5067If PROCESS is associated with a buffer, the new process will be associated
5068 with the current buffer instead.
5069Returns nil if PROCESS has already terminated."
5070 (setq newname (or newname (process-name process)))
5071 (if (string-match "<[0-9]+>\\'" newname)
5072 (setq newname (substring newname 0 (match-beginning 0))))
5073 (when (memq (process-status process) '(run stop open))
5074 (let* ((process-connection-type (process-tty-name process))
b005abd5
SM
5075 (new-process
5076 (if (memq (process-status process) '(open))
ed7069af
KS
5077 (let ((args (process-contact process t)))
5078 (setq args (plist-put args :name newname))
5079 (setq args (plist-put args :buffer
403ca8d9
KS
5080 (if (process-buffer process)
5081 (current-buffer))))
ed7069af 5082 (apply 'make-network-process args))
b005abd5
SM
5083 (apply 'start-process newname
5084 (if (process-buffer process) (current-buffer))
5085 (process-command process)))))
ed7069af
KS
5086 (set-process-query-on-exit-flag
5087 new-process (process-query-on-exit-flag process))
b005abd5
SM
5088 (set-process-inherit-coding-system-flag
5089 new-process (process-inherit-coding-system-flag process))
5090 (set-process-filter new-process (process-filter process))
5091 (set-process-sentinel new-process (process-sentinel process))
403ca8d9 5092 (set-process-plist new-process (copy-sequence (process-plist process)))
b005abd5
SM
5093 new-process)))
5094
b75b82ab 5095;; things to maybe add (currently partly covered by `funcall mode'):
b005abd5
SM
5096;; - syntax-table
5097;; - overlays
5098(defun clone-buffer (&optional newname display-flag)
186f9ad1
LT
5099 "Create and return a twin copy of the current buffer.
5100Unlike an indirect buffer, the new buffer can be edited
5101independently of the old one (if it is not read-only).
5102NEWNAME is the name of the new buffer. It may be modified by
5103adding or incrementing <N> at the end as necessary to create a
5104unique buffer name. If nil, it defaults to the name of the
5105current buffer, with the proper suffix. If DISPLAY-FLAG is
5106non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5107clone a file-visiting buffer, or a buffer whose major mode symbol
5108has a non-nil `no-clone' property, results in an error.
5109
5110Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5111current buffer with appropriate suffix. However, if a prefix
5112argument is given, then the command prompts for NEWNAME in the
5113minibuffer.
b005abd5 5114
b005abd5
SM
5115This runs the normal hook `clone-buffer-hook' in the new buffer
5116after it has been set up properly in other respects."
61acfe7f
RS
5117 (interactive
5118 (progn
5119 (if buffer-file-name
5120 (error "Cannot clone a file-visiting buffer"))
5121 (if (get major-mode 'no-clone)
5122 (error "Cannot clone a buffer in %s mode" mode-name))
5123 (list (if current-prefix-arg (read-string "Name: "))
5124 t)))
b005abd5
SM
5125 (if buffer-file-name
5126 (error "Cannot clone a file-visiting buffer"))
5127 (if (get major-mode 'no-clone)
5128 (error "Cannot clone a buffer in %s mode" mode-name))
5129 (setq newname (or newname (buffer-name)))
5130 (if (string-match "<[0-9]+>\\'" newname)
5131 (setq newname (substring newname 0 (match-beginning 0))))
5132 (let ((buf (current-buffer))
5133 (ptmin (point-min))
5134 (ptmax (point-max))
5135 (pt (point))
5136 (mk (if mark-active (mark t)))
5137 (modified (buffer-modified-p))
5138 (mode major-mode)
5139 (lvars (buffer-local-variables))
5140 (process (get-buffer-process (current-buffer)))
5141 (new (generate-new-buffer (or newname (buffer-name)))))
5142 (save-restriction
5143 (widen)
5144 (with-current-buffer new
5145 (insert-buffer-substring buf)))
5146 (with-current-buffer new
5147 (narrow-to-region ptmin ptmax)
5148 (goto-char pt)
5149 (if mk (set-mark mk))
5150 (set-buffer-modified-p modified)
5151
5152 ;; Clone the old buffer's process, if any.
5153 (when process (clone-process process))
5154
5155 ;; Now set up the major mode.
5156 (funcall mode)
5157
5158 ;; Set up other local variables.
5159 (mapcar (lambda (v)
5160 (condition-case () ;in case var is read-only
5161 (if (symbolp v)
5162 (makunbound v)
5163 (set (make-local-variable (car v)) (cdr v)))
5164 (error nil)))
5165 lvars)
5166
5167 ;; Run any hooks (typically set up by the major mode
5168 ;; for cloning to work properly).
5169 (run-hooks 'clone-buffer-hook))
5170 (if display-flag (pop-to-buffer new))
5171 new))
5172
fa65f20b 5173
7e3afb04 5174(defun clone-indirect-buffer (newname display-flag &optional norecord)
fa65f20b
GM
5175 "Create an indirect buffer that is a twin copy of the current buffer.
5176
01ba9662 5177Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
fa65f20b
GM
5178from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5179or if not called with a prefix arg, NEWNAME defaults to the current
5180buffer's name. The name is modified by adding a `<N>' suffix to it
5181or by incrementing the N in an existing suffix.
5182
5183DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7e3afb04
GM
5184This is always done when called interactively.
5185
f33321ad 5186Optional third arg NORECORD non-nil means do not put this buffer at the
7e3afb04 5187front of the list of recently selected ones."
61acfe7f
RS
5188 (interactive
5189 (progn
5190 (if (get major-mode 'no-clone-indirect)
5191 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5192 (list (if current-prefix-arg
5193 (read-string "BName of indirect buffer: "))
5194 t)))
5195 (if (get major-mode 'no-clone-indirect)
5196 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
fa65f20b
GM
5197 (setq newname (or newname (buffer-name)))
5198 (if (string-match "<[0-9]+>\\'" newname)
5199 (setq newname (substring newname 0 (match-beginning 0))))
5200 (let* ((name (generate-new-buffer-name newname))
5201 (buffer (make-indirect-buffer (current-buffer) name t)))
5202 (when display-flag
58dd38f1 5203 (pop-to-buffer buffer norecord))
fa65f20b
GM
5204 buffer))
5205
5206
7e3afb04
GM
5207(defun clone-indirect-buffer-other-window (buffer &optional norecord)
5208 "Create an indirect buffer that is a twin copy of BUFFER.
5209Select the new buffer in another window.
5210Optional second arg NORECORD non-nil means do not put this buffer at
5211the front of the list of recently selected ones."
5212 (interactive "bClone buffer in other window: ")
acd39eb6 5213 (let ((pop-up-windows t))
7e3afb04
GM
5214 (set-buffer buffer)
5215 (clone-indirect-buffer nil t norecord)))
5216
f54b0d85 5217\f
1d4b11bf
GM
5218;;; Handling of Backspace and Delete keys.
5219
e5212545
SM
5220(defcustom normal-erase-is-backspace
5221 (and (not noninteractive)
5222 (or (memq system-type '(ms-dos windows-nt))
267e1dbe 5223 (eq window-system 'mac)
e5212545
SM
5224 (and (memq window-system '(x))
5225 (fboundp 'x-backspace-delete-keys-p)
5226 (x-backspace-delete-keys-p))
5227 ;; If the terminal Emacs is running on has erase char
5228 ;; set to ^H, use the Backspace key for deleting
5229 ;; backward and, and the Delete key for deleting forward.
5230 (and (null window-system)
5231 (eq tty-erase-char ?\^H))))
7f62656b 5232 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
1d4b11bf
GM
5233
5234On window systems, the default value of this option is chosen
5235according to the keyboard used. If the keyboard has both a Backspace
5236key and a Delete key, and both are mapped to their usual meanings, the
5237option's default value is set to t, so that Backspace can be used to
7f62656b 5238delete backward, and Delete can be used to delete forward.
1d4b11bf 5239
7f62656b 5240If not running under a window system, customizing this option accomplishes
1d4b11bf
GM
5241a similar effect by mapping C-h, which is usually generated by the
5242Backspace key, to DEL, and by mapping DEL to C-d via
5243`keyboard-translate'. The former functionality of C-h is available on
5244the F1 key. You should probably not use this setting if you don't
f060b834
GM
5245have both Backspace, Delete and F1 keys.
5246
5247Setting this variable with setq doesn't take effect. Programmatically,
7f62656b 5248call `normal-erase-is-backspace-mode' (which see) instead."
1d4b11bf
GM
5249 :type 'boolean
5250 :group 'editing-basics
5251 :version "21.1"
5252 :set (lambda (symbol value)
5253 ;; The fboundp is because of a problem with :set when
5254 ;; dumping Emacs. It doesn't really matter.
7f62656b
EZ
5255 (if (fboundp 'normal-erase-is-backspace-mode)
5256 (normal-erase-is-backspace-mode (or value 0))
1d4b11bf
GM
5257 (set-default symbol value))))
5258
5259
7f62656b
EZ
5260(defun normal-erase-is-backspace-mode (&optional arg)
5261 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5262
e02160a3 5263With numeric arg, turn the mode on if and only if ARG is positive.
7f62656b
EZ
5264
5265On window systems, when this mode is on, Delete is mapped to C-d and
5266Backspace is mapped to DEL; when this mode is off, both Delete and
5267Backspace are mapped to DEL. (The remapping goes via
5268`function-key-map', so binding Delete or Backspace in the global or
5269local keymap will override that.)
5270
5271In addition, on window systems, the bindings of C-Delete, M-Delete,
5272C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5273the global keymap in accordance with the functionality of Delete and
5274Backspace. For example, if Delete is remapped to C-d, which deletes
5275forward, C-Delete is bound to `kill-word', but if Delete is remapped
5276to DEL, which deletes backward, C-Delete is bound to
5277`backward-kill-word'.
5278
5279If not running on a window system, a similar effect is accomplished by
5280remapping C-h (normally produced by the Backspace key) and DEL via
5281`keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5282to C-d; if it's off, the keys are not remapped.
5283
5284When not running on a window system, and this mode is turned on, the
5285former functionality of C-h is available on the F1 key. You should
5286probably not turn on this mode on a text-only terminal if you don't
5287have both Backspace, Delete and F1 keys.
5288
5289See also `normal-erase-is-backspace'."
1d4b11bf 5290 (interactive "P")
7f62656b 5291 (setq normal-erase-is-backspace
1d4b11bf
GM
5292 (if arg
5293 (> (prefix-numeric-value arg) 0)
7f62656b 5294 (not normal-erase-is-backspace)))
1d4b11bf 5295
13a9eed7
EZ
5296 (cond ((or (memq window-system '(x w32 mac pc))
5297 (memq system-type '(ms-dos windows-nt)))
7f62656b 5298 (let ((bindings
103db06c
RS
5299 `(([C-delete] [C-backspace])
5300 ([M-delete] [M-backspace])
5301 ([C-M-delete] [C-M-backspace])
ec9f4754 5302 (,esc-map
103db06c
RS
5303 [C-delete] [C-backspace])))
5304 (old-state (lookup-key function-key-map [delete])))
ec9f4754 5305
7f62656b 5306 (if normal-erase-is-backspace
ec9f4754
GM
5307 (progn
5308 (define-key function-key-map [delete] [?\C-d])
be4f1e41 5309 (define-key function-key-map [kp-delete] [?\C-d])
ec9f4754
GM
5310 (define-key function-key-map [backspace] [?\C-?]))
5311 (define-key function-key-map [delete] [?\C-?])
be4f1e41 5312 (define-key function-key-map [kp-delete] [?\C-?])
ec9f4754
GM
5313 (define-key function-key-map [backspace] [?\C-?]))
5314
103db06c
RS
5315 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5316 (unless (equal old-state (lookup-key function-key-map [delete]))
5317 (dolist (binding bindings)
5318 (let ((map global-map))
5319 (when (keymapp (car binding))
5320 (setq map (car binding) binding (cdr binding)))
5321 (let* ((key1 (nth 0 binding))
5322 (key2 (nth 1 binding))
5323 (binding1 (lookup-key map key1))
5324 (binding2 (lookup-key map key2)))
5325 (define-key map key1 binding2)
5326 (define-key map key2 binding1)))))))
1d4b11bf 5327 (t
7f62656b 5328 (if normal-erase-is-backspace
1d4b11bf
GM
5329 (progn
5330 (keyboard-translate ?\C-h ?\C-?)
5331 (keyboard-translate ?\C-? ?\C-d))
5332 (keyboard-translate ?\C-h ?\C-h)
5333 (keyboard-translate ?\C-? ?\C-?))))
5334
7f62656b 5335 (run-hooks 'normal-erase-is-backspace-hook)
1d4b11bf 5336 (if (interactive-p)
7f62656b
EZ
5337 (message "Delete key deletes %s"
5338 (if normal-erase-is-backspace "forward" "backward"))))
ea82f0df 5339\f
aca8bee5 5340(defvar vis-mode-saved-buffer-invisibility-spec nil
0f7df535 5341 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7f62656b 5342
0f7df535
RS
5343(define-minor-mode visible-mode
5344 "Toggle Visible mode.
5345With argument ARG turn Visible mode on iff ARG is positive.
1d4b11bf 5346
0f7df535
RS
5347Enabling Visible mode makes all invisible text temporarily visible.
5348Disabling Visible mode turns off that effect. Visible mode
5349works by saving the value of `buffer-invisibility-spec' and setting it to nil."
4e57881d 5350 :lighter " Vis"
ab77efd0 5351 :group 'editing-basics
aca8bee5
SM
5352 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5353 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5354 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
0f7df535 5355 (when visible-mode
aca8bee5
SM
5356 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5357 buffer-invisibility-spec)
5358 (setq buffer-invisibility-spec nil)))
4e57881d 5359\f
e1e04350 5360;; Minibuffer prompt stuff.
9b350152 5361
49c14a05
GM
5362;(defun minibuffer-prompt-modification (start end)
5363; (error "You cannot modify the prompt"))
5364;
5365;
5366;(defun minibuffer-prompt-insertion (start end)
5367; (let ((inhibit-modification-hooks t))
5368; (delete-region start end)
5369; ;; Discard undo information for the text insertion itself
5370; ;; and for the text deletion.above.
5371; (when (consp buffer-undo-list)
5372; (setq buffer-undo-list (cddr buffer-undo-list)))
5373; (message "You cannot modify the prompt")))
5374;
5375;
f1180544 5376;(setq minibuffer-prompt-properties
49c14a05
GM
5377; (list 'modification-hooks '(minibuffer-prompt-modification)
5378; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
f1180544 5379;
9b350152 5380
00398e3b 5381(provide 'simple)
ab5796a9 5382
621a3f62 5383;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
c88ab9ce 5384;;; simple.el ends here