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